├── Resources ├── Private │ ├── .htaccess │ ├── Layouts │ │ └── PopupLayout.html │ ├── Partials │ │ └── TableRowsByGroup.html │ └── Themes │ │ ├── bootstrap4-modal │ │ └── Templates │ │ │ └── Popup.html │ │ ├── bootstrap5-modal │ │ └── Templates │ │ │ └── Popup.html │ │ ├── bootstrap3-modal │ │ └── Templates │ │ │ └── Popup.html │ │ └── bootstrap3-banner │ │ └── Templates │ │ └── Popup.html └── Public │ ├── Js │ ├── cookieman-init.min.js │ ├── Injects │ │ └── example-inject.js │ ├── cookieman-init.js │ ├── js.cookie.min.js │ └── cookieman.min.js │ ├── Themes │ ├── bootstrap3-banner │ │ ├── cookieman-theme.min.js │ │ ├── cookieman-theme.js │ │ ├── cookieman-theme.min.css │ │ └── cookieman-theme.css │ ├── bootstrap3-modal │ │ ├── cookieman-theme.min.js │ │ ├── cookieman-theme.min.css │ │ ├── cookieman-theme.css │ │ └── cookieman-theme.js │ ├── bootstrap4-modal │ │ ├── cookieman-theme.min.js │ │ ├── cookieman-theme.min.css │ │ ├── cookieman-theme.css │ │ └── cookieman-theme.js │ └── bootstrap5-modal │ │ ├── cookieman-theme.min.js │ │ ├── cookieman-theme.js │ │ ├── cookieman-theme.min.css │ │ └── cookieman-theme.css │ └── Icons │ └── Extension.svg ├── Documentation ├── Images │ ├── bs3-modal.png │ ├── cookieman.png │ ├── cookieman1.jpg │ ├── cookieman2.jpg │ ├── cookieman3.jpg │ ├── bs4-modal-colors.png │ ├── d-mind_logo_rgb.png │ ├── bs3-banner-initial.png │ ├── bs3-banner-opened.png │ ├── bs3-modal-initial.png │ ├── bs4-modal-initial.png │ ├── illu-3zu2-cookieman-d-mind.png │ ├── illl-transparenter-hintergrund.png │ └── header-cookieman-certified-extension-typo3.png ├── Sitemap.rst ├── Configuration │ ├── Reference │ │ ├── Index.rst │ │ ├── TypoScriptConstants │ │ │ └── Index.rst │ │ └── TypoScriptSetup │ │ │ └── Index.rst │ ├── Index.rst │ ├── CookieUsage │ │ └── Index.rst │ ├── Example │ │ └── Index.rst │ ├── Customization │ │ └── Index.rst │ └── How-To │ │ └── Index.rst ├── Includes.txt ├── Links │ └── Index.rst ├── Translation │ └── Index.rst ├── Installation │ └── Index.rst ├── Index.rst ├── Developer │ ├── JavaScript.rst │ └── Contributing.rst ├── Introduction │ └── Index.rst └── Settings.cfg ├── Configuration ├── Services.yaml ├── TypoScript │ ├── TrackingObjects │ │ ├── fe_typo_user.typoscript │ │ ├── CookieConsent.typoscript │ │ ├── GoogleMaps.typoscript │ │ ├── Youtube.typoscript │ │ ├── Vimeo.typoscript │ │ ├── GoogleTagManager.typoscript │ │ ├── Bing.typoscript │ │ ├── MicrosoftForms.typoscript │ │ ├── Slideshare.typoscript │ │ ├── MicrosoftStream.typoscript │ │ ├── FacebookPixel.typoscript │ │ ├── Matomo.typoscript │ │ ├── eTracker.typoscript │ │ ├── GoogleAds.typoscript │ │ └── GoogleAnalytics.typoscript │ ├── constants.typoscript │ ├── Example │ │ └── setup.typoscript │ └── setup.typoscript └── TCA │ └── Overrides │ └── sys_template.php ├── .php-cs-fixer.php ├── ext_emconf.php ├── Classes ├── ViewHelpers │ └── ShownTrackingObjectsViewHelper.php └── DataProcessing │ └── TypoScriptSettingsProcessor.php ├── README.md ├── composer.json └── LICENSE /Resources/Private/.htaccess: -------------------------------------------------------------------------------- 1 | deny from all 2 | -------------------------------------------------------------------------------- /Documentation/Images/bs3-modal.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/dmind-gmbh/extension-cookieman/HEAD/Documentation/Images/bs3-modal.png -------------------------------------------------------------------------------- /Documentation/Images/cookieman.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/dmind-gmbh/extension-cookieman/HEAD/Documentation/Images/cookieman.png -------------------------------------------------------------------------------- /Documentation/Images/cookieman1.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/dmind-gmbh/extension-cookieman/HEAD/Documentation/Images/cookieman1.jpg -------------------------------------------------------------------------------- /Documentation/Images/cookieman2.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/dmind-gmbh/extension-cookieman/HEAD/Documentation/Images/cookieman2.jpg -------------------------------------------------------------------------------- /Documentation/Images/cookieman3.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/dmind-gmbh/extension-cookieman/HEAD/Documentation/Images/cookieman3.jpg -------------------------------------------------------------------------------- /Documentation/Images/bs4-modal-colors.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/dmind-gmbh/extension-cookieman/HEAD/Documentation/Images/bs4-modal-colors.png -------------------------------------------------------------------------------- /Documentation/Images/d-mind_logo_rgb.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/dmind-gmbh/extension-cookieman/HEAD/Documentation/Images/d-mind_logo_rgb.png -------------------------------------------------------------------------------- /Resources/Public/Js/cookieman-init.min.js: -------------------------------------------------------------------------------- 1 | null!==document.querySelector('[data-cookieman-showonce="1"]')&&setTimeout(cookieman.showOnce,100); 2 | -------------------------------------------------------------------------------- /Documentation/Images/bs3-banner-initial.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/dmind-gmbh/extension-cookieman/HEAD/Documentation/Images/bs3-banner-initial.png -------------------------------------------------------------------------------- /Documentation/Images/bs3-banner-opened.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/dmind-gmbh/extension-cookieman/HEAD/Documentation/Images/bs3-banner-opened.png -------------------------------------------------------------------------------- /Documentation/Images/bs3-modal-initial.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/dmind-gmbh/extension-cookieman/HEAD/Documentation/Images/bs3-modal-initial.png -------------------------------------------------------------------------------- /Documentation/Images/bs4-modal-initial.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/dmind-gmbh/extension-cookieman/HEAD/Documentation/Images/bs4-modal-initial.png -------------------------------------------------------------------------------- /Documentation/Images/illu-3zu2-cookieman-d-mind.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/dmind-gmbh/extension-cookieman/HEAD/Documentation/Images/illu-3zu2-cookieman-d-mind.png -------------------------------------------------------------------------------- /Documentation/Images/illl-transparenter-hintergrund.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/dmind-gmbh/extension-cookieman/HEAD/Documentation/Images/illl-transparenter-hintergrund.png -------------------------------------------------------------------------------- /Documentation/Images/header-cookieman-certified-extension-typo3.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/dmind-gmbh/extension-cookieman/HEAD/Documentation/Images/header-cookieman-certified-extension-typo3.png -------------------------------------------------------------------------------- /Documentation/Sitemap.rst: -------------------------------------------------------------------------------- 1 | :template: sitemap.html 2 | 3 | .. _sitemap: 4 | 5 | ======= 6 | Sitemap 7 | ======= 8 | 9 | .. template 'sitemap.html' will insert the toctree as a sitemap here 10 | below normal contents 11 | -------------------------------------------------------------------------------- /Resources/Public/Js/Injects/example-inject.js: -------------------------------------------------------------------------------- 1 | // won't work in IE11 https://developer.mozilla.org/en-US/docs/Web/API/Document/currentScript 2 | console.log('cookieman: I would inject ' + document.currentScript.dataset.what + ' now...') 3 | -------------------------------------------------------------------------------- /Configuration/Services.yaml: -------------------------------------------------------------------------------- 1 | services: 2 | Dmind\Cookieman\DataProcessing\TypoScriptSettingsProcessor: 3 | autowire: true 4 | autoconfigure: false 5 | public: true 6 | Dmind\Cookieman\ViewHelpers\ShownTrackingObjectsViewHelper: 7 | public: true 8 | -------------------------------------------------------------------------------- /Documentation/Configuration/Reference/Index.rst: -------------------------------------------------------------------------------- 1 | .. include:: ../../Includes.txt 2 | 3 | 4 | .. _typoscript-reference: 5 | 6 | ==================== 7 | TypoScript Reference 8 | ==================== 9 | 10 | .. toctree:: 11 | :glob: 12 | :titlesonly: 13 | 14 | */* 15 | -------------------------------------------------------------------------------- /Configuration/TypoScript/TrackingObjects/fe_typo_user.typoscript: -------------------------------------------------------------------------------- 1 | plugin.tx_cookieman.settings.trackingObjects { 2 | fe_typo_user { 3 | show { 4 | fe_typo_user { 5 | duration = 6 | durationUnit = session 7 | type = cookie_http 8 | provider = Website 9 | } 10 | } 11 | } 12 | } 13 | -------------------------------------------------------------------------------- /Configuration/TypoScript/TrackingObjects/CookieConsent.typoscript: -------------------------------------------------------------------------------- 1 | plugin.tx_cookieman.settings.trackingObjects { 2 | CookieConsent { 3 | show { 4 | CookieConsent { 5 | duration = 1 6 | durationUnit = year 7 | type = cookie_http+html 8 | provider = Website 9 | } 10 | } 11 | } 12 | } 13 | -------------------------------------------------------------------------------- /Resources/Public/Themes/bootstrap3-banner/cookieman-theme.min.js: -------------------------------------------------------------------------------- 1 | !function(){"use strict";jQuery(function(){jQuery('[aria-controls="cookieman-settings"]').on("click",function(){jQuery("[data-cookieman-save]").show()})}),cookieman.show=function(){jQuery(function(){jQuery("#cookieman-modal").modal({show:!0,backdrop:true})})},cookieman.hide=function(){jQuery(function(){jQuery("#cookieman-modal").modal("hide")})}}(); 2 | -------------------------------------------------------------------------------- /Resources/Public/Themes/bootstrap3-modal/cookieman-theme.min.js: -------------------------------------------------------------------------------- 1 | !function(){"use strict";jQuery(function(){jQuery('[aria-controls="cookieman-settings"]').on("click",function(){jQuery("[data-cookieman-save]").show()})}),cookieman.show=function(){jQuery(function(){jQuery("#cookieman-modal").modal({show:!0,backdrop:true})})},cookieman.hide=function(){jQuery(function(){jQuery("#cookieman-modal").modal("hide")})}}(); 2 | -------------------------------------------------------------------------------- /Resources/Public/Themes/bootstrap4-modal/cookieman-theme.min.js: -------------------------------------------------------------------------------- 1 | !function(){"use strict";jQuery(function(){jQuery('[aria-controls="cookieman-settings"]').on("click",function(){jQuery("[data-cookieman-save]").show()})}),cookieman.show=function(){jQuery(function(){jQuery("#cookieman-modal").modal({show:!0,backdrop:true})})},cookieman.hide=function(){jQuery(function(){jQuery("#cookieman-modal").modal("hide")})}}(); 2 | -------------------------------------------------------------------------------- /Resources/Public/Js/cookieman-init.js: -------------------------------------------------------------------------------- 1 | // show consent popup (once) if we find a data-cookieman-showonce="1" tag somewhere (used e.g. to suppress on specific 2 | // pages) 3 | /** global: cookieman */ 4 | 5 | if (null !== document.querySelector('[data-cookieman-showonce="1"]')) { 6 | // get out out of the main rendering thread 7 | setTimeout( 8 | cookieman.showOnce, 9 | 100 10 | ) 11 | } 12 | -------------------------------------------------------------------------------- /Resources/Public/Themes/bootstrap5-modal/cookieman-theme.min.js: -------------------------------------------------------------------------------- 1 | !function(){"use strict";var o=document.querySelector('[aria-controls="cookieman-settings"]'),e=null;o&&o.addEventListener("click",function(o){var e=document.querySelector("[data-cookieman-save]:not([data-cookieman-accept-all]):not([data-cookieman-accept-none])");e&&(e.hidden=!1)}),cookieman.show=function(){(e=new bootstrap.Modal(document.getElementById("cookieman-modal"),{backdrop:true})).show()},cookieman.hide=function(){e&&e.hide()}}(); 2 | -------------------------------------------------------------------------------- /Resources/Public/Themes/bootstrap3-modal/cookieman-theme.min.css: -------------------------------------------------------------------------------- 1 | #cookieman-modal.modal{z-index:9999}@media (min-width:768px){#cookieman-modal .modal-dialog{margin:80px auto 0}}#cookieman-modal label{margin-bottom:0}#cookieman-modal .panel-title{position:relative}#cookieman-modal table{font-size:80%}#cookieman-modal .modal-body{padding-bottom:0}#cookieman-modal [data-toggle=collapse]:after{font-family:'Glyphicons Halflings';content:"\e114";font-size:.7em;padding-left:.7em;opacity:.7;padding-top:.4%}#cookieman-settings [data-toggle=collapse]:after{float:right}#cookieman-modal [data-toggle=collapse].collapsed:after{content:"\e080"} 2 | -------------------------------------------------------------------------------- /Resources/Public/Themes/bootstrap4-modal/cookieman-theme.min.css: -------------------------------------------------------------------------------- 1 | #cookieman-modal table{font-size:80%}#cookieman-modal [data-toggle=collapse]:after{content:"+";font-size:2.5rem;opacity:.7;position:absolute;right:12px;top:50%;line-height:0;transition:transform ease-in-out .3s;transform-origin:center;transform:rotate(45deg)}#cookieman-modal [data-toggle=collapse].collapsed:after{transform:rotate(0)}#cookieman-settings .card-header{position:relative}#cookieman-modal [data-toggle=collapse][data-target="#cookieman-settings"]{position:relative}#cookieman-modal [data-toggle=collapse][data-target="#cookieman-settings"]:after{font-size:2rem} 2 | -------------------------------------------------------------------------------- /.php-cs-fixer.php: -------------------------------------------------------------------------------- 1 | getFinder() 5 | ->ignoreVCS(true) 6 | ->ignoreVCSIgnored(true) 7 | ->notName(['ext_localconf.php', 'ext_tables.php', 'ext_emconf.php', 'additional.php']) 8 | ->exclude(['Tests/Acceptance/Support/_generated/']) 9 | ->in(__DIR__); 10 | $config->addRules( 11 | [ 12 | 'yoda_style' => false, // dude, I love yoda style 13 | 'function_declaration' => [ 14 | 'closure_function_spacing' => 'none', 15 | 'closure_fn_spacing' => 'none', 16 | ], 17 | 'single_line_empty_body' => false, 18 | 'cast_spaces' => ['space' => 'single'], 19 | ] 20 | ); 21 | 22 | return $config; 23 | -------------------------------------------------------------------------------- /Documentation/Configuration/Index.rst: -------------------------------------------------------------------------------- 1 | .. include:: ../Includes.txt 2 | 3 | 4 | .. _configuration: 5 | 6 | ============= 7 | Configuration 8 | ============= 9 | 10 | Target group: **Developers, Integrators** 11 | 12 | This extension comes with two static templates: 13 | 14 | * `Cookieman` contains the basic and necessary configuration. Use this and extend the settings to your needs. 15 | 16 | * `Cookieman (Example configuration of groups and tracking objects)` can be included additionally to get 17 | a full example with multiple groups and tracking objects. 18 | 19 | Learn how to configure Cookieman: 20 | 21 | .. toctree:: 22 | :glob: 23 | :titlesonly: 24 | 25 | CookieUsage/* 26 | Example/* 27 | Reference/* 28 | Customization/* 29 | How-To/* 30 | -------------------------------------------------------------------------------- /Documentation/Includes.txt: -------------------------------------------------------------------------------- 1 | .. ================================================== 2 | .. FOR YOUR INFORMATION 3 | .. -------------------------------------------------- 4 | .. -*- coding: utf-8 -*- with BOM. 5 | 6 | .. This is 'Includes.txt'. It is included at the very top of each and 7 | every ReST source file in this documentation project (= manual). 8 | 9 | 10 | .. ================================================== 11 | .. DEFINE SOME TEXT ROLES 12 | .. -------------------------------------------------- 13 | 14 | .. role:: typoscript(code) 15 | 16 | .. role:: ts(typoscript) 17 | :class: typoscript 18 | 19 | .. role:: php(code) 20 | .. role:: js(code) 21 | 22 | .. highlight:: php 23 | 24 | .. role:: aspect (emphasis) 25 | .. role:: sep (strong) 26 | 27 | .. default-role:: code 28 | -------------------------------------------------------------------------------- /Configuration/TCA/Overrides/sys_template.php: -------------------------------------------------------------------------------- 1 | 8 | ) 9 | } 10 | # example: 11 | # inject ( 12 | # We are planning to support Google Maps out-of-the-box with cookieman. Stay tuned. 13 | # ) 14 | show { 15 | # https://www.microsoft.com/de-de/trust-center/privacy/gdpr-overview 16 | GoogleMaps { 17 | duration = 18 | durationUnit = none 19 | type = connection 20 | provider = Google 21 | } 22 | } 23 | } 24 | } 25 | -------------------------------------------------------------------------------- /Resources/Public/Themes/bootstrap4-modal/cookieman-theme.css: -------------------------------------------------------------------------------- 1 | #cookieman-modal table { 2 | font-size: 80%; 3 | } 4 | 5 | #cookieman-modal [data-toggle="collapse"]:after { 6 | content: "+"; 7 | font-size: 2.5rem; 8 | opacity: .7; 9 | position: absolute; 10 | right: 12px; 11 | top: 50%; 12 | line-height: 0; 13 | transition: transform ease-in-out 0.3s; 14 | transform-origin: center; 15 | transform: rotate(45deg); 16 | } 17 | 18 | #cookieman-modal [data-toggle="collapse"].collapsed:after { 19 | transform: rotate(0); 20 | } 21 | 22 | #cookieman-settings .card-header { 23 | position: relative; 24 | } 25 | #cookieman-modal [data-toggle="collapse"][data-target="#cookieman-settings"] { 26 | position: relative; 27 | } 28 | #cookieman-modal [data-toggle="collapse"][data-target="#cookieman-settings"]:after { 29 | font-size: 2rem; 30 | } 31 | -------------------------------------------------------------------------------- /Resources/Public/Themes/bootstrap3-modal/cookieman-theme.css: -------------------------------------------------------------------------------- 1 | #cookieman-modal.modal { 2 | z-index: 9999; 3 | } 4 | 5 | @media (min-width: 768px) { 6 | #cookieman-modal .modal-dialog { 7 | margin: 80px auto 0; 8 | } 9 | } 10 | 11 | #cookieman-modal label { 12 | margin-bottom: 0; 13 | } 14 | 15 | #cookieman-modal .panel-title { 16 | position: relative; 17 | } 18 | 19 | #cookieman-modal table { 20 | font-size: 80%; 21 | } 22 | 23 | #cookieman-modal .modal-body { 24 | padding-bottom: 0; 25 | } 26 | 27 | #cookieman-modal [data-toggle="collapse"]:after { 28 | font-family: 'Glyphicons Halflings'; 29 | content: "\e114"; 30 | font-size: .7em; 31 | padding-left: .7em; 32 | opacity: .7; 33 | padding-top: .4%; 34 | } 35 | 36 | #cookieman-settings [data-toggle="collapse"]:after { 37 | float: right; 38 | } 39 | 40 | #cookieman-modal [data-toggle="collapse"].collapsed:after { 41 | content: "\e080"; 42 | } 43 | -------------------------------------------------------------------------------- /Resources/Public/Themes/bootstrap3-banner/cookieman-theme.js: -------------------------------------------------------------------------------- 1 | // requires: cookieman.js, Bootstrap-JS, jQuery 2 | /** global: cookieman */ 3 | /** global: jQuery */ 4 | (function () { 5 | "use strict"; 6 | var showBackdrop = true 7 | 8 | // show "save" after opening settings 9 | jQuery(function () { 10 | jQuery('[aria-controls="cookieman-settings"]').on( 11 | 'click', 12 | function () { 13 | jQuery('[data-cookieman-save]').show() 14 | } 15 | ) 16 | }) 17 | 18 | cookieman.show = function () { 19 | jQuery(function () { 20 | var $modal = jQuery('#cookieman-modal') 21 | $modal.modal({show: true, backdrop: showBackdrop}) 22 | }) 23 | } 24 | cookieman.hide = function () { 25 | jQuery(function () { 26 | var $modal = jQuery('#cookieman-modal') 27 | $modal.modal('hide') 28 | }) 29 | } 30 | })() 31 | -------------------------------------------------------------------------------- /Resources/Public/Themes/bootstrap3-modal/cookieman-theme.js: -------------------------------------------------------------------------------- 1 | // requires: cookieman.js, Bootstrap-JS, jQuery 2 | /** global: cookieman */ 3 | /** global: jQuery */ 4 | (function () { 5 | "use strict"; 6 | var showBackdrop = true 7 | 8 | // show "save" after opening settings 9 | jQuery(function () { 10 | jQuery('[aria-controls="cookieman-settings"]').on( 11 | 'click', 12 | function () { 13 | jQuery('[data-cookieman-save]').show() 14 | } 15 | ) 16 | }) 17 | 18 | cookieman.show = function () { 19 | jQuery(function () { 20 | var $modal = jQuery('#cookieman-modal') 21 | $modal.modal({show: true, backdrop: showBackdrop}) 22 | }) 23 | } 24 | cookieman.hide = function () { 25 | jQuery(function () { 26 | var $modal = jQuery('#cookieman-modal') 27 | $modal.modal('hide') 28 | }) 29 | } 30 | })() 31 | -------------------------------------------------------------------------------- /Resources/Public/Themes/bootstrap4-modal/cookieman-theme.js: -------------------------------------------------------------------------------- 1 | // requires: cookieman.js, Bootstrap-JS, jQuery 2 | /** global: cookieman */ 3 | /** global: jQuery */ 4 | (function () { 5 | "use strict"; 6 | var showBackdrop = true 7 | 8 | // show "save" after opening settings 9 | jQuery(function () { 10 | jQuery('[aria-controls="cookieman-settings"]').on( 11 | 'click', 12 | function () { 13 | jQuery('[data-cookieman-save]').show() 14 | } 15 | ) 16 | }) 17 | 18 | cookieman.show = function () { 19 | jQuery(function () { 20 | var $modal = jQuery('#cookieman-modal') 21 | $modal.modal({show: true, backdrop: showBackdrop}) 22 | }) 23 | } 24 | cookieman.hide = function () { 25 | jQuery(function () { 26 | var $modal = jQuery('#cookieman-modal') 27 | $modal.modal('hide') 28 | }) 29 | } 30 | })() 31 | -------------------------------------------------------------------------------- /Resources/Public/Themes/bootstrap3-banner/cookieman-theme.min.css: -------------------------------------------------------------------------------- 1 | #cookieman-modal .modal-dialog{width:100%;max-width:unset;margin:0}@media (min-width:768px){#cookieman-modal .modal-dialog{margin:140px auto 20px}}#cookieman-modal .modal-content{border-radius:0;border:unset}@media (min-width:1025px){#cookieman-modal .modal-content{padding:5px 30% 10px}}#cookieman-modal .panel-default>.panel-heading{background-color:unset;padding:unset}#cookieman-modal .panel-group .panel-heading+.panel-collapse>.panel-body{border-top:none}#cookieman-modal .panel-title{position:relative}#cookieman-modal .panel-title a{display:inline-block;padding:15px 130px 15px 15px;width:100%}#cookieman-modal table{font-size:80%}#cookieman-settings [data-toggle=collapse]:after{content:"+";font-size:50px;opacity:.7;position:absolute;right:15px;top:50%;line-height:0;transition:transform ease-in-out .3s;transform-origin:center;transform:rotate(45deg)}#cookieman-settings [data-toggle=collapse].collapsed:after{transform:rotate(0)} 2 | -------------------------------------------------------------------------------- /Configuration/TypoScript/TrackingObjects/Youtube.typoscript: -------------------------------------------------------------------------------- 1 | plugin.tx_cookieman.settings.trackingObjects { 2 | YouTube { 3 | inject = TEXT 4 | inject { 5 | insertData = 1 6 | value ( 7 | 8 | ) 9 | } 10 | # example: 11 | # inject ( 12 | # We are planning to support Youtube out-of-the-box with cookieman. Stay tuned. 13 | # Until then please add your own logic (e.g. replacing your consent message including a 14 | # 105 | 106 | .. attention:: 107 | 108 | If your website uses a strict `Content-Security-Policy` (see `Mozilla Developer Network `__) the onclick= needs to be replaced with registering a click-handler from an external 21 | # 22 | # 23 | 24 | # ... then gets called when cookie usage is consented: 25 | inject ( 26 | 29 | ) 30 | 31 | show { 32 | # https://www.etracker.com/en/docs/integration-setup-2/settings-accounts/etracker-cookies/cookies-used/ 33 | cntcookie { 34 | duration = 4 35 | durationUnit = years 36 | type = cookie_http+html 37 | provider = etracker 38 | } 39 | 40 | GS3_v { 41 | duration = 1 42 | durationUnit = years 43 | type = cookie_http+html 44 | provider = etracker 45 | } 46 | 47 | _et_coid { 48 | duration = 2 49 | durationUnit = years 50 | type = cookie_http+html 51 | provider = etracker 52 | } 53 | 54 | et_oi_v2 { 55 | # sic! 50 years 56 | duration = 50 57 | durationUnit = years 58 | type = cookie_http+html 59 | provider = etracker 60 | } 61 | 62 | et_oip { 63 | duration = 50 64 | durationUnit = years 65 | type = cookie_http+html 66 | provider = etracker 67 | } 68 | 69 | et_allow_cookies { 70 | duration = 16 71 | durationUnit = months 72 | type = cookie_http+html 73 | provider = etracker 74 | } 75 | 76 | isSdEnabled { 77 | duration = 1 78 | durationUnit = day 79 | type = cookie_http+html 80 | provider = etracker 81 | } 82 | 83 | BT_ctst { 84 | duration = 85 | durationUnit = session 86 | type = cookie_http+html 87 | provider = etracker 88 | } 89 | 90 | BT_sdc { 91 | duration = 92 | durationUnit = session 93 | type = cookie_http+html 94 | provider = etracker 95 | } 96 | 97 | BT_pdc { 98 | duration = 1 99 | durationUnit = year 100 | type = cookie_http+html 101 | provider = etracker 102 | } 103 | 104 | BT_ecl { 105 | duration = 30 106 | durationUnit = days 107 | type = cookie_http+html 108 | provider = etracker 109 | } 110 | 111 | et_scroll_depth { 112 | duration = 113 | durationUnit = 114 | type = localstorage 115 | provider = etracker 116 | } 117 | 118 | targetingAPISession { 119 | duration = 120 | durationUnit = 121 | type = localstorage 122 | provider = etracker 123 | } 124 | 125 | _et_coid--localstorage { 126 | duration = 127 | durationUnit = 128 | type = localstorage 129 | provider = etracker 130 | } 131 | 132 | et_oi_v2--localstorage { 133 | duration = 134 | durationUnit = 135 | type = localstorage 136 | provider = etracker 137 | } 138 | 139 | et_oip--localstorage { 140 | duration = 141 | durationUnit = 142 | type = localstorage 143 | provider = etracker 144 | } 145 | } 146 | } 147 | } 148 | 149 | -------------------------------------------------------------------------------- /Classes/DataProcessing/TypoScriptSettingsProcessor.php: -------------------------------------------------------------------------------- 1 | configurationManager->getConfiguration( 41 | ConfigurationManagerInterface::CONFIGURATION_TYPE_SETTINGS, 42 | 'cookieman' 43 | ); 44 | 45 | $settings = $this->sanitizeSettings($settings, $cObj); 46 | 47 | $processedData['settings'] = $settings; 48 | 49 | return $processedData; 50 | } 51 | 52 | /** 53 | * Prepare TypoScript for the frontend. 54 | */ 55 | protected function sanitizeSettings(array $settings, ContentObjectRenderer $cObj): array 56 | { 57 | foreach (($settings['groups'] ?? []) as $groupId => $group) { 58 | if (isset($group['preselected'])) { 59 | $settings['groups'][$groupId]['preselected'] = (bool) $group['preselected']; 60 | } 61 | if (isset($group['disabled'])) { 62 | $settings['groups'][$groupId]['disabled'] = (bool) $group['disabled']; 63 | } 64 | if (isset($group['respectDnt'])) { 65 | $settings['groups'][$groupId]['respectDnt'] = (bool) $group['respectDnt']; 66 | } 67 | if (isset($group['showDntMessage'])) { 68 | $settings['groups'][$groupId]['showDntMessage'] = (bool) $group['showDntMessage']; 69 | } 70 | 71 | $trackingObjects = $group['trackingObjects'] ?? []; 72 | // sort to allow using TypoScript-style .20 .10 .40 etc. 73 | ksort($trackingObjects); 74 | // ignore keys on groups.trackingObjects - this makes sure it does not get output as an object in JSON 75 | $settings['groups'][$groupId]['trackingObjects'] = array_values($trackingObjects); 76 | } 77 | 78 | // render ` 79 | foreach (($settings['trackingObjects'] ?? []) as $trackingObjectKey => $trackingObject) { 80 | if (!($trackingObject['inject']['_typoScriptNodeValue'] ?? false)) { 81 | continue; 82 | } 83 | 84 | $settings['trackingObjects'][$trackingObjectKey]['inject'] 85 | = $this->renderCObject($trackingObject['inject'], $cObj); 86 | } 87 | 88 | return $settings; 89 | } 90 | 91 | protected function renderCObject(array $config, ContentObjectRenderer $cObj): string 92 | { 93 | $type = $config['_typoScriptNodeValue'] ?? null; 94 | if (!$type) { 95 | return ''; 96 | } 97 | unset($config['_typoScriptNodeValue']); 98 | 99 | if ($type === 'COA') { 100 | // Bring into "non-Extbasey" TypoScript form to render sub-objects directly 101 | $config = $this->convertPlainArrayToTypoScriptArray($config); 102 | } 103 | 104 | return $cObj->cObjGetSingle($type, $config); 105 | } 106 | 107 | /** 108 | * Taken from @see \TYPO3\CMS\Core\TypoScript\TypoScriptService::convertPlainArrayToTypoScriptArray 109 | */ 110 | protected function convertPlainArrayToTypoScriptArray(array $plainArray): array 111 | { 112 | $typoScriptArray = []; 113 | foreach ($plainArray as $key => $value) { 114 | if (is_array($value)) { 115 | if (isset($value['_typoScriptNodeValue'])) { 116 | $typoScriptArray[$key] = $value['_typoScriptNodeValue']; 117 | unset($value['_typoScriptNodeValue']); 118 | } 119 | $typoScriptArray[$key . '.'] = $this->convertPlainArrayToTypoScriptArray($value); 120 | } else { 121 | $typoScriptArray[$key] = $value ?? ''; 122 | } 123 | } 124 | return $typoScriptArray; 125 | } 126 | } 127 | -------------------------------------------------------------------------------- /Configuration/TypoScript/TrackingObjects/GoogleAds.typoscript: -------------------------------------------------------------------------------- 1 | plugin.tx_cookieman.settings.trackingObjects { 2 | GoogleAds { 3 | inject = 4 | show { 5 | # https://business.safety.google/adscookies/ 6 | __eoi { 7 | duration = 6 8 | durationUnit = months 9 | type = cookie_http+html 10 | provider = Google 11 | } 12 | 13 | NID { 14 | duration = 6 15 | durationUnit = months 16 | type = cookie_http+html 17 | provider = Google 18 | } 19 | 20 | __gads { 21 | duration = 13 22 | durationUnit = months 23 | type = cookie_http+html 24 | provider = Google 25 | } 26 | 27 | pm_sess { 28 | duration = 30 29 | durationUnit = minutes 30 | type = cookie_http+html 31 | provider = Google 32 | } 33 | 34 | pm_sess_NNN { 35 | duration = 30 36 | durationUnit = minutes 37 | type = cookie_http+html 38 | provider = Google 39 | htmlCookieRemovalPattern = ^pm_sess_ 40 | } 41 | 42 | aboutads_sessNNN { 43 | duration = 30 44 | durationUnit = minutes 45 | type = cookie_http+html 46 | provider = Google 47 | htmlCookieRemovalPattern = ^aboutads_sess_ 48 | } 49 | 50 | FPAU { 51 | duration = 90 52 | durationUnit = days 53 | type = cookie_http+html 54 | provider = Google 55 | } 56 | 57 | ANID { 58 | duration = 24 59 | durationUnit = months 60 | type = cookie_http+html 61 | provider = Google 62 | } 63 | 64 | AID { 65 | duration = 24 66 | durationUnit = months 67 | type = cookie_http+html 68 | provider = Google 69 | } 70 | 71 | TAID { 72 | duration = 14 73 | durationUnit = days 74 | type = cookie_http+html 75 | provider = Google 76 | } 77 | 78 | _gcl_au { 79 | duration = 90 80 | durationUnit = days 81 | type = cookie_http+html 82 | provider = Google 83 | } 84 | 85 | RUL { 86 | duration = 12 87 | durationUnit = months 88 | type = cookie_http+html 89 | provider = Google 90 | } 91 | 92 | FPGCLAW { 93 | duration = 90 94 | durationUnit = days 95 | type = cookie_http+html 96 | provider = Google 97 | } 98 | 99 | FPGCLGB { 100 | duration = 90 101 | durationUnit = days 102 | type = cookie_http+html 103 | provider = Google 104 | } 105 | 106 | _gcl_gb { 107 | duration = 90 108 | durationUnit = days 109 | type = cookie_http+html 110 | provider = Google 111 | } 112 | 113 | _gac_gb_--wpid-- { 114 | duration = 90 115 | durationUnit = days 116 | type = cookie_http+html 117 | provider = Google 118 | htmlCookieRemovalPattern = ^_gac_gb_ 119 | } 120 | 121 | _gcl_aw { 122 | duration = 90 123 | durationUnit = days 124 | type = cookie_http+html 125 | provider = Google 126 | } 127 | 128 | 1P_JAR { 129 | duration = 30 130 | durationUnit = days 131 | type = cookie_http+html 132 | provider = Google 133 | } 134 | 135 | Conversion { 136 | duration = 90 137 | durationUnit = days 138 | type = cookie_http+html 139 | provider = Google 140 | } 141 | 142 | YSC { 143 | duration = 144 | durationUnit = session 145 | type = cookie_http+html 146 | provider = Google 147 | } 148 | 149 | VISITOR_INFO1_LIVE { 150 | duration = 180 151 | durationUnit = days 152 | type = cookie_http+html 153 | provider = Google 154 | } 155 | 156 | VISITOR_INFO1_LIVE__k { 157 | duration = 180 158 | durationUnit = days 159 | type = cookie_http+html 160 | provider = Google 161 | } 162 | 163 | VISITOR_INFO1_LIVE__default { 164 | duration = 180 165 | durationUnit = days 166 | type = cookie_http+html 167 | provider = Google 168 | } 169 | } 170 | } 171 | } 172 | -------------------------------------------------------------------------------- /Documentation/Developer/Contributing.rst: -------------------------------------------------------------------------------- 1 | .. include:: ../Includes.txt 2 | 3 | 4 | .. _contributing: 5 | 6 | .. Helps Github discover the contributors page: 7 | .. _contributors: 8 | 9 | ============ 10 | Contributing 11 | ============ 12 | 13 | Target group: **Contributors** 14 | 15 | Thank you for considering contributions! You can contact us with any questions. 16 | 17 | .. _contribute_docs: 18 | 19 | Documentation 20 | ============= 21 | 22 | You are welcome to help improve this guide. Just click on "Edit me on GitHub" 23 | on the top right to submit your improvement via a Pull Request. 24 | 25 | .. _contribute_feedback: 26 | 27 | Translations 28 | ============ 29 | 30 | Translations are managed on the official TYPO3 translation platform. 31 | See :ref:`Translation `. 32 | 33 | 34 | Feedback 35 | ======== 36 | 37 | Any problems? You miss a feature? There is an incompatibility? You have strategic input? 38 | 39 | Please open an issue 40 | `at our Github repository `__ 41 | after you have read the documentation. 42 | 43 | .. _contribute_code: 44 | 45 | Code (Templates, JavaScript, PHP) 46 | ================================= 47 | 48 | We are happy to receive pull requests. 49 | 50 | Branches 51 | -------- 52 | 53 | We use one branch for each stable TYPO3 API version. This model is not followed by many extensions. 54 | It allows us to 55 | focus on that API only and not worry about compatibility constructs or inabilities to incorporate any new 56 | TYPO3 feature. So absolutely no `if (TYPO3_VERSION ...)` in cookieman. 57 | 58 | Also it simplifies testing, as each version might need a different setup. 59 | 60 | After switching branches, you might need a `git clean -fdX` to remove any ignored files which were 61 | created by another version's build (append `-e '!.idea'` to exclude .idea). 62 | 63 | Supported TYPO3 versions 64 | ~~~~~~~~~~~~~~~~~~~~~~~~ 65 | 66 | * all LTS versions: features, bugfixes, security 67 | * ELTS versions: security 68 | 69 | Exceptions can be made if Pull Requests are provided. 70 | 71 | We strive to support the latest version, too (but no promises). 72 | 73 | 74 | Releases 75 | -------- 76 | 77 | Releases follow `semver `__. Including with composer via `dmind/cookieman: ^2.0` shall never 78 | break any documented feature or the input or output of any function marked with @api in the code. 79 | Be sure to shoot us an angry message if we messed up! 80 | 81 | We usually release for all maintained TYPO3 APIs at the same time and use consecutive patch versions (e.g. 82 | 2.2.3, 2.2.4, 2.2.5), each supporting one. 83 | 84 | 85 | Create a new release 86 | ~~~~~~~~~~~~~~~~~~~~ 87 | 88 | Before creating a release you should merge the automatic Crowdin PRs until TYPO3v9 (in v10+ translations are 89 | Crowdin-only, for earlier versions we distribute them because we were not on the older "poodle" server). 90 | 91 | The DDEV host command :command:`ddev release ` will create a release commit and an annotated Git tag. 92 | It expects that you have set up Git for signing commits (:command:`git config --get user.signingKey`). 93 | 94 | Pushing the tag with :command:`git push --tags` makes the new release available for composer (packagist). 95 | It also triggers the Github Actions workflow "publish-ter" which uses the TER API via "tailor" to publish the new 96 | release to TER. 97 | 98 | Commits 99 | ------- 100 | 101 | We loosely follow the commit message style of 102 | `conventional commits `__. 103 | 104 | 105 | Run locally 106 | ----------- 107 | 108 | :command:`ddev start && ddev launch` will install a TYPO3 with example content and cookieman. 109 | This installs helper extensions that automatically enable a certain theme and some TypoScript setup to facilitate 110 | development. 111 | The admin user is "admin", password "aaAA11!!". 112 | 113 | The ddev custom command :command:`ddev install-git-hooks` installs CGL checkers as pre-commit hooks (only tested on Linux 114 | so far - the script runs under the container environment so good chances that this would work for other OSs as 115 | well). 116 | 117 | To throw away the database and restart cleanly, run :command:`ddev delete -Oy && git clean -fdX -e '!.idea' && ddev start` 118 | 119 | 120 | Run in Gitpod 121 | ------------- 122 | 123 | Thanks to https://drud.github.io/ddev-gitpod-launcher/, we are able to develop on cookieman with DDEV in the cloud. 124 | 125 | `This link `__ 126 | opens the cookieman development environment in Gitpod. 127 | 128 | 129 | Composer scripts 130 | ---------------- 131 | 132 | Have a look at the `composer.json`'s `script` section. This is the main entry point for commands needed 133 | during development. 134 | 135 | - :command:`ddev composer cookieman:...` enables an official cookieman theme. The "customtheme" shall resemble an integrator 136 | following our documentation. 137 | - :command:`ddev composer build` generates minified JS/CSS. 138 | - :command:`ddev composer test` runs all important tests. You do not strictly have to run tests before opening a 139 | pull request - they are also run post-commit on 140 | `Github actions `__. 141 | - :command:`ddev composer fix:cgl` tries to fix linting problems. 142 | -------------------------------------------------------------------------------- /Documentation/Introduction/Index.rst: -------------------------------------------------------------------------------- 1 | .. figure:: ../Images/header-cookieman-certified-extension-typo3.png 2 | 3 | .. include:: ../Includes.txt 4 | 5 | 6 | .. _introduction: 7 | 8 | ============ 9 | Introduction 10 | ============ 11 | 12 | 13 | What does it do? 14 | ================ 15 | 16 | It provides a user consent popup. It asks for approval to include tracking objects (cookies, images or any HTML) and includes the objects when consented. 17 | 18 | It allows tracking from the very first page (including referrer). 19 | 20 | Consents are managed in groups and saved to a cookie. 21 | 22 | It provides a stable API to work with in JavaScript. 23 | 24 | It removes HTML-cookies of tracking objects after the user has revoked consent. 25 | 26 | 27 | .. _when-is-it-shown: 28 | 29 | When is the popup shown to users? 30 | --------------------------------- 31 | 32 | By default, the popup is shown once on every page load until the user saves the consent status. 33 | 34 | The consent status is saved in the cookie `CookieConsent`. 35 | 36 | .. note:: 37 | The popup is not automatically shown on imprint and data privacy statement pages – this is to follow the GDPR's expectation that 38 | those pages shall be easily and directly accessible and should not interfere with a cookie consent banner. 39 | The page UIDs can be :ref:`set in TypoScript constants `. 40 | This also allows to link to these pages directly in the popup. 41 | 42 | 43 | .. _force-user-choice: 44 | 45 | Does the user have to make a choice? 46 | ------------------------------------ 47 | 48 | In our demo themes, we allow closing the popup without forcing the user to make a selection by clicking outside of the modal popup or using the ESC key. 49 | In that case no consent is saved, thus the popup is shown again upon opening another page. 50 | 51 | .. tip:: 52 | That is purely a function of the theme and can be changed by adapting the JavaScript that opens your modal. See :ref:`create-new-theme`. 53 | 54 | This behaviour is to follow our interpretation of the GDPR that a consent decision should not be forced. Bullet point 55 | 82 in `Guidelines 05/2020 of the European Data Protection Board 56 | `__ reads: 57 | 58 | When consent is to be given following a request by electronic means, the request for consent should 59 | not be unnecessarily disruptive to the use of the service for which the consent is provided (See Recital 32 GDPR). An active 60 | affirmative motion by which the data subject indicates consent can be necessary when a less infringing 61 | or disturbing modus would result in ambiguity. Thus, it may be necessary that a consent request 62 | interrupts the use experience to some extent to make that request effective. 63 | 64 | Since websites *can* continue to work without a consent, 65 | we think users should be given the possibility of just looking around without any consent. 66 | We don't see any ambiguity if no decission has been taken: The default is a continued service under 67 | the common rules "data minimisation + no third party involved". 68 | 69 | Of course, any functionality that requires consent has to be disabled in that case ("fallback gracefully" where possible). 70 | 71 | 72 | 73 | .. _features: 74 | 75 | Features 76 | -------- 77 | 78 | * Tracking objects: Render detailed information about your cookies, tracking pixels, LocalStorage entries...: Name, Purpose, Lifetime, Type, Provider 79 | * Tracking objects: Commonly used tracking objects are already supported with configuration and information text 80 | * Tracking objects: Extendable as needed 81 | * Tracking objects: HTML Cookies will be removed from the user's browser 82 | * Groups: **Group your tracking objects** (e.g. "Mandatory", "Marketing", "Analytics") 83 | * Groups: **Preselect and/or disable groups**, e.g. the group for mandatory technical cookies 84 | * A note about the **"Do-not-track"** setting can be shown inside the popup and this setting can also be respected (configurable on a per-group level) 85 | 86 | * The extension includes **3 ready-made themes** based on Bootstrap 87 | * **Customization:** Fluid templates and all texts can be adjusted to your needs 88 | 89 | 90 | .. _compatibility: 91 | 92 | Compatibility 93 | ------------- 94 | 95 | * Supports all modern browsers 96 | * Can be configured to work with a strict `Content Security Policy `__ 97 | (no inline scripts are needed) 98 | 99 | 100 | .. _demo: 101 | 102 | Demo 103 | ==== 104 | 105 | You can click around the included demo themes `here `__. 106 | Have a look at the JavaScript console to see when tracking gets enabled. 107 | 108 | You can also try out the `"Do-not-track" setting of your browser `__ 109 | which triggers a message inside the popup (in the "marketing" group) when enabled. 110 | 111 | 112 | .. _screenshots: 113 | 114 | Screenshots 115 | =========== 116 | 117 | (Click on the screenshots to open the full resolution.) 118 | 119 | .. figure:: ../Images/cookieman1.jpg 120 | :class: with-shadow 121 | :width: 400px 122 | 123 | Showcase of a site implementation 124 | 125 | .. figure:: ../Images/cookieman2.jpg 126 | :class: with-shadow 127 | :width: 400px 128 | 129 | Showcase of a site implementation 130 | 131 | .. figure:: ../Images/cookieman3.jpg 132 | :class: with-shadow 133 | :width: 400px 134 | 135 | Showcase of a site implementation 136 | -------------------------------------------------------------------------------- /Documentation/Settings.cfg: -------------------------------------------------------------------------------- 1 | # Sphinx setup file for this project 2 | # 3 | # This document lives here: 4 | # https://github.com/TYPO3-Documentation/TYPO3CMS-Guide-HowToDocument/blob/master/Documentation/Settings.cfg 5 | # See sample file: 6 | # https://github.com/TYPO3-Documentation/TYPO3CMS-Guide-HowToDocument/blob/master/Documentation/Settings.cfg 7 | # Documentation: 8 | # https://docs.typo3.org/typo3cms/HowToDocument/GeneralConventions/DirectoryFilenames.html#settings-cfg 9 | 10 | [general] 11 | 12 | # ................................................................................. 13 | # ... (required) title (displayed in left sidebar (desktop) or top panel (mobile) 14 | # ................................................................................. 15 | 16 | project = Cookieman 17 | 18 | # ................................................................................. 19 | # ... (recommended) version, displayed next to title (desktop) and in 10 | ) 11 | } 12 | # example: 13 | # inject ( 14 | # 23 | # ) 24 | show { 25 | # https://developers.google.com/analytics/devguides/collection/gtagjs/cookie-usage 26 | # many are missing. See https://business.safety.google/adscookies/ 27 | DSID { 28 | duration = 2 29 | durationUnit = weeks 30 | type = cookie_http+html 31 | provider = Google 32 | } 33 | 34 | test_cookie { 35 | duration = 15 36 | durationUnit = minutes 37 | type = cookie_http+html 38 | provider = Google 39 | } 40 | 41 | IDE { 42 | duration = 24 43 | durationUnit = months 44 | type = cookie_http+html 45 | provider = Google 46 | } 47 | 48 | FPLC { 49 | duration = 20 50 | durationUnit = hours 51 | type = cookie_http+html 52 | provider = Google 53 | } 54 | 55 | FPID { 56 | duration = 2 57 | durationUnit = years 58 | type = cookie_http+html 59 | provider = Google 60 | } 61 | 62 | GA_OPT_OUT { 63 | duration = 7 64 | durationUnit = years 65 | type = cookie_http+html 66 | provider = Google 67 | } 68 | 69 | __utma { 70 | duration = 2 71 | durationUnit = years 72 | type = cookie_http+html 73 | provider = Google 74 | } 75 | 76 | __utmb { 77 | duration = 30 78 | durationUnit = minutes 79 | type = cookie_http+html 80 | provider = Google 81 | } 82 | 83 | __utmc { 84 | duration = 85 | durationUnit = session 86 | type = cookie_http+html 87 | provider = Google 88 | } 89 | 90 | __utmt { 91 | duration = 10 92 | durationUnit = minutes 93 | type = cookie_http+html 94 | provider = Google 95 | } 96 | 97 | __utmz { 98 | duration = 6 99 | durationUnit = months 100 | type = cookie_http+html 101 | provider = Google 102 | } 103 | 104 | __utmv { 105 | duration = 2 106 | durationUnit = years 107 | type = cookie_http+html 108 | provider = Google 109 | } 110 | 111 | _ga { 112 | duration = 2 113 | durationUnit = years 114 | type = cookie_http+html 115 | provider = Google 116 | } 117 | 118 | _gat { 119 | duration = 1 120 | durationUnit = minute 121 | type = cookie_http+html 122 | provider = Google 123 | } 124 | 125 | _gat_--custom-name-- { 126 | duration = 1 127 | durationUnit = minute 128 | type = cookie_http+html 129 | provider = Google 130 | } 131 | 132 | _gid { 133 | duration = 24 134 | durationUnit = hours 135 | type = cookie_http+html 136 | provider = Google 137 | } 138 | 139 | _ga_--container-id-- { 140 | duration = 2 141 | durationUnit = years 142 | type = cookie_http+html 143 | provider = Google 144 | htmlCookieRemovalPattern = ^_ga_ 145 | } 146 | 147 | _dc_gtm_--property-id-- { 148 | duration = 1 149 | durationUnit = minute 150 | type = cookie_http+html 151 | provider = Google 152 | htmlCookieRemovalPattern = ^_dc_gtm_UA\-\d+\-\d+$ 153 | } 154 | 155 | _gaexp { 156 | duration = 93 157 | durationUnit = days 158 | type = cookie_http+html 159 | provider = Google 160 | } 161 | 162 | _gaexp_rc { 163 | duration = 10 164 | durationUnit = seconds 165 | type = cookie_http+html 166 | provider = Google 167 | } 168 | 169 | _opt_awcid { 170 | duration = 24 171 | durationUnit = hours 172 | type = cookie_http+html 173 | provider = Google 174 | } 175 | 176 | _opt_awmid { 177 | duration = 24 178 | durationUnit = hours 179 | type = cookie_http+html 180 | provider = Google 181 | } 182 | 183 | _opt_awgid { 184 | duration = 24 185 | durationUnit = hours 186 | type = cookie_http+html 187 | provider = Google 188 | } 189 | 190 | _opt_awkid { 191 | duration = 24 192 | durationUnit = hours 193 | type = cookie_http+html 194 | provider = Google 195 | } 196 | 197 | _opt_utmc { 198 | duration = 24 199 | durationUnit = hours 200 | type = cookie_http+html 201 | provider = Google 202 | } 203 | 204 | 205 | _gac_--property-id-- { 206 | duration = 90 207 | durationUnit = days 208 | type = cookie_http+html 209 | provider = Google 210 | htmlCookieRemovalPattern = ^_gac_ 211 | } 212 | 213 | AMP_TOKEN { 214 | duration = 1 215 | durationUnit = year 216 | type = cookie_http+html 217 | provider = Google 218 | } 219 | } 220 | } 221 | } 222 | -------------------------------------------------------------------------------- /Resources/Private/Themes/bootstrap4-modal/Templates/Popup.html: -------------------------------------------------------------------------------- 1 | 4 | 5 | 6 | 7 |
8 |
9 | 12 |
13 |

