3) Introducing ConfigFactory

src/Core/Config/ConfigCache.php

@@ -0,0 +1,173 @@
+<?php
+
+namespace Friendica\Core\Config;
+
+class ConfigCache implements IConfigCache, IPConfigCache
+{
+	/**
+	 * NEVER, EVER use this public config array outside of the class
+	 * It is only public due to backward compatibility to .htconfig.php
+	 *
+	 * @var array The cached config array
+	 */
+	public $config;
+
+	public function __construct($config = [], $overwrite = false)
+	{
+		$this->config = [];
+
+		if (isset($config)) {
+			$this->loadConfigArray($config, $overwrite);
+		}
+	}
+
+	/**
+	 * Tries to load the specified configuration array into the App->config array.
+	 * Doesn't overwrite previously set values by default to prevent default config files to supersede DB Config.
+	 *
+	 * @param array $config
+	 * @param bool  $overwrite Force value overwrite if the config key already exists
+	 */
+	public function loadConfigArray(array $config, $overwrite = false)
+	{
+		foreach ($config as $category => $values) {
+			foreach ($values as $key => $value) {
+				if ($overwrite) {
+					self::set($category, $key, $value);
+				} else {
+					self::setDefault($category, $key, $value);
+				}
+			}
+		}
+	}
+
+	/**
+	 * {@inheritdoc}
+	 */
+	public function get($cat, $key = null, $default = null)
+	{
+		$return = $default;
+
+		if ($cat === 'config') {
+			if (isset($this->config[$key])) {
+				$return = $this->config[$key];
+			}
+		} else {
+			if (isset($this->config[$cat][$key])) {
+				$return = $this->config[$cat][$key];
+			} elseif ($key == null && isset($this->config[$cat])) {
+				$return = $this->config[$cat];
+			}
+		}
+
+		return $return;
+	}
+
+	/**
+	 * Sets a default value in the config cache. Ignores already existing keys.
+	 *
+	 * @param string $cat Config category
+	 * @param string $k   Config key
+	 * @param mixed  $v   Default value to set
+	 */
+	private function setDefault($cat, $k, $v)
+	{
+		if (!isset($this->config[$cat][$k])) {
+			self::set($cat, $k, $v);
+		}
+	}
+
+	/**
+	 * {@inheritdoc}
+	 */
+	public function set($cat, $key, $value)
+	{
+		// Only arrays are serialized in database, so we have to unserialize sparingly
+		$value = is_string($value) && preg_match("|^a:[0-9]+:{.*}$|s", $value) ? unserialize($value) : $value;
+
+		if ($cat === 'config') {
+			$this->config[$key] = $value;
+		} else {
+			if (!isset($this->config[$cat])) {
+				$this->config[$cat] = [];
+			}
+
+			$this->config[$cat][$key] = $value;
+		}
+	}
+
+	/**
+	 * {@inheritdoc}
+	 */
+	public function delete($cat, $key)
+	{
+		if ($cat === 'config') {
+			if (isset($this->config[$key])) {
+				unset($this->config[$key]);
+			}
+		} else {
+			if (isset($this->config[$cat][$key])) {
+				unset($this->config[$cat][$key]);
+			}
+		}
+	}
+
+	/**
+	 * {@inheritdoc}
+	 */
+	public function getP($uid, $cat, $key = null, $default = null)
+	{
+		$return = $default;
+
+		if (isset($this->config[$uid][$cat][$key])) {
+			$return = $this->config[$uid][$cat][$key];
+		} elseif ($key == null && isset($this->config[$uid][$cat])) {
+			$return = $this->config[$uid][$cat];
+		}
+
+		return $return;
+	}
+
+	/**
+	 * {@inheritdoc}
+	 */
+	public function setP($uid, $cat, $key, $value)
+	{
+		// Only arrays are serialized in database, so we have to unserialize sparingly
+		$value = is_string($value) && preg_match("|^a:[0-9]+:{.*}$|s", $value) ? unserialize($value) : $value;
+
+		if (!isset($this->config[$uid]) || !is_array($this->config[$uid])) {
+			$this->config[$uid] = [];
+		}
+
+		if (!isset($this->config[$uid][$cat]) || !is_array($this->config[$uid][$cat])) {
+			$this->config[$uid][$cat] = [];
+		}
+
+		if ($key === null) {
+			$this->config[$uid][$cat] = $value;
+		} else {
+			$this->config[$uid][$cat][$key] = $value;
+		}
+	}
+
+	/**
+	 * {@inheritdoc}
+	 */
+	public function deleteP($uid, $cat, $key)
+	{
+		if (isset($this->config[$uid][$cat][$key])) {
+			unset($this->config[$uid][$cat][$key]);
+		}
+	}
+
+	/**
+	 * Returns the whole configuration
+	 *
+	 * @return array The configuration
+	 */
+	public function getAll()
+	{
+		return $this->config;
+	}
+}

