From 7e8ea1cb87f74e83d2c2a7adbc4ee9575b393086 Mon Sep 17 00:00:00 2001 From: rabuzarus <> Date: Wed, 8 Jun 2016 11:02:18 +0200 Subject: [PATCH 1/2] move config to its own class (with legacy support) --- include/Config.php | 233 ++++++++++++++++++++++++++++++++++++++++++++ include/PConfig.php | 8 +- include/config.php | 176 +++------------------------------ 3 files changed, 253 insertions(+), 164 deletions(-) create mode 100644 include/Config.php diff --git a/include/Config.php b/include/Config.php new file mode 100644 index 000000000..62022b62b --- /dev/null +++ b/include/Config.php @@ -0,0 +1,233 @@ +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'", 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 boolean $instore Determines if the key already exists in the DB + * @return mixed Stored value or false if it does not exist + */ + public static function get($family, $key, $instore = false) { + + global $a; + + if(! $instore) { + // Looking if the whole family isn't set + if(isset($a->config[$family])) { + if($a->config[$family] === '!!') { + return false; + } + } + + if(isset($a->config[$family][$key])) { + if($a->config[$family][$key] === '!!') { + return false; + } + return $a->config[$family][$key]; + } + } + + // If APC is enabled then fetch the data from there, else try XCache + /*if (function_exists("apc_fetch") AND function_exists("apc_exists")) + if (apc_exists($family."|".$key)) { + $val = apc_fetch($family."|".$key); + $a->config[$family][$key] = $val; + + if ($val === '!!') + return false; + else + return $val; + } + elseif (function_exists("xcache_fetch") AND function_exists("xcache_isset")) + if (xcache_isset($family."|".$key)) { + $val = xcache_fetch($family."|".$key); + $a->config[$family][$key] = $val; + + if ($val === '!!') + return false; + else + return $val; + } + */ + + $ret = q("SELECT `v` FROM `config` WHERE `cat` = '%s' AND `k` = '%s' 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; + + // If APC is enabled then store the data there, else try XCache + /*if (function_exists("apc_store")) + apc_store($family."|".$key, $val, 600); + elseif (function_exists("xcache_set")) + xcache_set($family."|".$key, $val, 600);*/ + + return $val; + } + else { + $a->config[$family][$key] = '!!'; + + // If APC is enabled then store the data there, else try XCache + /*if (function_exists("apc_store")) + apc_store($family."|".$key, '!!', 600); + elseif (function_exists("xcache_set")) + xcache_set($family."|".$key, '!!', 600);*/ + } + return false; + } + + /** + * @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 $a->config[$family] has been previously set to '!!', then + // $a->config[$family][$key] will evaluate to $a->config[$family][0], and + // $a->config[$family][$key] = $value will be equivalent to + // $a->config[$family][0] = $value[0] (this causes infuriating bugs), + // so unset the family before assigning a value to a family's key + if($a->config[$family] === '!!') + unset($a->config[$family]); + + // manage array value + $dbvalue = (is_array($value)?serialize($value):$value); + $dbvalue = (is_bool($dbvalue) ? intval($dbvalue) : $dbvalue); + if(self::get($family,$key,true) === false) { + $a->config[$family][$key] = $value; + $ret = q("INSERT INTO `config` ( `cat`, `k`, `v` ) VALUES ( '%s', '%s', '%s' ) ", + dbesc($family), + dbesc($key), + dbesc($dbvalue) + ); + if($ret) + return $value; + return $ret; + } + + $ret = q("UPDATE `config` SET `v` = '%s' WHERE `cat` = '%s' AND `k` = '%s'", + dbesc($dbvalue), + dbesc($family), + dbesc($key) + ); + + $a->config[$family][$key] = $value; + + // If APC is enabled then store the data there, else try XCache + /*if (function_exists("apc_store")) + apc_store($family."|".$key, $value, 600); + elseif (function_exists("xcache_set")) + xcache_set($family."|".$key, $value, 600);*/ + + 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) + ); + // If APC is enabled then delete the data from there, else try XCache + /*if (function_exists("apc_delete")) + apc_delete($family."|".$key); + elseif (function_exists("xcache_unset")) + xcache_unset($family."|".$key);*/ + + return $ret; + } + +} diff --git a/include/PConfig.php b/include/PConfig.php index 9ef113699..06e470e97 100644 --- a/include/PConfig.php +++ b/include/PConfig.php @@ -7,7 +7,11 @@ */ /** - * @brief Management of user configuration + * @brief Management of user configuration storage + * Note: + * Please do not store booleans - convert to 0/1 integer values + * The PConfig::get() functions return boolean false for keys that are unset, + * and this could lead to subtle bugs. */ class PConfig { @@ -155,7 +159,7 @@ class PConfig { // manage array value $dbvalue = (is_array($value)?serialize($value):$value); - if(get_pconfig($uid,$family,$key,true) === false) { + if(self::get($uid,$family,$key,true) === false) { $a->config[$uid][$family][$key] = $value; $ret = q("INSERT INTO `pconfig` ( `uid`, `cat`, `k`, `v` ) VALUES ( %d, '%s', '%s', '%s' ) ", intval($uid), diff --git a/include/config.php b/include/config.php index 585caf43a..d8c97744e 100644 --- a/include/config.php +++ b/include/config.php @@ -1,11 +1,12 @@ config + * Note: This function is deprecated. Use Config::load() instead. * * @param string $family * The category of the configuration value * @return void */ function load_config($family) { - global $a; - - $r = q("SELECT `v`, `k` FROM `config` WHERE `cat` = '%s'", 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] = "!!"; - } + return Config::load($family); } /** - * @brief Get a particular user's config variable given the category name + * @brief (Deprecated) 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. + * Note: This function is deprecated. Use Config::get() instead. * * @param string $family * The category of the configuration value @@ -64,84 +43,13 @@ function load_config($family) { * @return mixed Stored value or false if it does not exist */ function get_config($family, $key, $instore = false) { - - global $a; - - if(! $instore) { - // Looking if the whole family isn't set - if(isset($a->config[$family])) { - if($a->config[$family] === '!!') { - return false; - } - } - - if(isset($a->config[$family][$key])) { - if($a->config[$family][$key] === '!!') { - return false; - } - return $a->config[$family][$key]; - } - } - - // If APC is enabled then fetch the data from there, else try XCache - /*if (function_exists("apc_fetch") AND function_exists("apc_exists")) - if (apc_exists($family."|".$key)) { - $val = apc_fetch($family."|".$key); - $a->config[$family][$key] = $val; - - if ($val === '!!') - return false; - else - return $val; - } - elseif (function_exists("xcache_fetch") AND function_exists("xcache_isset")) - if (xcache_isset($family."|".$key)) { - $val = xcache_fetch($family."|".$key); - $a->config[$family][$key] = $val; - - if ($val === '!!') - return false; - else - return $val; - } - */ - - $ret = q("SELECT `v` FROM `config` WHERE `cat` = '%s' AND `k` = '%s' 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; - - // If APC is enabled then store the data there, else try XCache - /*if (function_exists("apc_store")) - apc_store($family."|".$key, $val, 600); - elseif (function_exists("xcache_set")) - xcache_set($family."|".$key, $val, 600);*/ - - return $val; - } - else { - $a->config[$family][$key] = '!!'; - - // If APC is enabled then store the data there, else try XCache - /*if (function_exists("apc_store")) - apc_store($family."|".$key, '!!', 600); - elseif (function_exists("xcache_set")) - xcache_set($family."|".$key, '!!', 600);*/ - } - return false; + return Config::get($family, $key, $instore); } /** - * @brief Sets a configuration value for system config + * @brief (Deprecated) 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! + * Note: This function is deprecated. Use Config::set() instead. * * @param string $family * The category of the configuration value @@ -152,55 +60,13 @@ function get_config($family, $key, $instore = false) { * @return mixed Stored $value or false if the database update failed */ function set_config($family,$key,$value) { - global $a; - - // If $a->config[$family] has been previously set to '!!', then - // $a->config[$family][$key] will evaluate to $a->config[$family][0], and - // $a->config[$family][$key] = $value will be equivalent to - // $a->config[$family][0] = $value[0] (this causes infuriating bugs), - // so unset the family before assigning a value to a family's key - if($a->config[$family] === '!!') - unset($a->config[$family]); - - // manage array value - $dbvalue = (is_array($value)?serialize($value):$value); - $dbvalue = (is_bool($dbvalue) ? intval($dbvalue) : $dbvalue); - if(get_config($family,$key,true) === false) { - $a->config[$family][$key] = $value; - $ret = q("INSERT INTO `config` ( `cat`, `k`, `v` ) VALUES ( '%s', '%s', '%s' ) ", - dbesc($family), - dbesc($key), - dbesc($dbvalue) - ); - if($ret) - return $value; - return $ret; - } - - $ret = q("UPDATE `config` SET `v` = '%s' WHERE `cat` = '%s' AND `k` = '%s'", - dbesc($dbvalue), - dbesc($family), - dbesc($key) - ); - - $a->config[$family][$key] = $value; - - // If APC is enabled then store the data there, else try XCache - /*if (function_exists("apc_store")) - apc_store($family."|".$key, $value, 600); - elseif (function_exists("xcache_set")) - xcache_set($family."|".$key, $value, 600);*/ - - if($ret) - return $value; - return $ret; + return Config::set($family, $key, $value); } /** - * @brief Deletes the given key from the system configuration. + * @brief (Deprecated) 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. + * Note: This function is deprecated. Use Config::delete() instead. * * @param string $family * The category of the configuration value @@ -209,21 +75,7 @@ function set_config($family,$key,$value) { * @return mixed */ function del_config($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) - ); - // If APC is enabled then delete the data from there, else try XCache - /*if (function_exists("apc_delete")) - apc_delete($family."|".$key); - elseif (function_exists("xcache_unset")) - xcache_unset($family."|".$key);*/ - - return $ret; + return Config::delete($family, $key); } /** From 023c43fa4a9a5d041fa5a6c49bf5208816d0a05b Mon Sep 17 00:00:00 2001 From: rabuzarus <> Date: Wed, 8 Jun 2016 21:52:10 +0200 Subject: [PATCH 2/2] config && pconfig: return NULL if config is unset --- include/Config.php | 13 +++++++------ include/PConfig.php | 14 +++++++------- include/config.php | 23 ++++++++++++++++------- 3 files changed, 30 insertions(+), 20 deletions(-) diff --git a/include/Config.php b/include/Config.php index 62022b62b..e08a7de74 100644 --- a/include/Config.php +++ b/include/Config.php @@ -64,10 +64,11 @@ class Config { * The category of the configuration value * @param string $key * The configuration key to query - * @param boolean $instore Determines if the key already exists in the DB - * @return mixed Stored value or false if it does not exist + * @param boolean $refresh + * If true the config is loaded from the db and not from the cache + * @return mixed Stored value or null if it does not exist */ - public static function get($family, $key, $instore = false) { + public static function get($family, $key, $refresh = false) { global $a; @@ -75,13 +76,13 @@ class Config { // Looking if the whole family isn't set if(isset($a->config[$family])) { if($a->config[$family] === '!!') { - return false; + return null; } } if(isset($a->config[$family][$key])) { if($a->config[$family][$key] === '!!') { - return false; + return null; } return $a->config[$family][$key]; } @@ -136,7 +137,7 @@ class Config { elseif (function_exists("xcache_set")) xcache_set($family."|".$key, '!!', 600);*/ } - return false; + return null; } /** diff --git a/include/PConfig.php b/include/PConfig.php index 06e470e97..5ee4ec692 100644 --- a/include/PConfig.php +++ b/include/PConfig.php @@ -57,11 +57,11 @@ class PConfig { * The category of the configuration value * @param string $key * The configuration key to query - * @param boolean $instore - * Determines if the key already exists in the DB - * @return mixed Stored value or false if it does not exist + * @param boolean $refresh + * If true the config is loaded from the db and not from the cache + * @return mixed Stored value or null if it does not exist */ - public static function get($uid,$family, $key, $instore = false) { + public static function get($uid, $family, $key, $refresh = false) { global $a; @@ -69,13 +69,13 @@ class PConfig { // Looking if the whole family isn't set if(isset($a->config[$uid][$family])) { if($a->config[$uid][$family] === '!!') { - return false; + return null; } } if(isset($a->config[$uid][$family][$key])) { if($a->config[$uid][$family][$key] === '!!') { - return false; + return null; } return $a->config[$uid][$family][$key]; } @@ -131,7 +131,7 @@ class PConfig { elseif (function_exists("xcache_set")) xcache_set($uid."|".$family."|".$key, '!!', 600);*/ } - return false; + return null; } /** diff --git a/include/config.php b/include/config.php index d8c97744e..8f36dbdc8 100644 --- a/include/config.php +++ b/include/config.php @@ -39,11 +39,16 @@ function load_config($family) { * The category of the configuration value * @param string $key * The configuration key to query - * @param boolean $instore Determines if the key already exists in the DB + * @param boolean $refresh + * If true the config is loaded from the db and not from the cache * @return mixed Stored value or false if it does not exist */ -function get_config($family, $key, $instore = false) { - return Config::get($family, $key, $instore); +function get_config($family, $key, $refresh = false) { + $v = Config::get($family, $key, $refresh); + if(is_null($v)) + $v = false; + + return $v; } /** @@ -105,12 +110,16 @@ function load_pconfig($uid,$family) { * The category of the configuration value * @param string $key * The configuration key to query - * @param boolean $instore - * Determines if the key already exists in the DB + * @param boolean $refresh + * If true the config is loaded from the db and not from the cache * @return mixed Stored value or false if it does not exist */ -function get_pconfig($uid,$family, $key, $instore = false) { - return PConfig::get($uid, $family, $key, $instore); +function get_pconfig($uid, $family, $key, $refresh = false) { + $v = PConfig::get($uid, $family, $key, $refresh); + if(is_null($v)) + $v = false; + + return $v; } /**