]> git.mxchange.org Git - friendica.git/blobdiff - src/Core/Config.php
Refactor namespaces
[friendica.git] / src / Core / Config.php
index d454de39218f59071c13f11978e18f71f93f0c69..755dc6ebbcf50bfcc82e9f31a7877ea5d89ea8e3 100644 (file)
@@ -1,29 +1,43 @@
 <?php
-namespace Friendica\Core;
-
-use dbm;
-
 /**
+ * System Configuration Class
+ *
  * @file include/Core/Config.php
  *
- *  @brief Contains the class with methods for system configuration
+ * @brief Contains the class with methods for system configuration
  */
+namespace Friendica\Core;
 
+use Friendica\App;
+use Friendica\BaseObject;
 
 /**
- * @brief Arbitrary sytem configuration storage
- * Note:
- * Please do not store booleans - convert to 0/1 integer values
- * The Config::get() functions return boolean false for keys that are unset,
- * and this could lead to subtle bugs.
+ * @brief Arbitrary system configuration storage
  *
- * There are a few places in the code (such as the admin panel) where boolean
- * configurations need to be fixed as of 10/08/2011.
+ * Note:
+ * If we ever would decide to return exactly the variable type as entered,
+ * we will have fun with the additional features. :-)
  */
-class Config {
+class Config extends BaseObject
+{
+       /**
+        * @var \Friendica\Core\Config\IConfigAdapter
+        */
+       private static $adapter = null;
 
-       private static $cache;
-       private static $in_db;
+       public static function init()
+       {
+               // Database isn't ready or populated yet
+               if (!self::getApp()->getMode()->has(App\Mode::DBCONFIGAVAILABLE)) {
+                       return;
+               }
+
+               if (self::getApp()->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.
@@ -31,33 +45,23 @@ class Config {
         * All configuration values of the system are stored in global cache
         * which is available under the global variable $a->config
         *
-        * @param string $family
-        *  The category of the configuration value
+        * @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') {
+       public static function load($family = "config")
+       {
+               // Database isn't ready or populated yet
+               if (!self::getApp()->getMode()->has(App\Mode::DBCONFIGAVAILABLE)) {
                        return;
                }
 
-               $a = get_app();
-
-               $r = q("SELECT `v`, `k` FROM `config` WHERE `cat` = '%s'", dbesc($family));
-               if (dbm::is_result($r)) {
-                       foreach ($r as $rr) {
-                               $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();
                }
+
+               self::$adapter->load($family);
        }
 
        /**
@@ -72,57 +76,26 @@ class Config {
         * local config cache, pull it into the cache so we don't have
         * to hit the DB again for this item.
         *
-        * @param string $family
-        *  The category of the configuration value
-        * @param string $key
-        *  The configuration key to query
-        * @param mixed $default_value optional
-        *  The value to return if key is not set (default: null)
-        * @param boolean $refresh optional
-        *  If true the config is loaded from the db and not from the cache (default: false)
+        * @param string  $family        The category of the configuration value
+        * @param string  $key           The configuration key to query
+        * @param mixed   $default_value optional, The value to return if key is not set (default: null)
+        * @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];
-                               }
-                       }
+       public static function get($family, $key, $default_value = null, $refresh = false)
+       {
+               // Database isn't ready or populated yet, fallback to file config
+               if (!self::getApp()->getMode()->has(App\Mode::DBCONFIGAVAILABLE)) {
+                       return self::getApp()->getConfigValue($family, $key, $default_value);
                }
 
-               $ret = q("SELECT `v` FROM `config` WHERE `cat` = '%s' AND `k` = '%s'",
-                       dbesc($family),
-                       dbesc($key)
-               );
-               if (dbm::is_result($ret)) {
-                       // manage array value
-                       $val = (preg_match("|^a:[0-9]+:{.*}$|s", $ret[0]['v']) ? unserialize($ret[0]['v']) : $ret[0]['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);
        }
 
        /**
@@ -133,59 +106,25 @@ class Config {
         *
         * Note: Please do not store booleans - convert to 0/1 integer values!
         *
-        * @param string $family
-        *  The category of the configuration value
-        * @param string $key
-        *  The configuration key to set
-        * @param string $value
-        *  The value to store
-        * @return mixed Stored $value or false if the database update failed
+        * @param string $family 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 \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;
+       public static function set($family, $key, $value)
+       {
+               // 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);
-
-               if (is_null($stored) || !self::$in_db[$family][$key]) {
-                       $ret = q("INSERT INTO `config` (`cat`, `k`, `v`) VALUES ('%s', '%s', '%s') ON DUPLICATE KEY UPDATE `v` = '%s'",
-                               dbesc($family),
-                               dbesc($key),
-                               dbesc($dbvalue),
-                               dbesc($dbvalue)
-                       );
-               } else {
-                       $ret = q("UPDATE `config` SET `v` = '%s' WHERE `cat` = '%s' AND `k` = '%s'",
-                               dbesc($dbvalue),
-                               dbesc($family),
-                               dbesc($key)
-                       );
-               }
-               if ($ret) {
-                       self::$in_db[$family][$key] = true;
-                       return $value;
-               }
-               return $ret;
+               return self::$adapter->set($family, $key, $value);
        }
 
        /**
@@ -194,23 +133,23 @@ class Config {
         * Removes the configured value from the stored cache in $a->config
         * and removes it from the database.
         *
-        * @param string $family
-        *  The category of the configuration value
-        * @param string $key
-        *  The configuration key to delete
+        * @param string $family The category of the configuration value
+        * @param string $key    The configuration key to delete
+        *
         * @return mixed
+        * @throws \Friendica\Network\HTTPException\InternalServerErrorException
         */
-       public static function delete($family, $key) {
+       public static function delete($family, $key)
+       {
+               // Database isn't ready or populated yet
+               if (!self::getApp()->getMode()->has(App\Mode::DBCONFIGAVAILABLE)) {
+                       return false;
+               }
 
-               if (isset(self::$cache[$family][$key])) {
-                       unset(self::$cache[$family][$key]);
-                       unset(self::$in_db[$family][$key]);
+               if (empty(self::$adapter)) {
+                       self::init();
                }
-               $ret = q("DELETE FROM `config` WHERE `cat` = '%s' AND `k` = '%s'",
-                       dbesc($family),
-                       dbesc($key)
-               );
 
-               return $ret;
+               return self::$adapter->delete($family, $key);
        }
 }