src/Core/Config/ConfigCacheLoader.php

@@ -0,0 +1,159 @@
+<?php
+
+namespace Friendica\Core\Config;
+
+class ConfigCacheLoader
+{
+	private $baseDir;
+	private $configDir;
+
+	public function __construct($baseDir)
+	{
+		$this->baseDir = $baseDir;
+		$this->configDir = $baseDir . '/config/';
+	}
+
+	/**
+	 * Load the configuration files
+	 *
+	 * First loads the default value for all the configuration keys, then the legacy configuration files, then the
+	 * expected local.config.php
+	 */
+	public function loadConfigFiles(ConfigCache $config)
+	{
+		// Setting at least the basepath we know
+		$config->set('system', 'basepath', $this->baseDir);
+
+		$config->loadConfigArray($this->loadConfigFile('defaults'));
+		$config->loadConfigArray($this->loadConfigFile('settings'));
+
+		// Legacy .htconfig.php support
+		if (file_exists($this->baseDir  . '/.htpreconfig.php')) {
+			$a = $config;
+			include $this->baseDir . '/.htpreconfig.php';
+		}
+
+		// Legacy .htconfig.php support
+		if (file_exists($this->baseDir . '/.htconfig.php')) {
+			$a = $config;
+
+			include $this->baseDir . '/.htconfig.php';
+
+			$config->set('database', 'hostname', $db_host);
+			$config->set('database', 'username', $db_user);
+			$config->set('database', 'password', $db_pass);
+			$config->set('database', 'database', $db_data);
+			$charset = $config->get('system', 'db_charset');
+			if (isset($charset)) {
+				$config->set('database', 'charset', $charset);
+			}
+
+			unset($db_host, $db_user, $db_pass, $db_data);
+
+			if (isset($default_timezone)) {
+				$config->set('system', 'default_timezone', $default_timezone);
+				unset($default_timezone);
+			}
+
+			if (isset($pidfile)) {
+				$config->set('system', 'pidfile', $pidfile);
+				unset($pidfile);
+			}
+
+			if (isset($lang)) {
+				$config->set('system', 'language', $lang);
+				unset($lang);
+			}
+		}
+
+		if (file_exists($this->baseDir . '/config/local.config.php')) {
+			$config->loadConfigArray($this->loadConfigFile('local'), true);
+		} elseif (file_exists($this->baseDir . '/config/local.ini.php')) {
+			$config->loadConfigArray($this->loadINIConfigFile('local'), true);
+		}
+	}
+
+	/**
+	 * Tries to load the specified legacy configuration file into the App->config array.
+	 * Doesn't overwrite previously set values by default to prevent default config files to supersede DB Config.
+	 *
+	 * @deprecated since version 2018.12
+	 * @param string $filename
+	 *
+	 * @return array The configuration
+	 * @throws \Exception
+	 */
+	public function loadINIConfigFile($filename)
+	{
+		$filepath = $this->configDir . $filename . ".ini.php";
+
+		if (!file_exists($filepath)) {
+			throw new \Exception('Error parsing non-existent INI config file ' . $filepath);
+		}
+
+		$contents = include($filepath);
+
+		$config = parse_ini_string($contents, true, INI_SCANNER_TYPED);
+
+		if ($config === false) {
+			throw new \Exception('Error parsing INI config file ' . $filepath);
+		}
+
+		return $config;
+	}
+
+	/**
+	 * Tries to load the specified configuration file into the App->config array.
+	 * Doesn't overwrite previously set values by default to prevent default config files to supersede DB Config.
+	 *
+	 * The config format is PHP array and the template for configuration files is the following:
+	 *
+	 * <?php return [
+	 *      'section' => [
+	 *          'key' => 'value',
+	 *      ],
+	 * ];
+	 *
+	 * @param string $filename
+	 * @return array The configuration
+	 * @throws \Exception
+	 */
+	public function loadConfigFile($filename)
+	{
+		$filepath = $this->configDir . $filename . ".config.php";
+
+		if (!file_exists($filepath)) {
+			throw new \Exception('Error loading non-existent config file ' . $filepath);
+		}
+
+		$config = include($filepath);
+
+		if (!is_array($config)) {
+			throw new \Exception('Error loading config file ' . $filepath);
+		}
+
+		return $config;
+	}
+
+	/**
+	 * Loads addons configuration files
+	 *
+	 * First loads all activated addons default configuration through the load_config hook, then load the local.config.php
+	 * again to overwrite potential local addon configuration.
+	 *
+	 * @return array The config array
+	 *
+	 * @throws \Exception
+	 */
+	public function loadAddonConfig()
+	{
+		// Load the local addon config file to overwritten default addon config values
+		if (file_exists($this->configDir . 'addon.config.php')) {
+			return $this->loadConfigFile('addon');
+		} elseif (file_exists($this->configDir . 'addon.ini.php')) {
+			return $this->loadINIConfigFile('addon');
+		} else {
+			return [];
+		}
+	}
+}

