Upgrade Piwik Twig Extension to Matomo

2024-05-12 06:12:38 +00:00 · 2020-04-28 09:02:39 +02:00 · 2020-04-28 09:02:39 +02:00 · 9717d01298
parent 976b4bbb11
commit 9717d01298
22 changed files with 106 additions and 77 deletions
--- a/app/DoctrineMigrations/Version20200428072628.php
+++ b/app/DoctrineMigrations/Version20200428072628.php
@ -0,0 +1,28 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Application\Migrations;
+
+use Doctrine\DBAL\Schema\Schema;
+use Wallabag\CoreBundle\Doctrine\WallabagMigration;
+
+/**
+ * Renamed Piwik to Matomo in configuration.
+ */
+final class Version20200428072628 extends WallabagMigration
+{
+    public function up(Schema $schema): void
+    {
+        $this->addSql('UPDATE ' . $this->getTable('internal_setting', true) . " SET name = 'matomo_enabled' where name = 'piwik_enabled';");
+        $this->addSql('UPDATE ' . $this->getTable('internal_setting', true) . " SET name = 'matomo_host' where name = 'piwik_host';");
+        $this->addSql('UPDATE ' . $this->getTable('internal_setting', true) . " SET name = 'matomo_site_id' where name = 'piwik_site_id';");
+    }
+
+    public function down(Schema $schema): void
+    {
+        $this->addSql('UPDATE ' . $this->getTable('internal_setting', true) . " SET name = 'piwik_enabled' where name = 'matomo_enabled';");
+        $this->addSql('UPDATE ' . $this->getTable('internal_setting', true) . " SET name = 'piwik_host' where name = 'matomo_host';");
+        $this->addSql('UPDATE ' . $this->getTable('internal_setting', true) . " SET name = 'piwik_site_id' where name = 'matomo_site_id';");
+    }
+}
--- a/app/Resources/CraueConfigBundle/translations/CraueConfigBundle.da.yml
+++ b/app/Resources/CraueConfigBundle/translations/CraueConfigBundle.da.yml
@ -27,9 +27,9 @@ export: "eksport"
 import: "import"
 misc: "misc"
 modify_settings: "Gem ændring"
