]> git.mxchange.org Git - friendica.git/blobdiff - src/Core/PConfig.php
Update use statement lists with new Friendica\Database\dba class
[friendica.git] / src / Core / PConfig.php
index 4b43d969a27fbfa076cdde5e3d20fdaf89016f50..e8b5c6ca5af2be985e99b2be1a63960015d07fcc 100644 (file)
@@ -1,14 +1,16 @@
 <?php
-namespace Friendica\Core;
-
-use dba;
-use dbm;
-
 /**
+ * User Configuration Class
+ *
  * @file include/Core/PConfig.php
- * @brief contains the class with methods for the management
- * of the user configuration
+ *
+ * @brief Contains the class with methods for user configuration
  */
+namespace Friendica\Core;
+
+use Friendica\BaseObject;
+
+require_once 'include/dba.php';
 
 /**
  * @brief Management of user configuration storage
@@ -17,9 +19,26 @@ use dbm;
  * The PConfig::get() functions return boolean false for keys that are unset,
  * and this could lead to subtle bugs.
  */
-class PConfig {
+class PConfig extends BaseObject
+{
+       /**
+        * @var Friendica\Core\Config\IPConfigAdapter
+        */
+       private static $adapter = null;
+
+       public static function init($uid)
+       {
+               // Database isn't ready or populated yet
+               if (!(self::getApp()->mode & \Friendica\App::MODE_DBCONFIGAVAILABLE)) {
+                       return;
+               }
 
-       private static $in_db;
+               if (self::getApp()->getConfigValue('system', 'config_adapter') == 'preload') {
+                       self::$adapter = new Config\PreloadPConfigAdapter($uid);
+               } else {
+                       self::$adapter = new Config\JITPConfigAdapter($uid);
+               }
+       }
 
        /**
         * @brief Loads all configuration values of a user's config family into a cached storage.
@@ -27,27 +46,23 @@ class PConfig {
         * All configuration values of the given user are stored in global cache
         * which is available under the global variable $a->config[$uid].
         *
-        * @param string $uid
-        *  The user_id
-        * @param string $family
-        *  The category of the configuration value
+        * @param string $uid    The user_id
+        * @param string $family The category of the configuration value
+        *
         * @return void
         */
-       public static function load($uid, $family) {
-               $a = get_app();
-
-               $r = dba::select('pconfig', array('v', 'k'), array('cat' => $family, 'uid' => $uid),
-                               array("order" => array('uid', 'cat', 'k')));
-               if (dbm::is_result($r)) {
-                       while ($rr = dba::fetch($r)) {
-                               $k = $rr['k'];
-                               $a->config[$uid][$family][$k] = $rr['v'];
-                               self::$in_db[$uid][$family][$k] = true;
-                       }
-               } else if ($family != 'config') {
-                       // Negative caching
-                       $a->config[$uid][$family] = "!<unset>!";
+       public static function load($uid, $family)
+       {
+               // Database isn't ready or populated yet
+               if (!(self::getApp()->mode & \Friendica\App::MODE_DBCONFIGAVAILABLE)) {
+                       return;
                }
+
+               if (empty(self::$adapter)) {
+                       self::init($uid);
+               }
+
+               self::$adapter->load($uid, $family);
        }
 
        /**
@@ -57,52 +72,26 @@ class PConfig {
         * Get a particular user's config value from the given category ($family)
         * and the $key from a cached storage in $a->config[$uid].
         *
-        * @param string $uid
-        *  The user_id
-        * @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  $uid           The user_id
+        * @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
         */
-       public static function get($uid, $family, $key, $default_value = null, $refresh = false) {
-
-               $a = get_app();
-
-               if (!$refresh) {
-                       // Looking if the whole family isn't set
-                       if (isset($a->config[$uid][$family])) {
-                               if ($a->config[$uid][$family] === '!<unset>!') {
-                                       return $default_value;
-                               }
-                       }
-
-                       if (isset($a->config[$uid][$family][$key])) {
-                               if ($a->config[$uid][$family][$key] === '!<unset>!') {
-                                       return $default_value;
-                               }
-                               return $a->config[$uid][$family][$key];
-                       }
+       public static function get($uid, $family, $key, $default_value = null, $refresh = false)
+       {
+               // Database isn't ready or populated yet
+               if (!(self::getApp()->mode & \Friendica\App::MODE_DBCONFIGAVAILABLE)) {
+                       return;
                }
 
-               $ret = dba::select('pconfig', array('v'), array('uid' => $uid, 'cat' => $family, 'k' => $key),
-                               array("order" => array('uid', 'cat', 'k'), 'limit' => 1));
-               if (dbm::is_result($ret)) {
-                       $val = (preg_match("|^a:[0-9]+:{.*}$|s", $ret['v']) ? unserialize($ret['v']) : $ret['v']);
-                       $a->config[$uid][$family][$key] = $val;
-                       self::$in_db[$uid][$family][$key] = true;
-
-                       return $val;
-               } else {
-                       $a->config[$uid][$family][$key] = '!<unset>!';
-                       self::$in_db[$uid][$family][$key] = false;
-
-                       return $default_value;
+               if (empty(self::$adapter)) {
+                       self::init($uid);
                }
+
+               return self::$adapter->get($uid, $family, $key, $default_value, $refresh);
        }
 
        /**
@@ -113,58 +102,25 @@ class PConfig {
         *
         * @note Please do not store booleans - convert to 0/1 integer values!
         *
-        * @param string $uid
-        *  The user_id
-        * @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
+        * @param string $uid    The user_id
+        * @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 bool Operation success
         */
-       public static function set($uid, $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($uid, $family, $key, null, true);
-
-               if (($stored === $dbvalue) && self::$in_db[$uid][$family][$key]) {
-                       return true;
+       public static function set($uid, $family, $key, $value)
+       {
+               // Database isn't ready or populated yet
+               if (!(self::getApp()->mode & \Friendica\App::MODE_DBCONFIGAVAILABLE)) {
+                       return false;
                }
 
-               $a->config[$uid][$family][$key] = $dbvalue;
-
-               // manage array value
-               $dbvalue = (is_array($value) ? serialize($value) : $dbvalue);
-
-               if (is_null($stored) || !self::$in_db[$uid][$family][$key]) {
-                       $ret = q("INSERT INTO `pconfig` (`uid`, `cat`, `k`, `v`) VALUES (%d, '%s', '%s', '%s') ON DUPLICATE KEY UPDATE `v` = '%s'",
-                               intval($uid),
-                               dbesc($family),
-                               dbesc($key),
-                               dbesc($dbvalue),
-                               dbesc($dbvalue)
-                       );
-               } else {
-                       $ret = q("UPDATE `pconfig` SET `v` = '%s' WHERE `uid` = %d AND `cat` = '%s' AND `k` = '%s'",
-                               dbesc($dbvalue),
-                               intval($uid),
-                               dbesc($family),
-                               dbesc($key)
-                       );
+               if (empty(self::$adapter)) {
+                       self::init($uid);
                }
 
-               if ($ret) {
-                       self::$in_db[$uid][$family][$key] = true;
-                       return $value;
-               }
-               return $ret;
+               return self::$adapter->set($uid, $family, $key, $value);
        }
 
        /**
@@ -173,24 +129,23 @@ class PConfig {
         * Removes the configured value from the stored cache in $a->config[$uid]
         * and removes it from the database.
         *
-        * @param string $uid The user_id
-        * @param string $family
-        *  The category of the configuration value
-        * @param string $key
-        *  The configuration key to delete
+        * @param string $uid    The user_id
+        * @param string $family The category of the configuration value
+        * @param string $key    The configuration key to delete
+        *
         * @return mixed
         */
-       public static function delete($uid,$family,$key) {
-
-               $a = get_app();
-
-               if (x($a->config[$uid][$family], $key)) {
-                       unset($a->config[$uid][$family][$key]);
-                       unset(self::$in_db[$uid][$family][$key]);
+       public static function delete($uid, $family, $key)
+       {
+               // Database isn't ready or populated yet
+               if (!(self::getApp()->mode & \Friendica\App::MODE_DBCONFIGAVAILABLE)) {
+                       return false;
                }
 
-               $ret = dba::delete('pconfig', array('uid' => $uid, 'cat' => $family, 'k' => $key));
+               if (empty(self::$adapter)) {
+                       self::init($uid);
+               }
 
-               return $ret;
+               return self::$adapter->delete($uid, $family, $key);
        }
 }