202411 consentratio lp 135

config/default/core.extension.yml

@@ -36,6 +36,7 @@ module:
   diff: 0
   dynamic_entity_reference: 0
   dynamic_page_cache: 0
+  ecc_cct: 0
   ecc_cludo_search: 0
   ecc_content_moderation: 0
   ecc_cookie_compliance: 0

config/default/ecc_cct.settings.yml

@@ -0,0 +1 @@
+enable: '1'

web/modules/custom/ecc_cct/README.md

@@ -0,0 +1,11 @@
+# Essex Co Co cookie consent statistics.
+
+This module hooks into the events thown by the EU Cookie Compliance module.
+
+Whenever consent is set, this module takes a simplified value of choice: i.e.
+granted or denied, and sends it to an endpoint.
+
+The endpoint controller writes the time and value to a custom table.
+
+An administrator can access a simple aggregate report of choices. It calculates
+the percentage of grants out of the total number of records.

web/modules/custom/ecc_cct/config/schema/ecc_cct.schema.yml

@@ -0,0 +1,8 @@
+# Schema for the configuration files of the ECC Cookie Consent Tracker module.
+ecc_cct.settings:
+  type: config_object
+  label: 'ECC Cookie Consent Tracker settings'
+  mapping:
+    enable:
+      type: string
+      label: 'enable'

web/modules/custom/ecc_cct/ecc_cct.info.yml

@@ -0,0 +1,7 @@
+name: 'ECC Cookie Consent Tracker'
+type: module
+description: 'Tracks cookie consent choices and stores them for reporting.'
+package: Custom
+core_version_requirement: ^10 || ^11
+dependencies:
+  - eu_cookie_consent:eu_cookie_compliance

web/modules/custom/ecc_cct/ecc_cct.install

@@ -0,0 +1,41 @@
+<?php
+
+/**
+ * @file
+ * Install, update and uninstall functions for the ECC Cookie Consent Tracker module.
+ */
+
+ /**
+ * Implements hook_schema().
+ */
+function ecc_cct_schema() {
+  $schema['ecc_cct_data'] = [
+    'description' => 'Contains custom cookie consent data.',
+    'fields' => [
+      'id' => [
+        'type' => 'serial',
+        'not null' => TRUE,
+        'description' => 'Primary Key: Unique record ID.',
+      ],
+      'choice' => [
+        'type' => 'int',
+        'unsigned' => TRUE,
+        'not null' => TRUE,
+        'size' => 'small',
+        'default' => 0,
+        'description' => 'The value of the choice.',
+      ],
+      'timestamp' => [
+        'type' => 'int',
+        'unsigned' => TRUE,
+        'not null' => TRUE,
+        'size' => 'big',
+        'default' => 0,
+        'description' => 'Date of choice.',
+      ],
+    ],
+    'primary key' => ['id'],
+  ];
+
+  return $schema;
+}

web/modules/custom/ecc_cct/ecc_cct.libraries.yml

@@ -0,0 +1,6 @@
+# Custom library for general purposes.
+ecc_cct:
+  js:
+    js/ecc_cct.js: {}
+  dependencies:
+    - core/drupalSettings

web/modules/custom/ecc_cct/ecc_cct.links.menu.yml

@@ -0,0 +1,14 @@
+# Simple link.
+ecc_cct.report:
+  title: Consent Statistics
+  description: Consent Statistics.
+  menu_name: administration
+  route_name: ecc_cct.report
+  parent: system.admin_reports
+  weight: 10
+
+ecc_cct.settings:
+  title: Essex Cookie Consent Tracker
+  parent: system.admin_config_system
+  route_name: ecc_cct.settings
+  weight: 10

web/modules/custom/ecc_cct/ecc_cct.module

@@ -0,0 +1,17 @@
+<?php
+
+use \Drupal\Core\Form\FormStateInterface;
+
+/**
+ * @file
+ * Primary module hooks for ECC Cookie Consent Tracker module.
+ */
+
+/**
+ * Implements hook_preprocess_html().
+ */
+function ecc_cct_preprocess_html(&$vars) {
+  if ($vars['root_path'] !== 'admin') {
+    $vars['#attached']['library'][] = 'ecc_cct/ecc_cct';
+  }
+}

web/modules/custom/ecc_cct/ecc_cct.routing.yml

@@ -0,0 +1,24 @@
+ecc_cct.log:
+  path: '/ecc-cct/js/log/{choice}'
+  defaults:
+    _title: 'Content Log'
+    _controller: '\Drupal\ecc_cct\Controller\ConsentLog:log'
+  requirements:
+    _permission: 'access content'
+    choice: '\d+'  # Restricts 'choice' to be numeric only
+
+ecc_cct.report:
+  path: 'admin/reports/consent'
+  defaults:
+    _title: 'Consent Statistics'
+    _controller: '\Drupal\ecc_cct\Controller\EccCctController:build'
+  requirements:
+    _permission: 'access site reports'
+
+ecc_cct.settings:
+  path: '/admin/config/system/cookie-consent-tracker'
+  defaults:
+    _title: 'Cookie Consent Tracker'
+    _form: 'Drupal\ecc_cct\Form\SettingsForm'
+  requirements:
+    _permission: 'administer site configuration'

web/modules/custom/ecc_cct/js/ecc_cct.js

