Jump to content
joshua

PrivacyWire - Cookie Management & async external asset loading

Recommended Posts

This module is (yet another) way for implementing a cookie management solution.

Of course there are several other possibilities:
- https://processwire.com/talk/topic/22920-klaro-cookie-consent-manager/
- https://github.com/webmanufaktur/CookieManagementBanner
- https://github.com/johannesdachsel/cookiemonster
- https://www.oiljs.org/
- ... and so on ...

In this module you can configure which kind of cookie categories you want to manage:
privacywire-module-config.thumb.jpg.5d002e91ceb1df770d6804b47c345fee.jpg
You can also enable the support for respecting the Do-Not-Track (DNT) header to don't annoy users, who already decided for all their browsing experience.

Currently there are four possible cookie groups:
- Necessary (always enabled)
- Statistics
- Marketing
- External Media
All groups can be renamed, so feel free to use other cookie group names. I just haven't found a way to implement a "repeater like" field as configurable module field ...

When you want to load specific scripts ( like Google Analytics, Google Maps, ...) only after the user's content to this specific category of cookies, just use the following script syntax:

<script type="text/plain" data-type="text/javascript" data-category="statistics" data-src="/path/to/your/statistic/script.js"></script>
<script type="text/plain" data-type="text/javascript" data-category="marketing" data-src="/path/to/your/mareketing/script.js"></script>
<script type="text/plain" data-type="text/javascript" data-category="external_media" data-src="/path/to/your/external-media/script.js"></script>

<script type="text/plain" data-type="text/javascript" data-category="marketing">console.log("Inline scripts are also working!");</script>

The type has to be "optin" to get recognized by PrivacyWire, the data-attributes are giving hints, how the script shall be loaded, if the data-category is within the cookie consents of the user. These scripts are loaded asynchronously after the user made the decision.

If you want to give the users the possibility to change their consent, you can use the following Textformatter:

[[privacywire-choose-cookies]]

It's planned to add also other Textformatters to opt-out of specific cookie groups or delete the whole consent cookie.
You can also add a custom link to output the banner again with a link / button with following class:

<a href="#" class="privacywire-show-options">Show Cookie Options</a>

<button class="privacywire-show-options">Show Cookie Options</button>

This module is still in development, but we already use it on several production websites.
You find it here: PrivacyWire Git Repo
Download as .zip

I would love to hear your feedback 🙂

CHANGELOG

  • 0.1.1 Debugging: fixed error during uninstall
  • 0.1.0 Added new detection of async scripts for W3C Validation
  • 0.0.6 CSS-Debugging for hiding unused buttons, added ProCache support for the JavaScript tag
  • 0.0.5 Multi-language support included completely (also in TextFormatter). Added possibility to async load other assets (e.g. <img type="optin" data-category="marketing" data-src="https://via.placeholder.com/300x300">)
  • 0.0.4 Added possibility to add an imprint link to the banner
  • 0.0.3 Multi-language support for module config (still in development)
  • 0.0.2 First release
  • 0.0.1 Early development
  • Like 19
  • Thanks 3

Share this post


Link to post
Share on other sites

@joshua Nice! Thanks for sharing.

Can this module be used for multi-lingual sites? i.e. If I wanted to translate the banner texts and labels, is that possible out of the box? Or would I have to manually re-define the module's text fields as text/textarea language?

  • Like 1

Share this post


Link to post
Share on other sites

Right now only the default values can be overwritten via language translation files.
But good hint - I'll add multi-language support for the config fields as well.

  • Like 7

Share this post


Link to post
Share on other sites

Wow... thanks @joshua for this.

This is really a nice extension or more advanced and often asked for solution.
I wil definitely try this and check out what is possible with your module.

Great work!

  • Like 1

Share this post


Link to post
Share on other sites

You can simply write your own CSS. In the module included are only some basic styles (less than 500 byte) which are directly included via JS. I tried to keep the module as slim as possible, the javascript has only 3.05 kb (gzipped) with all the functionality.
You can see an example of styling at our website or this website.

I usually only style the div.privacywire and the buttons to match the website styles.

Share this post


Link to post
Share on other sites
On 2/16/2020 at 4:07 PM, dragan said:

Can this module be used for multi-lingual sites? i.e. If I wanted to translate the banner texts and labels, is that possible out of the box? Or would I have to manually re-define the module's text fields as text/textarea language?

