Extend anonymisation settings to allow them to be site specific

core/Date.php

@@ -1008,7 +1008,7 @@ public function addMonth($n)
     /**
      * Adds `$n` hours to `$this` date and returns the result in a new Date.
      *
-     * @param int $n Number of hours to add. Can be less than 0.
+     * @param int|float $n Number of hours to add. Can be less than 0, can be decimal (will get converted to minutes)
      * @return \Piwik\Date
      */
     public function addHour($n)
@@ -1022,7 +1022,7 @@ public function addHour($n)
      * this static function instead of {@link addHour()} will be faster since a
      * Date instance does not have to be created.
      *
-     * @param int $timestamp The timestamp to add to.
+     * @param int|float $timestamp The timestamp to add to.
      * @param number $n Number of hours to add, must be > 0.
      * @return int The result as a UNIX timestamp.
      */

core/Settings/Interfaces/CustomSettingInterface.php

@@ -0,0 +1,8 @@
+<?php
+
+namespace Piwik\Settings\Interfaces;
+
+interface CustomSettingInterface
+{
+    public static function getCustomValue(?int $idSite = null);
+}

core/Settings/Interfaces/OptionSettingInterface.php

@@ -7,5 +7,5 @@ interface OptionSettingInterface
     /**
      * @return string|false
      */
-    public static function getOptionValue();
+    public static function getOptionValue(?int $idSite = null);
 }

core/Settings/Interfaces/Traits/Getters/OptionGetterTrait.php

@@ -10,17 +10,14 @@
  */
 trait OptionGetterTrait
 {
-    /**
-     * @return string|null
-     */
-    public static function getOptionValue()
+    public static function getOptionValue(?int $idSite = null): ?string
     {
-        $optionValue = Option::get(self::getOptionName());
+        $optionValue = Option::get(self::getOptionName($idSite));
         if ($optionValue !== false) {
             return $optionValue;
         }
         return null;
     }
 
-    abstract protected static function getOptionName(): string;
+    abstract protected static function getOptionName(?int $idSite = null): string;
 }

phpstan-baseline.neon

@@ -5698,16 +5698,6 @@ parameters:
 			count: 1
 			path: plugins/PrivacyManager/API.php
 
-		-
-			message: "#^Property Piwik\\\\Plugins\\\\PrivacyManager\\\\Config\\:\\:\\$anonymizeOrderId \\(int\\) does not accept bool\\.$#"
-			count: 1
-			path: plugins/PrivacyManager/API.php
-
-		-
-			message: "#^Property Piwik\\\\Plugins\\\\PrivacyManager\\\\Config\\:\\:\\$anonymizeUserId \\(int\\) does not accept bool\\.$#"
-			count: 1
-			path: plugins/PrivacyManager/API.php
-
 		-
 			message: "#^Binary operation \"\\+\" between non\\-falsy\\-string and int results in an error\\.$#"
 			count: 1
@@ -6439,7 +6429,7 @@ parameters:
 			path: plugins/UsersManager/API.php
 
 		-
-			message: "#^Parameter \\#1 \\$n of method Piwik\\\\Date\\:\\:addHour\\(\\) expects int, string given\\.$#"
+			message: "#^Parameter \\#1 \\$n of method Piwik\\\\Date\\:\\:addHour\\(\\) expects float\\|int, string given\\.$#"
 			count: 1
 			path: plugins/UsersManager/API.php
 

plugins/CoreHome/Tracker/VisitRequestProcessor.php

@@ -108,7 +108,7 @@ public function processRequestParams(VisitProperties $visitProperties, Request $
             return true;
         }
 
