move pconfig to it's own class PConfig
This commit is contained in:
rabuzarus
parent
5f081cc47b
commit
f10011c282
2 changed files with 230 additions and 145 deletions
216
include/PConfig.php
Normal file
216
include/PConfig.php
Normal file
|
|
@ -0,0 +1,216 @@
|
||||||
|
<?php
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @file include/PConfig.php
|
||||||
|
* @brief contains the class with methods for the management
|
||||||
|
* of the user configuration
|
||||||
|
*/
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @brief Management of user configuration
|
||||||
|
*/
|
||||||
|
class PConfig {
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @brief Loads all configuration values of a user's config family into a cached storage.
|
||||||
|
*
|
||||||
|
* 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
|
||||||
|
* @return void
|
||||||
|
*/
|
||||||
|
public static function load($uid,$family) {
|
||||||
|
global $a;
|
||||||
|
$r = q("SELECT `v`,`k` FROM `pconfig` WHERE `cat` = '%s' AND `uid` = %d",
|
||||||
|
dbesc($family),
|
||||||
|
intval($uid)
|
||||||
|
);
|
||||||
|
if(count($r)) {
|
||||||
|
foreach($r as $rr) {
|
||||||
|
$k = $rr['k'];
|
||||||
|
$a->config[$uid][$family][$k] = $rr['v'];
|
||||||
|
}
|
||||||
|
} else if ($family != 'config') {
|
||||||
|
// Negative caching
|
||||||
|
$a->config[$uid][$family] = "!<unset>!";
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @brief Get a particular user's config variable given the category name
|
||||||
|
* ($family) and a key.
|
||||||
|
*
|
||||||
|
* 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 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($uid,$family, $key, $instore = false) {
|
||||||
|
|
||||||
|
global $a;
|
||||||
|
|
||||||
|
if(! $instore) {
|
||||||
|
// Looking if the whole family isn't set
|
||||||
|
if(isset($a->config[$uid][$family])) {
|
||||||
|
if($a->config[$uid][$family] === '!<unset>!') {
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
if(isset($a->config[$uid][$family][$key])) {
|
||||||
|
if($a->config[$uid][$family][$key] === '!<unset>!') {
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
return $a->config[$uid][$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($uid."|".$family."|".$key)) {
|
||||||
|
$val = apc_fetch($uid."|".$family."|".$key);
|
||||||
|
$a->config[$uid][$family][$key] = $val;
|
||||||
|
|
||||||
|
if ($val === '!<unset>!')
|
||||||
|
return false;
|
||||||
|
else
|
||||||
|
return $val;
|
||||||
|
}
|
||||||
|
elseif (function_exists("xcache_get") AND function_exists("xcache_isset"))
|
||||||
|
if (xcache_isset($uid."|".$family."|".$key)) {
|
||||||
|
$val = xcache_get($uid."|".$family."|".$key);
|
||||||
|
$a->config[$uid][$family][$key] = $val;
|
||||||
|
|
||||||
|
if ($val === '!<unset>!')
|
||||||
|
return false;
|
||||||
|
else
|
||||||
|
return $val;
|
||||||
|
}*/
|
||||||
|
|
||||||
|
|
||||||
|
$ret = q("SELECT `v` FROM `pconfig` WHERE `uid` = %d AND `cat` = '%s' AND `k` = '%s' LIMIT 1",
|
||||||
|
intval($uid),
|
||||||
|
dbesc($family),
|
||||||
|
dbesc($key)
|
||||||
|
);
|
||||||
|
|
||||||
|
if(count($ret)) {
|
||||||
|
$val = (preg_match("|^a:[0-9]+:{.*}$|s", $ret[0]['v'])?unserialize( $ret[0]['v']):$ret[0]['v']);
|
||||||
|
$a->config[$uid][$family][$key] = $val;
|
||||||
|
|
||||||
|
// If APC is enabled then store the data there, else try XCache
|
||||||
|
/*if (function_exists("apc_store"))
|
||||||
|
apc_store($uid."|".$family."|".$key, $val, 600);
|
||||||
|
elseif (function_exists("xcache_set"))
|
||||||
|
xcache_set($uid."|".$family."|".$key, $val, 600);*/
|
||||||
|
|
||||||
|
return $val;
|
||||||
|
}
|
||||||
|
else {
|
||||||
|
$a->config[$uid][$family][$key] = '!<unset>!';
|
||||||
|
|
||||||
|
// If APC is enabled then store the data there, else try XCache
|
||||||
|
/*if (function_exists("apc_store"))
|
||||||
|
apc_store($uid."|".$family."|".$key, '!<unset>!', 600);
|
||||||
|
elseif (function_exists("xcache_set"))
|
||||||
|
xcache_set($uid."|".$family."|".$key, '!<unset>!', 600);*/
|
||||||
|
}
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @brief Sets a configuration value for a user
|
||||||
|
*
|
||||||
|
* 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 $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
|
||||||
|
*/
|
||||||
|
public static function set($uid,$family,$key,$value) {
|
||||||
|
|
||||||
|
global $a;
|
||||||
|
|
||||||
|
// manage array value
|
||||||
|
$dbvalue = (is_array($value)?serialize($value):$value);
|
||||||
|
|
||||||
|
if(get_pconfig($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),
|
||||||
|
dbesc($family),
|
||||||
|
dbesc($key),
|
||||||
|
dbesc($dbvalue)
|
||||||
|
);
|
||||||
|
if($ret)
|
||||||
|
return $value;
|
||||||
|
return $ret;
|
||||||
|
}
|
||||||
|
$ret = q("UPDATE `pconfig` SET `v` = '%s' WHERE `uid` = %d AND `cat` = '%s' AND `k` = '%s'",
|
||||||
|
dbesc($dbvalue),
|
||||||
|
intval($uid),
|
||||||
|
dbesc($family),
|
||||||
|
dbesc($key)
|
||||||
|
);
|
||||||
|
|
||||||
|
$a->config[$uid][$family][$key] = $value;
|
||||||
|
|
||||||
|
// If APC is enabled then store the data there, else try XCache
|
||||||
|
/*if (function_exists("apc_store"))
|
||||||
|
apc_store($uid."|".$family."|".$key, $value, 600);
|
||||||
|
elseif (function_exists("xcache_set"))
|
||||||
|
xcache_set($uid."|".$family."|".$key, $value, 600);*/
|
||||||
|
|
||||||
|
|
||||||
|
if($ret)
|
||||||
|
return $value;
|
||||||
|
return $ret;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @brief Deletes the given key from the users's configuration.
|
||||||
|
*
|
||||||
|
* 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
|
||||||
|
* @return mixed
|
||||||
|
*/
|
||||||
|
public static function del($uid,$family,$key) {
|
||||||
|
|
||||||
|
global $a;
|
||||||
|
if(x($a->config[$uid][$family],$key))
|
||||||
|
unset($a->config[$uid][$family][$key]);
|
||||||
|
$ret = q("DELETE FROM `pconfig` WHERE `uid` = %d AND `cat` = '%s' AND `k` = '%s'",
|
||||||
|
intval($uid),
|
||||||
|
dbesc($family),
|
||||||
|
dbesc($key)
|
||||||
|
);
|
||||||
|
return $ret;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
@ -1,5 +1,7 @@
|
||||||
<?php
|
<?php
|
||||||
|
|
||||||
|
require_once("include/PConfig.php");
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @file include/config.php
|
* @file include/config.php
|
||||||
*
|
*
|
||||||
|
|
@ -225,10 +227,9 @@ function del_config($family,$key) {
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @brief Loads all configuration values of a user's config family into a cached storage.
|
* @brief (Deprecated) Loads all configuration values of a user's config family into a cached storage.
|
||||||
*
|
*
|
||||||
* All configuration values of the given user are stored in global cache
|
* Note: This function is deprecated. Use PConfig::load() instead.
|
||||||
* which is available under the global variable $a->config[$uid].
|
|
||||||
*
|
*
|
||||||
* @param string $uid
|
* @param string $uid
|
||||||
* The user_id
|
* The user_id
|
||||||
|
|
@ -237,28 +238,14 @@ function del_config($family,$key) {
|
||||||
* @return void
|
* @return void
|
||||||
*/
|
*/
|
||||||
function load_pconfig($uid,$family) {
|
function load_pconfig($uid,$family) {
|
||||||
global $a;
|
return PConfig::load($uid, $family);
|
||||||
$r = q("SELECT `v`,`k` FROM `pconfig` WHERE `cat` = '%s' AND `uid` = %d",
|
|
||||||
dbesc($family),
|
|
||||||
intval($uid)
|
|
||||||
);
|
|
||||||
if(count($r)) {
|
|
||||||
foreach($r as $rr) {
|
|
||||||
$k = $rr['k'];
|
|
||||||
$a->config[$uid][$family][$k] = $rr['v'];
|
|
||||||
}
|
|
||||||
} else if ($family != 'config') {
|
|
||||||
// Negative caching
|
|
||||||
$a->config[$uid][$family] = "!<unset>!";
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @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.
|
* ($family) and a key.
|
||||||
*
|
*
|
||||||
* Get a particular user's config value from the given category ($family)
|
* Note: This function is deprecated. Use PConfig::get() instead.
|
||||||
* and the $key from a cached storage in $a->config[$uid].
|
|
||||||
*
|
*
|
||||||
* @param string $uid
|
* @param string $uid
|
||||||
* The user_id
|
* The user_id
|
||||||
|
|
@ -271,85 +258,13 @@ function load_pconfig($uid,$family) {
|
||||||
* @return mixed Stored value or false if it does not exist
|
* @return mixed Stored value or false if it does not exist
|
||||||
*/
|
*/
|
||||||
function get_pconfig($uid,$family, $key, $instore = false) {
|
function get_pconfig($uid,$family, $key, $instore = false) {
|
||||||
|
return PConfig::get($uid, $family, $key, $instore);
|
||||||
global $a;
|
|
||||||
|
|
||||||
if(! $instore) {
|
|
||||||
// Looking if the whole family isn't set
|
|
||||||
if(isset($a->config[$uid][$family])) {
|
|
||||||
if($a->config[$uid][$family] === '!<unset>!') {
|
|
||||||
return false;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
if(isset($a->config[$uid][$family][$key])) {
|
|
||||||
if($a->config[$uid][$family][$key] === '!<unset>!') {
|
|
||||||
return false;
|
|
||||||
}
|
|
||||||
return $a->config[$uid][$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($uid."|".$family."|".$key)) {
|
|
||||||
$val = apc_fetch($uid."|".$family."|".$key);
|
|
||||||
$a->config[$uid][$family][$key] = $val;
|
|
||||||
|
|
||||||
if ($val === '!<unset>!')
|
|
||||||
return false;
|
|
||||||
else
|
|
||||||
return $val;
|
|
||||||
}
|
|
||||||
elseif (function_exists("xcache_get") AND function_exists("xcache_isset"))
|
|
||||||
if (xcache_isset($uid."|".$family."|".$key)) {
|
|
||||||
$val = xcache_get($uid."|".$family."|".$key);
|
|
||||||
$a->config[$uid][$family][$key] = $val;
|
|
||||||
|
|
||||||
if ($val === '!<unset>!')
|
|
||||||
return false;
|
|
||||||
else
|
|
||||||
return $val;
|
|
||||||
}*/
|
|
||||||
|
|
||||||
|
|
||||||
$ret = q("SELECT `v` FROM `pconfig` WHERE `uid` = %d AND `cat` = '%s' AND `k` = '%s' LIMIT 1",
|
|
||||||
intval($uid),
|
|
||||||
dbesc($family),
|
|
||||||
dbesc($key)
|
|
||||||
);
|
|
||||||
|
|
||||||
if(count($ret)) {
|
|
||||||
$val = (preg_match("|^a:[0-9]+:{.*}$|s", $ret[0]['v'])?unserialize( $ret[0]['v']):$ret[0]['v']);
|
|
||||||
$a->config[$uid][$family][$key] = $val;
|
|
||||||
|
|
||||||
// If APC is enabled then store the data there, else try XCache
|
|
||||||
/*if (function_exists("apc_store"))
|
|
||||||
apc_store($uid."|".$family."|".$key, $val, 600);
|
|
||||||
elseif (function_exists("xcache_set"))
|
|
||||||
xcache_set($uid."|".$family."|".$key, $val, 600);*/
|
|
||||||
|
|
||||||
return $val;
|
|
||||||
}
|
|
||||||
else {
|
|
||||||
$a->config[$uid][$family][$key] = '!<unset>!';
|
|
||||||
|
|
||||||
// If APC is enabled then store the data there, else try XCache
|
|
||||||
/*if (function_exists("apc_store"))
|
|
||||||
apc_store($uid."|".$family."|".$key, '!<unset>!', 600);
|
|
||||||
elseif (function_exists("xcache_set"))
|
|
||||||
xcache_set($uid."|".$family."|".$key, '!<unset>!', 600);*/
|
|
||||||
}
|
|
||||||
return false;
|
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @brief Sets a configuration value for a user
|
* @brief (Deprecated) Sets a configuration value for a user
|
||||||
*
|
*
|
||||||
* Stores a config value ($value) in the category ($family) under the key ($key)
|
* Note: This function is deprecated. Use PConfig::set() instead.
|
||||||
* for the user_id $uid.
|
|
||||||
*
|
|
||||||
* @note Please do not store booleans - convert to 0/1 integer values!
|
|
||||||
*
|
*
|
||||||
* @param string $uid
|
* @param string $uid
|
||||||
* The user_id
|
* The user_id
|
||||||
|
|
@ -362,50 +277,13 @@ function get_pconfig($uid,$family, $key, $instore = false) {
|
||||||
* @return mixed Stored $value or false
|
* @return mixed Stored $value or false
|
||||||
*/
|
*/
|
||||||
function set_pconfig($uid,$family,$key,$value) {
|
function set_pconfig($uid,$family,$key,$value) {
|
||||||
|
return PConfig::set($uid, $family, $key, $value);
|
||||||
global $a;
|
|
||||||
|
|
||||||
// manage array value
|
|
||||||
$dbvalue = (is_array($value)?serialize($value):$value);
|
|
||||||
|
|
||||||
if(get_pconfig($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),
|
|
||||||
dbesc($family),
|
|
||||||
dbesc($key),
|
|
||||||
dbesc($dbvalue)
|
|
||||||
);
|
|
||||||
if($ret)
|
|
||||||
return $value;
|
|
||||||
return $ret;
|
|
||||||
}
|
|
||||||
$ret = q("UPDATE `pconfig` SET `v` = '%s' WHERE `uid` = %d AND `cat` = '%s' AND `k` = '%s'",
|
|
||||||
dbesc($dbvalue),
|
|
||||||
intval($uid),
|
|
||||||
dbesc($family),
|
|
||||||
dbesc($key)
|
|
||||||
);
|
|
||||||
|
|
||||||
$a->config[$uid][$family][$key] = $value;
|
|
||||||
|
|
||||||
// If APC is enabled then store the data there, else try XCache
|
|
||||||
/*if (function_exists("apc_store"))
|
|
||||||
apc_store($uid."|".$family."|".$key, $value, 600);
|
|
||||||
elseif (function_exists("xcache_set"))
|
|
||||||
xcache_set($uid."|".$family."|".$key, $value, 600);*/
|
|
||||||
|
|
||||||
|
|
||||||
if($ret)
|
|
||||||
return $value;
|
|
||||||
return $ret;
|
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @brief Deletes the given key from the users's configuration.
|
* @brief (Deprecated) Deletes the given key from the users's configuration.
|
||||||
*
|
*
|
||||||
* Removes the configured value from the stored cache in $a->config[$uid]
|
* Note: This function is deprecated. Use PConfig::del() instead.
|
||||||
* and removes it from the database.
|
|
||||||
*
|
*
|
||||||
* @param string $uid The user_id
|
* @param string $uid The user_id
|
||||||
* @param string $family
|
* @param string $family
|
||||||
|
|
@ -415,14 +293,5 @@ function set_pconfig($uid,$family,$key,$value) {
|
||||||
* @return mixed
|
* @return mixed
|
||||||
*/
|
*/
|
||||||
function del_pconfig($uid,$family,$key) {
|
function del_pconfig($uid,$family,$key) {
|
||||||
|
return PConfig::del($uid, $family, $key);
|
||||||
global $a;
|
|
||||||
if(x($a->config[$uid][$family],$key))
|
|
||||||
unset($a->config[$uid][$family][$key]);
|
|
||||||
$ret = q("DELETE FROM `pconfig` WHERE `uid` = %d AND `cat` = '%s' AND `k` = '%s'",
|
|
||||||
intval($uid),
|
|
||||||
dbesc($family),
|
|
||||||
dbesc($key)
|
|
||||||
);
|
|
||||||
return $ret;
|
|
||||||
}
|
}
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue