j1-template 2021.1.13 → 2021.1.18

data/assets/error_pages/HTTP501.html

@@ -1,4 +1,13 @@
 ---
+date:                                   2021-01-01 00:00:00
+description: >
+                                        Customized HTML error page
+
+categories:                             [ Error page ]
+tags:                                   [ HTML, 501 ]
+
+exclude_from_search:                    true
+
 regenerate:                             false
 permalink:                              /501.html
 http_error:                             501
@@ -43,8 +52,14 @@ sitemap:                                false
 
 {% capture brand_image %}{{images_dir}}/{{brand_image_source}}{% endcapture %}
 
-{% if language != 'en' or language != 'de' %}
-  {% assign language          = 'en' %}
+{% comment %} language detection
+-------------------------------------------------------------------------------- {% endcomment %}
+{% if site.language == "en" %}
+  {% assign language = "en" %}
+{% elsif site.language == "de"%}
+  {% assign language = "de" %}
+{% else %}
+  {% assign language = "en" %}
 {% endif %}
 
 {% if language == 'en' %}

data/assets/error_pages/HTTP502.html

@@ -1,4 +1,13 @@
 ---
+date:                                   2021-01-01 00:00:00
+description: >
+                                        Customized HTML error page
+
+categories:                             [ Error page ]
+tags:                                   [ HTML, 502 ]
+
+exclude_from_search:                    true
+
 regenerate:                             false
 permalink:                              /502.html
 http_error:                             502
@@ -43,8 +52,14 @@ sitemap:                                false
 
 {% capture brand_image %}{{images_dir}}/{{brand_image_source}}{% endcapture %}
 
-{% if language != 'en' or language != 'de' %}
-  {% assign language          = 'en' %}
+{% comment %} language detection
+-------------------------------------------------------------------------------- {% endcomment %}
+{% if site.language == "en" %}
+  {% assign language = "en" %}
+{% elsif site.language == "de"%}
+  {% assign language = "de" %}
+{% else %}
+  {% assign language = "en" %}
 {% endif %}
 
 {% if language == 'en' %}

data/assets/error_pages/HTTP503.html

@@ -1,4 +1,12 @@
----
+---date:                                   2021-01-01 00:00:00
+description: >
+                                        Customized HTML error page
+
+categories:                             [ Error page ]
+tags:                                   [ HTML, 503 ]
+
+exclude_from_search:                    true
+
 regenerate:                             false
 permalink:                              /503.html
 http_error:                             503
@@ -45,8 +53,14 @@ sitemap:                                false
 
 {% capture brand_image %}{{images_dir}}/{{brand_image_source}}{% endcapture %}
 
-{% if language != 'en' or language != 'de' %}
-  {% assign language          = 'en' %}
+{% comment %} language detection
+-------------------------------------------------------------------------------- {% endcomment %}
+{% if site.language == "en" %}
+  {% assign language = "en" %}
+{% elsif site.language == "de"%}
+  {% assign language = "de" %}
+{% else %}
+  {% assign language = "en" %}
 {% endif %}
 
 {% if language == 'en' %}

data/assets/themes/j1/adapter/js/cookieConsent.js

@@ -39,7 +39,7 @@ regenerate:                             true
 {% assign tracking_enabled    = template_config.analytics.enabled %}
 {% assign tracking_id         = template_config.analytics.google.tracking_id %}
 
-{% assign comment_provider        = site.data.j1_config.comments.provider %}
+{% assign comment_provider    = site.data.j1_config.comments.provider %}
 
 {% comment %} Set config options
 -------------------------------------------------------------------------------- {% endcomment %}
