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
|
<?php
/**
* Manage configuration for the application.
*/
class Minz_Configuration {
/**
* The list of configurations.
*/
private static $config_list = array();
/**
* Add a new configuration to the list of configuration.
*
* @param $namespace the name of the current configuration
* @param $config_filename the filename of the configuration
* @param $default_filename a filename containing default values for the configuration
* @param $configuration_setter an optional helper to set values in configuration
*/
public static function register($namespace, $config_filename, $default_filename = null,
$configuration_setter = null) {
self::$config_list[$namespace] = new Minz_Configuration(
$namespace, $config_filename, $default_filename, $configuration_setter
);
}
/**
* Parse a file and return its data.
*
* @param $filename the name of the file to parse.
* @return an array of values
* @throws Minz_FileNotExistException if the file does not exist or is invalid.
*/
public static function load($filename) {
$data = @include($filename);
if (is_array($data)) {
return $data;
} else {
throw new Minz_FileNotExistException($filename);
}
}
/**
* Return the configuration related to a given namespace.
*
* @param $namespace the name of the configuration to get.
* @return a Minz_Configuration object
* @throws Minz_ConfigurationNamespaceException if the namespace does not exist.
*/
public static function get($namespace) {
if (!isset(self::$config_list[$namespace])) {
throw new Minz_ConfigurationNamespaceException(
$namespace . ' namespace does not exist'
);
}
return self::$config_list[$namespace];
}
/**
* The namespace of the current configuration.
*/
private $namespace = '';
/**
* The filename for the current configuration.
*/
private $config_filename = '';
/**
* The filename for the current default values, null by default.
*/
private $default_filename = null;
/**
* The configuration values, an empty array by default.
*/
private $data = array();
/**
* An object which help to set good values in configuration.
*/
private $configuration_setter = null;
public function removeExtension($ext_name) {
unset(self::$extensions_enabled[$ext_name]);
$legacyKey = array_search($ext_name, self::$extensions_enabled, true);
if ($legacyKey !== false) { //Legacy format FreshRSS < 1.11.1
unset(self::$extensions_enabled[$legacyKey]);
}
}
public function addExtension($ext_name) {
if (!isset(self::$extensions_enabled[$ext_name])) {
self::$extensions_enabled[$ext_name] = true;
}
}
/**
* Create a new Minz_Configuration object.
*
* @param $namespace the name of the current configuration.
* @param $config_filename the file containing configuration values.
* @param $default_filename the file containing default values, null by default.
* @param $configuration_setter an optional helper to set values in configuration
*/
private function __construct($namespace, $config_filename, $default_filename = null,
$configuration_setter = null) {
$this->namespace = $namespace;
$this->config_filename = $config_filename;
$this->default_filename = $default_filename;
$this->_configurationSetter($configuration_setter);
if ($this->default_filename != null) {
$this->data = self::load($this->default_filename);
}
try {
$this->data = array_replace_recursive(
$this->data, self::load($this->config_filename)
);
} catch (Minz_FileNotExistException $e) {
if ($this->default_filename == null) {
throw $e;
}
}
}
/**
* Set a configuration setter for the current configuration.
* @param $configuration_setter the setter to call when modifying data. It
* must implement an handle($key, $value) method.
*/
public function _configurationSetter($configuration_setter) {
if (is_callable(array($configuration_setter, 'handle'))) {
$this->configuration_setter = $configuration_setter;
}
}
/**
* Return the value of the given param.
*
* @param $key the name of the param.
* @param $default default value to return if key does not exist.
* @return the value corresponding to the key.
* @throws Minz_ConfigurationParamException if the param does not exist
*/
public function param($key, $default = null) {
if (isset($this->data[$key])) {
return $this->data[$key];
} elseif (!is_null($default)) {
return $default;
} else {
Minz_Log::warning($key . ' does not exist in configuration');
return null;
}
}
/**
* A wrapper for param().
*/
public function __get($key) {
return $this->param($key);
}
/**
* Set or remove a param.
*
* @param $key the param name to set.
* @param $value the value to set. If null, the key is removed from the configuration.
*/
public function _param($key, $value = null) {
if (!is_null($this->configuration_setter) && $this->configuration_setter->support($key)) {
$this->configuration_setter->handle($this->data, $key, $value);
} elseif (isset($this->data[$key]) && is_null($value)) {
unset($this->data[$key]);
} elseif (!is_null($value)) {
$this->data[$key] = $value;
}
}
/**
* A wrapper for _param().
*/
public function __set($key, $value) {
$this->_param($key, $value);
}
/**
* Save the current configuration in the configuration file.
*/
public function save() {
$back_filename = $this->config_filename . '.bak.php';
@rename($this->config_filename, $back_filename);
if (file_put_contents($this->config_filename,
"<?php\nreturn " . var_export($this->data, true) . ';',
LOCK_EX) === false) {
return false;
}
// Clear PHP 5.5+ cache for include
if (function_exists('opcache_invalidate')) {
opcache_invalidate($this->config_filename);
}
return true;
}
}
|
