From 76f3b07033065b0a4229866b9ac320a72176d8fe Mon Sep 17 00:00:00 2001 From: Philipp Date: Sat, 25 Mar 2023 19:02:47 +0100 Subject: [PATCH] Disable setting fields in case we use environment variables --- .../Config/Capability/IManageConfigValues.php | 10 ++++++++++ src/Core/Config/Model/DatabaseConfig.php | 6 ++++++ src/Core/Config/Model/ReadOnlyFileConfig.php | 6 ++++++ src/Core/Config/ValueObject/Cache.php | 9 +++++++++ src/Module/Admin/Logs/Settings.php | 18 ++++++++++++------ src/Module/Admin/Site.php | 12 ++++++++---- src/Module/Admin/Storage.php | 3 ++- view/templates/admin/storage.tpl | 8 +++++--- view/templates/field_select.tpl | 2 +- view/theme/frio/templates/admin/storage.tpl | 8 +++++--- view/theme/frio/templates/field_select.tpl | 2 +- 11 files changed, 65 insertions(+), 19 deletions(-) diff --git a/src/Core/Config/Capability/IManageConfigValues.php b/src/Core/Config/Capability/IManageConfigValues.php index 4f785d0077..93e0143b0a 100644 --- a/src/Core/Config/Capability/IManageConfigValues.php +++ b/src/Core/Config/Capability/IManageConfigValues.php @@ -58,6 +58,16 @@ interface IManageConfigValues */ public function get(string $cat, string $key = null, $default_value = null); + /** + * Returns true, if the current config cannot be changed + * + * @param string $cat The category of the configuration value + * @param string $key The configuration key to query + * + * @return bool true, if set is disabled + */ + public function isSetDisabled(string $cat, string $key): bool; + /** * Sets a configuration value for system config * diff --git a/src/Core/Config/Model/DatabaseConfig.php b/src/Core/Config/Model/DatabaseConfig.php index 7167ccbf8e..058c903599 100644 --- a/src/Core/Config/Model/DatabaseConfig.php +++ b/src/Core/Config/Model/DatabaseConfig.php @@ -80,6 +80,12 @@ class DatabaseConfig implements IManageConfigValues return $this->cache->get($cat, $key) ?? $default_value; } + /** {@inheritDoc} */ + public function isSetDisabled(string $cat, string $key): bool + { + return $this->cache->getSource($cat, $key) >= Cache::SOURCE_ENV; + } + /** {@inheritDoc} */ public function set(string $cat, string $key, $value): bool { diff --git a/src/Core/Config/Model/ReadOnlyFileConfig.php b/src/Core/Config/Model/ReadOnlyFileConfig.php index 4b32720f02..f0a25fcf40 100644 --- a/src/Core/Config/Model/ReadOnlyFileConfig.php +++ b/src/Core/Config/Model/ReadOnlyFileConfig.php @@ -68,6 +68,12 @@ class ReadOnlyFileConfig implements IManageConfigValues return $this->configCache->get($cat, $key) ?? $default_value; } + /** {@inheritDoc} */ + public function isSetDisabled(string $cat, string $key): bool + { + return $this->configCache->getSource($cat, $key) >= Cache::SOURCE_ENV; + } + /** {@inheritDoc} */ public function set(string $cat, string $key, $value): bool { diff --git a/src/Core/Config/ValueObject/Cache.php b/src/Core/Config/ValueObject/Cache.php index acfac3ab9a..f80be18049 100644 --- a/src/Core/Config/ValueObject/Cache.php +++ b/src/Core/Config/ValueObject/Cache.php @@ -31,6 +31,15 @@ use ParagonIE\HiddenString\HiddenString; */ class Cache { + /** @var int[] A list of valid config source */ + const VALID_SOURCES = [ + self::SOURCE_STATIC, + self::SOURCE_FILE, + self::SOURCE_DATA, + self::SOURCE_ENV, + self::SOURCE_FIX, + ]; + /** @var int Indicates that the cache entry is a default value - Lowest Priority */ const SOURCE_STATIC = 0; /** @var int Indicates that the cache entry is set by file - Low Priority */ diff --git a/src/Module/Admin/Logs/Settings.php b/src/Module/Admin/Logs/Settings.php index 91b2938710..1fbd4ce843 100644 --- a/src/Module/Admin/Logs/Settings.php +++ b/src/Module/Admin/Logs/Settings.php @@ -48,9 +48,15 @@ class Settings extends BaseAdmin return; } - DI::config()->set('system', 'logfile', $logfile); - DI::config()->set('system', 'debugging', $debugging); - DI::config()->set('system', 'loglevel', $loglevel); + if (!DI::config()->isSetDisabled('system', 'logfile')) { + DI::config()->set('system', 'logfile', $logfile); + } + if (!DI::config()->isSetDisabled('system', 'debugging')) { + DI::config()->set('system', 'debugging', $debugging); + } + if (!DI::config()->isSetDisabled('system', 'loglevel')) { + DI::config()->set('system', 'loglevel', $loglevel); + } DI::baseUrl()->redirect('admin/logs'); } @@ -82,9 +88,9 @@ class Settings extends BaseAdmin '$clear' => DI::l10n()->t('Clear'), '$logname' => DI::config()->get('system', 'logfile'), // see /help/smarty3-templates#1_1 on any Friendica node - '$debugging' => ['debugging', DI::l10n()->t("Enable Debugging"), DI::config()->get('system', 'debugging'), ""], - '$logfile' => ['logfile', DI::l10n()->t("Log file"), DI::config()->get('system', 'logfile'), DI::l10n()->t("Must be writable by web server. Relative to your Friendica top-level directory.")], - '$loglevel' => ['loglevel', DI::l10n()->t("Log level"), DI::config()->get('system', 'loglevel'), "", $log_choices], + '$debugging' => ['debugging', DI::l10n()->t("Enable Debugging"), DI::config()->get('system', 'debugging'), "", DI::config()->isSetDisabled('system', 'debugging') ? 'disabled' : ''], + '$logfile' => ['logfile', DI::l10n()->t("Log file"), DI::config()->get('system', 'logfile'), DI::l10n()->t("Must be writable by web server. Relative to your Friendica top-level directory."), "", DI::config()->isSetDisabled('system', 'logfile') ? 'disabled' : ''], + '$loglevel' => ['loglevel', DI::l10n()->t("Log level"), DI::config()->get('system', 'loglevel'), "", $log_choices, DI::config()->isSetDisabled('system', 'loglevel') ? 'disabled' : ''], '$form_security_token' => self::getFormSecurityToken("admin_logs"), '$phpheader' => DI::l10n()->t("PHP logging"), '$phphint' => DI::l10n()->t("To temporarily enable logging of PHP errors and warnings you can prepend the following to the index.php file of your installation. The filename set in the 'error_log' line is relative to the friendica top-level directory and must be writeable by the web server. The option '1' for 'log_errors' and 'display_errors' is to enable these options, set to '0' to disable them."), diff --git a/src/Module/Admin/Site.php b/src/Module/Admin/Site.php index c867c04c97..98e5070580 100644 --- a/src/Module/Admin/Site.php +++ b/src/Module/Admin/Site.php @@ -165,7 +165,9 @@ class Site extends BaseAdmin $transactionConfig->set('system', 'poco_discovery' , $poco_discovery); $transactionConfig->set('system', 'poco_local_search' , $poco_local_search); $transactionConfig->set('system', 'nodeinfo' , $nodeinfo); - $transactionConfig->set('config', 'sitename' , $sitename); + if (!DI::config()->isSetDisabled('config', 'sitename')) { + $transactionConfig->set('config', 'sitename' , $sitename); + } $transactionConfig->set('config', 'sender_email' , $sender_email); $transactionConfig->set('system', 'suppress_tags' , $suppress_tags); $transactionConfig->set('system', 'shortcut_icon' , $shortcut_icon); @@ -188,7 +190,9 @@ class Site extends BaseAdmin } else { $transactionConfig->set('config', 'info', $additional_info); } - $transactionConfig->set('system', 'language', $language); + if (!DI::config()->isSetDisabled('system', 'language')) { + $transactionConfig->set('system', 'language', $language); + } $transactionConfig->set('system', 'theme', $theme); Theme::install($theme); @@ -413,7 +417,7 @@ class Site extends BaseAdmin '$relocate_cmd' => DI::l10n()->t('(Friendica directory)# bin/console relocate https://newdomain.com'), // name, label, value, help string, extra data... - '$sitename' => ['sitename', DI::l10n()->t('Site name'), DI::config()->get('config', 'sitename'), ''], + '$sitename' => ['sitename', DI::l10n()->t('Site name'), DI::config()->get('config', 'sitename'), '', '', DI::config()->isSetDisabled('config', 'sitename') ? 'disabled' : ''], '$sender_email' => ['sender_email', DI::l10n()->t('Sender Email'), DI::config()->get('config', 'sender_email'), DI::l10n()->t('The email address your server shall use to send notification emails from.'), '', '', 'email'], '$system_actor_name' => ['system_actor_name', DI::l10n()->t('Name of the system actor'), User::getActorName(), DI::l10n()->t("Name of the internal system account that is used to perform ActivityPub requests. This must be an unused username. If set, this can't be changed again.")], '$banner' => ['banner', DI::l10n()->t('Banner/Logo'), $banner, ''], @@ -421,7 +425,7 @@ class Site extends BaseAdmin '$shortcut_icon' => ['shortcut_icon', DI::l10n()->t('Shortcut icon'), DI::config()->get('system', 'shortcut_icon'), DI::l10n()->t('Link to an icon that will be used for browsers.')], '$touch_icon' => ['touch_icon', DI::l10n()->t('Touch icon'), DI::config()->get('system', 'touch_icon'), DI::l10n()->t('Link to an icon that will be used for tablets and mobiles.')], '$additional_info' => ['additional_info', DI::l10n()->t('Additional Info'), $additional_info, DI::l10n()->t('For public servers: you can add additional information here that will be listed at %s/servers.', Search::getGlobalDirectory())], - '$language' => ['language', DI::l10n()->t('System language'), DI::config()->get('system', 'language'), '', $lang_choices], + '$language' => ['language', DI::l10n()->t('System language'), DI::config()->get('system', 'language'), '', $lang_choices, DI::config()->isSetDisabled('system', 'language') ? 'disabled' : ''], '$theme' => ['theme', DI::l10n()->t('System theme'), DI::config()->get('system', 'theme'), DI::l10n()->t('Default system theme - may be over-ridden by user profiles - Change default theme settings', DI::baseUrl() . '/admin/themes'), $theme_choices], '$theme_mobile' => ['theme_mobile', DI::l10n()->t('Mobile system theme'), DI::config()->get('system', 'mobile-theme', '---'), DI::l10n()->t('Theme for mobile devices'), $theme_choices_mobile], '$force_ssl' => ['force_ssl', DI::l10n()->t('Force SSL'), DI::config()->get('system', 'force_ssl'), DI::l10n()->t('Force all Non-SSL requests to SSL - Attention: on some systems it could lead to endless loops.')], diff --git a/src/Module/Admin/Storage.php b/src/Module/Admin/Storage.php index e31d7db390..b3361b6c17 100644 --- a/src/Module/Admin/Storage.php +++ b/src/Module/Admin/Storage.php @@ -76,7 +76,7 @@ class Storage extends BaseAdmin } } - if (!empty($_POST['submit_save_set'])) { + if (!empty($_POST['submit_save_set']) && !DI::config()->isSetDisabled('storage', 'name') ) { try { $newstorage = DI::storageManager()->getWritableStorageByName($storagebackend); @@ -129,6 +129,7 @@ class Storage extends BaseAdmin 'prefix' => $storage_form_prefix, 'form' => $storage_form, 'active' => $current_storage_backend instanceof ICanWriteToStorage && $name === $current_storage_backend::getName(), + 'set_disabled' => DI::config()->isSetDisabled('storage', 'name'), ]; } diff --git a/view/templates/admin/storage.tpl b/view/templates/admin/storage.tpl index b1918c5a8b..e4c33e1e28 100644 --- a/view/templates/admin/storage.tpl +++ b/view/templates/admin/storage.tpl @@ -19,12 +19,14 @@ {{if $storage.form}} - {{if $storage.active}} + {{if ! $storage.set_disabled}} + {{if $storage.active}} - {{else}} + {{else}} + {{/if}} {{/if}} - {{else}} + {{elseif ! $storage.set_disabled}}
{{/if}} diff --git a/view/templates/field_select.tpl b/view/templates/field_select.tpl index 16a796a444..9336ce3cc7 100644 --- a/view/templates/field_select.tpl +++ b/view/templates/field_select.tpl @@ -1,7 +1,7 @@
- {{foreach $field.4 as $opt=>$val}} {{/foreach}} diff --git a/view/theme/frio/templates/admin/storage.tpl b/view/theme/frio/templates/admin/storage.tpl index 1a63d1817f..e2d1bbf895 100644 --- a/view/theme/frio/templates/admin/storage.tpl +++ b/view/theme/frio/templates/admin/storage.tpl @@ -33,12 +33,14 @@
{{if $storage.form}} - {{if $storage.active}} + {{if ! $storage.set_disabled}} + {{if $storage.active}} - {{else}} + {{else}} + {{/if}} {{/if}} - {{else}} + {{elseif ! $storage.set_disabled }} {{/if}}
diff --git a/view/theme/frio/templates/field_select.tpl b/view/theme/frio/templates/field_select.tpl index 25cfd652cd..d5bcfdad61 100644 --- a/view/theme/frio/templates/field_select.tpl +++ b/view/theme/frio/templates/field_select.tpl @@ -1,7 +1,7 @@
- {{foreach $field.4 as $opt=>$val}} {{/foreach}}