j1-template 2022.0.12 → 2022.0.13

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5c037151437cd15323621e862ab96516d0949d4de2d6126a7fd7b2b1ce61ea9f
-  data.tar.gz: 4d70c7d408321ada5b32579b811c42c2758fec708878f6d839174239632889f8
+  metadata.gz: 4f1cafe13f11508c2bba1a30585af76cd2cf2ed917c746dfcdf12f646792b981
+  data.tar.gz: 06c239b5297206fde2f28b3f21046712a2f7beca6c8e8111583e2d50339aee0c
 SHA512:
-  metadata.gz: 8262cafb8ec127d6ec93d2d39f8ec0d5826f6b3dca61314472af7b88506304f5c54024bee15ccc4a782d7baaeae0a0e39de3e9253b0cb6869d3618e63ea70d67
-  data.tar.gz: 2da79d073c80ab3a76a8787b443e2d08b6a4bb3d8ef9ff119efb78ac3659b4a27acecab3925bc5f1527f4f2f6c2134f2524174010146c3cf5a28808fd86fa75d
+  metadata.gz: 3ece2178ed2e520a8d842411b9000ba5b95f3fe8f2c57aa97b0c568eddde3f5df6ab6533cead28d1ecb4ad560d11d2a5808ce8c6f4e5c1d6caf391811ea18b87
+  data.tar.gz: 3e5b29d8ee062cfc81dacccd6f74db3180878fbe3d22f41060256f4275b66c5dc640a500a8a2128663591fb5aed72fa3a1ab2b86c9ebec361518bc6649a78784

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

@@ -89,6 +89,8 @@ j1.adapter.advertising = (function (j1, window) {
 {% comment %} Set global variables
 -------------------------------------------------------------------------------- {% endcomment %}
 var environment             = '{{environment}}';
+var date                    = new Date();
+var timestamp_now           = date.toISOString();
 var gadScript               = document.createElement('script');
 var adInitializerScript     = document.createElement('script');
 var autoHideOnUnfilled      = {{advertising_options.google.autoHideOnUnfilled}};
@@ -102,14 +104,18 @@ var baseUrl;
 var hostname;
 var cookie_names;
 var user_consent;
-var domain;
-var domainAttribute;
-var cookie_option_domain;
-var cookie_domain;
+var advertisingProvider;
+var providerID;
+var validProviderID;
 var _this;
 var logger;
 var logText;
 
+// var domain;
+// var domainAttribute;
+// var cookie_option_domain;
+// var cookie_domain;
+
   // ---------------------------------------------------------------------------
   // Main object
   // ---------------------------------------------------------------------------
@@ -125,38 +131,57 @@ var logText;
       // [INFO   ] [j1.adapter.advertising                  ] [ detected advertising provider (j1_config): {{advertising_provider}}} ]
       // [INFO   ] [j1.adapter.advertising                  ] [ start processing load region head, layout: {{page.layout}} ]
 
+      // -----------------------------------------------------------------------
+      // Default module settings
+      // -----------------------------------------------------------------------
+      var settings = $.extend({
+        module_name: 'j1.adapter.advertising',
+        generated:   '{{site.time}}'
+      }, options);
+
+      // -----------------------------------------------------------------------
+      // Global variable settings
+      // -----------------------------------------------------------------------
       cookie_names          = j1.getCookieNames();
       user_consent          = j1.readCookie(cookie_names.user_consent);
       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}}';
-
-      // set domain used by cookies
-      if (cookie_option_domain == 'auto') {
-        domainAttribute = domain ;
-      } else  {
-        domainAttribute = hostname;
-      }
+
+//    domain                = hostname.substring(hostname.lastIndexOf('.', hostname.lastIndexOf('.') - 1) + 1);
+//    cookie_option_domain  = '{{cookie_options.domain}}';
+
+      // // set domain used by cookies
+      // if (cookie_option_domain == 'auto') {
+      //   domainAttribute = domain ;
+      // } else  {
+      //   domainAttribute = hostname;
+      // }
 
       {% case advertising_provider %}
       {% when "google" %}
       // [INFO   ] [j1.adapter.advertising                  ] [ place provider: Google Adsense ]
