Jump to content
joshua

PrivacyWire - Cookie Management & async external asset loading

Recommended Posts

Hi @ngrmm,
I just wanted to reply the exact same thing - the data-category and data-ask-consent should be at the iFrame tag directly, as you figured out 😉

Best,

Joshua

  • Like 2

Share this post


Link to post
Share on other sites

@joshua thx again.

Works great for iframes.
Is there also a solution to have it for external content which loads through scripts and divs. For example GoogleMaps. Right now i can do this:

// this puts content into #myMap
<script type="text/plain" data-type="text/javascript" data-category="external_media" data-src="gmaps.js"></script>

<div id='myMap'></div>

But unlike the your-iframe solution i cant have a ask-consent-button. It would be nice to have links like this integrated:

<a href="#" class="privacywire-allow-category" data-category="external_media" data-ask-consent="0">Allow Cookies for external media</a>


 

Share this post


Link to post
Share on other sites

haha

i see, you have already thought of that

<button class='privacywire-consent-button' data-consent-category='external_media'>allow cookies</button>

 

  • Like 1

Share this post


Link to post
Share on other sites

That's right - you cann add a button (or link, whatever you prefer) with this css class and the data-consent-category attribute. PrivacyWire will handle it 😉

I definetely have to update the documentation with all the added features - will do that in the next weeks.

  • Like 2

Share this post


Link to post
Share on other sites
40 minutes ago, joshua said:

I definetely have to update the documentation with all the added features - will do that in the next weeks.

Hehe. Documentation often lags far behind development. 🙃

Share this post


Link to post
Share on other sites

Hey @joshua!

I'm not sure if this is a real bug, but on one site I have a script like this:

<script id='taeggie-feed-widget-script-xxx' type="text/plain" data-type="text/javascript" data-category="marketing" data-ask-consent="1">
  jQuery.getScript(...);
</script>

This works and the consent info/request box is displayed. If I click the "accept" button from this info box it goes away and the script gets executed, so all is good in that case — but if I instead click the "accept all" button from the (separate) cookie management banner, the info and accept button next to the script are not removed.

Note that the script works as expected regardless of which accept method I use, so the only issue here seems to be that the info box / accept button are not removed. If I refresh the page, they are gone.

Is that a bug, feature, or user error? 🙂

  • Like 1

Share this post


Link to post
Share on other sites

Hey @teppo,

this sounds like a bug. I will take a look into this during the weekend.
Thanks for noticing!

  • Like 1

Share this post


Link to post
Share on other sites

I could no longer concentrate on my actual work in the knowledge that this bug existed. So I fixed it directly instead 😉

0.3.8 contains the bugfix.

  • Thanks 1
  • Haha 1

Share this post


Link to post
Share on other sites

Awesome — thanks Joshua!

Just a heads-up: I've opened a new PR for you to check out at https://github.com/blaueQuelle/privacywire/pull/10. This is quite opinionated, so let me know if you don't feel it's a great match with the module. Basically what I've added is support for the textformatter module to replace embedded media/video iframes with PrivacyWire enabled ones.

It's mainly a compatibility layer for TextformatterVideoEmbed 🙂

  • Like 4

Share this post


Link to post
Share on other sites

Thanks @teppo! I will look into this and will merge your PR then 😉
Sounds like a very useful addition to me

  • Like 3

Share this post


Link to post
Share on other sites

Hi Joshua,

just an idea. If there were a counter for all closes of all finished user decisions and a separate one only for the "accept all" decisions, it would give me a perfect idea of the accept ratio of the specific site. Either generally (probably enough), or even per month in a table (to monitor changes in behaviour). In the module, or in logfiles or a CSV file with a row limit? Basically, sort of mini-statistics.

I have guesswork right now regarding Analytics' / Matomo's result changes and of how many users (in percent) those analytics results represent?

  • Like 2

Share this post


Link to post
Share on other sites

@teppo Thanks alot for your PR with the TextformatterVideoEmbed integration! I tested and merged your PR today.

I like the idea of adding more and more integrations with other modules like TextformatterVideoEmbed.

  • Like 3

Share this post


Link to post
Share on other sites

