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
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
|
<?php
/**
* @copyright Copyright (c) 2016, ownCloud, Inc.
*
* @author Adam Williamson <awilliam@redhat.com>
* @author Aldo "xoen" Giambelluca <xoen@xoen.org>
* @author Bart Visscher <bartv@thisnet.nl>
* @author Brice Maron <brice@bmaron.net>
* @author Christoph Wurst <christoph@winzerhof-wurst.at>
* @author Daniel Kesselberg <mail@danielkesselberg.de>
* @author Frank Karlitschek <frank@karlitschek.de>
* @author Jakob Sack <mail@jakobsack.de>
* @author Jan-Christoph Borchardt <hey@jancborchardt.net>
* @author Joas Schilling <coding@schilljs.com>
* @author John Molakvoæ <skjnldsv@protonmail.com>
* @author Lukas Reschke <lukas@statuscode.ch>
* @author Michael Gapczynski <GapczynskiM@gmail.com>
* @author Morris Jobke <hey@morrisjobke.de>
* @author Philipp Schaffrath <github@philipp.schaffrath.email>
* @author Robin Appelman <robin@icewind.nl>
* @author Robin McCorkell <robin@mccorkell.me.uk>
* @author Roeland Jago Douma <roeland@famdouma.nl>
*
* @license AGPL-3.0
*
* This code is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License, version 3,
* as published by the Free Software Foundation.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License, version 3,
* along with this program. If not, see <http://www.gnu.org/licenses/>
*
*/
namespace OC;
use OCP\HintException;
/**
* This class is responsible for reading and writing config.php, the very basic
* configuration file of Nextcloud.
*/
class Config {
public const ENV_PREFIX = 'NC_';
/** @var array Associative array ($key => $value) */
protected $cache = [];
/** @var array */
protected $envCache = [];
/** @var string */
protected $configDir;
/** @var string */
protected $configFilePath;
/** @var string */
protected $configFileName;
/** @var bool */
protected $isReadOnly;
/**
* @param string $configDir Path to the config dir, needs to end with '/'
* @param string $fileName (Optional) Name of the config file. Defaults to config.php
*/
public function __construct($configDir, $fileName = 'config.php') {
$this->configDir = $configDir;
$this->configFilePath = $this->configDir.$fileName;
$this->configFileName = $fileName;
$this->readData();
$this->isReadOnly = $this->getValue('config_is_read_only', false);
}
/**
* Lists all available config keys
*
* Please note that it does not return the values.
*
* @return array an array of key names
*/
public function getKeys() {
return array_keys($this->cache);
}
/**
* Returns a config value
*
* gets its value from an `NC_` prefixed environment variable
* if it doesn't exist from config.php
* if this doesn't exist either, it will return the given `$default`
*
* @param string $key key
* @param mixed $default = null default value
* @return mixed the value or $default
*/
public function getValue($key, $default = null) {
$envKey = self::ENV_PREFIX . $key;
if (isset($this->envCache[$envKey])) {
return $this->envCache[$envKey];
}
if (isset($this->cache[$key])) {
return $this->cache[$key];
}
return $default;
}
/**
* Sets and deletes values and writes the config.php
*
* @param array $configs Associative array with `key => value` pairs
* If value is null, the config key will be deleted
* @throws HintException
*/
public function setValues(array $configs) {
$needsUpdate = false;
foreach ($configs as $key => $value) {
if ($value !== null) {
$needsUpdate |= $this->set($key, $value);
} else {
$needsUpdate |= $this->delete($key);
}
}
if ($needsUpdate) {
// Write changes
$this->writeData();
}
}
/**
* Sets the value and writes it to config.php if required
*
* @param string $key key
* @param mixed $value value
* @throws HintException
*/
public function setValue($key, $value) {
if ($this->set($key, $value)) {
// Write changes
$this->writeData();
}
}
/**
* This function sets the value
*
* @param string $key key
* @param mixed $value value
* @return bool True if the file needs to be updated, false otherwise
* @throws HintException
*/
protected function set($key, $value) {
$this->checkReadOnly();
if (!isset($this->cache[$key]) || $this->cache[$key] !== $value) {
// Add change
$this->cache[$key] = $value;
return true;
}
return false;
}
/**
* Removes a key from the config and removes it from config.php if required
*
* @param string $key
* @throws HintException
*/
public function deleteKey($key) {
if ($this->delete($key)) {
// Write changes
$this->writeData();
}
}
/**
* This function removes a key from the config
*
* @param string $key
* @return bool True if the file needs to be updated, false otherwise
* @throws HintException
*/
protected function delete($key) {
$this->checkReadOnly();
if (isset($this->cache[$key])) {
// Delete key from cache
unset($this->cache[$key]);
return true;
}
return false;
}
/**
* Loads the config file
*
* Reads the config file and saves it to the cache
*
* @throws \Exception If no lock could be acquired or the config file has not been found
*/
private function readData() {
// Default config should always get loaded
$configFiles = [$this->configFilePath];
// Add all files in the config dir ending with the same file name
$extra = glob($this->configDir.'*.'.$this->configFileName);
if (is_array($extra)) {
natsort($extra);
$configFiles = array_merge($configFiles, $extra);
}
// Include file and merge config
foreach ($configFiles as $file) {
$fileExistsAndIsReadable = file_exists($file) && is_readable($file);
$filePointer = $fileExistsAndIsReadable ? fopen($file, 'r') : false;
if ($file === $this->configFilePath &&
$filePointer === false) {
// Opening the main config might not be possible, e.g. if the wrong
// permissions are set (likely on a new installation)
continue;
}
unset($CONFIG);
include $file;
if (!defined('PHPUNIT_RUN') && headers_sent()) {
// syntax issues in the config file like leading spaces causing PHP to send output
$errorMessage = sprintf('Config file has leading content, please remove everything before "<?php" in %s', basename($file));
if (!defined('OC_CONSOLE')) {
print(\OCP\Util::sanitizeHTML($errorMessage));
}
throw new \Exception($errorMessage);
}
if (isset($CONFIG) && is_array($CONFIG)) {
$this->cache = array_merge($this->cache, $CONFIG);
}
// Close the file pointer and release the lock
fclose($filePointer);
}
$this->envCache = getenv();
}
/**
* Writes the config file
*
* Saves the config to the config file.
*
* @throws HintException If the config file cannot be written to, etc
*/
private function writeData() {
$this->checkReadOnly();
// Create a php file ...
$content = "<?php\n";
$content .= '$CONFIG = ';
$content .= var_export($this->cache, true);
$content .= ";\n";
// tmpfile must be in the same filesystem for the rename() to be atomic
$tmpfile = tempnam(dirname($this->configFilePath), 'config.php.tmp.');
// dirname check is for PHP's fallback quirk
if (!$tmpfile || dirname($tmpfile) != dirname($this->configFilePath)) {
if ($tmpfile) {
unlink($tmpfile);
}
throw new HintException(
"Can't create temporary file in config directory!",
'This can usually be fixed by giving the webserver write access to the config directory.');
}
chmod($tmpfile, 0640);
$filePointer = fopen($tmpfile, 'w');
if (!is_resource($filePointer)) {
throw new HintException(
"Failed to open temporary file in config directory for writing",
'Please report this to Nextcloud developers.');
}
$write_ok = fwrite($filePointer, $content);
$close_ok = fclose($filePointer);
if (!$write_ok || !$close_ok) {
unlink($tmpfile);
throw new HintException(
"Failed to save temporary file in config directory",
'Please report this to Nextcloud developers.');
}
if (!rename($tmpfile, $this->configFilePath)) {
unlink($tmpfile);
throw new HintException(
"Failed to replace the config file with the new copy",
'Please report this to Nextcloud developers.');
}
if (function_exists('opcache_invalidate')) {
@opcache_invalidate($this->configFilePath, true);
}
}
/**
* @throws HintException
*/
private function checkReadOnly(): void {
if ($this->isReadOnly) {
throw new HintException(
'Config is set to be read-only via option "config_is_read_only".',
'Unset "config_is_read_only" to allow changes to the config file.');
}
}
}
|