j1-template 2022.0.9 → 2022.0.13

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

@@ -0,0 +1,442 @@
+---
+regenerate:                             true
+---
+
+{% capture cache %}
+
+{% comment %}
+ # -----------------------------------------------------------------------------
+ # ~/assets/themes/j1/adapter/js/advertising.js
+ # Liquid template to adapt advertising plugin
+ #
+ # Product/Info:
+ # https://jekyll.one
+ # Copyright (C) 2021 Juergen Adams
+ #
+ # J1 Template is licensed under the MIT License.
+ # For details, see https://jekyll.one
+ # -----------------------------------------------------------------------------
+ # Test data:
+ #  {{ liquid_var | debug }}
+ #  advertising_options:  {{ advertising_options | debug }}
+ # -----------------------------------------------------------------------------
+{% endcomment %}
+
+{% comment %} Liquid procedures
+-------------------------------------------------------------------------------- {% endcomment %}
+
+{% comment %} Set global settings
+-------------------------------------------------------------------------------- {% endcomment %}
+{% assign environment       = site.environment %}
+{% assign asset_path        = "/assets/themes/j1" %}
+
+{% comment %} Process YML config data
+================================================================================ {% endcomment %}
+
+{% comment %} Set config files
+-------------------------------------------------------------------------------- {% endcomment %}
+{% assign template_config   = site.data.j1_config %}
+{% assign blocks            = site.data.blocks %}
+{% assign modules           = site.data.modules %}
+
+{% comment %} Set config data (settings only)
+-------------------------------------------------------------------------------- {% endcomment %}
+{% assign cookie_defaults      = modules.defaults.cookies.defaults %}
+{% assign cookie_settings      = modules.cookies.settings %}
+{% assign advertising_defaults = modules.defaults.advertising.defaults %}
+{% assign advertising_settings = modules.advertising.settings %}
+
+{% comment %} Set config options (settings only)
+-------------------------------------------------------------------------------- {% endcomment %}
+{% assign cookie_options       = cookie_defaults | merge: cookie_settings %}
+{% assign advertising_options  = advertising_defaults | merge: advertising_settings %}
+
+{% comment %} Variables
+-------------------------------------------------------------------------------- {% endcomment %}
+{% assign advertising           = advertising_options.enabled %}
+{% assign advertising_provider  = advertising_options.provider %}
+
+{% assign production = false %}
+{% if environment == 'prod' or environment == 'production' %}
+  {% assign production = true %}
+{% endif %}
+
+/*
+ # -----------------------------------------------------------------------------
+ # ~/assets/themes/j1/adapter/js/advertising.js
+ # J1 Adapter for advertising
+ #
+ # Product/Info:
+ # https://jekyll.one
+ #
+ # Copyright (C) 2021 Juergen Adams
+ #
+ # J1 Template is licensed under the MIT License.
+ # For details, see https://jekyll.one
+ # -----------------------------------------------------------------------------
+ #  Adapter generated: {{site.time}}
+ # -----------------------------------------------------------------------------
+*/
+
+// -----------------------------------------------------------------------------
+// ESLint shimming
+// -----------------------------------------------------------------------------
+/* eslint indent: "off"                                                       */
+// -----------------------------------------------------------------------------
+'use strict';
+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}};
+var addBorderOnUnfilled     = {{advertising_options.google.addBorderOnUnfilled}};
+var checkTrackingProtection = {{advertising_options.google.checkTrackingProtection}};
+var showErrorPageOnBlocked  = {{advertising_options.google.showErrorPageOnBlocked}};
+var adInitializerScriptText;
+var tracking_protection;
+var url;
+var baseUrl;
+var hostname;
+var cookie_names;
+var user_consent;
+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
+  // ---------------------------------------------------------------------------
+  return {
+
+    // -------------------------------------------------------------------------
+    // init()
+    // adapter initializer
+    // -------------------------------------------------------------------------
+    init: function (options) {
+
+    {% if advertising %}
+      // [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);
+      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;
+      // }
+
+      {% 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');
+
+      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
+            // -----------------------------------------------------------------
+            // _this.place_ads();
+
+            // add gad api dynamically in the head section
+            // -----------------------------------------------------------------
+            logger.info('\n' + 'add gad api dynamically in section: head');
+            gadScript.async = true;
+            gadScript.id    = 'gad-api';
+            gadScript.src   = '//pagead2.googlesyndication.com/pagead/js/adsbygoogle.js';
+            gadScript.setAttribute('data-ad-client', 'ca-pub-3885670015316130');
+            document.head.appendChild(gadScript);
+
+            // setup monitor for state changes on all ads configured
+            // ---------------------------------------------------------------
+            logger.info('\n' + 'setup monitoring');
+            _this.monitor_ads();
+
+            // run protection check
+            // -------------------------------------------------------------------
+            if (checkTrackingProtection) {
+              logger.info('\n' + 'run checks for tracking protection');
+              _this.check_tracking_protection();
+
+              var dependencies_met_tracking_check_ready = setInterval (function (options) {
+                if (typeof tracking_protection !== 'undefined' ) {
+
+                  var browser_tracking_feature = navigator.DoNotTrack;
+
+                  if (!tracking_protection && !browser_tracking_feature) {
+                    logText = '\n' + 'tracking protection: disabled';
+                    logger.info(logText);
+                  } else {
+                    logText = '\n' + 'tracking protection: enabled';
+                    logger.warn(logText);
+
+                    if (showErrorPageOnBlocked) {
+                      logger.error('\n' + 'redirect to error page (blocked content): HTML-447');
+                      // redirect to error page: blocked content
+                      window.location.href = '/447.html';
+                    }
+                  }
+                }
+                clearInterval(dependencies_met_tracking_check_ready);
+              }, 25);
+            } else {
+              // setup monitor for state changes on all ads configured
+              // ---------------------------------------------------------------
+              logger.info('\n' + 'setup monitoring');
+              _this.monitor_ads();
+
+              _this.setState('finished');
+              logger.info('\n' + 'state: ' + _this.getState());
+              logger.info('\n' + 'module initialized successfully');
+              clearInterval(dependencies_met_tracking_check_ready);
+            }
+            clearInterval(dependencies_met_page_ready);
+          } else {
+            // 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');
+
+            // 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';
+                logger.warn(logText);
+
+                if (showErrorPageOnBlocked) {
+                  logger.error('\n' + 'redirect to error page (blocked content): HTML-447');
+                  // redirect to error page: blocked content
+                  window.location.href = '/448.html';
+                }
+              }
+            }
+            clearInterval(dependencies_met_page_ready);
+          } // END if user_consent.personalization
+        } // END if getState 'finished'
+      }, 25);
+
+      {% when "custom" %}
+      // [INFO   ] [j1.adapter.advertising                  ] [ place provider: Custom Provider ]
+      {% endcase %}
+      // [INFO   ] [j1.adapter.advertising                  ] [ end processing ]
+      {% else %}
+      var dependencies_met_page_ready = setInterval(function() {
+        if (j1.getState() == 'finished') {
+          var ads_found = document.getElementsByClassName('adsbygoogle').length;
+          logger = log4javascript.getLogger('j1.adapter.advertising.google');
+          logger.warn('\n' + 'found ads in page: #' + ads_found);
+          logger.warn('\n' + 'no ads initialized, advertising disabled');
+          clearInterval(dependencies_met_page_ready);
+        }
+      }, 25);
+      {% endif %}
+      return;
+    }, // END init
+
+    // -------------------------------------------------------------------------
+    // monitor_ads()
+    // monitor for state changes on the ad placed in pages (if any)
+    // -------------------------------------------------------------------------
+    monitor_ads: function () {
+
+      $('.adsbygoogle').attrchange({
+        trackValues: true,
+        callback: function (event) {
+          if (event.newValue === 'unfilled') {
+            var elm = event.target.dataset;
+            if (addBorderOnUnfilled) { $('.adsbygoogle').addClass('border--dotted'); }
+            if (elm.adClient) {
+              logger.warn('\n' + 'found ad state ' + event.newValue + ' for slot: ' + elm.adSlot);
+              if (autoHideOnUnfilled) {
+                logger.warn('\n' + ' hide ad for slot: ' + elm.adSlot);
+                $('#' + elm.adSlot ).hide();
+              }
+            }
+          }
+        }
+      });
+    },
+
+    // -------------------------------------------------------------------------
+    // check_tracking_protection()
+    // detect if a user is using tracking protection
+    // NOTE:
+    // Firefox uses a list obtained from 'https://disconnect.me/trackerprotection'
+    // for its tracking protection. The checker use an image loaded from a
+    // domain that is on that list (facebook.com), and an image that will
+    // exist (tracking pixel).
+    //
+    // See for more details:
+    //  https://stackoverflow.com/questions/33959324/how-to-detect-if-a-user-is-using-tracking-protection-in-firefox-42
+    // -------------------------------------------------------------------------
+    check_tracking_protection: function () {
+      var logger = log4javascript.getLogger('j1.adapter.advertising.tracking.monitor');
+
+      logText = '\n' + 'check for trackingprotection';
+      logger.info(logText);
+
+      function checkTrackingProtection() {
+        if (!checkTrackingProtection.promise) {
+          checkTrackingProtection.promise = new Promise(function(resolve, reject) {
+
+            var time = Date.now();
+            var img = new Image();
+            img.onload = resolve;
+            img.onerror = function() {
+              if ((Date.now() - time) < 50) {
+                reject(new Error("Rejected."));
+              } else {
+                resolve(new Error("Takes too long."));
+              }
+            };
+            img.src = '//www.facebook.com/tr/';
+          }).then((result) => {
+            tracking_protection = false;
+          }).catch(e => {
+            tracking_protection = true;
+            logger.debug('\n' + 'detection details: ' + e);
+          });
+        }
+      }
+      checkTrackingProtection();
+    }, // END check_tracking_protection
+
+    // -------------------------------------------------------------------------
+    // place_ads()
+    // place ads configured|enabled
+    // -------------------------------------------------------------------------
+    place_ads: function () {
+
+      logText = '\n' + 'ads are being placed';
+      logger.info(logText);
+
+      // START loadig ads
+      var dependencies_met_page_ready = setInterval (function (options) {
+        if (j1.getState() === 'finished') {
+
+          {% comment %} See loop for loading elements with adapter/scroller.js
+          ---------------------------------------------------------------------- {% endcomment %}
+          clearInterval(dependencies_met_page_ready);
+
+        }
+      });
+      // END place ads
+    },
+
+    // -------------------------------------------------------------------------
+    // messageHandler()
+    // manage messages send from other J1 modules
+    // -------------------------------------------------------------------------
+    messageHandler: function (sender, message) {
+      var json_message = JSON.stringify(message, undefined, 2);
+
+      logText = '\n' + 'received message from ' + sender + ': ' + json_message;
+      logger.debug(logText);
+
+      // -----------------------------------------------------------------------
+      //  Process commands|actions
+      // -----------------------------------------------------------------------
+      if (message.type === 'command' && message.action === 'module_initialized') {
+        //
+        // Place handling of command|action here
+        //
+        logger.info('\n' + message.text);
+      }
+
+      //
+      // Place handling of other command|action here
+      //
+
+      return true;
+    }, // END messageHandler
+
+    // -------------------------------------------------------------------------
+    // setState()
+    // Sets the current (processing) state of the module
+    // -------------------------------------------------------------------------
+    setState: function (stat) {
+      _this.state = stat;
+    }, // END setState
+
+    // -------------------------------------------------------------------------
+    // getState()
+    // Returns the current (processing) state of the module
+    // -------------------------------------------------------------------------
+    getState: function () {
+      return _this.state;
+    } // END getState
+
+  }; // END return
+})(j1, window);
+
+{% endcapture %}
+{% if production %}
+  {{ cache | minifyJS }}
+{% else %}
+  {{ cache | strip_empty_lines }}
+{% endif %}
+{% assign cache = nil %}

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

@@ -74,10 +74,7 @@ regenerate:                             false
 /* eslint indent: "off"                                                       */
 // -----------------------------------------------------------------------------
 'use strict';
-
-{% comment %} Main
--------------------------------------------------------------------------------- {% endcomment %}
-j1.adapter['algolia'] = (function (j1, window) {
+j1.adapter.algolia = (function (j1, window) {
 
   {% comment %} Set global variables
   ------------------------------------------------------------------------------ {% endcomment %}
@@ -101,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
       // -----------------------------------------------------------------------
@@ -118,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');