Hi @ceberlin,

sounds like an good idea to me. To allow this kind of "tracking" we would need to send this decission via JS to an endpoint which connects to the ProcessWire API.

I will think about an way to implement this feature. I'm also open for a PR, if you already have an idea how to realize this feature.

Share this post


Link to post
Share on other sites

I tried to disable or hide a "Remember me" checkbox. My HTML is

<div class="field has-text-right">
    <label class="checkbox">
        <input type="checkbox" name="rememberme" value="<?=(int) input()->cookie->rememberme?>">
        <?=__('Remember me')?>
    </label>
</div>

The code I'd prefer would be (notice the two "disabled" attributes on the label and the input)

<div class="field has-text-right">
    <label class="checkbox" disabled>
        <input type="checkbox" name="rememberme" value="<?=(int) input()->cookie->rememberme?>" disabled>
        <?=__('Remember me')?>
    </label>
</div>

Although I could live with only hiding it, which is what I've tried by adding

data-category="functional" data-ask-consent="0" data-ask-consent-rendered="1"

to the div, the label or the checkbox. And it hides them all right. The issue is that PrivacyWire does not care about innerHTML of my poor div, or about its class. I changed o.innerText=e.innerText with o.innerHTML=e.innerHTML directly into js/PrivacyWireUnstyled.js and I got my checkbox back, but without its initial class. I think it is the code at line 231 in src/js/PrivacyWire.js.

I know almost no JavaScript, so start throwing tomatoes - in the priw_updateAllowedElement there is no way to let the old element live instead of copy into a new one > insert the new one in the DOM > delete the old one?

Also, it feels to me that flipping between two attributes or two CSS classes should be all PrivacyWire needs to do in regard to the elements that need consent.

LATER: hmm, maybe not in regard to scripts. Leaving for the coffee machine...

 

hmmm.jpg.d15604314fa2490e9b29acac524ac0bc.jpg

 

  • Like 1
  • Thanks 1

Share this post


Link to post
Share on other sites

Hi @The G,

thanks for noticing this behavior! During the development of PrivacyWire I never thought of showing or hiding divs or "regular" elements - only thought of scripts, videos, media ... So, good catch!

I refactored that part of the priw_updateAllowedElement function to fix this bug.

Cloning is required for everything, where media, scripts or other external stuff gets loaded...
Waaaait a minute... While I was writing these lines of nonesense, I realized that this idea is wrong! 🥳 You're right - keeping the elements alive and just update the attributes works for scripts, images, iframes and of course divs and other elements, too. I refactored again and tested the new version with all kind of elements and media...

Only script tags need to be a new added element, as they will not run otherwise: https://html.spec.whatwg.org/multipage/scripting.html#script-processing-model

0.4.2 fixed it!

Edited by joshua
Added another bug within the old bugfix. It's fixed now :D
  • Like 3
  • Thanks 1

Share this post


Link to post
Share on other sites
On 11/25/2020 at 5:59 PM, joshua said:

@teppo Thanks alot for your PR with the TextformatterVideoEmbed integration! I tested and merged your PR today.

I like the idea of adding more and more integrations with other modules like TextformatterVideoEmbed.

@teppo & @joshua does this mean, that iframes generated via TextformatterVideoEmbed will use PrivvacyWite data-attributes and are hidden untill given consent?

 

Share this post


Link to post
Share on other sites
12 minutes ago, ngrmm said:

does this mean, that iframes generated via TextformatterVideoEmbed will use PrivvacyWite data-attributes and are hidden untill given consent?

If enabled in the TextformatterPrivacyWire settings, yes.

grafik.png.64904c7279fe590b671b1e8cc053cf74.png

But it's disabled by default.

  • Like 3

Share this post


Link to post
Share on other sites
47 minutes ago, joshua said:

If enabled in the TextformatterPrivacyWire settings, yes.

But it's disabled by default.

Ok. Then i'm doing something wrong.
I installed PrivacyWire and TextformatterVideoEmbed and added them both to my textarea-field as textformatters.
After that i choosed ExternalMedia to as you suggest above.
Now when i add a YouTube-Link inside my textarea and external-media-cookies are off, i still can see the Iframe.

