API
5 days ago
Access
1 month ago
Application
1 month ago
Archive
1 month ago
ArchiveProcessor
5 days ago
Archiver
2 years ago
AssetManager
1 month ago
Auth
1 month ago
Category
1 month ago
Changes
3 months ago
CliMulti
1 month ago
Columns
5 days ago
Concurrency
1 month ago
Config
1 month ago
Container
3 months ago
CronArchive
1 month ago
DataAccess
5 days ago
DataFiles
2 years ago
DataTable
1 month ago
Db
5 days ago
DeviceDetector
1 year ago
Email
2 years ago
Exception
6 months ago
Http
5 days ago
Intl
5 months ago
Log
2 years ago
Mail
1 year ago
Measurable
8 months ago
Menu
1 month ago
Metrics
1 month ago
Notification
8 months ago
Period
1 month ago
Plugin
5 days ago
Policy
3 months ago
ProfessionalServices
1 year ago
Report
1 year ago
ReportRenderer
5 days ago
Request
1 month ago
Scheduler
1 month ago
Segment
1 month ago
Session
5 days ago
Settings
5 days ago
Tracker
5 days ago
Translation
3 months ago
Twig
1 year ago
UpdateCheck
5 months ago
Updater
1 month ago
Updates
2 months ago
Validators
1 year ago
View
3 months ago
ViewDataTable
5 days ago
Visualization
5 days ago
Widget
1 month ago
.htaccess
2 years ago
Access.php
1 month ago
Archive.php
3 months ago
ArchiveProcessor.php
5 days ago
AssetManager.php
1 month ago
Auth.php
8 months ago
AuthResult.php
8 months ago
BaseFactory.php
2 years ago
Cache.php
1 month ago
CacheId.php
6 months ago
CliMulti.php
1 month ago
Common.php
1 month ago
Config.php
1 month ago
Console.php
5 months ago
Context.php
2 years ago
Cookie.php
1 month ago
CronArchive.php
1 month ago
DI.php
5 months ago
DataArray.php
1 month ago
DataTable.php
5 days ago
Date.php
3 months ago
Db.php
3 months ago
DbHelper.php
1 month ago
Development.php
1 month ago
ErrorHandler.php
8 months ago
EventDispatcher.php
3 months ago
ExceptionHandler.php
6 months ago
FileIntegrity.php
1 month ago
Filechecks.php
1 year ago
Filesystem.php
5 days ago
FrontController.php
1 month ago
Http.php
5 days ago
IP.php
1 year ago
Log.php
5 months ago
LogDeleter.php
1 month ago
Mail.php
1 year ago
Metrics.php
3 months ago
NoAccessException.php
2 years ago
Nonce.php
8 months ago
Notification.php
3 months ago
NumberFormatter.php
1 month ago
Option.php
1 month ago
Period.php
1 month ago
Piwik.php
1 month ago
Plugin.php
3 months ago
Process.php
3 months ago
Profiler.php
1 month ago
ProxyHeaders.php
6 months ago
ProxyHttp.php
1 month ago
QuickForm2.php
5 months ago
RankingQuery.php
3 months ago
ReportRenderer.php
5 days ago
Request.php
3 months ago
Segment.php
5 days ago
Sequence.php
1 month ago
Session.php
2 months ago
SettingsPiwik.php
1 month ago
SettingsServer.php
1 month ago
Singleton.php
2 years ago
Site.php
3 months ago
SiteContentDetector.php
5 days ago
SupportedBrowser.php
2 years ago
TCPDF.php
1 year ago
Theme.php
1 month ago
Timer.php
1 month ago
Tracker.php
1 month ago
Twig.php
5 days ago
Unzip.php
1 year ago
UpdateCheck.php
3 months ago
Updater.php
1 month ago
UpdaterErrorException.php
2 years ago
Updates.php
1 month ago
Url.php
1 month ago
UrlHelper.php
3 months ago
Version.php
5 days ago
View.php
1 month ago
bootstrap.php
1 year ago
dispatch.php
2 years ago
testMinimumPhpVersion.php
8 months ago
Option.php
261 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; |
| 10 | |
| 11 | use Piwik\Container\StaticContainer; |
| 12 | use Piwik\Log\LoggerInterface; |
| 13 | /** |
| 14 | * Convenient key-value storage for user specified options and temporary |
| 15 | * data that needs to be persisted beyond one request. |
| 16 | * |
| 17 | * ### Examples |
| 18 | * |
| 19 | * **Setting and getting options** |
| 20 | * |
| 21 | * $optionValue = Option::get('MyPlugin.MyOptionName'); |
| 22 | * if ($optionValue === false) { |
| 23 | * // if not set, set it |
| 24 | * Option::set('MyPlugin.MyOptionName', 'my option value'); |
| 25 | * } |
| 26 | * |
| 27 | * **Storing user specific options** |
| 28 | * |
| 29 | * $userName = // ... |
| 30 | * Option::set('MyPlugin.MyOptionName.' . $userName, 'my option value'); |
| 31 | * |
| 32 | * **Clearing user specific options** |
| 33 | * |
| 34 | * Option::deleteLike('MyPlugin.MyOptionName.%'); |
| 35 | * |
| 36 | * @api |
| 37 | */ |
| 38 | class Option |
| 39 | { |
| 40 | /** |
| 41 | * Returns the option value for the requested option `$name`. |
| 42 | * |
| 43 | * @param string $name The option name. |
| 44 | * @return string|false The value or `false`, if not found. |
| 45 | */ |
| 46 | public static function get($name) |
| 47 | { |
| 48 | return self::getInstance()->getValue($name); |
| 49 | } |
| 50 | /** |
| 51 | * Returns option values for options whose names are like a given pattern. Only `%` is supported as part of the |
| 52 | * pattern. |
| 53 | * |
| 54 | * @param string $namePattern The pattern used in the SQL `LIKE` expression |
| 55 | * used to SELECT options.`'%'` characters should be used as wildcard. Underscore match is not supported. |
| 56 | * @return array Array mapping option names with option values. |
| 57 | */ |
| 58 | public static function getLike($namePattern) |
| 59 | { |
| 60 | return self::getInstance()->getNameLike($namePattern); |
| 61 | } |
| 62 | /** |
| 63 | * Sets an option value by name. |
| 64 | * |
| 65 | * @param string $name The option name. |
| 66 | * @param string $value The value to set the option to. |
| 67 | * @param int|bool $autoload If set to 1, this option value will be automatically loaded when Piwik is initialized; |
| 68 | * should be set to 1 for options that will be used in every Piwik request. |
| 69 | */ |
| 70 | public static function set($name, $value, $autoload = 0) |
| 71 | { |
| 72 | self::getInstance()->setValue($name, $value, $autoload); |
| 73 | } |
| 74 | /** |
| 75 | * Deletes an option. |
| 76 | * |
| 77 | * @param string $name Option name to match exactly. |
| 78 | * @param string $value If supplied the option will be deleted only if its value matches this value. |
| 79 | */ |
| 80 | public static function delete($name, $value = null) |
| 81 | { |
| 82 | self::getInstance()->deleteValue($name, $value); |
| 83 | } |
| 84 | /** |
| 85 | * Deletes all options that match the supplied pattern. Only `%` is supported as part of the |
| 86 | * pattern. |
| 87 | * |
| 88 | * @param string $namePattern Pattern of key to match. `'%'` characters should be used as wildcard. Underscore match is not supported. |
| 89 | * @param string $value If supplied, options will be deleted only if their value matches this value. |
| 90 | */ |
| 91 | public static function deleteLike($namePattern, $value = null) |
| 92 | { |
| 93 | self::getInstance()->deleteNameLike($namePattern, $value); |
| 94 | } |
| 95 | public static function clearCachedOption($name) |
| 96 | { |
| 97 | self::getInstance()->clearCachedOptionByName($name); |
| 98 | } |
| 99 | /** |
| 100 | * Clears the option value cache and forces a reload from the Database. |
| 101 | * Used in unit tests to reset the state of the object between tests. |
| 102 | * |
| 103 | * @return void |
| 104 | * @ignore |
| 105 | */ |
| 106 | public static function clearCache() |
| 107 | { |
| 108 | $option = self::getInstance(); |
| 109 | $option->loaded = \false; |
| 110 | $option->all = array(); |
| 111 | } |
| 112 | /** |
| 113 | * @var array |
| 114 | */ |
| 115 | private $all = array(); |
| 116 | /** |
| 117 | * @var bool |
| 118 | */ |
| 119 | private $loaded = \false; |
| 120 | /** |
| 121 | * Singleton instance |
| 122 | * @var \Piwik\Option |
| 123 | */ |
| 124 | private static $instance = null; |
| 125 | /** |
| 126 | * Returns Singleton instance |
| 127 | * |
| 128 | * @return \Piwik\Option |
| 129 | */ |
| 130 | private static function getInstance() |
| 131 | { |
| 132 | if (self::$instance == null) { |
| 133 | self::$instance = new self(); |
| 134 | } |
| 135 | return self::$instance; |
| 136 | } |
| 137 | /** |
| 138 | * Sets the singleton instance. For testing purposes. |
| 139 | * |
| 140 | * @param mixed $instance |
| 141 | * @ignore |
| 142 | */ |
| 143 | public static function setSingletonInstance($instance) |
| 144 | { |
| 145 | self::$instance = $instance; |
| 146 | } |
| 147 | /** |
| 148 | * Private Constructor |
| 149 | */ |
| 150 | private function __construct() |
| 151 | { |
| 152 | } |
| 153 | protected function clearCachedOptionByName($name) |
| 154 | { |
| 155 | $name = $this->trimOptionNameIfNeeded($name); |
| 156 | if (isset($this->all[$name])) { |
| 157 | unset($this->all[$name]); |
| 158 | } |
| 159 | } |
| 160 | protected function getValue($name) |
| 161 | { |
| 162 | $name = $this->trimOptionNameIfNeeded($name); |
| 163 | $this->autoload(); |
| 164 | if (isset($this->all[$name])) { |
| 165 | return $this->all[$name]; |
| 166 | } |
| 167 | $value = \Piwik\Db::fetchOne('SELECT option_value FROM `' . \Piwik\Common::prefixTable('option') . '` ' . 'WHERE option_name = ?', [$name]); |
| 168 | $this->all[$name] = $value; |
| 169 | return $value; |
| 170 | } |
| 171 | protected function setValue($name, $value, $autoLoad = 0) |
| 172 | { |
| 173 | $autoLoad = (int) $autoLoad; |
| 174 | $name = $this->trimOptionNameIfNeeded($name); |
| 175 | $sql = 'UPDATE `' . \Piwik\Common::prefixTable('option') . '` SET option_value = ?, autoload = ? WHERE option_name = ?'; |
| 176 | $bind = array($value, $autoLoad, $name); |
| 177 | $result = \Piwik\Db::query($sql, $bind); |
| 178 | $rowsUpdated = \Piwik\Db::get()->rowCount($result); |
| 179 | if (!$rowsUpdated) { |
| 180 | try { |
| 181 | $sql = 'INSERT IGNORE INTO `' . \Piwik\Common::prefixTable('option') . '` (option_name, option_value, autoload) ' . 'VALUES (?, ?, ?) '; |
| 182 | $bind = array($name, $value, $autoLoad); |
| 183 | \Piwik\Db::query($sql, $bind); |
| 184 | } catch (\Exception $e) { |
| 185 | } |
| 186 | } |
| 187 | $this->all[$name] = $value; |
| 188 | } |
| 189 | protected function deleteValue($name, $value) |
| 190 | { |
| 191 | $name = $this->trimOptionNameIfNeeded($name); |
| 192 | $sql = 'DELETE FROM `' . \Piwik\Common::prefixTable('option') . '` WHERE option_name = ?'; |
| 193 | $bind[] = $name; |
| 194 | if (isset($value)) { |
| 195 | $sql .= ' AND option_value = ?'; |
| 196 | $bind[] = $value; |
| 197 | } |
| 198 | \Piwik\Db::query($sql, $bind); |
| 199 | $this->clearCache(); |
| 200 | } |
| 201 | protected function deleteNameLike($name, $value = null) |
| 202 | { |
| 203 | $name = $this->trimOptionNameIfNeeded($name); |
| 204 | $name = $this->getNameForLike($name); |
| 205 | $sql = 'DELETE FROM `' . \Piwik\Common::prefixTable('option') . '` WHERE option_name LIKE ?'; |
| 206 | $bind[] = $name; |
| 207 | if (isset($value)) { |
| 208 | $sql .= ' AND option_value = ?'; |
| 209 | $bind[] = $value; |
| 210 | } |
| 211 | \Piwik\Db::query($sql, $bind); |
| 212 | $this->clearCache(); |
| 213 | } |
| 214 | private function getNameForLike($name) |
| 215 | { |
| 216 | $name = str_replace('\\_', '###NOREPLACE###', $name); |
| 217 | $name = str_replace('_', '\\_', $name); |
| 218 | $name = str_replace('###NOREPLACE###', '\\_', $name); |
| 219 | return $name; |
| 220 | } |
| 221 | protected function getNameLike($name) |
| 222 | { |
| 223 | $name = $this->trimOptionNameIfNeeded($name); |
| 224 | $name = $this->getNameForLike($name); |
| 225 | $sql = 'SELECT option_name, option_value FROM `' . \Piwik\Common::prefixTable('option') . '` WHERE option_name LIKE ?'; |
| 226 | $bind = array($name); |
| 227 | $rows = \Piwik\Db::fetchAll($sql, $bind); |
| 228 | $result = array(); |
| 229 | foreach ($rows as $row) { |
| 230 | $result[$row['option_name']] = $row['option_value']; |
| 231 | } |
| 232 | return $result; |
| 233 | } |
| 234 | /** |
| 235 | * Initialize cache with autoload settings. |
| 236 | * |
| 237 | * @return void |
| 238 | */ |
| 239 | protected function autoload() |
| 240 | { |
| 241 | if ($this->loaded) { |
| 242 | return; |
| 243 | } |
| 244 | $table = \Piwik\Common::prefixTable('option'); |
| 245 | $sql = 'SELECT option_value, option_name FROM `' . $table . '` WHERE autoload = 1'; |
| 246 | $all = \Piwik\Db::fetchAll($sql); |
| 247 | foreach ($all as $option) { |
| 248 | $this->all[$option['option_name']] = $option['option_value']; |
| 249 | } |
| 250 | $this->loaded = \true; |
| 251 | } |
| 252 | private function trimOptionNameIfNeeded($name) |
| 253 | { |
| 254 | if (strlen($name) > 191) { |
| 255 | StaticContainer::get(LoggerInterface::class)->debug("Option name '{$name}' is too long and was trimmed to 191 chars"); |
| 256 | $name = substr($name, 0, 191); |
| 257 | } |
| 258 | return $name; |
| 259 | } |
| 260 | } |
| 261 |