j1-template 2022.0.10 → 2022.0.14

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

@@ -19,6 +19,7 @@ regenerate:                             true
  # -----------------------------------------------------------------------------
  # Test data:
  #  {{ liquid_var | debug }}
+ # cookie_options: {{ cookie_options | debug }}
  # -----------------------------------------------------------------------------
 {% endcomment %}
 
@@ -36,18 +37,21 @@ regenerate:                             true
 -------------------------------------------------------------------------------- {% endcomment %}
 {% assign cookie_defaults     = modules.defaults.cookies.defaults %}
 {% assign cookie_settings     = modules.cookies.settings %}
-
 {% assign consent_defaults    = modules.defaults.cookieconsent.defaults %}
 {% assign consent_settings    = modules.cookieconsent.settings %}
-{% 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 analytics_defaults  = modules.defaults.analytics.defaults %}
+{% assign analytics_settings  = modules.analytics.settings %}
 
 {% comment %} Set config options
 -------------------------------------------------------------------------------- {% endcomment %}
 {% assign consent_options     = consent_defaults | merge: consent_settings %}
 {% assign cookie_options      = cookie_defaults | merge: cookie_settings %}
+{% assign analytics_options   = analytics_defaults | merge: analytics_settings %}
+
+{% comment %} Set variables
+-------------------------------------------------------------------------------- {% endcomment %}
+{% assign tracking_enabled    = analytics_options.enabled %}
+{% assign tracking_id         = analytics_options.google.trackingID %}
 
 {% assign production = false %}
 {% if environment == 'prod' or environment == 'production' %}
@@ -78,17 +82,13 @@ regenerate:                             true
 /* eslint quotes: "off"                                                       */
 // -----------------------------------------------------------------------------
 'use strict';
