Merge 5.x-dev to staging2

.github/workflows/matomo-tests.yml

@@ -1,7 +1,7 @@
 # Action for running tests
 # This file has been automatically created.
 # To recreate it you can run this command
-# ./console generate:test-action --plugin="VisitorGenerator" --php-versions="7.2,8.3" --schedule-cron="30 2 * * 6"
+# ./console generate:test-action --plugin="VisitorGenerator" --php-versions="matomo5_min_php,matomo5_max_php" --schedule-cron="30 2 * * 6"
 
 name: Plugin VisitorGenerator Tests
 
@@ -33,11 +33,11 @@ concurrency:
 
 jobs:
   PluginTests:
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-24.04
     strategy:
       fail-fast: false
       matrix:
-        php: [ '7.2', '8.3' ]
+        php: [ 'matomo5_min_php', 'matomo5_max_php' ]
         target: ['minimum_required_matomo', 'maximum_supported_matomo']
     steps:
       - uses: actions/checkout@v3
@@ -54,4 +54,4 @@ jobs:
           test-type: 'PluginTests'
           matomo-test-branch: ${{ matrix.target }}
           artifacts-pass: ${{ secrets.ARTIFACTS_PASS }}
-          upload-artifacts: ${{ matrix.php == '7.2' && matrix.target == 'maximum_supported_matomo' }}
+          upload-artifacts: ${{ matrix.php == 'matomo5_min_php' && matrix.target == 'maximum_supported_matomo' }}

.github/workflows/phpcs.yml

@@ -0,0 +1,42 @@
+name: PHPCS check
+
+on: pull_request
+
+permissions:
+  actions: read
+  checks: read
+  contents: read
+  deployments: none
+  issues: read
+  packages: none
+  pull-requests: read
+  repository-projects: none
+  security-events: none
+  statuses: read
+
+jobs:
+  phpcs:
+    name: PHPCS
+    runs-on: ubuntu-24.04
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          lfs: false
+          persist-credentials: false
+      - name: Setup PHP
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: '8.1'
+          tools: cs2pr
+      - name: Install dependencies
+        run:
+          composer --no-plugins config allow-plugins.dealerdirect/phpcodesniffer-composer-installer true -n;
+          composer config repositories.matomo-coding-standards vcs https://github.com/matomo-org/matomo-coding-standards -n;
+          composer require matomo-org/matomo-coding-standards:dev-master;
+          composer install --dev --prefer-dist --no-progress --no-suggest
+      - name: Check PHP code styles
+        id: phpcs
+        run: ./vendor/bin/phpcs --report-full --standard=phpcs.xml --report-checkstyle=./phpcs-report.xml
+      - name: Show PHPCS results in PR
+        if: ${{ always() && steps.phpcs.outcome == 'failure' }}
+        run: cs2pr ./phpcs-report.xml --prepend-filename

CHANGELOG.md

@@ -57,3 +57,16 @@
   * Updated README url in UI
 - 5.0.3
   * Added plugin category for Marketplace
+- 5.1.0 - 2024-09-09
+  * Replaced Symfony\Process with Piwik\Process
+- 5.1.1 - 2025-02-17
+  * Fixed deprecation warning from dependency
+- 5.1.2 - 2025-08-18
+  * Started generating AI referrer URLs 
+- 5.1.3 - 2025-09-01
+  * Fix for generation of ecommerce order ID 0
+- 5.1.4 - 2025-11-10
+  * Randomly mark visits as NovaAct agent also
+  * Added new command to send fake AI Bot Requests
+- 5.1.5 - 2025-11-24
+  * Generate string order IDs occasionally

Commands/AnonymizeLog.php

@@ -1,4 +1,5 @@
 <?php
