friendica/include/config.php

298 lines
8.1 KiB
PHP
Raw Normal View History

<?php
2016-06-06 10:22:14 +02:00
require_once("include/PConfig.php");
2011-08-10 10:19:27 +02:00
/**
2016-06-06 10:01:14 +02:00
* @file include/config.php
*
* @brief Arbitrary configuration storage
2011-08-10 10:19:27 +02:00
* Note:
* Please do not store booleans - convert to 0/1 integer values
* The get_?config() functions return boolean false for keys that are unset,
2012-05-20 00:11:32 +02:00
* and this could lead to subtle bugs.
2011-08-10 10:19:27 +02:00
*
* 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.
*/
2016-06-06 10:01:14 +02:00
/**
* @brief Loads all configuration values of family into a cached storage.
*
* All configuration values of the system are stored in global cache
* which is available under the global variable $a->config
*
* @param string $family
* The category of the configuration value
* @return void
*/
function load_config($family) {
global $a;
2016-01-16 12:32:11 +01:00
$r = q("SELECT `v`, `k` FROM `config` WHERE `cat` = '%s'", dbesc($family));
if(count($r)) {
foreach($r as $rr) {
$k = $rr['k'];
2012-06-17 02:29:42 +02:00
if ($family === 'config') {
$a->config[$k] = $rr['v'];
} else {
$a->config[$family][$k] = $rr['v'];
}
}
2012-06-17 02:29:42 +02:00
} else if ($family != 'config') {
// Negative caching
$a->config[$family] = "!<unset>!";
}
2016-06-06 10:01:14 +02:00
}
2016-06-06 10:01:14 +02:00
/**
* @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
*/
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] === '!<unset>!') {
return false;
}
}
if(isset($a->config[$family][$key])) {
if($a->config[$family][$key] === '!<unset>!') {
return false;
}
return $a->config[$family][$key];
}
}
2014-03-09 09:24:41 +01:00
// 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;
2014-03-09 09:24:41 +01:00
if ($val === '!<unset>!')
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 === '!<unset>!')
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;
2014-03-09 09:24:41 +01:00
// If APC is enabled then store the data there, else try XCache
/*if (function_exists("apc_store"))
apc_store($family."|".$key, $val, 600);
2014-03-09 09:24:41 +01:00
elseif (function_exists("xcache_set"))
xcache_set($family."|".$key, $val, 600);*/
return $val;
}
else {
$a->config[$family][$key] = '!<unset>!';
2014-03-09 09:24:41 +01:00
// If APC is enabled then store the data there, else try XCache
/*if (function_exists("apc_store"))
apc_store($family."|".$key, '!<unset>!', 600);
2014-03-09 09:24:41 +01:00
elseif (function_exists("xcache_set"))
xcache_set($family."|".$key, '!<unset>!', 600);*/
}
return false;
2016-06-06 10:01:14 +02:00
}
2016-06-06 10:01:14 +02:00
/**
* @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
*/
function set_config($family,$key,$value) {
global $a;
2013-01-19 07:38:49 +01:00
// If $a->config[$family] has been previously set to '!<unset>!', 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>!')
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;
}
2014-03-09 09:24:41 +01:00
$ret = q("UPDATE `config` SET `v` = '%s' WHERE `cat` = '%s' AND `k` = '%s'",
dbesc($dbvalue),
dbesc($family),
dbesc($key)
);
$a->config[$family][$key] = $value;
2014-03-09 09:24:41 +01:00
// If APC is enabled then store the data there, else try XCache
/*if (function_exists("apc_store"))
apc_store($family."|".$key, $value, 600);
2014-03-09 09:24:41 +01:00
elseif (function_exists("xcache_set"))
xcache_set($family."|".$key, $value, 600);*/
if($ret)
return $value;
return $ret;
2016-06-06 10:01:14 +02:00
}
2016-06-06 10:01:14 +02:00
/**
* @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
*/
function del_config($family,$key) {
2016-06-06 10:01:14 +02:00
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;
}
/**
2016-06-06 10:22:14 +02:00
* @brief (Deprecated) Loads all configuration values of a user's config family into a cached storage.
2016-06-06 10:01:14 +02:00
*
2016-06-06 10:22:14 +02:00
* Note: This function is deprecated. Use PConfig::load() instead.
2016-06-06 10:01:14 +02:00
*
* @param string $uid
* The user_id
* @param string $family
* The category of the configuration value
* @return void
*/
function load_pconfig($uid,$family) {
2016-06-06 10:22:14 +02:00
return PConfig::load($uid, $family);
2016-06-06 10:01:14 +02:00
}
2016-06-06 10:01:14 +02:00
/**
2016-06-06 10:22:14 +02:00
* @brief (Deprecated) Get a particular user's config variable given the category name
2016-06-06 10:01:14 +02:00
* ($family) and a key.
*
2016-06-06 10:22:14 +02:00
* Note: This function is deprecated. Use PConfig::get() instead.
2016-06-06 10:01:14 +02:00
*
* @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
*/
function get_pconfig($uid,$family, $key, $instore = false) {
2016-06-06 10:22:14 +02:00
return PConfig::get($uid, $family, $key, $instore);
2016-06-06 10:01:14 +02:00
}
2016-06-06 10:01:14 +02:00
/**
2016-06-06 10:22:14 +02:00
* @brief (Deprecated) Sets a configuration value for a user
2016-06-06 10:01:14 +02:00
*
2016-06-06 10:22:14 +02:00
* Note: This function is deprecated. Use PConfig::set() instead.
2016-06-06 10:01:14 +02:00
*
* @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
*/
function set_pconfig($uid,$family,$key,$value) {
2016-06-06 10:22:14 +02:00
return PConfig::set($uid, $family, $key, $value);
2016-06-06 10:01:14 +02:00
}
2016-06-06 10:01:14 +02:00
/**
2016-06-06 10:22:14 +02:00
* @brief (Deprecated) Deletes the given key from the users's configuration.
2016-06-06 10:01:14 +02:00
*
2016-06-06 10:22:14 +02:00
* Note: This function is deprecated. Use PConfig::del() instead.
2016-06-06 10:01:14 +02:00
*
* @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
*/
function del_pconfig($uid,$family,$key) {
2016-06-06 10:22:14 +02:00
return PConfig::del($uid, $family, $key);
2016-06-06 10:01:14 +02:00
}