14 | {f:translate( 15 | key: 'introText', extensionName: 'cookieman', 16 | arguments: { 17 | 1: "{dataProtectionDeclarationLink -> f:spaceless()}", 18 | 2: "{imprintLink -> f:spaceless()}" 19 | }) -> f:format.raw()} 20 |

21 | 26 |
27 | 28 |
29 |
32 |
33 | 34 |
35 | 42 | 43 |
46 | 47 |
48 | 49 |
50 |
51 | 56 | 59 |
60 |
61 |

62 | {f:translate(key: 'group.{groupId}.desc', extensionName: 'cookieman')} 63 |

64 | 65 |
66 | 67 | 68 | 69 | 70 | 71 | 72 | 73 | 74 | 75 | 76 | 77 | 79 | 80 |
{f:translate(key: 'tableheader.name', extensionName: 'cookieman')}{f:translate(key: 'tableheader.purpose', extensionName: 'cookieman')}{f:translate(key: 'tableheader.duration', extensionName: 'cookieman')}{f:translate(key: 'tableheader.type', extensionName: 'cookieman')}{f:translate(key: 'tableheader.provider', extensionName: 'cookieman')}
81 |
82 | 83 |
84 |
85 | 86 |
87 |
88 |
89 |
90 | 91 |
92 |
93 | 99 | 105 | 111 |
112 |
113 |
114 |
115 | 116 | 117 | -------------------------------------------------------------------------------- /Resources/Private/Themes/bootstrap5-modal/Templates/Popup.html: -------------------------------------------------------------------------------- 1 | 4 | 5 | 6 | 7 |
8 |
9 |
10 | 13 |
14 |
15 |