src/Core/Config/IConfigCache.php

@@ -0,0 +1,34 @@
+<?php
+
+namespace Friendica\Core\Config;
+
+interface IConfigCache
+{
+	/**
+	 * @param string $cat     Config category
+	 * @param string $key       Config key
+	 * @param mixed  $default Default value if it isn't set
+	 *
+	 * @return mixed Returns the value of the Config entry
+	 */
+	function get($cat, $key = null, $default = null);
+
+	/**
+	 * Sets a value in the config cache. Accepts raw output from the config table
+	 *
+	 * @param string $cat   Config category
+	 * @param string $key   Config key
+	 * @param mixed  $value Value to set
+	 */
+	function set($cat, $key, $value);
+
+	/**
+	 * Deletes a value from the config cache
+	 *
+	 * @param string $cat  Config category
+	 * @param string $key  Config key
+	 */
+	function delete($cat, $key);
+
+	function getAll();
+}

src/Core/Config/IPConfigCache.php

@@ -0,0 +1,41 @@
+<?php
+
+namespace Friendica\Core\Config;
+
+interface IPConfigCache
+{
+	/**
+	 * Retrieves a value from the user config cache
+	 *
+	 * @param int    $uid     User Id
+	 * @param string $cat     Config category
+	 * @param string $key     Config key
+	 * @param mixed  $default Default value if key isn't set
+	 *
+	 * @return string The value of the config entry
+	 */
+	function getP($uid, $cat, $key = null, $default = null);
+
+	/**
+	 * Sets a value in the user config cache
+	 *
+	 * Accepts raw output from the pconfig table
+	 *
+	 * @param int    $uid   User Id
+	 * @param string $cat   Config category
+	 * @param string $key   Config key
+	 * @param mixed  $value Value to set
+	 */
+	function setP($uid, $cat, $key, $value);
+
+	/**
+	 * Deletes a value from the user config cache
+	 *
+	 * @param int    $uid User Id
+	 * @param string $cat Config category
+	 * @param string $key Config key
+	 */
+	function deleteP($uid, $cat, $key);
+
+	function getAll();
+}

src/Core/Config/JITConfigAdapter.php

@@ -1,7 +1,6 @@
 <?php
 namespace Friendica\Core\Config;
 
