From edb56d295fece8020ce8f8dd86213d760a1b18e5 Mon Sep 17 00:00:00 2001
From: Mikkel Ricky <rimi@aarhus.dk>
Date: Mon, 18 Dec 2023 10:28:50 +0100
Subject: [PATCH] HRIN-767: Added GIS map token

---
 CHANGELOG.md                                  |  3 +-
 composer.json                                 |  1 +
 composer.lock                                 | 93 ++++++++++++++++--
 config/sync/core.extension.yml                |  1 +
 .../editor.editor.hearing_description.yml     | 59 ++++++++++++
 ...d.field.node.hearing.field_description.yml |  6 +-
 .../filter.format.hearing_description.yml     | 45 +++++++++
 config/sync/user.role.authenticated.yml       |  2 +
 .../assets/css/gis-minimap.css                | 11 +++
 .../hoeringsportal_hearing.libraries.yml      |  8 ++
 .../hoeringsportal_hearing.module             | 21 +++-
 .../hoeringsportal_hearing.services.yml       |  2 +
 .../src/TokenHelper.php                       | 96 +++++++++++++++++++
 13 files changed, 337 insertions(+), 11 deletions(-)
 create mode 100644 config/sync/editor.editor.hearing_description.yml
 create mode 100644 config/sync/filter.format.hearing_description.yml
 create mode 100644 web/modules/custom/hoeringsportal_hearing/assets/css/gis-minimap.css
 create mode 100644 web/modules/custom/hoeringsportal_hearing/src/TokenHelper.php