@@ -0,0 +1,43 @@
+
+
+(function ($, Drupal, drupalSettings, cookies) {
+
+  Drupal.behaviors.eccCCT = {
+    attach: function (context) {
+      var count = 0;
+      var postPreferencesLoadHandler = function (response) {
+        // The event usually fires twice: once on initial click, then
+        // preferences are taken into account and it fires again.
+        // We can't reasonably capture dithering users who change choices
+        // several times per page load.
+        count++;
+        if (count === 2) {
+          console.log(response);
+          if (response.currentStatus === 'granted') {
+            ecc_cct_log(1);
+          }
+          else if (response.currentStatus === 'denied') {
+            ecc_cct_log(2);
+          }
+        }
+      };
+      Drupal.eu_cookie_compliance('postStatusSave', postPreferencesLoadHandler);
+
+
+
+      async function ecc_cct_log(choice) {
+        const response = await fetch('/ecc-cct/js/log/' + choice).catch(error => {
+          console.error('Error sending integer:', error);
+        });
+
+
+        if (!response.ok) {
+          throw new Error(`Response status: ${response.status}`);
+        }
+        else {
+          console.log(response);
+        }
+      }
+    }
+  }
+})(jQuery, Drupal, drupalSettings, window.Cookies);

web/modules/custom/ecc_cct/src/Controller/ConsentLog.php

@@ -0,0 +1,51 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Drupal\ecc_cct\Controller;
+
+use Drupal\Core\Controller\ControllerBase;
+use Symfony\Component\HttpFoundation\Response;
+use Symfony\Component\HttpFoundation\Request;
+
+/**
+ * Returns responses for ECC Cookie Consent Tracker routes.
+ */
+final class ConsentLog extends ControllerBase {
+
+  /**
+   * Handles requests to /ecc-cct/js/log/{$choice}.
+   *
+   * @param int $choice
+   *   The dynamic ID passed to the route.
+   * @param \Symfony\Component\HttpFoundation\Request $request
+   *   The HTTP request object.
+   *
+   * @return \Symfony\Component\HttpFoundation\Response
+   *   A response object.
+   */
+  public function log(int $choice, Request $request): Response {
+    // If this isn't turned on, bail.
+    if (!\Drupal::config('ecc_cct.settings')->get('enable')) {
+      throw new ServiceUnavailableHttpException(NULL, t('Service unavailable'));
+    }
+    // Otherwise, let's write some data.
+    $content = [
+      'status' => 'success',
+      'message' => "Received ID: $choice",
+    ];
+
+    /** @var \Drupal\Core\Database\Connection $connection */
+    $connection = \Drupal::service('database');
+    $result = $connection->insert('ecc_cct_data')
+      ->fields([
+        'choice' => $choice,
+        'timestamp' => time(),
+      ])
+      ->execute();
+
+    // Maybe long term, we don't care about a response...
+    // but just in case, for testing, let's leave it in.
+    return new Response(json_encode($content), 200, ['Content-Type' => 'application/json']);
+  }
+}

web/modules/custom/ecc_cct/src/Controller/EccCctController.php

@@ -0,0 +1,32 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Drupal\ecc_cct\Controller;
+
+use Drupal\Core\Controller\ControllerBase;
+
+/**
+ * Returns responses for ECC Cookie Consent Tracker routes.
+ */
+final class EccCctController extends ControllerBase {
+
+  /**
+   * Builds the response.
+   */
+  public function build(): array {
+    $sql = "SELECT (COUNT(CASE WHEN choice = 1 THEN 1 END) / COUNT(*)) * 100 AS optin FROM {ecc_cct_data};";
+    $database = \Drupal::database();
+    $query = $database->query($sql);
+    $result = $query->fetchAll();
+
+    $stat = $result[0]->optin;
+    $build['content'] = [
+      '#type' => 'item',
+      '#markup' => $this->t($stat . '% of people opted into cookies.'),
+    ];
+
+    return $build;
+  }
+
+}

web/modules/custom/ecc_cct/src/Form/SettingsForm.php

@@ -0,0 +1,55 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Drupal\ecc_cct\Form;
+
+use Drupal\Core\Form\ConfigFormBase;
+use Drupal\Core\Form\FormStateInterface;
+
+/**
+ * Configure ECC Cookie Consent Tracker settings for this site.
+ */
+final class SettingsForm extends ConfigFormBase {
+
+  /**
+   * {@inheritdoc}
+   */
+  public function getFormId(): string {
+    return 'ecc_cct_settings';
+  }
+
+  /**
+   * {@inheritdoc}
+   */
+  protected function getEditableConfigNames(): array {
+    return ['ecc_cct.settings'];
+  }
+
+  /**
+   * {@inheritdoc}
+   */
+  public function buildForm(array $form, FormStateInterface $form_state): array {
+    $form['enable'] = [
+      '#type' => 'radios',
+      '#title' => $this->t('Enable tracking'),
+      '#options' => [
+        0 => $this->t('Disabled'),
+        1 => $this->t('Enabled'),
+      ],
+      '#default_value' => $this->config('ecc_cct.settings')->get('enable'),
+    ];
+    return parent::buildForm($form, $form_state);
+  }
+
+  /**
+   * {@inheritdoc}
+   */
+  public function submitForm(array &$form, FormStateInterface $form_state): void {
+    $this->config('ecc_cct.settings')
+      ->set('enable', $form_state->getValue('enable'))
+      ->save();
+    parent::submitForm($form, $form_state);
+  }
+
+}