Use template file to make the notice translatable and move stuff out …

…of JS
Kungbib · May 28, 2021 · 06e407f · 06e407f
1 parent 2342905
commit 06e407f
Show file tree

Hide file tree

Showing 6 changed files with 60 additions and 27 deletions.
diff --git a/cookieNotice/CookieNoticePlugin.inc.php b/cookieNotice/CookieNoticePlugin.inc.php
@@ -6,21 +6,43 @@ public function register($category, $path, $mainContextId = NULL) {
         $success = parent::register($category, $path);
 
         if ($success && $this->getEnabled()) {
+            HookRegistry::register('TemplateManager::display', array($this, 'registerResources'));
+            HookRegistry::register('Templates::Common::Footer::PageFooter', array($this, 'insertHTML'));
+        }
+
+        return $success;
+    }
+
+    function registerResources($hookName, $params) {
+        $request = Application::get()->getRequest();
+        $templateMgr = TemplateManager::getManager($request);
+
+        $templateMgr->addStyleSheet(
+            'cookieNoticeStyles',
+            $request->getBaseUrl() . '/' . $this->getPluginPath() . '/css/cookieNotice.css',
+            ['context' => ['backend', 'frontend']]
+        );
+
+        $templateMgr->addJavaScript(
+            'cookieNoticeScript',
+            $request->getBaseUrl() . '/' . $this->getPluginPath() . '/js/cookieNotice.js',
+            ['context' => ['backend', 'frontend']]
+        );
+
+        return false;
+    }
+
+    function insertHTML($hookName, $params) {
+        $request = Application::get()->getRequest();
+
+        if ($request->getCookieVar('cookieNotice') != 1) {
             $request = Application::get()->getRequest();
             $templateMgr = TemplateManager::getManager($request);
-            $templateMgr->addStyleSheet(
-                'cookieNoticeStyles',
-                $request->getBaseUrl() . '/' . $this->getPluginPath() . '/css/cookieNotice.css',
-                ['context' => ['backend', 'frontend']]
-            );
-            $templateMgr->addJavaScript(
-                'cookieNoticeScript',
-                $request->getBaseUrl() . '/' . $this->getPluginPath() . '/js/cookieNotice.js',
-                ['context' => ['backend', 'frontend']]
-            );
+            $output =& $params[2];
+            $output .= $templateMgr->fetch($this->getTemplateResource('cookieNotice.tpl'));
         }
 
-        return $success;
+        return false;
     }
 
     public function getDisplayName() {

diff --git a/cookieNotice/js/cookieNotice.js b/cookieNotice/js/cookieNotice.js
@@ -1,20 +1,11 @@
-let cookieInfoUrl = 'https://publicera.kb.se/kakor';
-let cookieDurationDays = 365;
-
 document.addEventListener('DOMContentLoaded', function() {
   if (!document.cookie.split(';').some((item) => item.trim().startsWith('cookieNotice='))) {
-      const confirmationHtml = `
-        <div id="cookie-notice" class="alert alert-primary" role="alert">
-          <div class="container">
-            Genom att använda Publicera godkänner du de kakor (cookies) som finns på webbplatsen. <a href="${cookieInfoUrl}">Läs mer om hur vi använder kakor</a>.
-            <button id="cookie-notice-confirmation" type="button" class="btn btn-secondary btn-light btn-sm">OK, jag förstår</button>
-          </div>
-        </div>
-      `;
-      document.body.insertAdjacentHTML('afterbegin', confirmationHtml);
+      let cookieNotice = document.getElementById('cookie-notice');
+      document.body.insertAdjacentElement('afterbegin', cookieNotice);
+
       document.getElementById('cookie-notice-confirmation').addEventListener('click', function() {
-        document.cookie = `cookieNotice=1; max-age=${60*60*24*cookieDurationDays}`;
+        document.cookie = `cookieNotice=1; max-age=${60*60*24*365}; SameSite=Strict`;
         document.getElementById('cookie-notice').classList.add('cookie-notice-hidden');
       });
   }
-});
+});
diff --git a/cookieNotice/locale/en_US/locale.po b/cookieNotice/locale/en_US/locale.po
@@ -3,3 +3,9 @@ msgstr "Cookie Notice Plugin"
 
 msgid "plugins.generic.cookieNotice.description"
 msgstr "Turns on a site-wide cookie notice."
+
+msgid "plugins.generic.cookieNotice.infoText"
+msgstr "By using Publicera you accept the cookies that we use on the website. <a href=\"/index/cookies\">Read more about how we use cookies</a>."
+
+msgid "plugins.generic.cookieNotice.confirmationButtonText"
+msgstr "OK, I understand"
diff --git a/cookieNotice/locale/sv_SE/locale.po b/cookieNotice/locale/sv_SE/locale.po
@@ -3,3 +3,9 @@ msgstr "Cookie-notifieringsplugin"
 
 msgid "plugins.generic.cookieNotice.description"
 msgstr "Informerar besökare om att cookies används."
+
+msgid "plugins.generic.cookieNotice.infoText"
+msgstr "Genom att använda Publicera godkänner du de kakor (cookies) som finns på webbplatsen. <a href=\"/index/cookies\">Läs mer om hur vi använder kakor</a>."
+
+msgid "plugins.generic.cookieNotice.confirmationButtonText"
+msgstr "OK, jag förstår"
diff --git a/cookieNotice/templates/cookieNotice.tpl b/cookieNotice/templates/cookieNotice.tpl
@@ -0,0 +1,8 @@
+<div id="cookie-notice" class="alert alert-primary" role="alert">
+  <div class="container">
+    {translate key='plugins.generic.cookieNotice.infoText'}
+    <button id="cookie-notice-confirmation" type="button" class="btn btn-secondary btn-light btn-sm">
+      {translate key='plugins.generic.cookieNotice.confirmationButtonText'}
+    </button>
+  </div>
+</div>
diff --git a/cookieNotice/version.xml b/cookieNotice/version.xml
@@ -3,8 +3,8 @@
 <version>
   <application>cookieNotice</application>
   <type>plugins.generic</type>
-  <release>1.0.0</release>
-  <date>2021-05-25</date>
+  <release>1.0.1</release>
+  <date>2021-05-28</date>
   <lazy-load>1</lazy-load>
   <sitewide>1</sitewide>
   <class>CookieNoticePlugin</class>