2016-06-08 05:02:18 -04:00
|
|
|
<?php
|
2016-06-10 05:52:01 -04:00
|
|
|
namespace Friendica\Core;
|
2016-12-13 09:24:44 -05:00
|
|
|
|
|
|
|
use dbm;
|
|
|
|
|
2016-06-08 05:02:18 -04:00
|
|
|
/**
|
2016-06-10 05:52:01 -04:00
|
|
|
* @file include/Core/Config.php
|
2016-09-30 09:22:35 -04:00
|
|
|
*
|
2016-06-08 05:02:18 -04:00
|
|
|
* @brief Contains the class with methods for system configuration
|
|
|
|
*/
|
|
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @brief Arbitrary sytem configuration storage
|
|
|
|
* Note:
|
|
|
|
* Please do not store booleans - convert to 0/1 integer values
|
|
|
|
* The Config::get() functions return boolean false for keys that are unset,
|
|
|
|
* and this could lead to subtle bugs.
|
|
|
|
*
|
|
|
|
* 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.
|
|
|
|
*/
|
|
|
|
class Config {
|
|
|
|
|
2017-01-18 16:45:32 -05:00
|
|
|
private static $cache;
|
|
|
|
|
2016-06-08 05:02:18 -04: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
|
|
|
|
*/
|
2017-01-18 16:45:32 -05:00
|
|
|
public static function load($family = "config") {
|
|
|
|
|
|
|
|
// We don't preload "system" anymore.
|
|
|
|
// This reduces the number of database reads a lot.
|
2017-01-19 17:47:20 -05:00
|
|
|
if ($family === 'system') {
|
2017-01-18 16:45:32 -05:00
|
|
|
return;
|
|
|
|
}
|
|
|
|
|
2016-12-13 04:16:36 -05:00
|
|
|
$a = get_app();
|
2016-06-08 05:02:18 -04:00
|
|
|
|
2017-01-18 16:45:32 -05:00
|
|
|
$r = q("SELECT `v`, `k` FROM `config` WHERE `cat` = '%s'", dbesc($family));
|
2016-12-13 04:44:13 -05:00
|
|
|
if (dbm::is_result($r)) {
|
2016-10-21 19:04:04 -04:00
|
|
|
foreach ($r as $rr) {
|
2016-06-08 05:02:18 -04:00
|
|
|
$k = $rr['k'];
|
|
|
|
if ($family === 'config') {
|
|
|
|
$a->config[$k] = $rr['v'];
|
|
|
|
} else {
|
|
|
|
$a->config[$family][$k] = $rr['v'];
|
2017-01-18 16:45:32 -05:00
|
|
|
self::$cache[$family][$k] = $rr['v'];
|
2016-06-08 05:02:18 -04: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
|
2016-06-10 06:00:34 -04: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 15:52:10 -04:00
|
|
|
* @return mixed Stored value or null if it does not exist
|
2016-06-08 05:02:18 -04:00
|
|
|
*/
|
2016-10-21 19:04:04 -04:00
|
|
|
public static function get($family, $key, $default_value = null, $refresh = false) {
|
2016-06-08 05:02:18 -04:00
|
|
|
|
2016-12-13 04:16:36 -05:00
|
|
|
$a = get_app();
|
2016-06-08 05:02:18 -04:00
|
|
|
|
2016-10-21 19:04:04 -04:00
|
|
|
if (!$refresh) {
|
2016-06-08 05:02:18 -04:00
|
|
|
|
2017-01-18 16:45:32 -05:00
|
|
|
// Do we have the cached value? Then return it
|
|
|
|
if (isset(self::$cache[$family][$key])) {
|
2017-01-19 17:47:20 -05:00
|
|
|
if (self::$cache[$family][$key] === '!<unset>!') {
|
2016-06-10 06:00:34 -04:00
|
|
|
return $default_value;
|
2017-01-18 16:45:32 -05:00
|
|
|
} else {
|
|
|
|
return self::$cache[$family][$key];
|
2016-06-08 05:02:18 -04:00
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2017-01-18 16:45:32 -05:00
|
|
|
$ret = q("SELECT `v` FROM `config` WHERE `cat` = '%s' AND `k` = '%s'",
|
2016-06-08 05:02:18 -04:00
|
|
|
dbesc($family),
|
|
|
|
dbesc($key)
|
|
|
|
);
|
2017-01-18 16:45:32 -05:00
|
|
|
if (dbm::is_result($ret)) {
|
2016-06-08 05:02:18 -04:00
|
|
|
// manage array value
|
|
|
|
$val = (preg_match("|^a:[0-9]+:{.*}$|s", $ret[0]['v'])?unserialize( $ret[0]['v']):$ret[0]['v']);
|
|
|
|
|
2017-01-18 16:45:32 -05:00
|
|
|
// Assign the value from the database to the cache
|
|
|
|
self::$cache[$family][$key] = $val;
|
2016-06-08 05:02:18 -04:00
|
|
|
return $val;
|
2017-01-18 16:45:32 -05:00
|
|
|
} elseif (isset($a->config[$family][$key])) {
|
|
|
|
|
|
|
|
// Assign the value (mostly) from the .htconfig.php to the cache
|
|
|
|
self::$cache[$family][$key] = $a->config[$family][$key];
|
|
|
|
|
|
|
|
return $a->config[$family][$key];
|
2016-06-08 05:02:18 -04:00
|
|
|
}
|
2017-01-18 16:45:32 -05:00
|
|
|
|
|
|
|
self::$cache[$family][$key] = '!<unset>!';
|
|
|
|
|
2016-06-10 06:00:34 -04:00
|
|
|
return $default_value;
|
2016-06-08 05:02:18 -04: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
|
|
|
|
*/
|
2016-10-21 19:04:04 -04:00
|
|
|
public static function set($family, $key, $value) {
|
2016-12-13 04:16:36 -05:00
|
|
|
$a = get_app();
|
2016-06-08 05:02:18 -04:00
|
|
|
|
2017-01-24 13:55:07 -05:00
|
|
|
// We always store boolean values as integer.
|
|
|
|
// And when fetching we don't convert them back to boolean.
|
|
|
|
// So we have to do the conversion here so that the compare below works.
|
|
|
|
$dbvalue = (is_bool($value) ? (string)intval($value) : $value);
|
|
|
|
|
|
|
|
// Convert the numeric values to string to make the compare work
|
|
|
|
$dbvalue = (is_numeric($value) ? (string)$value : $dbvalue);
|
|
|
|
|
2016-10-22 06:33:18 -04:00
|
|
|
$stored = self::get($family, $key);
|
|
|
|
|
2017-01-24 13:55:07 -05:00
|
|
|
if ($stored === $dbvalue) {
|
2016-10-22 06:33:18 -04:00
|
|
|
return true;
|
|
|
|
}
|
|
|
|
|
2017-01-18 16:45:32 -05:00
|
|
|
if ($family === 'config') {
|
2017-01-24 13:55:07 -05:00
|
|
|
$a->config[$key] = $dbvalue;
|
2017-01-18 16:45:32 -05:00
|
|
|
} elseif ($family != 'system') {
|
2017-01-24 13:55:07 -05:00
|
|
|
$a->config[$family][$key] = $dbvalue;
|
2017-01-18 16:45:32 -05:00
|
|
|
}
|
|
|
|
|
|
|
|
// Assign the just added value to the cache
|
2017-01-24 13:55:07 -05:00
|
|
|
self::$cache[$family][$key] = $dbvalue;
|
2016-06-08 05:02:18 -04:00
|
|
|
|
|
|
|
// manage array value
|
2017-01-24 13:55:07 -05:00
|
|
|
$dbvalue = (is_array($value) ? serialize($value) : $dbvalue);
|
2016-06-08 05:02:18 -04:00
|
|
|
|
2016-10-22 06:33:18 -04:00
|
|
|
if (is_null($stored)) {
|
2016-10-17 14:38:51 -04:00
|
|
|
$ret = q("INSERT INTO `config` (`cat`, `k`, `v`) VALUES ('%s', '%s', '%s') ON DUPLICATE KEY UPDATE `v` = '%s'",
|
|
|
|
dbesc($family),
|
|
|
|
dbesc($key),
|
|
|
|
dbesc($dbvalue),
|
|
|
|
dbesc($dbvalue)
|
|
|
|
);
|
2016-10-23 03:49:21 -04:00
|
|
|
} else {
|
2016-10-17 14:38:51 -04:00
|
|
|
$ret = q("UPDATE `config` SET `v` = '%s' WHERE `cat` = '%s' AND `k` = '%s'",
|
|
|
|
dbesc($dbvalue),
|
|
|
|
dbesc($family),
|
|
|
|
dbesc($key)
|
|
|
|
);
|
2016-10-21 19:04:04 -04:00
|
|
|
}
|
2016-10-22 06:33:18 -04:00
|
|
|
if ($ret) {
|
2016-06-08 05:02:18 -04:00
|
|
|
return $value;
|
2016-10-22 06:33:18 -04:00
|
|
|
}
|
2016-06-08 05:02:18 -04:00
|
|
|
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
|
|
|
|
*/
|
2016-10-21 19:04:04 -04:00
|
|
|
public static function delete($family, $key) {
|
2016-06-08 05:02:18 -04:00
|
|
|
|
2017-01-18 16:45:32 -05:00
|
|
|
if (isset(self::$cache[$family][$key])) {
|
|
|
|
unset(self::$cache[$family][$key]);
|
2016-10-22 06:33:18 -04:00
|
|
|
}
|
2016-06-08 05:02:18 -04:00
|
|
|
$ret = q("DELETE FROM `config` WHERE `cat` = '%s' AND `k` = '%s'",
|
|
|
|
dbesc($family),
|
|
|
|
dbesc($key)
|
|
|
|
);
|
|
|
|
|
|
|
|
return $ret;
|
|
|
|
}
|
|
|
|
}
|