Merge 5.x-dev to staging

.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="MarketingCampaignsReporting" --php-versions="7.2,8.3" --schedule-cron="55 2 * * 6"
+# ./console generate:test-action --plugin="MarketingCampaignsReporting" --php-versions="matomo5_min_php,matomo5_max_php" --schedule-cron="55 2 * * 6"
 
 name: Plugin MarketingCampaignsReporting Tests
 
@@ -33,19 +33,17 @@ 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
         with:
           lfs: true
           persist-credentials: false
-      - name: Install package ripgrep
-        run: sudo apt-get install ripgrep
       - name: Run tests
         uses: matomo-org/github-action-tests@main
         with:
@@ -54,9 +52,9 @@ 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' }}
   UI:
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-24.04
     steps:
       - uses: actions/checkout@v3
         with:
@@ -68,7 +66,7 @@ jobs:
           plugin-name: 'MarketingCampaignsReporting'
           matomo-test-branch: 'maximum_supported_matomo'
           test-type: 'UI'
-          php-version: '7.2'
+          php-version: 'matomo5_min_php'
           node-version: '16'
           artifacts-pass: ${{ secrets.ARTIFACTS_PASS }}
           upload-artifacts: true

.github/workflows/phpcs.yml

@@ -0,0 +1,43 @@
+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: '7.4'
+          tools: cs2pr
+      - name: Install dependencies
+        run:
+          composer init --name=matomo/marketingcampaignsreporting --quiet;
+          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

API.php

@@ -1,4 +1,5 @@
 <?php
