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

matomo / app / core / Option.php

matomo / app / core Last commit date

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