Merge pull request #7372 from nupplaphil/task/simplify_config

Refactor Configuration (Simplify Config Part 3)

src/Model/Config/Config.php

@@ -0,0 +1,131 @@
+<?php
+
+namespace Friendica\Model\Config;
+
+
+/**
+ * The Config model backend, which is using the general DB-model backend for configs
+ */
+class Config extends DbaConfig
+{
+	/**
+	 * Loads all configuration values and returns the loaded category as an array.
+	 *
+	 * @param string|null $cat The category of the configuration values to load
+	 *
+	 * @return array The config array
+	 *
+	 * @throws \Exception In case DB calls are invalid
+	 */
+	public function load(string $cat = null)
+	{
+		$return = [];
+
+		if (empty($cat)) {
+			$configs = $this->dba->select('config', ['cat', 'v', 'k']);
+		} else {
+			$configs = $this->dba->select('config', ['cat', 'v', 'k'], ['cat' => $cat]);
+		}
+
+		while ($config = $this->dba->fetch($configs)) {
+
+			$key   = $config['k'];
+			$value = $this->toConfigValue($config['v']);
+
+			// just save it in case it is set
+			if (isset($value)) {
+				$return[$config['cat']][$key] = $value;
+			}
+		}
+		$this->dba->close($configs);
+
+		return $return;
+	}
+
+	/**
+	 * Get a particular, system-wide config variable out of the DB with the
+	 * given category name ($cat) and a key ($key).
+	 *
+	 * Note: Boolean variables are defined as 0/1 in the database
+	 *
+	 * @param string $cat The category of the configuration value
+	 * @param string $key The configuration key to query
+	 *
+	 * @return array|string|null Stored value or null if it does not exist
+	 *
+	 * @throws \Exception In case DB calls are invalid
+	 */
+	public function get(string $cat, string $key)
+	{
+		if (!$this->isConnected()) {
+			return null;
+		}
+
+		$config = $this->dba->selectFirst('config', ['v'], ['cat' => $cat, 'k' => $key]);
+		if ($this->dba->isResult($config)) {
+			$value = $this->toConfigValue($config['v']);
+
+			// just return it in case it is set
+			if (isset($value)) {
+				return $value;
+			}
+		}
+
+		return null;
+	}
+
+	/**
+	 * Stores a config value ($value) in the category ($cat) under the key ($key).
+	 *
+	 * Note: Please do not store booleans - convert to 0/1 integer values!
+	 *
+	 * @param string $cat   The category of the configuration value
+	 * @param string $key   The configuration key to set
+	 * @param mixed  $value The value to store
+	 *
+	 * @return bool Operation success
+	 *
+	 * @throws \Exception In case DB calls are invalid
+	 */
+	public function set(string $cat, string $key, $value)
+	{
+		if (!$this->isConnected()) {
+			return false;
+		}
+
+		// We store our setting values in a string variable.
+		// So we have to do the conversion here so that the compare below works.
+		// The exception are array values.
+		$compare_value = (!is_array($value) ? (string)$value : $value);
+		$stored_value  = $this->get($cat, $key);
+
+		if (isset($stored_value) && ($stored_value === $compare_value)) {
+			return true;
+		}
+
+		$dbvalue = $this->toDbValue($value);
+
+		$result = $this->dba->update('config', ['v' => $dbvalue], ['cat' => $cat, 'k' => $key], true);
+
+		return $result;
+	}
+
+	/**
+	 * Removes the configured value from the database.
+	 *
+	 * @param string $cat The category of the configuration value
+	 * @param string $key The configuration key to delete
+	 *
+	 * @return bool Operation success
+	 *
+	 * @throws \Exception In case DB calls are invalid
+	 */
+	public function delete(string $cat, string $key)
+	{
+		if (!$this->isConnected()) {
+			return false;
+		}
+
+		return $this->dba->delete('config', ['cat' => $cat, 'k' => $key]);
+	}
+}

src/Model/Config/DbaConfig.php

@@ -0,0 +1,86 @@
+<?php
+
+namespace Friendica\Model\Config;
+
+use Friendica\Database\Database;
+
+/**
+ * The DB-based model of (P-)Config values
+ * Encapsulates db-calls in case of config queries
+ */
+abstract class DbaConfig
+{
+	/** @var Database */
+	protected $dba;
+
+	/**
+	 * @param Database $dba The database connection of this model
+	 */
+	public function __construct(Database $dba)
+	{
+		$this->dba = $dba;
+	}
+
+	/**
+	 * Checks if the model is currently connected
+	 *
+	 * @return bool
+	 */
+	public function isConnected()
+	{
+		return $this->dba->isConnected();
+	}
+
+	/**
+	 * Formats a DB value to a config value
+	 * - null   = The db-value isn't set
+	 * - bool   = The db-value is either '0' or '1'
+	 * - array  = The db-value is a serialized array
+	 * - string = The db-value is a string
+	 *
+	 * Keep in mind that there aren't any numeric/integer config values in the database
+	 *
+	 * @param null|string $value
+	 *
+	 * @return null|array|string
+	 */
+	protected function toConfigValue($value)
+	{
+		if (!isset($value)) {
+			return null;
+		}
+
+		switch (true) {
+			// manage array value
+			case preg_match("|^a:[0-9]+:{.*}$|s", $value):
+				return unserialize($value);
+
+			default:
+				return $value;
+		}
+	}
+
+	/**
+	 * Formats a config value to a DB value (string)
+	 *
+	 * @param mixed $value
+	 *
+	 * @return string
+	 */
+	protected function toDbValue($value)
+	{
+		// if not set, save an empty string
+		if (!isset($value)) {
+			return '';
+		}
+
+		switch (true) {
+			// manage arrays
+			case is_array($value):
+				return serialize($value);
+
+			default:
+				return (string)$value;
+		}
+	}
+}