16 | {f:translate( 17 | key: 'introText', extensionName: 'cookieman', 18 | arguments: { 19 | 1: "{dataProtectionDeclarationLink -> f:spaceless()}", 20 | 2: "{imprintLink -> f:spaceless()}" 21 | }) -> f:format.raw()} 22 |

23 | 28 | 29 |
30 | 31 |
32 |
35 |
36 | 37 |
38 |
39 | 44 |
45 |
48 |
49 | 50 |
51 | 52 | 53 |
54 |
55 | 60 | 63 |
64 |
65 | 66 |

67 | {f:translate(key: 'group.{groupId}.desc', extensionName: 'cookieman')} 68 |

69 | 70 | 71 |
72 | 73 | 74 | 75 | 76 | 77 | 78 | 79 | 80 | 81 | 82 | 83 | 85 | 86 |
{f:translate(key: 'tableheader.name', extensionName: 'cookieman')}{f:translate(key: 'tableheader.purpose', extensionName: 'cookieman')}{f:translate(key: 'tableheader.duration', extensionName: 'cookieman')}{f:translate(key: 'tableheader.type', extensionName: 'cookieman')}{f:translate(key: 'tableheader.provider', extensionName: 'cookieman')}
87 |
88 | 89 |
90 |
91 |
92 | 93 |
94 |
95 |
96 |
97 | 98 |
99 |
100 | 106 | 112 | 118 |
119 |
120 |
121 |
122 | 123 | 124 | -------------------------------------------------------------------------------- /Resources/Private/Themes/bootstrap3-modal/Templates/Popup.html: -------------------------------------------------------------------------------- 1 | 4 | 5 | 6 | 7 |
8 |
9 |
10 |
11 | {f:translate(key: 'heading', extensionName: 'cookieman')} 12 |
13 |
14 |
15 |

