diff --git a/API.php b/API.php index f32dcb4..eb03588 100644 --- a/API.php +++ b/API.php @@ -6,10 +6,10 @@ * @license http://www.gnu.org/licenses/gpl-3.0.html GPL v3 or later * * @category Piwik_Plugins - * @package CustomOptOut + * @package MatomoCustomOptOut */ -namespace Piwik\Plugins\CustomOptOut; +namespace Piwik\Plugins\MatomoCustomOptOut; use Piwik\Common; use Piwik\Db; diff --git a/CHANGELOG.md b/CHANGELOG.md index 1e038a0..3647619 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,9 @@ ## Changelog +### CustomOptOut 3.0.0 +* Matomo 5 compatibility +* Add deprecation notice + ### CustomOptOut 2.0.4 * Update translation diff --git a/Controller.php b/Controller.php index a7e2eff..186c2cb 100644 --- a/Controller.php +++ b/Controller.php @@ -9,7 +9,7 @@ * @package CustomOptOut */ -namespace Piwik\Plugins\CustomOptOut; +namespace Piwik\Plugins\MatomoCustomOptOut; use Piwik\Common; use Piwik\Piwik; @@ -22,7 +22,7 @@ /** * - * @package CustomOptOut + * @package MatomoCustomOptOut */ class Controller extends ControllerAdmin { @@ -73,14 +73,14 @@ public function index() } // Redirect to, clear POST vars - $this->redirectToIndex('CustomOptOut', 'index'); + $this->redirectToIndex('MatomoCustomOptOut', 'index'); return; } } - $view = new View('@CustomOptOut/index.twig'); + $view = new View('@MatomoCustomOptOut/index.twig'); Site::clearCache(); if (Piwik::hasUserSuperUserAccess()) { diff --git a/Menu.php b/Menu.php index 1066fa8..009a7e6 100644 --- a/Menu.php +++ b/Menu.php @@ -6,7 +6,7 @@ * @license http://www.gnu.org/licenses/gpl-3.0.html GPL v3 or later * */ -namespace Piwik\Plugins\CustomOptOut; +namespace Piwik\Plugins\MatomoCustomOptOut; use Piwik\Menu\MenuAdmin; use Piwik\Piwik; @@ -17,6 +17,7 @@ * To configure a menu (such as Admin Menu, Reporting Menu, User Menu...) simply call the corresponding methods as * described in the API-Reference http://developer.piwik.org/api-reference/Piwik/Menu/MenuAbstract */ + class Menu extends \Piwik\Plugin\Menu { public function configureAdminMenu(MenuAdmin $menu) @@ -30,3 +31,4 @@ public function configureAdminMenu(MenuAdmin $menu) } } } + diff --git a/CustomOptOut.php b/PiwikCustomOptOut.php similarity index 72% rename from CustomOptOut.php rename to PiwikCustomOptOut.php index ca6817a..143f7e0 100644 --- a/CustomOptOut.php +++ b/PiwikCustomOptOut.php @@ -9,17 +9,17 @@ * @package CustomOptOut */ -namespace Piwik\Plugins\CustomOptOut; +namespace Piwik\Plugins\MatomoCustomOptOut; use Piwik\Common; use Piwik\Container\StaticContainer; use Piwik\Db; -use Piwik\Plugins\CustomOptOut\SystemSettings as Settings; +use Piwik\Plugins\MatomoCustomOptOut\SystemSettings as Settings; /** - * @package CustomOptOut + * @package MatomoCustomOptOut */ -class CustomOptOut extends \Piwik\Plugin +class MatomoCustomOptOut extends \Piwik\Plugin { /** @@ -31,7 +31,7 @@ public function getListHooksRegistered() 'AssetManager.getJavaScriptFiles' => 'getJsFiles', 'AssetManager.getStylesheetFiles' => 'getStylesheetFiles', 'Controller.CoreAdminHome.optOut' => 'addOptOutStyles', - 'Settings.CustomOptOut.settingsUpdated' => 'onSettingsUpdate', + 'Settings.MatomoCustomOptOut.settingsUpdated' => 'onSettingsUpdate', 'SystemSettings.updated' => 'onSystemSettingsUpdate', ); } @@ -51,24 +51,24 @@ public function getJsFiles(&$jsFiles) { // CodeMirror - $jsFiles[] = "plugins/CustomOptOut/javascripts/codemirror/codemirror.js"; - $jsFiles[] = "plugins/CustomOptOut/javascripts/codemirror/mode/css/css.js"; - $jsFiles[] = "plugins/CustomOptOut/javascripts/codemirror/mode/javascript/javascript.js"; - $jsFiles[] = "plugins/CustomOptOut/javascripts/codemirror/addon/hint/show-hint.js"; - $jsFiles[] = "plugins/CustomOptOut/javascripts/codemirror/addon/hint/css-hint.js"; - $jsFiles[] = "plugins/CustomOptOut/javascripts/codemirror/addon/hint/javascript-hint.js"; - $jsFiles[] = "plugins/CustomOptOut/javascripts/codemirror/addon/lint/lint.js"; - $jsFiles[] = "plugins/CustomOptOut/javascripts/codemirror/addon/lint/css-lint.js"; - $jsFiles[] = "plugins/CustomOptOut/javascripts/codemirror/addon/lint/javascript-lint.js"; + $jsFiles[] = "plugins/MatomoCustomOptOut/javascripts/codemirror/codemirror.js"; + $jsFiles[] = "plugins/MatomoCustomOptOut/javascripts/codemirror/mode/css/css.js"; + $jsFiles[] = "plugins/MatomoCustomOptOut/javascripts/codemirror/mode/javascript/javascript.js"; + $jsFiles[] = "plugins/MatomoCustomOptOut/javascripts/codemirror/addon/hint/show-hint.js"; + $jsFiles[] = "plugins/MatomoCustomOptOut/javascripts/codemirror/addon/hint/css-hint.js"; + $jsFiles[] = "plugins/MatomoCustomOptOut/javascripts/codemirror/addon/hint/javascript-hint.js"; + $jsFiles[] = "plugins/MatomoCustomOptOut/javascripts/codemirror/addon/lint/lint.js"; + $jsFiles[] = "plugins/MatomoCustomOptOut/javascripts/codemirror/addon/lint/css-lint.js"; + $jsFiles[] = "plugins/MatomoCustomOptOut/javascripts/codemirror/addon/lint/javascript-lint.js"; // CSS Lint for CodeMirror - $jsFiles[] = "plugins/CustomOptOut/javascripts/csslint/csslint.js"; + $jsFiles[] = "plugins/MatomoCustomOptOut/javascripts/csslint/csslint.js"; // CSS Lint for CodeMirror - $jsFiles[] = "plugins/CustomOptOut/javascripts/jshint/jshint.js"; + $jsFiles[] = "plugins/MatomoCustomOptOut/javascripts/jshint/jshint.js"; // Plugin - $jsFiles[] = "plugins/CustomOptOut/javascripts/plugin.js"; + $jsFiles[] = "plugins/MatomoCustomOptOut/javascripts/plugin.js"; } @@ -79,10 +79,10 @@ public function getStylesheetFiles(&$stylesheets) { // CodeMirror CSS - $stylesheets[] = "plugins/CustomOptOut/stylesheets/codemirror/codemirror.css"; - $stylesheets[] = "plugins/CustomOptOut/stylesheets/codemirror/theme/blackboard.css"; - $stylesheets[] = "plugins/CustomOptOut/stylesheets/codemirror/lint.css"; - $stylesheets[] = "plugins/CustomOptOut/stylesheets/codemirror/show-hint.css"; + $stylesheets[] = "plugins/MatomoCustomOptOut/stylesheets/codemirror/codemirror.css"; + $stylesheets[] = "plugins/MatomoCustomOptOut/stylesheets/codemirror/theme/blackboard.css"; + $stylesheets[] = "plugins/MatomoCustomOptOut/stylesheets/codemirror/lint.css"; + $stylesheets[] = "plugins/MatomoCustomOptOut/stylesheets/codemirror/show-hint.css"; } @@ -93,7 +93,7 @@ public function onSettingsUpdate(Settings $settings) } public function onSystemSettingsUpdate(\Piwik\Settings\Plugin\SystemSettings $settings) { - if ($settings->getPluginName() == 'CustomOptOut') { + if ($settings->getPluginName() == 'MatomoCustomOptOut') { $this->install(); } } @@ -167,6 +167,14 @@ public function addOptOutStyles() } } + public function activate() { + $this->install(); + } + + public function deactivate() { + $this->uninstall(); + } + /** * Plugin install hook * diff --git a/README.md b/README.md index 92c3c8d..6ed784e 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,8 @@ -# Custom Opt-Out Styles Piwik Plugin +# Custom Opt-Out Styles Piwik / Matomo Plugin + +## Deprecation +You no longer need this plugin to change the CSS Styles in your opt-out. All features this plugin provides can +be found in the Matomo core features. This plugin will be keep available to not break any websites using this plugin. ## Description @@ -31,7 +35,7 @@ or insert a URL to the file containing your custom CSS into the input field call ## Requirements -+ Matomo >=4.0.0-b1 ++ Matomo >=5.0.0-b1 ## Authors diff --git a/SystemSettings.php b/SystemSettings.php index ff4c3d0..a242c1d 100644 --- a/SystemSettings.php +++ b/SystemSettings.php @@ -6,7 +6,7 @@ * @license http://www.gnu.org/licenses/gpl-3.0.html GPL v3 or later * */ -namespace Piwik\Plugins\CustomOptOut; +namespace Piwik\Plugins\MatomoCustomOptOut; use Piwik\Piwik; use Piwik\Settings\FieldConfig; diff --git a/lang/az.json b/lang/az.json new file mode 100644 index 0000000..0967ef4 --- /dev/null +++ b/lang/az.json @@ -0,0 +1 @@ +{} diff --git a/lang/bn.json b/lang/bn.json new file mode 100644 index 0000000..0967ef4 --- /dev/null +++ b/lang/bn.json @@ -0,0 +1 @@ +{} diff --git a/lang/cs.json b/lang/cs.json index 1d91180..8a55561 100644 --- a/lang/cs.json +++ b/lang/cs.json @@ -1,14 +1,14 @@ { "CustomOptOut": { - "DefaultCssFile": "Výchozí soubor šablony", - "DefaultCssFileDescription": "Tento css soubor bude použit, pokud nebude vybrána žádná stránka.", - "DefaultCssStyles": "Výchozí šablona", - "DefaultCssStylesDescription": "Tento css styl bude použit, pokud nebude vybrána žádná stránka.", + "DefaultCssFile": "Výchozí soubor stylesheet", + "DefaultCssFileDescription": "Tento soubor CSS se použije, pokud není vybrána žádná stránka.", + "DefaultCssStyles": "Výchozí soubory stylů", + "DefaultCssStylesDescription": "Tyto styly CSS se použijí, pokud není vybrána žádná stránka.", "EditorThemeDescription": "Vyberte motiv editoru.", "EditorThemeOptionName": "Motiv editoru", - "EnableJavascriptInjection": "Povolit javascriptová pole", - "EnableJavascriptInjectionDescription": "Povolte tuto možnost pro zobrazení polí k zadání javascriptu.", - "ShowEditorDescription": "Povolte tuto možnost pro zobrazení vlastního css kódu v jednoduchém css editoru.", - "ShowEditorOptionName": "Povolit editor css" + "EnableJavascriptInjection": "Povolit pole JavaScript", + "EnableJavascriptInjectionDescription": "Zapnutím této možnosti zobrazíte pole pro zadání JavaScriptu.", + "ShowEditorDescription": "Zapnutím této možnosti zobrazíte \"vlastní kód CSS\" v jednoduchém editoru CSS.", + "ShowEditorOptionName": "Povolit editor CSS" } } diff --git a/lang/dv.json b/lang/dv.json new file mode 100644 index 0000000..0967ef4 --- /dev/null +++ b/lang/dv.json @@ -0,0 +1 @@ +{} diff --git a/lang/eo.json b/lang/eo.json new file mode 100644 index 0000000..0967ef4 --- /dev/null +++ b/lang/eo.json @@ -0,0 +1 @@ +{} diff --git a/lang/eu.json b/lang/eu.json index c4512b5..3f20caa 100644 --- a/lang/eu.json +++ b/lang/eu.json @@ -1,6 +1,14 @@ { "CustomOptOut": { + "DefaultCssFile": "Estilo-orrien fitxategi lehenetsia", + "DefaultCssFileDescription": "CSS fitxategi hau erabiliko da orririk ez bada hautatu.", + "DefaultCssStyles": "Estilo-orri lehenetsiak", + "DefaultCssStylesDescription": "CSS estilo hauek erabiliko dira orririk ez bada hautatu.", + "EditorThemeDescription": "Aukeratu editorearen gaia.", "EditorThemeOptionName": "Editore itxura", + "EnableJavascriptInjection": "Gaitu JavaScript eremuak", + "EnableJavascriptInjectionDescription": "Aktibatu aukera hau JavaScript kodea sartzeko eremuak erakusteko.", + "ShowEditorDescription": "Aktibatu aukera hau \"CSS pertsonalizatuaren\" kodea CSS editore sinple batean erakusteko.", "ShowEditorOptionName": "Gaitu CSS editorea" } } diff --git a/lang/ga.json b/lang/ga.json index 0967ef4..71a34f1 100644 --- a/lang/ga.json +++ b/lang/ga.json @@ -1 +1,14 @@ -{} +{ + "CustomOptOut": { + "DefaultCssFile": "Comhad stílbhileog réamhshocraithe", + "DefaultCssFileDescription": "Úsáidfear an comhad CSS seo mura roghnaítear leathanach.", + "DefaultCssStyles": "Stílbhileoga réamhshocraithe", + "DefaultCssStylesDescription": "Úsáidfear na stíleanna CSS seo mura roghnaítear aon leathanach.", + "EditorThemeDescription": "Roghnaigh téama don eagarthóir.", + "EditorThemeOptionName": "Téama Eagarthóir", + "EnableJavascriptInjection": "Cumasaigh réimsí JavaScript", + "EnableJavascriptInjectionDescription": "Cuir an rogha seo ar siúl chun réimsí a thaispeáint inar féidir JavaScript a chur isteach.", + "ShowEditorDescription": "Cuir an rogha seo ar siúl chun an cód \"CSS saincheaptha\" a thaispeáint in eagarthóir CSS simplí.", + "ShowEditorOptionName": "Cumasaigh eagarthóir CSS" + } +} diff --git a/lang/gu.json b/lang/gu.json new file mode 100644 index 0000000..3cee40f --- /dev/null +++ b/lang/gu.json @@ -0,0 +1,14 @@ +{ + "CustomOptOut": { + "DefaultCssFile": "ડિફૉલ્ટ સ્ટાઇલશીટ ફાઇલ", + "DefaultCssFileDescription": "જો કોઈ પેજ પસંદ કરવામાં ન આવે તો આ CSS ફાઇલનો ઉપયોગ કરવામાં આવશે.", + "DefaultCssStyles": "ડિફૉલ્ટ સ્ટાઇલશીટ્સ", + "DefaultCssStylesDescription": "જો કોઈ પેજ પસંદ કરવામાં ન આવે તો આ CSS શૈલીઓનો ઉપયોગ કરવામાં આવશે.", + "EditorThemeDescription": "એડિટર માટે એક થીમ પસંદ કરો.", + "EditorThemeOptionName": "એડિટર થીમ", + "EnableJavascriptInjection": "JavaScript ફીલ્ડ્સ સક્ષમ કરો", + "EnableJavascriptInjectionDescription": "JavaScript દાખલ કરવા માટે ફીલ્ડ્સ બતાવવા માટે આ વિકલ્પ ચાલુ કરો.", + "ShowEditorDescription": "સરળ CSS એડિટરમાં \"કસ્ટમ CSS\" કોડ બતાવવા માટે આ વિકલ્પ ચાલુ કરો.", + "ShowEditorOptionName": "CSS એડિટર સક્ષમ કરો" + } +} diff --git a/lang/hr.json b/lang/hr.json index 0967ef4..f7ae9ee 100644 --- a/lang/hr.json +++ b/lang/hr.json @@ -1 +1,14 @@ -{} +{ + "CustomOptOut": { + "DefaultCssFile": "Zadana datoteka popisa stilova", + "DefaultCssFileDescription": "Ova CSS datoteka će se koristiti ako nijedna stranica nije odabrana.", + "DefaultCssStyles": "Zadani popis stilova", + "DefaultCssStylesDescription": "Ovi CSS stilovi će se koristiti ako nijedna stranica nije odabrana.", + "EditorThemeDescription": "Odaberi temu za uređivač.", + "EditorThemeOptionName": "Tema uređivača", + "EnableJavascriptInjection": "Aktiviraj JavaScript polja", + "EnableJavascriptInjectionDescription": "Uključi ovu opciju za prikaz polja za unos JavaScripta.", + "ShowEditorDescription": "Uključite ovu opciju za prikazivanje koda „prilagođenog CSS-a” u jednostavnom CSS uređivaču.", + "ShowEditorOptionName": "Aktiviraj CSS uređivač" + } +} diff --git a/lang/hy.json b/lang/hy.json new file mode 100644 index 0000000..0967ef4 --- /dev/null +++ b/lang/hy.json @@ -0,0 +1 @@ +{} diff --git a/lang/ku.json b/lang/ku.json new file mode 100644 index 0000000..0967ef4 --- /dev/null +++ b/lang/ku.json @@ -0,0 +1 @@ +{} diff --git a/lang/lb.json b/lang/lb.json new file mode 100644 index 0000000..0967ef4 --- /dev/null +++ b/lang/lb.json @@ -0,0 +1 @@ +{} diff --git a/lang/ms.json b/lang/ms.json new file mode 100644 index 0000000..0967ef4 --- /dev/null +++ b/lang/ms.json @@ -0,0 +1 @@ +{} diff --git a/lang/ru.json b/lang/ru.json index 6b81baa..8f77f44 100644 --- a/lang/ru.json +++ b/lang/ru.json @@ -1,14 +1,14 @@ { "CustomOptOut": { - "ShowEditorOptionName": "Включить редактор css", - "ShowEditorDescription": "Включить эту опцию, чтобы показывать «пользовательский css» код в простом редакторе css.", - "EditorThemeOptionName": "Тема редактора", - "EditorThemeDescription": "Выбрать тему для редактора.", - "DefaultCssStyles": "Таблица стилей по умолчанию", - "DefaultCssStylesDescription": "Эти стили будут использованы, если страница не выбрана.", "DefaultCssFile": "Файл с таблицей стиля по умолчанию", "DefaultCssFileDescription": "Этот файл css будет использован, если страница не выбрана.", + "DefaultCssStyles": "Таблица стилей по умолчанию", + "DefaultCssStylesDescription": "Эти стили будут использованы, если страница не выбрана.", + "EditorThemeDescription": "Выбрать тему для редактора.", + "EditorThemeOptionName": "Тема редактора", + "EnableJavascriptInjection": "Включить поля Javascript", "EnableJavascriptInjectionDescription": "Включите эту опцию, чтобы показать поля для ввода JavaScript.", - "EnableJavascriptInjection": "Включить поля Javascript" + "ShowEditorDescription": "Включить эту опцию, чтобы показывать «пользовательский css» код в простом редакторе css.", + "ShowEditorOptionName": "Включить редактор css" } -} \ No newline at end of file +} diff --git a/lang/si.json b/lang/si.json new file mode 100644 index 0000000..0967ef4 --- /dev/null +++ b/lang/si.json @@ -0,0 +1 @@ +{} diff --git a/lang/ta.json b/lang/ta.json index 0967ef4..aa35df9 100644 --- a/lang/ta.json +++ b/lang/ta.json @@ -1 +1,14 @@ -{} +{ + "CustomOptOut": { + "DefaultCssFile": "இயல்புநிலை நடைதாள் கோப்பு", + "DefaultCssFileDescription": "எந்தப் பக்கமும் தேர்ந்தெடுக்கப்படாவிட்டால் இந்த சிஎச்எச் கோப்பு பயன்படுத்தப்படும்.", + "DefaultCssStyles": "இயல்புநிலை நடைதாள்", + "DefaultCssStylesDescription": "எந்தப் பக்கமும் தேர்ந்தெடுக்கப்படாவிட்டால் இந்த சிஎச்எச் பாணிகள் பயன்படுத்தப்படும்.", + "EditorThemeDescription": "எடிட்டருக்கு ஒரு கருப்பொருளைத் தேர்வுசெய்க.", + "EditorThemeOptionName": "ஆசிரியர் கருப்பொருள்", + "EnableJavascriptInjection": "சாவாச்கிரிப்ட் புலங்களை இயக்கவும்", + "EnableJavascriptInjectionDescription": "சாவாச்கிரிப்ட் உள்ளே நுழைய புலங்களைக் காட்ட இந்த விருப்பத்தை இயக்கவும்.", + "ShowEditorDescription": "எளிய சிஎச்எச் எடிட்டரில் \"தனிப்பயன் CSS\" குறியீட்டைக் காட்ட இந்த விருப்பத்தை இயக்கவும்.", + "ShowEditorOptionName": "சிஎச்எச் எடிட்டரை இயக்கவும்" + } +} diff --git a/lang/tzm.json b/lang/tzm.json new file mode 100644 index 0000000..0967ef4 --- /dev/null +++ b/lang/tzm.json @@ -0,0 +1 @@ +{} diff --git a/lang/zh-cn.json b/lang/zh-cn.json index 472d06f..b4ba617 100644 --- a/lang/zh-cn.json +++ b/lang/zh-cn.json @@ -6,7 +6,7 @@ "EditorThemeOptionName": "编辑主题", "EnableJavascriptInjection": "启用Javascript字段", "EnableJavascriptInjectionDescription": "启用此选项可显示要输入javascript的字段。", - "ShowEditorDescription": "启用此选项可在简单的CSS编辑器中显示“自定义CSS”代码。", + "ShowEditorDescription": "启用此选项可在简易CSS编辑器中显示“自定义CSS”代码。", "ShowEditorOptionName": "启用 CSS 编辑器" } } diff --git a/plugin.json b/plugin.json index 0f752a2..29c560a 100644 --- a/plugin.json +++ b/plugin.json @@ -1,6 +1,6 @@ { - "name": "CustomOptOut", - "version": "2.0.4", + "name": "MatomoCustomOptOut", + "version": "3.0.3", "description": "Create your own opt-out iframe css styles", "keywords": [ "Opt-Out", @@ -10,7 +10,7 @@ "license": "GPL-3.0+", "homepage": "https:\/\/www.zwei-entwickler.de", "require": { - "matomo": ">=4.0.0-b1,<5.0.0-b1", + "matomo": ">=5.0.0-b1,<6.0.0-b1", "php": ">=7.2.5" }, "donate": { diff --git a/templates/index.twig b/templates/index.twig index 3677c1d..5b41fa2 100644 --- a/templates/index.twig +++ b/templates/index.twig @@ -35,10 +35,10 @@ {%- endfor -%} - + - + {% if enableJs %} @@ -52,10 +52,10 @@   - + - + {% endif %}