nextcloud/lib/private/config.php

215 lines
5.4 KiB
PHP
Raw Normal View History

<?php
2011-03-12 20:19:11 +03:00
/**
* @author Frank Karlitschek
* @author Jakob Sack
2012-05-26 21:14:24 +04:00
* @copyright 2012 Frank Karlitschek frank@owncloud.org
2011-03-12 20:19:11 +03:00
*
* This file is licensed under the Affero General Public License version 3 or
* later.
* See the COPYING-README file.
*/
2011-03-12 20:19:11 +03:00
2013-03-03 15:06:00 +04:00
namespace OC;
2011-03-12 20:19:11 +03:00
/**
* This class is responsible for reading and writing config.php, the very basic
2013-06-04 02:05:38 +04:00
* configuration file of ownCloud.
2011-03-12 20:19:11 +03:00
*/
2013-03-03 15:06:00 +04:00
class Config {
/** @var array Associative array ($key => $value) */
2013-03-03 15:06:00 +04:00
protected $cache = array();
/** @var string */
2013-05-08 20:20:44 +04:00
protected $configDir;
/** @var string */
protected $configFilePath;
/** @var string */
protected $configFileName;
/** @var bool */
protected $debugMode;
2013-07-08 20:01:32 +04:00
/**
* @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
2013-07-08 20:01:32 +04:00
*/
public function __construct($configDir, $fileName = 'config.php') {
2013-05-08 20:20:44 +04:00
$this->configDir = $configDir;
$this->configFilePath = $this->configDir.$fileName;
$this->configFileName = $fileName;
2013-03-03 15:06:00 +04:00
$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;
2013-03-03 15:06:00 +04:00
}
/**
* 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
2014-05-11 21:13:51 +04:00
* @return array an array of key names
2011-03-12 20:19:11 +03:00
*
* This function returns all keys saved in config.php. Please note that it
* does not return the values.
*/
2013-03-03 15:06:00 +04:00
public function getKeys() {
2013-06-04 02:05:38 +04:00
return array_keys($this->cache);
}
/**
* Gets a value from config.php
2012-09-23 04:39:11 +04:00
* @param string $key key
2014-05-13 02:27:36 +04:00
* @param mixed $default = null default value
* @return mixed the value or $default
*
2011-03-12 20:19:11 +03:00
* This function gets the value from config.php. If it does not exist,
* $default will be returned.
*/
2013-06-04 02:05:38 +04:00
public function getValue($key, $default = null) {
if (isset($this->cache[$key])) {
2013-03-03 15:06:00 +04:00
return $this->cache[$key];
}
2011-03-12 20:19:11 +03:00
return $default;
}
/**
* Sets a value
2012-09-23 04:39:11 +04:00
* @param string $key key
2014-05-13 02:27:36 +04:00
* @param mixed $value value
2011-03-12 20:19:11 +03:00
*
2013-06-04 02:05:38 +04:00
* This function sets the value and writes the config.php.
*
2011-03-12 20:19:11 +03:00
*/
2013-06-04 02:05:38 +04:00
public function setValue($key, $value) {
// Add change
2013-03-03 15:06:00 +04:00
$this->cache[$key] = $value;
// Write changes
2013-03-03 15:06:00 +04:00
$this->writeData();
}
2011-03-12 20:19:11 +03:00
/**
* Removes a key from the config
2012-09-23 04:39:11 +04:00
* @param string $key key
2011-03-12 20:19:11 +03:00
*
2013-06-04 02:05:38 +04:00
* This function removes a key from the config.php.
*
2011-03-12 20:19:11 +03:00
*/
2013-06-04 02:05:38 +04:00
public function deleteKey($key) {
if (isset($this->cache[$key])) {
// Delete key from cache
2013-06-04 02:05:38 +04:00
unset($this->cache[$key]);
// Write changes
2013-03-03 15:06:00 +04:00
$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
*/
2013-03-03 15:06:00 +04:00
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);
2013-06-10 19:42:20 +04:00
if (is_array($extra)) {
natsort($extra);
$configFiles = array_merge($configFiles, $extra);
}
2013-06-10 19:42:20 +04:00
// Include file and merge config
2013-06-04 02:05:38 +04:00
foreach ($configFiles as $file) {
if($file === $this->configFilePath && !@touch($file)) {
// Writing to the main config might not be possible, e.g. if the wrong
// permissions are set (likely on a new installation)
2013-03-03 15:06:00 +04:00
continue;
}
$filePointer = fopen($file, 'r');
// 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));
}
2013-03-03 15:06:00 +04:00
unset($CONFIG);
include $file;
if(isset($CONFIG) && is_array($CONFIG)) {
2013-03-03 15:06:00 +04:00
$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
*/
2013-03-03 15:06:00 +04:00
private function writeData() {
// Create a php file ...
2013-03-03 15:06:00 +04:00
$content = "<?php\n";
if ($this->debugMode) {
$content .= "define('DEBUG',true);\n";
}
2013-03-03 15:06:00 +04:00
$content .= '$CONFIG = ';
$content .= var_export($this->cache, true);
2012-06-23 01:01:12 +04:00
$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');
2013-03-03 15:06:00 +04:00
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
2013-06-27 23:57:59 +04:00
\OC_Util::clearOpcodeCache();
}
}