nextcloud/lib/private/Config.php

271 lines
7.4 KiB
PHP
Raw Normal View History

<?php
2011-03-12 20:19:11 +03:00
/**
2016-07-21 18:07:57 +03:00
* @copyright Copyright (c) 2016, ownCloud, Inc.
*
2015-03-26 13:44:34 +03:00
* @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>
2016-05-26 20:56:05 +03:00
* @author Frank Karlitschek <frank@karlitschek.de>
2015-03-26 13:44:34 +03:00
* @author Jakob Sack <mail@jakobsack.de>
* @author Jan-Christoph Borchardt <hey@jancborchardt.net>
2016-07-21 18:07:57 +03:00
* @author Joas Schilling <coding@schilljs.com>
2016-05-26 20:56:05 +03:00
* @author Lukas Reschke <lukas@statuscode.ch>
2015-03-26 13:44:34 +03:00
* @author Michael Gapczynski <GapczynskiM@gmail.com>
* @author Morris Jobke <hey@morrisjobke.de>
* @author Philipp Schaffrath <github@philipp.schaffrath.email>
2016-07-21 19:13:36 +03:00
* @author Robin Appelman <robin@icewind.nl>
2016-01-12 17:02:16 +03:00
* @author Robin McCorkell <robin@mccorkell.me.uk>
2015-03-26 13:44:34 +03:00
*
* @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/>
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
* configuration file of Nextcloud.
2011-03-12 20:19:11 +03:00
*/
2013-03-03 15:06:00 +04:00
class Config {
public const ENV_PREFIX = 'NC_';
/** @var array Associative array ($key => $value) */
protected $cache = [];
/** @var string */
2013-05-08 20:20:44 +04:00
protected $configDir;
/** @var string */
protected $configFilePath;
/** @var string */
protected $configFileName;
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();
}
/**
* Lists all available config keys
2011-03-12 20:19:11 +03:00
*
* Please note that it does not return the values.
*
* @return array an array of key names
2011-03-12 20:19:11 +03:00
*/
2013-03-03 15:06:00 +04:00
public function getKeys() {
2013-06-04 02:05:38 +04:00
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`
*
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
*/
2013-06-04 02:05:38 +04:00
public function getValue($key, $default = null) {
$envValue = getenv(self::ENV_PREFIX . $key);
if ($envValue !== false) {
return $envValue;
}
2013-06-04 02:05:38 +04:00
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 and deletes values and writes the config.php
2013-06-04 02:05:38 +04:00
*
* @param array $configs Associative array with `key => value` pairs
* If value is null, the config key will be deleted
2011-03-12 20:19:11 +03:00
*/
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();
}
}
2011-03-12 20:19:11 +03:00
/**
* Sets the value and writes it to config.php if required
2011-03-12 20:19:11 +03:00
*
* @param string $key key
* @param mixed $value value
*/
public function setValue($key, $value) {
if ($this->set($key, $value)) {
// Write changes
$this->writeData();
}
}
/**
* This function sets the value
2013-06-04 02:05:38 +04:00
*
* @param string $key key
* @param mixed $value value
* @return bool True if the file needs to be updated, false otherwise
*/
protected function set($key, $value) {
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
2011-03-12 20:19:11 +03:00
*/
2013-06-04 02:05:38 +04:00
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
*/
protected function delete($key) {
2013-06-04 02:05:38 +04:00
if (isset($this->cache[$key])) {
// Delete key from cache
2013-06-04 02:05:38 +04:00
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
*/
2013-03-03 15:06:00 +04:00
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);
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) {
$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)
2013-03-03 15:06:00 +04:00
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));
}
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";
$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)) {
2013-03-03 15:06:00 +04:00
throw new HintException(
"Can't write into config directory!",
2020-03-28 18:16:41 +03:00
'This can usually be fixed by giving the webserver write access to the config directory.');
}
// 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);
if (function_exists('opcache_invalidate')) {
@opcache_invalidate($this->configFilePath, true);
}
}
}