2019-02-03 16:22:04 -05:00
|
|
|
<?php
|
|
|
|
|
2019-06-23 13:56:21 -04:00
|
|
|
namespace Friendica\Util;
|
2019-02-03 16:22:04 -05:00
|
|
|
|
2019-06-23 13:56:21 -04:00
|
|
|
use Exception;
|
2019-02-04 03:33:55 -05:00
|
|
|
use Friendica\Core\Addon;
|
2019-07-12 16:38:50 -04:00
|
|
|
use Friendica\Core\Config\Cache\ConfigCache;
|
2019-02-04 03:33:55 -05:00
|
|
|
|
2019-02-03 17:39:30 -05:00
|
|
|
/**
|
2019-07-12 16:38:50 -04:00
|
|
|
* The ConfigFileLoader loads config-files and stores them in a ConfigCache ( @see ConfigCache )
|
2019-02-03 17:39:30 -05:00
|
|
|
*
|
|
|
|
* It is capable of loading the following config files:
|
|
|
|
* - *.config.php (current)
|
|
|
|
* - *.ini.php (deprecated)
|
|
|
|
* - *.htconfig.php (deprecated)
|
|
|
|
*/
|
2019-06-23 13:56:21 -04:00
|
|
|
class ConfigFileLoader
|
2019-02-03 16:22:04 -05:00
|
|
|
{
|
2019-06-23 13:56:21 -04:00
|
|
|
/**
|
|
|
|
* The Sub directory of the config-files
|
|
|
|
*
|
|
|
|
* @var string
|
|
|
|
*/
|
|
|
|
const CONFIG_DIR = 'config';
|
|
|
|
|
|
|
|
/**
|
|
|
|
* The Sub directory of the static config-files
|
|
|
|
*
|
|
|
|
* @var string
|
|
|
|
*/
|
|
|
|
const STATIC_DIR = 'static';
|
|
|
|
|
|
|
|
/**
|
|
|
|
* The default name of the user defined ini file
|
|
|
|
*
|
|
|
|
* @var string
|
|
|
|
*/
|
|
|
|
const CONFIG_INI = 'local';
|
|
|
|
|
|
|
|
/**
|
|
|
|
* The default name of the user defined legacy config file
|
|
|
|
*
|
|
|
|
* @var string
|
|
|
|
*/
|
|
|
|
const CONFIG_HTCONFIG = 'htconfig';
|
|
|
|
|
|
|
|
/**
|
|
|
|
* The sample string inside the configs, which shouldn't get loaded
|
|
|
|
*
|
|
|
|
* @var string
|
|
|
|
*/
|
|
|
|
const SAMPLE_END = '-sample';
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @var string
|
|
|
|
*/
|
|
|
|
private $baseDir;
|
|
|
|
/**
|
|
|
|
* @var string
|
|
|
|
*/
|
|
|
|
private $configDir;
|
|
|
|
/**
|
|
|
|
* @var string
|
|
|
|
*/
|
|
|
|
private $staticDir;
|
2019-03-13 21:36:49 -04:00
|
|
|
|
2019-07-20 19:22:10 -04:00
|
|
|
public function __construct(string $basePath)
|
2019-02-03 16:22:04 -05:00
|
|
|
{
|
2019-07-20 19:22:10 -04:00
|
|
|
$this->baseDir = $basePath;
|
|
|
|
$this->configDir = $this->baseDir . DIRECTORY_SEPARATOR . self::CONFIG_DIR;
|
|
|
|
$this->staticDir = $this->baseDir . DIRECTORY_SEPARATOR . self::STATIC_DIR;
|
2019-02-03 16:22:04 -05:00
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
2019-03-24 07:54:26 -04:00
|
|
|
* Load the configuration files into an configuration cache
|
2019-02-03 16:22:04 -05:00
|
|
|
*
|
|
|
|
* First loads the default value for all the configuration keys, then the legacy configuration files, then the
|
|
|
|
* expected local.config.php
|
2019-03-13 21:36:49 -04:00
|
|
|
*
|
2019-07-12 16:38:50 -04:00
|
|
|
* @param ConfigCache $config The config cache to load to
|
|
|
|
* @param bool $raw Setup the raw config format
|
2019-03-13 21:36:49 -04:00
|
|
|
*
|
2019-06-23 13:56:21 -04:00
|
|
|
* @throws Exception
|
2019-02-03 16:22:04 -05:00
|
|
|
*/
|
2019-07-12 16:38:50 -04:00
|
|
|
public function setupCache(ConfigCache $config, $raw = false)
|
2019-02-03 16:22:04 -05:00
|
|
|
{
|
2019-06-23 13:56:21 -04:00
|
|
|
// Load static config files first, the order is important
|
|
|
|
$config->load($this->loadStaticConfig('defaults'));
|
|
|
|
$config->load($this->loadStaticConfig('settings'));
|
2019-02-03 16:22:04 -05:00
|
|
|
|
2019-06-23 13:56:21 -04:00
|
|
|
// try to load the legacy config first
|
2019-02-10 13:52:21 -05:00
|
|
|
$config->load($this->loadLegacyConfig('htpreconfig'), true);
|
|
|
|
$config->load($this->loadLegacyConfig('htconfig'), true);
|
2019-02-03 16:22:04 -05:00
|
|
|
|
2019-06-23 13:56:21 -04:00
|
|
|
// Now load every other config you find inside the 'config/' directory
|
|
|
|
$this->loadCoreConfig($config);
|
2019-03-13 21:36:49 -04:00
|
|
|
|
|
|
|
// In case of install mode, add the found basepath (because there isn't a basepath set yet
|
2019-07-20 19:22:10 -04:00
|
|
|
if (!$raw && empty($config->get('system', 'basepath'))) {
|
2019-03-13 21:36:49 -04:00
|
|
|
// Setting at least the basepath we know
|
|
|
|
$config->set('system', 'basepath', $this->baseDir);
|
|
|
|
}
|
2019-02-05 17:36:01 -05:00
|
|
|
}
|
2019-02-03 16:22:04 -05:00
|
|
|
|
2019-02-05 17:36:01 -05:00
|
|
|
/**
|
2019-06-23 13:56:21 -04:00
|
|
|
* Tries to load the static core-configuration and returns the config array.
|
2019-02-05 18:02:25 -05:00
|
|
|
*
|
2019-06-23 13:56:21 -04:00
|
|
|
* @param string $name The name of the configuration
|
2019-02-05 18:02:25 -05:00
|
|
|
*
|
|
|
|
* @return array The config array (empty if no config found)
|
|
|
|
*
|
2019-06-23 13:56:21 -04:00
|
|
|
* @throws Exception if the configuration file isn't readable
|
2019-02-05 18:02:25 -05:00
|
|
|
*/
|
2019-06-23 13:56:21 -04:00
|
|
|
private function loadStaticConfig($name)
|
2019-02-05 18:02:25 -05:00
|
|
|
{
|
2019-06-23 13:56:21 -04:00
|
|
|
$configName = $this->staticDir . DIRECTORY_SEPARATOR . $name . '.config.php';
|
|
|
|
$iniName = $this->staticDir . DIRECTORY_SEPARATOR . $name . '.ini.php';
|
|
|
|
|
|
|
|
if (file_exists($configName)) {
|
|
|
|
return $this->loadConfigFile($configName);
|
|
|
|
} elseif (file_exists($iniName)) {
|
|
|
|
return $this->loadINIConfigFile($iniName);
|
2019-02-05 18:02:25 -05:00
|
|
|
} else {
|
|
|
|
return [];
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2019-06-23 13:56:21 -04:00
|
|
|
/**
|
|
|
|
* Tries to load the specified core-configuration into the config cache.
|
|
|
|
*
|
|
|
|
* @param ConfigCache $config The Config cache
|
|
|
|
*
|
|
|
|
* @return array The config array (empty if no config found)
|
|
|
|
*
|
|
|
|
* @throws Exception if the configuration file isn't readable
|
|
|
|
*/
|
|
|
|
private function loadCoreConfig(ConfigCache $config)
|
|
|
|
{
|
|
|
|
// try to load legacy ini-files first
|
|
|
|
foreach ($this->getConfigFiles(true) as $configFile) {
|
|
|
|
$config->load($this->loadINIConfigFile($configFile), true);
|
|
|
|
}
|
|
|
|
|
|
|
|
// try to load supported config at last to overwrite it
|
|
|
|
foreach ($this->getConfigFiles() as $configFile) {
|
|
|
|
$config->load($this->loadConfigFile($configFile), true);
|
|
|
|
}
|
|
|
|
|
|
|
|
return [];
|
|
|
|
}
|
|
|
|
|
2019-02-05 18:02:25 -05:00
|
|
|
/**
|
|
|
|
* Tries to load the specified addon-configuration and returns the config array.
|
|
|
|
*
|
|
|
|
* @param string $name The name of the configuration
|
|
|
|
*
|
|
|
|
* @return array The config array (empty if no config found)
|
|
|
|
*
|
2019-06-23 13:56:21 -04:00
|
|
|
* @throws Exception if the configuration file isn't readable
|
2019-02-05 18:02:25 -05:00
|
|
|
*/
|
|
|
|
public function loadAddonConfig($name)
|
|
|
|
{
|
2019-07-16 15:53:48 -04:00
|
|
|
$filepath = $this->baseDir . DIRECTORY_SEPARATOR . // /var/www/html/
|
|
|
|
Addon::DIRECTORY . DIRECTORY_SEPARATOR . // addon/
|
|
|
|
$name . DIRECTORY_SEPARATOR . // openstreetmap/
|
|
|
|
self::CONFIG_DIR . DIRECTORY_SEPARATOR . // config/
|
|
|
|
$name . ".config.php"; // openstreetmap.config.php
|
2019-02-05 18:02:25 -05:00
|
|
|
|
|
|
|
if (file_exists($filepath)) {
|
|
|
|
return $this->loadConfigFile($filepath);
|
|
|
|
} else {
|
|
|
|
return [];
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2019-06-23 13:56:21 -04:00
|
|
|
/**
|
|
|
|
* Get the config files of the config-directory
|
|
|
|
*
|
|
|
|
* @param bool $ini True, if scan for ini-files instead of config files
|
|
|
|
*
|
|
|
|
* @return array
|
|
|
|
*/
|
|
|
|
private function getConfigFiles(bool $ini = false)
|
|
|
|
{
|
|
|
|
$files = scandir($this->configDir);
|
|
|
|
$found = array();
|
|
|
|
|
|
|
|
$filePattern = ($ini ? '*.ini.php' : '*.config.php');
|
|
|
|
|
|
|
|
// Don't load sample files
|
|
|
|
$sampleEnd = self::SAMPLE_END . ($ini ? '.ini.php' : '.config.php');
|
|
|
|
|
|
|
|
foreach ($files as $filename) {
|
|
|
|
if (fnmatch($filePattern, $filename) && substr_compare($filename, $sampleEnd, -strlen($sampleEnd))) {
|
|
|
|
$found[] = $this->configDir . '/' . $filename;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
return $found;
|
|
|
|
}
|
|
|
|
|
2019-02-05 18:02:25 -05:00
|
|
|
/**
|
|
|
|
* Tries to load the legacy config files (.htconfig.php, .htpreconfig.php) and returns the config array.
|
2019-02-05 17:36:01 -05:00
|
|
|
*
|
2019-03-23 10:40:09 -04:00
|
|
|
* @param string $name The name of the config file (default is empty, which means .htconfig.php)
|
2019-02-05 18:02:25 -05:00
|
|
|
*
|
|
|
|
* @return array The configuration array (empty if no config found)
|
2019-02-05 17:36:01 -05:00
|
|
|
*
|
|
|
|
* @deprecated since version 2018.09
|
|
|
|
*/
|
2019-03-23 10:40:09 -04:00
|
|
|
private function loadLegacyConfig($name = '')
|
2019-02-05 17:36:01 -05:00
|
|
|
{
|
2019-06-23 13:56:21 -04:00
|
|
|
$name = !empty($name) ? $name : self::CONFIG_HTCONFIG;
|
|
|
|
$fullName = $this->baseDir . DIRECTORY_SEPARATOR . '.' . $name . '.php';
|
|
|
|
|
2019-03-16 15:04:11 -04:00
|
|
|
$config = [];
|
2019-06-23 13:56:21 -04:00
|
|
|
if (file_exists($fullName)) {
|
|
|
|
$a = new \stdClass();
|
2019-03-16 15:31:10 -04:00
|
|
|
$a->config = [];
|
2019-06-23 13:56:21 -04:00
|
|
|
include $fullName;
|
2019-02-03 16:22:04 -05:00
|
|
|
|
2019-03-17 04:57:34 -04:00
|
|
|
$htConfigCategories = array_keys($a->config);
|
2019-03-16 15:31:10 -04:00
|
|
|
|
|
|
|
// map the legacy configuration structure to the current structure
|
2019-03-17 04:57:34 -04:00
|
|
|
foreach ($htConfigCategories as $htConfigCategory) {
|
|
|
|
if (is_array($a->config[$htConfigCategory])) {
|
|
|
|
$keys = array_keys($a->config[$htConfigCategory]);
|
2019-03-16 15:31:10 -04:00
|
|
|
|
|
|
|
foreach ($keys as $key) {
|
2019-03-17 04:57:34 -04:00
|
|
|
$config[$htConfigCategory][$key] = $a->config[$htConfigCategory][$key];
|
2019-03-16 15:31:10 -04:00
|
|
|
}
|
|
|
|
} else {
|
2019-03-17 04:57:34 -04:00
|
|
|
$config['config'][$htConfigCategory] = $a->config[$htConfigCategory];
|
2019-03-16 15:31:10 -04:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
unset($a);
|
|
|
|
|
2019-02-05 17:36:01 -05:00
|
|
|
if (isset($db_host)) {
|
2019-03-16 15:04:11 -04:00
|
|
|
$config['database']['hostname'] = $db_host;
|
2019-02-05 17:36:01 -05:00
|
|
|
unset($db_host);
|
|
|
|
}
|
|
|
|
if (isset($db_user)) {
|
2019-03-16 15:04:11 -04:00
|
|
|
$config['database']['username'] = $db_user;
|
2019-02-05 17:36:01 -05:00
|
|
|
unset($db_user);
|
|
|
|
}
|
|
|
|
if (isset($db_pass)) {
|
2019-03-16 15:04:11 -04:00
|
|
|
$config['database']['password'] = $db_pass;
|
2019-02-05 17:36:01 -05:00
|
|
|
unset($db_pass);
|
|
|
|
}
|
|
|
|
if (isset($db_data)) {
|
2019-03-16 15:04:11 -04:00
|
|
|
$config['database']['database'] = $db_data;
|
2019-02-05 17:36:01 -05:00
|
|
|
unset($db_data);
|
|
|
|
}
|
2019-03-16 15:31:10 -04:00
|
|
|
if (isset($config['system']['db_charset'])) {
|
|
|
|
$config['database']['charset'] = $config['system']['db_charset'];
|
2019-02-03 16:22:04 -05:00
|
|
|
}
|
|
|
|
if (isset($pidfile)) {
|
2019-03-16 15:04:11 -04:00
|
|
|
$config['system']['pidfile'] = $pidfile;
|
2019-02-03 16:22:04 -05:00
|
|
|
unset($pidfile);
|
|
|
|
}
|
2019-02-05 17:36:01 -05:00
|
|
|
if (isset($default_timezone)) {
|
2019-03-16 15:04:11 -04:00
|
|
|
$config['system']['default_timezone'] = $default_timezone;
|
2019-02-05 17:36:01 -05:00
|
|
|
unset($default_timezone);
|
|
|
|
}
|
2019-02-03 16:22:04 -05:00
|
|
|
if (isset($lang)) {
|
2019-03-16 15:04:11 -04:00
|
|
|
$config['system']['language'] = $lang;
|
2019-02-03 16:22:04 -05:00
|
|
|
unset($lang);
|
|
|
|
}
|
2019-02-05 17:36:01 -05:00
|
|
|
}
|
2019-03-16 15:04:11 -04:00
|
|
|
|
|
|
|
return $config;
|
2019-02-03 16:22:04 -05:00
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
2019-02-05 17:36:01 -05:00
|
|
|
* Tries to load the specified legacy configuration file and returns the config array.
|
2019-02-03 16:22:04 -05:00
|
|
|
*
|
2019-02-05 17:47:40 -05:00
|
|
|
* @param string $filepath
|
2019-02-03 16:22:04 -05:00
|
|
|
*
|
2019-02-05 17:36:01 -05:00
|
|
|
* @return array The configuration array
|
2019-06-23 13:56:21 -04:00
|
|
|
* @throws Exception
|
|
|
|
* @deprecated since version 2018.12
|
2019-02-03 16:22:04 -05:00
|
|
|
*/
|
2019-02-05 18:02:25 -05:00
|
|
|
private function loadINIConfigFile($filepath)
|
2019-02-03 16:22:04 -05:00
|
|
|
{
|
|
|
|
$contents = include($filepath);
|
|
|
|
|
|
|
|
$config = parse_ini_string($contents, true, INI_SCANNER_TYPED);
|
|
|
|
|
|
|
|
if ($config === false) {
|
2019-06-23 13:56:21 -04:00
|
|
|
throw new Exception('Error parsing INI config file ' . $filepath);
|
2019-02-03 16:22:04 -05:00
|
|
|
}
|
|
|
|
|
|
|
|
return $config;
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
2019-02-05 16:27:57 -05:00
|
|
|
* Tries to load the specified configuration file and returns the config array.
|
2019-02-03 16:22:04 -05:00
|
|
|
*
|
|
|
|
* The config format is PHP array and the template for configuration files is the following:
|
|
|
|
*
|
|
|
|
* <?php return [
|
|
|
|
* 'section' => [
|
|
|
|
* 'key' => 'value',
|
|
|
|
* ],
|
|
|
|
* ];
|
|
|
|
*
|
2019-06-23 13:56:21 -04:00
|
|
|
* @param string $filepath The filepath of the
|
|
|
|
*
|
2019-02-05 16:27:57 -05:00
|
|
|
* @return array The config array0
|
|
|
|
*
|
2019-06-23 13:56:21 -04:00
|
|
|
* @throws Exception if the config cannot get loaded.
|
2019-02-03 16:22:04 -05:00
|
|
|
*/
|
2019-02-05 16:27:57 -05:00
|
|
|
private function loadConfigFile($filepath)
|
2019-02-03 16:22:04 -05:00
|
|
|
{
|
|
|
|
$config = include($filepath);
|
|
|
|
|
|
|
|
if (!is_array($config)) {
|
2019-06-23 13:56:21 -04:00
|
|
|
throw new Exception('Error loading config file ' . $filepath);
|
2019-02-03 16:22:04 -05:00
|
|
|
}
|
|
|
|
|
|
|
|
return $config;
|
|
|
|
}
|
|
|
|
}
|