Option.php — Matomo Analytics – Powerful, Privacy-First Insights for WordPress 5.0.7

matomo / app / core / Option.php

matomo / app / core Last commit date

API 2 years ago Access 2 years ago Application 2 years ago Archive 2 years ago ArchiveProcessor 2 years ago Archiver 2 years ago AssetManager 2 years ago Auth 2 years ago Category 2 years ago Changes 2 years ago CliMulti 2 years ago Columns 2 years ago Concurrency 2 years ago Config 2 years ago Container 2 years ago CronArchive 2 years ago DataAccess 2 years ago DataFiles 2 years ago DataTable 2 years ago Db 2 years ago DeviceDetector 2 years ago Email 2 years ago Exception 2 years ago Http 2 years ago Intl 2 years ago Log 2 years ago Mail 2 years ago Measurable 2 years ago Menu 2 years ago Metrics 2 years ago Notification 2 years ago Period 2 years ago Plugin 2 years ago ProfessionalServices 2 years ago Report 2 years ago ReportRenderer 2 years ago Scheduler 2 years ago Segment 2 years ago Session 2 years ago Settings 2 years ago Tracker 2 years ago Translation 2 years ago Twig 2 years ago UpdateCheck 2 years ago Updater 2 years ago Updates 2 years ago Validators 2 years ago View 2 years ago ViewDataTable 2 years ago Visualization 2 years ago Widget 2 years ago .htaccess 2 years ago Access.php 2 years ago Archive.php 2 years ago ArchiveProcessor.php 2 years ago AssetManager.php 2 years ago Auth.php 2 years ago AuthResult.php 2 years ago BaseFactory.php 2 years ago Cache.php 2 years ago CacheId.php 2 years ago CliMulti.php 2 years ago Common.php 2 years ago Config.php 2 years ago Console.php 2 years ago Context.php 2 years ago Cookie.php 2 years ago CronArchive.php 2 years ago DI.php 2 years ago DataArray.php 2 years ago DataTable.php 2 years ago Date.php 2 years ago Db.php 2 years ago DbHelper.php 2 years ago Development.php 2 years ago ErrorHandler.php 2 years ago EventDispatcher.php 2 years ago ExceptionHandler.php 2 years ago FileIntegrity.php 2 years ago Filechecks.php 2 years ago Filesystem.php 2 years ago FrontController.php 2 years ago Http.php 2 years ago IP.php 2 years ago Log.php 2 years ago LogDeleter.php 2 years ago Mail.php 2 years ago Metrics.php 2 years ago NoAccessException.php 2 years ago Nonce.php 2 years ago Notification.php 2 years ago NumberFormatter.php 2 years ago Option.php 2 years ago Period.php 2 years ago Piwik.php 2 years ago Plugin.php 2 years ago Profiler.php 2 years ago ProxyHeaders.php 2 years ago ProxyHttp.php 2 years ago QuickForm2.php 2 years ago RankingQuery.php 2 years ago ReportRenderer.php 2 years ago Request.php 2 years ago Segment.php 2 years ago Sequence.php 2 years ago Session.php 2 years ago SettingsPiwik.php 2 years ago SettingsServer.php 2 years ago Singleton.php 2 years ago Site.php 2 years ago SiteContentDetector.php 2 years ago SupportedBrowser.php 2 years ago TCPDF.php 2 years ago Theme.php 2 years ago Timer.php 2 years ago Tracker.php 2 years ago Twig.php 2 years ago Unzip.php 2 years ago UpdateCheck.php 2 years ago Updater.php 2 years ago UpdaterErrorException.php 2 years ago Updates.php 2 years ago Url.php 2 years ago UrlHelper.php 2 years ago Version.php 2 years ago View.php 2 years ago bootstrap.php 2 years ago dispatch.php 2 years ago testMinimumPhpVersion.php 2 years ago

Option.php

262 lines

