Added first version of ConfigCacheSaver
This commit is contained in:
Philipp Holzer
@@ -0,0 +1,219 @@
|
||||
<?php
|
||||
|
||||
namespace Friendica\Util\Config;
|
||||
|
||||
use Friendica\App;
|
||||
use Friendica\Core\Addon;
|
||||
use Friendica\Core\Config\Cache\IConfigCache;
|
||||
|
||||
/**
|
||||
* The ConfigCacheLoader loads config-files and stores them in a IConfigCache ( @see IConfigCache )
|
||||
*
|
||||
* It is capable of loading the following config files:
|
||||
* - *.config.php (current)
|
||||
* - *.ini.php (deprecated)
|
||||
* - *.htconfig.php (deprecated)
|
||||
*/
|
||||
class ConfigCacheLoader extends ConfigCacheManager
|
||||
{
|
||||
/**
|
||||
* @var App\Mode
|
||||
*/
|
||||
private $appMode;
|
||||
|
||||
public function __construct($baseDir, App\Mode $mode)
|
||||
{
|
||||
parent::__construct($baseDir);
|
||||
$this->appMode = $mode;
|
||||
}
|
||||
|
||||
/**
|
||||
* Load the configuration files
|
||||
*
|
||||
* First loads the default value for all the configuration keys, then the legacy configuration files, then the
|
||||
* expected local.config.php
|
||||
*
|
||||
* @param IConfigCache The config cache to load to
|
||||
*
|
||||
* @throws \Exception
|
||||
*/
|
||||
public function loadConfigFiles(IConfigCache $config)
|
||||
{
|
||||
$config->load($this->loadCoreConfig('defaults'));
|
||||
$config->load($this->loadCoreConfig('settings'));
|
||||
|
||||
$config->load($this->loadLegacyConfig('htpreconfig'), true);
|
||||
$config->load($this->loadLegacyConfig('htconfig'), true);
|
||||
|
||||
$config->load($this->loadCoreConfig('local'), true);
|
||||
|
||||
// In case of install mode, add the found basepath (because there isn't a basepath set yet
|
||||
if ($this->appMode->isInstall()) {
|
||||
// Setting at least the basepath we know
|
||||
$config->set('system', 'basepath', $this->baseDir);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Tries to load the specified core-configuration and returns the config array.
|
||||
*
|
||||
* @param string $name The name of the configuration
|
||||
*
|
||||
* @return array The config array (empty if no config found)
|
||||
*
|
||||
* @throws \Exception if the configuration file isn't readable
|
||||
*/
|
||||
public function loadCoreConfig($name)
|
||||
{
|
||||
if (!empty($this->getConfigFullName($name))) {
|
||||
return $this->loadConfigFile($this->getConfigFullName($name));
|
||||
} elseif (!empty($this->getIniFullName($name))) {
|
||||
return $this->loadINIConfigFile($this->getIniFullName($name));
|
||||
} else {
|
||||
return [];
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* 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)
|
||||
*
|
||||
* @throws \Exception if the configuration file isn't readable
|
||||
*/
|
||||
public function loadAddonConfig($name)
|
||||
{
|
||||
$filepath = $this->baseDir . DIRECTORY_SEPARATOR . // /var/www/html/
|
||||
Addon::DIRECTORY . DIRECTORY_SEPARATOR . // addon/
|
||||
$name . DIRECTORY_SEPARATOR . // openstreetmap/
|
||||
self::SUBDIRECTORY . DIRECTORY_SEPARATOR . // config/
|
||||
$name . ".config.php"; // openstreetmap.config.php
|
||||
|
||||
if (file_exists($filepath)) {
|
||||
return $this->loadConfigFile($filepath);
|
||||
} else {
|
||||
return [];
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Tries to load the legacy config files (.htconfig.php, .htpreconfig.php) and returns the config array.
|
||||
*
|
||||
* @param string $name The name of the config file
|
||||
*
|
||||
* @return array The configuration array (empty if no config found)
|
||||
*
|
||||
* @deprecated since version 2018.09
|
||||
*/
|
||||
private function loadLegacyConfig($name)
|
||||
{
|
||||
$config = [];
|
||||
if (!empty($this->getHtConfigFullName($name))) {
|
||||
$a = new \stdClass();
|
||||
$a->config = [];
|
||||
include $this->getHtConfigFullName($name);
|
||||
|
||||
$htConfigCategories = array_keys($a->config);
|
||||
|
||||
// map the legacy configuration structure to the current structure
|
||||
foreach ($htConfigCategories as $htConfigCategory) {
|
||||
if (is_array($a->config[$htConfigCategory])) {
|
||||
$keys = array_keys($a->config[$htConfigCategory]);
|
||||
|
||||
foreach ($keys as $key) {
|
||||
$config[$htConfigCategory][$key] = $a->config[$htConfigCategory][$key];
|
||||
}
|
||||
} else {
|
||||
$config['config'][$htConfigCategory] = $a->config[$htConfigCategory];
|
||||
}
|
||||
}
|
||||
|
||||
unset($a);
|
||||
|
||||
if (isset($db_host)) {
|
||||
$config['database']['hostname'] = $db_host;
|
||||
unset($db_host);
|
||||
}
|
||||
if (isset($db_user)) {
|
||||
$config['database']['username'] = $db_user;
|
||||
unset($db_user);
|
||||
}
|
||||
if (isset($db_pass)) {
|
||||
$config['database']['password'] = $db_pass;
|
||||
unset($db_pass);
|
||||
}
|
||||
if (isset($db_data)) {
|
||||
$config['database']['database'] = $db_data;
|
||||
unset($db_data);
|
||||
}
|
||||
if (isset($config['system']['db_charset'])) {
|
||||
$config['database']['charset'] = $config['system']['db_charset'];
|
||||
}
|
||||
if (isset($pidfile)) {
|
||||
$config['system']['pidfile'] = $pidfile;
|
||||
unset($pidfile);
|
||||
}
|
||||
if (isset($default_timezone)) {
|
||||
$config['system']['default_timezone'] = $default_timezone;
|
||||
unset($default_timezone);
|
||||
}
|
||||
if (isset($lang)) {
|
||||
$config['system']['language'] = $lang;
|
||||
unset($lang);
|
||||
}
|
||||
}
|
||||
|
||||
return $config;
|
||||
}
|
||||
|
||||
/**
|
||||
* Tries to load the specified legacy configuration file and returns the config array.
|
||||
*
|
||||
* @deprecated since version 2018.12
|
||||
* @param string $filepath
|
||||
*
|
||||
* @return array The configuration array
|
||||
* @throws \Exception
|
||||
*/
|
||||
private function loadINIConfigFile($filepath)
|
||||
{
|
||||
$contents = include($filepath);
|
||||
|
||||
$config = parse_ini_string($contents, true, INI_SCANNER_TYPED);
|
||||
|
||||
if ($config === false) {
|
||||
throw new \Exception('Error parsing INI config file ' . $filepath);
|
||||
}
|
||||
|
||||
return $config;
|
||||
}
|
||||
|
||||
/**
|
||||
* Tries to load the specified configuration file and returns the config array.
|
||||
*
|
||||
* The config format is PHP array and the template for configuration files is the following:
|
||||
*
|
||||
* <?php return [
|
||||
* 'section' => [
|
||||
* 'key' => 'value',
|
||||
* ],
|
||||
* ];
|
||||
*
|
||||
* @param string $filepath The filepath of the
|
||||
* @return array The config array0
|
||||
*
|
||||
* @throws \Exception if the config cannot get loaded.
|
||||
*/
|
||||
private function loadConfigFile($filepath)
|
||||
{
|
||||
$config = include($filepath);
|
||||
|
||||
if (!is_array($config)) {
|
||||
throw new \Exception('Error loading config file ' . $filepath);
|
||||
}
|
||||
|
||||
return $config;
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,39 @@
|
||||
<?php
|
||||
|
||||
namespace Friendica\Util\Config;
|
||||
|
||||
abstract class ConfigCacheManager
|
||||
{
|
||||
/**
|
||||
* The Sub directory of the config-files
|
||||
* @var string
|
||||
*/
|
||||
const SUBDIRECTORY = 'config';
|
||||
|
||||
protected $baseDir;
|
||||
protected $configDir;
|
||||
|
||||
public function __construct($baseDir)
|
||||
{
|
||||
$this->baseDir = $baseDir;
|
||||
$this->configDir = $baseDir . DIRECTORY_SEPARATOR . self::SUBDIRECTORY;
|
||||
}
|
||||
|
||||
protected function getConfigFullName($name)
|
||||
{
|
||||
$fullName = $this->configDir . DIRECTORY_SEPARATOR . $name . '.config.php';
|
||||
return file_exists($fullName) ? $fullName : '';
|
||||
}
|
||||
|
||||
protected function getIniFullName($name)
|
||||
{
|
||||
$fullName = $this->configDir . DIRECTORY_SEPARATOR . $name . '.ini.php';
|
||||
return file_exists($fullName) ? $fullName : '';
|
||||
}
|
||||
|
||||
protected function getHtConfigFullName($name)
|
||||
{
|
||||
$fullName = $this->baseDir . DIRECTORY_SEPARATOR . '.' . $name . '.php';
|
||||
return file_exists($fullName) ? $fullName : '';
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,198 @@
|
||||
<?php
|
||||
|
||||
namespace Friendica\Util\Config;
|
||||
|
||||
/**
|
||||
* The ConfigCacheSaver saves specific variables back from the ConfigCache (@see ConfigCache )
|
||||
* into the config-files
|
||||
*
|
||||
* It is capable of loading the following config files:
|
||||
* - *.config.php (current)
|
||||
* - *.ini.php (deprecated)
|
||||
* - *.htconfig.php (deprecated)
|
||||
*/
|
||||
class ConfigCacheSaver extends ConfigCacheManager
|
||||
{
|
||||
/**
|
||||
* The standard indentation for config files
|
||||
* @var string
|
||||
*/
|
||||
const INDENT = "\t";
|
||||
|
||||
/**
|
||||
* Saves a given value to the config file
|
||||
* Either it replaces the current value or it will get added
|
||||
*
|
||||
* @param string $cat The configuration category
|
||||
* @param string $key The configuration key
|
||||
* @param string $value The new value
|
||||
*/
|
||||
public function saveToConfigFile($cat, $key, $value)
|
||||
{
|
||||
$this->saveToLegacyConfig('htpreconfig', $cat, $key, $value);
|
||||
$this->saveToLegacyConfig('htconfig', $cat, $key, $value);
|
||||
$this->saveToCoreConfig('local', $cat, $key, $value);
|
||||
}
|
||||
|
||||
/**
|
||||
* Saves a value to either an config or an ini file
|
||||
*
|
||||
* @param string $name The configuration file name ('local', 'addon', ..)
|
||||
* @param string $cat The configuration category
|
||||
* @param string $key The configuration key
|
||||
* @param string $value The new value
|
||||
*/
|
||||
private function saveToCoreConfig($name, $cat, $key, $value)
|
||||
{
|
||||
if (!empty($this->getConfigFullName($name))) {
|
||||
$this->saveConfigFile($this->getConfigFullName($name), $cat, $key, $value);
|
||||
} elseif (!empty($this->getIniFullName($name))) {
|
||||
$this->saveINIConfigFile($this->getIniFullName($name), $cat, $key, $value);
|
||||
} else {
|
||||
return;
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Saves a value to a config file
|
||||
*
|
||||
* @param string $fullName The configuration full name (including the path)
|
||||
* @param string $cat The configuration category
|
||||
* @param string $key The configuration key
|
||||
* @param string $value The new value
|
||||
*
|
||||
* @throws \Exception In case a file operation doesn't work
|
||||
*/
|
||||
private function saveConfigFile($fullName, $cat, $key, $value)
|
||||
{
|
||||
$reading = fopen($fullName, 'r');
|
||||
if (!$reading) {
|
||||
throw new \Exception('Cannot open config file \'' . $fullName . '\'.');
|
||||
}
|
||||
$writing = fopen($fullName . '.tmp', 'w');
|
||||
if (!$writing) {
|
||||
throw new \Exception('Cannot create temporary config file \'' . $fullName . '.tmp\'.');
|
||||
}
|
||||
$categoryFound = false;
|
||||
$categoryBracketFound = false;
|
||||
$lineFound = false;
|
||||
$lineArrowFound = false;
|
||||
while (!feof($reading)) {
|
||||
$line = fgets($reading);
|
||||
// find the first line like "'system' =>"
|
||||
if (!$categoryFound && stristr($line, sprintf('\'%s\'', $cat))) {
|
||||
$categoryFound = true;
|
||||
}
|
||||
// find the first line with a starting bracket ( "[" )
|
||||
if ($categoryFound && !$categoryBracketFound && stristr($line, '[')) {
|
||||
$categoryBracketFound = true;
|
||||
}
|
||||
// find the first line with the key like "'value'"
|
||||
if ($categoryBracketFound && !$lineFound && stristr($line, sprintf('\'%s\'', $key))) {
|
||||
$lineFound = true;
|
||||
}
|
||||
// find the first line with an arrow ("=>") after finding the key
|
||||
if ($lineFound && !$lineArrowFound && stristr($line, '=>')) {
|
||||
$lineArrowFound = true;
|
||||
}
|
||||
// find the current value and replace it
|
||||
if ($lineArrowFound && preg_match_all('/\'(.*?)\'/', $line, $matches, PREG_SET_ORDER)) {
|
||||
$lineVal = end($matches)[0];
|
||||
$writeLine = str_replace($lineVal, '\'' . $value . '\'', $line);
|
||||
$categoryFound = false;
|
||||
$categoryBracketFound = false;
|
||||
$lineFound = false;
|
||||
$lineArrowFound = false;
|
||||
// if a line contains a closing bracket for the category ( "]" ) and we didn't find the key/value pair,
|
||||
// add it as a new line before the closing bracket
|
||||
} elseif ($categoryBracketFound && !$lineArrowFound && stristr($line, ']')) {
|
||||
$categoryFound = false;
|
||||
$categoryBracketFound = false;
|
||||
$lineFound = false;
|
||||
$lineArrowFound = false;
|
||||
$writeLine = sprintf(self::INDENT . self::INDENT .'\'%s\' => \'%s\',' . PHP_EOL, $key, $value);
|
||||
$writeLine .= $line;
|
||||
} else {
|
||||
$writeLine = $line;
|
||||
}
|
||||
fputs($writing, $writeLine);
|
||||
}
|
||||
if (!fclose($reading)) {
|
||||
throw new \Exception('Cannot close config file \'' . $fullName . '\'.');
|
||||
};
|
||||
if (!fclose($writing)) {
|
||||
throw new \Exception('Cannot close temporary config file \'' . $fullName . '.tmp\'.');
|
||||
};
|
||||
if (!rename($fullName, $fullName . '.old')) {
|
||||
throw new \Exception('Cannot backup current config file \'' . $fullName . '\'.');
|
||||
}
|
||||
if (!rename($fullName . '.tmp', $fullName)) {
|
||||
throw new \Exception('Cannot move temporary config file \'' . $fullName . '.tmp\' to current.');
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Saves a value to a ini file
|
||||
*
|
||||
* @param string $fullName The configuration full name (including the path)
|
||||
* @param string $cat The configuration category
|
||||
* @param string $key The configuration key
|
||||
* @param string $value The new value
|
||||
*/
|
||||
private function saveINIConfigFile($fullName, $cat, $key, $value)
|
||||
{
|
||||
$reading = fopen($fullName, 'r');
|
||||
$writing = fopen($fullName . '.tmp', 'w');
|
||||
$categoryFound = false;
|
||||
while (!feof($reading)) {
|
||||
$line = fgets($reading);
|
||||
if (!$categoryFound && stristr($line, sprintf('[%s]', $cat))) {
|
||||
$categoryFound = true;
|
||||
$writeLine = $line;
|
||||
} elseif ($categoryFound && preg_match_all('/^' . $key . '\s*=\s*(.*?)$/', $line, $matches, PREG_SET_ORDER)) {
|
||||
$writeLine = $key . ' = ' . $value . PHP_EOL;
|
||||
$categoryFound = false;
|
||||
} elseif ($categoryFound && (preg_match_all('/^\[.*?\]$/', $line) || preg_match_all('/^INI;.*$/', $line))) {
|
||||
$categoryFound = false;
|
||||
$writeLine = $key . ' = ' . $value . PHP_EOL;
|
||||
$writeLine .= $line;
|
||||
} else {
|
||||
$writeLine = $line;
|
||||
}
|
||||
fputs($writing, $writeLine);
|
||||
}
|
||||
fclose($reading);
|
||||
fclose($writing);
|
||||
rename($fullName, $fullName . '.old');
|
||||
rename($fullName . '.tmp', $fullName);
|
||||
}
|
||||
|
||||
private function saveToLegacyConfig($name, $cat, $key, $value)
|
||||
{
|
||||
if (empty($this->getHtConfigFullName($name))) {
|
||||
return;
|
||||
}
|
||||
$fullName = $this->getHtConfigFullName($name);
|
||||
$reading = fopen($fullName, 'r');
|
||||
$writing = fopen($fullName . '.tmp', 'w');
|
||||
$found = false;
|
||||
while (!feof($reading)) {
|
||||
$line = fgets($reading);
|
||||
if (preg_match_all('/^\$a\-\>config\[\'' . $cat . '\',\'' . $key . '\'\]\s*=\s\'*(.*?)\'$/', $line, $matches, PREG_SET_ORDER)) {
|
||||
$writeLine = $key . ' = ' . $value . PHP_EOL;
|
||||
$found = true;
|
||||
} else {
|
||||
$writeLine = $line;
|
||||
}
|
||||
fputs($writing, $writeLine);
|
||||
}
|
||||
if (!$found) {
|
||||
$writeLine = $key . ' = ' . $value . PHP_EOL;
|
||||
fputs($writing, $writeLine);
|
||||
}
|
||||
fclose($reading);
|
||||
fclose($writing);
|
||||
rename($fullName, $fullName . '.old');
|
||||
rename($fullName . '.tmp', $fullName);
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user