-use Friendica\Core\Config;
 use Friendica\Database\DBA;
 
 /**
@@ -16,6 +15,19 @@ class JITConfigAdapter implements IConfigAdapter
 	private $cache;
 	private $in_db;
 
+	/**
+	 * @var IConfigCache The config cache of this driver
+	 */
+	private $config;
+
+	/**
+	 * @param IConfigCache $config The config cache of this driver
+	 */
+	public function __construct($config)
+	{
+		$this->config = $config;
+	}
+
 	public function load($cat = "config")
 	{
 		// We don't preload "system" anymore.
@@ -28,7 +40,7 @@ class JITConfigAdapter implements IConfigAdapter
 		while ($config = DBA::fetch($configs)) {
 			$k = $config['k'];
 
-			Config::setConfigValue($cat, $k, $config['v']);
+			$this->config->set($cat, $k, $config['v']);
 
 			if ($cat !== 'config') {
 				$this->cache[$cat][$k] = $config['v'];
@@ -60,18 +72,18 @@ class JITConfigAdapter implements IConfigAdapter
 			$this->cache[$cat][$k] = $value;
 			$this->in_db[$cat][$k] = true;
 			return $value;
-		} elseif (Config::getConfigValue($cat, $k) !== null) {
+		} elseif ($this->config->get($cat, $k) !== null) {
 			// Assign the value (mostly) from config/local.config.php file to the cache
-			$this->cache[$cat][$k] = Config::getConfigValue($cat, $k);
+			$this->cache[$cat][$k] = $this->config->get($cat, $k);
 			$this->in_db[$cat][$k] = false;
 
-			return Config::getConfigValue($cat, $k);
-		} elseif (Config::getConfigValue('config', $k) !== null) {
+			return $this->config->get($cat, $k);
+		} elseif ($this->config->get('config', $k) !== null) {
 			// Assign the value (mostly) from config/local.config.php file to the cache
-			$this->cache[$k] = Config::getConfigValue('config', $k);
+			$this->cache[$k] = $this->config->get('config', $k);
 			$this->in_db[$k] = false;
 
-			return Config::getConfigValue('config', $k);
+			return $this->config->get('config', $k);
 		}
 
 		$this->cache[$cat][$k] = '!<unset>!';
@@ -100,7 +112,7 @@ class JITConfigAdapter implements IConfigAdapter
 			return true;
 		}
 
-		Config::setConfigValue($cat, $k, $value);
+		$this->config->set($cat, $k, $value);
 
 		// Assign the just added value to the cache
 		$this->cache[$cat][$k] = $dbvalue;

src/Core/Config/JITPConfigAdapter.php

@@ -1,7 +1,6 @@
 <?php
 namespace Friendica\Core\Config;
 
-use Friendica\Core\PConfig;
 use Friendica\Database\DBA;
 
 /**
@@ -15,6 +14,20 @@ class JITPConfigAdapter implements IPConfigAdapter
 {
 	private $in_db;
 
+	/**
+	 * The config cache of this adapter
+	 * @var IPConfigCache
+	 */
+	private $config;
+
+	/**
+	 * @param IPConfigCache $config The config cache of this adapter
+	 */
+	public function __construct($config)
+	{
+		$this->config = $config;
+	}
+
 	public function load($uid, $cat)
 	{
 		$pconfigs = DBA::select('pconfig', ['v', 'k'], ['cat' => $cat, 'uid' => $uid]);
@@ -22,13 +35,13 @@ class JITPConfigAdapter implements IPConfigAdapter
 			while ($pconfig = DBA::fetch($pconfigs)) {
 				$k = $pconfig['k'];
 
-				PConfig::setPConfigValue($uid, $cat, $k, $pconfig['v']);
+				$this->config->setP($uid, $cat, $k, $pconfig['v']);
 
 				$this->in_db[$uid][$cat][$k] = true;
 			}
 		} else if ($cat != 'config') {
 			// Negative caching
-			PConfig::setPConfigValue($uid, $cat, null, "!<unset>!");
+			$this->config->setP($uid, $cat, null, "!<unset>!");
 		}
 		DBA::close($pconfigs);
 	}
