1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
|
<?php
/**
* Matomo - free/libre analytics platform
*
* @link https://matomo.org
* @license https://www.gnu.org/licenses/gpl-3.0.html GPL v3 or later
*/
namespace Piwik\Plugins\PrivacyManager\Settings;
use Piwik\Piwik;
use Piwik\Plugins\PrivacyManager\Config;
use Piwik\Plugins\PrivacyManager\ReferrerAnonymizer;
use Piwik\Settings\Interfaces\CustomSettingInterface;
use Piwik\Settings\Interfaces\PolicyComparisonInterface;
use Piwik\Settings\Interfaces\SettingValueInterface;
use Piwik\Settings\Interfaces\Traits\Getters\CustomGetterTrait;
use Piwik\Settings\Interfaces\Traits\PolicyComparisonTrait;
use Piwik\Policy\CnilPolicy;
/**
* @implements CustomSettingInterface<string|null>
* @implements PolicyComparisonInterface<string|null>
* @implements SettingValueInterface<string|null>
*/
class ReferrerAnonymisation implements CustomSettingInterface, PolicyComparisonInterface, SettingValueInterface
{
/**
* @use PolicyComparisonTrait<string|null>
*/
use PolicyComparisonTrait;
/**
* @use CustomGetterTrait<string|null>
*/
use CustomGetterTrait;
/**
* @var string|null
*/
private $value;
private function __construct(?string $value)
{
$this->value = $value;
}
public function getValue()
{
return $this->value;
}
protected static function getCustomSettingName(): string
{
return 'anonymizeReferrer';
}
public static function getCustomValue(?int $idSite = null)
{
// disallowing compliance override to prevent indefinite loop in getting the value
return (new Config($idSite))->getFromOption(self::getCustomSettingName(), $allowPolicyComplianceOverride = false);
}
public static function getTitle(): string
{
return Piwik::translate('PrivacyManager_ReferrerAnonymizationSettingTitle');
}
public static function getComplianceRequirementNote(?int $idSite = null): string
{
return Piwik::translate('PrivacyManager_ReferrerAnonymizationSettingRequirementNote');
}
public static function getInlineHelp(): string
{
// not used as not a true setting, help text part of FE vue component
return '';
}
public static function getPolicyRequirements(): array
{
$policies = [];
$policies[CnilPolicy::class] = ReferrerAnonymizer::EXCLUDE_PATH;
return $policies;
}
public static function getInstance(?int $idSite = null): self
{
$values = self::getPolicyRequiredValues($idSite);
$customValue = self::getCustomValue($idSite);
$values['custom'] = $customValue ?? null;
return new self(self::getStrictestValueFromArray($values));
}
public static function isCompliant(string $policy, ?int $idSite = null): bool
{
$policyValues = self::getPolicyRequirements();
if (!array_key_exists($policy, $policyValues)) {
return true;
}
$currentValue = self::getInstance($idSite)->getValue();
return $currentValue === self::compareStrictness($currentValue, $policyValues[$policy]);
}
protected static function compareStrictness($value1, $value2)
{
// the list of options in ReferrerAnonymizer::getAvailableAnonymizationOptions is ordered by strictness
// higher position in the array means stricter value
$options = array_keys(ReferrerAnonymizer::getAvailableAnonymizationOptions());
$posValue1 = array_search($value1, $options);
$posValue2 = array_search($value2, $options);
if ($posValue1 > $posValue2) {
return $value1;
}
return $value2;
}
}
|
