use matomo/matomo-php-tracker instead of piwik/piwik-php-tracker

matomo-org · Jan 13, 2020 · 0d4030f · 0d4030f
1 parent 8bd9671
commit 0d4030f
Show file tree

Hide file tree

Showing 35 changed files with 122 additions and 134 deletions.
diff --git a/composer.json b/composer.json
@@ -43,13 +43,13 @@
         "matomo/referrer-spam-blacklist": "~1.0",
         "matomo/searchengine-and-social-list": "~1.0",
         "tecnickcom/tcpdf": "~6.0",
-        "piwik/piwik-php-tracker": "^1.0.0",
         "composer/semver": "~1.3.0",
         "szymach/c-pchart": "^2.0",
         "geoip2/geoip2": "^2.8",
         "davaxi/sparkline": "dev-multiple-series",
         "matomo-org/jshrink": "1.3.1",
-        "matomo/network": "~2.0"
+        "matomo/network": "~2.0",
+        "matomo/matomo-php-tracker": "~2.0"
     },
     "require-dev": {
         "aws/aws-sdk-php": "2.7.1",

diff --git a/composer.lock b/composer.lock
diff --git a/core/Common.php b/core/Common.php
@@ -729,8 +729,7 @@ public static function convertVisitorIdToBin($id)
      */
     public static function convertUserIdToVisitorIdBin($userId)
     {
-        require_once PIWIK_INCLUDE_PATH . '/libs/PiwikTracker/PiwikTracker.php';
-        $userIdHashed = \PiwikTracker::getUserIdHashed($userId);
+        $userIdHashed = \MatomoTracker::getUserIdHashed($userId);
 
         return self::convertVisitorIdToBin($userIdHashed);
     }

diff --git a/core/Tracker/Request.php b/core/Tracker/Request.php
@@ -869,7 +869,7 @@ private function truncateIdAsVisitorId($idVisitor)
     }
 
     /**
-     * Matches implementation of PiwikTracker::getUserIdHashed
+     * Matches implementation of MatomoTracker::getUserIdHashed
      *
      * @param $userId
      * @return string

diff --git a/libs/PiwikTracker/PiwikTracker.php b/libs/PiwikTracker/PiwikTracker.php
@@ -11,7 +11,7 @@
 // code, this file has been left as a redirect to its new location in the
 // vendor directory.
 if (!class_exists('PiwikTracker')) {
-    require_once __DIR__ . '/../../vendor/piwik/piwik-php-tracker/PiwikTracker.php';
+    require_once __DIR__ . '/../../vendor/matomo/matomo-php-tracker/PiwikTracker.php';
 }
 
 if (PiwikTracker::VERSION !== 1) {

diff --git a/misc/others/ExampleMatomoTracker.php b/misc/others/ExampleMatomoTracker.php
@@ -0,0 +1,17 @@
+<?php
+// Example file to demonstrate MatomoTracker.php
+// See https://matomo.org/docs/tracking-api/
+require_once '../../vendor/matomo/matomo-php-tracker/MatomoTracker.php';
+MatomoTracker::$URL = 'http://localhost/trunk/';
+
+$matomoTracker = new MatomoTracker($idSite = 1);
+// You can manually set the Visitor details (resolution, time, plugins)
+// See all other ->set* functions available in the MatomoTracker class
+$matomoTracker->setResolution(1600, 1400);
+
+// Sends Tracker request via http
+$matomoTracker->doTrackPageView('Document title of current page view');
+// You can also track Goal conversions
+$matomoTracker->doTrackGoal($idGoal = 1, $revenue = 42);
+
+echo 'done';
diff --git a/misc/others/ExamplePiwikTracker.php b/misc/others/ExamplePiwikTracker.php
diff --git a/misc/others/tracker_simpleImageTracker.php b/misc/others/tracker_simpleImageTracker.php
@@ -1,9 +1,9 @@
 <?php
-// -- Piwik Tracking API init --
-require_once "../../libs/PiwikTracker/PiwikTracker.php";
-PiwikTracker::$URL = 'http://localhost/matomo-master/';
+// -- Matomo Tracking API init --
+require_once '../../vendor/matomo/matomo-php-tracker/MatomoTracker.php';
+MatomoTracker::$URL = 'http://localhost/matomo-master/';
 // Example 1: Tracks a pageview for Website id = {$IDSITE}
-$trackingURL = Piwik_getUrlTrackPageView($idSite = 16, $customTitle = 'This title will appear in the report Actions > Page titles');
+$trackingURL = Matomo_getUrlTrackPageView($idSite = 16, $customTitle = 'This title will appear in the report Actions > Page titles');
 
 ?>
 <html>

diff --git a/plugins/BulkTracking/tests/System/TrackerTest.php b/plugins/BulkTracking/tests/System/TrackerTest.php
@@ -22,7 +22,7 @@ class TrackerTest extends SystemTestCase
     public static $fixture = null;
 
     /**
-     * @var \PiwikTracker
+     * @var \MatomoTracker
      */
     private $tracker;
 

