[Copyright] Add "Dont show again" option

Author: swinkelmann

src/Mapbender/CoreBundle/Element/Copyright.php

@@ -3,6 +3,7 @@
 
 use Mapbender\Component\Element\AbstractElementService;
 use Mapbender\Component\Element\StaticView;
+use Mapbender\Component\Element\TemplateView;
 use Mapbender\CoreBundle\Entity\Element;
 use Mapbender\Utils\HtmlUtil;
 use Twig;
@@ -72,6 +73,7 @@ public static function getDefaultConfiguration()
         return array(
             'autoOpen' => false,
             'content' => null,
+            'dontShowAgain' => false,
             'popupWidth'    => 300,
             'popupHeight' => null,
         );
@@ -88,19 +90,19 @@ public function getWidgetName(Element $element)
     public function getView(Element $element)
     {
         $config = $element->getConfiguration();
+
+        $view = new TemplateView('@MapbenderCore/Element/copyright.html.twig');
+        $view->attributes['class'] = 'mb-element-copyright';
+        $view->attributes['data-title'] = $element->getTitle();
+        $view->variables['content'] = $config['content'];
+        $view->variables['dontShowAgain'] = $config['dontShowAgain'];
+        $view->variables['dontShowAgainLabel'] = $config['dontShowAgainLabel'];
+
         // Do not cache if content contains any twig expressions or flow control ("{{" or "{%")
-        $content = $this->templateEngine->createTemplate($config['content'] ?: '')->render(array(
-            'configuration' => $config,
-        ));
-        $wrapped = HtmlUtil::renderTag('div', $content, array(
-            'class' => 'hidden -js-popup-content',
-        ));
-        $view = new StaticView($wrapped);
         if (!empty($config['content']) && false !== strpos($config['content'], '{')) {
             $view->cacheable = false;
         }
-        $view->attributes['class'] = 'mb-element-copyright';
-        $view->attributes['data-title'] = $element->getTitle();
+
         return $view;
     }
 

src/Mapbender/CoreBundle/Element/Type/CopyrightAdminType.php

@@ -8,6 +8,7 @@
 
 class CopyrightAdminType extends AbstractType
 {
+
     /**
      * @inheritdoc
      */
@@ -43,6 +44,15 @@ public function buildForm(FormBuilderInterface $builder, array $options): void
                     new HtmlTwigConstraint(),
                 ),
             ))
+            ->add('dontShowAgain', 'Symfony\Component\Form\Extension\Core\Type\CheckboxType', array(
+                'required' => false,
+                'label' => 'mb.core.copyright.admin.dontShowAgain',
+            ))
+            ->add('dontShowAgainLabel', 'Symfony\Component\Form\Extension\Core\Type\TextType', array(
+                'required' => false,
+                'label' => 'mb.core.copyright.admin.dontShowAgainLabel',
+                'data' => 'mb.core.copyright.admin.dontShowAgainDefaultLabel',
+            ))
         ;
     }
 }

src/Mapbender/CoreBundle/Resources/public/elements/MbCopyright.js

@@ -5,9 +5,17 @@
             super(configuration, $element);
 
             this.content_ = $('.-js-popup-content', this.$element).remove().removeClass('hidden');
-            if (this.checkAutoOpen && this.checkAutoOpen()) {
+
+            if (this.options.autoOpen) {
+                const currentText = this.content_.text().trim();
+                const storedText = localStorage.getItem('mbCopyrightText-' + Mapbender.configuration.application.slug);
+                this.options.autoOpen = (storedText === null) || (currentText !== storedText);
+            }
+
+            if (this.checkAutoOpen(this.element, this.options)) {
                 this.activateByButton();
             }
+
             this._setup();
         }
 
@@ -35,6 +43,10 @@
             if (this.notifyWidgetActivated) {
                 this.notifyWidgetActivated();
             }
+
+            if (this.options.dontShowAgain) {
+                this.initListeners();
+            }
         }
 
         closeByButton() {
@@ -43,6 +55,23 @@
                 this.notifyWidgetDeactivated();
             }
         }
+
+        initListeners() {
+            const currentText = this.content_.text().trim();
+            const localStorageKey = 'mbCopyrightText-' + Mapbender.configuration.application.slug;
+            const storedText = localStorage.getItem(localStorageKey);
+            const $checkbox = this.content_.find('.copyright-dont-show-again');
+
+            $checkbox.prop('checked', (storedText !== null) && (storedText === currentText));
+            $checkbox.off('change.mbCopyright')
+                .on('change.mbCopyright', function() {
+                    if (this.checked) {
+                        localStorage.setItem(localStorageKey, currentText);
+                    } else {
+                        localStorage.removeItem(localStorageKey);
+                    }
+                });
+        }
     }
 
     window.Mapbender.Element = window.Mapbender.Element || {};

src/Mapbender/CoreBundle/Resources/translations/messages.de.yaml

@@ -356,6 +356,9 @@ mb:
         dialog: Dialog
       admin:
         content: Inhalt
+        dontShowAgain: '"Nicht mehr anzeigen"-Option'
+        dontShowAgainLabel: '"Nicht mehr anzeigen"-Text'
+        dontShowAgainDefaultLabel: 'Nicht mehr anzeigen'
     map:
       class:
         title: Karte

src/Mapbender/CoreBundle/Resources/translations/messages.en.yaml

@@ -356,6 +356,9 @@ mb:
         dialog: dialog
       admin:
         content: Content
+        dontShowAgain: "\"Don't show again\"-Option"
+        dontShowAgainLabel: "\"Don't show again\"-Label"
+        dontShowAgainDefaultLabel: "Don't show again"
     map:
       class:
         title: Map

src/Mapbender/CoreBundle/Resources/views/Element/copyright.html.twig

@@ -0,0 +1,9 @@
+<div class="hidden -js-popup-content">
+    {{- content | raw -}}
+    {% if dontShowAgain %}
+        <div class="form-check mt-5">
+            <input type="checkbox" class="form-check-input copyright-dont-show-again">
+            <label class="form-check-label">{{ dontShowAgainLabel | trans }}</label>
+        </div>
+    {% endif %}
+</div>