UHF-8650 Preparation for the HDS cookie banner module

assets/js/chat_leijuke.js

@@ -31,21 +31,18 @@
     console.warn(`No adapter found for ${chatSelection}!`);
   }
 
-  // @todo UHF-8650: EU Cookie Compliance module will be removed.
-  // @todo UHF-8650: Convert the following code to support HDS cookie banner.
   class EuCookieManager {
     cookieCheck(cookieNames) {
       let cookiesOk = true;
       cookieNames.map((cookieName) => {
-        if (!Drupal.eu_cookie_compliance.hasAgreedWithCategory(cookieName)) cookiesOk = false;
+        if (!Drupal.cookieConsent.getConsentStatus([cookieName])) cookiesOk = false;
       });
       return cookiesOk;
     }
-
     cookieSet() {
-      if (Drupal.eu_cookie_compliance.hasAgreedWithCategory('chat')) return;
+      if (Drupal.cookieConsent.getConsentStatus(['chat'])) return;
 
-      Drupal.eu_cookie_compliance.setAcceptedCategories([ ...Drupal.eu_cookie_compliance.getAcceptedCategories(), 'chat' ]);
+      Drupal.cookieConsent.setAcceptedCategories(['chat']);
     }
   }
 

assets/js/clear-localstorage.js

