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
|
<?php
/**
* @author Frank Karlitschek
* @author Jakob Sack
* @copyright 2012 Frank Karlitschek frank@owncloud.org
*
* This file is licensed under the Affero General Public License version 3 or
* later.
* See the COPYING-README file.
*/
namespace OC;
/**
* This class is responsible for reading and writing config.php, the very basic
* configuration file of ownCloud.
*/
class Config {
/** @var array Associative array ($key => $value) */
protected $cache = array();
/** @var string */
protected $configDir;
/** @var string */
protected $configFilePath;
/** @var string */
protected $configFileName;
/** @var bool */
protected $debugMode;
/**
* @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->debugMode = (defined('DEBUG') && DEBUG);
}
/**
* Enables or disables the debug mode
* @param bool $state True to enable, false to disable
*/
public function setDebugMode($state) {
$this->debugMode = $state;
$this->writeData();
$this->cache;
}
/**
* Returns whether the debug mode is enabled or disabled
* @return bool True when enabled, false otherwise
*/
public function isDebugMode() {
return $this->debugMode;
}
/**
* Lists all available config keys
* @return array an array of key names
*
* This function returns all keys saved in config.php. Please note that it
* does not return the values.
*/
public function getKeys() {
return array_keys($this->cache);
}
/**
* Gets a value from config.php
* @param string $key key
* @param mixed $default = null default value
* @return mixed the value or $default
*
* This function gets the value from config.php. If it does not exist,
* $default will be returned.
*/
public function getValue($key, $default = null) {
if (isset($this->cache[$key])) {
return $this->cache[$key];
}
return $default;
}
/**
* Sets a value
* @param string $key key
* @param mixed $value value
*
* This function sets the value and writes the config.php.
*
*/
public function setValue($key, $value) {
// Add change
$this->cache[$key] = $value;
// Write changes
$this->writeData();
}
/**
* Removes a key from the config
* @param string $key key
*
* This function removes a key from the config.php.
*
*/
public function deleteKey($key) {
if (isset($this->cache[$key])) {
// Delete key from cache
unset($this->cache[$key]);
// Write changes
$this->writeData();
}
}
/**
* 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 = array($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) {
$filePointer = @fopen($file, 'r');
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;
}
// Try to acquire a file lock
if(!flock($filePointer, LOCK_SH)) {
throw new \Exception(sprintf('Could not acquire a shared lock on the config file %s', $file));
}
unset($CONFIG);
include $file;
if(isset($CONFIG) && is_array($CONFIG)) {
$this->cache = array_merge($this->cache, $CONFIG);
}
// Close the file pointer and release the lock
flock($filePointer, LOCK_UN);
fclose($filePointer);
}
}
/**
* Writes the config file
*
* Saves the config to the config file.
*
* @throws HintException If the config file cannot be written to
* @throws \Exception If no file lock can be acquired
*/
private function writeData() {
// Create a php file ...
$content = "<?php\n";
if ($this->debugMode) {
$content .= "define('DEBUG',true);\n";
}
$content .= '$CONFIG = ';
$content .= var_export($this->cache, true);
$content .= ";\n";
touch ($this->configFilePath);
$filePointer = fopen($this->configFilePath, 'r+');
// Prevent others not to read the config
chmod($this->configFilePath, 0640);
// File does not exist, this can happen when doing a fresh install
if(!is_resource ($filePointer)) {
$url = \OC_Helper::linkToDocs('admin-dir_permissions');
throw new HintException(
"Can't write into config directory!",
'This can usually be fixed by '
.'<a href="' . $url . '" target="_blank">giving the webserver write access to the config directory</a>.');
}
// Try to acquire a file lock
if(!flock($filePointer, LOCK_EX)) {
throw new \Exception(sprintf('Could not acquire an exclusive lock on the config file %s', $this->configFilePath));
}
// Write the config and release the lock
ftruncate ($filePointer, 0);
fwrite($filePointer, $content);
fflush($filePointer);
flock($filePointer, LOCK_UN);
fclose($filePointer);
// Clear the opcode cache
\OC_Util::clearOpcodeCache();
}
}
|