16 | {f:translate( 17 | key: 'introText', extensionName: 'cookieman', 18 | arguments: { 19 | 1: "{dataProtectionDeclarationLink -> f:spaceless()}", 20 | 2: "{imprintLink -> f:spaceless()}" 21 | }) -> f:format.raw()} 22 |

23 | 29 | 30 |
31 | 32 |
33 |
36 |
37 | 38 |
39 | 49 |
50 |
51 | 52 |
53 | 54 |
55 |
56 | 64 |
65 |
66 |

67 | {f:translate(key: 'group.{groupId}.desc', extensionName: 'cookieman')} 68 |

69 | 70 |
71 | 72 | 73 | 74 | 75 | 76 | 77 | 78 | 79 | 80 | 81 | 82 | 84 | 85 |
{f:translate(key: 'tableheader.name', extensionName: 'cookieman')}{f:translate(key: 'tableheader.purpose', extensionName: 'cookieman')}{f:translate(key: 'tableheader.duration', extensionName: 'cookieman')}{f:translate(key: 'tableheader.type', extensionName: 'cookieman')}{f:translate(key: 'tableheader.provider', extensionName: 'cookieman')}
86 |
87 | 88 |
89 |
90 |
91 | 92 |
93 |
94 |
95 |
96 | 97 |
98 |
99 | 105 | 111 | 117 |
118 |
119 |
120 |
121 | 122 | 123 | -------------------------------------------------------------------------------- /Resources/Private/Themes/bootstrap3-banner/Templates/Popup.html: -------------------------------------------------------------------------------- 1 | 4 | 5 | 6 | 7 |
8 |
9 |
10 |
11 | {f:translate(key: 'heading', extensionName: 'cookieman')} 12 |
13 |

