- /**
- * Checks the config settings and saves given config values into the config file
- *
- * @param string $basePath The basepath of Friendica
- * @param App\Mode $mode The current App mode
- *
- * @return bool True, if something has been saved
- */
- 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);
- $configCache = new Config\Cache\ConfigCache();
- $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);
-
- $updated = false;
- $toDelete = [];
-
- 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;
- };
- }
- }
-
- // In case there is nothing to do, skip the update
- if (!$updated) {
- Lock::release('config_update');
- return true;
- }
-
- if (!$configFileSaver->saveToConfigFile()) {
- Logger::alert('Config entry update failed - maybe wrong permission?');
- Lock::release('config_update');
- return false;
- }
-
- // After the successful save, remove the db values
- foreach ($toDelete as $delete) {
- DBA::delete('config', ['cat' => $delete['cat'], 'k' => $delete['key']]);
- }
-
- Lock::release('config_update');
- }
-
- return true;
- }
-
- /**
- * Adds a value to the ConfigFileSave in case it isn't already updated
- *
- * @param IConfigCache $configCache The cached config file
- * @param ConfigFileSaver $configFileSaver The config file saver
- * @param string $cat The config category
- * @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
- *
- * @return boolean True, if a value was updated
- *
- * @throws \Exception if DBA or Logger doesn't work
- */
- 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)
- $fileValue = $configCache->get($cat, $key);
- $dbConfig = DBA::selectFirst('config', ['v'], ['cat' => $cat, 'k' => $key]);
-
- if (DBA::isResult($dbConfig)) {
- $dbValue = $dbConfig['v'];
- } else {
- $dbValue = null;
- }
-
- // If the db contains a config value, check it
- if ((
- ($allowEmpty && isset($dbValue)) ||
- (!$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;
-
- // If both config values are not set, use the default value
- } 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]);
- $configFileSaver->addConfigValue($cat, $key, $default);
- return true;
-
- // If either the file config value isn't empty or the db value is the same as the
- // file config value, skip it
- } else {
- Logger::debug('No Difference in config found', ['cat' => $cat, 'key' => $key, 'value' => $fileValue, 'db' => $dbValue]);
- return false;
- }
- }
-