Blame view

sources/lib/private/config.php 4.42 KB
31b7f2792   Kload   Upgrade to ownclo...
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
  <?php
  /**
   * ownCloud
   *
   * @author Frank Karlitschek
   * @author Jakob Sack
   * @copyright 2012 Frank Karlitschek frank@owncloud.org
   *
   * This library is free software; you can redistribute it and/or
   * modify it under the terms of the GNU AFFERO GENERAL PUBLIC LICENSE
   * License as published by the Free Software Foundation; either
   * version 3 of the License, or any later version.
   *
   * This library 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 along with this library.  If not, see <http://www.gnu.org/licenses/>.
   *
   */
  /*
   *
   * An example of config.php
   *
   * <?php
   * $CONFIG = array(
   *     "database" => "mysql",
   *     "firstrun" => false,
   *     "pi" => 3.14
   * );
   * ?>
   *
   */
  
  namespace OC;
  
  /**
   * This class is responsible for reading and writing config.php, the very basic
   * configuration file of ownCloud.
   */
  class Config {
  	// associative array key => value
  	protected $cache = array();
  
  	protected $configDir;
  	protected $configFilename;
  
  	protected $debugMode;
  
  	/**
6d9380f96   Cédric Dupont   Update sources OC...
53
  	 * @param string $configDir path to the config dir, needs to end with '/'
31b7f2792   Kload   Upgrade to ownclo...
54
55
56
57
58
59
60
61
62
63
64
65
66
  	 */
  	public function __construct($configDir) {
  		$this->configDir = $configDir;
  		$this->configFilename = $this->configDir.'config.php';
  		$this->readData();
  		$this->setDebugMode(defined('DEBUG') && DEBUG);
  	}
  
  	public function setDebugMode($enable) {
  		$this->debugMode = $enable;
  	}
  
  	/**
6d9380f96   Cédric Dupont   Update sources OC...
67
68
  	 * Lists all available config keys
  	 * @return array an array of key names
31b7f2792   Kload   Upgrade to ownclo...
69
70
71
72
73
74
75
76
77
  	 *
  	 * 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);
  	}
  
  	/**
6d9380f96   Cédric Dupont   Update sources OC...
78
  	 * Gets a value from config.php
31b7f2792   Kload   Upgrade to ownclo...
79
  	 * @param string $key key
6d9380f96   Cédric Dupont   Update sources OC...
80
81
  	 * @param mixed $default = null default value
  	 * @return mixed the value or $default
31b7f2792   Kload   Upgrade to ownclo...
82
83
84
85
86
87
88
89
90
91
92
93
94
  	 *
  	 * 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;
  	}
  
  	/**
6d9380f96   Cédric Dupont   Update sources OC...
95
  	 * Sets a value
31b7f2792   Kload   Upgrade to ownclo...
96
  	 * @param string $key key
6d9380f96   Cédric Dupont   Update sources OC...
97
  	 * @param mixed $value value
31b7f2792   Kload   Upgrade to ownclo...
98
99
100
101
102
103
104
105
106
107
108
109
110
  	 *
  	 * 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();
  	}
  
  	/**
6d9380f96   Cédric Dupont   Update sources OC...
111
  	 * Removes a key from the config
31b7f2792   Kload   Upgrade to ownclo...
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
  	 * @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();
  		}
  	}
  
  	/**
6d9380f96   Cédric Dupont   Update sources OC...
128
  	 * Loads the config file
31b7f2792   Kload   Upgrade to ownclo...
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
  	 *
  	 * Reads the config file and saves it to the cache
  	 */
  	private function readData() {
  		// Default config
  		$configFiles = array($this->configFilename);
  		// Add all files in the config dir ending with config.php
  		$extra = glob($this->configDir.'*.config.php');
  		if (is_array($extra)) {
  			natsort($extra);
  			$configFiles = array_merge($configFiles, $extra);
  		}
  		// Include file and merge config
  		foreach ($configFiles as $file) {
  			if (!file_exists($file)) {
  				continue;
  			}
  			unset($CONFIG);
  			// ignore errors on include, this can happen when doing a fresh install
  			@include $file;
  			if (isset($CONFIG) && is_array($CONFIG)) {
  				$this->cache = array_merge($this->cache, $CONFIG);
  			}
  		}
  	}
  
  	/**
6d9380f96   Cédric Dupont   Update sources OC...
156
  	 * Writes the config file
31b7f2792   Kload   Upgrade to ownclo...
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
  	 *
  	 * Saves the config to the config file.
  	 *
  	 */
  	private function writeData() {
  		// Create a php file ...
  		$content = "<?php
  ";
  		if ($this->debugMode) {
  			$content .= "define('DEBUG',true);
  ";
  		}
  		$content .= '$CONFIG = ';
  		$content .= var_export($this->cache, true);
  		$content .= ";
  ";
  
  		// Write the file
  		$result = @file_put_contents($this->configFilename, $content);
  		if (!$result) {
  			$defaults = new \OC_Defaults;
837968727   Kload   [enh] Upgrade to ...
178
  			$url = \OC_Helper::linkToDocs('admin-dir_permissions');
31b7f2792   Kload   Upgrade to ownclo...
179
180
181
182
183
184
185
186
187
188
  			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>.');
  		}
  		// Prevent others not to read the config
  		@chmod($this->configFilename, 0640);
  		\OC_Util::clearOpcodeCache();
  	}
  }