Moved some files in \OC to PSR-4

* \OC\ActivityManager
* \OC\AllConfig
* \OC\AppConfig
* \OC\AppHelper
* \OC\Avatar
* \OC\AvatarManager
* \OC\CapabilitiesManager
* \OC\Config
* \OC\ContactsManager
* \OC\DatabaseException
* \OC\DatabaseSetupException

1 files changed, 264 insertions, 0 deletions

diff --git a/lib/private/Config.php b/lib/private/Config.php
new file mode 100644
index 00000000000..9bb5c299463
--- /dev/null
+++ b/lib/private/Config.php
@@ -0,0 +1,264 @@
+<?php
+/**
+ * @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 Frank Karlitschek <frank@owncloud.org>
+ * @author Jakob Sack <mail@jakobsack.de>
+ * @author Jan-Christoph Borchardt <hey@jancborchardt.net>
+ * @author Joas Schilling <nickvergessen@owncloud.com>
+ * @author Lukas Reschke <lukas@owncloud.com>
+ * @author Michael Gapczynski <GapczynskiM@gmail.com>
+ * @author Morris Jobke <hey@morrisjobke.de>
+ * @author Robin Appelman <icewind@owncloud.com>
+ * @author Robin McCorkell <robin@mccorkell.me.uk>
+ *
+ * @copyright Copyright (c) 2016, ownCloud, Inc.
+ * @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/>
+ *
+ */
+
+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;
+
+	/**
+	 * @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();
+	}
+
+	/**
+	 * Lists all available config keys
+	 *
+	 * Please note that it does not return the values.
+	 *
+	 * @return array an array of key names
+	 */
+	public function getKeys() {
+		return array_keys($this->cache);
+	}
+
+	/**
+	 * Gets a value from config.php
+	 *
+	 * If it does not exist, $default will be returned.
+	 *
+	 * @param string $key key
+	 * @param mixed $default = null default value
+	 * @return mixed the value or $default
+	 */
+	public function getValue($key, $default = null) {
+		if (isset($this->cache[$key])) {
+			return $this->cache[$key];
+		}
+
+		return $default;
+	}
+
+	/**
+	 * Sets and deletes values and writes the config.php
+	 *
+	 * @param array $configs Associative array with `key => value` pairs
+	 *                       If value is null, the config key will be deleted
+	 */
+	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();
+		}
+	}
+
+	/**
+	 * Sets the value and writes it to config.php if required
+	 *
+	 * @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
+	 *
+	 * @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
+	 */
+	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) {
+		if (isset($this->cache[$key])) {
+			// Delete key from cache
+			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
+	 */
+	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 = file_exists($file) ? fopen($file, 'r') : false;
+			if($file === $this->configFilePath &&
+				$filePointer === false &&
+				@!file_exists($this->configFilePath)) {
+				// 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";
+		$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)) {
+			// TODO fix this via DI once it is very clear that this doesn't cause side effects due to initialization order
+			// currently this breaks app routes but also could have other side effects especially during setup and exception handling
+			$url = \OC::$server->getURLGenerator()->linkToDocs('admin-dir_permissions');
+			throw new HintException(
+				"Can't write into config directory!",
+				'This can usually be fixed by '
+				.'<a href="' . $url . '" target="_blank" rel="noreferrer">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);
+
+		// Try invalidating the opcache just for the file we wrote...
+		if (!\OC_Util::deleteFromOpcodeCache($this->configFilePath)) {
+			// But if that doesn't work, clear the whole cache.
+			\OC_Util::clearOpcodeCache();
+		}
+	}
+}
+