+
 /**
  * Matomo - free/libre analytics platform
  *
@@ -156,7 +157,7 @@ private function isTableEmpty(DataTable\DataTableInterface $dataTable)
     {
         if ($dataTable instanceof DataTable) {
             return $dataTable->getRowsCount() == 0;
-        } else if ($dataTable instanceof DataTable\Map) {
+        } elseif ($dataTable instanceof DataTable\Map) {
             foreach ($dataTable->getDataTables() as $label => $childTable) {
                 if ($this->isTableEmpty($childTable)) {
                     return true;
@@ -168,17 +169,18 @@ private function isTableEmpty(DataTable\DataTableInterface $dataTable)
         }
     }
 
-    private function mergeDataTableMaps(DataTable\DataTableInterface $dataTable,
-                                        DataTable\DataTableInterface $referrersDataTable)
-    {
+    private function mergeDataTableMaps(
+        DataTable\DataTableInterface $dataTable,
+        DataTable\DataTableInterface $referrersDataTable
+    ) {
         if ($dataTable instanceof DataTable) {
             if ($this->isTableEmpty($dataTable)) {
                 $referrersDataTable->setAllTableMetadata($dataTable->getAllTableMetadata());
                 return $referrersDataTable;
             } else {
                 return $dataTable;
             }
-        } else if ($dataTable instanceof DataTable\Map) {
+        } elseif ($dataTable instanceof DataTable\Map) {
             foreach ($dataTable->getDataTables() as $label => $childTable) {
                 $newTable = $this->mergeDataTableMaps($childTable, $referrersDataTable->getTable($label));
                 $dataTable->addTable($newTable, $label);
@@ -188,5 +190,4 @@ private function mergeDataTableMaps(DataTable\DataTableInterface $dataTable,
             throw new \Exception("Sanity check: unknown datatable type '" . get_class($dataTable) . "'.");
         }
     }
-
 }

Archiver.php

@@ -1,4 +1,5 @@
 <?php
+
 /**
  * Matomo - free/libre analytics platform
  *
@@ -13,15 +14,15 @@
 
 class Archiver extends \Piwik\Plugin\Archiver
 {
-    const CAMPAIGN_ID_RECORD_NAME = 'MarketingCampaignsReporting_Id';
-    const CAMPAIGN_NAME_RECORD_NAME = 'MarketingCampaignsReporting_Name';
-    const CAMPAIGN_KEYWORD_RECORD_NAME = 'MarketingCampaignsReporting_Keyword';
-    const CAMPAIGN_SOURCE_RECORD_NAME = 'MarketingCampaignsReporting_Source';
-    const CAMPAIGN_MEDIUM_RECORD_NAME = 'MarketingCampaignsReporting_Medium';
-    const CAMPAIGN_CONTENT_RECORD_NAME = 'MarketingCampaignsReporting_Content';
-    const CAMPAIGN_GROUP_RECORD_NAME = 'MarketingCampaignsReporting_Group';
-    const CAMPAIGN_PLACEMENT_RECORD_NAME = 'MarketingCampaignsReporting_Placement';
-    const HIERARCHICAL_SOURCE_MEDIUM_RECORD_NAME = 'MarketingCampaignsReporting_SourceMedium_Name';
+    public const CAMPAIGN_ID_RECORD_NAME = 'MarketingCampaignsReporting_Id';
+    public const CAMPAIGN_NAME_RECORD_NAME = 'MarketingCampaignsReporting_Name';
+    public const CAMPAIGN_KEYWORD_RECORD_NAME = 'MarketingCampaignsReporting_Keyword';
+    public const CAMPAIGN_SOURCE_RECORD_NAME = 'MarketingCampaignsReporting_Source';
+    public const CAMPAIGN_MEDIUM_RECORD_NAME = 'MarketingCampaignsReporting_Medium';
+    public const CAMPAIGN_CONTENT_RECORD_NAME = 'MarketingCampaignsReporting_Content';
+    public const CAMPAIGN_GROUP_RECORD_NAME = 'MarketingCampaignsReporting_Group';
+    public const CAMPAIGN_PLACEMENT_RECORD_NAME = 'MarketingCampaignsReporting_Placement';
+    public const HIERARCHICAL_SOURCE_MEDIUM_RECORD_NAME = 'MarketingCampaignsReporting_SourceMedium_Name';
 
-    const SEPARATOR_COMBINED_DIMENSIONS = " - ";
+    public const SEPARATOR_COMBINED_DIMENSIONS = " - ";
 }

CHANGELOG.md

@@ -0,0 +1,93 @@
+## Changelog
+
+#### 5.1.5 - 2025-11-11
+- Fixed fatal error due to new code to track AI referrer visit
+
+#### 5.1.4 - 2025-11-10
+- Fixed incorrectly forcing a new visit for visits referred by AI referrers
+
+#### 5.1.3 - 2025-10-13
+- Fix for handling AI referrers correctly, providing utm_source parameter
+
+#### 5.1.2 - 2025-07-21
+- README.md updated
+
+#### 5.1.1 - 2025-01-15
+- Changed to logic to lower the campaign values in database query instead of serverside 
+
+#### 5.1.0
+- Added an option to retain the case of campaign parameter values via SystemSetting
+
+#### 5.0.4
+- Added plugin category for Marketplace
+
+#### 5.0.3 
+- Fixed flat report not working for campaign_name and campaign_source-medium report
+
+#### 5.0.2
+- Archiving: Ensure parameter is provided in correct type
+
+#### 5.0.1 
+- Compatability with Matomo 5
+
+#### 5.0.0-b1
+- Compatability with Matomo 5
+
+#### 4.1.3
+- Translation changes
+
+#### 4.1.2
+- Allowed creating new visit when campaign changes to be different per site if necessary
+
+#### 4.1.1
+- Fixed deprecation warnings for PHP 8.1
+
+#### 4.1.0
+- Additional dimensions for campaign group and placement
+
+#### 4.0.0
+- Compatibility with Matomo 4 and translation updates
+
+#### 3.1.1
+- Rebrand and translation updates
+
+#### 3.1.0
+- Show campaign information in visitor log and profile
+
+#### 3.0.1
+- Enables segmented visitorlog for campaign reports
+
+#### 3.0.0
+- Plugin forked by Piwik team + Renamed + Compatibility with Piwik 3
+
+#### 1.4.0 
+- Added possibility to configure custom campaign parameters names
+
+#### 1.3.1 
+- Better support for campaign parameters behind hash tag (#)
+
+#### 1.3.0 
+- Compatibility with Piwik 2.16.0
+
+#### 1.2.0
+- Plugin comaptibility with Piwik 2.15.0
+
+#### 1.1.1
+- Campaign reports now display your campaign report data even for campaign data before you activated AdvancedCampaignReporting
+
+#### 1.1.0
+
+#### 1.0.8 
+- Exclude Google Analytics campaign parameters from the Page URLs
+
+#### 1.0.6 
+- Documentation
+
+#### 1.0.5 
+- Detect new URL parameters: piwik_campaign, pk_cpn and for Keywords: pk_kwd, piwik_keyword
+
+#### 1.0.4
+- View Goals by Campaign Dimension in the Goals & Ecommerce reports
+
+#### 1.0.3
+- Released for free on the [Piwik Marketplace](http://plugins.piwik.org/)

Campaign/CampaignDetector.php

@@ -1,4 +1,5 @@
 <?php
+
 /**
  * Matomo - free/libre analytics platform
  *
@@ -11,7 +12,6 @@
 
 namespace Piwik\Plugins\MarketingCampaignsReporting\Campaign;
 
-use Piwik\Common;
 use Piwik\Plugins\MarketingCampaignsReporting\MarketingCampaignsReporting;
 use Piwik\Tracker\PageUrl;
 use Piwik\Tracker\Request;
@@ -29,7 +29,8 @@ public function detectCampaignFromRequest(Request $request, $campaignParameters)
         $landingUrl       = PageUrl::cleanupUrl($landingUrl);
         $landingUrlParsed = parse_url($landingUrl);
 
-        if (!isset($landingUrlParsed['query'])
+        if (
+            !isset($landingUrlParsed['query'])
             && !isset($landingUrlParsed['fragment'])
         ) {
             return false;
@@ -84,9 +85,6 @@ protected function getValueFromQueryString($param, $queryString)
     {
         $valueFromRequest = UrlHelper::getParameterFromQueryString($queryString, $param) ?? '';
         $valueFromRequest = trim(urldecode($valueFromRequest));
-        if ($param != "mtm_clid") {
-            $valueFromRequest = Common::mb_strtolower($valueFromRequest);
-        }
         $valueFromRequest = substr($valueFromRequest, 0, 250);
         if (!empty($valueFromRequest)) {
             return $valueFromRequest;

Campaign/CampaignDetectorInterface.php

@@ -1,4 +1,5 @@
 <?php
+
 /**
  * Matomo - free/libre analytics platform
  *

Columns/Base.php

@@ -1,4 +1,5 @@
 <?php
+
 /**
  * Matomo - free/libre analytics platform
  *
@@ -43,6 +44,11 @@ public function onNewVisit(Request $request, Visitor $visitor, $action)
 
         $visitProperties = $visitor->visitProperties->getProperties();
 
+        // @todo Not using Common::REFERRER_TYPE_AI_ASSISTANT for BC reasons. Can be changed with Matomo 6
+        if ($visitProperties['referer_type'] === 8) {
+            return null; // skip campaign detection when a AI assistant was detected as referrer by core
+        }
+
         $campaignDimensions = $campaignDetector->detectCampaignFromRequest(
             $request,
             $campaignParameters
@@ -52,7 +58,6 @@ public function onNewVisit(Request $request, Visitor $visitor, $action)
             // If for some reason a campaign was detected in Core Tracker
             // but not here, copy that campaign to the Advanced Campaign
             if ($visitProperties['referer_type'] == Common::REFERRER_TYPE_CAMPAIGN) {
-
                 $campaignDimensions = array(
                     (new CampaignName())->getColumnName() => $visitProperties['referer_name']
                 );
@@ -82,6 +87,11 @@ public function onAnyGoalConversion(Request $request, Visitor $visitor, $action)
 
         $visitProperties = $visitor->visitProperties->getProperties();
 
+        // @todo Not using Common::REFERRER_TYPE_AI_ASSISTANT for BC reasons. Can be changed with Matomo 6
+        if ($visitProperties['referer_type'] === 8) {
+            return null; // skip campaign detection when a AI assistant was detected as referrer by core
+        }
+
         $campaignDimensions = $campaignDetector->detectCampaignFromVisit(
             $visitProperties,
             $campaignParameters

Columns/CampaignContent.php

@@ -1,4 +1,5 @@
 <?php
+
 /**
  * Matomo - free/libre analytics platform
  *

Columns/CampaignGroup.php

@@ -1,4 +1,5 @@
 <?php
+
 /**
  * Matomo - free/libre analytics platform
  *

Columns/CampaignId.php

@@ -1,4 +1,5 @@
 <?php
+
 /**
  * Matomo - free/libre analytics platform
  *

Columns/CampaignKeyword.php

@@ -1,4 +1,5 @@
 <?php
+
 /**
  * Matomo - free/libre analytics platform
  *

Columns/CampaignMedium.php

@@ -1,4 +1,5 @@
 <?php
+
 /**
  * Matomo - free/libre analytics platform
  *