src/Core/Config.php

   1 <?php
   2 /**
   3  * System Configuration Class
   4  *
   5  * @file include/Core/Config.php
   6  *
   7  * @brief Contains the class with methods for system configuration
   8  */
   9 namespace Friendica\Core;
  10
  11 use Friendica\Database\DBM;
  12 use dba;
  13
  14 /**
  15  * @brief Arbitrary sytem configuration storage
  16  * Note:
  17  * Please do not store booleans - convert to 0/1 integer values
  18  * The Config::get() functions return boolean false for keys that are unset,
  19  * and this could lead to subtle bugs.
  20  *
  21  * There are a few places in the code (such as the admin panel) where boolean
  22  * configurations need to be fixed as of 10/08/2011.
  23  */
  24 class Config {
  25
  26         private static $cache;
  27         private static $in_db;
  28
  29         /**
  30          * @brief Loads all configuration values of family into a cached storage.
  31          *
  32          * All configuration values of the system are stored in global cache
  33          * which is available under the global variable $a->config
  34          *
  35          * @param string $family
  36          *  The category of the configuration value
  37          * @return void
  38          */
  39         public static function load($family = "config") {
  40
  41                 // We don't preload "system" anymore.
  42                 // This reduces the number of database reads a lot.
  43                 if ($family === 'system') {
  44                         return;
  45                 }
  46
  47                 $a = get_app();
  48
  49                 $r = dba::select('config', array('v', 'k'), array('cat' => $family));
  50                 while ($rr = dba::fetch($r)) {
  51                         $k = $rr['k'];
  52                         if ($family === 'config') {
  53                                 $a->config[$k] = $rr['v'];
  54                         } else {
  55                                 $a->config[$family][$k] = $rr['v'];
  56                                 self::$cache[$family][$k] = $rr['v'];
  57                                 self::$in_db[$family][$k] = true;
  58                         }
  59                 }
  60                 dba::close($r);
  61         }
  62
  63         /**
  64          * @brief Get a particular user's config variable given the category name
  65          * ($family) and a key.
  66          *
  67          * Get a particular config value from the given category ($family)
  68          * and the $key from a cached storage in $a->config[$uid].
  69          * $instore is only used by the set_config function
  70          * to determine if the key already exists in the DB
  71          * If a key is found in the DB but doesn't exist in
  72          * local config cache, pull it into the cache so we don't have
  73          * to hit the DB again for this item.
  74          *
  75          * @param string $family
  76          *  The category of the configuration value
  77          * @param string $key
  78          *  The configuration key to query
  79          * @param mixed $default_value optional
  80          *  The value to return if key is not set (default: null)
  81          * @param boolean $refresh optional
  82          *  If true the config is loaded from the db and not from the cache (default: false)
  83          * @return mixed Stored value or null if it does not exist
  84          */
  85         public static function get($family, $key, $default_value = null, $refresh = false) {
  86
  87                 $a = get_app();
  88
  89                 if (!$refresh) {
  90                         // Do we have the cached value? Then return it
  91                         if (isset(self::$cache[$family][$key])) {
  92                                 if (self::$cache[$family][$key] === '!<unset>!') {
  93                                         return $default_value;
  94                                 } else {
  95                                         return self::$cache[$family][$key];
  96                                 }
  97                         }
  98                 }
  99
 100                 $ret = dba::select('config', array('v'), array('cat' => $family, 'k' => $key), array('limit' => 1));
 101                 if (DBM::is_result($ret)) {
 102                         // manage array value
 103                         $val = (preg_match("|^a:[0-9]+:{.*}$|s", $ret['v']) ? unserialize($ret['v']) : $ret['v']);
 104
 105                         // Assign the value from the database to the cache
 106                         self::$cache[$family][$key] = $val;
 107                         self::$in_db[$family][$key] = true;
 108                         return $val;
 109                 } elseif (isset($a->config[$family][$key])) {
 110                         // Assign the value (mostly) from the .htconfig.php to the cache
 111                         self::$cache[$family][$key] = $a->config[$family][$key];
 112                         self::$in_db[$family][$key] = false;
 113
 114                         return $a->config[$family][$key];
 115                 }
 116
 117                 self::$cache[$family][$key] = '!<unset>!';
 118                 self::$in_db[$family][$key] = false;
 119
 120                 return $default_value;
 121         }
 122
 123         /**
 124          * @brief Sets a configuration value for system config
 125          *
 126          * Stores a config value ($value) in the category ($family) under the key ($key)
 127          * for the user_id $uid.
 128          *
 129          * Note: Please do not store booleans - convert to 0/1 integer values!
 130          *
 131          * @param string $family
 132          *  The category of the configuration value
 133          * @param string $key
 134          *  The configuration key to set
 135          * @param string $value
 136          *  The value to store
 137          * @return mixed Stored $value or false if the database update failed
 138          */
 139         public static function set($family, $key, $value) {
 140                 $a = get_app();
 141
 142                 // We store our setting values in a string variable.
 143                 // So we have to do the conversion here so that the compare below works.
 144                 // The exception are array values.
 145                 $dbvalue = (!is_array($value) ? (string)$value : $value);
 146
 147                 $stored = self::get($family, $key, null, true);
 148
 149                 if (($stored === $dbvalue) && self::$in_db[$family][$key]) {
 150                         return true;
 151                 }
 152
 153                 if ($family === 'config') {
 154                         $a->config[$key] = $dbvalue;
 155                 } elseif ($family != 'system') {
 156                         $a->config[$family][$key] = $dbvalue;
 157                 }
 158
 159                 // Assign the just added value to the cache
 160                 self::$cache[$family][$key] = $dbvalue;
 161
 162                 // manage array value
 163                 $dbvalue = (is_array($value) ? serialize($value) : $dbvalue);
 164
 165                 dba::update('config', array('v' => $dbvalue), array('cat' => $family, 'k' => $key), true);
 166
 167                 if ($ret) {
 168                         self::$in_db[$family][$key] = true;
 169                         return $value;
 170                 }
 171                 return $ret;
 172         }
 173
 174         /**
 175          * @brief Deletes the given key from the system configuration.
 176          *
 177          * Removes the configured value from the stored cache in $a->config
 178          * and removes it from the database.
 179          *
 180          * @param string $family
 181          *  The category of the configuration value
 182          * @param string $key
 183          *  The configuration key to delete
 184          * @return mixed
 185          */
 186         public static function delete($family, $key) {
 187
 188                 if (isset(self::$cache[$family][$key])) {
 189                         unset(self::$cache[$family][$key]);
 190                         unset(self::$in_db[$family][$key]);
 191                 }
 192
 193                 $ret = dba::delete('config', array('cat' => $family, 'k' => $key));
 194
 195                 return $ret;
 196         }
 197 }