Exceptions
8 months ago
CnilPolicy.php
8 months ago
CompliancePolicy.php
8 months ago
PolicyManager.php
8 months ago
CompliancePolicy.php
127 lines
| 1 | <?php |
| 2 | |
| 3 | /** |
| 4 | * Matomo - free/libre analytics platform |
| 5 | * |
| 6 | * @link https://matomo.org |
| 7 | * @license https://www.gnu.org/licenses/gpl-3.0.html GPL v3 or later |
| 8 | */ |
| 9 | namespace Piwik\Policy; |
| 10 | |
| 11 | use Piwik\Piwik; |
| 12 | use Piwik\Plugin\Manager; |
| 13 | use Piwik\Settings\FieldConfig; |
| 14 | use Piwik\Settings\Interfaces\ConfigSettingInterface; |
| 15 | use Piwik\Settings\Interfaces\MeasurableSettingInterface; |
| 16 | use Piwik\Settings\Interfaces\SystemSettingInterface; |
| 17 | use Piwik\Settings\Interfaces\Traits\Getters\ConfigGetterTrait; |
| 18 | use Piwik\Settings\Interfaces\Traits\Setters\MeasurableSetterTrait; |
| 19 | use Piwik\Settings\Interfaces\Traits\Setters\SystemSetterTrait; |
| 20 | /** |
| 21 | * @implements SystemSettingInterface<bool> |
| 22 | * @implements MeasurableSettingInterface<bool> |
| 23 | */ |
| 24 | abstract class CompliancePolicy implements SystemSettingInterface, MeasurableSettingInterface, ConfigSettingInterface |
| 25 | { |
| 26 | /** |
| 27 | * @use SystemSetterTrait<bool> |
| 28 | */ |
| 29 | use SystemSetterTrait; |
| 30 | /** |
| 31 | * @use MeasurableSetterTrait<bool> |
| 32 | */ |
| 33 | use MeasurableSetterTrait; |
| 34 | /** |
| 35 | * @use ConfigGetterTrait<bool> |
| 36 | */ |
| 37 | use ConfigGetterTrait; |
| 38 | public static abstract function getName() : string; |
| 39 | public static abstract function getTitle() : string; |
| 40 | protected static abstract function generateDescription() : string; |
| 41 | public static function getDescription() : string |
| 42 | { |
| 43 | $description = static::generateDescription(); |
| 44 | Piwik::postEvent('CompliancePolicy.updatePolicyDescription', [&$description, static::class]); |
| 45 | return $description; |
| 46 | } |
| 47 | /** |
| 48 | * @return array<array<string>> of [['title' => (string) 'TITLE', 'note' => (string) 'NOTE']] |
| 49 | */ |
| 50 | public static abstract function getUnknownSettings() : array; |
| 51 | /** |
| 52 | * @return array<string, string> |
| 53 | */ |
| 54 | public static function getDetails() : array |
| 55 | { |
| 56 | return ['id' => static::getName(), 'title' => static::getTitle(), 'description' => static::getDescription()]; |
| 57 | } |
| 58 | protected static function getPluginManagerInstance() : Manager |
| 59 | { |
| 60 | return Manager::getInstance(); |
| 61 | } |
| 62 | protected static function getSystemDefaultValue() |
| 63 | { |
| 64 | return \false; |
| 65 | } |
| 66 | protected static function getSystemName() : string |
| 67 | { |
| 68 | return preg_replace('/\\s+/', '', static::getName()) . '_policy_enabled'; |
| 69 | } |
| 70 | protected static function getSystemType() : string |
| 71 | { |
| 72 | return FieldConfig::TYPE_BOOL; |
| 73 | } |
| 74 | protected static function getMeasurableDefaultValue() |
| 75 | { |
| 76 | return \false; |
| 77 | } |
| 78 | protected static function getMeasurableName() : string |
| 79 | { |
| 80 | return preg_replace('/\\s+/', '', static::getName()) . '_policy_enabled'; |
| 81 | } |
| 82 | protected static function getMeasurableType() : string |
| 83 | { |
| 84 | return FieldConfig::TYPE_BOOL; |
| 85 | } |
| 86 | protected static function getConfigSection() : string |
| 87 | { |
| 88 | return Piwik::getPluginNameOfMatomoClass(static::class); |
| 89 | } |
| 90 | protected static function getConfigSettingName() : string |
| 91 | { |
| 92 | return static::getSystemName(); |
| 93 | } |
| 94 | /** |
| 95 | * If the policy is active at the instance level, |
| 96 | * disabling the policy for a site will also disable it |
| 97 | * for the instance. |
| 98 | */ |
| 99 | public static function setActiveStatus(?int $idSite, bool $isActive) : void |
| 100 | { |
| 101 | if (isset($idSite)) { |
| 102 | static::setMeasurableValue($idSite, $isActive); |
| 103 | if (static::getSystemValue() && !$isActive) { |
| 104 | static::setSystemValue($isActive); |
| 105 | } |
| 106 | return; |
| 107 | } |
| 108 | static::setSystemValue($isActive); |
| 109 | } |
| 110 | /** |
| 111 | * If the policy is active at the instance level, then |
| 112 | * this function will return true for all sites. |
| 113 | */ |
| 114 | public static function isActive(?int $idSite) : bool |
| 115 | { |
| 116 | $instanceLevel = static::getSystemValue(); |
| 117 | if (!$instanceLevel && isset($idSite)) { |
| 118 | return static::getMeasurableValue($idSite); |
| 119 | } |
| 120 | return $instanceLevel; |
| 121 | } |
| 122 | public static function isConfigControlled() |
| 123 | { |
| 124 | return !is_null(static::getConfigValue()); |
| 125 | } |
| 126 | } |
| 127 |