j1-template 2021.1.7 → 2021.1.11

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

@@ -28,14 +28,16 @@ regenerate:                             true
 {% comment %} Set config files
 -------------------------------------------------------------------------------- {% endcomment %}
 {% assign environment         = site.environment %}
+{% assign blocks              = site.data.blocks %}
 {% assign modules             = site.data.modules %}
+{% assign template_config     = site.data.j1_config %}
 
 {% comment %} Set config data
 -------------------------------------------------------------------------------- {% endcomment %}
 {% assign consent_defaults    = modules.defaults.cookieconsent.defaults %}
 {% assign consent_settings    = modules.cookieconsent.settings %}
-{% assign tracking_enabled    = site.data.j1_config.analytics.enabled %}
-{% assign tracking_id         = site.data.j1_config.analytics.google.tracking_id %}
+{% assign tracking_enabled    = template_config.analytics.enabled %}
+{% assign tracking_id         = template_config.analytics.google.tracking_id %}
 
 {% comment %} Set config options
 -------------------------------------------------------------------------------- {% endcomment %}
@@ -89,6 +91,7 @@ j1.adapter['cookieConsent'] = (function (j1, window) {
   var user_cookie;
   var logger;
   var logText;
+  var cookie_written;
 
   // 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
@@ -138,31 +141,28 @@ j1.adapter['cookieConsent'] = (function (j1, window) {
       // -----------------------------------------------------------------------
       // initializer
       // -----------------------------------------------------------------------
-      _this.setState('started');
-      logger.info('state: ' + _this.getState());
-      logger.info('module is being initialized');
-
-      j1.cookieConsent = new BootstrapCookieConsent({
-        contentURL:             moduleOptions.contentURL,
-        cookieName:             moduleOptions.cookieName,
-        language:               moduleOptions.language,
-        whitelisted:            moduleOptions.whitelisted,
-        reloadPageOnChange:     moduleOptions.reloadCurrentPage,
-        xhr_data_element:       moduleOptions.xhr_data_element + '-' + moduleOptions.language,
-        postSelectionCallback:  function () {
-            j1.adapter.cookieConsent.cbCookie()
-        }
-      });
-
       var dependencies_met_page_ready = setInterval (function (options) {
-        if ( j1.cookieConsent && j1.getState() === 'finished' ) {
+        if ( j1.getState() === 'finished' ) {
+          _this.setState('started');
+          logger.info('state: ' + _this.getState());
+          logger.info('module is being initialized');
+
+          j1.cookieConsent = new BootstrapCookieConsent({
+            contentURL:             moduleOptions.contentURL,
+            cookieName:             moduleOptions.cookieName,
+            language:               moduleOptions.language,
+            whitelisted:            moduleOptions.whitelisted,
+            reloadPageOnChange:     moduleOptions.reloadPageOnChange,
+            xhr_data_element:       moduleOptions.xhr_data_element + '-' + moduleOptions.language,
+            postSelectionCallback:  function () {j1.adapter.cookieConsent.cbCookie()}
+          });
+
           _this.setState('finished');
           logger.info('state: ' + _this.getState());
           logger.debug('module initialized successfully');
           clearInterval(dependencies_met_page_ready);
         }
       });
-
     }, // END init
 
     // -------------------------------------------------------------------------
@@ -214,23 +214,42 @@ j1.adapter['cookieConsent'] = (function (j1, window) {
     // made his selection (callback)
     // -------------------------------------------------------------------------
     cbCookie: function () {
-      var gaCookies     = j1.findCookie('_ga');
-      var user_state    = j1.readCookie('j1.user.state');
-      var user_consent  = j1.readCookie('j1.user.consent');
-      var json          = JSON.stringify(user_consent);
+      var gaCookies           = j1.findCookie('_ga');
+      var j1Cookies           = j1.findCookie('j1');
+      var cookie_names        = j1.getCookieNames();
+      var user_state          = j1.readCookie(cookie_names.user_state);
+      var user_consent        = j1.readCookie(cookie_names.user_consent);
+      var json                = JSON.stringify(user_consent);
+      var user_agent          = platform.ua;
 
       logger.info('Entered post selection callback from CookieConsent');
       logger.info('Current values from CookieConsent: ' + json);
 
+      // enable cookie button if not visible
+      if ($('#quickLinksCookieButton').css('display') === 'none')  {
+        $('#quickLinksCookieButton').css('display', 'block');
+      }
+
+      // jadams, 2021-07-11: moved to j1 adapter (displayPage)
       // NOTE: Warning needs to be moved to another module
       // because page is reloaded after selection
       //
-      if (tracking_enabled && !tracking_id_valid) {
-        logger.warn('tracking enabled, but invalid tracking id found: ' + tracking_id);
+      // if (tracking_enabled && !tracking_id_valid) {
+      //   logger.error('tracking enabled, but invalid tracking id found: ' + tracking_id);
+      // } else {
+      //   logger.warn('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));
       }
 
-      // for debugging
-      // gaCookies.forEach(item => console.log('cookieConsent: ' + item));
+      if (user_agent.includes('iPad'))  {
+        logger.warn('Product detected : ' + platform.product);
+        logger.warn('Skip deleting (unwanted) cookies for this platform');
+      }
 
       // Manage Google Analytics OptIn/Out
       // See: https://github.com/luciomartinez/gtag-opt-in/wiki
@@ -242,39 +261,41 @@ j1.adapter['cookieConsent'] = (function (j1, window) {
         } else {
           logger.warn('Disable: GA');
           GTagOptIn.optOut();
-          var gaCookies = j1.findCookie('_ga');
-          gaCookies.forEach(function (item) {
-            logger.warn('Delete GA cookie: ' + item);
-            j1.removeCookie({
-              name: item,
-              path: '/'
+
+          if (!user_agent.includes('iPad')) {
+            gaCookies.forEach(function (item) {
+              logger.warn('Delete GA cookie: ' + item);
+              j1.removeCookie({name: item, path: '/'});
             });
-          });
+          }
         }
-      }
 
+        if (!user_consent.analyses || !user_consent.personalization)  {
+          // expire consent|state cookies to session
+          cookie_written = j1.writeCookie({
+            name:     cookie_names.user_state,
+            data:     user_state,
+            samesite: 'Strict'
+          });
+          if (!cookie_written) {
+          	logger.error('failed to write cookie: ' + cookie_names.user_state);
+          }
+
+          cookie_written = j1.writeCookie({
+            name:     cookie_names.user_consent,
+            data:     user_consent,
+            samesite: 'Strict'
+          });
+          if (!cookie_written) {
+          	logger.error('failed to write cookie: ' + cookie_names.user_consent);
+          }
+        }
 
-      // enable cookie button if not visible
-      if ($('#quickLinksCookieButton').css('display') === 'none')  {
-        $('#quickLinksCookieButton').css('display', 'block');
-      }
-
-      if (!user_consent.analyses || !user_consent.personalization)  {
-        // expire consent|state cookies to session
-        j1.writeCookie({
-          name:     'j1.user.state',
-          data:     user_state,
-          samesite: 'Strict'
-        });
-        j1.writeCookie({
-          name:     'j1.user.consent',
-          data:     user_consent,
-          samesite: 'Strict'
-        });
-      }
-
-      // reload page after selection
-      location.reload();
+        if (moduleOptions.reloadPageOnChange)  {
+          // reload current page (skip cache)
+          location.reload(true);
+        }
+      } // END if tracking_enabled
 
     } // END cbCookie
 

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

@@ -393,7 +393,8 @@ j1.adapter['fam'] = (function (j1, window) {
     // reload page
     // -------------------------------------------------------------------------
     reload_page: function () {
-      location.reload();
+      // reload current page (skip cache)
+      location.reload(true);
     }, // END reload_page
 
     // -------------------------------------------------------------------------

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

@@ -41,9 +41,9 @@ regenerate:                             true
 
 {% comment %} Set config files
 -------------------------------------------------------------------------------- {% endcomment %}
-{% 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 %}
@@ -56,6 +56,8 @@ regenerate:                             true
 {% 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 %}
@@ -122,6 +124,11 @@ var j1 = (function () {
   var state                     = 'not_started';
   var mode                      = 'not_detected';
 
+  // Tracking information (GA)
+  var tracking_enabled          = ('{{tracking_enabled}}' === 'true') ? true: false;
+  var tracking_id               = '{{tracking_id}}';
+  var tracking_id_valid         = (tracking_id.includes('tracking-id')) ? false : true;
+
   var current_user_data;
   var current_page;
   var previous_page;
@@ -129,6 +136,7 @@ var j1 = (function () {
   var last_pager_url;
   var app_detected;
   var user_session_detected;
+  var cookie_written;
 
   // Translatior settings (currently NOT supported)
   // var translation_enabled       = {{template_config.translation.enabled}};
@@ -157,17 +165,16 @@ var j1 = (function () {
   var baseUrl;
   var referrer;
 
+  // initial cookie values
   var cookie_names = {
     'app_session':  '{{template_config.cookies.app_session}}',
     'user_session': '{{template_config.cookies.user_session}}',
     'user_state':   '{{template_config.cookies.user_state}}',
     'user_consent': '{{template_config.cookies.user_consent}}'
   };
-
-  // user SESSION cookie (initial values)
   var user_session = {
     'mode':                 'web',
-    'writer':               'web',
+    'writer':               'j1.adapter',
     'locale':               navigator.language || navigator.userLanguage,
     'user_name':            '{{template_config.user.user_name}}',
     'provider':             '{{template_config.user.provider}}',
@@ -182,17 +189,17 @@ var j1 = (function () {
     'previous_page':        'na',
     'last_pager':           '/pages/public/blog/navigator/'
   };
-
   var user_state = {
+    'writer':               'j1.adapter',
+    'theme_css':            '',
     'theme_css':            '',
     'theme_name':           '',
     'theme_author':         '',
-    'theme_version':        '{{site.version}}',
+    'theme_version':        '{{template_version}}',
     'session_active':       false,
     'last_session_ts':      ''
   };
-
-  var user_consent;
+  var user_consent = {};
 
   // ---------------------------------------------------------------------------
   // helper functions
@@ -223,12 +230,12 @@ var j1 = (function () {
       // -----------------------------------------------------------------------
       // global var (function)
       // -----------------------------------------------------------------------
-      var logger        = log4javascript.getLogger('j1.init');
-      var url           = new liteURL(window.location.href);
-      var baseUrl       = url.origin;
-      var date          = new Date();
-      var timestamp_now = date.toISOString();
-      var curr_state    = 'started';
+      var logger            = log4javascript.getLogger('j1.init');
+      var url               = new liteURL(window.location.href);
+      var baseUrl           = url.origin;
+      var date              = new Date();
+      var timestamp_now     = date.toISOString();
+      var curr_state        = 'started';
 
       // -----------------------------------------------------------------------
       // options loader
@@ -262,30 +269,44 @@ var j1 = (function () {
         var url;
         var baseUrl;
 
-        user_state.session_active     = false;
-        user_state.last_session_ts    = timestamp_now;
+        if (user_state) {
+          user_state.session_active     = false;
+          user_state.last_session_ts    = timestamp_now;
 
-        if (!user_consent.analyses || !user_consent.personalization)  {
-          // expire consent|state cookies to session
-          j1.writeCookie({
-            name:     cookie_names.user_consent,
-            data:     user_state,
-            samesite: 'Strict'
-          });
-          j1.writeCookie({
-            name:     cookie_names.user_state,
-            data:     user_state,
-            samesite: 'Strict'
-          });
+          if (!user_consent.analyses || !user_consent.personalization)  {
+            // expire consent|state cookies to session
+            cookie_written = j1.writeCookie({
+              name:     cookie_names.user_consent,
+              data:     user_state,
+              samesite: 'Strict'
+            });
+            if (!cookie_written) {
+              logger.error('failed to write cookie: ' + cookie_names.user_consent);
+            }
+            cookie_written = j1.writeCookie({
+              name:     cookie_names.user_state,
+              data:     user_state,
+              samesite: 'Strict'
+            });
+            if (!cookie_written) {
+            	logger.error('failed to write cookie: ' + cookie_names.user_consent);
+            }
+          } else {
+            cookie_written = j1.writeCookie({
+              name:     cookie_names.user_state,
+              data:     user_state,
+              samesite: 'Strict',
+              expires:  365
+            });
+            if (!cookie_written) {
+            	logger.error('failed to write cookie: ' + cookie_names.user_state);
+            }
+          }
         } else {
-          j1.writeCookie({
-            name:     cookie_names.user_state,
-            data:     user_state,
-            samesite: 'Strict',
-            expires:  365
-          });
+          // jadams, 2021-07-11: on beforeunload, a vaild state cookie
+          // is expected
+          logger.fatal('missing cookie detected for: ' + cookie_names.user_state);
         }
-
       }); // END beforeunload
 
       // -----------------------------------------------------------------------
@@ -297,37 +318,57 @@ var j1 = (function () {
       user_consent  = j1.readCookie(cookie_names.user_consent);
       user_session  =  j1.existsCookie(cookie_names.user_session)
                         ? j1.readCookie(cookie_names.user_session)
-                        : j1.writeCookie({
+                        : cookie_written = j1.writeCookie({
                             name:     cookie_names.user_session,
                             data:     user_session,
                             samesite: 'Strict'
                           });
+      if (!cookie_written) {
+      	logger.error('failed to write cookie: ' + cookie_names.user_session);
+      }
 
       user_state    =  j1.existsCookie(cookie_names.user_state)
                         ? j1.readCookie(cookie_names.user_state)
-                        : j1.writeCookie({
+                        : cookie_written = j1.writeCookie({
                             name:     cookie_names.user_state,
                             data:     user_state,
                             samesite: 'Strict',
                             expires:  365
                           });
+      if (!cookie_written) {
+      	logger.error('failed to write cookie: ' + cookie_names.user_state);
+      }
 
-      user_state.session_active = true;
+      // 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.warn('cookie not found: ' + cookie_names.user_state);
+        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
-        j1.writeCookie({
+        cookie_written = j1.writeCookie({
           name:     cookie_names.user_state,
           data:     user_state,
           samesite: 'Strict'
         });
+        if (!cookie_written) {
+        	logger.error('failed to write cookie: ' + cookie_names.user_state);
+        }
       } else {
-        j1.writeCookie({
+        cookie_written = j1.writeCookie({
           name:     cookie_names.user_state,
           data:     user_state,
           samesite: 'Strict',
           expires:  365
         });
+        if (!cookie_written) {
+        	logger.error('failed to write cookie: ' + cookie_names.user_state);
+        }
       }
 
       // detect middleware (mode 'app') and update user session cookie
@@ -354,11 +395,16 @@ var j1 = (function () {
 
           logger.info(logText);
           logger.info('update user session cookie');
-          j1.writeCookie({
+          cookie_written = j1.writeCookie({
             name:     cookie_names.user_session,
             data:     user_session,
             samesite: 'Strict'
           });
+
+          if (!cookie_written) {
+          	logger.error('failed to write cookie: ' + cookie_names.user_session);
+          }
+
           j1.setState(curr_state);
           logger.info('state: ' + j1.getState());
 
@@ -395,16 +441,20 @@ var j1 = (function () {
             logText                     = 'mode detected: ' + user_session.mode;
 
             logger.info(logText);
-            j1.writeCookie({
+            cookie_written = j1.writeCookie({
               name:     cookie_names.user_session,
               data:     user_session,
               samesite: 'Strict'
             });
+            if (!cookie_written) {
+            	logger.error('failed to write cookie: ' + cookie_names.user_session);
+            }
+
             j1.setState(curr_state);
             logger.info('state: ' + j1.getState());
           }, detectTimeout);
         });
-      } else { // app mode
+      } else { // web mode
         state = 'started';
         logger.info('state: ' + state);
         logger.info('page is being initialized');
@@ -450,12 +500,16 @@ var j1 = (function () {
       }
 
       logger.info('update user session cookie');
-      j1.writeCookie({
+      cookie_written = j1.writeCookie({
         name:     cookie_names.user_session,
         data:     user_session,
         samesite: 'Strict'
       });
 
+      if (!cookie_written) {
+      	logger.error('failed to write cookie: ' + cookie_names.user_session);
+      }
+
       // NOTE: asynchronous calls should be rewitten to xhrData
       // initialize page resources for blocks
       j1.initBanner(settings);
@@ -467,11 +521,14 @@ var j1 = (function () {
       logger.info(logText);
 
       user_session.timestamp = timestamp_now;
-      j1.writeCookie({
+      cookie_written = j1.writeCookie({
         name:     cookie_names.user_session,
         data:     user_session,
         samesite: 'Strict'
       });
+      if (!cookie_written) {
+      	logger.error('failed to write cookie: ' + cookie_names.user_session);
+      }
 
       // -----------------------------------------------------------------------
       // additional BS helpers from j1.core
@@ -788,11 +845,14 @@ var j1 = (function () {
           user_session = j1.mergeData(user_session, data);
 
           user_session.current_page = current_url.pathname;
-          j1.writeCookie({
+          cookie_written = j1.writeCookie({
             name:     cookie_names.user_session,
             data:     user_session,
             samesite: 'Strict'
           });
+          if (!cookie_written) {
+          	logger.error('failed to write cookie: ' + cookie_names.user_session);
+          }
 
           providerPermissions = user_session.provider_permissions;
           categoryAllowed     = providerPermissions.includes(user_session.page_permission);
@@ -821,6 +881,15 @@ var j1 = (function () {
             // display page
             $('#no_flicker').css('display', 'block');
 
+            // NOTE: Placed tracking warning/info here because page may reloaded
+            // after cookie consent selection
+            //
+            if (tracking_enabled && !tracking_id_valid) {
+              logger.error('tracking enabled, but invalid tracking id found: ' + tracking_id);
+            } else {
+              logger.warn('tracking enabled, tracking id found: ' + tracking_id);
+            }
+
             // show|hide cookie icon (should MOVED to Cookiebar ???)
             if (j1.existsCookie(cookie_names.user_consent)) {
               // Display cookie icon
@@ -898,16 +967,28 @@ var j1 = (function () {
           // display page
           $('#no_flicker').css('display', 'block');
 
+          // NOTE: Placed tracking warning/info here because page may reloaded
+          // after cookie consent selection
+          //
+          if (tracking_enabled && !tracking_id_valid) {
+            logger.error('tracking enabled, but invalid tracking id found: ' + tracking_id);
+          } else {
+            logger.warn('tracking enabled, tracking id found: ' + tracking_id);
+          }
+
           logger.info('mode detected: web');
           logger.info('hide signin icon');
           $('#quickLinksSignInOutButton').css('display', 'none');
 
           user_session.current_page = current_url.pathname;
-          j1.writeCookie({
+          cookie_written = j1.writeCookie({
               name:     cookie_names.user_session,
               data:     user_session,
               samesite: 'Strict'
           });
+          if (!cookie_written) {
+          	logger.error('failed to write cookie: ' + cookie_names.user_session);
+          }
 
           // show|hide translator icon (currently NOT supported)
           // if (translation_enabled) {
@@ -1232,14 +1313,17 @@ var j1 = (function () {
 
     // -------------------------------------------------------------------------
     // findCookie()
-    // Search for cookies (names) in the page header that matches
-    // a given regex string. Returns all names found as an array.
+    // Search for cookies (names) in the page header that matches a given
+    // name. Cookie name can be give as full name, like 'j1.user.state', or
+    // as partials like 'j1'
+    // Returns all names found as an array.
     // -------------------------------------------------------------------------
     // See: https://stackoverflow.com/questions/52287989/javascript-cookie-remove-or-delete-with-regex-regular-expression
     // -------------------------------------------------------------------------
-    findCookie: function (regex) {
+    findCookie: function (name) {
       var r=[];
-      document.cookie.replace(new RegExp(regex + "[^= ]*", "g"), function(a){ r.push(a.trim()); });
+
+      document.cookie.replace(new RegExp(name + '[^= ]*', 'g'), function(a){ r.push(a.trim()); });
       return r;
     }, // END findCookie