diff --git a/CHANGELOG.md b/CHANGELOG.md
index d13a66b9e..6a27d9c34 100755
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -6,9 +6,10 @@ Versioning](https://semver.org/spec/v2.0.0.html).
 
 ## [Unreleased]
 
+* [PR-376](https://github.com/itk-dev/hoeringsportal/pull/376)
+  Added GIS map token
 * [PR-374](https://github.com/itk-dev/hoeringsportal/pull/374)
   Fix hidden mobile filters
-
 * [PR-367](https://github.com/itk-dev/hoeringsportal/pull/367)
   Added and used Editor Advanced link
 
diff --git a/composer.json b/composer.json
index 1e78d7fcc..68e4bbfea 100755
--- a/composer.json
+++ b/composer.json
@@ -144,6 +144,7 @@
         "drupal/quick_node_clone": "^1.12",
         "drupal/redirect": "^1.6",
         "drupal/search_autocomplete": "^3.0",
+        "drupal/token_filter": "^2.1",
         "drupal/toolbar_visibility": "^2.1",
         "drupal/twig_tweak": "^3.2",
         "drupal/view_custom_table": "^2.0",
diff --git a/composer.lock b/composer.lock
index 8e49cc053..b36426692 100644
--- a/composer.lock
+++ b/composer.lock
@@ -4,7 +4,7 @@
         "Read more about it at https://getcomposer.org/doc/01-basic-usage.md#installing-dependencies",
         "This file is @generated automatically"
     ],
-    "content-hash": "e8af805a89710ee8dcff49ed024c727b",
+    "content-hash": "56df1281b9775c8eaa3212258d0eab9a",
     "packages": [
         {
             "name": "asm89/stack-cors",
@@ -3695,10 +3695,6 @@
                     "name": "oknate",
                     "homepage": "https://www.drupal.org/user/471638"
                 },
-                {
-                    "name": "podarok",
-                    "homepage": "https://www.drupal.org/user/116002"
-                },
                 {
                     "name": "ram4nd",
                     "homepage": "https://www.drupal.org/user/601534"
@@ -4730,6 +4726,75 @@
                 "source": "https://git.drupalcode.org/project/token"
             }
         },
+        {
+            "name": "drupal/token_filter",
+            "version": "2.1.0",
+            "source": {
+                "type": "git",
+                "url": "https://git.drupalcode.org/project/token_filter.git",
+                "reference": "2.1.0"
+            },
+            "dist": {
+                "type": "zip",
+                "url": "https://ftp.drupal.org/files/projects/token_filter-2.1.0.zip",
+                "reference": "2.1.0",
+                "shasum": "34d72db7151738395afd25391195b36afb140bf1"
+            },
+            "require": {
+                "drupal/core": "^9.4 || ^10",
+                "drupal/token": "*"
+            },
+            "type": "drupal-module",
+            "extra": {
+                "drupal": {
+                    "version": "2.1.0",
+                    "datestamp": "1698126115",
+                    "security-coverage": {
+                        "status": "covered",
+                        "message": "Covered by Drupal's security advisory policy"
+                    }
+                }
+            },
+            "notification-url": "https://packages.drupal.org/8/downloads",
+            "license": [
+                "GPL-2.0-or-later"
+            ],
+            "authors": [
+                {
+                    "name": "ademarco",
+                    "homepage": "https://www.drupal.org/user/186696"
+                },
+                {
+                    "name": "asciikewl",
+                    "homepage": "https://www.drupal.org/user/147292"
+                },
+                {
+                    "name": "darvanen",
+                    "homepage": "https://www.drupal.org/user/1068770"
+                },
+                {
+                    "name": "Dave Reid",
+                    "homepage": "https://www.drupal.org/user/53892"
+                },
+                {
+                    "name": "Deciphered",
+                    "homepage": "https://www.drupal.org/user/103796"
+                },
+                {
+                    "name": "pescetti",
+                    "homepage": "https://www.drupal.org/user/436244"
+                },
+                {
+                    "name": "pvhee",
+                    "homepage": "https://www.drupal.org/user/108811"
+                }
+            ],
+            "description": "This is a very simple module to make global token values available as an input filter.",
+            "homepage": "https://www.drupal.org/project/token_filter",
+            "support": {
+                "source": "https://git.drupalcode.org/project/token_filter"
+            }
+        },
         {
             "name": "drupal/toolbar_visibility",
             "version": "2.1.0",
@@ -16919,12 +16984,12 @@
             "version": "3.7.2",
             "source": {
                 "type": "git",
-                "url": "https://github.com/squizlabs/PHP_CodeSniffer.git",
+                "url": "https://github.com/PHPCSStandards/PHP_CodeSniffer.git",
                 "reference": "ed8e00df0a83aa96acf703f8c2979ff33341f879"
             },
             "dist": {
                 "type": "zip",
-                "url": "https://api.github.com/repos/squizlabs/PHP_CodeSniffer/zipball/ed8e00df0a83aa96acf703f8c2979ff33341f879",
+                "url": "https://api.github.com/repos/PHPCSStandards/PHP_CodeSniffer/zipball/ed8e00df0a83aa96acf703f8c2979ff33341f879",
                 "reference": "ed8e00df0a83aa96acf703f8c2979ff33341f879",
                 "shasum": ""
             },
@@ -16969,6 +17034,20 @@
                 "source": "https://github.com/squizlabs/PHP_CodeSniffer",
                 "wiki": "https://github.com/squizlabs/PHP_CodeSniffer/wiki"
             },
+            "funding": [
+                {
+                    "url": "https://github.com/PHPCSStandards",
+                    "type": "github"
+                },
+                {
+                    "url": "https://github.com/jrfnl",
+                    "type": "github"
+                },
+                {
+                    "url": "https://opencollective.com/php_codesniffer",
+                    "type": "open_collective"
+                }
+            ],
             "time": "2023-02-22T23:07:41+00:00"
         },
         {
diff --git a/config/sync/core.extension.yml b/config/sync/core.extension.yml
index ca0a65e8d..4fca0472d 100644
--- a/config/sync/core.extension.yml
+++ b/config/sync/core.extension.yml
@@ -98,6 +98,7 @@ module:
   telephone: 0
   text: 0
   token: 0
+  token_filter: 0
   toolbar: 0
   toolbar_visibility: 0
   twig_tweak: 0
diff --git a/config/sync/editor.editor.hearing_description.yml b/config/sync/editor.editor.hearing_description.yml
new file mode 100644
index 000000000..f76b25e0d
--- /dev/null
+++ b/config/sync/editor.editor.hearing_description.yml
@@ -0,0 +1,59 @@
+uuid: d4a16c11-faf2-4617-bd62-c28ad4eb5f31
+langcode: da
+status: true
+dependencies:
+  config:
+    - filter.format.hearing_description
+  module:
+    - ckeditor5
+format: hearing_description
+editor: ckeditor5
+settings:
+  toolbar:
+    items:
+      - bold
+      - italic
+      - '|'
+      - link
+      - '|'
+      - bulletedList
+      - numberedList
+      - '|'
+      - blockQuote
+      - '|'
+      - sourceEditing
+      - '|'
+      - heading
+      - tokenBrowser
+  plugins:
+    ckeditor5_heading:
+      enabled_headings:
+        - heading2
+        - heading3
+        - heading4
+    ckeditor5_list:
+      reversed: false
+      startIndex: true
+    ckeditor5_sourceEditing:
+      allowed_tags:
+        - '<cite>'
+        - '<a hreflang target>'
+        - '<blockquote cite>'
+        - '<ul type>'
+        - '<ol type>'
+        - '<h2 id>'
+        - '<h3 id>'
+        - '<h4 id>'
+    editor_advanced_link_link:
+      enabled_attributes:
+        - target
+    token_filter_token_browser:
+      token_types: {  }
+image_upload:
+  status: false
+  scheme: public
+  directory: inline-images
+  max_size: ''
+  max_dimensions:
+    width: null
+    height: null
diff --git a/config/sync/field.field.node.hearing.field_description.yml b/config/sync/field.field.node.hearing.field_description.yml
index e4be6d815..7f5326500 100644
--- a/config/sync/field.field.node.hearing.field_description.yml
+++ b/config/sync/field.field.node.hearing.field_description.yml
@@ -4,6 +4,7 @@ status: true
 dependencies:
   config:
     - field.storage.node.field_description
+    - filter.format.hearing_description
     - node.type.hearing
   module:
     - allowed_formats
@@ -11,7 +12,7 @@ dependencies:
 third_party_settings:
   allowed_formats:
     allowed_formats:
-      - filtered_html
+      - hearing_description
 id: node.hearing.field_description
 field_name: field_description
 entity_type: node
@@ -23,5 +24,6 @@ translatable: true
 default_value: {  }
 default_value_callback: ''
 settings:
-  allowed_formats: {  }
+  allowed_formats:
+    - hearing_description
 field_type: text_long
diff --git a/config/sync/filter.format.hearing_description.yml b/config/sync/filter.format.hearing_description.yml
new file mode 100644
index 000000000..d6ac819c2
--- /dev/null
+++ b/config/sync/filter.format.hearing_description.yml
@@ -0,0 +1,45 @@
+uuid: 15881684-2eac-4426-bae4-7e44d395c82a
+langcode: da
+status: true
+dependencies:
+  module:
+    - token_filter
+name: 'Hearing description'
+format: hearing_description
+weight: 0
+filters:
+  filter_autop:
+    id: filter_autop
+    provider: filter
+    status: true
+    weight: 9
+    settings: {  }
+  filter_htmlcorrector:
+    id: filter_htmlcorrector
+    provider: filter
+    status: true
+    weight: -50
+    settings: {  }
+  filter_url:
+    id: filter_url
+    provider: filter
+    status: false
+    weight: -50
+    settings:
+      filter_url_length: 72
+  filter_html:
+    id: filter_html
+    provider: filter
+    status: true
+    weight: 0
+    settings:
+      allowed_html: '<br> <p> <h2 id> <h3 id> <h4 id> <cite> <a hreflang target href> <blockquote cite> <ul type> <ol type start> <strong> <em> <li>'
+      filter_html_help: true
+      filter_html_nofollow: false
+  token_filter:
+    id: token_filter
+    provider: token_filter
+    status: true
+    weight: 15
+    settings:
+      replace_empty: '1'
diff --git a/config/sync/user.role.authenticated.yml b/config/sync/user.role.authenticated.yml
index 2a06e4aa4..0e27e6ddd 100644
--- a/config/sync/user.role.authenticated.yml
+++ b/config/sync/user.role.authenticated.yml
@@ -5,6 +5,7 @@ dependencies:
   config:
     - filter.format.citizen_proposal_content
     - filter.format.filtered_html
+    - filter.format.hearing_description
   module:
     - file
     - filter
@@ -23,4 +24,5 @@ permissions:
   - 'search content'
   - 'use text format citizen_proposal_content'
   - 'use text format filtered_html'
+  - 'use text format hearing_description'
   - 'view media'
diff --git a/web/modules/custom/hoeringsportal_hearing/assets/css/gis-minimap.css b/web/modules/custom/hoeringsportal_hearing/assets/css/gis-minimap.css
new file mode 100644
index 000000000..a31057676
--- /dev/null
+++ b/web/modules/custom/hoeringsportal_hearing/assets/css/gis-minimap.css
@@ -0,0 +1,11 @@
+.hoeringsportal-hearing-gis-minimap {
+  /* We use a `span` element to render the map (it's most times inside a `p` element). */
+  display: block;
+  height: 500px;
+}
+
+.hoeringsportal-hearing-gis-minimap.invalid-token {
+  color: #f00;
+  background: #ff0;
+  height: auto;
+}
diff --git a/web/modules/custom/hoeringsportal_hearing/hoeringsportal_hearing.libraries.yml b/web/modules/custom/hoeringsportal_hearing/hoeringsportal_hearing.libraries.yml
index a452656ec..ebb7062fc 100644
--- a/web/modules/custom/hoeringsportal_hearing/hoeringsportal_hearing.libraries.yml
+++ b/web/modules/custom/hoeringsportal_hearing/hoeringsportal_hearing.libraries.yml
@@ -2,3 +2,11 @@ hearing-form:
   version: VERSION
   js:
     assets/js/form.js: {}
+
+gis-minimap:
+  version: VERSION
+  css:
+    theme:
+      assets/css/gis-minimap.css: {}
+  js:
+    https://webkort.aarhuskommune.dk/clientapi/minimap2/mmloader.js: { type: external, minified: true }
diff --git a/web/modules/custom/hoeringsportal_hearing/hoeringsportal_hearing.module b/web/modules/custom/hoeringsportal_hearing/hoeringsportal_hearing.module
index 3949e7ceb..aa0234102 100644
--- a/web/modules/custom/hoeringsportal_hearing/hoeringsportal_hearing.module
+++ b/web/modules/custom/hoeringsportal_hearing/hoeringsportal_hearing.module
@@ -9,8 +9,10 @@ use Drupal\Core\Entity\Display\EntityViewDisplayInterface;
 use Drupal\Core\Entity\EntityInterface;
 use Drupal\Core\Form\FormStateInterface;
 use Drupal\Core\Link;
+use Drupal\Core\Render\BubbleableMetadata;
 use Drupal\Core\Routing\RouteMatchInterface;
 use Drupal\Core\Url;
+use Drupal\hoeringsportal_hearing\TokenHelper;
 
 /**
  * Implements hook_help().
@@ -82,6 +84,23 @@ function hoeringsportal_hearing_node_view(array &$build, EntityInterface $entity
       $new_title = $title . $state;
       $build['title'][0]['#context']['value'] = $new_title;
     }
-
   }
 }
+
+/**
+ * Implements hook_token_info().
+ *
+ * @see \Drupal\hoeringsportal_hearing\TokenHelper::tokenInfo()
+ */
+function hoeringsportal_hearing_token_info() {
+  return \Drupal::service(TokenHelper::class)->tokenInfo();
+}
+
+/**
+ * Implements hook_tokens().
+ *
+ * @see \Drupal\hoeringsportal_hearing\TokenHelper::tokens()
+ */
+function hoeringsportal_hearing_tokens($type, $tokens, array $data, array $options, BubbleableMetadata $bubbleable_metadata) {
+  return \Drupal::service(TokenHelper::class)->tokens($type, $tokens, $data, $options, $bubbleable_metadata);
+}
diff --git a/web/modules/custom/hoeringsportal_hearing/hoeringsportal_hearing.services.yml b/web/modules/custom/hoeringsportal_hearing/hoeringsportal_hearing.services.yml
index d7fb33c57..24a3a862a 100644
--- a/web/modules/custom/hoeringsportal_hearing/hoeringsportal_hearing.services.yml
+++ b/web/modules/custom/hoeringsportal_hearing/hoeringsportal_hearing.services.yml
@@ -3,3 +3,5 @@ services:
     class: Drupal\hoeringsportal_hearing\EventSubscriber\EventSubscriber
     tags:
       - {name: event_subscriber}
+
+  Drupal\hoeringsportal_hearing\TokenHelper:
diff --git a/web/modules/custom/hoeringsportal_hearing/src/TokenHelper.php b/web/modules/custom/hoeringsportal_hearing/src/TokenHelper.php
new file mode 100644
index 000000000..a2ec67035
--- /dev/null
+++ b/web/modules/custom/hoeringsportal_hearing/src/TokenHelper.php
@@ -0,0 +1,96 @@
+<?php
+
+namespace Drupal\hoeringsportal_hearing;
+
+use Drupal\Component\Render\FormattableMarkup;
+use Drupal\Component\Uuid\Uuid;
+use Drupal\Core\Render\BubbleableMetadata;
+use Drupal\Core\StringTranslation\StringTranslationTrait;
+use Drupal\Core\Template\Attribute;
+
+/**
+ * Token helper.
+ */
+final class TokenHelper {
+  use StringTranslationTrait;
+
+  /**
+   * Token info.
+   *
+   * @implements hook_token_info().
+   */
+  public function tokenInfo(): array {
+    return [
+      'types' => [
+        'gis' => [
+          'name' => $this->t('GIS data'),
+        ],
+      ],
+      'tokens' => [
+        'gis' => [
+          'minimap:?' => [
+            'name' => $this->t('Insert GIS minimap by UUID'),
+            'description' => $this->t('Example: <code>[gis:minimap:409c1dc9-b604-4f1e-9df9-2768d050acb4]</code>'),
+          ],
+        ],
+      ],
+    ];
+  }
+
+  /**
+   * Tokens.
+   *
+   * @implements hook_tokens().
+   */
+  public function tokens($type, $tokens, array $data, array $options, BubbleableMetadata $bubbleableMetadata): array {
+    $replacements = [];
+    if ('gis' === $type) {
+      foreach ($tokens as $name => $original) {
+        if (preg_match('/^minimap:(?P<uuid>[^:]+)(?:\:(?P<config>.+))?$/', $name, $matches)) {
+          $mapUuid = $matches['uuid'];
+          $elementAttributes = new Attribute();
+          $elementAttributes->addClass('hoeringsportal-hearing-gis-minimap');
+          if (Uuid::isValid($mapUuid)) {
+            $elementId = uniqid('gis-minimap-');
+            parse_str($matches['config'] ?? '', $config);
+            $elementStyle['height'] = $config['height'] ?? '500px';
+            $script = sprintf('<script>window.addEventListener("load", function() { MiniMap.createMiniMap({mapDiv: "%s", minimapId: "%s"}) })</script>',
+              $elementId, $mapUuid);
+
+            $elementAttributes->setAttribute('id', $elementId);
+            // Build CSS style from associative array with, e.g.
+            // ['height' => '500px', 'width' => '50%']
+            // -> 'height: 500px; width: 50%'.
+            $style = implode(
+              '; ',
+              // Convert array to list of `«property»: «value»`.
+              array_map(
+                static fn($property, $value) => $property . ': ' . $value, array_keys($elementStyle),
+                $elementStyle
+              )
+            );
+            $elementAttributes->setAttribute('style', $style);
+            // Note: We use a `span` element (rather than a `div` element) for
+            // the map since we're (most times) inside a `p` element.
+            $markup = sprintf('<span %s></span>', $elementAttributes);
+
+            $replacements[$original] = new FormattableMarkup($script . $markup,
+              []);
+            $bubbleableMetadata->addAttachments(['library' => ['hoeringsportal_hearing/gis-minimap']]);
+          }
+          else {
+            $elementAttributes->addClass('invalid-token');
+            $elementAttributes->setAttribute('title', $this->t('Invalid GIS map UUID: @map_uuid', ['@map_uuid' => $mapUuid]));
+            $replacements[$original] = new FormattableMarkup(
+              sprintf('<span %s>%s</span>', $elementAttributes, $original),
+              []
+            );
+          }
+        }
+      }
+    }
+
+    return $replacements;
+  }
+
+}