Merge remote-tracking branch 'origin/master'

This commit is contained in:
tommy tomson 2012-04-06 12:24:05 +02:00
commit 52d5ef905e

298
include/config.php Normal file → Executable file
View file

@ -1,87 +1,80 @@
<?php <?php
/** /**
* *
* Arbitrary configuration storage * Arbitrary configuration storage
* Note: * Note:
* Please do not store booleans - convert to 0/1 integer values * Please do not store booleans - convert to 0/1 integer values
* The get_?config() functions return boolean false for keys that are unset, * The get_?config() functions return boolean false for keys that are unset,
* and this could lead to subtle bugs. * and this could lead to subtle bugs.
* *
* There are a few places in the code (such as the admin panel) where boolean * There are a few places in the code (such as the admin panel) where boolean
* configurations need to be fixed as of 10/08/2011. * configurations need to be fixed as of 10/08/2011.
*
* @package config;
*/ */
/** // retrieve a "family" of config variables from database to cached storage
* retrieve a "family" of config variables
* from database to cached storage
*/
if(! function_exists('load_config')) { if(! function_exists('load_config')) {
function load_config($family) { function load_config($family) {
global $a; global $a;
$r = q("SELECT * FROM `config` WHERE `cat` = '%s'", $r = q("SELECT * FROM `config` WHERE `cat` = '%s'",
dbesc($family) dbesc($family)
); );
if(count($r)) { if(count($r)) {
foreach($r as $rr) { foreach($r as $rr) {
$k = $rr['k']; $k = $rr['k'];
if ($rr['cat'] === 'config') { if ($rr['cat'] === 'config') {
$a->config[$k] = $rr['v']; $a->config[$k] = $rr['v'];
} else { } else {
$a->config[$family][$k] = $rr['v']; $a->config[$family][$k] = $rr['v'];
}
} }
} }
} }
} }}
// get a particular config variable given the family name
// and key. Returns false if not set.
// $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.
/**
* get a particular config variable given the family name
* and key. Returns false if not set.
*
* 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.
*/
if(! function_exists('get_config')) { if(! function_exists('get_config')) {
function get_config($family, $key) { function get_config($family, $key, $instore = false) {
global $a;
global $a;
if(! $instore) {
if(isset($a->config[$family][$key])) { if(isset($a->config[$family][$key])) {
if($a->config[$family][$key] === '!<unset>!') { if($a->config[$family][$key] === '!<unset>!') {
return false; return false;
} }
return $a->config[$family][$key]; return $a->config[$family][$key];
} }
$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]+:{.*}$|", $ret[0]['v'])?unserialize( $ret[0]['v']):$ret[0]['v']);
$a->config[$family][$key] = $val;
return $val;
}
else {
$a->config[$family][$key] = '!<unset>!';
}
return false;
} }
} $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]+:{.*}$|", $ret[0]['v'])?unserialize( $ret[0]['v']):$ret[0]['v']);
$a->config[$family][$key] = $val;
return $val;
}
else {
$a->config[$family][$key] = '!<unset>!';
}
return false;
}}
// Store a config value ($value) in the category ($family)
// under the key ($key)
// Return the value, or false if the database update failed
/**
* Store a config value ($value) in the category ($family)
* under the key ($key)
*
* Return the value, or false if the database update failed
*/
if(! function_exists('set_config')) { if(! function_exists('set_config')) {
function set_config($family,$key,$value) { function set_config($family,$key,$value) {
global $a; global $a;
@ -89,139 +82,142 @@ function set_config($family,$key,$value) {
$dbvalue = (is_array($value)?serialize($value):$value); $dbvalue = (is_array($value)?serialize($value):$value);
$dbvalue = (is_bool($value) ? intval($value) : $value); $dbvalue = (is_bool($value) ? intval($value) : $value);
if(get_config($family,$key,true) === false) {
$a->config[$family][$key] = $value; $a->config[$family][$key] = $value;
$ret = q("REPLACE INTO `config` ( `cat`, `k`, `v` ) VALUES ( '%s', '%s', '%s' ) ", $ret = q("INSERT INTO `config` ( `cat`, `k`, `v` ) VALUES ( '%s', '%s', '%s' ) ",
dbesc($family), dbesc($family),
dbesc($key), dbesc($key),
dbesc($dbvalue) dbesc($dbvalue)
); );
if($ret) { if($ret)
return $value; return $value;
}
return $ret; return $ret;
} }
}
$ret = q("UPDATE `config` SET `v` = '%s' WHERE `cat` = '%s' AND `k` = '%s' LIMIT 1",
dbesc($dbvalue),
dbesc($family),
dbesc($key)
);
$a->config[$family][$key] = $value;
if($ret)
return $value;
return $ret;
}}
if(! function_exists('load_pconfig')) { if(! function_exists('load_pconfig')) {
function load_pconfig($uid,$family) { function load_pconfig($uid,$family) {
global $a; global $a;
$r = q("SELECT * FROM `pconfig` WHERE `cat` = '%s' AND `uid` = %d", $r = q("SELECT * FROM `pconfig` WHERE `cat` = '%s' AND `uid` = %d",
dbesc($family), dbesc($family),
intval($uid) intval($uid)
); );
if(count($r)) { if(count($r)) {
foreach($r as $rr) { foreach($r as $rr) {
$k = $rr['k']; $k = $rr['k'];
$a->config[$uid][$family][$k] = $rr['v']; $a->config[$uid][$family][$k] = $rr['v'];
}
} }
} }
} }}
/**
* get a particular user-specific config variable given the family name,
* the user id and key. Returns false if not set.
*
* 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.
*/
if(! function_exists('get_pconfig')) { if(! function_exists('get_pconfig')) {
function get_pconfig($uid,$family, $key) { function get_pconfig($uid,$family, $key, $instore = false) {
global $a;
global $a;
if(! $instore) {
if(isset($a->config[$uid][$family][$key])) { if(isset($a->config[$uid][$family][$key])) {
if($a->config[$uid][$family][$key] === '!<unset>!') { if($a->config[$uid][$family][$key] === '!<unset>!') {
return false; return false;
} }
return $a->config[$uid][$family][$key]; return $a->config[$uid][$family][$key];
} }
$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]+:{.*}$|", $ret[0]['v'])?unserialize( $ret[0]['v']):$ret[0]['v']);
$a->config[$uid][$family][$key] = $val;
return $val;
}
else {
$a->config[$uid][$family][$key] = '!<unset>!';
}
return false;
} }
}
/** $ret = q("SELECT `v` FROM `pconfig` WHERE `uid` = %d AND `cat` = '%s' AND `k` = '%s' LIMIT 1",
* Delete a value from config. This function intval($uid),
* deletes both: db value and cache entry. dbesc($family),
*/ dbesc($key)
);
if(count($ret)) {
$val = (preg_match("|^a:[0-9]+:{.*}$|", $ret[0]['v'])?unserialize( $ret[0]['v']):$ret[0]['v']);
$a->config[$uid][$family][$key] = $val;
return $val;
}
else {
$a->config[$uid][$family][$key] = '!<unset>!';
}
return false;
}}
if(! function_exists('del_config')) { if(! function_exists('del_config')) {
function del_config($family,$key) { function del_config($family,$key) {
global $a; global $a;
if(x($a->config[$family],$key)) if(x($a->config[$family],$key))
unset($a->config[$family][$key]); unset($a->config[$family][$key]);
$ret = q("DELETE FROM `config` WHERE `cat` = '%s' AND `k` = '%s' LIMIT 1", $ret = q("DELETE FROM `config` WHERE `cat` = '%s' AND `k` = '%s' LIMIT 1",
dbesc($family), dbesc($family),
dbesc($key) dbesc($key)
); );
return $ret; return $ret;
} }}
}
/**
* Store a user-specific config value ($value) for user $uid in the category ($family) // Same as above functions except these are for personal config storage and take an
* under the key ($key). // additional $uid argument.
*
* Return the value, or false if the database update failed
*/
if(! function_exists('set_pconfig')) { if(! function_exists('set_pconfig')) {
function set_pconfig($uid,$family,$key,$value) { function set_pconfig($uid,$family,$key,$value) {
global $a; global $a;
// manage array value
$dbvalue = (is_array($value)?serialize($value):$value);
$dbvalue = (is_bool($value)?serialize($value):$value);
// manage array value
$dbvalue = (is_array($value)?serialize($value):$value);
if(get_pconfig($uid,$family,$key,true) === false) {
$a->config[$uid][$family][$key] = $value; $a->config[$uid][$family][$key] = $value;
$ret = q("REPLACE INTO `pconfig` ( `uid`, `cat`, `k`, `v` ) VALUES ( %d, '%s', '%s', '%s' ) ", $ret = q("INSERT INTO `pconfig` ( `uid`, `cat`, `k`, `v` ) VALUES ( %d, '%s', '%s', '%s' ) ",
intval($uid), intval($uid),
dbesc($family), dbesc($family),
dbesc($key), dbesc($key),
dbesc($dbvalue) dbesc($dbvalue)
); );
if($ret) { if($ret)
return $value; return $value;
}
return $ret; return $ret;
} }
} $ret = q("UPDATE `pconfig` SET `v` = '%s' WHERE `uid` = %d AND `cat` = '%s' AND `k` = '%s' LIMIT 1",
dbesc($dbvalue),
intval($uid),
dbesc($family),
dbesc($key)
);
$a->config[$uid][$family][$key] = $value;
if($ret)
return $value;
return $ret;
}}
if(! function_exists('del_pconfig')) { if(! function_exists('del_pconfig')) {
function del_pconfig($uid,$family,$key) { function del_pconfig($uid,$family,$key) {
global $a; global $a;
if(x($a->config[$uid][$family],$key)) if(x($a->config[$uid][$family],$key))
unset($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' LIMIT 1", $ret = q("DELETE FROM `pconfig` WHERE `uid` = %d AND `cat` = '%s' AND `k` = '%s' LIMIT 1",
intval($uid), intval($uid),
dbesc($family), dbesc($family),
dbesc($key) dbesc($key)
); );
return $ret; return $ret;
} }}
}