+
       _this = j1.adapter.advertising;
       logger = log4javascript.getLogger('j1.adapter.advertising.google');
+
       // 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.advertising',
-        generated:   '2021-12-18 18:55:38 +0000'
-      }, options);
 
       var dependencies_met_page_ready = setInterval(function() {
         if (j1.getState() == 'finished') {
+
+          providerID          = '{{advertising_options.google.publisherID}}';
+          advertisingProvider = 'Google Adsense';
+          validProviderID = (providerID.includes('your')) ? false : true;
+          if (!validProviderID) {
+            logger.warn('\n' + 'invalid publisherID detected for Google Adsense: ' + providerID);
+            logger.info('\n' + 'skip initialization for provider: ' + advertisingProvider);
+            clearInterval(dependencies_met_page_ready);
+            return false;
+          }
+
           if (user_consent.personalization) {
             // place all ads configured for the page
             // NOTE: currently NOT implemented/used
@@ -217,22 +242,26 @@ var logText;
             }
             clearInterval(dependencies_met_page_ready);
           } else {
-            var gaCookies  = j1.findCookie('_ga');
+            // manage GAD cookies if no consent is given|rejected
+            // -----------------------------------------------------------------
+            var gasCookies = j1.findCookie('__ga');
             logger.warn('\n' + 'consent on cookies disabled for personalization');
             logger.warn('\n' + 'initialization of module advertising skipped');
 
-            // jadams, 2021-12-19: remove cookies on invalid GAD config
-            // or left cookies from previous session
-            // -----------------------------------------------------------------
-            j1.removeCookie({ name: '__gads' });
-
-            // jadams, 2021-12-19: delete cookies in loop doesn't work
-            // gaCookies.forEach(function (item) {
-            //   logger.warn('\n' + 'delete GAD cookie: ' + item);
-            //   // j1.removeCookie({ name: item, domain: domainAttribute });
-            //   // j1.removeCookie({ name: item });
-            // });
+            // 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
+              if (hostname == 'localhost') {
+                j1.removeCookie({ name: item, domain: false, secure: false });
+              } else {
+                j1.removeCookie({ name: item, domain: '.' + hostname, secure: false });
+              }
+            });
 
+            // manage tracking protection
+            // -----------------------------------------------------------------
             if (checkTrackingProtection) {
               if (!user_consent.personalization) {
                 logText = '\n' + 'consent on cookies disabled for personalization';
@@ -270,7 +299,7 @@ var logText;
 
     // -------------------------------------------------------------------------
     // monitor_ads()
-    // monitor for state changes on the ad
+    // monitor for state changes on the ad placed in pages (if any)
     // -------------------------------------------------------------------------
     monitor_ads: function () {
 

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

@@ -98,15 +98,6 @@ j1.adapter.algolia = (function (j1, window) {
     // -------------------------------------------------------------------------
     init: function (options) {
 
-      // -----------------------------------------------------------------------
-      // globals
-      // -----------------------------------------------------------------------
-      _this   = j1.adapter.algolia;
-      logger  = log4javascript.getLogger('j1.adapter.algolia');
-
-      // initialize state flag
-      _this.state = 'pending';
-
       // -----------------------------------------------------------------------
       // Default module settings
       // -----------------------------------------------------------------------
@@ -115,6 +106,15 @@ j1.adapter.algolia = (function (j1, window) {
         generated:   '{{site.time}}'
       }, options);
 
+      // -----------------------------------------------------------------------
+      // Global variable settings
+      // -----------------------------------------------------------------------
+      _this   = j1.adapter.algolia;
+      logger  = log4javascript.getLogger('j1.adapter.algolia');
+
+      // initialize state flag
+      _this.state = 'pending';
+
       _this.setState('started');
       logger.info('\n' + 'state: ' + _this.getState());
       logger.info('\n' + 'module is being initialized');

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

@@ -85,12 +85,17 @@ j1.adapter.analytics = (function (j1, window) {
 
 {% comment %} Set global variables
 -------------------------------------------------------------------------------- {% endcomment %}
-var environment   = '{{environment}}';
-var gaScript      = document.createElement('script');
-var trackingID    = '{{analytics_options.google.trackingID}}';
-var optInOut      = {{analytics_options.google.optInOut}};
-var anonymizeIP   = {{analytics_options.google.anonymizeIP}};
-var cookie_names  = j1.getCookieNames();
+var url             = new liteURL(window.location.href);
+var hostname        = url.hostname;
+var environment     = '{{environment}}';
+var gaScript        = document.createElement('script');
+var providerID      = '{{analytics_options.google.trackingID}}';
+var validProviderID = (providerID.includes('your')) ? false : true;
+var optInOut        = {{analytics_options.google.optInOut}};
+var anonymizeIP     = {{analytics_options.google.anonymizeIP}};
+var cookie_names    = j1.getCookieNames();
+var date            = new Date();
+var timestamp_now   = date.toISOString();
 var gaCookies;
 var user_consent;
 var gaExists;
@@ -116,24 +121,37 @@ var logText;
       {% case analytics_provider %}
       {% when "google" %}
       // [INFO   ] [j1.adapter.analytics                    ] [ place provider: Google Adsense ]
+
+      // -----------------------------------------------------------------------
+      // Default module settings
+      // -----------------------------------------------------------------------
+      var settings = $.extend({
+        module_name: 'j1.adapter.analytics',
+        generated:   '{{site.time}}'
+      }, options);
+
+      // -----------------------------------------------------------------------
+      // Global variable settings
+      // -----------------------------------------------------------------------
       _this = j1.adapter.analytics;
       logger = log4javascript.getLogger('j1.adapter.analytics.google');
+
       // 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.analytics',
-        generated:   '2021-12-18 18:55:38 +0000'
-      }, options);
 
-      // remove all ga cookies left from a previous session/page view
-      // -----------------------------------------------------------------------
+      // remove cookies on invalid GA config or left from a previous
+      // session/page view if they exists
+      // ---------------------------------------------------------------------
       gaCookies = j1.findCookie('_ga');
       gaCookies.forEach(function (item) {
-        logger.warn('\n' + 'delete GA cookie: ' + item);
-        j1.removeCookie({ name: item });
+        logger.warn('\n' + 'delete cookie created by Google Analytics: ' + item);
+        if (hostname == 'localhost') {
+          j1.removeCookie({ name: item, domain: false, secure: false });
+        } else {
+          j1.removeCookie({ name: item, domain: '.' + hostname, secure: false });
+        }
       });
 
       var dependencies_met_page_ready = setInterval(function() {
@@ -143,23 +161,27 @@ var logText;
           if (!gaExists) {
             // add ga api dynamically in the head section
             // -----------------------------------------------------------------
-            logger.info('\n' + 'add ga api dynamically in section: head');
+            logger.info('\n' + 'Google Analytics API added in section: head');
             gaScript.async = true;
             gaScript.id    = 'google-tag-manager';
-            gaScript.src   = '//www.googletagmanager.com/gtag/js?id={{analytics_options.google.trackingID}}';
+            gaScript.src   = '//www.googletagmanager.com/gtag/js?id=' + providerID;
             document.head.appendChild(gaScript);
           }
 
           user_consent  = j1.readCookie(cookie_names.user_consent);
           if (user_consent.analysis) {
-            logger.info('\n' + 'user consent on analytics: ' + user_consent.analysis);
-            logger.info('\n' + 'enable: GA');
-            GTagOptIn.register(trackingID);
-            GTagOptIn.optIn();
+            if (validProviderID) {
+              logger.info('\n' + 'user consent on analytics: ' + user_consent.analysis);
+              logger.info('\n' + 'enable Google Analytics on ID: ' + providerID);
+              GTagOptIn.register(providerID);
+              GTagOptIn.optIn();
+            } else {
+              logger.warn('\n' + 'invalid trackig id detected for Google Analytics: ' + providerID);
+            }
           } else {
             logger.info('\n' + 'user consent on analytics: ' + user_consent.analysis);
-            logger.warn('\n' + 'disable: GA');
-            GTagOptIn.register(trackingID);
+            logger.warn('\n' + 'disable Google Analytics on ID: ' + providerID);
+            GTagOptIn.register(providerID);
             GTagOptIn.optOut();
           }
           clearInterval(dependencies_met_page_ready);
@@ -174,7 +196,7 @@ var logText;
       var dependencies_met_page_ready = setInterval(function() {
         if (j1.getState() == 'finished') {
           logger = log4javascript.getLogger('j1.adapter.analytics.google');
-          logger.info('\n' + 'ga: disabled');
+          logger.info('\n' + 'Google Analytics: disabled');
           clearInterval(dependencies_met_page_ready);
         }
       }, 25);

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

@@ -69,7 +69,15 @@ j1.adapter.asciidoctor = (function (j1, window) {
     init: function (options) {
 
       // -----------------------------------------------------------------------
-      // globals
+      // Default module settings
+      // -----------------------------------------------------------------------
+      var settings = $.extend({
+        module_name: 'j1.adapter.rtable',
+        generated:   '{{site.time}}'
+      }, options);
+
+      // -----------------------------------------------------------------------
+      // Global variable settings
       // -----------------------------------------------------------------------
       _this   = j1.adapter.asciidoctor;
       logger  = log4javascript.getLogger('j1.adapter.asciidoctor');
@@ -79,14 +87,6 @@ j1.adapter.asciidoctor = (function (j1, window) {
       logger.info('\n' + 'state: ' + _this.getState());
       logger.info('\n' + 'module is being initialized');
 
-      // -----------------------------------------------------------------------
-      // Default module settings
-      // -----------------------------------------------------------------------
-      var settings = $.extend({
-        module_name: 'j1.adapter.rtable',
-        generated:   '{{site.time}}'
-      }, options);
-
       // -----------------------------------------------------------------------
       // asciidoctor initializer
       // -----------------------------------------------------------------------

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

@@ -102,7 +102,15 @@ j1.adapter.attic = (function (j1, window) {
     init: function (options) {
 
       // -----------------------------------------------------------------------
-      // globals
+      // Default module settings
+      // -----------------------------------------------------------------------
+      var settings = $.extend({
+        module_name: 'j1.adapter.attic',
+        generated:   '{{site.time}}'
+      }, options);
+
+      // -----------------------------------------------------------------------
+      // Global variable settings
       // -----------------------------------------------------------------------
       _this   = j1.adapter.attic;
       logger  = log4javascript.getLogger('j1.adapter.attic');

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

@@ -69,7 +69,15 @@ j1.adapter.bmd = (function (j1, window) {
     init: function (options) {
 
       // -----------------------------------------------------------------------
-      // globals
+      // Default module settings
+      // -----------------------------------------------------------------------
+      var settings = $.extend({
+        module_name: 'j1.adapter.bmd',
+        generated:   '{{site.time}}'
+      }, options);
+
+      // -----------------------------------------------------------------------
+      // Global variable settings
       // -----------------------------------------------------------------------
       _this   = j1.adapter.bmd;
       logger  = log4javascript.getLogger('j1.adapter.bmd');
@@ -78,15 +86,6 @@ j1.adapter.bmd = (function (j1, window) {
       _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.bmd',
-        generated:   '{{site.time}}'
-      }, options);
-
       // -----------------------------------------------------------------------
       // BMD initializer
       // -----------------------------------------------------------------------

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

@@ -99,15 +99,6 @@ j1.adapter.carousel = (function (j1, window) {
     // -------------------------------------------------------------------------
     init: function (options) {
 
-      // -----------------------------------------------------------------------
-      // globals
-      // -----------------------------------------------------------------------
-      _this   = j1.adapter.carousel;
-      logger  = log4javascript.getLogger('j1.adapter.carousel');
-
-      // initialize state flag
-      _this.state = 'pending';
-
       // -----------------------------------------------------------------------
       // Default module settings
       // -----------------------------------------------------------------------
@@ -116,6 +107,15 @@ j1.adapter.carousel = (function (j1, window) {
         generated:   '{{site.time}}'
       }, options);
 
+      // -----------------------------------------------------------------------
+      // Global variable settings
+      // -----------------------------------------------------------------------
+      _this   = j1.adapter.carousel;
+      logger  = log4javascript.getLogger('j1.adapter.carousel');
+
+      // initialize state flag
+      _this.state = 'pending';
+
       {% comment %} Load module config from yml data
       -------------------------------------------------------------------------- {% endcomment %}
       // Load  module DEFAULTS|CONFIG

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

@@ -89,20 +89,20 @@ j1.adapter.clipboard = (function (j1, window) {
     init: function (options) {
 
       // -----------------------------------------------------------------------
-      // globals
-      // -----------------------------------------------------------------------
-      _this     = j1.adapter.clipboard;
-      language  = '{{site.language}}';
-      logger    = log4javascript.getLogger('j1.adapter.clipboard');
-
-      // -----------------------------------------------------------------------
-      // defaults
+      // Default module settings
       // -----------------------------------------------------------------------
       var settings  = $.extend({
         module_name: 'j1.adapter.clipboard',
         generated:   '{{site.time}}'
       }, options);
 
+      // -----------------------------------------------------------------------
+      // Global variable settings
+      // -----------------------------------------------------------------------
+      _this     = j1.adapter.clipboard;
+      language  = '{{site.language}}';
+      logger    = log4javascript.getLogger('j1.adapter.clipboard');
+
       // initialize state flag
       _this.state = 'started';
       logText = '\n' + 'initialization: started';

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

@@ -124,7 +124,8 @@ var comments_provider = '{{comments_provider}}';
 var dqApiScript       = document.createElement('script');
 var hvApiScript       = document.createElement('script');
 var hvCallbackScript  = document.createElement('script');
-var siteID            = '{{site_id}}';
+var providerID        = '{{site_id}}';
+var validProviderID   = (providerID.includes('your')) ? false : true;
 var comments_headline = '{{comments_headline}}';
 var cookie_names      = j1.getCookieNames();
 var user_consent;
@@ -147,13 +148,18 @@ var logText;
       // [INFO   ] [j1.adapter.comments                    ] [ detected comments provider (j1_config): {{comments_provider}}} ]
       // [INFO   ] [j1.adapter.comments                    ] [ start processing load region head, layout: {{page.layout}} ]
 
-      // default module settings
-      // ----------------------------------------------------------------------
+      // -----------------------------------------------------------------------
+      // Default module settings
+      // -----------------------------------------------------------------------
       var settings = $.extend({
         module_name: 'j1.adapter.comments',
-        generated:   '2021-12-18 18:55:38 +0000'
+        generated:   '{{site.time}}'
       }, options);
 
+      // -----------------------------------------------------------------------
+      // Global variable settings
+      // -----------------------------------------------------------------------
+
       {% if site_id %}
 
       _this = j1.adapter.comments;
@@ -162,9 +168,17 @@ var logText;
       {% case comments_provider %}
       {% when "hyvor" %}
       // [INFO   ] [j1.adapter.comments                    ] [ place provider: Hyvor Talk ]
+
       var dependencies_met_page_ready = setInterval(function() {
         if (j1.getState() == 'finished') {
 
+          if (!validProviderID) {
+            logger.warn('\n' + 'invalid site id detected for Hyvor Talk: ' + providerID);
+            logger.info('\n' + 'skip initialization for provider: ' + comments_provider);
+            clearInterval(dependencies_met_page_ready);
+            return false;
+          }
+
           // initialize state flag, issue init message
           // -------------------------------------------------------------------
           _this.setState('started');
@@ -179,7 +193,7 @@ var logText;
             // -----------------------------------------------------------------
             $('#main-content').append('<h2 id="leave-a-comment" class="mt-4">{{comments_headline}}</h2>');
             logger.info('\n' + 'user consent on comments: ' + user_consent.personalization);
-            logger.info('\n' + 'enable comments provider' + ' {{comments_provider}} on siteID: ' + siteID);
+            logger.info('\n' + 'enable comments provider' + ' {{comments_provider}} on siteID: ' + providerID);
 
             // add Hyvor Talk Web API
             // NOTE: don't change the script id
@@ -193,7 +207,7 @@ var logText;
             // -----------------------------------------------------------------
             hvCallbackScript.id   = 'hyvor-callback';
             hvCallbackScript.text  = '\n';
-            hvCallbackScript.text += 'var HYVOR_TALK_WEBSITE = ' + siteID + '\n';
+            hvCallbackScript.text += 'var HYVOR_TALK_WEBSITE = ' + providerID + '\n';
             hvCallbackScript.text += 'var HYVOR_TALK_CONFIG = {' + '\n';
             hvCallbackScript.text += '		  url: false,' + '\n';
             hvCallbackScript.text += '      id: false' + '\n';
@@ -217,7 +231,7 @@ var logText;
             // disable Hyvor Talk
             // -----------------------------------------------------------------
             logger.info('\n' + 'user consent on comments: ' + user_consent.personalization);
-            logger.warn('\n' + 'disable comments provider' + ' {{comments_provider}} on siteID: ' + siteID);
+            logger.warn('\n' + 'disable Hyvor Talk on site id: ' + providerID);
 
             // remove Hyvor Talk resources
             // -----------------------------------------------------------------
@@ -235,6 +249,13 @@ var logText;
       var dependencies_met_page_ready = setInterval(function() {
         if (j1.getState() == 'finished') {
 
+          if (!validProviderID) {
+            logger.warn('\n' + 'invalid short name detected for Disqus: ' + providerID);
+            logger.info('\n' + 'skip initialization for provider: ' + comments_provider);
+            clearInterval(dependencies_met_page_ready);
+            return;
+          }
+
           // initialize state flag, issue init message
           // -------------------------------------------------------------------
           _this.setState('started');
@@ -247,7 +268,7 @@ var logText;
           if (user_consent.personalization) {
             $('#main-content').append('<h2 id="leave-a-comment" class="mt-4">{{comments_headline}}</h2>');
             logger.info('\n' + 'user consent on comments: ' + user_consent.personalization);
-            logger.info('\n' + 'enable comments provider' + ' {{comments_provider}} on siteID: ' + siteID);
+            logger.info('\n' + 'enable comments provider' + ' {{comments_provider}} on short name: ' + providerID);
 
             // old Disqus Web API init
             // -----------------------------------------------------------------
@@ -279,7 +300,7 @@ var logText;
             // add|initialize Disqus Web API
             // -----------------------------------------------------------------
             dqApiScript.id    = 'dq-web-api';
-            dqApiScript.src   = '//' + siteID + '.disqus.com/embed.js";'
+            dqApiScript.src   = '//' + providerID + '.disqus.com/embed.js";'
             dqApiScript.setAttribute("data-timestamp", '"' + timestamp_now + '"');
             document.head.appendChild(dqApiScript);
 
@@ -288,7 +309,7 @@ var logText;
             $('#main-content').append('<div id="disqus_thread"></div>');
           } else {
             logger.info('\n' + 'user consent on comments: ' + user_consent.personalization);
-            logger.warn('\n' + 'disable comments provider' + ' {{comments_provider}} on siteID: ' + siteID);
+            logger.warn('\n' + 'disable comments provider' + ' {{comments_provider}} on short name: ' + providerID);
             $('#leave-a-comment').remove();
             $('#dq-web-api').remove();
             $('#hdisqus_thread').remove();