+
 /**
  * Matomo - free/libre analytics platform
  *
@@ -136,7 +137,6 @@ private function anonymizeDomains($line)
         $url = parse_url($log['url']);
 
         if (!empty($url['query'])) {
-
             $params = array();
             parse_str($url['query'], $params);
 
@@ -147,7 +147,6 @@ private function anonymizeDomains($line)
                     $line   = str_replace(urlencode($params[$param]), urlencode($newUrl), $line);
                 }
             }
-
         }
 
         $referrer    = $log['referrer'];

Commands/GenerateAnnotation.php

@@ -1,4 +1,5 @@
 <?php
+
 /**
  * Matomo - free/libre analytics platform
  *
@@ -44,5 +45,4 @@ protected function doExecute(): int
 
         return self::SUCCESS;
     }
-
 }

Commands/GenerateBotRequests.php

@@ -0,0 +1,132 @@
+<?php
+
+/**
+ * Matomo - free/libre analytics platform
+ *
+ * @link https://matomo.org
+ * @license http://www.gnu.org/licenses/gpl-3.0.html GPL v3 or later
+ *
+ */
+
+namespace Piwik\Plugins\VisitorGenerator\Commands;
+
+use Piwik\Access;
+use Piwik\Date;
+use Piwik\Plugin\ConsoleCommand;
+use Piwik\Plugins\VisitorGenerator\Generator\BotRequestsFake;
+use Piwik\Site;
+use Piwik\Timer;
+use Piwik\UrlHelper;
+
+class GenerateBotRequests extends ConsoleCommand
+{
+    protected function configure()
+    {
+        $this->setName('visitorgenerator:generate-bot-requests');
+        $this->setDescription('Generates many bot requests for a given amount of days in the past. This command is intended for developers.');
+        $this->addRequiredValueOption('idsite', null, 'Defines the site the requests should be generated for');
+        $this->addRequiredValueOption('days', null, 'Defines for how many days in the past requests should be generated', 1);
+        $this->addRequiredValueOption('start-date', null, 'Date to start generating on.');
+        $this->addRequiredValueOption('limit-fake-requests', null, 'Limits the number of fake requests', null);
+        $this->addRequiredValueOption('custom-matomo-url', null, "Defines an alternate Matomo URL, e.g. if Matomo is installed behind a Load-Balancer.");
+    }
+
+    /**
+     * @return int
+     */
+    protected function doExecute(): int
+    {
+        $input  = $this->getInput();
+        $output = $this->getOutput();
+        $timer  = new Timer();
+        $days   = $this->checkDays();
+        $customMatomoUrl = $this->checkCustomMatomoUrl();
+        $limit  = $this->getLimitFakeRequests();
+        $idSite = $this->getIdSite();
+
+        $startDate = $input->getOption('start-date');
+        if (empty($startDate) || $startDate === 'now') {
+            $startTime = time();
+        } else {
+            $startTime = strtotime($startDate);
+        }
+
+        $time = $startTime - ($days - 1) * 86400;
+
+        $nbActionsTotal = 0;
+        while ($time <= $startTime) {
+            $output->writeln([
+                sprintf("Generating requests for %s...", Date::factory($time)->toString()),
+            ]);
+
+            Access::doAsSuperUser(function () use ($time, $idSite, &$nbActionsTotal, $customMatomoUrl, $limit) {
+                $fakeRequests = new BotRequestsFake($customMatomoUrl);
+                $nbActionsTotal += $fakeRequests->generate($time, $idSite, $limit);
+            });
+
+            $time += 86400;
+        }
+
+        $this->writeSuccessMessage([
+            'idsite = ' . $idSite,
+            $nbActionsTotal . ' Requests generated',
+            round($nbActionsTotal / $timer->getTime(), 0) . ' requests per second',
+        ]);
+
+        return self::SUCCESS;
+    }
+
+    private function getLimitFakeRequests(): int
+    {
+        $input = $this->getInput();
+
+        if ($input->getOption('limit-fake-requests')) {
+            return $input->getOption('limit-fake-requests');
+        }
+
+        return rand(400, 1000);
+    }
+
+    protected function checkDays(): int
+    {
+        $days = (int)$this->getInput()->getOption('days');
+
+        if ($days < 1) {
+            throw new \InvalidArgumentException('Days to compute must be greater or equal to 1.');
+        }
+
+        return $days;
+    }
+
+    private function checkCustomMatomoUrl(): ?string
+    {
+        if (!$customMatomoUrl = $this->getInput()->getOption('custom-matomo-url')) {
+            return null;
+        }
+
+        if (!UrlHelper::isLookLikeUrl($customMatomoUrl)) {
+            throw new \Exception("The Custom Matomo Tracker Url you entered doesn't seem to be valid.");
+        }
+
+        return $customMatomoUrl;
+    }
+
+    protected function getIdSite(): int
+    {
+        $idSite = $this->getInput()->getOption('idsite');
+
+        if ($idSite === null) {
+            $idSite = $this->ask('ID of the site in which to generate the visits: ');
+        }
+
+        $idSite = (int)$idSite;
+
+        return Access::doAsSuperUser(function () use ($idSite) {
+            if (!Site::getSite($idSite)) {
+                throw new \InvalidArgumentException('idsite is not a valid, no such site found');
+            }
+
+            return $idSite;
+        });
+    }
+}