I today integrated the multi-language support for all the config fields.

  • Like 3
  • Thanks 1

Share this post


Link to post
Share on other sites

Update - Version 0.0.6

  • Minor CSS-Debugging (hiding the choose button when no cookie group is selected)
  • Added ProCache support for the script tag, when ProCache is installed
  • Like 2

Share this post


Link to post
Share on other sites

Hi @joshua,

thank you for this great module! Would you consider a suggestion to enable an "option out" approach on the check-boxes. I know this is controversial, but some clients insist on having this. 

Another question, do you know if there's a way to have a granular control on the scripts loaded by Google Tag Manager?

Share this post


Link to post
Share on other sites

Hi Sergio,

thank you! 🙂 Glad you like the module. I actually never thought about the "opt out" approach as our customers or their "Data protection officer" requested the opt-in version.
Do you mean this approach for "pre-selecting" the checkboxes within the choose-window? That would be not to hard to implement, I could add an option for this to the module config.
More difficult would it be to automatically load all scripts on page load and only stop specific categories, when the user choose to opt-out.

About the Google Tag Manager: I have no experience in this kind of granular control within the GTM. Maybe this article could help?

 

 

  • Like 1

Share this post


Link to post
Share on other sites
16 hours ago, Sergio said:

Another question, do you know if there's a way to have a granular control on the scripts loaded by Google Tag Manager?