I also installed TextformatterVideoEmbedOptions and activated YouTube: Enable privacy-enhanced mode.

All Modules are updated to newest version. 

Share this post


Link to post
Share on other sites
13 minutes ago, ngrmm said:

I installed PrivacyWire and TextformatterVideoEmbed and added them both to my textarea-field as textformatters.
After that i choosed ExternalMedia to as you suggest above.
Now when i add a YouTube-Link inside my textarea and external-media-cookies are off, i still can see the Iframe.

Just checking: TextformatterVideoEmbed is listed before TextformatterPrivacyWire? If it's the other way around, this won't work.

13 minutes ago, ngrmm said:

I also installed TextformatterVideoEmbedOptions and activated YouTube: Enable privacy-enhanced mode.

This could potentially affect the situation. I would make sure if it makes difference, i.e. try disabling it and see if that changes anything.

So far this has worked for me, but let us know if the issue persists 🙂

Edit: if TextformatterVideoEmbedOptions runs before TextformatterPrivacyWire, this will definitely break things due to this line: https://github.com/blaueQuelle/privacywire/blob/master/TextformatterPrivacyWire.module#L51. Seems like an easy fix, though. Admittedly the order of the modules is a bit fragile, but part of it is really due to the way textformatters work and there's not much that can be done about that.

Edited by teppo
  • Like 2

Share this post


Link to post
Share on other sites

TextformatterPrivacyWire.module works fine here as long as:
1) the iframe contains www.youtube.com/embed/ and not www.youtube-nocookie.com/embed/ and
2) as long as its the second textformatter (or at least the textformatter after VideoEmbed).

Just played around with it here in my testing setup.

  • Like 2

Share this post


Link to post
Share on other sites

I just added the support for videos embedded via the youtube-nocookie.com domain to the Textformatter. Fixed in 0.4.3

Thank you all for noticing and helping to find the missing URL 😉

  • Like 4

Share this post


Link to post
Share on other sites

Thank you all!

I had the formatters not in the right order!
So for all noobs like me: 

Textarea Text Formatters:
1. Video embed for YouTube/Vimeo
2. PrivacyWire Textformatter

and i guess after updating to 0.4.3 then:
1. Video embed for YouTube/Vimeo
2. Apply options for embedded YouTube and Vimeo videos
3. PrivacyWire Textformatter

Share this post


Link to post
Share on other sites

Well... while this works (1):

screenshot-20201201163234.thumb.png.e4dd9af8b3bc380aa5a12fdb87892825.png

This doesn't (2):

screenshot-20201201163315.thumb.png.10bf47160908c66aa4c539c5dc245d96.png

I use a slightly modified version of Ryan's Video embed for YouTube/Vimeo module which already saves the "no cookie" domain to the database.
Users would paste the URL as usual, the module fetches the oEmbed data but in my case the domain will be replaced.

Around line 104 in Ryan's module I changed that part:

$embedCode = str_replace('youtube.com', 'youtube-nocookie.com', $data['html']);

 

  • Confused 1

Share this post


Link to post
Share on other sites

@joshua thanks for the module.

I unchecked the module config checkbox "CSS: Add basic CSS Styling" and added via <script> the PrivacyWire.js (which, as of module implementation, seems to include CSS itself), but the PrivacyWireUnstyled.js still loads in network (i.e. a HTTP request is made to get it).

Is there a way to include "manually" all the JS files (including PrivacyWireUnstyled.js)?

That is, to make possible something like this:

<script src="/site/modules/PrivacyWire/js/PrivacyWire.js"></script>
<script src="/site/modules/PrivacyWire/js/PrivacyWireUnstyled.js"></script>

so it would be the developer choose to minify and merge files, and to manage for less HTTP requests.

 

Maybe a config option? 

Share this post


Link to post
Share on other sites

You have the "Render Banner and Header Content Manually" option in the module settings. After checking it you can insert the module generated code wherever you'd like. The script tags are generated by the folowing snippet:

$modules->get('PrivacyWire')->renderHeadContent()

Disclaimer: didn't tested my suggestion, this is just what I saw in the module's code.

