]> git.mxchange.org Git - friendica.git/blobdiff - src/Core/Config.php
1) Refactor App->config[] into Core\Config
[friendica.git] / src / Core / Config.php
index a1ea5ae1ff19c8a4a50612bdb8bdf46793c3fc93..2a719e8e41098e9a29cbe8777681c020933a3809 100644 (file)
@@ -8,24 +8,38 @@
  */
 namespace Friendica\Core;
 
-use Friendica\Database\DBM;
-use dba;
+use Friendica\App;
+use Friendica\BaseObject;
 
 /**
- * @brief Arbitrary sytem configuration storage
+ * @brief Arbitrary system configuration storage
  *
  * Note:
  * If we ever would decide to return exactly the variable type as entered,
  * we will have fun with the additional features. :-)
- *
- * The config class always returns strings but in the default features
- * we use a "false" to determine if the config value isn't set.
- *
  */
-class Config
+class Config extends BaseObject
 {
-       private static $cache;
-       private static $in_db;
+       public static $config = [];
+
+       /**
+        * @var \Friendica\Core\Config\IConfigAdapter
+        */
+       private static $adapter = null;
+
+       public static function init()
+       {
+               // Database isn't ready or populated yet
+               if (!self::getApp()->getMode()->has(App\Mode::DBCONFIGAVAILABLE)) {
+                       return;
+               }
+
+               if (self::getConfigValue('system', 'config_adapter') == 'preload') {
+                       self::$adapter = new Config\PreloadConfigAdapter();
+               } else {
+                       self::$adapter = new Config\JITConfigAdapter();
+               }
+       }
 
        /**
         * @brief Loads all configuration values of family into a cached storage.
@@ -36,29 +50,20 @@ class Config
         * @param string $family The category of the configuration value
         *
         * @return void
+        * @throws \Friendica\Network\HTTPException\InternalServerErrorException
         */
        public static function load($family = "config")
        {
-               // We don't preload "system" anymore.
-               // This reduces the number of database reads a lot.
-               if ($family === 'system') {
+               // Database isn't ready or populated yet
+               if (!self::getApp()->getMode()->has(App\Mode::DBCONFIGAVAILABLE)) {
                        return;
                }
 
-               $a = get_app();
-
-               $r = dba::select('config', array('v', 'k'), array('cat' => $family));
-               while ($rr = dba::fetch($r)) {
-                       $k = $rr['k'];
-                       if ($family === 'config') {
-                               $a->config[$k] = $rr['v'];
-                       } else {
-                               $a->config[$family][$k] = $rr['v'];
-                               self::$cache[$family][$k] = $rr['v'];
-                               self::$in_db[$family][$k] = true;
-                       }
+               if (empty(self::$adapter)) {
+                       self::init();
                }
-               dba::close($r);
+
+               self::$adapter->load($family);
        }
 
        /**
@@ -66,7 +71,7 @@ class Config
         * ($family) and a key.
         *
         * Get a particular config value from the given category ($family)
-        * and the $key from a cached storage in $a->config[$uid].
+        * and the $key from a cached storage in static::config[$uid].
         * $instore is only used by the set_config function
         * to determine if the key already exists in the DB
         * If a key is found in the DB but doesn't exist in
@@ -79,43 +84,20 @@ class Config
         * @param boolean $refresh       optional, If true the config is loaded from the db and not from the cache (default: false)
         *
         * @return mixed Stored value or null if it does not exist
+        * @throws \Friendica\Network\HTTPException\InternalServerErrorException
         */
        public static function get($family, $key, $default_value = null, $refresh = false)
        {
-               $a = get_app();
-
-               if (!$refresh) {
-                       // Do we have the cached value? Then return it
-                       if (isset(self::$cache[$family][$key])) {
-                               if (self::$cache[$family][$key] === '!<unset>!') {
-                                       return $default_value;
-                               } else {
-                                       return self::$cache[$family][$key];
-                               }
-                       }
+               // Database isn't ready or populated yet, fallback to file config
+               if (!self::getApp()->getMode()->has(App\Mode::DBCONFIGAVAILABLE)) {
+                       return self::getConfigValue($family, $key, $default_value);
                }
 
-               $ret = dba::select('config', array('v'), array('cat' => $family, 'k' => $key), array('limit' => 1));
-               if (DBM::is_result($ret)) {
-                       // manage array value
-                       $val = (preg_match("|^a:[0-9]+:{.*}$|s", $ret['v']) ? unserialize($ret['v']) : $ret['v']);
-
-                       // Assign the value from the database to the cache
-                       self::$cache[$family][$key] = $val;
-                       self::$in_db[$family][$key] = true;
-                       return $val;
-               } elseif (isset($a->config[$family][$key])) {
-                       // Assign the value (mostly) from the .htconfig.php to the cache
-                       self::$cache[$family][$key] = $a->config[$family][$key];
-                       self::$in_db[$family][$key] = false;
-
-                       return $a->config[$family][$key];
+               if (empty(self::$adapter)) {
+                       self::init();
                }
 
-               self::$cache[$family][$key] = '!<unset>!';
-               self::$in_db[$family][$key] = false;
-
-               return $default_value;
+               return self::$adapter->get($family, $key, $default_value, $refresh);
        }
 
        /**
@@ -128,44 +110,23 @@ class Config
         *
         * @param string $family The category of the configuration value
         * @param string $key    The configuration key to set
-        * @param string $value  The value to store
+        * @param mixed  $value  The value to store
         *
-        * @return mixed Stored $value or false if the database update failed
+        * @return bool Operation success
+        * @throws \Friendica\Network\HTTPException\InternalServerErrorException
         */
        public static function set($family, $key, $value)
        {
-               $a = get_app();
-
-               // 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.
-               $dbvalue = (!is_array($value) ? (string)$value : $value);
-
-               $stored = self::get($family, $key, null, true);
-
-               if (($stored === $dbvalue) && self::$in_db[$family][$key]) {
-                       return true;
+               // Database isn't ready or populated yet
+               if (!self::getApp()->getMode()->has(App\Mode::DBCONFIGAVAILABLE)) {
+                       return false;
                }
 
-               if ($family === 'config') {
-                       $a->config[$key] = $dbvalue;
-               } elseif ($family != 'system') {
-                       $a->config[$family][$key] = $dbvalue;
+               if (empty(self::$adapter)) {
+                       self::init();
                }
 
-               // Assign the just added value to the cache
-               self::$cache[$family][$key] = $dbvalue;
-
-               // manage array value
-               $dbvalue = (is_array($value) ? serialize($value) : $dbvalue);
-
-               dba::update('config', array('v' => $dbvalue), array('cat' => $family, 'k' => $key), true);
-
-               if ($ret) {
-                       self::$in_db[$family][$key] = true;
-                       return $value;
-               }
-               return $ret;
+               return self::$adapter->set($family, $key, $value);
        }
 
        /**
@@ -178,16 +139,131 @@ class Config
         * @param string $key    The configuration key to delete
         *
         * @return mixed
+        * @throws \Friendica\Network\HTTPException\InternalServerErrorException
         */
        public static function delete($family, $key)
        {
-               if (isset(self::$cache[$family][$key])) {
-                       unset(self::$cache[$family][$key]);
-                       unset(self::$in_db[$family][$key]);
+               // Database isn't ready or populated yet
+               if (!self::getApp()->getMode()->has(App\Mode::DBCONFIGAVAILABLE)) {
+                       return false;
+               }
+
+               if (empty(self::$adapter)) {
+                       self::init();
+               }
+
+               return self::$adapter->delete($family, $key);
+       }
+
+       /**
+        * 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::setConfigValue($category, $key, $value);
+                               } else {
+                                       self::setDefaultConfigValue($category, $key, $value);
+                               }
+                       }
+               }
+       }
+
+       /**
+        * @param string $cat     Config category
+        * @param string $k       Config key
+        * @param mixed  $default Default value if it isn't set
+        *
+        * @return string Returns the value of the Config entry
+        */
+       public static function getConfigValue($cat, $k = null, $default = null)
+       {
+               $return = $default;
+
+               if ($cat === 'config') {
+                       if (isset(self::$config[$k])) {
+                               $return = self::$config[$k];
+                       }
+               } else {
+                       if (isset(self::$config[$cat][$k])) {
+                               $return = self::$config[$cat][$k];
+                       } elseif ($k == null && isset(self::$config[$cat])) {
+                               $return = self::$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 static function setDefaultConfigValue($cat, $k, $v)
+       {
+               if (!isset(self::$config[$cat][$k])) {
+                       self::setConfigValue($cat, $k, $v);
+               }
+       }
+
+       /**
+        * Sets a value in the config cache. Accepts raw output from the config table
+        *
+        * @param string $cat Config category
+        * @param string $k   Config key
+        * @param mixed  $v   Value to set
+        */
+       public static function setConfigValue($cat, $k, $v)
+       {
+               // Only arrays are serialized in database, so we have to unserialize sparingly
+               $value = is_string($v) && preg_match("|^a:[0-9]+:{.*}$|s", $v) ? unserialize($v) : $v;
+
+               if ($cat === 'config') {
+                       self::$config[$k] = $value;
+               } else {
+                       if (!isset(self::$config[$cat])) {
+                               self::$config[$cat] = [];
+                       }
+
+                       self::$config[$cat][$k] = $value;
                }
+       }
 
-               $ret = dba::delete('config', array('cat' => $family, 'k' => $key));
+       /**
+        * Deletes a value from the config cache
+        *
+        * @param string $cat Config category
+        * @param string $k   Config key
+        */
+       public static function deleteConfigValue($cat, $k)
+       {
+               if ($cat === 'config') {
+                       if (isset(self::$config[$k])) {
+                               unset(self::$config[$k]);
+                       }
+               } else {
+                       if (isset(self::$config[$cat][$k])) {
+                               unset(self::$config[$cat][$k]);
+                       }
+               }
+       }
 
-               return $ret;
+       /**
+        * Returns the whole configuration
+        *
+        * @return array The configuration
+        */
+       public static function getAll()
+       {
+               return self::$config;
        }
 }