FORGEBOX Enterprise 🚀 - Take your ColdFusion (CFML) Development to Modern Times! Learn More...

PresideCMS Extension: GDPR cookie/tracking consent manager

v0.3.1 Public

Preside GDPR Cookie Extension

The new GDPR rules require to manage cookie more specific. Meanwhile it's not enough to say "Yeah Cookies, go ahead", you need to make them available for separate sections and allow the user to allow/deny every single cookie.

This tiny extension allows you to define all cookies and trackers you use on your website. A configuration page allows the (anonymize) visitor to allow/deny each single setting.

In your code you can check every setting for a user and react accordingly to show maybe some information or just leave out the code which tracks your visitor.

Dependencies (0)


Dev Dependencies (0)


Preside GDPR Cookie Extension

The new GDPR rules require to manage cookie more specific. Meanwhile it's not enough to say "Yeah Cookies, go ahead", you need to make them available for separate sections and allow the user to allow/deny every single cookie.

This tiny extension allows you to define all cookies and trackers you use on your website. A configuration page allows the (anonymize) visitor to allow/deny each single setting.

In your code you can check every setting for a user and react accordingly to show maybe some information or just leave out the code which tracks your visitor.

Attention: The module requires Bootstrap and jQuery to work.

Installation

Install the extension to your application via either of the methods detailed below (Git submodule / CommandBox + ForgeBox)

Git Submodule method

From the root of your application, type the following command:

git submodule add https://gitlab.com/madmike_de/preside-ext-gdpr.git application/extensions/preside-ext-gdpr

CommandBox (box.json) method

From the root of your application type the following command:

box install preside-ext-gdpr

From the Preside CMS developer console reload the application:

reload all

Usage

The visitor

The most funny thing about the GDPR cookie stuff is that you need to identify the individual user. This is happening with a - right: Cookie. The visitor ist completely anonymous and is automatically generated as a UUID using the Preside visitorService.getVisitorId().

As long as the VisitogID exists, the saved settings are checked and validated. When the VisitorID changes or the settings are deleted for this VisitorID the GDPR Dialog is shown again and all(!!) cookies are denied until the user allows them again.

Available itemShortCodes

The item short codes are predefined as an enum in the config/config.cfc file:

settings.enum.gdprItemShortcode  = [ "ga","matomo","gads","yt","vimeo","vid","cfid","cftoken","jsession" ];

This is done to avoid user errors and to allow only a selection of predefined values. If you need more values you can simply append them to the array in your own config.cfc with arrayAppend.

Objects

Three datamanager objects are definied by the extension:

  • gdprgroup: Define groups for organizing your cookies, like Statistics, tracking, etc.
  • gdpritem: Define the individual GDPR items you allow/deny for the visitor.
  • gdprpermission: Here are the saved permissions per item and visitor. In your code you can check if the visitor allowed/denied the item.

Pagetype

A pagetype gdpr is defined as a systempage. This page is showing a form with all grpritems, grouped by grprgroup and allows the user to allow/deny each single setting. The permissions are saved in the object gdprpermission per individual user.

System settings

There are several system setting for button labels, etc.

To show the annoying dialog to a visitor, asking for permission, do the following:

put the viewlet code at the start of your layout (must be before the first renderIncludes()):

gdprDialog = renderViewlet( event="gdpr._gdprDialog" );

at the end of your layout output the viewlet (must be before renderIncludes("js")):

#gdprDialog#

If the automatic generated visitorID can't be found in the gdprpermission object the dialog will be shown. Otherwise the visitor already did some settings and the dialog will not be shown.

Check permissions

Each gdpr item has a shortcode. This shortcode can be used as a simple identifier of the item. The shortcode can be used in the validation function. To check if a user allowed or denied the access of a permission use the following:

gdprIsAllowed('shortcode')

The functions return true/false when the permission for this item is allowed/denied.

Todos

  • Systemsetting for how long the cookie settings are stored.
  • Automatic task deleting settings older than specified.

License

Code released under the MIT licence.

See SilkTide licence for details.

THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

v0.3.1

  • removed the named dependencies of Bootstrap and jQuery

v0.3.0

  • layout optimization
  • simple bot checking (don't check for items for bots. Performance optimization)
  • created index on permission (performance problems with large DB table fixed)

v0.2.2

  • Moved itemShortCodes to an ENUM to avoid user errors

v0.2.1

  • Small optimizations for mobile devices.

v0.2.0

  • fixed a few small issues, occured after the first test in a live installation.

v0.1.5

  • Added flag for mandatory groups/items
  • Added flag to set groups/items in/active
  • Added field for provider and duration of items
  • Several UI optimizations
  • Enhanced errorhandling
  • Fixed bug in settings form to set the items correct as on/off
  • Ajax save for modal dialog
  • Added english/german translation. Thanks to @sebduggan

v0.1.1

  • implement the gdprIsAllowed() function as a helper function.

v0.1.0

this is the initial version with the following features:

  • manage gdpr groups
  • manage gdpr items
  • manage gdpr permission per user
  • settings for the dgpr dialog

 

$ box install preside-ext-gdpr

     
  • Feb 17 2020 12:57 PM
  • Jul 06 2020 08:46 AM
  • 313
  • 398
  • 45