nextcloud/lib/config.php

189 lines
4.6 KiB
PHP
Raw Normal View History

<?php
2011-03-12 20:19:11 +03:00
/**
* ownCloud
*
* @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 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
* );
* ?>
*
*/
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 {
2011-03-12 20:19:11 +03:00
// associative array key => value
2013-03-03 15:06:00 +04:00
protected $cache = array();
2013-05-08 20:20:44 +04:00
protected $configDir;
protected $configFilename;
2011-03-12 20:19:11 +03:00
protected $debugMode;
2013-07-08 20:01:32 +04:00
/**
* @param $configDir path to the config dir, needs to end with '/'
*/
public function __construct($configDir) {
2013-05-08 20:20:44 +04:00
$this->configDir = $configDir;
$this->configFilename = $this->configDir.'config.php';
2013-03-03 15:06:00 +04:00
$this->readData();
$this->setDebugMode(defined('DEBUG') && DEBUG);
2013-03-03 15:06:00 +04:00
}
public function setDebugMode($enable) {
$this->debugMode = $enable;
}
/**
2011-03-12 20:19:11 +03:00
* @brief Lists all available config keys
2012-09-23 04:39:11 +04:00
* @return array with 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);
}
/**
2011-03-12 20:19:11 +03:00
* @brief Gets a value from config.php
2012-09-23 04:39:11 +04:00
* @param string $key key
* @param string $default = null default value
* @return string 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;
}
/**
2011-03-12 20:19:11 +03:00
* @brief Sets a value
2012-09-23 04:39:11 +04:00
* @param string $key key
* @param string $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
/**
2011-03-12 20:19:11 +03:00
* @brief 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();
}
}
/**
* @brief Loads the config file
*
* Reads the config file and saves it to the cache
*/
2013-03-03 15:06:00 +04:00
private function readData() {
2013-06-10 19:42:20 +04:00
// 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
2013-06-04 02:05:38 +04:00
foreach ($configFiles as $file) {
2013-06-28 00:23:53 +04:00
if (!file_exists($file)) {
2013-03-03 15:06:00 +04:00
continue;
}
unset($CONFIG);
if((@include $file) === false)
{
throw new HintException("Can't read from config file '" . $file . "'. ".
'This is usually caused by the wrong file permission.');
}
2013-06-04 02:05:38 +04:00
if (isset($CONFIG) && is_array($CONFIG)) {
2013-03-03 15:06:00 +04:00
$this->cache = array_merge($this->cache, $CONFIG);
}
}
}
/**
* @brief Writes the config file
*
* Saves the config to the config file.
*
*/
2013-03-03 15:06:00 +04:00
private function writeData() {
// Create a php file ...
2013-07-08 20:29:43 +04:00
$defaults = new \OC_Defaults;
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";
// Write the file
2013-06-04 02:17:32 +04:00
$result = @file_put_contents($this->configFilename, $content);
2013-06-04 02:05:38 +04:00
if (!$result) {
$url = $defaults->getDocBaseUrl() . '/server/5.0/admin_manual/installation/installation_source.html#set-the-directory-permissions';
2013-03-03 15:06:00 +04:00
throw new HintException(
"Can't write into config directory 'config'",
'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
2013-05-08 20:20:44 +04:00
@chmod($this->configFilename, 0640);
2013-06-27 23:57:59 +04:00
\OC_Util::clearOpcodeCache();
}
}