j1-template 2022.0.5 → 2022.0.9

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

@@ -54,6 +54,9 @@ regenerate:                             true
 {% assign footer_config_defaults    = blocks.defaults.footer.defaults %}
 {% assign toccer_defaults           = modules.defaults.toccer.defaults %}
 
+{% assign cookie_defaults           = modules.defaults.cookies.defaults %}
+{% assign cookie_settings           = modules.cookies.settings %}
+
 {% assign themer_defaults           = modules.defaults.themer.defaults %}
 {% assign themer_settings           = modules.themer.settings %}
 
@@ -67,6 +70,7 @@ regenerate:                             true
 -------------------------------------------------------------------------------- {% endcomment %}
 {% assign toccer_options            = toccer_defaults | merge: toccer_settings %}
 {% assign themer_options            = themer_defaults| merge: themer_settings %}
+{% assign cookie_options            = cookie_defaults | merge: cookie_settings %}
 
 {% assign authentication_options    = authentication_defaults | merge: authentication_settings %}
 
@@ -170,9 +174,7 @@ var j1 = (function () {
   // Default comment provider information
   var comment_provider          = '{{comment_provider}}';
   var site_id                   = '{{site_id}}';
-
-  // Default translator settings (currently NOT supported)
-  // var translation_enabled       = {{template_config.translation.enabled}};
+  var check_cookies             = {{cookie_options.check_cookies}};
 
   var current_user_data;
   var current_page;
@@ -305,7 +307,7 @@ var j1 = (function () {
       j1['xhrDOMState']  = {};
 
       // -----------------------------------------------------------------------
-      // update cookies if browser window get closed
+      // final updates before browser page|tab
       // see: https://stackoverflow.com/questions/3888902/detect-browser-or-tab-closing
       // -----------------------------------------------------------------------
       window.addEventListener('beforeunload', function (event) {
@@ -318,52 +320,27 @@ var j1 = (function () {
         var url;
         var baseUrl;
 
-        // final update of the user state cookie before browser page|tab
-        // get closed
-        if (user_state) {
-          user_state.session_active     = false;
-          user_state.last_session_ts    = timestamp_now;
+        // final update of the user state cookie
+        user_state.session_active     = false;
+        user_state.last_session_ts    = timestamp_now;
 
-          if (!user_consent.analysis || !user_consent.personalization)  {
-            // 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,
-              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,
-              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,
-              samesite: 'Strict',
-              secure:   secure,
-              expires:  365
-            });
-            if (!cookie_written) {
-                logger.error('\n' + 'failed to write cookie: ' + cookie_names.user_state);
-            }
-          }
+        if (!user_consent.analysis || !user_consent.personalization) {
+          logger.debug('\n' + 'write to cookie : ' + cookie_names.user_state);
+
+          cookie_written = j1.writeCookie({
+            name:     cookie_names.user_state,
+            data:     user_state,
+            secure:   secure,
+            expires:  0
+          });
         } else {
-          // jadams, 2021-07-11: on beforeunload, a user state cookie is expected
-          logger.error('\n' + 'missing cookie detected: ' + cookie_names.user_state);
+          logger.debug('\n' + 'write to cookie : ' + cookie_names.user_state);
+          cookie_written = j1.writeCookie({
+            name:     cookie_names.user_state,
+            data:     user_state,
+            secure:   secure,
+            expires:  365
+          });
         }
       }); // END beforeunload
 
@@ -379,115 +356,37 @@ var j1 = (function () {
                         : cookie_written = j1.writeCookie({
                             name:     cookie_names.user_session,
                             data:     user_session,
-                            samesite: 'Strict',
                             secure:   secure,
                             expires:  0
                           });
-      if (!cookie_written) {
-        logger.error('\n' + 'failed to write cookie: ' + cookie_names.user_session);
-      }
 
       user_state    =  j1.existsCookie(cookie_names.user_state)
                         ? j1.readCookie(cookie_names.user_state)
                         : cookie_written = j1.writeCookie({
                             name:     cookie_names.user_state,
                             data:     user_state,
-                            samesite: 'Strict',
                             secure:   secure,
                             expires:  365
                           });
-      if (!cookie_written) {
-        logger.error('\n' + 'failed to write cookie: ' + cookie_names.user_state);
-      }
 
-      // jadams, 2021-07-11: Found situation that user_state NOT initialized
-      // correctly (user_state == false).
-      // TODO: Check if/why user state (cookie NOT created?) NOT initialized
-      // 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;
+      // jadams, 2021-12-06: Check if access to cookies for this site failed.
+      // Possibly, a third-party domain or an attacker tries to access it.
+      if (check_cookies) {
+        if (!user_state) {
+          logger.error('\n' + 'Access to cookie failed or cookie not found: ' + cookie_names.user_state);
+          logger.debug('\n' + 'j1 cookies found:' + j1Cookies.length);
+          // redirect to error page: blocked content
+          window.location.href = '/446.html';
+        }
       }
 
       if (!user_consent.analysis || !user_consent.personalization)  {
-        // 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,
-          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,
-          samesite: 'Strict',
-          secure:   secure,
-          expires:  365
-        });
-        if (!cookie_written) {
-          logger.error('\n' + 'failed to write cookie: ' + cookie_names.user_state);
-        }
+        // expire permanent cookies to session
+        j1.expireCookie({ name: cookie_names.user_state });
+        j1.expireCookie({ name: cookie_names.user_consent });
+        j1.expireCookie({ name: cookie_names.user_translate });
       }
 
-      // jadams, 2021-11-10: anchor links of type #void are used/managed
-      // by the FAB module. No geneneraL use for NOW.
-      // -----------------------------------------------------------------------
-      // initialize event handler for smooth scroll on in-page anchors
-      // $('a[href*=\\#]').on('click', function (event) {
-      //   // ignore void links
-      //   if (window.location.href.includes('#void')||this.href.includes('#void')) {
-      //     return false;
-      //   }
-      //   // for external links, redirect to this page
-      //   if (window.location.pathname !== this.pathname) {
-      //     window.location.href = this.href;
-      //   } else {
-      //     // continue on in-page anchor
-      //     var toccerScrollDuration  = 300;
-      //     var toccerScrollOffset    = 10;
-      //
-      //     // calculate offset value for correct (smooth) scroll position
-      //     //
-      //     var $pagehead       = $('.attic');
-      //     var $navbar         = $('nav.navbar');
-      //     var $adblock        = $('#adblock');
-      //     var navbarType      = $navbar.hasClass('navbar-fixed') ? 'fixed' : 'scrolled';
-      //     var fontSize        = $('body').css('font-size').replace('px','');
-      //     var start           = window.pageYOffset;
-      //     var l               = parseInt(fontSize);
-      //     var h               = $pagehead.length ? $pagehead.height() : 0;
-      //     var n               = $navbar.length ? $navbar.height() : 0;
-      //     var a               = $adblock.length ? $adblock.height() : 0;
-      //     var scrollOffset    = navbarType == 'fixed' ? -1*(n + a + l) : -1*(h + n + a + l);
-      //
-      //     // TODO:  to be checked why this static offset (toccerScrollOffset)
-      //     //        is needed
-      //     scrollOffset        = scrollOffset + toccerScrollOffset;
-      //
-      //     logger.debug('\n' + 'scroll to anchor: ' + this.hash);
-      //     $("html, body").animate({
-      //       scrollTop: $($(this).attr("href")).offset().top + scrollOffset + "px"
-      //     }, {
-      //       duration: toccerScrollDuration,
-      //       easing: "swing"
-      //     });
-      //     // disable bubble up the event
-      //     return false;
-      //   } // End in-page link
-      // }); // END click event on anchors
-
       // initialize event handler for window/history/back on <ESC>
       // -----------------------------------------------------------------------
       window.onkeyup = function (event) {
@@ -522,15 +421,10 @@ var j1 = (function () {
           cookie_written = j1.writeCookie({
             name:     cookie_names.user_session,
             data:     user_session,
-            samesite: 'Strict',
             secure:   secure,
             expires:  0
           });
 
-          if (!cookie_written) {
-            logger.error('\n' + 'failed to write cookie: ' + cookie_names.user_session);
-          }
-
           j1.setState(curr_state);
           logger.info('\n' + 'state: ' + j1.getState());
 
@@ -571,13 +465,9 @@ var j1 = (function () {
             cookie_written = j1.writeCookie({
               name:     cookie_names.user_session,
               data:     user_session,
-              samesite: 'Strict',
               secure:   secure,
               expires:  0
             });
-            if (!cookie_written) {
-                logger.error('\n' + 'failed to write cookie: ' + cookie_names.user_session);
-            }
 
             j1.setState(curr_state);
             logger.info('\n' + 'state: ' + j1.getState());
@@ -606,7 +496,8 @@ var j1 = (function () {
       themeName                 = user_session.theme_name;
       themeCss                  = user_session.theme_css;
 
-      // save last page access
+      // -----------------------------------------------------------------------
+      // Save last page access
       // see: https://stackoverflow.com/questions/3528324/how-to-get-the-previous-url-in-javascript
       // see: https://developer.mozilla.org/de/docs/Web/API/Window/history
       //
@@ -634,15 +525,10 @@ var j1 = (function () {
       cookie_written = j1.writeCookie({
         name:     cookie_names.user_session,
         data:     user_session,
-        samesite: 'Strict',
         secure:   secure,
         expires:  0
       });
 
-      if (!cookie_written) {
-        logger.error('\n' + 'failed to write cookie: ' + cookie_names.user_session);
-      }
-
       // NOTE: asynchronous calls should be rewitten to xhrData
       // initialize page resources for blocks
       j1.initBanner(settings);
@@ -651,20 +537,15 @@ var j1 = (function () {
 
       state = 'running';
       logger.info('\n' + 'state: ' + state);
-      // 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,
         expires:  0
       });
-      if (!cookie_written) {
-        logger.error('\n' + 'failed to write cookie: ' + cookie_names.user_session);
-      }
 
       // -----------------------------------------------------------------------
       // additional BS helpers from j1.core
@@ -786,7 +667,6 @@ var j1 = (function () {
     // initPanel()
     // AJAX fetcher to load and place all panel used for a page
     // -------------------------------------------------------------------------
-    // ToDo:
     initPanel: function ( options ) {
       var logger            = log4javascript.getLogger('j1.initPanel');
       var panel             = [];
@@ -1007,20 +887,17 @@ var j1 = (function () {
           cookie_written = j1.writeCookie({
             name:     cookie_names.user_session,
             data:     user_session,
-            samesite: 'Strict',
             secure:   secure,
             expires:  0
           });
-          if (!cookie_written) {
-            logger.error('\n' + 'failed to write cookie: ' + cookie_names.user_session);
-          }
 
           providerPermissions = user_session.provider_permissions;
           categoryAllowed     = providerPermissions.includes(user_session.page_permission);
 
+          // -------------------------------------------------------------------
           // check protected pages (applies for APP only)
           // make sure that protected pages are ALWAYS checked for permissions
-          // -------------------------------------------------------------------
+          //
           if (
             j1.authEnabled() &&
             user_session.page_permission !== 'public' &&
@@ -1123,13 +1000,7 @@ var j1 = (function () {
               $('#quickLinksCookieButton').css('display', 'none');
             }
 
-            // show|hide translator icon (currently NOT supported)
-            // if (translation_enabled) {
-            //   logger.info('\n' + 'translator detected: google');
-            //   logger.info('\n' + 'initialize language selector');
-            //   $('.goog-te-combo').addClass('form-control');
-            // }
-
+            // -----------------------------------------------------------------
             // show cc icon (currently NOT supported)
             // $('#quickLinksControlCenterButton').css('display', 'block');
 
@@ -1301,20 +1172,9 @@ var j1 = (function () {
           cookie_written = j1.writeCookie({
               name:     cookie_names.user_session,
               data:     user_session,
-              samesite: 'Strict',
               secure:   secure,
               expires:  0
           });
-          if (!cookie_written) {
-            logger.error('\n' + 'failed to write cookie: ' + cookie_names.user_session);
-          }
-
-          // show|hide translator icon (currently NOT supported)
-          // if (translation_enabled) {
-          //   logger.info('\n' + 'translator detected: google');
-          //   logger.info('\n' + 'initialize language selector');
-          //   $('.goog-te-combo').addClass('form-control');
-          // }
 
           // show cc icon (currently NOT supported)
           // $('#quickLinksControlCenterButton').css('display', 'block');
@@ -1450,6 +1310,7 @@ var j1 = (function () {
 
       return scrollOffset;
     },
+
     // -------------------------------------------------------------------------
     // scrollTo()
     // Scrolls smooth to any anchor referenced by an page URL on
@@ -1754,25 +1615,29 @@ var j1 = (function () {
     //    context/HTTPS).
     // -------------------------------------------------------------------------
     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 date                  = new Date();
+      var timestamp_now         = date.toISOString()
+      var url                   = new liteURL(window.location.href);
+      var baseUrl               = url.origin;;
+      var hostname              = url.hostname;
+      var domain                = hostname.substring(hostname.lastIndexOf('.', hostname.lastIndexOf('.') - 1) + 1);
+      var stringifiedAttributes = '';
+      var cookie_data           = {};
       var data_json;
       var data_encoded;
       var expires;
-      var stringifiedAttributes = '';
+      var domainAttribute;
 
       var defaults = {
-          data: {},
-          name: '',
-          path: '/',
-          expires: 0,
-          domain: 'localhost',
-          samesite: 'Strict',
-          http_only: false,
-          secure: false
+          data:         {},
+          name:         '',
+          path:         '{{cookie_options.path}}',
+          expires:      '{{cookie_options.expires}}',
+          domain:       '{{cookie_options.domain}}',
+          samesite:     '{{cookie_options.same_site}}',
+          http_only:    '{{cookie_options.http_only}}',
+          secure:       '{{cookie_options.secure}}'
       };
-
       var settings = $.extend(defaults, options);
 
       cookie_data.timestamp = timestamp_now;
@@ -1788,17 +1653,26 @@ var j1 = (function () {
         data_encoded  = window.btoa(data_json);
       }
 
-      stringifiedAttributes += '; ' + 'path=' + settings.path;
+      stringifiedAttributes += '; ' + 'Path=' + settings.path;
 
       if (settings.expires > 0) {
         date.setTime(date.getTime() + (settings.expires * 24 * 60 * 60 * 1000));
-        stringifiedAttributes += '; ' + 'expires=' + date.toUTCString();
+        stringifiedAttributes += '; ' + 'Expires=' + date.toUTCString();
       }
 
       stringifiedAttributes += '; ' + 'SameSite=' + settings.samesite;
 
-      if (settings.secure) {
-        stringifiedAttributes += '; ' + 'secure=' + settings.secure;
+      // set domain used by cookies
+      if (settings.domain == 'auto') {
+        domainAttribute = domain;
+        stringifiedAttributes += '; ' + 'Domain=' + domainAttribute;
+      } else  {
+        domainAttribute = '';
+        stringifiedAttributes += '; ' + 'Domain=' + domainAttribute;
+      }
+
+      if (settings.secure == 'true') {
+        stringifiedAttributes += '; ' + 'Secure=' + settings.secure;
       }
 
       // write the cookie
@@ -1833,16 +1707,29 @@ var j1 = (function () {
     // removeCookie (Vanilla JS)
     // -------------------------------------------------------------------------
     removeCookie: function (options /*name, [path, domain]*/) {
-      var cookieExists;
       var defaults = {
-          domain: 'localhost',
-          path: '/'
+        path:         '{{cookie_options.path}}',
+        expires:      '{{cookie_options.expires}}',
+        domain:       '{{cookie_options.domain}}',
+        samesite:     '{{cookie_options.same_site}}',
+        http_only:    '{{cookie_options.http_only}}',
+        secure:       '{{cookie_options.secure}}'
       };
+      var cookieExists;
+
       var settings = $.extend(defaults, options);
 
+      // set domain used by cookies
+      if (settings.domain == 'auto') {
+        domainAttribute = domain ;
+      } else  {
+        // domainAttribute = hostname;
+        domainAttribute = '';
+      }
+
       if (j1.findCookie(settings.name)) {
         // clear cookie CONTENT and set expiry date in the PAST
-        document.cookie = settings.name + '=; domain=' + settings.domain + '; expires=Thu, 01 Jan 1970 00:00:00 UTC; path=/;';
+        document.cookie = settings.name + '=; Domain=' + domainAttribute + '; Expires=Thu, 01 Jan 1970 00:00:00 UTC; Path=/;';
         return true;
       } else {
         return false;
@@ -1868,13 +1755,30 @@ var j1 = (function () {
     // to JavaScript. For that reason, attributes needs to be set explicitly.
     // -------------------------------------------------------------------------
     expireCookie: function (options /*name [,path, samesite, secure]*/) {
+      var url             = new liteURL(window.location.href);
+      var baseUrl         = url.origin;;
+      var hostname        = url.hostname;
+      var domain          = hostname.substring(hostname.lastIndexOf('.', hostname.lastIndexOf('.') - 1) + 1);
+      var domainAttribute;
+
       var defaults = {
-          path: '/',
-          samesite: 'Strict',
-          secure: false
+        path:         '{{cookie_options.path}}',
+        expires:      '{{cookie_options.expires}}',
+        domain:       '{{cookie_options.domain}}',
+        samesite:     '{{cookie_options.same_site}}',
+        http_only:    '{{cookie_options.http_only}}',
+        secure:       '{{cookie_options.secure}}'
       };
       var settings  = $.extend(defaults, options);
 
+      // set domain used by cookies
+      if (settings.domain == 'auto') {
+        domainAttribute = domain ;
+      } else  {
+        // domainAttribute = hostname;
+        domainAttribute = '';
+      }
+
       var dc        = document.cookie;                                            // all cookies in page
       var end       = dc.length;                                                  // default to end of the string
       var prefix    = settings.name + '=';                                                 // search string for the cookie name given
@@ -1902,10 +1806,10 @@ var j1 = (function () {
 
       // expire cookie to session
       content = decodeURI(dc.substring(begin + prefix.length, end) ).replace(/"/g, '');
-      if (settings.secure) {
-        document.cookie = settings.name + '=' + content +'; path=' + settings.path + '; ' + 'SameSite=' + settings.samesite + '; secure';
+      if (settings.secure == 'true') {
+        document.cookie = settings.name + '=' + content +'; Path=' + settings.path + '; ' + 'SameSite=' + settings.samesite + '; ' + 'Domain=' + domainAttribute + '; Secure' + '; ';
       } else {
-        document.cookie = settings.name + '=' + content +'; path=' + settings.path + '; ' + 'SameSite=' + settings.samesite;
+        document.cookie = settings.name + '=' + content +'; Path=' + settings.path + '; ' + 'SameSite=' + settings.samesite + '; ' + 'Domain=' + domainAttribute + '; ';
       }
 
       return true;

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

@@ -203,7 +203,6 @@ j1.adapter['themer'] = (function (j1, window) {
              cookie_written = j1.writeCookie({
                name:     cookie_names.user_state,
                data:     user_state,
-               samesite: 'Strict',
                secure:   secure,
                expires:  365
              });