Commands/GenerateGoals.php

@@ -1,4 +1,5 @@
 <?php
+
 /**
  * Matomo - free/libre analytics platform
  *
@@ -46,5 +47,4 @@ protected function doExecute(): int
 
         return self::SUCCESS;
     }
-
 }

Commands/GenerateLiveVisits.php

@@ -1,4 +1,5 @@
 <?php
+
 /**
  * Matomo - free/libre analytics platform
  *
@@ -26,15 +27,24 @@ protected function configure()
         $this->setDescription('Continuously generates visits from a single log file to make it seem like there is real time traffic.');
         $this->addRequiredValueOption('idsite', null, '(required) The ID of the site to track to.');
         $this->addRequiredValueOption('stop-after', null, 'If supplied, the command will exit after this many seconds.');
-        $this->addRequiredValueOption('log-file', null,
-            '(required) The log file to track visits from. This file MUST have visits in order of time.');
-        $this->addRequiredValueOption('day-of-month', null,
+        $this->addRequiredValueOption(
+            'log-file',
+            null,
+            '(required) The log file to track visits from. This file MUST have visits in order of time.'
+        );
+        $this->addRequiredValueOption(
+            'day-of-month',
+            null,
             'By default this command starts with visits for the current day of the month. Use this option to force an override. '
             . 'Specify 0 to ignore day of the month and use every log.',
-            Date::now()->toString('j'));
-        $this->addRequiredValueOption('time-of-day', null,
+            Date::now()->toString('j')
+        );
+        $this->addRequiredValueOption(
+            'time-of-day',
+            null,
             'The time of day to start replaying logs for. Defaults to now, specify a value here to override.',
-            time() % LiveVisitsFromLog::SECONDS_IN_DAY);
+            time() % LiveVisitsFromLog::SECONDS_IN_DAY
+        );
         $this->addRequiredValueOption('custom-matomo-url', null, 'Custom Matomo URL to track to.');
         $this->addRequiredValueOption('timeout', null, "Sets how long, in seconds, the timeout should be for the request.", 10);
         $this->addRequiredValueOption('token-auth', null, 'Use custom token auth instead of system generated one. If running this '
@@ -83,7 +93,8 @@ protected function doExecute(): int
 
             // nextWaitTime can be large if the next visit happens in an hour. no sense in
             // waiting if it'll be after stopAfter
-            if ($stopAfter > 0
+            if (
+                $stopAfter > 0
                 && (time() + $nextWaitTime) - $startTime > $stopAfter
             ) {
                 $output->writeln("$stopAfter seconds reached, exiting.");
@@ -93,7 +104,8 @@ protected function doExecute(): int
             $output->writeln("  sleeping {$nextWaitTime}s.");
             sleep($nextWaitTime);
 
-            if ($stopAfter > 0
+            if (
+                $stopAfter > 0
                 && time() - $startTime > $stopAfter
             ) {
                 $output->writeln("$stopAfter seconds reached, exiting.");
@@ -107,7 +119,8 @@ protected function doExecute(): int
     private function getPostiveIntegerOption($optionName)
     {
         $value = $this->getInput()->getOption($optionName);
-        if (!empty($value)
+        if (
+            !empty($value)
             && (!is_numeric($value)
                 || $value < 0)
         ) {

Commands/GenerateUsers.php

@@ -1,4 +1,5 @@
 <?php
+
 /**
  * Matomo - free/libre analytics platform
  *
@@ -39,5 +40,4 @@ protected function doExecute(): int
 
         return self::SUCCESS;
     }
-
 }

Commands/GenerateVisits.php

@@ -1,4 +1,5 @@
 <?php
+
 /**
  * Matomo - free/libre analytics platform
  *
@@ -104,7 +105,6 @@ private function getLimitFakeVisits()
         $input = $this->getInput();
 
         if ($input->getOption('limit-fake-visits')) {
-
             return $input->getOption('limit-fake-visits');
         }
 
@@ -153,4 +153,4 @@ protected function getIdSite()
             return $idSite;
         });
     }
-}
+}