2016-06-06 10:22:14 +02:00
|
|
|
<?php
|
2016-06-10 11:52:01 +02:00
|
|
|
namespace Friendica\Core;
|
2016-12-13 15:24:44 +01:00
|
|
|
|
2017-08-09 07:53:07 +02:00
|
|
|
use dba;
|
2016-12-13 15:24:44 +01:00
|
|
|
use dbm;
|
|
|
|
|
2016-06-06 10:22:14 +02:00
|
|
|
/**
|
2016-06-10 11:52:01 +02:00
|
|
|
* @file include/Core/PConfig.php
|
2016-06-06 10:22:14 +02:00
|
|
|
* @brief contains the class with methods for the management
|
|
|
|
* of the user configuration
|
|
|
|
*/
|
|
|
|
|
|
|
|
/**
|
2016-06-08 11:02:18 +02:00
|
|
|
* @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.
|
2016-06-06 10:22:14 +02:00
|
|
|
*/
|
|
|
|
class PConfig {
|
|
|
|
|
2017-01-28 07:18:16 +01:00
|
|
|
private static $in_db;
|
|
|
|
|
2016-06-06 10:22:14 +02:00
|
|
|
/**
|
|
|
|
* @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
|
|
|
|
*/
|
2016-10-22 01:04:04 +02:00
|
|
|
public static function load($uid, $family) {
|
2016-12-13 10:16:36 +01:00
|
|
|
$a = get_app();
|
2017-08-09 07:53:07 +02:00
|
|
|
|
|
|
|
$r = dba::select('pconfig', array('v', 'k'), array('cat' => $family, 'uid' => $uid),
|
|
|
|
array("order" => array('uid', 'cat', 'k')));
|
2016-12-13 10:44:13 +01:00
|
|
|
if (dbm::is_result($r)) {
|
2017-08-09 07:53:07 +02:00
|
|
|
while ($rr = dba::fetch($r)) {
|
2016-06-06 10:22:14 +02:00
|
|
|
$k = $rr['k'];
|
|
|
|
$a->config[$uid][$family][$k] = $rr['v'];
|
2017-01-28 07:18:16 +01:00
|
|
|
self::$in_db[$uid][$family][$k] = true;
|
2016-06-06 10:22:14 +02:00
|
|
|
}
|
|
|
|
} 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
|
2016-06-10 12:00:34 +02:00
|
|
|
* @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)
|
2016-06-08 21:52:10 +02:00
|
|
|
* @return mixed Stored value or null if it does not exist
|
2016-06-06 10:22:14 +02:00
|
|
|
*/
|
2016-06-10 12:00:34 +02:00
|
|
|
public static function get($uid, $family, $key, $default_value = null, $refresh = false) {
|
2016-06-06 10:22:14 +02:00
|
|
|
|
2016-12-13 10:16:36 +01:00
|
|
|
$a = get_app();
|
2016-06-06 10:22:14 +02:00
|
|
|
|
2016-10-22 01:04:04 +02:00
|
|
|
if (!$refresh) {
|
2016-06-06 10:22:14 +02:00
|
|
|
// Looking if the whole family isn't set
|
2016-10-22 01:04:04 +02:00
|
|
|
if (isset($a->config[$uid][$family])) {
|
|
|
|
if ($a->config[$uid][$family] === '!<unset>!') {
|
2016-06-10 12:00:34 +02:00
|
|
|
return $default_value;
|
2016-06-06 10:22:14 +02:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2016-10-22 01:04:04 +02:00
|
|
|
if (isset($a->config[$uid][$family][$key])) {
|
|
|
|
if ($a->config[$uid][$family][$key] === '!<unset>!') {
|
2016-06-10 12:00:34 +02:00
|
|
|
return $default_value;
|
2016-06-06 10:22:14 +02:00
|
|
|
}
|
|
|
|
return $a->config[$uid][$family][$key];
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2017-08-09 07:53:07 +02:00
|
|
|
$ret = dba::select('pconfig', array('v'), array('uid' => $uid, 'cat' => $family, 'k' => $key),
|
|
|
|
array("order" => array('uid', 'cat', 'k'), 'limit' => 1));
|
|
|
|
if (dbm::is_result($ret)) {
|
2017-08-09 08:16:19 +02:00
|
|
|
$val = (preg_match("|^a:[0-9]+:{.*}$|s", $ret['v']) ? unserialize($ret['v']) : $ret['v']);
|
2016-06-06 10:22:14 +02:00
|
|
|
$a->config[$uid][$family][$key] = $val;
|
2017-01-28 07:18:16 +01:00
|
|
|
self::$in_db[$uid][$family][$key] = true;
|
2016-06-06 10:22:14 +02:00
|
|
|
|
|
|
|
return $val;
|
2016-10-22 01:04:04 +02:00
|
|
|
} else {
|
2016-06-06 10:22:14 +02:00
|
|
|
$a->config[$uid][$family][$key] = '!<unset>!';
|
2017-01-28 07:18:16 +01:00
|
|
|
self::$in_db[$uid][$family][$key] = false;
|
|
|
|
|
|
|
|
return $default_value;
|
2016-06-06 10:22:14 +02:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @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
|
|
|
|
*/
|
2016-10-17 22:53:37 +02:00
|
|
|
public static function set($uid, $family, $key, $value) {
|
2016-06-06 10:22:14 +02:00
|
|
|
|
2016-12-13 10:16:36 +01:00
|
|
|
$a = get_app();
|
2016-06-06 10:22:14 +02:00
|
|
|
|
2017-01-28 07:18:16 +01:00
|
|
|
// We store our setting values in a string variable.
|
|
|
|
// So we have to do the conversion here so that the compare below works.
|
|
|
|
// The exception are array values.
|
|
|
|
$dbvalue = (!is_array($value) ? (string)$value : $value);
|
|
|
|
|
|
|
|
$stored = self::get($uid, $family, $key, null, true);
|
2016-10-23 09:49:21 +02:00
|
|
|
|
2017-06-08 04:00:59 +02:00
|
|
|
if (($stored === $dbvalue) && self::$in_db[$uid][$family][$key]) {
|
2016-10-23 09:49:21 +02:00
|
|
|
return true;
|
|
|
|
}
|
|
|
|
|
2017-01-28 07:18:16 +01:00
|
|
|
$a->config[$uid][$family][$key] = $dbvalue;
|
2016-06-06 10:22:14 +02:00
|
|
|
|
2017-01-28 07:18:16 +01:00
|
|
|
// manage array value
|
|
|
|
$dbvalue = (is_array($value) ? serialize($value) : $dbvalue);
|
2016-10-02 03:40:41 +02:00
|
|
|
|
2017-06-08 04:00:59 +02:00
|
|
|
if (is_null($stored) || !self::$in_db[$uid][$family][$key]) {
|
2016-10-17 20:38:51 +02:00
|
|
|
$ret = q("INSERT INTO `pconfig` (`uid`, `cat`, `k`, `v`) VALUES (%d, '%s', '%s', '%s') ON DUPLICATE KEY UPDATE `v` = '%s'",
|
|
|
|
intval($uid),
|
|
|
|
dbesc($family),
|
|
|
|
dbesc($key),
|
|
|
|
dbesc($dbvalue),
|
|
|
|
dbesc($dbvalue)
|
|
|
|
);
|
2016-10-23 09:49:21 +02:00
|
|
|
} else {
|
2016-10-17 20:38:51 +02:00
|
|
|
$ret = q("UPDATE `pconfig` SET `v` = '%s' WHERE `uid` = %d AND `cat` = '%s' AND `k` = '%s'",
|
|
|
|
dbesc($dbvalue),
|
|
|
|
intval($uid),
|
|
|
|
dbesc($family),
|
|
|
|
dbesc($key)
|
|
|
|
);
|
2016-10-23 09:49:21 +02:00
|
|
|
}
|
2016-10-17 20:38:51 +02:00
|
|
|
|
2016-10-23 09:49:21 +02:00
|
|
|
if ($ret) {
|
2017-01-28 07:18:16 +01:00
|
|
|
self::$in_db[$uid][$family][$key] = true;
|
2016-06-06 10:22:14 +02:00
|
|
|
return $value;
|
2016-10-23 09:49:21 +02:00
|
|
|
}
|
2016-06-06 10:22:14 +02:00
|
|
|
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
|
|
|
|
*/
|
2016-06-06 10:46:33 +02:00
|
|
|
public static function delete($uid,$family,$key) {
|
2016-06-06 10:22:14 +02:00
|
|
|
|
2016-12-13 10:16:36 +01:00
|
|
|
$a = get_app();
|
2016-10-23 09:49:21 +02:00
|
|
|
|
|
|
|
if (x($a->config[$uid][$family], $key)) {
|
2016-06-06 10:22:14 +02:00
|
|
|
unset($a->config[$uid][$family][$key]);
|
2017-01-28 07:18:16 +01:00
|
|
|
unset(self::$in_db[$uid][$family][$key]);
|
2016-10-23 09:49:21 +02:00
|
|
|
}
|
|
|
|
|
2017-08-09 07:53:07 +02:00
|
|
|
$ret = dba::delete('pconfig', array('uid' => $uid, 'cat' => $family, 'k' => $key));
|
2016-10-23 09:49:21 +02:00
|
|
|
|
2016-06-06 10:22:14 +02:00
|
|
|
return $ret;
|
|
|
|
}
|
|
|
|
}
|