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
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
|
<?php
/**
* Piwik - free/libre analytics platform
*
* @link https://matomo.org
* @license http://www.gnu.org/licenses/gpl-3.0.html GPL v3 or later
*
*/
namespace Piwik;
/**
* Convenient key-value storage for user specified options and temporary
* data that needs to be persisted beyond one request.
*
* ### Examples
*
* **Setting and getting options**
*
* $optionValue = Option::get('MyPlugin.MyOptionName');
* if ($optionValue === false) {
* // if not set, set it
* Option::set('MyPlugin.MyOptionName', 'my option value');
* }
*
* **Storing user specific options**
*
* $userName = // ...
* Option::set('MyPlugin.MyOptionName.' . $userName, 'my option value');
*
* **Clearing user specific options**
*
* Option::deleteLike('MyPlugin.MyOptionName.%');
*
* @api
*/
class Option
{
/**
* Returns the option value for the requested option `$name`.
*
* @param string $name The option name.
* @return string|false The value or `false`, if not found.
*/
public static function get($name)
{
return self::getInstance()->getValue($name);
}
/**
* Returns option values for options whose names are like a given pattern. Only `%` is supported as part of the
* pattern.
*
* @param string $namePattern The pattern used in the SQL `LIKE` expression
* used to SELECT options.`'%'` characters should be used as wildcard. Underscore match is not supported.
* @return array Array mapping option names with option values.
*/
public static function getLike($namePattern)
{
return self::getInstance()->getNameLike($namePattern);
}
/**
* Sets an option value by name.
*
* @param string $name The option name.
* @param string $value The value to set the option to.
* @param int $autoLoad If set to 1, this option value will be automatically loaded when Piwik is initialzed;
* should be set to 1 for options that will be used in every Piwik request.
*/
public static function set($name, $value, $autoload = 0)
{
self::getInstance()->setValue($name, $value, $autoload);
}
/**
* Deletes an option.
*
* @param string $name Option name to match exactly.
* @param string $value If supplied the option will be deleted only if its value matches this value.
*/
public static function delete($name, $value = null)
{
self::getInstance()->deleteValue($name, $value);
}
/**
* Deletes all options that match the supplied pattern. Only `%` is supported as part of the
* pattern.
*
* @param string $namePattern Pattern of key to match. `'%'` characters should be used as wildcard. Underscore match is not supported.
* @param string $value If supplied, options will be deleted only if their value matches this value.
*/
public static function deleteLike($namePattern, $value = null)
{
self::getInstance()->deleteNameLike($namePattern, $value);
}
public static function clearCachedOption($name)
{
self::getInstance()->clearCachedOptionByName($name);
}
/**
* Clears the option value cache and forces a reload from the Database.
* Used in unit tests to reset the state of the object between tests.
*
* @return void
* @ignore
*/
public static function clearCache()
{
$option = self::getInstance();
$option->loaded = false;
$option->all = array();
}
/**
* @var array
*/
private $all = array();
/**
* @var bool
*/
private $loaded = false;
/**
* Singleton instance
* @var \Piwik\Option
*/
private static $instance = null;
/**
* Returns Singleton instance
*
* @return \Piwik\Option
*/
private static function getInstance()
{
if (self::$instance == null) {
self::$instance = new self;
}
return self::$instance;
}
/**
* Sets the singleton instance. For testing purposes.
*
* @param mixed
* @ignore
*/
public static function setSingletonInstance($instance)
{
self::$instance = $instance;
}
/**
* Private Constructor
*/
private function __construct()
{
}
protected function clearCachedOptionByName($name)
{
if (isset($this->all[$name])) {
unset($this->all[$name]);
}
}
protected function getValue($name)
{
$this->autoload();
if (isset($this->all[$name])) {
return $this->all[$name];
}
$value = Db::fetchOne('SELECT option_value FROM `' . Common::prefixTable('option') . '` ' .
'WHERE option_name = ?', $name);
$this->all[$name] = $value;
return $value;
}
protected function setValue($name, $value, $autoLoad = 0)
{
$autoLoad = (int)$autoLoad;
$sql = 'UPDATE `' . Common::prefixTable('option') . '` SET option_value = ?, autoload = ? WHERE option_name = ?';
$bind = array($value, $autoLoad, $name);
$result = Db::query($sql, $bind);
$rowsUpdated = Db::get()->rowCount($result);
if (! $rowsUpdated) {
try {
$sql = 'INSERT IGNORE INTO `' . Common::prefixTable('option') . '` (option_name, option_value, autoload) ' .
'VALUES (?, ?, ?) ';
$bind = array($name, $value, $autoLoad);
Db::query($sql, $bind);
} catch (\Exception $e) {
}
}
$this->all[$name] = $value;
}
protected function deleteValue($name, $value)
{
$sql = 'DELETE FROM `' . Common::prefixTable('option') . '` WHERE option_name = ?';
$bind[] = $name;
if (isset($value)) {
$sql .= ' AND option_value = ?';
$bind[] = $value;
}
Db::query($sql, $bind);
$this->clearCache();
}
protected function deleteNameLike($name, $value = null)
{
$name = $this->getNameForLike($name);
$sql = 'DELETE FROM `' . Common::prefixTable('option') . '` WHERE option_name LIKE ?';
$bind[] = $name;
if (isset($value)) {
$sql .= ' AND option_value = ?';
$bind[] = $value;
}
Db::query($sql, $bind);
$this->clearCache();
}
private function getNameForLike($name)
{
$name = str_replace('\_', '###NOREPLACE###', $name);
$name = str_replace('_', '\_', $name);
$name = str_replace( '###NOREPLACE###', '\_', $name);
return $name;
}
protected function getNameLike($name)
{
$name = $this->getNameForLike($name);
$sql = 'SELECT option_name, option_value FROM `' . Common::prefixTable('option') . '` WHERE option_name LIKE ?';
$bind = array($name);
$rows = Db::fetchAll($sql, $bind);
$result = array();
foreach ($rows as $row) {
$result[$row['option_name']] = $row['option_value'];
}
return $result;
}
/**
* Initialize cache with autoload settings.
*
* @return void
*/
protected function autoload()
{
if ($this->loaded) {
return;
}
$table = Common::prefixTable('option');
$sql = 'SELECT option_value, option_name FROM `' . $table . '` WHERE autoload = 1';
$all = Db::fetchAll($sql);
foreach ($all as $option) {
$this->all[$option['option_name']] = $option['option_value'];
}
$this->loaded = true;
}
}
|