With klaro consent manager you can gain control over the scripts loaded by GTM. See this issue. (I'm not affiliated with that project in any way, just using it on a couple of sites)

It is implemented via custom callback functions for each app that is managed by the consent manager. @joshua Maybe you could go a similar route to make configuration more flexible and tweakable? And thanks for putting this together!

And a suggestion for improvement: The type="optin" attribute is not a valid script attribute. So W3C Validator will not like it. You could use text/plain instead. That is not very semantic but could help to pass validator tests...

  • Like 3

Share this post


Link to post
Share on other sites
6 hours ago, joshua said:

More difficult would it be to automatically load all scripts on page load and only stop specific categories, when the user choose to opt-out.

Yep, that's the challenge indeed. I need to take a look at how Klaro does that, as mentioned by @gebeer. 

Share this post


Link to post
Share on other sites

Hello everyone,

i managed to implement your module and integrade GTM with it like in the examples you've posted from your websites. Thank you for that!

Two things i would like to ask:

  1. It seems like that the Imprint and Privacy Policy URLs are ignoring the different languages. It doesn't matter if i use the full https-url or just /de/impressum/ | /en/imprint/ etc., it will always link me to the default language. Am i doing something wrong or is this a minor bug?
  2. Could you give an example how to handle external media like embedded YouTube-Videos or GoogleMaps? Unfortunately my skills and knowledge are not good enough to manage it on my own.

Thanks in advance and stay safe.

 

  • Like 1

Share this post


Link to post
Share on other sites

Thanks for your feedback!

I'll look into bug about the privacy URL in different languages later today.
For embedding videos I'll also write an example and update the main post later with this.

  • Like 2

Share this post


Link to post
Share on other sites

Thank you for this module. It works great.

I ran my webpage through W3C validation and it gave me these errors. Any suggestions on how to fix it? (Procache strips the quotes, but it's in the code). Thank you.

  1. Error: Bad value optin for attribute type on element script: Subtype missing.

    From line 1, column 30; to line 1, column 174

    l lang=en><script type=optin data-type=text/javascript data-category=statistics async data-src="https://www.googletagmanager.com/gtag/js?id=Ufkjdkfj"></scri

  2. Error: Element script must not have attribute async unless attribute src is also specified or unless attribute type is specified with value module.

    From line 1, column 30; to line 1, column 174

    l lang=en><script type=optin data-type=text/javascript data-category=statistics async data-src="https://www.googletagmanager.com/gtag/js?id=dfdfdfdf"></scri

  • Like 1

Share this post


Link to post
Share on other sites
On 3/25/2020 at 4:20 PM, PK Mi43 said:

Hello everyone,

i managed to implement your module and integrade GTM with it like in the examples you've posted from your websites. Thank you for that!

Two things i would like to ask:

  1. It seems like that the Imprint and Privacy Policy URLs are ignoring the different languages. It doesn't matter if i use the full https-url or just /de/impressum/ | /en/imprint/ etc., it will always link me to the default language. Am i doing something wrong or is this a minor bug?
  2. Could you give an example how to handle external media like embedded YouTube-Videos or GoogleMaps? Unfortunately my skills and knowledge are not good enough to manage it on my own.

Thanks in advance and stay safe.

 

Thanks again for your feedback. I tested the privacy & imprint URLs and there really was a small bug about the multi language URLs.
When you update the module the multi language URLs should work now.

Example of external media:

<!-- This is the output container -->
<div id="player"></div>


<script type="optin" data-type="text/javascript" data-category="external_media">
        // 2. This code loads the IFrame Player API code asynchronously.
      var tag = document.createElement('script');

      tag.src = "https://www.youtube.com/iframe_api";
      var firstScriptTag = document.getElementsByTagName('script')[0];
      firstScriptTag.parentNode.insertBefore(tag, firstScriptTag);

      // 3. This function creates an <iframe> (and YouTube player)
      //    after the API code downloads.
      var player;
      function onYouTubeIframeAPIReady() {
        player = new YT.Player('player', {
          height: '360',
          width: '640',
          videoId: 'M7lc1UVf-VE',
          events: {
            'onReady': onPlayerReady,
            'onStateChange': onPlayerStateChange
          }
        });
      }

      // 4. The API will call this function when the video player is ready.
      function onPlayerReady(event) {
        event.target.playVideo();
      }

      // 5. The API calls this function when the player's state changes.
      //    The function indicates that when playing a video (state=1),
      //    the player should play for six seconds and then stop.
      var done = false;
      function onPlayerStateChange(event) {
        if (event.data == YT.PlayerState.PLAYING && !done) {
          setTimeout(stopVideo, 6000);
          done = true;
        }
      }
      function stopVideo() {
        player.stopVideo();
      }

    </script>

See this for more info about the YouTube API. The code above is from their example.

  • Like 2
  • Thanks 1

Share this post


Link to post
Share on other sites
On 3/27/2020 at 1:40 PM, montero4 said:

Thank you for this module. It works great.

I ran my webpage through W3C validation and it gave me these errors. Any suggestions on how to fix it? (Procache strips the quotes, but it's in the code). Thank you.

  1. Error: Bad value optin for attribute type on element script: Subtype missing.

    From line 1, column 30; to line 1, column 174

    l lang=en><script type=optin data-type=text/javascript data-category=statistics async data-src="https://www.googletagmanager.com/gtag/js?id=Ufkjdkfj"></scri

  2. Error: Element script must not have attribute async unless attribute src is also specified or unless attribute type is specified with value module.

    From line 1, column 30; to line 1, column 174

    l lang=en><script type=optin data-type=text/javascript data-category=statistics async data-src="https://www.googletagmanager.com/gtag/js?id=dfdfdfdf"></scri

That's right, currently the W3C does not validate.  @gebeer also mentioned this with the possible solution to use "text/plain" instead of "optin".
I'm planning to implement this solution, but as an optional addition to keep backwards compatibility for the users who already use the "optin" variant.

  • Like 3
  • Thanks 1

Share this post


Link to post
Share on other sites

Thank you for this module. I like it.

Is there a posibility to notice them who saves the cookie. To make a documentation of it. So far I know, the privacy policy says, you have to do that.

Its very strange and nonsensical in my opinion. Perhaps it ist possible to make a entry in logs. This would be very great.

Perhaps others know, what is realy necessary.   

Share this post


Link to post
Share on other sites

Hi @joshua,

I really like your module, especially the way how scripts are loaded asynchronous. Thank you for sharing!

It would be nice if you would use data-type="optin" instead of type="optin" in order to have valid HTML5.
 

Many greets!

Share this post


Link to post
Share on other sites

By the way: This is really helpful.

On 2/16/2020 at 1:07 PM, joshua said:

<img type="optin" data-category="marketing" data-src="https://via.placeholder.com/300x300">

@joshua Is there an opposite option to only show an element if a specific data-category isn't allowed? I want to display the link for managing cookies only to users if cookies of a certain kind are not allowed.

Share this post


Link to post
Share on other sites

Hello everyone,

first of all thank you @joshua for your example with external media. Greatly appreciated.

Right now i was tasked to integrate a Facebook Pixel onto a website. I assume i just do the same i did with Google Analytics and add the type/data-type/data-category "statistics" to the <script> tag. Easy!?

What about the following part:

<noscript>
  <img height="1" width="1" src="https://www.facebook.com/tr?id=yourfacebookid&ev=PageView&noscript=1"/>
</noscript>

Can/do i use the same procedure just with <noscript> instead of <script>, e. g.

<noscript type="optin" data-type="text/javascript" data-category="statistics">

or do i use the new (v0.0.5) implemented

<img type="optin" data-category="statistics" data-src="https://www.facebook.com/tr?id=yourfacebookid&ev=PageView&noscript=1" width="1" height="1">

without the <noscript></noscript> part?

 

Thanks in advance for your help, again. Have a great weekend and stay safe.

Share this post


Link to post
Share on other sites

I've updated the module today to add the W3C validation.
Starting now the type can be "text/plain" instead of "optin", the js will detect the elements via the data-category attribute. I will update the documentation.

On 4/9/2020 at 5:45 PM, DV-JF said:

Is there an opposite option to only show an element if a specific data-category isn't allowed?

That's a good point. Right now there isn't a detection for this but I'll think about a way to implement this.

 

On 4/4/2020 at 7:10 AM, hintraeger said:

Is there a posibility to notice them who saves the cookie. To make a documentation of it. So far I know, the privacy policy says, you have to do that.

When you add a button to change cookie preferences in your privacy policy, the selected options are pre-selected, so one could say it's "documented". I'm not sure if this is sufficient for your case?
 

On 4/17/2020 at 2:53 PM, PK Mi43 said:

Can/do i use the same procedure just with <noscript> instead of <script>, e. g.

That will not work, as the loading works via javascript. When javascript is disabled (and the <noscript> tag comes into play), PrivacyWire isn't loaded as well so it cannot load the <noscript> tag.

  • Like 1

Share this post


Link to post
Share on other sites
On 5/10/2020 at 1:41 PM, joshua said:

That will not work, as the loading works via javascript. When javascript is disabled (and the <noscript> tag comes into play), PrivacyWire isn't loaded as well so it cannot load the <noscript> tag.

Thank you for your explanation, that makes sense. So would i leave it just as it is, or get rid of it alltogether since the cookie banner requires javascript?

Does anyone have experience with it, or would this be too much work to implement?

Share this post


Link to post
Share on other sites

Isn't it required in the new word of EU web bureaucracy to list every single cookie on demand (by category) and explain what is does, where it's from and can set it individually?

So, for example, in the same example category "my user settings" I can agree to remember a "my selected language" cookie but not another cookie with "my last page visited"?

As Borlabs cookie does it, or Klaro (kind of)?

Am I wrong with my understanding of the current GDPR law situation? Or is this implemented already and I just did not find it?

(Right now I am evaluation this module against using KLARO directy)

Share this post


Link to post
Share on other sites

Create an account or sign in to comment

You need to be a member in order to leave a comment

Create an account

Sign up for a new account in our community. It's easy!

Register a new account

Sign in

Already have an account? Sign in here.

Sign In Now

  • Recently Browsing   0 members

    No registered users viewing this page.

  • Similar Content

    • By d'Hinnisdaël
      Happy new year, everybody 🥬
      I've been sitting on this Dashboard module I made for a client and finally came around to cleaning it up and releasing it to the wider public. This is how it looks.
      ProcessWire Dashboard

      If anyone is interested in trying this out, please go ahead! I'd love to get some feedback on it. If this proves useful and survives some real-world testing, I'll add this to the module directory.
      Download
      You can find the latest release on Github.
      Documentation
      Check out the documentation to get started. This is where you'll find information about included panel types and configuration options.
      Custom Panels
      My goal was to make it really simple to create custom panels. The easiest way to do that is to use the panel type template and have it render a file in your templates folder. This might be enough for 80% of all use cases. For anything more complex (FormBuilder submissions? Comments? Live chat?), you can add new panel types by creating modules that extend the DashboardPanel base class. Check out the documentation on custom panels or take a look at the HelloWorld panel to get started. I'm happy to merge any user-created modules into the main repo if they might be useful to more than a few people.
       Disclaimer
      This is a pre-release version. Please treat it as such — don't install it on production sites. Just making sure 🍇
      Roadmap
      These are the things I'm looking to implement myself at some point. The wishlist is a lot longer, but those are the 80/20 items that I probably won't regret spending time on.
      Improve documentation & add examples ⚙️ Panel types Google Analytics ⚙️ Add new page  🔥 Drafts 🔥 At a glance / Page counter 404s  Layout options Render multiple tabs per panel panel groups with heading and spacing between ✅ panel wrappers as grid item (e.g. stacked notices) ✅ Admin themes support AdminThemeReno and AdminThemeDefault ✅ Shortcuts panel add a table layout with icon, title & summary ✅ Chart panel add default styles for common chart types ✅ load chart data from JS file (currently passed as PHP array) Collection panel support image columns ✅ add buttons: view all & add new ✅
    • By Pip
      Hi everyone!
      I'm trying out the Login/Register module for my site. Noted that the module assigns the newly registered user to login-register role. 
      Once you modify the login-register role's permissions, particularly adding page-edit, the new member role will be set to guest. 
      Thing is I'd like to grant my new users the power to create their own pages. Any advice? 
      Thanks. 
    • By Gadgetto
      SnipWire - Snipcart integration for ProcessWire
      Snipcart is a powerful 3rd party, developer-first HTML/JavaScript shopping cart platform. SnipWire is the missing link between Snipcart and the content management framework ProcessWire.
      With SnipWire, you can quickly turn any ProcessWire site into a Snipcart online shop. The SnipWire plugin helps you to get your store up and running in no time. Detailed knowledge of the Snipcart system is not required.
      SnipWire is free and open source licensed under Mozilla Public License 2.0! A lot of work and effort has gone into development. It would be nice if you could donate an amount to support further development:

      Status update links (inside this thread) for SnipWire development
      2020-07-03 -- SnipWire 0.8.7 (beta) released! Fixes some small bugs and adds an indicator for TEST mode 2020-04-06 -- SnipWire 0.8.6 (beta) released! Adds support for Snipcart subscriptions and also fixes some problems 2020-03-21 -- SnipWire 0.8.5 (beta) released! Improves SnipWires webhooks interface and provides some other fixes and additions 2020-03-03 -- SnipWire 0.8.4 (beta) released! Improves compatibility for Windows based Systems. 2020-03-01 -- SnipWire 0.8.3 (beta) released! The installation and uninstallation process has been heavily revised. 2020-02-08 -- SnipWire 0.8.2 (beta) released! Added a feature to change the cart and catalogue currency by GET, POST or SESSION param 2020-02-03 -- SnipWire 0.8.1 (beta) released! All custom classes moved into their own namespaces. 2020-02-01 -- SnipWire is now available via ProcessWire's module directory! 2020-01-30 -- SnipWire 0.8.0 (beta) first public release! (module just submitted to the PW modules directory) 2020-01-28 -- added Custom Order Fields feature (first SnipWire release version is near!) 2020-01-21 -- Snipcart v3 - when will the new cart system be implemented? 2020-01-19 -- integrated taxes provider finished (+ very flexible shipping taxes handling) 2020-01-14 -- new date range picker, discount editor, order notifiactions, order statuses, and more ... 2019-11-15 -- orders filter, order details, download + resend invoices, refunds 2019-10-18 -- list filters, REST API improvements, new docs platform, and more ... 2019-08-08 -- dashboard interface, currency selector, managing Orders, Customers and Products, Added a WireTabs, refinded caching behavior 2019-06-15 -- taxes provider, shop templates update, multiCURL implementation, and more ... 2019-06-02 -- FieldtypeSnipWireTaxSelector 2019-05-25 -- SnipWire will be free and open source Plugin Key Features
      Fast and simple store setup Full integration of the Snipcart dashboard into the ProcessWire backend (no need to leave the ProcessWire admin area) Browse and manage orders, customers, discounts, abandoned carts, and more Multi currency support Custom order and cart fields Process refunds and send customer notifications from within the ProcessWire backend Process Abandoned Carts + sending messages to customers from within the ProcessWire backend Complete Snipcart webhooks integration (all events are hookable via ProcessWire hooks) Integrated taxes provider (which is more flexible then Snipcart own provider) Useful Links
      SnipWire in PW modules directory SnipWire Docs (please note that the documentation is a work in progress) SnipWire @GitHub (feature requests and suggestions for improvement are welcome - I also accept pull requests) Snipcart Website  

       
      ---- INITIAL POST FROM 2019-05-25 ----
       
    • By Sten
      Hello
      Till now I hacked something with the twig template but it works no more with new PW versions so I look forward to create a module. I am working on a site in multiple languages : French, English, Italian, German, Spanish, Portuguese, Hebrew, Russian. The new posts are entered in any language with a field for language. Till now, I got twig files to get the translations with constants defined for each part of the pages.
      So I'd like to create a module to include theses files added according to the url /fr/en/...
      Have you some observations to do before I begin about the direction to take ?
      Thank you
    • By ukyo
      Mystique Module for ProcessWire CMS/CMF
      Github repo : https://github.com/trk/Mystique
      Mystique module allow you to create dynamic fields and store dynamic fields data on database by using a config file.
      Requirements
      ProcessWire 3.0 or newer PHP 7.0 or newer FieldtypeMystique InputfieldMystique Installation
      Install the module from the modules directory:
      Via Composer:
      composer require trk/mystique Via git clone:
      cd your-processwire-project-folder/ cd site/modules/ git clone https://github.com/trk/Mystique.git Module in live reaction with your Mystique config file
      This mean if you remove a field from your config file, field will be removed from edit screen. As you see on youtube video.
      Using Mystique with your module or use different configs path, autoload need to be true for modules
      Default configs path is site/templates/configs/, and your config file name need to start with Mystique. and need to end with .php extension.
      Adding custom path not supporting anymore !
      // Add your custom path inside your module class`init` function, didn't tested outside public function init() { $path = __DIR__ . DIRECTORY_SEPARATOR . 'configs' . DIRECTORY_SEPARATOR; Mystique::add($path); } Mystique module will search site/modules/**/configs/Mystique.*.php and site/templates/Mystique.*.php paths for Mystique config files.
      All config files need to return a PHP ARRAY like examples.
      Usage almost same with ProcessWire Inputfield Api, only difference is set and showIf usage like on example.
      <?php namespace ProcessWire; /** * Resource : testing-mystique */ return [ 'title' => __('Testing Mystique'), 'fields' => [ 'text_field' => [ 'label' => __('You can use short named types'), 'description' => __('In file showIf working like example'), 'notes' => __('Also you can use $input->set() method'), 'type' => 'text', 'showIf' => [ 'another_text' => "=''" ], 'set' => [ 'showCount' => InputfieldText::showCountChars, 'maxlength' => 255 ], 'attr' => [ 'attr-foo' => 'bar', 'attr-bar' => 'foo' ] ], 'another_text' => [ 'label' => __('Another text field (default type is text)') ] ] ]; Example:
      site/templates/configs/Mystique.seo-fields.php <?php namespace ProcessWire; /** * Resource : seo-fields */ return [ 'title' => __('Seo fields'), 'fields' => [ 'window_title' => [ 'label' => __('Window title'), 'type' => Mystique::TEXT, // or InputfieldText 'useLanguages' => true, 'attr' => [ 'placeholder' => __('Enter a window title') ] ], 'navigation_title' => [ 'label' => __('Navigation title'), 'type' => Mystique::TEXT, // or InputfieldText 'useLanguages' => true, 'showIf' => [ 'window_title' => "!=''" ], 'attr' => [ 'placeholder' => __('Enter a navigation title') ] ], 'description' => [ 'label' => __('Description for search engines'), 'type' => Mystique::TEXTAREA, 'useLanguages' => true ], 'page_tpye' => [ 'label' => __('Type'), 'type' => Mystique::SELECT, 'options' => [ 'basic' => __('Basic page'), 'gallery' => __('Gallery'), 'blog' => __('Blog') ] ], 'show_on_nav' => [ 'label' => __('Display this page on navigation'), 'type' => Mystique::CHECKBOX ] ] ]; Searching data on Mystique field is limited. Because, Mystique saving data to database in json format. When you make search for Mystique field, operator not important. Operator will be changed with %= operator.
      Search example
      $navigationPages = pages()->find('my_mystique_field.show_on_nav=1'); $navigationPages = pages()->find('my_mystique_field.page_tpye=gallery');
×
×
  • Create New...