diff --git a/plugins/Contents/tests/Fixtures/TwoVisitsWithContents.php b/plugins/Contents/tests/Fixtures/TwoVisitsWithContents.php
@@ -10,7 +10,7 @@
 use Piwik\Date;
 use Piwik\Plugins\Goals\API as APIGoals;
 use Piwik\Tests\Framework\Fixture;
-use PiwikTracker;
+use MatomoTracker;
 
 /**
  * Tracks contents
@@ -56,13 +56,13 @@ public function trackVisits()
         $this->trackContentImpressionsAndInteractions($vis2);
     }
 
-    private function moveTimeForward(PiwikTracker $vis, $minutes)
+    private function moveTimeForward(MatomoTracker $vis, $minutes)
     {
         $hour = $minutes / 60;
         $vis->setForceVisitDateTime(Date::factory($this->dateTime)->addHour($hour)->getDatetime());
     }
 
-    protected function trackContentImpressionsAndInteractions(PiwikTracker $vis)
+    protected function trackContentImpressionsAndInteractions(MatomoTracker $vis)
     {
         $vis->setUrl('http://www.example.org/page');
         $vis->setGenerationTime(333);

diff --git a/plugins/CoreHome/tests/Integration/Column/UserIdTest.php b/plugins/CoreHome/tests/Integration/Column/UserIdTest.php
@@ -244,7 +244,7 @@ private function trackPageviewsWithDifferentUsers($userIds)
         }
     }
 
-    private function trackPageview(\PiwikTracker $tracker, $userId, $url = null)
+    private function trackPageview(\MatomoTracker $tracker, $userId, $url = null)
     {
         if (null !== $url) {
             $tracker->setUrl('http://www.example.org' . $url);

diff --git a/plugins/CustomVariables/Archiver.php b/plugins/CustomVariables/Archiver.php
@@ -16,8 +16,6 @@
 use Piwik\Tracker\GoalManager;
 use Piwik\Tracker;
 
-require_once PIWIK_INCLUDE_PATH . '/libs/PiwikTracker/PiwikTracker.php';
-
 class Archiver extends \Piwik\Plugin\Archiver
 {
     const LABEL_CUSTOM_VALUE_NOT_DEFINED = "Value not defined";
@@ -109,7 +107,7 @@ protected function aggregateCustomVariable($slot)
         // then we also query the "Product page view" price which was possibly recorded.
         $additionalSelects = false;
 
-        if (in_array($slot, array(\PiwikTracker::CVAR_INDEX_ECOMMERCE_ITEM_SKU, \PiwikTracker::CVAR_INDEX_ECOMMERCE_ITEM_NAME, \PiwikTracker::CVAR_INDEX_ECOMMERCE_ITEM_CATEGORY))) {
+        if (in_array($slot, array(\MatomoTracker::CVAR_INDEX_ECOMMERCE_ITEM_SKU, \MatomoTracker::CVAR_INDEX_ECOMMERCE_ITEM_NAME, \MatomoTracker::CVAR_INDEX_ECOMMERCE_ITEM_CATEGORY))) {
             $additionalSelects = array($this->getSelectAveragePrice());
         }
         $query = $this->getLogAggregator()->queryActionsByDimension($dimensions, $where, $additionalSelects);
@@ -121,7 +119,7 @@ protected function aggregateCustomVariable($slot)
 
     protected function getSelectAveragePrice()
     {
-        $field = "custom_var_v" . \PiwikTracker::CVAR_INDEX_ECOMMERCE_ITEM_PRICE;
+        $field = "custom_var_v" . \MatomoTracker::CVAR_INDEX_ECOMMERCE_ITEM_PRICE;
         return LogAggregator::getSqlRevenue("AVG(log_link_visit_action." . $field . ")") . " as `" . Metrics::INDEX_ECOMMERCE_ITEM_PRICE_VIEWED . "`";
     }
 

diff --git a/plugins/IntranetMeasurable/tests/Fixtures/IntranetSitesWithVisits.php b/plugins/IntranetMeasurable/tests/Fixtures/IntranetSitesWithVisits.php
@@ -49,7 +49,7 @@ private function setUpWebsites()
         }
     }
 
-    private function configureSameDevice(\PiwikTracker $t)
+    private function configureSameDevice(\MatomoTracker $t)
     {
         // to make purpose of test more clear we configure the device partially...
         $t->setIp('56.11.55.70');

diff --git a/plugins/Live/tests/Fixtures/VisitsWithAllActionsAndDevices.php b/plugins/Live/tests/Fixtures/VisitsWithAllActionsAndDevices.php
@@ -69,7 +69,7 @@ public function tearDown()
         // empty
     }
 
-    private function trackVisitSmartphone(\PiwikTracker $t, $dateTime)
+    private function trackVisitSmartphone(\MatomoTracker $t, $dateTime)
     {
         $t->setForceVisitDateTime($dateTime);
         $t->setUserAgent('Mozilla/5.0 (Linux; U; Android 4.4.2; fr-fr; HTC One_M8 Build/KOT49H) AppleWebKit/537.16 (KHTML, like Gecko) Version/4.0 Mobile Safari/537.16');
@@ -147,7 +147,7 @@ private function trackVisitSmartphone(\PiwikTracker $t, $dateTime)
         self::checkResponse($t->doTrackAction('http://vendor.site', 'link'));
     }
 
-    private function trackVisitTablet(\PiwikTracker $t, $dateTime)
+    private function trackVisitTablet(\MatomoTracker $t, $dateTime)
     {
         $t->setForceVisitDateTime($dateTime);
         $t->setUserAgent('Mozilla/5.0 (Linux; U; en-us; KFAPWI Build/JDQ39) AppleWebKit/535.19 (KHTML, like Gecko) Silk/3.8 Safari/535.19 Silk-Accelerated=true');
@@ -187,7 +187,7 @@ private function trackVisitTablet(\PiwikTracker $t, $dateTime)
         $t->doTrackContentImpression('product slider', 'product_16.jpg', 'http://example.org/product16');
     }
 
-    private function trackVisitMediaPlayer(\PiwikTracker $t, $dateTime)
+    private function trackVisitMediaPlayer(\MatomoTracker $t, $dateTime)
     {
         $t->setForceVisitDateTime($dateTime);
         $t->setUserAgent('Mozilla/5.0 (iPod; U; CPU iPhone OS 4_2_1 like Mac OS X; ja-jp) AppleWebKit/533.17.9 (KHTML, like Gecko) Mobile/8C148');
@@ -213,7 +213,7 @@ private function trackVisitMediaPlayer(\PiwikTracker $t, $dateTime)
         self::checkResponse($t->doTrackPageView('Action without url'));
     }
 
-    private function trackDeviceVisit(\PiwikTracker $t, $dateTime, $useragent)
+    private function trackDeviceVisit(\MatomoTracker $t, $dateTime, $useragent)
     {
         $t->setForceVisitDateTime($dateTime);
         $t->setUserAgent($useragent);

diff --git a/plugins/Monolog/tests/System/TrackerLoggingTest.php b/plugins/Monolog/tests/System/TrackerLoggingTest.php
@@ -10,12 +10,10 @@
 
 use Piwik\Config;
 use Piwik\Date;
-use Piwik\Plugins\Monolog\Handler\EchoHandler;
 use Piwik\Tests\Framework\Fixture;
 use Piwik\Tests\Framework\TestCase\SystemTestCase;
 use Piwik\Tests\Framework\TestingEnvironmentVariables;
-use PiwikTracker;
-use Psr\Container\ContainerInterface;
+use MatomoTracker;
 
 /**
  * @group Monolog
@@ -72,7 +70,7 @@ private function buildTracker()
         return $t;
     }
 
-    private function assertTrackerResponseContainsLogOutput(PiwikTracker $t)
+    private function assertTrackerResponseContainsLogOutput(MatomoTracker $t)
     {
         $response = $t->doTrackPageView('incredible title!');
 

diff --git a/plugins/PrivacyManager/tests/Fixtures/MultipleSitesMultipleVisitsFixture.php b/plugins/PrivacyManager/tests/Fixtures/MultipleSitesMultipleVisitsFixture.php
@@ -160,7 +160,7 @@ class MultipleSitesMultipleVisitsFixture extends Fixture
     public $idSite = 1;
     public $numVisitsPerIteration = 32;
     /**
-     * @var \PiwikTracker
+     * @var \MatomoTracker
      */
     private $tracker;
 