1	<?php
2
3	/**
4	* Matomo - free/libre analytics platform
5	*
6	* @link https://matomo.org
7	* @license http://www.gnu.org/licenses/gpl-3.0.html GPL v3 or later
8	*
9	*/
10	namespace Piwik;
11
12	use Piwik\Container\StaticContainer;
13	use Piwik\Log\LoggerInterface;
14	/**
15	* Convenient key-value storage for user specified options and temporary
16	* data that needs to be persisted beyond one request.
17	*
18	* ### Examples
19	*
20	* Setting and getting options
21	*
22	* $optionValue = Option::get('MyPlugin.MyOptionName');
23	* if ($optionValue === false) {
24	* // if not set, set it
25	* Option::set('MyPlugin.MyOptionName', 'my option value');
26	* }
27	*
28	* Storing user specific options
29	*
30	* $userName = // ...
31	* Option::set('MyPlugin.MyOptionName.' . $userName, 'my option value');
32	*
33	* Clearing user specific options
34	*
35	* Option::deleteLike('MyPlugin.MyOptionName.%');
36	*
37	* @api
38	*/
39	class Option
40	{
41	/**
42	* Returns the option value for the requested option `$name`.
43	*
44	* @param string $name The option name.
45	* @return string\|false The value or `false`, if not found.
46	*/
47	public static function get($name)
48	{
49	return self::getInstance()->getValue($name);
50	}
51	/**
52	* Returns option values for options whose names are like a given pattern. Only `%` is supported as part of the
53	* pattern.
54	*
55	* @param string $namePattern The pattern used in the SQL `LIKE` expression
56	* used to SELECT options.`'%'` characters should be used as wildcard. Underscore match is not supported.
57	* @return array Array mapping option names with option values.
58	*/
59	public static function getLike($namePattern)
60	{
61	return self::getInstance()->getNameLike($namePattern);
62	}
63	/**
64	* Sets an option value by name.
65	*
66	* @param string $name The option name.
67	* @param string $value The value to set the option to.
68	* @param int $autoLoad If set to 1, this option value will be automatically loaded when Piwik is initialized;
69	* should be set to 1 for options that will be used in every Piwik request.
70	*/
71	public static function set($name, $value, $autoload = 0)
72	{
73	self::getInstance()->setValue($name, $value, $autoload);
74	}
75	/**
76	* Deletes an option.
77	*
78	* @param string $name Option name to match exactly.
79	* @param string $value If supplied the option will be deleted only if its value matches this value.
80	*/
81	public static function delete($name, $value = null)
82	{
83	self::getInstance()->deleteValue($name, $value);
84	}
85	/**
86	* Deletes all options that match the supplied pattern. Only `%` is supported as part of the
87	* pattern.
88	*
89	* @param string $namePattern Pattern of key to match. `'%'` characters should be used as wildcard. Underscore match is not supported.
90	* @param string $value If supplied, options will be deleted only if their value matches this value.
91	*/
92	public static function deleteLike($namePattern, $value = null)
93	{
94	self::getInstance()->deleteNameLike($namePattern, $value);
95	}
96	public static function clearCachedOption($name)
97	{
98	self::getInstance()->clearCachedOptionByName($name);
99	}
100	/**
101	* Clears the option value cache and forces a reload from the Database.
102	* Used in unit tests to reset the state of the object between tests.
103	*
104	* @return void
105	* @ignore
106	*/
107	public static function clearCache()
108	{
109	$option = self::getInstance();
110	$option->loaded = false;
111	$option->all = array();
112	}
113	/**
114	* @var array
115	*/
116	private $all = array();
117	/**
118	* @var bool
119	*/
120	private $loaded = false;
121	/**
122	* Singleton instance
123	* @var \Piwik\Option
124	*/
125	private static $instance = null;
126	/**
127	* Returns Singleton instance
128	*
129	* @return \Piwik\Option
130	*/
131	private static function getInstance()
132	{
133	if (self::$instance == null) {
134	self::$instance = new self();
135	}
136	return self::$instance;
137	}
138	/**
139	* Sets the singleton instance. For testing purposes.
140	*
141	* @param mixed
142	* @ignore
143	*/
144	public static function setSingletonInstance($instance)
145	{
146	self::$instance = $instance;
147	}
148	/**
149	* Private Constructor
150	*/
151	private function __construct()
152	{
153	}
154	protected function clearCachedOptionByName($name)
155	{
156	$name = $this->trimOptionNameIfNeeded($name);
157	if (isset($this->all[$name])) {
158	unset($this->all[$name]);
159	}
160	}
161	protected function getValue($name)
162	{
163	$name = $this->trimOptionNameIfNeeded($name);
164	$this->autoload();
165	if (isset($this->all[$name])) {
166	return $this->all[$name];
167	}
168	$value = \Piwik\Db::fetchOne('SELECT option_value FROM `' . \Piwik\Common::prefixTable('option') . '` ' . 'WHERE option_name = ?', [$name]);
169	$this->all[$name] = $value;
170	return $value;
171	}
172	protected function setValue($name, $value, $autoLoad = 0)
173	{
174	$autoLoad = (int) $autoLoad;
175	$name = $this->trimOptionNameIfNeeded($name);
176	$sql = 'UPDATE `' . \Piwik\Common::prefixTable('option') . '` SET option_value = ?, autoload = ? WHERE option_name = ?';
177	$bind = array($value, $autoLoad, $name);
178	$result = \Piwik\Db::query($sql, $bind);
179	$rowsUpdated = \Piwik\Db::get()->rowCount($result);
180	if (!$rowsUpdated) {
181	try {
182	$sql = 'INSERT IGNORE INTO `' . \Piwik\Common::prefixTable('option') . '` (option_name, option_value, autoload) ' . 'VALUES (?, ?, ?) ';
183	$bind = array($name, $value, $autoLoad);
184	\Piwik\Db::query($sql, $bind);
185	} catch (\Exception $e) {
186	}
187	}
188	$this->all[$name] = $value;
189	}
190	protected function deleteValue($name, $value)
191	{
192	$name = $this->trimOptionNameIfNeeded($name);
193	$sql = 'DELETE FROM `' . \Piwik\Common::prefixTable('option') . '` WHERE option_name = ?';
194	$bind[] = $name;
195	if (isset($value)) {
196	$sql .= ' AND option_value = ?';
197	$bind[] = $value;
198	}
199	\Piwik\Db::query($sql, $bind);
200	$this->clearCache();
201	}
202	protected function deleteNameLike($name, $value = null)
203	{
204	$name = $this->trimOptionNameIfNeeded($name);
205	$name = $this->getNameForLike($name);
206	$sql = 'DELETE FROM `' . \Piwik\Common::prefixTable('option') . '` WHERE option_name LIKE ?';
207	$bind[] = $name;
208	if (isset($value)) {
209	$sql .= ' AND option_value = ?';
210	$bind[] = $value;
211	}
212	\Piwik\Db::query($sql, $bind);
213	$this->clearCache();
214	}
215	private function getNameForLike($name)
216	{
217	$name = str_replace('\\_', '###NOREPLACE###', $name);
218	$name = str_replace('_', '\\_', $name);
219	$name = str_replace('###NOREPLACE###', '\\_', $name);
220	return $name;
221	}
222	protected function getNameLike($name)
223	{
224	$name = $this->trimOptionNameIfNeeded($name);
225	$name = $this->getNameForLike($name);
226	$sql = 'SELECT option_name, option_value FROM `' . \Piwik\Common::prefixTable('option') . '` WHERE option_name LIKE ?';
227	$bind = array($name);
228	$rows = \Piwik\Db::fetchAll($sql, $bind);
229	$result = array();
230	foreach ($rows as $row) {
231	$result[$row['option_name']] = $row['option_value'];
232	}
233	return $result;
234	}
235	/**
236	* Initialize cache with autoload settings.
237	*
238	* @return void
239	*/
240	protected function autoload()
241	{
242	if ($this->loaded) {
243	return;
244	}
245	$table = \Piwik\Common::prefixTable('option');
246	$sql = 'SELECT option_value, option_name FROM `' . $table . '` WHERE autoload = 1';
247	$all = \Piwik\Db::fetchAll($sql);
248	foreach ($all as $option) {
249	$this->all[$option['option_name']] = $option['option_value'];
250	}
251	$this->loaded = true;
252	}
253	private function trimOptionNameIfNeeded($name)
254	{
255	if (strlen($name) > 191) {
256	StaticContainer::get(LoggerInterface::class)->debug("Option name '{$name}' is too long and was trimmed to 191 chars");
257	$name = substr($name, 0, 191);
258	}
259	return $name;
260	}
261	}
262