@@ -101,6 +101,7 @@ j1.adapter['cookieConsent'] = (function (j1, window) {
   var secure;
   var logText;
   var cookie_written;
+  var language;
 
   // NOTE: RegEx for tracking_id: ^(G|UA|YT|MO)-[a-zA-Z0-9-]+$
   // See: https://stackoverflow.com/questions/20411767/how-to-validate-google-analytics-tracking-id-using-a-javascript-function/20412153
@@ -129,6 +130,7 @@ j1.adapter['cookieConsent'] = (function (j1, window) {
       hostname      = url.hostname;
       domain        = hostname.substring(hostname.lastIndexOf('.', hostname.lastIndexOf('.') - 1) + 1);
       secure        = (url.protocol.includes('https')) ? true : false;
+      language      = "{{site.language}}";
 
       // set domain used by cookies
       if(domain !== 'localhost') {
@@ -171,10 +173,10 @@ j1.adapter['cookieConsent'] = (function (j1, window) {
           j1.cookieConsent = new BootstrapCookieConsent({
             contentURL:             moduleOptions.contentURL,
             cookieName:             moduleOptions.cookieName,
-            language:               moduleOptions.language,
+            language:               language,
             whitelisted:            moduleOptions.whitelisted,
             reloadPageOnChange:     moduleOptions.reloadPageOnChange,
-            xhr_data_element:       moduleOptions.xhr_data_element + '-' + moduleOptions.language,
+            xhr_data_element:       moduleOptions.xhr_data_element + '-' + language,
             sameSite:               moduleOptions.sameSite,
             secure:                 secure,
             postSelectionCallback:  function () {j1.adapter.cookieConsent.cbCookie()}
@@ -263,11 +265,10 @@ j1.adapter['cookieConsent'] = (function (j1, window) {
       //   logger.warn('\n' + 'tracking enabled, tracking id found: ' + tracking_id);
       // }
 
-      // for development only
-      if (environment === 'development') {
-        gaCookies.forEach(item => console.log('cookieConsent: ' + item));
-        j1Cookies.forEach(item => console.log('cookieConsent: ' + item));
-      }
+      logger.debug('\n' + 'j1 cookies found:' + j1Cookies.length);
+      j1Cookies.forEach(item => console.log('j1.core.switcher: ' + item));
+      logger.debug('\n' + 'ga cookies found:' + gaCookies.length);
+      gaCookies.forEach(item => console.log('j1.core.switcher: ' + item));
 
       if (user_agent.includes('iPad'))  {
         logger.warn('\n' + 'product detected : ' + platform.product);

data/assets/themes/j1/adapter/js/j1.js

@@ -41,41 +41,44 @@ regenerate:                             true
 
 {% comment %} Set config files
 -------------------------------------------------------------------------------- {% endcomment %}
-{% assign blocks                  = site.data.blocks %}
-{% assign modules                 = site.data.modules %}
-{% assign template_config         = site.data.j1_config %}
+{% assign blocks                    = site.data.blocks %}
+{% assign modules                   = site.data.modules %}
+{% assign template_config           = site.data.j1_config %}
 
 {% comment %} Set config data
 -------------------------------------------------------------------------------- {% endcomment %}
-{% assign banner_config_defaults  = blocks.defaults.banner.defaults %}
-{% assign banner_config_settings  = blocks.banner.settings %}
-{% assign panel_config_defaults   = blocks.defaults.panel.defaults %}
-{% assign panel_config_settings   = blocks.panel.settings %}
-{% assign footer_config_defaults  = blocks.defaults.footer.defaults %}
-{% assign toccer_defaults         = modules.defaults.toccer.defaults %}
-{% assign toccer_settings         = modules.toccer.settings %}
-{% assign themer_defaults         = modules.defaults.themer.defaults %}
-{% assign themer_settings         = modules.themer.settings %}
-{% assign tracking_enabled        = template_config.analytics.enabled %}
-{% assign tracking_id             = template_config.analytics.google.tracking_id %}
-
-{% assign authentication_defaults = modules.defaults.authentication.defaults %}
-{% assign authentication_settings = modules.authentication.settings %}
+{% assign banner_config_defaults    = blocks.defaults.banner.defaults %}
+{% assign banner_config_settings    = blocks.banner.settings %}
+{% assign panel_config_defaults     = blocks.defaults.panel.defaults %}
+{% assign panel_config_settings     = blocks.panel.settings %}
+{% assign footer_config_defaults    = blocks.defaults.footer.defaults %}
+{% assign toccer_defaults           = modules.defaults.toccer.defaults %}
+
+{% assign themer_defaults           = modules.defaults.themer.defaults %}
+{% assign themer_settings           = modules.themer.settings %}
+
+{% assign tracking_enabled          = template_config.analytics.enabled %}
+{% assign tracking_id               = template_config.analytics.google.tracking_id %}
+
+{% assign authentication_defaults   = modules.defaults.authentication.defaults %}
+{% assign authentication_settings   = modules.authentication.settings %}
 
 {% comment %} Set config options
 -------------------------------------------------------------------------------- {% endcomment %}
-{% assign toccer_options          = toccer_defaults | merge: toccer_settings %}
-{% assign themer_options          = themer_defaults | merge: themer_settings %}
+{% assign toccer_options            = toccer_defaults | merge: toccer_settings %}
+{% assign themer_options            = themer_defaults| merge: themer_settings %}
 
-{% assign authentication_options  = authentication_defaults | merge: authentication_settings %}
+{% assign authentication_options    = authentication_defaults | merge: authentication_settings %}
 
-{% assign footer_id               = footer_config_defaults.container-id %}
-{% assign footer_data_path        = footer_config_defaults.data_path %}
-{% assign banner_data_path        = banner_config_defaults.data_path %}
-{% assign panel_data_path         = panel_config_defaults.data_path %}
+{% assign footer_id                 = footer_config_defaults.container-id %}
+{% assign footer_data_path          = footer_config_defaults.data_path %}
+{% assign banner_data_path          = banner_config_defaults.data_path %}
+{% assign panel_data_path           = panel_config_defaults.data_path %}
 
-{% assign hideOnReload            = modules.themer_options.hideOnReload %}
-{% assign comment_provider        = template_config.comments.provider %}
+{% assign themer_enabled            = modules.themer_options.enabled %}
+{% assign themer_reloadPageOnChange = modules.themer_options.reloadPageOnChange %}
+{% assign themer_hideOnReload       = modules.themer_options.hideOnReload %}
+{% assign comment_provider          = template_config.comments.provider %}
 
 {% comment %} Set variables
 -------------------------------------------------------------------------------- {% endcomment %}
@@ -98,6 +101,24 @@ regenerate:                             true
   {% assign production = true %}
 {% endif %}
 
+{% comment %} language detection
+-------------------------------------------------------------------------------- {% endcomment %}
+{% if site.language == "en" %}
+  {% assign language = "en" %}
+{% elsif site.language == "de"%}
+  {% assign language = "de" %}
+{% else %}
+  {% assign language = "en" %}
+{% endif %}
+
+{% if language == "en" %}
+  {% assign comments_headline = template_config.comments.comments_headline.en %}
+{% endif %}
+
+{% if language == "de" %}
+  {% assign comments_headline = template_config.comments.comments_headline.de %}
+{% endif %}
+
 /*
  # -----------------------------------------------------------------------------
  # ~/assets/themes/j1/adapter/js/j1_template.js
@@ -167,7 +188,7 @@ var j1 = (function () {
   var themeCss;
   var cssExtension              = (environment === 'production')
                                   ? '.min.css'
-                                  : '.css';
+                                  : '.css'
 
    // Pathes of J1 data files
   var colors_data_path          = '{{template_config.colors_data_path}}';
@@ -212,9 +233,8 @@ var j1 = (function () {
   };
   var user_state = {
     'writer':               'j1.adapter',
-    'theme_css':            '',
-    'theme_css':            '',
     'theme_name':           '',
+    'theme_css':            '',
     'theme_author':         '',
     'theme_version':        '{{template_version}}',
     'session_active':       false,
@@ -260,6 +280,9 @@ var j1 = (function () {
       var date              = new Date();
       var timestamp_now     = date.toISOString();
       var curr_state        = 'started';
+      var gaCookies         = j1.findCookie('_ga');
+      var j1Cookies         = j1.findCookie('j1');
+      var themerOptions     = $.extend({}, {{themer_options | replace: '=>', ':' | replace: 'nil', '""' }});
 
       // -----------------------------------------------------------------------
       // options loader
@@ -300,26 +323,31 @@ var j1 = (function () {
           user_state.last_session_ts    = timestamp_now;
 
           if (!user_consent.analyses || !user_consent.personalization)  {
-            // expire consent|state cookies to session
+            // rewrite consent|state cookies to session
+            logger.debug('\n' + 'write to cookie : ' + cookie_names.user_consent);
             cookie_written = j1.writeCookie({
               name:     cookie_names.user_consent,
               data:     user_consent,
               samesite: 'Strict',
-              secure:   secure
+              secure:   secure,
+              expires:  0
             });
             if (!cookie_written) {
               logger.error('\n' + 'failed to write cookie: ' + cookie_names.user_consent);
             }
+            logger.debug('\n' + 'write to cookie : ' + cookie_names.user_state);
             cookie_written = j1.writeCookie({
               name:     cookie_names.user_state,
               data:     user_state,
               samesite: 'Strict',
-              secure:   secure
+              secure:   secure,
+              expires:  0
             });
             if (!cookie_written) {
             	logger.error('\n' + 'failed to write cookie: ' + cookie_names.user_consent);
             }
           } else {
+            logger.debug('\n' + 'write to cookie : ' + cookie_names.user_state);
             cookie_written = j1.writeCookie({
               name:     cookie_names.user_state,
               data:     user_state,
@@ -332,9 +360,8 @@ var j1 = (function () {
             }
           }
         } else {
-          // jadams, 2021-07-11: on beforeunload, a vaild state cookie
-          // is expected
-          logger.fatal('\n' + 'missing cookie detected: ' + cookie_names.user_state);
+          // jadams, 2021-07-11: on beforeunload, a user state cookie is expected
+          logger.error('\n' + 'missing cookie detected: ' + cookie_names.user_state);
         }
       }); // END beforeunload
 
@@ -351,7 +378,8 @@ var j1 = (function () {
                             name:     cookie_names.user_session,
                             data:     user_session,
                             samesite: 'Strict',
-                            secure:   secure
+                            secure:   secure,
+                            expires:  0
                           });
       if (!cookie_written) {
       	logger.error('\n' + 'failed to write cookie: ' + cookie_names.user_session);
@@ -376,22 +404,29 @@ var j1 = (function () {
       // for what reason.
       if (!user_state) {
         logger.error('\n' + 'cookie not found: ' + cookie_names.user_state);
+        logger.debug('\n' + 'j1 cookies found:' + j1Cookies.length);
+        j1Cookies.forEach(item => console.log('j1.core.switcher: ' + item));
+        logger.debug('\n' + 'ga cookies found:' + gaCookies.length);
+        gaCookies.forEach(item => console.log('j1.core.switcher: ' + item));
         user_state = j1.readCookie(cookie_names.user_state);
         user_state.session_active = true;
       }
 
       if (!user_consent.analyses || !user_consent.personalization)  {
-        // expire consent|state cookies to session
+        // rewrite consent|state cookies to session
+        logger.debug('\n' + 'write to cookie : ' + cookie_names.user_state);
         cookie_written = j1.writeCookie({
           name:     cookie_names.user_state,
           data:     user_state,
           samesite: 'Strict',
-          secure:   secure
+          secure:   secure,
+          expires:  0
         });
         if (!cookie_written) {
         	logger.error('\n' + 'failed to write cookie: ' + cookie_names.user_state);
         }
       } else {
+        logger.debug('\n' + 'write to cookie : ' + cookie_names.user_state);
         cookie_written = j1.writeCookie({
           name:     cookie_names.user_state,
           data:     user_state,
@@ -428,11 +463,13 @@ var j1 = (function () {
 
           logger.info(logText);
           logger.info('\n' + 'update user session cookie');
+          logger.debug('\n' + 'write to cookie : ' + cookie_names.user_session);
           cookie_written = j1.writeCookie({
             name:     cookie_names.user_session,
             data:     user_session,
             samesite: 'Strict',
-            secure:   secure
+            secure:   secure,
+            expires:  0
           });
 
           if (!cookie_written) {
@@ -475,11 +512,13 @@ var j1 = (function () {
             logText                     = '\n' + 'mode detected: ' + user_session.mode;
 
             logger.info(logText);
+            logger.debug('\n' + 'write to cookie : ' + cookie_names.user_session);
             cookie_written = j1.writeCookie({
               name:     cookie_names.user_session,
               data:     user_session,
               samesite: 'Strict',
-              secure:   secure
+              secure:   secure,
+              expires:  0
             });
             if (!cookie_written) {
             	logger.error('\n' + 'failed to write cookie: ' + cookie_names.user_session);
@@ -535,11 +574,13 @@ var j1 = (function () {
       }
 
       logger.info('\n' + 'update user session cookie');
+      logger.debug('\n' + 'write to cookie : ' + cookie_names.user_session);
       cookie_written = j1.writeCookie({
         name:     cookie_names.user_session,
         data:     user_session,
         samesite: 'Strict',
-        secure:   secure
+        secure:   secure,
+        expires:  0
       });
 
       if (!cookie_written) {
@@ -557,11 +598,13 @@ var j1 = (function () {
       // logger.info(logText);
 
       user_session.timestamp = timestamp_now;
+      logger.debug('\n' + 'write to cookie : ' + cookie_names.user_session);
       cookie_written = j1.writeCookie({
         name:     cookie_names.user_session,
         data:     user_session,
         samesite: 'Strict',
-        secure:   secure
+        secure:   secure,
+        expires:  0
       });
       if (!cookie_written) {
       	logger.error('\n' + 'failed to write cookie: ' + cookie_names.user_session);
@@ -906,11 +949,13 @@ var j1 = (function () {
           user_session = j1.mergeData(user_session, data);
 
           user_session.current_page = current_url.pathname;
+          logger.debug('\n' + 'write to cookie : ' + cookie_names.user_session);
           cookie_written = j1.writeCookie({
             name:     cookie_names.user_session,
             data:     user_session,
             samesite: 'Strict',
-            secure:   secure
+            secure:   secure,
+            expires:  0
           });
           if (!cookie_written) {
           	logger.error('\n' + 'failed to write cookie: ' + cookie_names.user_session);
@@ -956,7 +1001,7 @@ var j1 = (function () {
             } else {
               if (comments) {
                 logger.warn('\n' + 'enable comment provider: ' + comment_provider);
-                $('#main-content').append('<h2 id="leave-a-comment" class="mt-4">Leave a comment</h2>');
+                $('#main-content').append('<h2 id="leave-a-comment" class="mt-4">{{comments_headline}}</h2>');
                 if (comment_provider === 'disqus') {
                   logger.info('\n' + 'load comment provider code: ' + comment_provider);
                   $('#main-content').append('<div id="disqus_thread"></div>');
@@ -977,6 +1022,16 @@ var j1 = (function () {
             // display page
            $('#no_flicker').css('display', 'block');
 
+             // add recommended title to hyvor iframe for SEO optimization (if loadad)
+            if (comment_provider === 'hyvor') {
+              var dependencies_met_load_finished = setInterval (function () {
+              	if ($('#hyvor-talk-view').children().length) {
+              		$('#hyvor-talk-iframe').prop('title', 'Hyvor talk iframe');
+              		clearInterval(dependencies_met_load_finished);
+              	}
+              }, 25);
+            }
+
             // NOTE: Placed tracking warning/info here because page may reloaded
             // after cookie consent selection
             if (user_consent.analyses) {
@@ -1081,7 +1136,7 @@ var j1 = (function () {
           } else {
             if (comments) {
               logger.warn('\n' + 'enable comment provider: ' + comment_provider);
-              $('#main-content').append('<h2 id="leave-a-comment" class="mt-4">Leave a comment</h2>');
+              $('#main-content').append('<h2 id="leave-a-comment" class="mt-4">{{comments_headline}}</h2>');
               if (comment_provider === 'disqus') {
                 logger.info('\n' + 'load comment provider code: ' + comment_provider);
                 $('#main-content').append('<div id="disqus_thread"></div>');
@@ -1102,6 +1157,16 @@ var j1 = (function () {
           // display page
           $('#no_flicker').css('display', 'block');
 
+            // add recommended title to hyvor iframe for SEO optimization (if loadad)
+           if (comment_provider === 'hyvor') {
+             var dependencies_met_load_finished = setInterval (function () {
+               if ($('#hyvor-talk-view').children().length) {
+                 $('#hyvor-talk-iframe').prop('title', 'Hyvor talk iframe');
+                 clearInterval(dependencies_met_load_finished);
+               }
+             }, 25);
+           }
+
           // NOTE: Placed tracking warning/info here because page may reloaded
           // after cookie consent selection
           if (user_consent.analyses) {
@@ -1122,11 +1187,13 @@ var j1 = (function () {
           $('#quickLinksSignInOutButton').css('display', 'none');
 
           user_session.current_page = current_url.pathname;
+          logger.debug('\n' + 'write to cookie : ' + cookie_names.user_session);
           cookie_written = j1.writeCookie({
               name:     cookie_names.user_session,
               data:     user_session,
               samesite: 'Strict',
-              secure:   secure
+              secure:   secure,
+              expires:  0
           });
           if (!cookie_written) {
           	logger.error('\n' + 'failed to write cookie: ' + cookie_names.user_session);
@@ -1501,6 +1568,14 @@ var j1 = (function () {
     //    https://developer.mozilla.org/de/docs/Web/HTTP/Headers/Set-Cookie/SameSite
     //    https://www.smarketer.de/blog/chrome-update-80-cookies/
     // -------------------------------------------------------------------------
+    // SESSION Cookies:
+    // NOT putting an EXPIRES part in will create a session cookie.
+    // -------------------------------------------------------------------------
+    // REMOVING Cookies: Cookies get removed immediately, if the expires
+    // part points to a PAST date (e.g. 01 Jan 1970 00:00:00 UTC).
+    // -------------------------------------------------------------------------
+    // MAX-AGE Cookies: To leave cookies for a specific time, set the expires
+    // part into a FUTUTE date. FOR GDPR compliance, MAX-AGE is 365 days.
     // TODO:
     //    Change attribute "Secure" to true, if HTTPS is used.
     //    Checks and config changes are to be done.
@@ -1517,25 +1592,27 @@ var j1 = (function () {
     //    must now also specify the Secure attribute (they require a secure
     //    context/HTTPS).
     // -------------------------------------------------------------------------
-    writeCookie: function (options /*name, data, [path, expires, samesite, http_only, secure]*/) {
+    writeCookie: function (options /*name, data, [path, expires, domain, samesite, http_only, secure]*/) {
+      var date          = new Date();
+      var timestamp_now = date.toISOString();
+      var cookie_data   = {};
+      var data_json;
+      var data_encoded;
+      var expires;
+      var stringifiedAttributes = '';
+
       var defaults = {
           data: {},
           name: '',
           path: '/',
           expires: 0,
+          domain: 'localhost',
           samesite: 'Strict',
           http_only: false,
           secure: false
       };
-      var settings = $.extend(defaults, options);
 
-      var date          = new Date();
-      var timestamp_now = date.toISOString();
-      var cookie_data   = {};
-      var data_json;
-      var data_encoded;
-      var expires;
-      var stringifiedAttributes = '';
+      var settings = $.extend(defaults, options);
 
       cookie_data.timestamp = timestamp_now;
 
@@ -1550,26 +1627,21 @@ var j1 = (function () {
         data_encoded  = window.btoa(data_json);
       }
 
-//    if (settings.path !== '/') {
-        stringifiedAttributes += '; ' + 'path=' + settings.path;
-//    }
+      stringifiedAttributes += '; ' + 'path=' + settings.path;
 
       if (settings.expires > 0) {
-        settings.expires = new Date(new Date() * 1 + settings.expires * 864e+5);
-        stringifiedAttributes += '; ' + 'expires=' + settings.expires;
+        date.setTime(date.getTime() + (settings.expires * 24 * 60 * 60 * 1000));
+        stringifiedAttributes += '; ' + 'expires=' + date.toUTCString();
       }
 
-//    if (settings.samesite !== 'Strict') {
-        stringifiedAttributes += '; ' + 'SameSite=' + settings.samesite;
-//    }
+      stringifiedAttributes += '; ' + 'SameSite=' + settings.samesite;
 
-      // stringify cookie attributes
       if (settings.secure) {
         stringifiedAttributes += '; ' + 'secure=' + settings.secure;
-        // document.cookie = settings.name + '=' + content +'; path=' + settings.path + '; ' + 'SameSite=' + settings.samesite + '; secure';
       }
 
       // write the cookie
+//    document.cookie = settings.name + '=' + content + '; path=' + settings.path + '; domain=' + settings.domain + '; ' + 'SameSite=' + settings.samesite + '; secure';
       document.cookie = settings.name + '=' + data_encoded + stringifiedAttributes;
 
       if (j1.existsCookie(settings.name)) {