diff --git a/plugins/SitesManager/Controller.php b/plugins/SitesManager/Controller.php
@@ -102,6 +102,8 @@ public function setGlobalSettings()
 
     /**
      *  User will download a file called PiwikTracker.php that is the content of the actual script
+     *
+     * @deprecated  seems unused and PiwikTracker is now MatomoTracker
      */
     function downloadPiwikTracker()
     {

diff --git a/plugins/TestRunner/Commands/TestsSetupFixture.php b/plugins/TestRunner/Commands/TestsSetupFixture.php
@@ -256,8 +256,6 @@ private function createFixture(InputInterface $input, $allowSave)
 
     private function requireFixtureFiles(InputInterface $input)
     {
-        require_once PIWIK_INCLUDE_PATH . '/libs/PiwikTracker/PiwikTracker.php';
-
         $file = $input->getOption('file');
         if ($file) {
             if (is_file($file)) {

diff --git a/plugins/VisitsSummary/tests/Integration/VisitsSummaryTest.php b/plugins/VisitsSummary/tests/Integration/VisitsSummaryTest.php
@@ -150,7 +150,7 @@ private function trackPageviewsWithDifferentUsers($userIds)
         }
     }
 
-    private function trackPageview(\PiwikTracker $tracker, $userId, $url)
+    private function trackPageview(\MatomoTracker $tracker, $userId, $url)
     {
         $tracker->setUrl('http://www.example.org' . $url);
         $tracker->setUserId($userId);

diff --git a/tests/LocalTracker.php b/tests/LocalTracker.php
@@ -12,12 +12,11 @@
 require_once PIWIK_INCLUDE_PATH . '/core/Tracker/Visit.php';
 require_once PIWIK_INCLUDE_PATH . '/core/Tracker/GoalManager.php';
 require_once PIWIK_INCLUDE_PATH . '/core/Tracker/Action.php';
-require_once PIWIK_INCLUDE_PATH . '/libs/PiwikTracker/PiwikTracker.php';
 
 /**
  * Tracker that uses core/Tracker.php directly.
  */
-class Piwik_LocalTracker extends PiwikTracker
+class Matomo_LocalTracker extends MatomoTracker
 {
     protected function sendRequest($url, $method = 'GET', $data = null, $force = false)
     {
@@ -125,3 +124,4 @@ private function parseUrl($url)
     }
 }
 
+class_alias('Matomo_LocalTracker', 'Piwik_LocalTracker');
-Original file line number
+Diff line change
@@ Expand Up / @@ -102,6 +102,8 @@ public function setGlobalSettings() @@
         /**
          *  User will download a file called PiwikTracker.php that is the content of the actual script
+         *
+         * @deprecated  seems unused and PiwikTracker is now MatomoTracker
          */
         function downloadPiwikTracker()
         {
@@ Expand Down @@