@@ -8,11 +8,8 @@
   'use strict';
 
   var clearLocalStorage = function () {
-    if (typeof Drupal.eu_cookie_compliance === 'undefined') {
-      return;
-    }
 
-    if (!Drupal.eu_cookie_compliance.hasAgreed('statistics')) {
+    if (!Drupal.cookieConsent.getConsentStatus(['statistics'])) {
       var requireStatistics = [
         'rnsbid',
         'rnsbid_ts',

assets/js/reactAndShareSettings.js

@@ -2,9 +2,7 @@
   'use strict';
 
   var loadReactAndShare = function () {
-    // @todo UHF-8650: EU Cookie Compliance module will be removed.
-    // @todo UHF-8650: Convert the following code to support HDS cookie banner.
-    if (Drupal.eu_cookie_compliance.hasAgreed('statistics')) {
+    if (Drupal.cookieConsent.getConsentStatus(['statistics'])) {
       window.rnsData = {
         apiKey: drupalSettings.reactAndShareApiKey,
         disableFa: true,
@@ -32,11 +30,9 @@
     loadReactAndShare = function () {};
   };
 
-  // Run after choosing cookie settings.
-  $(document).on('eu_cookie_compliance.changeStatus', loadReactAndShare);
-
-  // Run after page is ready.
-  $(document).ready(function () {
+  if (Drupal.cookieConsent.initialized()) {
     loadReactAndShare();
-  });
+  } else {
+    Drupal.cookieConsent.loadFunction(loadReactAndShare);
+  }
 })(jQuery, Drupal);

assets/js/telia_ace.js

@@ -18,17 +18,16 @@
       };
     }
 
-    // @todo UHF-8650: EU Cookie Compliance module will be removed.
-    // @todo UHF-8650: Convert the following code to support HDS cookie banner.
     // eslint-disable-next-line class-methods-use-this
     cookieCheck() {
-      return Drupal.eu_cookie_compliance.hasAgreedWithCategory('chat');
+      return Drupal.cookieConsent.getConsentStatus(['chat']);
     }
 
     // eslint-disable-next-line class-methods-use-this
     cookieSet() {
-      if (Drupal.eu_cookie_compliance.hasAgreedWithCategory('chat')) return;
-      Drupal.eu_cookie_compliance.setAcceptedCategories([ ...Drupal.eu_cookie_compliance.getAcceptedCategories(), 'chat' ]);
+      if (Drupal.cookieConsent.getConsentStatus(['chat'])) return;
+
+      Drupal.cookieConsent.setAcceptedCategories(['chat']);
     }
 
     init() {

assets/js/user_consent_functions.js

@@ -1,13 +1,11 @@
 (function (Drupal) {
   'use strict';
 
-  // @todo UHF-8650: EU Cookie Compliance module will be removed.
-  // @todo UHF-8650: Convert the following code to support HDS cookie banner.
   window.chat_user_consent = {
-    retrieveUserConsent: () => (Drupal.eu_cookie_compliance.hasAgreedWithCategory('chat')),
+    retrieveUserConsent: () => (Drupal.cookieConsent.getConsentStatus(['chat'])),
     confirmUserConsent: () => {
-      if (Drupal.eu_cookie_compliance.hasAgreedWithCategory('chat')) return;
-      Drupal.eu_cookie_compliance.setAcceptedCategories([ ...Drupal.eu_cookie_compliance.getAcceptedCategories(), 'chat' ]);
+      if (Drupal.cookieConsent.getConsentStatus(['chat'])) return;
+      Drupal.cookieConsent.setAcceptedCategories(['chat']);
     }
   };
 

helfi_platform_config.module

@@ -193,7 +193,7 @@ function helfi_platform_config_page_attachments_alter(array &$attachments): void
  */
 function helfi_platform_config_theme() : array {
   return [
-    // @todo Deprecated. Remove when the EU cookie compliance module is removed.
+    // @todo UHF-10862 Remove cookie_consent_intro once the HDBT cookie banner module is in use.
     'cookie_consent_intro' => [
       'variables' => [
         'title' => NULL,
@@ -403,7 +403,13 @@ function helfi_platform_config_system_breadcrumb_alter(
  * Implements hook_preprocess_HOOK().
  */
 function helfi_platform_config_preprocess_react_and_share(&$variables) : void {
-  if (Drupal::moduleHandler()->moduleExists('helfi_eu_cookie_compliance')) {
+  if (Drupal::moduleHandler()->moduleExists('hdbt_cookie_banner')) {
+    /** @var \Drupal\hdbt_cookie_banner\Services\CookieSettings $cookie_settings */
+    $cookie_settings = \Drupal::service('hdbt_cookie_banner.cookie_settings');
+    $variables['privacy_policy_url'] = $cookie_settings->getCookieSettingsPageUrl();
+  }
+  // @todo UHF-10862 Remove once the HDBT cookie banner module is in use.
+  elseif (Drupal::moduleHandler()->moduleExists('helfi_eu_cookie_compliance')) {
     $variables['privacy_policy_url'] = helfi_eu_cookie_compliance_get_privacy_policy_url();
   }
 }

modules/hdbt_cookie_banner/assets/js/hdbt-cookie-banner.js

@@ -1,4 +1,29 @@
-(function (Drupal, drupalSettings) {
+'use strict';
+
+((Drupal, drupalSettings) => {
+
+  // Global cookie consent status object.
+  Drupal.cookieConsent = {
+    initialized: () => {
+      return window && window.hds.cookieConsent;
+    },
+    loadFunction: (loadFunction) => {
+      if (typeof loadFunction === 'function') {
+        document.addEventListener('hds_cookieConsent_ready', loadFunction);
+      }
+    },
+    getConsentStatus: (categories) => {
+      return window &&
+        window.hds.cookieConsent &&
+        window.hds.cookieConsent.getConsentStatus(categories);
+    },
+    setAcceptedCategories: (categories) => {
+      if (Drupal.cookieConsent.initialized()) {
+        window.hds.cookieConsent.setGroupsStatusToAccepted(categories);
+      }
+    },
+  };
+
   Drupal.behaviors.hdbt_cookie_banner = {
     attach: function () {
       if (

modules/hdbt_cookie_banner/config/install/hdbt_cookie_banner.settings.yml

@@ -1,5 +1,5 @@
 langcode: en
-site_settings: ''
+site_settings: '{"languages":[{"code":"fi","name":"Finnish","direction":"ltr"},{"code":"sv","name":"Swedish","direction":"ltr"},{"code":"en","name":"English","direction":"ltr"}],"siteName":"Hel.fi","cookieName":"helfi-cookie-consents","monitorInterval":500,"fallbackLanguage":"en","requiredGroups":[{"groupId":"essential","title":{"fi":"Välttämättömät toiminnalliset evästeet","sv":"Nödvändiga funktionella cookies","en":"Essential cookies"},"description":{"fi":"Välttämättömät evästeet auttavat tekemään verkkosivustosta käyttökelpoisen sallimalla perustoimintoja, kuten sivulla siirtymisen ja sivuston suojattujen alueiden käytön. Verkkosivusto ei toimi kunnolla ilman näitä evästeitä eikä niihin tarvita suostumusta.","sv":"Nödvändiga cookies hjälper till att göra webbplatsen användbar genom att tillåta grundläggande funktioner som att navigera på sidan och använda de skyddade områdena på webbplatsen. Webbplatsen fungerar inte korrekt utan dessa cookies och kräver inte samtycke.","en":"Essential cookies help to make the website usable by allowing basic functions, navigating the page and using the protected areas of the site. The website will not work properly without these cookies and their consent is not required."},"cookies":[{"name":"helfi-cookie-consents","host":"www.hel.fi","type":1,"description":{"fi":"Sivusto käyttää tätä evästettä tietojen tallentamiseen siitä, ovatko kävijät antaneet hyväksyntänsä tai kieltäytyneet evästeiden käytöstä.","sv":"Cookie möjliggör hantering av cookies på webbplatsen.","en":"Used by www.hel.fi Drupal to store information about whether visitors have given or declined the use of cookie categories used on the www.hel.fi site."},"expiration":{"fi":"100 päivää","sv":"100 dagar","en":"100 days"}}]}],"optionalGroups":[],"translations":{"bannerAriaLabel":{"fi":"Evästeasetukset","sv":"Inställningar för kakor","en":"Cookie settings"},"heading":{"fi":"${siteName} käyttää evästeitä","sv":"${siteName} använder kakor","en":"${siteName} uses cookies"},"description":{"fi":"Tämä sivusto käyttää välttämättömiä evästeitä sivun perustoimintojen ja suorituskyvyn varmistamiseksi. Lisäksi käytämme kohdennusevästeitä käyttäjäkokemuksen parantamiseksi, analytiikkaan ja yksilöidyn sisällön näyttämiseen.","sv":"Denna webbplats använder obligatoriska kakor för att säkerställa de grundläggande funktionerna och prestandan. Dessutom använder vi inriktningskakor för bättre användarupplevelse, analytik och individualiserat innehåll.","en":"This website uses required cookies to ensure the basic functionality and performance. In addition, we use targeting cookies to improve the user experience, perform analytics and display personalised content."},"showDetails":{"fi":"Näytä yksityiskohdat","sv":"Visa detaljer","en":"Show details"},"hideDetails":{"fi":"Piilota yksityiskohdat","sv":"Stänga detaljer","en":"Hide details"},"form_heading":{"fi":"Tietoa sivustolla käytetyistä evästeistä","sv":"Information om kakor som används på webbplatsen","en":"About the cookies used on the website"},"form_text":{"fi":"Sivustolla käytetyt evästeet on luokiteltu käyttötarkoituksen mukaan. Alla voit lukea eri luokista ja sallia tai kieltää evästeiden käytön.","sv":"Kakorna som används på webbplatsen har klassificerats enligt användningsändamål. Du kan läsa om de olika klasserna och acceptera eller förbjuda användningen av kakor.","en":"The cookies used on the website have been classified according to their intended use. Below, you can read about the various categories and accept or reject the use of cookies."},"highlightedGroup":{"fi":"Sinun on hyväksyttävä tämä kategoria, jotta voit näyttää valitsemasi sisällön.","sv":"Du måste acceptera den här kategorin för att visa innehållet du har valt.","en":"You need to accept this category to display the content you have selected."},"highlightedGroupAria":{"fi":"Hyvä tietää kategorialle: ${title}","sv":"Bra att veta för kategorin: ${title}","en":"Good to know for category: ${title}"},"showCookieSettings":{"fi":"Näytä evästeasetukset","sv":"Visa kakinställningarna","en":"Show cookie settings"},"hideCookieSettings":{"fi":"Piilota evästeasetukset","sv":"Stänga kakinställningarna","en":"Hide cookie settings"},"acceptedAt":{"fi":"Olet hyväksynyt tämän kategorian: ${date} klo ${time}.","sv":"Du har accepterat denna kategori: ${date} kl. ${time}.","en":"You have accepted this category: ${date} at ${time}."},"tableHeadingsName":{"fi":"Nimi","sv":"Namn","en":"Name"},"tableHeadingsHostName":{"fi":"Evästeen asettaja","sv":"Den som lagrat kakan","en":"Cookie set by"},"tableHeadingsDescription":{"fi":"Käyttötarkoitus","sv":"Användning","en":"Purpose of use"},"tableHeadingsExpiration":{"fi":"Voimassaoloaika","sv":"Giltighetstid","en":"Period of validity"},"tableHeadingsType":{"fi":"Tyyppi","sv":"Typ","en":"Type"},"approveAllConsents":{"fi":"Hyväksy kaikki evästeet","sv":"Acceptera alla kakor","en":"Accept all cookies"},"approveRequiredAndSelectedConsents":{"fi":"Hyväksy valitut evästeet","sv":"Acceptera valda kakor","en":"Accept selected cookies"},"approveOnlyRequiredConsents":{"fi":"Hyväksy vain välttämättömät evästeet","sv":"Acceptera endast nödvändiga","en":"Accept required cookies only"},"settingsSaved":{"fi":"Asetukset tallennettu!","sv":"Inställningar sparade!","en":"Settings saved!"},"notificationAriaLabel":{"fi":"Ilmoitus","sv":"Meddelande","en":"Annoucement"},"type_1":{"fi":"Eväste","sv":"Kakan","en":"Cookie"},"type_2":"localStorage","type_3":"sessionStorage","type_4":"IndexedDB","type_5":"Cache Storage"}}'
 cookie_information:
   title: 'Cookie information'
   content: "A cookie is a small-scale data storage program that a computer browser installs on a user's computer hard drive. Whenever the user's browser retrieves the site from the City of Helsinki's servers, the message is sent back to the user's computer. Javascript and server logs are used to record, for example, the number of users, country of use, usage time and browser used, as well as the content that the visitor has visited. The cookie does not damage the drive.\r\n\r\nCookies are used to speed up, analyze and develop the website and to target content to each user."

modules/hdbt_cookie_banner/hdbt_cookie_banner.install

@@ -0,0 +1,49 @@
+<?php
+
+/**
+ * @file
+ * Contains installation tasks for hdbt_cookie_banner module.
+ */
+
+declare(strict_types=1);
+
+/**
+ * Grants required permissions.
+ */
+function hdbt_cookie_banner_grant_permissions() : void {
+  $permissions = [
+    'admin' => [
+      'administer hdbt_cookie_banner',
+    ],
+  ];
+  helfi_platform_config_grant_permissions($permissions);
+}
+
+/**
+ * Implements hook_install().
+ */
+function hdbt_cookie_banner_install($is_syncing) : void {
+  // Do not perform following steps if the module is being installed as part
+  // of a configuration import.
+  if ($is_syncing) {
+    return;
+  }
+
+  // Uninstall the EU Cookie compliance and Helfi EU Cookie compliance
+  // modules if they are installed.
+  $module_handler = \Drupal::moduleHandler();
+  $module_installer = \Drupal::service('module_installer');
+
+  if (
+    $module_handler->moduleExists('eu_cookie_compliance') ||
+    $module_handler->moduleExists('helfi_eu_cookie_compliance')
+  ) {
+    $module_installer->uninstall([
+      'eu_cookie_compliance',
+      'helfi_eu_cookie_compliance',
+    ]);
+  }
+
+  // Grant required permissions.
+  hdbt_cookie_banner_grant_permissions();
+}

modules/hdbt_cookie_banner/hdbt_cookie_banner.libraries.yml

@@ -44,13 +44,16 @@ cookie_banner_admin_ui:
 
 hdbt_cookie_banner:
   version: 1.0.0
+  header: true
   js:
-    assets/js/hdbt-cookie-banner.js: {}
+    # The weight needs to be as low as drupal.init.js, which is -17.
+    assets/js/hdbt-cookie-banner.js: { weight: -16 }
   dependencies:
     - core/drupal
     - core/drupalSettings
 
 hds_cookie_consent:
   version: 1.0.0
+  header: true
   js:
-    assets/js/hds-cookie-consent.min.js: { minified: true, preprocess: false }
+    assets/js/hds-cookie-consent.min.js: { weight: -17, minified: true, preprocess: false }

modules/hdbt_cookie_banner/hdbt_cookie_banner.module

@@ -10,9 +10,6 @@ declare(strict_types=1);
 use Drupal\Core\Language\LanguageInterface;
 use Drupal\Core\Url;
 use Drupal\hdbt_cookie_banner\Form\HdbtCookieBannerForm;
-use Drupal\helfi_api_base\Environment\EnvironmentEnum;
-use Drupal\helfi_api_base\Environment\EnvironmentResolverInterface;
-use Drupal\helfi_api_base\Environment\Project;
 
 /**
  * Implements hook_config_ignore_settings_alter().
@@ -26,7 +23,7 @@ function hdbt_cookie_banner_config_ignore_settings_alter(array &$settings): void
  */
 function hdbt_cookie_banner_theme() : array {
   return [
-    'cookie_policy' => [
+    'cookie_settings_page' => [
       'variables' => [
         'title' => NULL,
         'content' => NULL,
@@ -43,18 +40,21 @@ function hdbt_cookie_banner_page_attachments(array &$attachments) : void {
   $langcode = \Drupal::languageManager()->getCurrentLanguage(LanguageInterface::TYPE_CONTENT)->getId();
   $attachments['#cache']['tags'] = array_merge($attachments['#cache']['tags'] ?? [], $config->getCacheTags());
 
+  /** @var \Drupal\hdbt_cookie_banner\Services\CookieSettings $cookie_settings_service */
+  $cookie_settings_service = \Drupal::service('hdbt_cookie_banner.cookie_settings');
+
   // By default, we use the hel.fi etusivu instance HDS cookie consent JS file.
   if (empty($config->get('use_custom_settings'))) {
-    _hdbt_cookie_banner_attach_hds_cookie_consent($attachments['#attached']);
+    $cookie_settings_service->injectBannerJavaScript($attachments);
   }
   // We can also use the current instance HDS cookie consent JS file.
   elseif (empty($config->get('use_internal_hds_cookie_js'))) {
     $attachments['#attached']['library'][] = 'hdbt_cookie_banner/hds_cookie_consent';
   }
   // Or the custom HDS cookie consent JS file can be used.
   else {
-    _hdbt_cookie_banner_attach_hds_cookie_consent(
-      $attachments['#attached'],
+    $cookie_settings_service->injectBannerJavaScript(
+      $attachments,
       $config->get('hds_cookie_js_override')
     );
   }
@@ -64,77 +64,32 @@ function hdbt_cookie_banner_page_attachments(array &$attachments) : void {
 
   // Attach HDBT cookie banner settings.
   $attachments['#attached']['drupalSettings']['hdbt_cookie_banner'] = [
-    'apiUrl' => _hdbt_cookie_banner_get_api_url(),
+    'apiUrl' => $cookie_settings_service->getCookieBannerApiUrl(),
     'langcode' => $langcode,
     'theme' => 'black',
-    'settingsPageSelector' => '.cookie-policy-settings',
+    'settingsPageSelector' => '.cookie-settings',
+    'settingsPageUrl' => $cookie_settings_service->getCookieSettingsPageUrl()?->setAbsolute()?->toString(),
   ];
-}
-
-/**
- * Gets HDBT cookie banner api url.
- */
-function _hdbt_cookie_banner_get_api_url(): string {
-  $config = \Drupal::configFactory()->get(HdbtCookieBannerForm::SETTINGS);
-  $language = \Drupal::languageManager()->getDefaultLanguage();
-
-  // Default to Etusivu API URL.
-  if (
-    empty($config->get('site_settings')) ||
-    !$config->get('use_custom_settings')
-  ) {
-    /** @var \Drupal\helfi_api_base\Environment\EnvironmentResolverInterface $resolver */
-    $resolver = \Drupal::service(EnvironmentResolverInterface::class);
-    try {
-      $environment = $resolver
-        ->getEnvironment(Project::ETUSIVU, $resolver->getActiveEnvironmentName());
-
-      return vsprintf("%s/api/cookie-banner", [
-        $environment->getUrl($language->getId()),
-      ]);
-    }
-    catch (InvalidArgumentException) {
-    }
-  }
 
-  return Url::fromRoute('hdbt_cookie_banner.site_settings', options: [
-    'language' => $language,
-  ])->toString();
+  // Fallback for the old variable used in HDBT theme react search JS.
+  // @todo UHF-10862 Remove once the HDBT cookie banner module is in use.
+  $attachments['#attached']['drupalSettings']['helfi_react_search'] = [
+    'cookie_privacy_url' => $cookie_settings_service->getCookieSettingsPageUrl()?->setAbsolute()?->toString(),
+  ];
 }
 
 /**
- * Gets HDS cookie consent JavaScript file URL.
+ * Helper function to get the privacy policy link URL.
+ *
+ * @todo UHF-10862 Remove once deprecations have been fixed.
+ *
+ * @return \Drupal\Core\Url|string
+ *   Returns the cookie settings page URL or empty string.
  */
-function _hdbt_cookie_banner_attach_hds_cookie_consent(&$attached, ?string $library = NULL): void {
-  // Load HDS cookie consent JavaScript file from Etusivu instance.
-  if (!$library) {
-    $resolver = \Drupal::service('helfi_api_base.environment_resolver');
-    $module_path = \Drupal::service('extension.list.module')->getPath('hdbt_cookie_banner');
-
-    // Get active Etusivu environment.
-    try {
-      $environment = $resolver->getEnvironment(Project::ETUSIVU, $resolver->getActiveEnvironmentName());
-    }
-    catch (\InvalidArgumentException) {
-      $environment = $resolver->getEnvironment(Project::ETUSIVU, EnvironmentEnum::Prod->value);
-    }
-
-    // Construct the URL to the HDS cookie consent JS file.
-    $library = vsprintf("%s/etusivu-assets/%s/assets/js/hds-cookie-consent.min.js", [
-      $environment->getBaseUrl(),
-      $module_path,
-    ]);
-  }
-
-  // Attach the HDS cookie consent JS file to HTML head.
-  $attached['html_head'][] = [
-    [
-      '#tag' => 'script',
-      '#attributes' => [
-        'src' => $library,
-        'type' => 'text/javascript',
-      ],
-    ],
-    'external_script',
-  ];
+// phpcs:ignore Drupal.Commenting.FunctionComment.Missing, Drupal.NamingConventions.ValidFunctionName.InvalidPrefix
+function helfi_eu_cookie_compliance_get_privacy_policy_url(): Url|string {
+  // Use the HDBT cookie banner cookie settings service to retrieve the
+  // cookie settings page URL.
+  $cookie_settings = Drupal::service('hdbt_cookie_banner.cookie_settings');
+  return $cookie_settings->getCookieSettingsPageUrl();
 }