Changeset 36002

Timestamp:

2022-01-14T11:01:06+13:00 (2 years ago)

Author:

cstephen

Message:

Disable cookieconsent when XSL param is not set, and fully localise it.

Location:

main/trunk/greenstone3/web/interfaces/default_wip

Files:

• js/cookieconsent-init.js (modified) (3 diffs)
• transform/layouts/header.xsl (modified) (2 diffs)

main/trunk/greenstone3/web/interfaces/default_wip/js/cookieconsent-init.js

@@ -1 +1 @@
 // @ts-nocheck
-// See https://github.com/orestbida/cookieconsent for customisation options
+
+/**
+ * Initialisation for the cookieconsent.js script, version 2.7.2.
+ * See https://github.com/orestbida/cookieconsent for customisation options.
+ * The translation strings that are referenced in this document via 'gs.text.ccm.XXX'
+ * can be found in the 'interface_default<_LANG>.properties' files, under 'WEB-INF/classes'.
+ */
 
 // obtain plugin
@@ -8 +14 @@
 cc.run({
     current_lang: 'en',
-    autoclear_cookies: true,                   // default: false
-    // theme_css: '../style/cookieconsent.css',  // 🚚 replace with a valid path
+    autoclear_cookies: false,                  // default: false
     page_scripts: true,                        // default: false
-    cookie_path: '/greenstone3',                       // default: root ( / )
+    cookie_path: '/greenstone3',               // default: root ( / )
     gui_options: {
         consent_modal: {
-            layout: 'cloud',               // box/cloud/bar
-            position: 'bottom left',     // bottom/middle/top + left/right/center
-            transition: 'slide',           // zoom/slide
-            swap_buttons: false            // enable to invert buttons
+            layout: 'cloud',                   // box/cloud/bar
+            position: 'bottom left',           // bottom/middle/top + left/right/center
+            transition: 'slide',               // zoom/slide
+            swap_buttons: false                // enable to invert buttons
         },
         settings_modal: {
-            layout: 'box',                 // box/bar
-            // position: 'left',           // left/right - only valid with 'bar' layout
-            transition: 'slide'            // zoom/slide
+            layout: 'box',                     // box/bar
+            // position: 'left',               // left/right - only valid with 'bar' layout
+            transition: 'slide'                // zoom/slide
         }
     },
@@ -70 +75 @@
             settings_modal: {
                 title: gs.text.ccm.Manager_Title,
-                save_settings_btn: 'Close',
-                accept_all_btn: 'Accept All',
-                // reject_all_btn: 'Reject All',
-                close_btn_label: 'Close',
+                save_settings_btn: gs.text.ccm.Manager_SaveSettingsButton,
+                accept_all_btn: gs.text.ccm.Manager_AcceptAllButton,
+                // reject_all_btn: ccm.Manager_AcceptNecessaryButton,
+                close_btn_label: gs.text.ccm.Manager_CloseButton,
                 cookie_table_headers: [
-                    {col1: 'Name'},
-                    {col2: 'Domain'},
-                    {col3: 'Expiration'},
-                    {col4: 'Description'}
+                    { name: gs.text.ccm.Manager.CookieTableHeaders_Name },
+                    { provider: gs.text.ccm.Manager.CookieTableHeaders_Provider },
+                    { expiration: gs.text.ccm.Manager.CookieTableHeaders_Expiration },
+                    { description: gs.text.ccm.Manager.CookieTableHeaders_Description }
                 ],
                 blocks: [
                     {
-                        title: 'Cookie Usage',
-                        description: 'Greenstone uses cookies to ensure the basic functionalities of the website. You can view this cookie manager later by visiting the preferences page.'
+                        description: gs.text.ccm.Manager_Description
                     },
                     {
-                        title: 'Required Cookies',
-                        description: 'These cookies are essential to ensuring that Greenstone operates properly',
+                        title: gs.text.ccm.Manager.RequiredCookies_Title,
+                        description: gs.text.ccm.Manager.RequiredCookies_Description,
                         toggle: {
-                            value: 'required',
+                            value: 'required', // The cookie collection to toggle
                             enabled: true,
                             readonly: true
                         },
-                        cookie_table: [             // list of all expected cookies
+                        cookie_table: [
                             {
-                                col1: 'JSESSIONID',
-                                col2: window.location.hostname,
-                                col3: 'End of session',
-                                col4: 'Allows Greenstone to maintain your login status, chosen language, site settings and favourites basket',
+                                name: 'JSESSIONID',
+                                provider: window.location.hostname,
+                                expiration: gs.text.ccm.Manager.CookieTable_EndOfSessionExpiration,
+                                description: gs.text.ccm.Manager.RequiredCookies.JSESSIONID_Description,
                             },
                             {
-                                col1: 'supportsXSLT',
-                                col2: window.location.hostname,
-                                col3: 'End of session',
-                                col4: 'Allows Greenstone to tell whether or not your browser supports client-side XSLT transformations.'
+                                name: 'supportsXSLT',
+                                provider: window.location.hostname,
+                                expiration: gs.text.ccm.Manager.CookieTable_EndOfSessionExpiration,
+                                description: gs.text.ccm.Manager.RequiredCookies.supportsXSLT_Description
                             }
                         ]

main/trunk/greenstone3/web/interfaces/default_wip/transform/layouts/header.xsl

@@ -11 +11 @@
   <xsl:include href="../shared-templates.xsl"/>
   <xsl:include href="../javascript-global-setup.xsl"/>
+
+  <xsl:param name="cookie_consent"/>
   
   <!-- If the c parameter is empty then use the p.c parameter for the collection name-->
@@ -123 +125 @@
     <script type="text/javascript" src="interfaces/{$interface_name}/js/ace/ace.js"><xsl:text> </xsl:text></script>
     
-    <link rel="stylesheet" href="interfaces/{$interface_name}/style/cookieconsent.css" type="text/css"/>
-    <gslib:langfrag name="ccm" />
-    <script defer="true" type="text/javascript" src="interfaces/{$interface_name}/js/cookieconsent.js"><xsl:text> </xsl:text></script>
-    <script defer="true" type="text/javascript" src="interfaces/{$interface_name}/js/cookieconsent-init.js"><xsl:text> </xsl:text></script>
+    <!-- Cookie Consent Manager -->
+    <xsl:choose>
+        <xsl:when test="$cookie_consent">
+            <link rel="stylesheet" href="interfaces/{$interface_name}/style/cookieconsent.css" type="text/css"/>
+            <gslib:langfrag name="ccm" />
+            <script defer="true" type="text/javascript" src="interfaces/{$interface_name}/js/cookieconsent.js"><xsl:text> </xsl:text></script>
+            <script defer="true" type="text/javascript" src="interfaces/{$interface_name}/js/cookieconsent-init.js"><xsl:text> </xsl:text></script>
+        </xsl:when>
+    </xsl:choose>
 
     <script type="text/javascript" src="interfaces/{$interface_name}/js/zoomer.js"><xsl:text> </xsl:text></script>