3 * System Configuration Class
5 * @file include/Core/Config.php
7 * @brief Contains the class with methods for system configuration
9 namespace Friendica\Core;
11 use Friendica\Database\DBM;
14 require_once 'include/dba.php';
17 * @brief Arbitrary sytem configuration storage
20 * If we ever would decide to return exactly the variable type as entered,
21 * we will have fun with the additional features. :-)
23 * The config class always returns strings but in the default features
24 * we use a "false" to determine if the config value isn't set.
29 private static $cache;
30 private static $in_db;
33 * @brief Loads all configuration values of family into a cached storage.
35 * All configuration values of the system are stored in global cache
36 * which is available under the global variable $a->config
38 * @param string $family The category of the configuration value
42 public static function load($family = "config")
44 // We don't preload "system" anymore.
45 // This reduces the number of database reads a lot.
46 if ($family === 'system') {
52 $r = dba::select('config', array('v', 'k'), array('cat' => $family));
53 while ($rr = dba::fetch($r)) {
55 if ($family === 'config') {
56 $a->config[$k] = $rr['v'];
58 $a->config[$family][$k] = $rr['v'];
59 self::$cache[$family][$k] = $rr['v'];
60 self::$in_db[$family][$k] = true;
67 * @brief Get a particular user's config variable given the category name
68 * ($family) and a key.
70 * Get a particular config value from the given category ($family)
71 * and the $key from a cached storage in $a->config[$uid].
72 * $instore is only used by the set_config function
73 * to determine if the key already exists in the DB
74 * If a key is found in the DB but doesn't exist in
75 * local config cache, pull it into the cache so we don't have
76 * to hit the DB again for this item.
78 * @param string $family The category of the configuration value
79 * @param string $key The configuration key to query
80 * @param mixed $default_value optional, The value to return if key is not set (default: null)
81 * @param boolean $refresh optional, 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
85 public static function get($family, $key, $default_value = null, $refresh = false)
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;
95 return self::$cache[$family][$key];
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']);
105 // Assign the value from the database to the cache
106 self::$cache[$family][$key] = $val;
107 self::$in_db[$family][$key] = true;
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;
114 return $a->config[$family][$key];
117 self::$cache[$family][$key] = '!<unset>!';
118 self::$in_db[$family][$key] = false;
120 return $default_value;
124 * @brief Sets a configuration value for system config
126 * Stores a config value ($value) in the category ($family) under the key ($key)
127 * for the user_id $uid.
129 * Note: Please do not store booleans - convert to 0/1 integer values!
131 * @param string $family The category of the configuration value
132 * @param string $key The configuration key to set
133 * @param string $value The value to store
135 * @return mixed Stored $value or false if the database update failed
137 public static function set($family, $key, $value)
141 // We store our setting values in a string variable.
142 // So we have to do the conversion here so that the compare below works.
143 // The exception are array values.
144 $dbvalue = (!is_array($value) ? (string)$value : $value);
146 $stored = self::get($family, $key, null, true);
148 if (($stored === $dbvalue) && self::$in_db[$family][$key]) {
152 if ($family === 'config') {
153 $a->config[$key] = $dbvalue;
154 } elseif ($family != 'system') {
155 $a->config[$family][$key] = $dbvalue;
158 // Assign the just added value to the cache
159 self::$cache[$family][$key] = $dbvalue;
161 // manage array value
162 $dbvalue = (is_array($value) ? serialize($value) : $dbvalue);
164 $ret = dba::update('config', array('v' => $dbvalue), array('cat' => $family, 'k' => $key), true);
167 self::$in_db[$family][$key] = true;
174 * @brief Deletes the given key from the system configuration.
176 * Removes the configured value from the stored cache in $a->config
177 * and removes it from the database.
179 * @param string $family The category of the configuration value
180 * @param string $key The configuration key to delete
184 public static function delete($family, $key)
186 if (isset(self::$cache[$family][$key])) {
187 unset(self::$cache[$family][$key]);
188 unset(self::$in_db[$family][$key]);
191 $ret = dba::delete('config', array('cat' => $family, 'k' => $key));