2016-06-08 11:02:18 +02:00
|
|
|
<?php
|
|
|
|
/**
|
2017-11-08 23:02:50 +01:00
|
|
|
* System Configuration Class
|
|
|
|
*
|
2016-06-10 11:52:01 +02:00
|
|
|
* @file include/Core/Config.php
|
2016-09-30 15:22:35 +02:00
|
|
|
*
|
2017-11-08 23:02:50 +01:00
|
|
|
* @brief Contains the class with methods for system configuration
|
2016-06-08 11:02:18 +02:00
|
|
|
*/
|
2017-11-08 23:02:50 +01:00
|
|
|
namespace Friendica\Core;
|
2016-06-08 11:02:18 +02:00
|
|
|
|
2018-07-27 04:27:28 +02:00
|
|
|
use Friendica\App;
|
2018-03-03 18:10:55 +01:00
|
|
|
use Friendica\BaseObject;
|
|
|
|
use Friendica\Core\Config;
|
2016-06-08 11:02:18 +02:00
|
|
|
|
|
|
|
/**
|
2018-03-03 18:10:55 +01:00
|
|
|
* @brief Arbitrary system configuration storage
|
2017-11-26 12:43:02 +01:00
|
|
|
*
|
2016-06-08 11:02:18 +02:00
|
|
|
* Note:
|
2017-11-26 12:43:02 +01:00
|
|
|
* If we ever would decide to return exactly the variable type as entered,
|
|
|
|
* we will have fun with the additional features. :-)
|
2016-06-08 11:02:18 +02:00
|
|
|
*/
|
2018-03-03 18:10:55 +01:00
|
|
|
class Config extends BaseObject
|
2017-11-19 20:15:25 +01:00
|
|
|
{
|
2018-03-03 18:10:55 +01:00
|
|
|
/**
|
|
|
|
* @var Friendica\Core\Config\IConfigAdapter
|
|
|
|
*/
|
|
|
|
private static $adapter = null;
|
|
|
|
|
|
|
|
public static function init()
|
|
|
|
{
|
2018-06-26 02:57:57 +02:00
|
|
|
// Database isn't ready or populated yet
|
2018-10-06 16:27:20 +02:00
|
|
|
if (!self::getApp()->getMode()->has(App\Mode::DBCONFIGAVAILABLE)) {
|
2018-06-26 02:57:57 +02:00
|
|
|
return;
|
|
|
|
}
|
|
|
|
|
2018-03-07 02:04:04 +01:00
|
|
|
if (self::getApp()->getConfigValue('system', 'config_adapter') == 'preload') {
|
2018-03-03 18:10:55 +01:00
|
|
|
self::$adapter = new Config\PreloadConfigAdapter();
|
|
|
|
} else {
|
|
|
|
self::$adapter = new Config\JITConfigAdapter();
|
|
|
|
}
|
|
|
|
}
|
2017-01-18 22:45:32 +01:00
|
|
|
|
2016-06-08 11:02:18 +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
|
|
|
|
*
|
2017-11-19 20:15:25 +01:00
|
|
|
* @param string $family The category of the configuration value
|
|
|
|
*
|
2016-06-08 11:02:18 +02:00
|
|
|
* @return void
|
|
|
|
*/
|
2017-11-19 20:15:25 +01:00
|
|
|
public static function load($family = "config")
|
|
|
|
{
|
2018-06-26 02:57:57 +02:00
|
|
|
// Database isn't ready or populated yet
|
2018-10-06 16:27:20 +02:00
|
|
|
if (!self::getApp()->getMode()->has(App\Mode::DBCONFIGAVAILABLE)) {
|
2018-06-26 02:57:57 +02:00
|
|
|
return;
|
|
|
|
}
|
|
|
|
|
2018-03-03 18:10:55 +01:00
|
|
|
if (empty(self::$adapter)) {
|
|
|
|
self::init();
|
2017-01-18 22:45:32 +01:00
|
|
|
}
|
|
|
|
|
2018-03-03 18:10:55 +01:00
|
|
|
self::$adapter->load($family);
|
2016-06-08 11:02:18 +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.
|
|
|
|
*
|
2017-11-19 20:15:25 +01:00
|
|
|
* @param string $family The category of the configuration value
|
|
|
|
* @param string $key The configuration key to query
|
|
|
|
* @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-08 11:02:18 +02:00
|
|
|
*/
|
2017-11-19 20:15:25 +01:00
|
|
|
public static function get($family, $key, $default_value = null, $refresh = false)
|
|
|
|
{
|
2018-06-26 02:57:57 +02:00
|
|
|
// Database isn't ready or populated yet, fallback to file config
|
2018-10-06 16:27:20 +02:00
|
|
|
if (!self::getApp()->getMode()->has(App\Mode::DBCONFIGAVAILABLE)) {
|
2018-06-26 02:57:57 +02:00
|
|
|
return self::getApp()->getConfigValue($family, $key, $default_value);
|
|
|
|
}
|
|
|
|
|
2018-03-03 18:10:55 +01:00
|
|
|
if (empty(self::$adapter)) {
|
|
|
|
self::init();
|
2016-06-08 11:02:18 +02:00
|
|
|
}
|
|
|
|
|
2018-03-03 18:10:55 +01:00
|
|
|
return self::$adapter->get($family, $key, $default_value, $refresh);
|
2016-06-08 11:02:18 +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!
|
|
|
|
*
|
2017-11-19 20:15:25 +01:00
|
|
|
* @param string $family The category of the configuration value
|
|
|
|
* @param string $key The configuration key to set
|
2018-01-05 01:42:48 +01:00
|
|
|
* @param mixed $value The value to store
|
2017-11-19 20:15:25 +01:00
|
|
|
*
|
2018-07-18 08:32:35 +02:00
|
|
|
* @return bool Operation success
|
2016-06-08 11:02:18 +02:00
|
|
|
*/
|
2017-11-19 20:15:25 +01:00
|
|
|
public static function set($family, $key, $value)
|
|
|
|
{
|
2018-06-26 02:57:57 +02:00
|
|
|
// Database isn't ready or populated yet
|
2018-10-06 16:27:20 +02:00
|
|
|
if (!self::getApp()->getMode()->has(App\Mode::DBCONFIGAVAILABLE)) {
|
2018-06-26 02:57:57 +02:00
|
|
|
return false;
|
|
|
|
}
|
|
|
|
|
2018-03-03 18:10:55 +01:00
|
|
|
if (empty(self::$adapter)) {
|
|
|
|
self::init();
|
2016-10-22 12:33:18 +02:00
|
|
|
}
|
|
|
|
|
2018-03-03 18:10:55 +01:00
|
|
|
return self::$adapter->set($family, $key, $value);
|
2016-06-08 11:02:18 +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.
|
|
|
|
*
|
2017-11-19 20:15:25 +01:00
|
|
|
* @param string $family The category of the configuration value
|
|
|
|
* @param string $key The configuration key to delete
|
|
|
|
*
|
2016-06-08 11:02:18 +02:00
|
|
|
* @return mixed
|
|
|
|
*/
|
2017-11-19 20:15:25 +01:00
|
|
|
public static function delete($family, $key)
|
|
|
|
{
|
2018-06-26 02:57:57 +02:00
|
|
|
// Database isn't ready or populated yet
|
2018-10-06 16:27:20 +02:00
|
|
|
if (!self::getApp()->getMode()->has(App\Mode::DBCONFIGAVAILABLE)) {
|
2018-06-26 02:57:57 +02:00
|
|
|
return false;
|
|
|
|
}
|
|
|
|
|
2018-03-03 18:10:55 +01:00
|
|
|
if (empty(self::$adapter)) {
|
|
|
|
self::init();
|
2016-10-22 12:33:18 +02:00
|
|
|
}
|
2016-06-08 11:02:18 +02:00
|
|
|
|
2018-03-03 18:10:55 +01:00
|
|
|
return self::$adapter->delete($family, $key);
|
2016-06-08 11:02:18 +02:00
|
|
|
}
|
|
|
|
}
|