Why would you want to include both PrivacyWire.js and PrivacyWireUnstyled.js? AFAIK they only differ in including or not the module's CSS for the frontend. Including PrivacyWireUnstyled.js would only waste resources if PrivacyWire.js is included.

  • Like 1

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 bernhard
      DEPRECATED
      I'm using this module in several projects, but it will likely not see any updates in the future. I'm not happy with it and I'm looking for ways to develop better solutions. RockTabulator was my first try, but I'm also not 100% happy with that. The tabulator library is great, but my module implementation is not. I hope to get a good solution soon, but it will be a lot of work...
      ---
      Some of you might have followed the development of this module here: https://processwire.com/talk/topic/15524-previewdiscussion-rockdatatables/ . It is the successor of "RockDataTables" and requires RockFinder to get the data for the grid easily and efficiently. It uses the open source part of agGrid for grid rendering.
       
      WHY?
      ProcessWire is awesome for creating all kinds of custom backend applications, but where it is not so awesome in my opinion is when it comes to listing this data. Of course we have the built in page lister and we have ListerPro, but none of that solutions is capable of properly displaying large amounts of data, for example lists of revenues, aggregations, quick and easy sorts by the user, instant filter and those kind of features. RockGrid to the rescue 😉 
       
      Features/Highlights:
      100k+ rows Instant (client side) filter, search, sort (different sort based on data type, eg "lower/greater than" for numbers, "contains" for strings) extendable via plugins (available plugins at the moment: fullscreen, csv export, reload, batch-processing of data, column sum/statistics, row selection) all the agGrid features (cell renderers, cell styling, pagination, column grouping etc) vanilla javascript, backend and frontend support (though not all plugins are working on the frontend yet and I don't plan to support it as long as I don't need it myself)  
      Limitations:
      While there is an option to retrieve data via AJAX the actual processing of the grid (displaying, filtering, sorting) is done on the client side, meaning that you can get into troubles when handling really large datasets of several thousands of rows. agGrid should be one of the most performant grid options in the world (see the official example page with a 100k row example) and does a lot to prevent problems (such as virtual row rendering), but you should always have this limitation in mind as this is a major difference to the available lister options that do not have this limitation.
      Currently it only supports AdminThemeUikit and I don't plan to support any other admin theme.
       
      Download: https://gitlab.com/baumrock/FieldtypeRockGrid
      Installation: https://gitlab.com/baumrock/RockGrid/wikis/Installation
      Quikckstart: https://gitlab.com/baumrock/RockGrid/wikis/quickstart
      Further instructions: https://gitlab.com/baumrock/RockGrid/wikis/quickstart#further-instructions
      German Translation File: site--modules--fieldtyperockgrid--fieldtyperockgrid-module-php.json
      Changelog: https://gitlab.com/baumrock/FieldtypeRockGrid/raw/master/changelog.md
       
      Module status: alpha, License: MIT
      Note that every installation and uninstallation sends an anonymous google analytics event to my google analytics account. If you don't want that feel free to remove the appropriate lines of code before installation/uninstallation.
       
      Contribute:
      You can contribute to the development of this and other modules or just say thank you by
      testing, reporting issues and making PRs at gitlab liking this post buying me a drink: paypal.me/baumrock/5 liking my facebook page: facebook.com/baumrock hiring me for pw work: baumrock.com  
      Support: Please note that this module might not be as easy and plug&play as many other modules. It needs a good understanding of agGrid (and JavaScript in general) and it likely needs some looks into the code to get all the options. Please understand that I can not provide free support for every request here in the forum. I try to answer all questions that might also help others or that might improve the module but for individual requests I offer paid support (please contact me via PM).
       
      Use Cases / Examples:
      Colored grid cells, Icons, Links etc. The Grid also has a "batcher" feature built in that helps communicating with the server via AJAX and managing resource intensive tasks in batches:

      Filters, PW panel links and instant reload on panel close:

      You can combine the grid with a chart library like I did with the (outdated) RockDataTables module:

    • By Paul Greinke
      Hi there. I wrote a custom module for one of my projects. In fact I maybe want to use my module in other projects too. In order to be variable and customizable  I need to implement some custom hooks into my module. So I can afterwards hook into the my functions in order to modify them to match the needs of the new project.
      I tried simply defining functions with the '__' prefix. But that did not work. I'm imagining something like the following:
      <?php class MyClass { public function ___someFunction() { // Do something } } // ready.php $this->addHookBefore('MyClass::someFunction', function($event) { // some customization }); Is there a way to accomplish that? 
    • By adrian
      Hi everyone,
      Here's a new module that I have been meaning to build for a long time.
      http://modules.processwire.com/modules/process-admin-actions/
      https://github.com/adrianbj/ProcessAdminActions
       
      What does it do?
      Do you have a bunch of admin snippets laying around, or do you recreate from them from scratch every time you need them, or do you try to find where you saw them in the forums, or on the ProcessWire Recipes site?
      Admin Actions lets you quickly create actions in the admin that you can use over and over and even make available to your site editors (permissions for each action are assigned to roles separately so you have full control over who has access to which actions).
       
      Included Actions
      It comes bundled with several actions and I will be adding more over time (and hopefully I'll get some PRs from you guys too). You can browse and sort and if you have @tpr's Admin on Steroid's datatables filter feature, you can even filter based on the content of all columns. 

      The headliner action included with the module is: PageTable To RepeaterMatrix which fully converts an existing (and populated) PageTable field to either a Repeater or RepeaterMatrix field. This is a huge timesaver if you have an existing site that makes heavy use of PageTable fields and you would like to give the clients the improved interface of RepeaterMatrix.
      Copy Content To Other Field
      This action copies the content from one field to another field on all pages that use the selected template.
      Copy Field Content To Other Page
      Copies the content from a field on one page to the same field on another page.
      Copy Repeater Items To Other Page
      Add the items from a Repeater field on one page to the same field on another page.
      Copy Table Field Rows To Other Page
      Add the rows from a Table field on one page to the same field on another page.
      Create Users Batcher
      Allows you to batch create users. This module requires the Email New User module and it should be configured to generate a password automatically.
      Delete Unused Fields
      Deletes fields that are not used by any templates.
      Delete Unused Templates
      Deletes templates that are not used by any pages.
      Email Batcher
      Lets you email multiple addresses at once.
      Field Set Or Search And Replace
      Set field values, or search and replace text in field values from a filtered selection of pages and fields.
      FTP Files to Page
      Add files/images from a folder to a selected page.
      Page Active Languages Batcher
      Lets you enable or disable active status of multiple languages on multiple pages at once.
      Page Manipulator
      Uses an InputfieldSelector to query pages and then allows batch actions on the matched pages.
      Page Table To Repeater Matrix
      Fully converts an existing (and populated) PageTable field to either a Repeater or RepeaterMatrix field.
      Template Fields Batcher
      Lets you add or remove multiple fields from multiple templates at once.
      Template Roles Batcher
      Lets you add or remove access permissions, for multiple roles and multiple templates at once.
      User Roles Permissions Batcher
      Lets you add or remove permissions for multiple roles, or roles for multiple users at once.
       
      Creating a New Action
      If you create a new action that you think others would find useful, please add it to the actions subfolder of this module and submit a PR. If you think it is only useful for you, place it in /site/templates/AdminActions/ so that it doesn't get lost on module updates.
      A new action file can be as simple as this:
      class UnpublishAboutPage extends ProcessAdminActions { protected function executeAction() { $p = $this->pages->get('/about/'); $p->addStatus(Page::statusUnpublished); $p->save(); return true; } } Each action:
      class must extend "ProcessAdminActions" and the filename must match the class name and end in ".action.php" like: UnpublishAboutPage.action.php the action method must be: executeAction() As you can see there are only a few lines needed to wrap the actual API call, so it's really worth the small extra effort to make an action.
      Obviously that example action is not very useful. Here is another more useful one that is included with the module. It includes $description, $notes, and $author variables which are used in the module table selector interface. It also makes use of the defineOptions() method which builds the input fields used to gather the required options before running the action.
      class DeleteUnusedFields extends ProcessAdminActions { protected $description = 'Deletes fields that are not used by any templates.'; protected $notes = 'Shows a list of unused fields with checkboxes to select those to delete.'; protected $author = 'Adrian Jones'; protected $authorLinks = array( 'pwforum' => '985-adrian', 'pwdirectory' => 'adrian-jones', 'github' => 'adrianbj', ); protected function defineOptions() { $fieldOptions = array(); foreach($this->fields as $field) { if ($field->flags & Field::flagSystem || $field->flags & Field::flagPermanent) continue; if(count($field->getFieldgroups()) === 0) $fieldOptions[$field->id] = $field->label ? $field->label . ' (' . $field->name . ')' : $field->name; } return array( array( 'name' => 'fields', 'label' => 'Fields', 'description' => 'Select the fields you want to delete', 'notes' => 'Note that all fields listed are not used by any templates and should therefore be safe to delete', 'type' => 'checkboxes', 'options' => $fieldOptions, 'required' => true ) ); } protected function executeAction($options) { $count = 0; foreach($options['fields'] as $field) { $f = $this->fields->get($field); $this->fields->delete($f); $count++; } $this->successMessage = $count . ' field' . _n('', 's', $count) . ' ' . _n('was', 'were', $count) . ' successfully deleted'; return true; } }  
      This defineOptions() method builds input fields that look like this:

      Finally we use $options array in the executeAction() method to get the values entered into those options fields to run the API script to remove the checked fields.
      There is one additional method that I didn't outline called: checkRequirements() - you can see it in action in the PageTableToRepeaterMatrix action. You can use this to prevent the action from running if certain requirements are not met.
      At the end of the executeAction() method you can populate $this->successMessage, or $this->failureMessage which will be returned after the action has finished.
       
      Populating options via URL parameters
      You can also populate the option parameters via URL parameters. You should split multiple values with a “|” character.
      You can either just pre-populate options:
      http://mysite.dev/processwire/setup/admin-actions/options?action=TemplateFieldsBatcher&templates=29|56&fields=219&addOrRemove=add
      or you can execute immediately:
      http://mysite.dev/processwire/setup/admin-actions/execute?action=TemplateFieldsBatcher&templates=29|56&fields=219&addOrRemove=add

      Note the “options” vs “execute” as the last path before the parameters.
       
      Automatic Backup / Restore
      Before any action is executed, a full database backup is automatically made. You have a few options to run a restore if needed:
      Follow the Restore link that is presented after an action completes Use the "Restore" submenu: Setup > Admin Actions > Restore Move the restoredb.php file from the /site/assets/cache/AdminActions/ folder to the root of your site and load in the browser Manually restore using the AdminActionsBackup.sql file in the /site/assets/cache/AdminActions/ folder I think all these features make it very easy to create custom admin data manipulation methods that can be shared with others and executed using a simple interface without needing to build a full Process Module custom interface from scratch. I also hope it will reduce the barriers for new ProcessWire users to create custom admin functionality.
      Please let me know what you think, especially if you have ideas for improving the interface, or the way actions are defined.
       
       
    • By joshua
      As we often use Matomo (former known as Piwik) instead of Google Analytics we wanted to embed Matomo not only in the template code but also via the ProcessWire backend.
      That's why I developed a tiny module for the implementation.
      The module provides the possibility to connect to an existing Matomo installation with the classical site tracking and also via the Matomo Tag Manager.
      If you have also PrivacyWire installed, you can tell MatomoWire to only load the script, if the user has accepted cookies via PrivacyWire.
      To offer an Opt-Out solution you can choose between the simple Opt-Out iFrame, delivered by your Matomo installation, or a button to choose cookies via PrivacyWire.
      You'll find the module both in the module directory and via github:
      ProcessWire Module Directory MatomoWire @ GitHub MatomoWire @ Packagist ->installable via composer require blauequelle/matomowire I'm looking forward to hear your feedback!


    • By Robin S
      If your module has a lot of config fields you might want to divide them into groups inside a tabbed interface. Here is a demonstration module showing how this can be done.
      https://github.com/Toutouwai/ModuleConfigTabs

      Thanks to @kixe for providing my starting point in this forum topic.
×
×
  • Create New...