Hardening ConfigUpgrade
This commit is contained in:
parent
1c2a77c47f
commit
e0b1f4f251
5 changed files with 126 additions and 57 deletions
|
@ -33,7 +33,7 @@ require dirname(__DIR__) . '/vendor/autoload.php';
|
||||||
$a = Factory\DependencyFactory::setUp('worker', dirname(__DIR__));
|
$a = Factory\DependencyFactory::setUp('worker', dirname(__DIR__));
|
||||||
|
|
||||||
// Check the database structure and possibly fixes it
|
// Check the database structure and possibly fixes it
|
||||||
Update::check($a->getBasePath(), true);
|
Update::check($a->getBasePath(), true, $a->getMode());
|
||||||
|
|
||||||
// Quit when in maintenance
|
// Quit when in maintenance
|
||||||
if (!$a->getMode()->has(App\Mode::MAINTENANCEDISABLED)) {
|
if (!$a->getMode()->has(App\Mode::MAINTENANCEDISABLED)) {
|
||||||
|
|
|
@ -1187,7 +1187,7 @@ class App
|
||||||
$this->module = 'maintenance';
|
$this->module = 'maintenance';
|
||||||
} else {
|
} else {
|
||||||
$this->checkURL();
|
$this->checkURL();
|
||||||
Core\Update::check($this->getBasePath(), false);
|
Core\Update::check($this->getBasePath(), false, $this->getMode());
|
||||||
Core\Addon::loadAddons();
|
Core\Addon::loadAddons();
|
||||||
Core\Hook::loadHooks();
|
Core\Hook::loadHooks();
|
||||||
}
|
}
|
||||||
|
|
|
@ -188,4 +188,32 @@ class ConfigCache implements IConfigCache, IPConfigCache
|
||||||
{
|
{
|
||||||
return $this->config;
|
return $this->config;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Returns an array with missing categories/Keys
|
||||||
|
*
|
||||||
|
* @param array $config The array to check
|
||||||
|
*
|
||||||
|
* @return array
|
||||||
|
*/
|
||||||
|
public function keyDiff(array $config)
|
||||||
|
{
|
||||||
|
$return = [];
|
||||||
|
|
||||||
|
$categories = array_keys($config);
|
||||||
|
|
||||||
|
foreach ($categories as $category) {
|
||||||
|
if (is_array($config[$category])) {
|
||||||
|
$keys = array_keys($config[$category]);
|
||||||
|
|
||||||
|
foreach ($keys as $key) {
|
||||||
|
if (!isset($this->config[$category][$key])) {
|
||||||
|
$return[$category][$key] = $config[$category][$key];
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return $return;
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
|
@ -20,15 +20,20 @@ class Update
|
||||||
* @brief Function to check if the Database structure needs an update.
|
* @brief Function to check if the Database structure needs an update.
|
||||||
*
|
*
|
||||||
* @param string $basePath The base path of this application
|
* @param string $basePath The base path of this application
|
||||||
* @param boolean $via_worker boolean Is the check run via the worker?
|
* @param boolean $via_worker Is the check run via the worker?
|
||||||
|
* @param App\Mode $mode The current app mode
|
||||||
|
*
|
||||||
* @throws \Friendica\Network\HTTPException\InternalServerErrorException
|
* @throws \Friendica\Network\HTTPException\InternalServerErrorException
|
||||||
*/
|
*/
|
||||||
public static function check($basePath, $via_worker)
|
public static function check($basePath, $via_worker, App\Mode $mode)
|
||||||
{
|
{
|
||||||
if (!DBA::connected()) {
|
if (!DBA::connected()) {
|
||||||
return;
|
return;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// Check if the config files are set correctly
|
||||||
|
self::checkConfigFile($basePath, $mode);
|
||||||
|
|
||||||
// Don't check the status if the last update was failed
|
// Don't check the status if the last update was failed
|
||||||
if (Config::get('system', 'update', Update::SUCCESS, true) == Update::FAILED) {
|
if (Config::get('system', 'update', Update::SUCCESS, true) == Update::FAILED) {
|
||||||
return;
|
return;
|
||||||
|
@ -228,39 +233,76 @@ class Update
|
||||||
* Checks the config settings and saves given config values into the config file
|
* Checks the config settings and saves given config values into the config file
|
||||||
*
|
*
|
||||||
* @param string $basePath The basepath of Friendica
|
* @param string $basePath The basepath of Friendica
|
||||||
* @param App\Mode $mode The Application mode
|
* @param App\Mode $$mode The current App mode
|
||||||
*
|
*
|
||||||
* @return bool True, if something has been saved
|
* @return bool True, if something has been saved
|
||||||
*/
|
*/
|
||||||
public static function saveConfigToFile($basePath, App\Mode $mode)
|
public static function checkConfigFile($basePath, App\Mode $mode)
|
||||||
{
|
{
|
||||||
|
if (empty($basePath)) {
|
||||||
|
$basePath = BasePath::create(dirname(__DIR__, 2));
|
||||||
|
}
|
||||||
|
|
||||||
|
$config = [
|
||||||
|
'config' => [
|
||||||
|
'hostname' => [
|
||||||
|
'allowEmpty' => false,
|
||||||
|
'default' => '',
|
||||||
|
],
|
||||||
|
],
|
||||||
|
'system' => [
|
||||||
|
'basepath' => [
|
||||||
|
'allowEmpty' => false,
|
||||||
|
'default' => $basePath,
|
||||||
|
],
|
||||||
|
]
|
||||||
|
];
|
||||||
|
|
||||||
$configFileLoader = new ConfigFileLoader($basePath, $mode);
|
$configFileLoader = new ConfigFileLoader($basePath, $mode);
|
||||||
$configCache = new Config\Cache\ConfigCache();
|
$configCache = new Config\Cache\ConfigCache();
|
||||||
$configFileLoader->setupCache($configCache, true);
|
$configFileLoader->setupCache($configCache, true);
|
||||||
|
|
||||||
|
// checks if something is to update, otherwise skip this function at all
|
||||||
|
$missingConfig = $configCache->keyDiff($config);
|
||||||
|
if (empty($missingConfig)) {
|
||||||
|
return true;
|
||||||
|
}
|
||||||
|
|
||||||
|
// We just want one update process
|
||||||
|
if (Lock::acquire('config_update')) {
|
||||||
$configFileSaver = new ConfigFileSaver($basePath);
|
$configFileSaver = new ConfigFileSaver($basePath);
|
||||||
|
|
||||||
$updated = false;
|
$updated = false;
|
||||||
|
$toDelete = [];
|
||||||
|
|
||||||
if (self::updateConfigEntry($configCache, $configFileSaver,'config', 'hostname')) {
|
foreach ($missingConfig as $category => $keys) {
|
||||||
|
foreach ($keys as $key => $value) {
|
||||||
|
if (self::updateConfigEntry($configCache, $configFileSaver, $category, $key, $value['allowEmpty'], $value['default'])) {
|
||||||
|
$toDelete[] = ['cat' => $category, 'key' => $key];
|
||||||
$updated = true;
|
$updated = true;
|
||||||
};
|
};
|
||||||
|
}
|
||||||
if (self::updateConfigEntry($configCache, $configFileSaver,'system', 'basepath', BasePath::create(dirname(__DIR__) . '/../'))) {
|
|
||||||
$updated = true;
|
|
||||||
}
|
}
|
||||||
|
|
||||||
// In case there is nothing to do, skip the update
|
// In case there is nothing to do, skip the update
|
||||||
if (!$updated) {
|
if (!$updated) {
|
||||||
|
Lock::release('config_update');
|
||||||
return true;
|
return true;
|
||||||
}
|
}
|
||||||
|
|
||||||
if (!$configFileSaver->saveToConfigFile()) {
|
if (!$configFileSaver->saveToConfigFile()) {
|
||||||
Logger::alert('Config entry update failed - maybe wrong permission?');
|
Logger::alert('Config entry update failed - maybe wrong permission?');
|
||||||
|
Lock::release('config_update');
|
||||||
return false;
|
return false;
|
||||||
}
|
}
|
||||||
|
|
||||||
DBA::delete('config', ['cat' => 'config', 'k' => 'hostname']);
|
// After the successful save, remove the db values
|
||||||
DBA::delete('config', ['cat' => 'system', 'k' => 'basepath']);
|
foreach ($toDelete as $delete) {
|
||||||
|
DBA::delete('config', ['cat' => $delete['cat'], 'k' => $delete['key']]);
|
||||||
|
}
|
||||||
|
|
||||||
|
Lock::release('config_update');
|
||||||
|
}
|
||||||
|
|
||||||
return true;
|
return true;
|
||||||
}
|
}
|
||||||
|
@ -272,33 +314,47 @@ class Update
|
||||||
* @param ConfigFileSaver $configFileSaver The config file saver
|
* @param ConfigFileSaver $configFileSaver The config file saver
|
||||||
* @param string $cat The config category
|
* @param string $cat The config category
|
||||||
* @param string $key The config key
|
* @param string $key The config key
|
||||||
|
* @param bool $allowEmpty If true, empty values are valid (Default there has to be a variable)
|
||||||
* @param string $default A default value, if none of the settings are valid
|
* @param string $default A default value, if none of the settings are valid
|
||||||
*
|
*
|
||||||
* @return boolean True, if a value was updated
|
* @return boolean True, if a value was updated
|
||||||
*
|
*
|
||||||
* @throws \Exception if DBA or Logger doesn't work
|
* @throws \Exception if DBA or Logger doesn't work
|
||||||
*/
|
*/
|
||||||
private static function updateConfigEntry(IConfigCache $configCache, ConfigFileSaver $configFileSaver, $cat, $key, $default = '')
|
private static function updateConfigEntry(
|
||||||
|
IConfigCache $configCache,
|
||||||
|
ConfigFileSaver $configFileSaver,
|
||||||
|
$cat,
|
||||||
|
$key,
|
||||||
|
$allowEmpty = false,
|
||||||
|
$default = '')
|
||||||
{
|
{
|
||||||
|
|
||||||
// check if the config file differs from the whole configuration (= The db contains other values)
|
// check if the config file differs from the whole configuration (= The db contains other values)
|
||||||
$fileConfig = $configCache->get($cat, $key);
|
$fileValue = $configCache->get($cat, $key);
|
||||||
|
$dbConfig = DBA::selectFirst('config', ['v'], ['cat' => $cat, 'k' => $key]);
|
||||||
|
|
||||||
$savedConfig = DBA::selectFirst('config', ['v'], ['cat' => $cat, 'k' => $key]);
|
if (DBA::isResult($dbConfig)) {
|
||||||
|
$dbValue = $dbConfig['v'];
|
||||||
if (DBA::isResult($savedConfig)) {
|
|
||||||
$savedValue = $savedConfig['v'];
|
|
||||||
} else {
|
} else {
|
||||||
$savedValue = null;
|
$dbValue = null;
|
||||||
}
|
}
|
||||||
|
|
||||||
// If the db contains a config value, check it
|
// If the db contains a config value, check it
|
||||||
if (isset($savedValue) && $fileConfig !== $savedValue) {
|
if ((
|
||||||
Logger::info('Difference in config found', ['cat' => $cat, 'key' => $key, 'file' => $fileConfig, 'saved' => $savedValue]);
|
($allowEmpty && isset($dbValue)) ||
|
||||||
$configFileSaver->addConfigValue($cat, $key, $savedValue);
|
(!$allowEmpty && !empty($dbValue))
|
||||||
|
) &&
|
||||||
|
$fileValue !== $dbValue) {
|
||||||
|
Logger::info('Difference in config found', ['cat' => $cat, 'key' => $key, 'file' => $fileValue, 'db' => $dbValue]);
|
||||||
|
$configFileSaver->addConfigValue($cat, $key, $dbValue);
|
||||||
return true;
|
return true;
|
||||||
|
|
||||||
// If both config values are not set, use the default value
|
// If both config values are not set, use the default value
|
||||||
} elseif (!isset($fileConfig) && !isset($savedValue)) {
|
} elseif (
|
||||||
|
($allowEmpty && !isset($fileValue) && !isset($dbValue)) ||
|
||||||
|
(!$allowEmpty && empty($fileValue) && empty($dbValue) && !empty($default))) {
|
||||||
|
|
||||||
Logger::info('Using default for config', ['cat' => $cat, 'key' => $key, 'value' => $default]);
|
Logger::info('Using default for config', ['cat' => $cat, 'key' => $key, 'value' => $default]);
|
||||||
$configFileSaver->addConfigValue($cat, $key, $default);
|
$configFileSaver->addConfigValue($cat, $key, $default);
|
||||||
return true;
|
return true;
|
||||||
|
@ -306,7 +362,7 @@ class Update
|
||||||
// If either the file config value isn't empty or the db value is the same as the
|
// If either the file config value isn't empty or the db value is the same as the
|
||||||
// file config value, skip it
|
// file config value, skip it
|
||||||
} else {
|
} else {
|
||||||
Logger::info('No Difference in config found', ['cat' => $cat, 'key' => $key, 'value' => $fileConfig, 'saved' => $savedValue]);
|
Logger::debug('No Difference in config found', ['cat' => $cat, 'key' => $key, 'value' => $fileValue, 'db' => $dbValue]);
|
||||||
return false;
|
return false;
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
15
update.php
15
update.php
|
@ -1,6 +1,5 @@
|
||||||
<?php
|
<?php
|
||||||
|
|
||||||
use Friendica\BaseObject;
|
|
||||||
use Friendica\Core\Addon;
|
use Friendica\Core\Addon;
|
||||||
use Friendica\Core\Config;
|
use Friendica\Core\Config;
|
||||||
use Friendica\Core\L10n;
|
use Friendica\Core\L10n;
|
||||||
|
@ -347,17 +346,3 @@ function update_1298()
|
||||||
}
|
}
|
||||||
return Update::SUCCESS;
|
return Update::SUCCESS;
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
|
||||||
* @see https://github.com/friendica/friendica/pull/6920
|
|
||||||
* @return int Success
|
|
||||||
*/
|
|
||||||
function update_1307()
|
|
||||||
{
|
|
||||||
$app = BaseObject::getApp();
|
|
||||||
if (Update::saveConfigToFile($app->getBasePath(), $app->getMode())) {
|
|
||||||
return Update::SUCCESS;
|
|
||||||
} else {
|
|
||||||
return Update::FAILED;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
Loading…
Reference in a new issue