@@ -37,17 +50,17 @@ class JITPConfigAdapter implements IPConfigAdapter
 	{
 		if (!$refresh) {
 			// Looking if the whole family isn't set
-			if (PConfig::getPConfigValue($uid, $cat) !== null) {
-				if (PConfig::getPConfigValue($uid, $cat) === '!<unset>!') {
+			if ($this->config->getP($uid, $cat) !== null) {
+				if ($this->config->getP($uid, $cat) === '!<unset>!') {
 					return $default_value;
 				}
 			}
 
-			if (PConfig::getPConfigValue($uid, $cat, $k) !== null) {
-				if (PConfig::getPConfigValue($uid, $cat, $k) === '!<unset>!') {
+			if ($this->config->getP($uid, $cat, $k) !== null) {
+				if ($this->config->getP($uid, $cat, $k) === '!<unset>!') {
 					return $default_value;
 				}
-				return PConfig::getPConfigValue($uid, $cat, $k);
+				return $this->config->getP($uid, $cat, $k);
 			}
 		}
 
@@ -55,13 +68,13 @@ class JITPConfigAdapter implements IPConfigAdapter
 		if (DBA::isResult($pconfig)) {
 			$val = (preg_match("|^a:[0-9]+:{.*}$|s", $pconfig['v']) ? unserialize($pconfig['v']) : $pconfig['v']);
 
-			PConfig::setPConfigValue($uid, $cat, $k, $val);
+			$this->config->setP($uid, $cat, $k, $val);
 
 			$this->in_db[$uid][$cat][$k] = true;
 
 			return $val;
 		} else {
-			PConfig::setPConfigValue($uid, $cat, $k, '!<unset>!');
+			$this->config->setP($uid, $cat, $k, '!<unset>!');
 
 			$this->in_db[$uid][$cat][$k] = false;
 
@@ -82,7 +95,7 @@ class JITPConfigAdapter implements IPConfigAdapter
 			return true;
 		}
 
-		PConfig::setPConfigValue($uid, $cat, $k, $value);
+		$this->config->setP($uid, $cat, $k, $value);
 
 		// manage array value
 		$dbvalue = (is_array($value) ? serialize($value) : $dbvalue);
@@ -98,7 +111,7 @@ class JITPConfigAdapter implements IPConfigAdapter
 
 	public function delete($uid, $cat, $k)
 	{
-		PConfig::deletePConfigValue($uid, $cat, $k);
+		$this->config->deleteP($uid, $cat, $k);
 
 		if (!empty($this->in_db[$uid][$cat][$k])) {
 			unset($this->in_db[$uid][$cat][$k]);

src/Core/Config/PreloadConfigAdapter.php

@@ -3,7 +3,6 @@
 namespace Friendica\Core\Config;
 
 use Exception;
-use Friendica\Core\Config;
 use Friendica\Database\DBA;
 
 /**
@@ -17,8 +16,17 @@ class PreloadConfigAdapter implements IConfigAdapter
 {
 	private $config_loaded = false;
 
-	public function __construct()
+	/**
+	 * @var IConfigCache The config cache of this driver
+	 */
+	private $config;
+
+	/**
+	 * @param IConfigCache $config The config cache of this driver
+	 */
+	public function __construct($config)
 	{
+		$this->config = $config;
 		$this->load();
 	}
 
@@ -30,7 +38,7 @@ class PreloadConfigAdapter implements IConfigAdapter
 
 		$configs = DBA::select('config', ['cat', 'v', 'k']);
 		while ($config = DBA::fetch($configs)) {
-			Config::setConfigValue($config['cat'], $config['k'], $config['v']);
+			$this->config->set($config['cat'], $config['k'], $config['v']);
 		}
 		DBA::close($configs);
 
@@ -42,11 +50,11 @@ class PreloadConfigAdapter implements IConfigAdapter
 		if ($refresh) {
 			$config = DBA::selectFirst('config', ['v'], ['cat' => $cat, 'k' => $k]);
 			if (DBA::isResult($config)) {
-				Config::setConfigValue($cat, $k, $config['v']);
+				$this->config->set($cat, $k, $config['v']);
 			}
 		}
 
-		$return = Config::getConfigValue($cat, $k, $default_value);
+		$return = $this->config->get($cat, $k, $default_value);
 
 		return $return;
 	}
@@ -58,11 +66,11 @@ class PreloadConfigAdapter implements IConfigAdapter
 		// The exception are array values.
 		$compare_value = !is_array($value) ? (string)$value : $value;
 
-		if (Config::getConfigValue($cat, $k) === $compare_value) {
+		if ($this->config->get($cat, $k) === $compare_value) {
 			return true;
 		}
 
-		Config::setConfigValue($cat, $k, $value);
+		$this->config->set($cat, $k, $value);
 
 		// manage array value
 		$dbvalue = is_array($value) ? serialize($value) : $value;
@@ -77,7 +85,7 @@ class PreloadConfigAdapter implements IConfigAdapter
 
 	public function delete($cat, $k)
 	{
-		Config::deleteConfigValue($cat, $k);
+		$this->config->delete($cat, $k);
 
 		$result = DBA::delete('config', ['cat' => $cat, 'k' => $k]);
 

src/Core/Config/PreloadPConfigAdapter.php

@@ -3,7 +3,6 @@
 namespace Friendica\Core\Config;
 
 use Exception;
-use Friendica\Core\PConfig;
 use Friendica\Database\DBA;
 
 /**
@@ -17,8 +16,19 @@ class PreloadPConfigAdapter implements IPConfigAdapter
 {
 	private $config_loaded = false;
 
-	public function __construct($uid)
+	/**
+	 * The config cache of this adapter
+	 * @var IPConfigCache
+	 */
+	private $config;
+
+	/**
+	 * @param int           $uid    The UID of the current user
+	 * @param IPConfigCache $config The config cache of this adapter
+	 */
+	public function __construct($uid, $config)
 	{
+		$this->config = $config;
 		$this->load($uid, 'config');
 	}
 
@@ -34,7 +44,7 @@ class PreloadPConfigAdapter implements IPConfigAdapter
 
 		$pconfigs = DBA::select('pconfig', ['cat', 'v', 'k'], ['uid' => $uid]);
 		while ($pconfig = DBA::fetch($pconfigs)) {
-			PConfig::setPConfigValue($uid, $pconfig['cat'], $pconfig['k'], $pconfig['v']);
+			$this->config->setP($uid, $pconfig['cat'], $pconfig['k'], $pconfig['v']);
 		}
 		DBA::close($pconfigs);
 
@@ -50,15 +60,13 @@ class PreloadPConfigAdapter implements IPConfigAdapter
 		if ($refresh) {
 			$config = DBA::selectFirst('pconfig', ['v'], ['uid' => $uid, 'cat' => $cat, 'k' => $k]);
 			if (DBA::isResult($config)) {
-				PConfig::setPConfigValue($uid, $cat, $k, $config['v']);
+				$this->config->setP($uid, $cat, $k, $config['v']);
 			} else {
-				PConfig::deletePConfigValue($uid, $cat, $k);
+				$this->config->deleteP($uid, $cat, $k);
 			}
 		}
 
-		$return = PConfig::getPConfigValue($uid, $cat, $k, $default_value);
-
-		return $return;
+		return $this->config->getP($uid, $cat, $k, $default_value);;
 	}
 
 	public function set($uid, $cat, $k, $value)
@@ -71,11 +79,11 @@ class PreloadPConfigAdapter implements IPConfigAdapter
 		// The exception are array values.
 		$compare_value = !is_array($value) ? (string)$value : $value;
 
-		if (PConfig::getPConfigValue($uid, $cat, $k) === $compare_value) {
+		if ($this->config->getP($uid, $cat, $k) === $compare_value) {
 			return true;
 		}
 
-		PConfig::setPConfigValue($uid, $cat, $k, $value);
+		$this->config->setP($uid, $cat, $k, $value);
 
 		// manage array value
 		$dbvalue = is_array($value) ? serialize($value) : $value;
@@ -94,7 +102,7 @@ class PreloadPConfigAdapter implements IPConfigAdapter
 			$this->load($uid, $cat);
 		}
 
-		PConfig::deletePConfigValue($uid, $cat, $k);
+		$this->config->deleteP($uid, $cat, $k);
 
 		$result = DBA::delete('pconfig', ['uid' => $uid, 'cat' => $cat, 'k' => $k]);