Merge pull request #1920 from acelaya-forks/feature/matomo-integration

Feature/matomo integration
shlinkio · Nov 22, 2023 · cb0bac5 · cb0bac5
2 parents 36e2a93 + bd5d3f6
commit cb0bac5
Show file tree

Hide file tree

Showing 26 changed files with 744 additions and 186 deletions.
diff --git a/.gitignore b/.gitignore
@@ -9,6 +9,7 @@ vendor/
 data/database.sqlite
 data/shlink-tests.db
 data/GeoLite2-City.*
+data/infra/matomo
 docs/swagger-ui*
 docs/mercure.html
 docker-compose.override.yml

diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -6,6 +6,8 @@ The format is based on [Keep a Changelog](https://keepachangelog.com), and this
 
 ## [Unreleased]
 ### Added
+* [#1798](https://github.com/shlinkio/shlink/issues/1798) Experimental support to send visits to an external Matomo instance.
+
 * [#1780](https://github.com/shlinkio/shlink/issues/1780) Add new `NO_ORPHAN_VISITS` API key role.
 
   Keys with this role will always get `0` when fetching orphan visits.

diff --git a/composer.json b/composer.json
@@ -35,6 +35,7 @@
         "laminas/laminas-stdlib": "^3.17",
         "league/uri": "^6.8",
         "lstrojny/functional-php": "^1.17",
+        "matomo/matomo-php-tracker": "^3.2",
         "mezzio/mezzio": "^3.17",
         "mezzio/mezzio-fastroute": "^3.10",
         "mezzio/mezzio-problem-details": "^1.13",
@@ -47,9 +48,9 @@
         "ramsey/uuid": "^4.7",
         "shlinkio/shlink-common": "dev-main#7d46772 as 5.7",
         "shlinkio/shlink-config": "dev-main#cde5d3b as 2.5",
-        "shlinkio/shlink-event-dispatcher": "dev-main#faf2582 as 3.1",
+        "shlinkio/shlink-event-dispatcher": "dev-main#35ccc0b as 3.1",
         "shlinkio/shlink-importer": "dev-main#d621b20 as 5.2",
-        "shlinkio/shlink-installer": "dev-develop#c1ef08c as 8.6",
+        "shlinkio/shlink-installer": "dev-develop#c505a19 as 8.6",
         "shlinkio/shlink-ip-geolocation": "dev-main#4a1cef8 as 3.3",
         "shlinkio/shlink-json": "dev-main#e5a111c as 1.1",
         "spiral/roadrunner": "^2023.2",

diff --git a/config/autoload/installer.global.php b/config/autoload/installer.global.php
@@ -66,6 +66,10 @@
             Option\RabbitMq\RabbitMqUserConfigOption::class,
             Option\RabbitMq\RabbitMqPasswordConfigOption::class,
             Option\RabbitMq\RabbitMqVhostConfigOption::class,
+            Option\Matomo\MatomoEnabledConfigOption::class,
+            Option\Matomo\MatomoBaseUrlConfigOption::class,
+            Option\Matomo\MatomoSiteIdConfigOption::class,
+            Option\Matomo\MatomoApiTokenConfigOption::class,
         ],
 
         'installation_commands' => [

diff --git a/config/autoload/matomo.global.php b/config/autoload/matomo.global.php
@@ -0,0 +1,16 @@
+<?php
+
+declare(strict_types=1);
+
+use Shlinkio\Shlink\Core\Config\EnvVars;
+
+return [
+
+    'matomo' => [
+        'enabled' => (bool) EnvVars::MATOMO_ENABLED->loadFromEnv(false),
+        'base_url' => EnvVars::MATOMO_BASE_URL->loadFromEnv(),
+        'site_id' => EnvVars::MATOMO_SITE_ID->loadFromEnv(),
+        'api_token' => EnvVars::MATOMO_API_TOKEN->loadFromEnv(),
+    ],
+
+];
diff --git a/config/autoload/matomo.local.php.dist b/config/autoload/matomo.local.php.dist
@@ -0,0 +1,26 @@
+<?php
+
+declare(strict_types=1);
+
+/*
+ * Dev matomo instance needs to be manually configured once before enabling the configuration below.
+ *
+ * 1. Go to http://localhost:8003 and follow the installation instructions.
+ * 2. Open data/infra/matomo/config/config.ini.php and replace `trusted_hosts[] = "localhost"` with
+ *   `trusted_hosts[] = "localhost:8003"` (see https://github.com/matomo-org/matomo/issues/9549)
+ * 3. Go to http://localhost:8003/index.php?module=SitesManager&action=index and paste the ID for the site you just
+ *    created into the `site_id` field below.
+ * 4. Go to http://localhost:8003/index.php?module=UsersManager&action=userSecurity, scroll down, click
+ *    "Create new token" and once generated, paste the token into the `api_token` field below.
+ */
+
+return [
+
+    'matomo' => [
+//        'enabled' => true,
+//        'base_url' => 'http://shlink_matomo',
+//        'site_id' => '...',
+//        'api_token' => '...',
+    ],
+
+];
diff --git a/config/config.php b/config/config.php
@@ -22,33 +22,39 @@
 $isTestEnv = env('APP_ENV') === 'test';
 $enableSwoole = PHP_SAPI === 'cli' && openswooleIsInstalled() && ! runningInRoadRunner();
 
-return (new ConfigAggregator\ConfigAggregator([
-    ! $isTestEnv
-        ? new EnvVarLoaderProvider('config/params/generated_config.php', enumValues(Core\Config\EnvVars::class))
-        : new ConfigAggregator\ArrayProvider([]),
-    Mezzio\ConfigProvider::class,
-    Mezzio\Router\ConfigProvider::class,
-    Mezzio\Router\FastRouteRouter\ConfigProvider::class,
-    $enableSwoole && class_exists(Swoole\ConfigProvider::class)
-        ? Swoole\ConfigProvider::class
-        : new ConfigAggregator\ArrayProvider([]),
-    ProblemDetails\ConfigProvider::class,
-    Diactoros\ConfigProvider::class,
-    Common\ConfigProvider::class,
-    Config\ConfigProvider::class,
-    Importer\ConfigProvider::class,
-    IpGeolocation\ConfigProvider::class,
-    EventDispatcher\ConfigProvider::class,
-    Core\ConfigProvider::class,
-    CLI\ConfigProvider::class,
-    Rest\ConfigProvider::class,
-    new ConfigAggregator\PhpFileProvider('config/autoload/{,*.}global.php'),
-    // Local config should not be loaded during tests, whereas test config should be loaded ONLY during tests
-    new ConfigAggregator\PhpFileProvider($isTestEnv ? 'config/test/*.global.php' : 'config/autoload/{,*.}local.php'),
-    // Routes have to be loaded last
-    new ConfigAggregator\PhpFileProvider('config/autoload/routes.config.php'),
-], 'data/cache/app_config.php', [
-    Core\Config\PostProcessor\BasePathPrefixer::class,
-    Core\Config\PostProcessor\MultiSegmentSlugProcessor::class,
-    Core\Config\PostProcessor\ShortUrlMethodsProcessor::class,
-]))->getMergedConfig();
+return (new ConfigAggregator\ConfigAggregator(
+    providers: [
+        ! $isTestEnv
+            ? new EnvVarLoaderProvider('config/params/generated_config.php', enumValues(Core\Config\EnvVars::class))
+            : new ConfigAggregator\ArrayProvider([]),
+        Mezzio\ConfigProvider::class,
+        Mezzio\Router\ConfigProvider::class,
+        Mezzio\Router\FastRouteRouter\ConfigProvider::class,
+        $enableSwoole && class_exists(Swoole\ConfigProvider::class)
+            ? Swoole\ConfigProvider::class
+            : new ConfigAggregator\ArrayProvider([]),
+        ProblemDetails\ConfigProvider::class,
+        Diactoros\ConfigProvider::class,
+        Common\ConfigProvider::class,
+        Config\ConfigProvider::class,
+        Importer\ConfigProvider::class,
+        IpGeolocation\ConfigProvider::class,
+        EventDispatcher\ConfigProvider::class,
+        Core\ConfigProvider::class,
+        CLI\ConfigProvider::class,
+        Rest\ConfigProvider::class,
+        new ConfigAggregator\PhpFileProvider('config/autoload/{,*.}global.php'),
+        // Local config should not be loaded during tests, whereas test config should be loaded ONLY during tests
+        new ConfigAggregator\PhpFileProvider(
+            $isTestEnv ? 'config/test/*.global.php' : 'config/autoload/{,*.}local.php',
+        ),
+        // Routes have to be loaded last
+        new ConfigAggregator\PhpFileProvider('config/autoload/routes.config.php'),
+    ],
+    cachedConfigFile: 'data/cache/app_config.php',
+    postProcessors: [
+        Core\Config\PostProcessor\BasePathPrefixer::class,
+        Core\Config\PostProcessor\MultiSegmentSlugProcessor::class,
+        Core\Config\PostProcessor\ShortUrlMethodsProcessor::class,
+    ],
+))->getMergedConfig();
diff --git a/docker-compose.yml b/docker-compose.yml
@@ -33,6 +33,7 @@ services:
             - shlink_mercure
             - shlink_mercure_proxy
             - shlink_rabbitmq
+            - shlink_matomo
         environment:
             LC_ALL: C
         extra_hosts:
@@ -70,6 +71,7 @@ services:
             - shlink_mercure
             - shlink_mercure_proxy
             - shlink_rabbitmq
+            - shlink_matomo
         environment:
             LC_ALL: C
         extra_hosts:
@@ -95,6 +97,7 @@ services:
             - shlink_mercure
             - shlink_mercure_proxy
             - shlink_rabbitmq
+            - shlink_matomo
         environment:
             LC_ALL: C
         extra_hosts:
@@ -201,3 +204,21 @@ services:
             - "8005:8080"
         volumes:
             - ./docs/swagger:/app
+
+    shlink_matomo:
+        container_name: shlink_matomo
+        image: matomo:4.15-apache
+        ports:
+            - "8003:80"
+        volumes:
+            # Matomo does not persist port in trusted hosts. This volume is needed to edit config afterward
+            # https://github.com/matomo-org/matomo/issues/9549
+            - ./data/infra/matomo:/var/www/html
+        links:
+            - shlink_db_mysql
+        environment:
+            MATOMO_DATABASE_HOST: "shlink_db_mysql"
+            MATOMO_DATABASE_ADAPTER: "mysql"
+            MATOMO_DATABASE_DBNAME: "matomo"
+            MATOMO_DATABASE_USERNAME: "root"
+            MATOMO_DATABASE_PASSWORD: "root"
diff --git a/module/Core/config/dependencies.config.php b/module/Core/config/dependencies.config.php
@@ -92,6 +92,9 @@
             Importer\ImportedLinksProcessor::class => ConfigAbstractFactory::class,
 
             Crawling\CrawlingHelper::class => ConfigAbstractFactory::class,
+
+            Matomo\MatomoOptions::class => [ValinorConfigFactory::class, 'config.matomo'],
+            Matomo\MatomoTrackerBuilder::class => ConfigAbstractFactory::class,
         ],
 
         'aliases' => [
@@ -100,6 +103,8 @@
     ],
 
     ConfigAbstractFactory::class => [
+        Matomo\MatomoTrackerBuilder::class => [Matomo\MatomoOptions::class],
+
         ErrorHandler\NotFoundTypeResolverMiddleware::class => ['config.router.base_path'],
         ErrorHandler\NotFoundTrackerMiddleware::class => [Visit\RequestTracker::class],
         ErrorHandler\NotFoundRedirectHandler::class => [