-piwik_host: Hosting af din side hos Piwik (uden http:// eller https://)
-piwik_site_id: ID for din side hos Piwik
-piwik_enabled: Aktiver Piwik
+matomo_host: Hosting af din side hos Matomo (uden http:// eller https://)
+matomo_site_id: ID for din side hos Matomo
+matomo_enabled: Aktiver Matomo
 demo_mode_enabled: "Aktiver demo-indstilling? (anvendes kun til wallabags offentlige demo)"
 demo_mode_username: "Demobruger"
 # share_public: Allow public url for entries
--- a/app/Resources/CraueConfigBundle/translations/CraueConfigBundle.de.yml
+++ b/app/Resources/CraueConfigBundle/translations/CraueConfigBundle.de.yml
@ -27,9 +27,9 @@ export: 'Export'
 import: 'Import'
 misc: 'Verschiedenes'
 modify_settings: 'Übernehmen'
-piwik_host: 'Host deiner Webseite in Piwik (ohne http:// oder https://)'
-piwik_site_id: 'ID deiner Webseite in Piwik'
-piwik_enabled: 'Piwik aktivieren'
+matomo_host: 'Host deiner Webseite in Matomo (ohne http:// oder https://)'
+matomo_site_id: 'ID deiner Webseite in Matomo'
+matomo_enabled: 'Matomo aktivieren'
 demo_mode_enabled: 'Test-Modus aktivieren? (nur für die öffentliche wallabag-Demo genutzt)'
 demo_mode_username: 'Test-Benutzer'
 share_public: 'Erlaube eine öffentliche URL für Einträge'
--- a/app/Resources/CraueConfigBundle/translations/CraueConfigBundle.en.yml
+++ b/app/Resources/CraueConfigBundle/translations/CraueConfigBundle.en.yml
@ -27,9 +27,9 @@ export: "export"
 import: "import"
 misc: "misc"
 modify_settings: "apply"
-piwik_host: Host of your website in Piwik (without http:// or https://)
-piwik_site_id: ID of your website in Piwik
-piwik_enabled: Enable Piwik
+matomo_host: Host of your website in Matomo (without http:// or https://)
+matomo_site_id: ID of your website in Matomo
+matomo_enabled: Enable Matomo
 demo_mode_enabled: "Enable demo mode? (Only used for the public wallabag demo)"
 demo_mode_username: "Demo user"
 share_public: Allow public URL for entries
--- a/app/Resources/CraueConfigBundle/translations/CraueConfigBundle.es.yml
+++ b/app/Resources/CraueConfigBundle/translations/CraueConfigBundle.es.yml
@ -27,9 +27,9 @@ export: "exportar"
 import: "importar"
 misc: "misc"
 modify_settings: "guardar"
-piwik_host: Host de tu website en Piwik (sin http:// o https://)
-piwik_site_id: ID de tu website en Piwik
-piwik_enabled: Activar Piwik
+matomo_host: Host de tu website en Matomo (sin http:// o https://)
+matomo_site_id: ID de tu website en Matomo
+matomo_enabled: Activar Matomo
 demo_mode_enabled: "Activar modo demo (sólo usado en la demo pública de wallabag)"
 demo_mode_username: "Nombre de usuario demo"
 share_public: Permitir URL pública para los artículos
--- a/app/Resources/CraueConfigBundle/translations/CraueConfigBundle.fa.yml
+++ b/app/Resources/CraueConfigBundle/translations/CraueConfigBundle.fa.yml
@ -27,9 +27,9 @@ export: "برون‌سپاری"
 import: "درون‌ریزی"
 misc: "غیره"
 modify_settings: "اعمال"
-# piwik_host: Host of your website in Piwik (without http:// or https://)
-# piwik_site_id: ID of your website in Piwik
-# piwik_enabled: Enable Piwik
+# matomo_host: Host of your website in Matomo (without http:// or https://)
+# matomo_site_id: ID of your website in Matomo
+# matomo_enabled: Enable Matomo
 # demo_mode_enabled: "Enable demo mode ? (only used for the wallabag public demo)"
 # demo_mode_username: "Demo user"
 # share_public: Allow public url for entries
--- a/app/Resources/CraueConfigBundle/translations/CraueConfigBundle.fr.yml
+++ b/app/Resources/CraueConfigBundle/translations/CraueConfigBundle.fr.yml
@ -27,9 +27,9 @@ export: "export"
 import: "import"
 misc: "divers"
 modify_settings: "appliquer"
-piwik_host: URL de votre site dans Piwik (sans http:// ou https://)
-piwik_site_id: ID de votre site dans Piwik
-piwik_enabled: Activer Piwik
+matomo_host: URL de votre site dans Matomo (sans http:// ou https://)
+matomo_site_id: ID de votre site dans Matomo
+matomo_enabled: Activer Matomo
 demo_mode_enabled: "Activer le mode démo ? (utiliser uniquement pour la démo publique de wallabag)"
 demo_mode_username: "Utilisateur de la démo"
 share_public: Autoriser une URL publique pour les articles
--- a/app/Resources/CraueConfigBundle/translations/CraueConfigBundle.it.yml
+++ b/app/Resources/CraueConfigBundle/translations/CraueConfigBundle.it.yml
@ -27,9 +27,9 @@ export: "esporta"
 import: "importa"
 misc: "misc"
 modify_settings: "applica"
-piwik_host: Host del tuo sito in Piwik (senza http:// o https://)
-piwik_site_id: ID del tuo sito in Piwik
-piwik_enabled: Abilita Piwik
+matomo_host: Host del tuo sito in Matomo (senza http:// o https://)
+matomo_site_id: ID del tuo sito in Matomo
+matomo_enabled: Abilita Matomo
 demo_mode_enabled: "Abilita modalità demo ? (usato solo per la demo pubblica di wallabag)"
 demo_mode_username: "Utente Demo"
 # share_public: Allow public url for entries
--- a/app/Resources/CraueConfigBundle/translations/CraueConfigBundle.ja.yml
+++ b/app/Resources/CraueConfigBundle/translations/CraueConfigBundle.ja.yml
@ -27,9 +27,9 @@ export: "エクスポート"
 import: "インポート"
 misc: "misc"
 modify_settings: "適用"
-piwik_host: Piwik でのウェブサイトのホスト (http:// または https:// は不要)
-piwik_site_id: Piwik でのあなたのウェブサイトの ID
-piwik_enabled: Piwik を有効にする
+matomo_host: Matomo でのウェブサイトのホスト (http:// または https:// は不要)
+matomo_site_id: Matomo でのあなたのウェブサイトの ID
+matomo_enabled: Matomo を有効にする
 demo_mode_enabled: "デモモードを有効にしますか？ (パブリック Wallabag のデモにのみ使用)"
 demo_mode_username: "デモユーザー"
 share_public: 記事の公開 URL を許可する
--- a/app/Resources/CraueConfigBundle/translations/CraueConfigBundle.oc.yml
+++ b/app/Resources/CraueConfigBundle/translations/CraueConfigBundle.oc.yml
@ -27,9 +27,9 @@ export: "expòrt"
 import: "impòrt"
 misc: "divèrs"
 modify_settings: "aplicar"
-piwik_host: URL de vòstre site dins Piwik (sense http:// o https://)
-piwik_site_id: ID de vòstre site dins Piwik
-piwik_enabled: Activar Piwik
+matomo_host: URL de vòstre site dins Matomo (sense http:// o https://)
+matomo_site_id: ID de vòstre site dins Matomo
+matomo_enabled: Activar Matomo
 demo_mode_enabled: "Activar lo mode demostracion ? (utilizar solament per la demostracion publica de wallabag)"
 demo_mode_username: "Utilizaire de la demostracion"
 share_public: Autorizar una URL publica pels articles
--- a/app/Resources/CraueConfigBundle/translations/CraueConfigBundle.pl.yml
+++ b/app/Resources/CraueConfigBundle/translations/CraueConfigBundle.pl.yml
@ -26,9 +26,9 @@ export: "eksport"
 import: "import"
 misc: "różne"
 modify_settings: "zatwierdź"
-piwik_host: Host twojej strony Piwik (bez http:// lub https://)
-piwik_site_id: ID twojej strony Piwik
-piwik_enabled: Włacz Piwik
+matomo_host: Host twojej strony Matomo (bez http:// lub https://)
+matomo_site_id: ID twojej strony Matomo
+matomo_enabled: Włacz Matomo
 demo_mode_enabled: "Włacz tryb demo? (używany wyłącznie dla publicznej demonstracji Wallabag)"
 demo_mode_username: "Użytkownik Demonstracyjny"
 share_public: Zezwalaj na publiczny adres url dla wpisow
--- a/app/Resources/CraueConfigBundle/translations/CraueConfigBundle.pt.yml
+++ b/app/Resources/CraueConfigBundle/translations/CraueConfigBundle.pt.yml
@ -28,9 +28,9 @@ export: "exportar"
 import: "importar"
 misc: "misc"
 modify_settings: "aplicar"
-piwik_host: Host de seu website Piwik
-piwik_site_id: ID de seu website Piwik
-piwik_enabled: Habilitar Piwik
+matomo_host: Host de seu website Matomo
+matomo_site_id: ID de seu website Matomo
+matomo_enabled: Habilitar Matomo
 demo_mode_enabled: "Habilitar modo demo? (somente usado para o demo público do wallabag)"
 demo_mode_username: "Usuário demo"
 # share_public: Allow public url for entries
--- a/app/Resources/CraueConfigBundle/translations/CraueConfigBundle.ro.yml
+++ b/app/Resources/CraueConfigBundle/translations/CraueConfigBundle.ro.yml
@ -27,9 +27,9 @@ export: "exportă"
 import: "importă"
 misc: "diverse"
 modify_settings: "aplică"
-# piwik_host: Host of your website in Piwik (without http:// or https://)
-# piwik_site_id: ID of your website in Piwik
-# piwik_enabled: Enable Piwik
+# matomo_host: Host of your website in Matomo (without http:// or https://)
+# matomo_site_id: ID of your website in Matomo
+# matomo_enabled: Enable Matomo
 # demo_mode_enabled: "Enable demo mode ? (only used for the wallabag public demo)"
 # demo_mode_username: "Demo user"
 # share_public: Allow public url for entries
--- a/app/Resources/CraueConfigBundle/translations/CraueConfigBundle.ru.yml
+++ b/app/Resources/CraueConfigBundle/translations/CraueConfigBundle.ru.yml
@ -27,9 +27,9 @@ export: "экспорт"
 import: "импорт"
 misc: "разное"
 modify_settings: "применить"
-piwik_host: "Ссылка на Ваш сайт на Piwik (с http:// или https://)"
-piwik_site_id: "ID Вашего сайта на Piwik"
-piwik_enabled: "Включить Piwik"
+matomo_host: "Ссылка на Ваш сайт на Matomo (с http:// или https://)"
+matomo_site_id: "ID Вашего сайта на Matomo"
+matomo_enabled: "Включить Matomo"
 demo_mode_enabled: "Включить демо режим ? (только для публичной демонстрации wallabag)"
 demo_mode_username: "Демо пользователь"
 share_public: "Разрешить публичные ссылки на записи"
--- a/app/Resources/CraueConfigBundle/translations/CraueConfigBundle.th.yml
+++ b/app/Resources/CraueConfigBundle/translations/CraueConfigBundle.th.yml
@ -25,9 +25,9 @@ export: "นำข้อมูลออก"
 import: "นำเข้าข้อมูล"
 misc: "เบ็ดเตล็ด"
 modify_settings: "ปรับใช้"
-piwik_host: โฮสบนเว็บไซต์ของคุณใน Piwik (ยกเว้น http:// หรือ https://)
-piwik_site_id: ไอดีบนเว็บไซต์ของคุณใน Piwik
-piwik_enabled: เปิดการใช้ Piwik
+matomo_host: โฮสบนเว็บไซต์ของคุณใน Matomo (ยกเว้น http:// หรือ https://)
+matomo_site_id: ไอดีบนเว็บไซต์ของคุณใน Matomo
+matomo_enabled: เปิดการใช้ Matomo
 demo_mode_enabled: "เปิดการใช้งานโหมดเดโม ? (เฉพาะการใช้สำหรับเดโมสาธารณะของ wallabag)"
 demo_mode_username: "ผู้ใช้ส่วนเดโม"
 share_public: ยอมรับ URL สาธารณะจากการเข้าถึงข้อมูล
--- a/app/Resources/CraueConfigBundle/translations/CraueConfigBundle.tr.yml
+++ b/app/Resources/CraueConfigBundle/translations/CraueConfigBundle.tr.yml
@ -28,9 +28,9 @@
 # import: "import"
 # misc: "misc"
 # modify_settings: "apply"
-# piwik_host: Host of your website in Piwik (without http:// or https://)
-# piwik_site_id: ID of your website in Piwik
-# piwik_enabled: Enable Piwik
+# matomo_host: Host of your website in Matomo (without http:// or https://)
+# matomo_site_id: ID of your website in Matomo
+# matomo_enabled: Enable Matomo
 # demo_mode_enabled: "Enable demo mode ? (only used for the wallabag public demo)"
 # demo_mode_username: "Demo user"
 # share_public: Allow public url for entries
--- a/app/Resources/CraueConfigBundle/translations/CraueConfigBundle.zh.yml
+++ b/app/Resources/CraueConfigBundle/translations/CraueConfigBundle.zh.yml
@ -27,9 +27,9 @@ export: "导出"
 import: "导入"
 misc: "杂项"
 modify_settings: "申请"
-piwik_host: 你的网站在 Piwik 的主机名（不包括 http:// or https://）
-piwik_site_id: 你的网站在 Piwik 的 ID
-piwik_enabled: 启用 Piwik
+matomo_host: 你的网站在 Matomo 的主机名（不包括 http:// or https://）
+matomo_site_id: 你的网站在 Matomo 的 ID
+matomo_enabled: 启用 Matomo
 demo_mode_enabled: "启用演示模式？(仅用于 wallabag 公开演示)"
 demo_mode_username: "Demo user"
 share_public: 允许为项目启用公开链接
--- a/app/config/services.yml
+++ b/app/config/services.yml
@ -20,8 +20,8 @@ services:
        tags:
            - { name: twig.extension }

-    wallabag.twig_piwik_extension:
-        class: PiwikTwigExtension\PiwikTwigExtension
+    wallabag.twig_matomo_extension:
+        class: MatomoTwigExtension\MatomoTwigExtension
        public: false
        tags:
            - { name: twig.extension }
--- a/app/config/wallabag.yml
+++ b/app/config/wallabag.yml
@ -125,15 +125,15 @@ wallabag_core:
            value: 0
            section: import
        -
-            name: piwik_enabled
+            name: matomo_enabled
            value: 0
            section: analytics
        -
-            name: piwik_host
-            value: v2.wallabag.org
+            name: matomo_host
+            value: matomo.wallabag.org
            section: analytics
        -
-            name: piwik_site_id
+            name: matomo_site_id
            value: 1
            section: analytics
        -
--- a/composer.json
+++ b/composer.json
@ -79,7 +79,7 @@
        "guzzlehttp/guzzle": "^5.3.1",
        "doctrine/doctrine-migrations-bundle": "^1.3",
        "craue/config-bundle": "^2.3.0",
-        "mnapoli/piwik-twig-extension": "^2.0",
+        "mnapoli/piwik-twig-extension": "^3.0",
        "ocramius/proxy-manager": "^2.1.1",
        "white-october/pagerfanta-bundle": "^1.1",
        "php-amqplib/rabbitmq-bundle": "^1.14",
--- a/composer.lock
+++ b/composer.lock
@ -4,7 +4,7 @@
        "Read more about it at https://getcomposer.org/doc/01-basic-usage.md#installing-dependencies",
        "This file is @generated automatically"
    ],
-    "content-hash": "934e7fcdcc82a110216efe0a9364ba2c",
+    "content-hash": "552a7c133014fd0a95d78a04fab4beba",
    "packages": [
        {
            "name": "bdunogier/guzzle-site-authenticator",
@ -3904,25 +3904,25 @@
            "authors": [
                {
                    "name": "Keyvan Minoukadeh",
+                    "role": "Developer (ported original JS code to PHP)",
                    "email": "keyvan@keyvan.net",
-                    "homepage": "http://keyvan.net",
-                    "role": "Developer (ported original JS code to PHP)"
+                    "homepage": "http://keyvan.net"
                },
                {
                    "name": "Arc90",
-                    "homepage": "http://arc90.com",
-                    "role": "Developer (original JS version)"
+                    "role": "Developer (original JS version)",
+                    "homepage": "http://arc90.com"
                },
                {
                    "name": "Jeremy Benoist",
+                    "role": "Developer",
                    "email": "jeremy.benoist@gmail.com",
-                    "homepage": "http://www.j0k3r.net",
-                    "role": "Developer"
+                    "homepage": "http://www.j0k3r.net"
                },
                {
                    "name": "DitherSky",
-                    "homepage": "https://github.com/Dither",
-                    "role": "Developer (https://github.com/Dither/full-text-rss)"
+                    "role": "Developer (https://github.com/Dither/full-text-rss)",
+                    "homepage": "https://github.com/Dither"
                }
            ],
            "description": "Automatic article extraction from HTML",
@ -4870,38 +4870,39 @@
        },
        {
            "name": "mnapoli/piwik-twig-extension",
-            "version": "2.0.1",
+            "version": "3.0.0",
            "source": {
                "type": "git",
-                "url": "https://github.com/mnapoli/PiwikTwigExtension.git",
-                "reference": "e1746d20730426d7098b4a9a3f5c6c99c6f04612"
+                "url": "https://github.com/mnapoli/MatomoTwigExtension.git",
+                "reference": "472fd49157d64e78081b7a626095ea989cae8471"
            },
            "dist": {
                "type": "zip",
-                "url": "https://api.github.com/repos/mnapoli/PiwikTwigExtension/zipball/e1746d20730426d7098b4a9a3f5c6c99c6f04612",
-                "reference": "e1746d20730426d7098b4a9a3f5c6c99c6f04612",
+                "url": "https://api.github.com/repos/mnapoli/MatomoTwigExtension/zipball/472fd49157d64e78081b7a626095ea989cae8471",
+                "reference": "472fd49157d64e78081b7a626095ea989cae8471",
                "shasum": ""
            },
            "require": {
                "php": ">=7.0",
-                "twig/twig": "~2.10"
+                "twig/twig": "~2.10|~3.0"
            },
            "require-dev": {
                "friendsofphp/php-cs-fixer": "~2.13",
                "php-coveralls/php-coveralls": "^2.0",
-                "symfony/phpunit-bridge": "^4.2"
+                "symfony/phpunit-bridge": "^5.0"
            },
            "type": "library",
            "autoload": {
                "psr-4": {
-                    "PiwikTwigExtension\\": "src/"
+                    "MatomoTwigExtension\\": "src/"
                }
            },
            "notification-url": "https://packagist.org/downloads/",
            "license": [
                "MIT"
            ],
-            "time": "2019-06-21T10:58:04+00:00"
+            "description": "This library integrates Matomo into Twig",
+            "time": "2020-04-24T14:45:43+00:00"
        },
        {
            "name": "monolog/monolog",
@ -9620,7 +9621,7 @@
                    "email": "adrien.brault@gmail.com"
                },
                {
-                    "name": "William DURAND",
+                    "name": "William Durand",
                    "email": "william.durand1@gmail.com"
                }
            ],
@ -9670,7 +9671,7 @@
            ],
            "authors": [
                {
-                    "name": "William DURAND",
+                    "name": "William Durand",
                    "email": "william.durand1@gmail.com"
                }
            ],
--- a/src/Wallabag/CoreBundle/Resources/views/base.html.twig
+++ b/src/Wallabag/CoreBundle/Resources/views/base.html.twig
@ -75,8 +75,8 @@

        {% block footer %}{% endblock %}

-        {% if craue_setting('piwik_enabled') %}
-            {{ piwik(craue_setting('piwik_host'), craue_setting('piwik_site_id')) }}
+        {% if craue_setting('matomo_enabled') %}
+            {{ matomo(craue_setting('matomo_host'), craue_setting('matomo_site_id')) }}
        {% endif %}
    </body>
 </html>