config * * @param string $family * The category of the configuration value * @return void */ public static function load($family) { global $a; $r = q("SELECT `v`, `k` FROM `config` WHERE `cat` = '%s' ORDER BY `cat`, `k`, `id`", dbesc($family)); if(count($r)) { foreach($r as $rr) { $k = $rr['k']; if ($family === 'config') { $a->config[$k] = $rr['v']; } else { $a->config[$family][$k] = $rr['v']; } } } else if ($family != 'config') { // Negative caching $a->config[$family] = "!!"; } } /** * @brief Get a particular user's config variable given the category name * ($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]. * $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 * 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) * @return mixed Stored value or null if it does not exist */ public static function get($family, $key, $default_value = null, $refresh = false) { global $a; if(! $refresh) { // Looking if the whole family isn't set if(isset($a->config[$family])) { if($a->config[$family] === '!!') { return $default_value; } } if(isset($a->config[$family][$key])) { if($a->config[$family][$key] === '!!') { return $default_value; } return $a->config[$family][$key]; } } $ret = q("SELECT `v` FROM `config` WHERE `cat` = '%s' AND `k` = '%s' ORDER BY `id` DESC LIMIT 1", dbesc($family), dbesc($key) ); if(count($ret)) { // manage array value $val = (preg_match("|^a:[0-9]+:{.*}$|s", $ret[0]['v'])?unserialize( $ret[0]['v']):$ret[0]['v']); $a->config[$family][$key] = $val; return $val; } else { $a->config[$family][$key] = '!!'; } return $default_value; } /** * @brief Sets a configuration value for system config * * Stores a config value ($value) in the category ($family) under the key ($key) * for the user_id $uid. * * 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 */ public static function set($family, $key, $value) { global $a; if (self::get($family, $key) == $value) { return true; } $a->config[$family][$key] = $value; // manage array value $dbvalue = is_array($value) ? serialize($value) : $value; $dbvalue = is_bool($dbvalue) ? intval($dbvalue) : $dbvalue; $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) ); if ($ret) { return $value; } return $ret; } /** * @brief Deletes the given key from the system configuration. * * 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 * @return mixed */ public static function delete($family,$key) { global $a; if(x($a->config[$family],$key)) unset($a->config[$family][$key]); $ret = q("DELETE FROM `config` WHERE `cat` = '%s' AND `k` = '%s'", dbesc($family), dbesc($key) ); return $ret; } }