-
-{% comment %} Main
--------------------------------------------------------------------------------- {% endcomment %}
-j1.adapter['cookieConsent'] = (function (j1, window) {
-
-  var environment       = '{{environment}}';
-  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 comment_provider  = '{{comment_provider}}';
-  var moduleOptions     = {};
+j1.adapter.cookieConsent = (function (j1, window) {
+  var environment                 = '{{environment}}';
+  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 expireCookiesOnRequiredOnly = ('{{cookie_options.expireCookiesOnRequiredOnly}}' === 'true') ? true: false;
+  var moduleOptions               = {};
   var _this;
   var $modal;
   var cookie_names;
@@ -97,7 +97,7 @@ j1.adapter['cookieConsent'] = (function (j1, window) {
   var url;
   var baseUrl;
   var hostname;
-  var domain;
+  var auto_domain;
   var cookie_option_domain;
   var cookie_domain;
   var secure;
@@ -125,7 +125,15 @@ j1.adapter['cookieConsent'] = (function (j1, window) {
     init: function (options) {
 
       // -----------------------------------------------------------------------
-      // globals
+      // Default module settings
+      // -----------------------------------------------------------------------
+      var settings = $.extend({
+        module_name: 'j1.adapter.cookieConsent',
+        generated:   '{{site.time}}'
+      }, options);
+
+      // -----------------------------------------------------------------------
+      // Global variable settings
       // -----------------------------------------------------------------------
       _this                 = j1.adapter.cookieConsent;
       logger                = log4javascript.getLogger('j1.adapter.cookieConsent');
@@ -133,8 +141,8 @@ j1.adapter['cookieConsent'] = (function (j1, window) {
       url                   = new liteURL(window.location.href);
       baseUrl               = url.origin;
       hostname              = url.hostname;
-      domain                = hostname.substring(hostname.lastIndexOf('.', hostname.lastIndexOf('.') - 1) + 1);
-      cookie_option_domain  = '{{cookie_options.domain}}';
+      auto_domain           = hostname.substring(hostname.lastIndexOf('.', hostname.lastIndexOf('.') - 1) + 1);
+      cookie_option_domain  = ('{{cookie_options.domain}}' === 'true');
       secure                = (url.protocol.includes('https')) ? true : false;
       contentLanguage       = '{{site.language}}';
       navigatorLanguage     = navigator.language || navigator.userLanguage;
@@ -142,14 +150,6 @@ j1.adapter['cookieConsent'] = (function (j1, window) {
       // initialize state flag
       _this.state = 'pending';
 
-      // -----------------------------------------------------------------------
-      // Default module settings
-      // -----------------------------------------------------------------------
-      var settings = $.extend({
-        module_name: 'j1.adapter.cookieConsent',
-        generated:   '{{site.time}}'
-      }, options);
-
       {% comment %} Load module config from yml data
       -------------------------------------------------------------------------- {% endcomment %}
       // Load  module DEFAULTS|CONFIG
@@ -174,11 +174,29 @@ j1.adapter['cookieConsent'] = (function (j1, window) {
         var expires     = '{{cookie_options.expires}}';
         var same_site   = '{{cookie_options.same_site}}';
 
+        // // set domain used by cookies
+        // if (cookie_option_domain == 'auto') {
+        //   domainAttribute = domain ;
+        // } else  {
+        //   domainAttribute = '';
+        // }
+
         // set domain used by cookies
-        if (cookie_option_domain == 'auto') {
-          domainAttribute = domain ;
-        } else  {
-          domainAttribute = '';
+        if (cookie_option_domain) {
+          if (cookie_option_domain == 'auto') {
+            domainAttribute = auto_domain;
+            stringifiedAttributes += '; ' + 'Domain=' + domainAttribute;
+          } else if (cookie_option_domain)  {
+            domainAttribute = domain;
+            stringifiedAttributes += '; ' + 'Domain=' + domainAttribute;
+          }
+        }
+
+        // Failsafe: if 'None' is given for samesite in non-secure
+        // environments open access to cookies to subdomains
+        // ---------------------------------------------------------------------
+        if (same_site == 'None' && !secure) {
+          same_site = 'Lax';
         }
 
         if ( j1.getState() === 'finished' ) {
@@ -259,18 +277,21 @@ j1.adapter['cookieConsent'] = (function (j1, window) {
 
     // -------------------------------------------------------------------------
     // cbCookie()
-    // Called by CookieConsent module after the user has
-    // made his selection (callback)
+    // Called (callback) by CookieConsent module after the user has
+    // made his selection
     // -------------------------------------------------------------------------
     cbCookie: function () {
-      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 user_translate      = j1.readCookie(cookie_names.user_translate);
-      var json                = JSON.stringify(user_consent);
-      var user_agent          = platform.ua;
+      var url             = new liteURL(window.location.href);
+      var hostname        = url.hostname;
+      var gaCookies       = j1.findCookie('_ga');
+      var gasCookies      = 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 user_translate  = j1.readCookie(cookie_names.user_translate);
+      var json            = JSON.stringify(user_consent);
+      var user_agent      = platform.ua;
       var cookie_written;
 
       logger.info('\n' + 'entered post selection callback from CookieConsent');
@@ -281,40 +302,15 @@ j1.adapter['cookieConsent'] = (function (j1, window) {
         $('#quickLinksCookieButton').css('display', 'block');
       }
 
-      // jadams, 2021-11-29: disabled additional logs to verify the existance
-      // of J1 and GA cookies (testing only)
-      //
-      // 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);
-      //   logger.warn('\n' + 'skip deleting (unwanted) cookies for this platform');
-      // }
-
       // Manage Google Analytics OptIn/Out
       // See: https://github.com/luciomartinez/gtag-opt-in/wiki
       if (tracking_enabled && tracking_id_valid) {
-        GTagOptIn.register(tracking_id);
-        if (user_consent.analysis)  {
-          logger.info('\n' + 'enable: GA');
-          GTagOptIn.optIn();
-        } else {
-          logger.warn('\n' + 'disable: GA');
-          GTagOptIn.optOut();
-
-          if (!user_agent.includes('iPad')) {
-            gaCookies.forEach(function (item) {
-              logger.warn('\n' + 'delete GA cookie: ' + item);
-              j1.removeCookie({ name: item, domain: cookie_domain });
-            });
-          }
-        }
-
-        // Managing providers using personalization OptIn/Out
-        // (Comments|Ads|Translation)
+        // Managing cookie life-time
+        // ---------------------------------------------------------------------
+        // If cookie settings allows only "required" cookies, all "persistent"
+        // cookies (Comments|Ads|Translation) get expired to "session" for
+        // better GDPR compliance. The GDPR regulations does NOT require
+        // any consent on session-only cookies.
         //
         if (!user_consent.analysis || !user_consent.personalization) {
 
@@ -331,6 +327,7 @@ j1.adapter['cookieConsent'] = (function (j1, window) {
           });
 
           // 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 });
@@ -340,21 +337,41 @@ j1.adapter['cookieConsent'] = (function (j1, window) {
           location.reload(true);
         }
       } else {
-        // jadams, 2021-08-10: remove cookies on invalid GA config or left
-        // cookies from previous session if they exists
+        // Failsafe: Make (really) sure the all GA|GAS cookies removed
+        // left from a previous session/page view for better privacy compliance
+        // ---------------------------------------------------------------------
+
+        // remove cookies on invalid GA config or left from a previous
+        // session/page view if they exists
         // ---------------------------------------------------------------------
         gaCookies.forEach(function (item) {
-          // Skip cookies from Google Ads
-          var gad = item.includes('gad');
-          if (!gad) {
-            logger.warn('\n' + 'delete GA cookie: ' + item);
-            j1.removeCookie({ name: item, domain: cookie_domain });
+          logger.warn('\n' + 'delete GA cookie: ' + item);
+          if (hostname == 'localhost') {
+            j1.removeCookie({ name: item, domain: false, secure: false });
+          } else {
+            j1.removeCookie({ name: item, domain: '.' + hostname, secure: false });
           }
         });
 
-        // Managing providers using personalization OptIn/Out
-        // (Comments|Ads|Translation)
-        //
+        // remove cookies on invalid GAS config or left from a previous
+        // session/page view if they exists
+        // ---------------------------------------------------------------------
+        gasCookies.forEach(function (item) {
+          // Remove cookies from Google Ads
+          logger.warn('\n' + 'delete GAS cookie: ' + item);
+          if (hostname == 'localhost') {
+            j1.removeCookie({ name: item, domain: false, secure: false });
+          } else {
+            j1.removeCookie({ name: item, domain: '.' + hostname, secure: false });
+          }
+        });
+
+        // Managing cookie life-time. If cookie settings allows only
+        // "required" cookies, all "persistent" cookies (Comments|Ads|Translation)
+        // get expired to "session" for better GDPR compliance. The GDPR
+        // regulations|privacy does NOT require any consent on using cookies
+        // for session-only cookies.
+        // ---------------------------------------------------------------------
         if (!user_consent.analysis || !user_consent.personalization) {
           // overload cookie consent settings
           user_translate.analysis         = user_consent.analysis;
@@ -368,10 +385,12 @@ j1.adapter['cookieConsent'] = (function (j1, window) {
             secure:   secure
           });
 
-          // 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 });
+          if (expireCookiesOnRequiredOnly) {
+            // 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 });
+          }
         }
 
         if (moduleOptions.reloadPageOnChange) {

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

@@ -78,10 +78,10 @@ regenerate:                             true
 /* eslint indent: "off"                                                       */
 // -----------------------------------------------------------------------------
 'use strict';
+j1.adapter.fab = (function (j1, window) {
 
-j1.adapter['fab'] = (function (j1, window) {
   // ---------------------------------------------------------------------------
-  // globals
+  // Global variable settings
   // ---------------------------------------------------------------------------
   var isMobile      = j1.core.isMobile();
   var environment   = '{{environment}}';
@@ -116,7 +116,15 @@ j1.adapter['fab'] = (function (j1, window) {
     init: function (options) {
 
       // -----------------------------------------------------------------------
-      // globals
+      // Default module settings
+      // -----------------------------------------------------------------------
+      var settings  = $.extend({
+        module_name: 'j1.adapter.fab',
+        generated:   '{{site.time}}'
+      }, options);
+
+      // -----------------------------------------------------------------------
+      // Global variable settings
       // -----------------------------------------------------------------------
       _this         = j1.adapter.fab;
       logger        = log4javascript.getLogger('j1.adapter.fab');
@@ -132,14 +140,6 @@ j1.adapter['fab'] = (function (j1, window) {
       // create settings object from frontmatterOptions
       var frontmatterOptions = options != null ? $.extend({}, options) : {};
 
-      // -----------------------------------------------------------------------
-      // defaults
-      // -----------------------------------------------------------------------
-      var settings  = $.extend({
-        module_name: 'j1.adapter.fab',
-        generated:   '{{site.time}}'
-      }, options);
-
       // -----------------------------------------------------------------------
       // options loader
       // -----------------------------------------------------------------------

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

@@ -78,10 +78,7 @@ regenerate:                             false
 /* eslint indent: "off"                                                       */
 // -----------------------------------------------------------------------------
 'use strict';
-
-{% comment %} Main
--------------------------------------------------------------------------------- {% endcomment %}
-j1.adapter['framer'] = (function (j1, window) {
+j1.adapter.framer = (function (j1, window) {
 
   {% comment %} Set global variables
   ------------------------------------------------------------------------------ {% endcomment %}
@@ -107,64 +104,65 @@ j1.adapter['framer'] = (function (j1, window) {
 
       var dependencies_met_page_finished = setInterval (function () {
         if (j1.getState() === 'finished') {
-            // -----------------------------------------------------------------------
-            // globals
-            // -----------------------------------------------------------------------
-            _this   = j1.adapter.framer;
-            logger  = log4javascript.getLogger('j1.adapter.framer');
-
-            // initialize state flag
-            _this.setState('started');
-            logger.info('\n' + 'state: ' + _this.getState());
-            logger.info('\n' + 'module is being initialized');
-
-            // -----------------------------------------------------------------------
-            // Default module settings
-            // -----------------------------------------------------------------------
-            var settings = $.extend({
-              module_name: 'j1.adapter.example',
-              generated:   '{{site.time}}'
-            }, options);
-
-            {% comment %} Load module config from yml data
-            -------------------------------------------------------------------------- {% endcomment %}
-            // Load  module DEFAULTS|CONFIG
-            /* eslint-disable */
-            moduleOptions = $.extend({}, {{framer_options | replace: '=>', ':' | replace: 'nil', '""'}});
-            /* eslint-enable */
-
-            if (typeof settings !== 'undefined') {
-              moduleOptions = j1.mergeData(moduleOptions, settings);
-            }
-
-            iFrameResize({
-              log:                      moduleOptions.log,
-              autoResize:               moduleOptions.autoResize,
-              bodyBackground:           moduleOptions.bodyBackground,
-              bodyMargin:               moduleOptions.bodyMargin,
-              checkOrigin:              moduleOptions.checkOrigin,
-              inPageLinks:              moduleOptions.inPageLinks,
-              interval:                 moduleOptions.interval,
-              heightCalculationMethod:  moduleOptions.heightCalculationMethod,
-              maxHeight:                moduleOptions.maxHeight,
-              minWidth:                 moduleOptions.minWidth,
-              maxWidth:                 moduleOptions.maxWidth,
-              minHeight:                moduleOptions.minHeight,
-              resizeFrom:               moduleOptions.resizeFrom,
-              scrolling:                moduleOptions.scrolling,
-              sizeHeight:               moduleOptions.sizeHeight,
-              sizeWidth:                moduleOptions.sizeWidth,
-              tolerance:                moduleOptions.tolerance,
-              widthCalculationMethod:   moduleOptions.widthCalculationMethod,
-              targetOrigin:             moduleOptions.checkOrigin
-            });
-
-            _this.setState('finished');
-            logger.info('\n' + 'state: ' + _this.getState());
-            logger.info('\n' + 'initializing module finished');
-
-            clearInterval(dependencies_met_page_finished);
-            return true;
+
+          // -----------------------------------------------------------------------
+          // Default module settings
+          // -----------------------------------------------------------------------
+          var settings = $.extend({
+            module_name: 'j1.adapter.example',
+            generated:   '{{site.time}}'
+          }, options);
+
+          // -----------------------------------------------------------------------
+          // Global variable settings
+          // -----------------------------------------------------------------------
+          _this   = j1.adapter.framer;
+          logger  = log4javascript.getLogger('j1.adapter.framer');
+
+          // initialize state flag
+          _this.setState('started');
+          logger.info('\n' + 'state: ' + _this.getState());
+          logger.info('\n' + 'module is being initialized');
+
+          {% comment %} Load module config from yml data
+          -------------------------------------------------------------------------- {% endcomment %}
+          // Load  module DEFAULTS|CONFIG
+          /* eslint-disable */
+          moduleOptions = $.extend({}, {{framer_options | replace: '=>', ':' | replace: 'nil', '""'}});
+          /* eslint-enable */
+
+          if (typeof settings !== 'undefined') {
+            moduleOptions = j1.mergeData(moduleOptions, settings);
+          }
+
+          iFrameResize({
+            log:                      moduleOptions.log,
+            autoResize:               moduleOptions.autoResize,
+            bodyBackground:           moduleOptions.bodyBackground,
+            bodyMargin:               moduleOptions.bodyMargin,
+            checkOrigin:              moduleOptions.checkOrigin,
+            inPageLinks:              moduleOptions.inPageLinks,
+            interval:                 moduleOptions.interval,
+            heightCalculationMethod:  moduleOptions.heightCalculationMethod,
+            maxHeight:                moduleOptions.maxHeight,
+            minWidth:                 moduleOptions.minWidth,
+            maxWidth:                 moduleOptions.maxWidth,
+            minHeight:                moduleOptions.minHeight,
+            resizeFrom:               moduleOptions.resizeFrom,
+            scrolling:                moduleOptions.scrolling,
+            sizeHeight:               moduleOptions.sizeHeight,
+            sizeWidth:                moduleOptions.sizeWidth,
+            tolerance:                moduleOptions.tolerance,
+            widthCalculationMethod:   moduleOptions.widthCalculationMethod,
+            targetOrigin:             moduleOptions.checkOrigin
+          });
+
+          _this.setState('finished');
+          logger.info('\n' + 'state: ' + _this.getState());
+          logger.info('\n' + 'initializing module finished');
+
+          clearInterval(dependencies_met_page_finished);
+          return true;
         }
       }, 25);
     }, // END init