14 | {f:translate( 15 | key: 'introText', extensionName: 'cookieman', 16 | arguments: { 17 | 1: "{dataProtectionDeclarationLink -> f:spaceless()}", 18 | 2: "{imprintLink -> f:spaceless()}" 19 | }) -> f:format.raw()} 20 |

21 |

22 | 23 | 24 | 27 | 28 | 29 | {f:translate( 30 | key: 'settingsText', extensionName: 'cookieman', 31 | arguments: {1: "{settingsLink -> f:spaceless()}" 32 | }) -> f:format.raw()} 33 |

34 | 35 | 36 |
37 | 38 |
39 |
42 |
44 | 45 |
46 | 56 |
57 |
58 |
59 |
60 | 67 |
68 |
69 | 70 |
71 | 72 | 73 |

74 | {f:translate(key: 'group.{groupId}.desc', extensionName: 'cookieman')} 75 |

76 | 77 | 78 |
79 | 80 | 81 | 82 | 83 | 84 | 85 | 86 | 87 | 88 | 89 | 90 | 92 | 93 |
{f:translate(key: 'tableheader.name', extensionName: 'cookieman')}{f:translate(key: 'tableheader.purpose', extensionName: 'cookieman')}{f:translate(key: 'tableheader.duration', extensionName: 'cookieman')}{f:translate(key: 'tableheader.type', extensionName: 'cookieman')}{f:translate(key: 'tableheader.provider', extensionName: 'cookieman')}
94 |
95 | 96 |
97 |
98 |
99 | 100 |
101 |
102 |
103 |
104 | 110 | 116 | 122 |
123 |
124 |
125 |
126 |
127 | 128 | 129 | -------------------------------------------------------------------------------- /Documentation/Configuration/Reference/TypoScriptSetup/Index.rst: -------------------------------------------------------------------------------- 1 | .. include:: ../../../Includes.txt 2 | 3 | .. toctree:: 4 | 5 | .. _typoscript-setup: 6 | 7 | ================ 8 | TypoScript setup 9 | ================ 10 | 11 | See a full TypoScript :ref:`configuration-example`. 12 | 13 | All configuration is prepended with `plugin.tx_cookieman.settings`. 14 | 15 | .. _groups: 16 | 17 | groups 18 | ^^^^^^ 19 | .. rst-class:: dl-parameters 20 | 21 | groups 22 | :sep:`|` :aspect:`Data type:` array 23 | :sep:`|` :aspect:`Default:` mandatory 24 | :sep:`|` 25 | 26 | Holds the group configurations. A group contains several tracking objects. 27 | 28 | By default, it only contains the 'mandatory' group, which includes the `CookieConsent` settings cookie. 29 | See a full TypoScript :ref:`configuration-example`. 30 | 31 | .. _groups.: 32 | 33 | groups. 34 | ^^^^^^^^^^^^^^^^^^ 35 | .. rst-class:: dl-parameters 36 | 37 | groups. 38 | :sep:`|` :aspect:`Data type:` array 39 | :sep:`|` :aspect:`Default:` mandatory 40 | :sep:`|` 41 | 42 | A single group. The group's key (name) should not contain spaces and non-ASCII characters. 43 | 44 | It will be saved in the settings cookie and can be checked with JavaScript: :js:`hasConsented('‹group-key›')` 45 | 46 | .. _groups.‹group-key›.preselected: 47 | 48 | groups.‹group-key›.preselected 49 | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 50 | .. rst-class:: dl-parameters 51 | 52 | groups..preselected 53 | :sep:`|` :aspect:`Data type:` :ref:`t3tsref:data-type-boolean` 54 | :sep:`|` :aspect:`Default:` 0 (not set) 55 | :sep:`|` 56 | 57 | If enabled (`1`), the group's consent checkbox will be already checked when the popup opens. 58 | 59 | The default group 'mandatory' has this set to `1`. 60 | 61 | .. _groups.‹group-key›.disabled: 62 | 63 | groups.‹group-key›.disabled 64 | ^^^^^^^^^^^^^^^^^^^^^^^^^^^ 65 | .. rst-class:: dl-parameters 66 | 67 | groups..disabled 68 | :sep:`|` :aspect:`Data type:` :ref:`t3tsref:data-type-boolean` 69 | :sep:`|` :aspect:`Default:` 0 (not set) 70 | :sep:`|` 71 | 72 | If enabled (`1`), the group's consent checkbox will be disabled (cannot be changed). 73 | 74 | The default group 'mandatory' has this set to `1`. 75 | 76 | .. _groups.‹group-key›.trackingObjects: 77 | 78 | groups.‹group-key›.trackingObjects 79 | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 80 | .. rst-class:: dl-parameters 81 | 82 | groups..trackingObjects 83 | :sep:`|` :aspect:`Data type:` array with numeric indices 84 | :sep:`|` 85 | 86 | Holds a list of tracking object keys (numbered). 87 | 88 | Example: 89 | 90 | .. code-block:: typoscript 91 | 92 | trackingObjects { 93 | 0 = CookieConsent 94 | 1 = fe_typo_user 95 | } 96 | 97 | .. _groups.‹group-key›.respectDnt: 98 | 99 | groups.‹group-key›.respectDnt 100 | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 101 | .. rst-class:: dl-parameters 102 | 103 | groups..respectDnt 104 | :sep:`|` :aspect:`Data type:` :ref:`t3tsref:data-type-boolean` 105 | :sep:`|` :aspect:`Default:` 0 (not set) 106 | :sep:`|` 107 | 108 | If set to `1`, this group respects to the `"Do-not-track" setting of your browser `__. 109 | 110 | .. _groups.‹group-key›.showDntMessage: 111 | 112 | groups.‹group-key›.showDntMessage 113 | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 114 | .. rst-class:: dl-parameters 115 | 116 | groups..showDntMessage 117 | :sep:`|` :aspect:`Data type:` :ref:`t3tsref:data-type-boolean` 118 | :sep:`|` :aspect:`Default:` 0 (not set) 119 | :sep:`|` 120 | 121 | If set to `1` **and** the `"Do-not-track" setting of your browser `__ is enabled, an additional message about that is shown inside the group. 122 | 123 | .. _trackingObjects: 124 | 125 | trackingObjects 126 | ^^^^^^^^^^^^^^^ 127 | .. rst-class:: dl-parameters 128 | 129 | trackingObjects 130 | :sep:`|` :aspect:`Data type:` array 131 | :sep:`|` 132 | 133 | This array holds the tracking object configurations. 134 | 135 | The Cookieman extension already provides several **preconfigured** tracking objects 136 | in the folder `./Configuration/TypoScript/TrackingObjects/ `__ 137 | (link to the Github repository). 138 | 139 | .. important:: 140 | If you add a preconfigured tracking object, you must at least **adapt** the `inject` code to your needs! 141 | 142 | The default group 'mandatory' only contains the tracking object `CookieConsent` settings cookie. 143 | 144 | .. _trackingObjects.‹tracking-object-key›: 145 | 146 | trackingObjects.‹tracking-object-key› 147 | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 148 | .. rst-class:: dl-parameters 149 | 150 | trackingObjects.‹tracking-object-key› 151 | :sep:`|` :aspect:`Data type:` array 152 | :sep:`|` :aspect:`Example:` fe_typo_user 153 | :sep:`|` 154 | 155 | A single tracking object configuration. 156 | 157 | Example: 158 | 159 | .. code-block:: typoscript 160 | 161 | plugin.tx_cookieman.settings.trackingObjects { 162 | // 'Matomo' is the ‹tracking-object-key›: 163 | Matomo { 164 | // injected code, if consent is given: 165 | inject = TEXT 166 | inject { 167 | insertData = 1 168 | value ( 169 | 170 | ) 171 | } 172 | 173 | show { 174 | // set cookies, if consent is given: 175 | _pk_id { 176 | duration = 13 177 | durationUnit = months 178 | type = cookie_http+html 179 | provider = Matomo 180 | } 181 | 182 | // etc. 183 | } 184 | } 185 | } 186 | 187 | .. _trackingObjects.‹tracking-object-key›.inject: 188 | 189 | trackingObjects.‹tracking-object-key›.inject 190 | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 191 | .. rst-class:: dl-parameters 192 | 193 | trackingObjects.‹tracking-object-key›.inject 194 | :sep:`|` :aspect:`Data type:` :ref:`data-type-html-code` / :ref:`cObject ` 195 | :sep:`|` :aspect:`Example:` 196 | :sep:`|` 197 | 198 | Each HTML tag in here will be appended to the page when the respective group is consented. 199 | This can be ` 64 | ) 65 | } 66 | } 67 | 68 | 69 | .. _add-preconfigured-trackingobject: 70 | 71 | Adding a preconfigured TrackingObject 72 | ------------------------------------- 73 | 74 | Cookieman already provides some preconfigured TrackingObjects. 75 | 76 | You can add selected TrackingObjects with two (or three) steps in TypoScript: 77 | 78 | 1. Import the provided definitions. 79 | 2. Add the key (name) of the TrackingObject. 80 | 81 | .. code-block:: typoscript 82 | 83 | # 1. Include provided definitions of TrackingObjects: 84 | @import 'EXT:cookieman/Configuration/TypoScript/TrackingObjects/*.typoscript' 85 | 86 | # 2. Add the TrackingObject key to a group: 87 | plugin.tx_cookieman.settings.groups { 88 | mandatory { 89 | trackingObjects { 90 | 10 = fe_typo_user 91 | } 92 | } 93 | } 94 | 95 | 3. If a TrackingObject needs to inject HTML code, you'll have to add this in a third step: 96 | 97 | .. code-block:: typoscript 98 | 99 | # 1. Include provided definitions of TrackingObjects: 100 | @import 'EXT:cookieman/Configuration/TypoScript/TrackingObjects/*.typoscript' 101 | 102 | # 2. Add the TrackingObject key to a group (see below how to configure a new group): 103 | plugin.tx_cookieman.settings.groups { 104 | analytics { 105 | trackingObjects { 106 | 10 = GoogleAnalytics 107 | } 108 | } 109 | } 110 | 111 | # 3. Add the tracking code to the TrackingObject: 112 | plugin.tx_cookieman.settings.trackingObjects { 113 | GoogleAnalytics { 114 | inject ( 115 | 124 | ) 125 | } 126 | } 127 | 128 | .. attention:: 129 | 130 | If your website sets the HTTP header `Content-Security-Policy`, you'll need to use 319 | 320 | ) 321 | } 322 | } 323 | } 324 | 325 | .. tip:: 326 | 327 | Read more about the Content Security Policy on the `Mozilla Developer Network `__. 328 | 329 | 330 | 331 | .. _extension-cookie-settings: 332 | 333 | Configuration of the cookie used by the extension itself 334 | -------------------------------------------------------- 335 | 336 | There are a few typoscript options to configure the cookie which is required by the exension. 337 | 338 | .. code-block:: typoscript 339 | 340 | plugin.tx_cookieman { 341 | settings { 342 | cookie { 343 | # cookie expire time in days (default: 365) 344 | cookieLifetimeDays = 345 | 346 | # domain without protocol like www.example.com, .example.com (default: Typo3 site name) 347 | domain = 348 | 349 | # sameSite Options: Lax, Strict or None (default: lax) 350 | sameSite = Lax 351 | } 352 | } 353 | } 354 | 355 | .. tip:: 356 | 357 | If you have multiple TYPO3 sites running on one instance with multiple subdomains you propably do not want to have multiple cookieman cookies. 358 | This would also mean that the cookieman banner is displayed on both domains and that every website user has to configure it for every subdomain again. 359 | To avoid this just set the domain setting to the domain with a starting dot. 360 | 361 | .. code-block:: typoscript 362 | 363 | plugin.tx_cookieman.settings.cookie.domain = .example.com 364 | 365 | 366 | 367 | 368 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 2, June 1991 3 | 4 | Copyright (C) 1989, 1991 Free Software Foundation, Inc., 5 | 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA 6 | Everyone is permitted to copy and distribute verbatim copies 7 | of this license document, but changing it is not allowed. 8 | 9 | Preamble 10 | 11 | The licenses for most software are designed to take away your 12 | freedom to share and change it. By contrast, the GNU General Public 13 | License is intended to guarantee your freedom to share and change free 14 | software--to make sure the software is free for all its users. This 15 | General Public License applies to most of the Free Software 16 | Foundation's software and to any other program whose authors commit to 17 | using it. (Some other Free Software Foundation software is covered by 18 | the GNU Lesser General Public License instead.) You can apply it to 19 | your programs, too. 20 | 21 | When we speak of free software, we are referring to freedom, not 22 | price. Our General Public Licenses are designed to make sure that you 23 | have the freedom to distribute copies of free software (and charge for 24 | this service if you wish), that you receive source code or can get it 25 | if you want it, that you can change the software or use pieces of it 26 | in new free programs; and that you know you can do these things. 27 | 28 | To protect your rights, we need to make restrictions that forbid 29 | anyone to deny you these rights or to ask you to surrender the rights. 30 | These restrictions translate to certain responsibilities for you if you 31 | distribute copies of the software, or if you modify it. 32 | 33 | For example, if you distribute copies of such a program, whether 34 | gratis or for a fee, you must give the recipients all the rights that 35 | you have. You must make sure that they, too, receive or can get the 36 | source code. And you must show them these terms so they know their 37 | rights. 38 | 39 | We protect your rights with two steps: (1) copyright the software, and 40 | (2) offer you this license which gives you legal permission to copy, 41 | distribute and/or modify the software. 42 | 43 | Also, for each author's protection and ours, we want to make certain 44 | that everyone understands that there is no warranty for this free 45 | software. If the software is modified by someone else and passed on, we 46 | want its recipients to know that what they have is not the original, so 47 | that any problems introduced by others will not reflect on the original 48 | authors' reputations. 49 | 50 | Finally, any free program is threatened constantly by software 51 | patents. We wish to avoid the danger that redistributors of a free 52 | program will individually obtain patent licenses, in effect making the 53 | program proprietary. To prevent this, we have made it clear that any 54 | patent must be licensed for everyone's free use or not licensed at all. 55 | 56 | The precise terms and conditions for copying, distribution and 57 | modification follow. 58 | 59 | GNU GENERAL PUBLIC LICENSE 60 | TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION 61 | 62 | 0. This License applies to any program or other work which contains 63 | a notice placed by the copyright holder saying it may be distributed 64 | under the terms of this General Public License. The "Program", below, 65 | refers to any such program or work, and a "work based on the Program" 66 | means either the Program or any derivative work under copyright law: 67 | that is to say, a work containing the Program or a portion of it, 68 | either verbatim or with modifications and/or translated into another 69 | language. (Hereinafter, translation is included without limitation in 70 | the term "modification".) Each licensee is addressed as "you". 71 | 72 | Activities other than copying, distribution and modification are not 73 | covered by this License; they are outside its scope. The act of 74 | running the Program is not restricted, and the output from the Program 75 | is covered only if its contents constitute a work based on the 76 | Program (independent of having been made by running the Program). 77 | Whether that is true depends on what the Program does. 78 | 79 | 1. You may copy and distribute verbatim copies of the Program's 80 | source code as you receive it, in any medium, provided that you 81 | conspicuously and appropriately publish on each copy an appropriate 82 | copyright notice and disclaimer of warranty; keep intact all the 83 | notices that refer to this License and to the absence of any warranty; 84 | and give any other recipients of the Program a copy of this License 85 | along with the Program. 86 | 87 | You may charge a fee for the physical act of transferring a copy, and 88 | you may at your option offer warranty protection in exchange for a fee. 89 | 90 | 2. You may modify your copy or copies of the Program or any portion 91 | of it, thus forming a work based on the Program, and copy and 92 | distribute such modifications or work under the terms of Section 1 93 | above, provided that you also meet all of these conditions: 94 | 95 | a) You must cause the modified files to carry prominent notices 96 | stating that you changed the files and the date of any change. 97 | 98 | b) You must cause any work that you distribute or publish, that in 99 | whole or in part contains or is derived from the Program or any 100 | part thereof, to be licensed as a whole at no charge to all third 101 | parties under the terms of this License. 102 | 103 | c) If the modified program normally reads commands interactively 104 | when run, you must cause it, when started running for such 105 | interactive use in the most ordinary way, to print or display an 106 | announcement including an appropriate copyright notice and a 107 | notice that there is no warranty (or else, saying that you provide 108 | a warranty) and that users may redistribute the program under 109 | these conditions, and telling the user how to view a copy of this 110 | License. (Exception: if the Program itself is interactive but 111 | does not normally print such an announcement, your work based on 112 | the Program is not required to print an announcement.) 113 | 114 | These requirements apply to the modified work as a whole. If 115 | identifiable sections of that work are not derived from the Program, 116 | and can be reasonably considered independent and separate works in 117 | themselves, then this License, and its terms, do not apply to those 118 | sections when you distribute them as separate works. But when you 119 | distribute the same sections as part of a whole which is a work based 120 | on the Program, the distribution of the whole must be on the terms of 121 | this License, whose permissions for other licensees extend to the 122 | entire whole, and thus to each and every part regardless of who wrote it. 123 | 124 | Thus, it is not the intent of this section to claim rights or contest 125 | your rights to work written entirely by you; rather, the intent is to 126 | exercise the right to control the distribution of derivative or 127 | collective works based on the Program. 128 | 129 | In addition, mere aggregation of another work not based on the Program 130 | with the Program (or with a work based on the Program) on a volume of 131 | a storage or distribution medium does not bring the other work under 132 | the scope of this License. 133 | 134 | 3. You may copy and distribute the Program (or a work based on it, 135 | under Section 2) in object code or executable form under the terms of 136 | Sections 1 and 2 above provided that you also do one of the following: 137 | 138 | a) Accompany it with the complete corresponding machine-readable 139 | source code, which must be distributed under the terms of Sections 140 | 1 and 2 above on a medium customarily used for software interchange; or, 141 | 142 | b) Accompany it with a written offer, valid for at least three 143 | years, to give any third party, for a charge no more than your 144 | cost of physically performing source distribution, a complete 145 | machine-readable copy of the corresponding source code, to be 146 | distributed under the terms of Sections 1 and 2 above on a medium 147 | customarily used for software interchange; or, 148 | 149 | c) Accompany it with the information you received as to the offer 150 | to distribute corresponding source code. (This alternative is 151 | allowed only for noncommercial distribution and only if you 152 | received the program in object code or executable form with such 153 | an offer, in accord with Subsection b above.) 154 | 155 | The source code for a work means the preferred form of the work for 156 | making modifications to it. For an executable work, complete source 157 | code means all the source code for all modules it contains, plus any 158 | associated interface definition files, plus the scripts used to 159 | control compilation and installation of the executable. However, as a 160 | special exception, the source code distributed need not include 161 | anything that is normally distributed (in either source or binary 162 | form) with the major components (compiler, kernel, and so on) of the 163 | operating system on which the executable runs, unless that component 164 | itself accompanies the executable. 165 | 166 | If distribution of executable or object code is made by offering 167 | access to copy from a designated place, then offering equivalent 168 | access to copy the source code from the same place counts as 169 | distribution of the source code, even though third parties are not 170 | compelled to copy the source along with the object code. 171 | 172 | 4. You may not copy, modify, sublicense, or distribute the Program 173 | except as expressly provided under this License. Any attempt 174 | otherwise to copy, modify, sublicense or distribute the Program is 175 | void, and will automatically terminate your rights under this License. 176 | However, parties who have received copies, or rights, from you under 177 | this License will not have their licenses terminated so long as such 178 | parties remain in full compliance. 179 | 180 | 5. You are not required to accept this License, since you have not 181 | signed it. However, nothing else grants you permission to modify or 182 | distribute the Program or its derivative works. These actions are 183 | prohibited by law if you do not accept this License. Therefore, by 184 | modifying or distributing the Program (or any work based on the 185 | Program), you indicate your acceptance of this License to do so, and 186 | all its terms and conditions for copying, distributing or modifying 187 | the Program or works based on it. 188 | 189 | 6. Each time you redistribute the Program (or any work based on the 190 | Program), the recipient automatically receives a license from the 191 | original licensor to copy, distribute or modify the Program subject to 192 | these terms and conditions. You may not impose any further 193 | restrictions on the recipients' exercise of the rights granted herein. 194 | You are not responsible for enforcing compliance by third parties to 195 | this License. 196 | 197 | 7. If, as a consequence of a court judgment or allegation of patent 198 | infringement or for any other reason (not limited to patent issues), 199 | conditions are imposed on you (whether by court order, agreement or 200 | otherwise) that contradict the conditions of this License, they do not 201 | excuse you from the conditions of this License. If you cannot 202 | distribute so as to satisfy simultaneously your obligations under this 203 | License and any other pertinent obligations, then as a consequence you 204 | may not distribute the Program at all. For example, if a patent 205 | license would not permit royalty-free redistribution of the Program by 206 | all those who receive copies directly or indirectly through you, then 207 | the only way you could satisfy both it and this License would be to 208 | refrain entirely from distribution of the Program. 209 | 210 | If any portion of this section is held invalid or unenforceable under 211 | any particular circumstance, the balance of the section is intended to 212 | apply and the section as a whole is intended to apply in other 213 | circumstances. 214 | 215 | It is not the purpose of this section to induce you to infringe any 216 | patents or other property right claims or to contest validity of any 217 | such claims; this section has the sole purpose of protecting the 218 | integrity of the free software distribution system, which is 219 | implemented by public license practices. Many people have made 220 | generous contributions to the wide range of software distributed 221 | through that system in reliance on consistent application of that 222 | system; it is up to the author/donor to decide if he or she is willing 223 | to distribute software through any other system and a licensee cannot 224 | impose that choice. 225 | 226 | This section is intended to make thoroughly clear what is believed to 227 | be a consequence of the rest of this License. 228 | 229 | 8. If the distribution and/or use of the Program is restricted in 230 | certain countries either by patents or by copyrighted interfaces, the 231 | original copyright holder who places the Program under this License 232 | may add an explicit geographical distribution limitation excluding 233 | those countries, so that distribution is permitted only in or among 234 | countries not thus excluded. In such case, this License incorporates 235 | the limitation as if written in the body of this License. 236 | 237 | 9. The Free Software Foundation may publish revised and/or new versions 238 | of the General Public License from time to time. Such new versions will 239 | be similar in spirit to the present version, but may differ in detail to 240 | address new problems or concerns. 241 | 242 | Each version is given a distinguishing version number. If the Program 243 | specifies a version number of this License which applies to it and "any 244 | later version", you have the option of following the terms and conditions 245 | either of that version or of any later version published by the Free 246 | Software Foundation. If the Program does not specify a version number of 247 | this License, you may choose any version ever published by the Free Software 248 | Foundation. 249 | 250 | 10. If you wish to incorporate parts of the Program into other free 251 | programs whose distribution conditions are different, write to the author 252 | to ask for permission. For software which is copyrighted by the Free 253 | Software Foundation, write to the Free Software Foundation; we sometimes 254 | make exceptions for this. Our decision will be guided by the two goals 255 | of preserving the free status of all derivatives of our free software and 256 | of promoting the sharing and reuse of software generally. 257 | 258 | NO WARRANTY 259 | 260 | 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY 261 | FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN 262 | OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES 263 | PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED 264 | OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF 265 | MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS 266 | TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE 267 | PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, 268 | REPAIR OR CORRECTION. 269 | 270 | 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 271 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR 272 | REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, 273 | INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING 274 | OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED 275 | TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY 276 | YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER 277 | PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE 278 | POSSIBILITY OF SUCH DAMAGES. 279 | 280 | END OF TERMS AND CONDITIONS 281 | 282 | How to Apply These Terms to Your New Programs 283 | 284 | If you develop a new program, and you want it to be of the greatest 285 | possible use to the public, the best way to achieve this is to make it 286 | free software which everyone can redistribute and change under these terms. 287 | 288 | To do so, attach the following notices to the program. It is safest 289 | to attach them to the start of each source file to most effectively 290 | convey the exclusion of warranty; and each file should have at least 291 | the "copyright" line and a pointer to where the full notice is found. 292 | 293 | 294 | Copyright (C) 295 | 296 | This program is free software; you can redistribute it and/or modify 297 | it under the terms of the GNU General Public License as published by 298 | the Free Software Foundation; either version 2 of the License, or 299 | (at your option) any later version. 300 | 301 | This program is distributed in the hope that it will be useful, 302 | but WITHOUT ANY WARRANTY; without even the implied warranty of 303 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 304 | GNU General Public License for more details. 305 | 306 | You should have received a copy of the GNU General Public License along 307 | with this program; if not, write to the Free Software Foundation, Inc., 308 | 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. 309 | 310 | Also add information on how to contact you by electronic and paper mail. 311 | 312 | If the program is interactive, make it output a short notice like this 313 | when it starts in an interactive mode: 314 | 315 | Gnomovision version 69, Copyright (C) year name of author 316 | Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 317 | This is free software, and you are welcome to redistribute it 318 | under certain conditions; type `show c' for details. 319 | 320 | The hypothetical commands `show w' and `show c' should show the appropriate 321 | parts of the General Public License. Of course, the commands you use may 322 | be called something other than `show w' and `show c'; they could even be 323 | mouse-clicks or menu items--whatever suits your program. 324 | 325 | You should also get your employer (if you work as a programmer) or your 326 | school, if any, to sign a "copyright disclaimer" for the program, if 327 | necessary. Here is a sample; alter the names: 328 | 329 | Yoyodyne, Inc., hereby disclaims all copyright interest in the program 330 | `Gnomovision' (which makes passes at compilers) written by James Hacker. 331 | 332 | , 1 April 1989 333 | Ty Coon, President of Vice 334 | 335 | This General Public License does not permit incorporating your program into 336 | proprietary programs. If your program is a subroutine library, you may 337 | consider it more useful to permit linking proprietary applications with the 338 | library. If this is what you want to do, use the GNU Lesser General 339 | Public License instead of this License. 340 | --------------------------------------------------------------------------------