-        $privacyConfig = new PrivacyManagerConfig();
+        $privacyConfig = new PrivacyManagerConfig($request->getIdSiteIfExists());
 
         if ($privacyConfig->randomizeConfigId) {
             // always new visit when randomising config id
@@ -155,8 +155,9 @@ public function afterRequestProcessed(VisitProperties $visitProperties, Request
          * This event is primarily used by the **PrivacyManager** plugin to anonymize IP addresses.
          *
          * @param string &$ip The visitor's IP address.
+         * @param int $idSite The site ID we're tracking the visit for.
          */
-        $this->eventDispatcher->postEvent('Tracker.setVisitorIp', array(&$ip));
+        $this->eventDispatcher->postEvent('Tracker.setVisitorIp', [&$ip, (int) $request->getIdSiteIfExists()]);
 
         $visitProperties->setProperty('location_ip', $ip);
 

plugins/PrivacyManager/API.php

@@ -16,6 +16,7 @@
 use Piwik\Piwik;
 use Piwik\Config as PiwikConfig;
 use Piwik\Plugin\Manager;
+use Piwik\Plugins\CustomJsTracker\File;
 use Piwik\Plugins\FeatureFlags\FeatureFlagManager;
 use Piwik\Plugins\Live\Live;
 use Piwik\Plugins\PrivacyManager\FeatureFlags\PrivacyCompliance;
@@ -26,6 +27,7 @@
 use Piwik\Policy\CompliancePolicy;
 use Piwik\Policy\PolicyManager;
 use Piwik\Site;
+use Piwik\Tracker\TrackerCodeGenerator;
 use Piwik\Validators\BaseValidator;
 
 /**
@@ -50,11 +52,6 @@ class API extends \Piwik\Plugin\API
      */
     private $logDataAnonymizer;
 
-    /**
-     * @var ReferrerAnonymizer
-     */
-    private $referrerAnonymizer;
-
     /**
      * @var FeatureFlagManager
      */
@@ -65,13 +62,11 @@ public function __construct(
         DataSubjects $gdpr,
         LogDataAnonymizations $logDataAnonymizations,
         LogDataAnonymizer $logDataAnonymizer,
-        ReferrerAnonymizer $referrerAnonymizer,
         FeatureFlagManager $featureFlagManager
     ) {
         $this->gdpr = $gdpr;
         $this->logDataAnonymizations = $logDataAnonymizations;
         $this->logDataAnonymizer = $logDataAnonymizer;
-        $this->referrerAnonymizer = $referrerAnonymizer;
         $this->featureFlagManager = $featureFlagManager;
     }
 
@@ -237,66 +232,133 @@ private function formatAvailableColumnsToAnonymize($columns)
         return $formatted;
     }
 
+    /**
+     * Provide tracker file name and whether it's writable
+     *
+     * @return array{0: string, 1: bool}
+     */
+    private function getTrackerFileDetails(): array
+    {
+        if (Piwik::hasUserSuperUserAccess()) {
+            $jsCodeGenerator = new TrackerCodeGenerator();
+            $file = new File(PIWIK_DOCUMENT_ROOT . '/' . $jsCodeGenerator->getJsTrackerEndpoint());
+            $filename = $jsCodeGenerator->getJsTrackerEndpoint();
+
+            if (Manager::getInstance()->isPluginActivated('CustomJsTracker')) {
+                $file = StaticContainer::get('Piwik\Plugins\CustomJsTracker\TrackerUpdater')->getToFile();
+                $filename = $file->getName();
+            }
+
+            return [$filename, $file->hasWriteAccess()];
+        }
+
+        return ['', false];
+    }
+
+    /**
+     * Provide anonymisation settings to Matomo UI only
+     *
+     * @internal
+     */
+    public function getAnonymisationSettings(?int $idSiteSpecific = null): array
+    {
+        if (is_numeric($idSiteSpecific)) {
+            $idSite = intval($idSiteSpecific);
+            Piwik::checkUserHasAdminAccess($idSiteSpecific);
+        } else {
+            $idSite = null;
+            Piwik::checkUserHasSuperUserAccess();
+        }
+
+        $privacyConfig = new Config($idSite);
+        $settings = [];
+        foreach ($privacyConfig->getConfigPropertyNames() as $propertyName) {
+            $settings[$propertyName] = $privacyConfig->{$propertyName};
+        }
+        $settings['useSiteSpecificSettings'] = $privacyConfig->useSiteSpecificSettings();
+
+        // provide extra settings
+        [$trackerFilename, $trackerFileWritable] = $this->getTrackerFileDetails();
+        $settings = array_merge($settings, [
+            'maskLengthOptions' => PrivacyManager::getMaskLengthOptions(),
+            'useAnonymizedIpForVisitEnrichmentOptions' =>
+                PrivacyManager::getUseAnonymizedIpForVisitEnrichmentOptions(),
+            'referrerAnonymizationOptions' => ReferrerAnonymizer::getAvailableAnonymizationOptions(),
+            'trackerFileName' => $trackerFilename,
+            'trackerWritable' => $trackerFileWritable,
+        ]);
+
+        return $settings;
+    }
+
     /**
      * @internal
      */
     public function setAnonymizeIpSettings(
-        $anonymizeIPEnable,
-        $maskLength,
-        $useAnonymizedIpForVisitEnrichment,
-        $anonymizeUserId = false,
-        $anonymizeOrderId = false,
-        $anonymizeReferrer = '',
-        $forceCookielessTracking = false,
-        $randomizeConfigId = false,
+        bool $anonymizeIPEnable,
+        int $ipAddressMaskLength,
+        bool $useAnonymizedIpForVisitEnrichment,
+        bool $anonymizeUserId = false,
+        bool $anonymizeOrderId = false,
+        string $anonymizeReferrer = '',
+        bool $forceCookielessTracking = false,
+        bool $randomizeConfigId = false,
+        ?int $idSiteSpecific = null,
+        bool $useSiteSpecificSettings = false,
         #[\SensitiveParameter]
-        $passwordConfirmation = ''
+        string $passwordConfirmation = ''
     ) {
-        Piwik::checkUserHasSuperUserAccess();
+        if (null !== $idSiteSpecific) {
+            $idSite = $idSiteSpecific;
+            Piwik::checkUserHasAdminAccess($idSiteSpecific);
+        } else {
+            $idSite = null;
+            Piwik::checkUserHasSuperUserAccess();
+        }
+
+        // if we receive a specific site ID, and it's set not to use custom site settings, we need to remove them
+        // so that the behaviour defaults to the system settings
+        if ($idSite && !$useSiteSpecificSettings) {
+            $privacyConfig = new Config($idSite);
+            $privacyConfig->removeForSite();
 
-        if ($randomizeConfigId == '1') {
+            return true;
+        }
+
+        if ($randomizeConfigId) {
             $this->confirmCurrentUserPassword($passwordConfirmation);
         }
 
-        if ($anonymizeIPEnable == '1') {
-            IPAnonymizer::activate();
-        } elseif ($anonymizeIPEnable == '0') {
-            IPAnonymizer::deactivate();
+        if ($anonymizeIPEnable) {
+            IPAnonymizer::activate($idSite);
         } else {
-            // pass
+            IPAnonymizer::deactivate($idSite);
         }
 
         if (
             !empty($anonymizeReferrer)
-            && !array_key_exists($anonymizeReferrer, $this->referrerAnonymizer->getAvailableAnonymizationOptions())
+            && !array_key_exists($anonymizeReferrer, ReferrerAnonymizer::getAvailableAnonymizationOptions())
         ) {
             $anonymizeReferrer = '';
         }
 
-        $privacyConfig = new Config();
-        $privacyConfig->ipAddressMaskLength = (int) $maskLength;
-        $privacyConfig->useAnonymizedIpForVisitEnrichment = (bool) $useAnonymizedIpForVisitEnrichment;
+        $privacyConfig = new Config($idSite);
+        $privacyConfig->ipAddressMaskLength = $ipAddressMaskLength;
+        $privacyConfig->useAnonymizedIpForVisitEnrichment = $useAnonymizedIpForVisitEnrichment;
         $privacyConfig->anonymizeReferrer = $anonymizeReferrer;
+        $privacyConfig->anonymizeUserId = $anonymizeUserId;
+        $privacyConfig->anonymizeOrderId = $anonymizeOrderId;
+        $privacyConfig->randomizeConfigId = $randomizeConfigId;
 
-        if (false !== $anonymizeUserId) {
-            $privacyConfig->anonymizeUserId = (bool) $anonymizeUserId;
-        }
-
-        if (false !== $anonymizeOrderId) {
-            $privacyConfig->anonymizeOrderId = (bool) $anonymizeOrderId;
-        }
-
-        if (false !== $forceCookielessTracking) {
-            $privacyConfig->forceCookielessTracking = (bool) $forceCookielessTracking;
+        if (!$idSite) {
+            // only allow setting 'force cookieless tracking' instance-wide and skip it for site as it applies
+            // changes to JS tracker files that we can't currently support on a per-site basis
+            $privacyConfig->forceCookielessTracking = $forceCookielessTracking;
 
             // update tracker files
             Piwik::postEvent('CustomJsTracker.updateTracker');
         }
 
-        if (false !== $randomizeConfigId) {
-            $privacyConfig->randomizeConfigId = (bool) $randomizeConfigId;
-        }
-
         return true;
     }