rommapp/romm
1
0
Fork 0
mirror of https://github.com/rommapp/romm.git synced 2026-02-18 00:27:41 +01:00
Code Issues Packages Projects Releases Wiki Activity

Separate checks for readable/writable config.yml

Browse Source
This commit is contained in:
Georges-Antoine Assi
2025-10-21 20:18:31 -04:00
parent d1395035bd
commit f87b7971a2
9 changed files with 36 additions and 15 deletions
Download Patch File Download Diff File Expand all files Collapse all files

23
backend/config/config_manager.py
View File

@@ -46,6 +46,7 @@ EjsOption = dict[str, str] # option_name -> option_value
class Config:
CONFIG_FILE_MOUNTED: bool
CONFIG_FILE_WRITABLE: bool
EXCLUDED_PLATFORMS: list[str]
EXCLUDED_SINGLE_EXT: list[str]
EXCLUDED_SINGLE_FILES: list[str]
@@ -82,6 +83,7 @@ class ConfigManager:
_self = None
_raw_config: dict = {}
_config_file_mounted: bool = False
_config_file_writable: bool = False
def __new__(cls, *args, **kwargs):
if cls._self is None:
@@ -94,17 +96,20 @@ class ConfigManager:
self.config_file = config_file
try:
with open(self.config_file, "r+") as cf:
# Check if the config file is mounted
with open(self.config_file, "r") as cf:
self._config_file_mounted = True
self._raw_config = yaml.load(cf, Loader=SafeLoader) or {}
# Also check if the config file is writable
with open(self.config_file, "r+") as cf:
self._config_file_writable = True
except FileNotFoundError:
self._config_file_mounted = False
log.critical(
"Config file not found! Any changes made to the configuration will not persist after the application restarts."
)
except PermissionError:
self._config_file_mounted = False
log.critical(
log.warning(
"Config file not writable! Any changes made to the configuration will not persist after the application restarts."
)
finally:
@@ -159,6 +164,7 @@ class ConfigManager:
self.config = Config(
CONFIG_FILE_MOUNTED=self._config_file_mounted,
CONFIG_FILE_WRITABLE=self._config_file_writable,
EXCLUDED_PLATFORMS=pydash.get(self._raw_config, "exclude.platforms", []),
EXCLUDED_SINGLE_EXT=[
e.lower()
@@ -415,11 +421,10 @@ class ConfigManager:
def get_config(self) -> Config:
try:
with open(self.config_file, "r+") as config_file:
with open(self.config_file, "r") as config_file:
self._raw_config = yaml.load(config_file, Loader=SafeLoader) or {}
except (FileNotFoundError, PermissionError):
log.debug("Config file not found or not writable")
pass
except FileNotFoundError:
log.debug("Config file not found!")
self._parse_config()
self._validate_config()
@@ -427,7 +432,7 @@ class ConfigManager:
return self.config
def _update_config_file(self) -> None:
if not self._config_file_mounted:
if not self._config_file_writable:
log.warning("Config file not mounted, skipping config file update")
raise ConfigNotWritableException

1
backend/endpoints/configs.py
View File

@@ -25,6 +25,7 @@ def get_config() -> ConfigResponse:
cfg = cm.get_config()
return ConfigResponse(
CONFIG_FILE_MOUNTED=cfg.CONFIG_FILE_MOUNTED,
CONFIG_FILE_WRITABLE=cfg.CONFIG_FILE_WRITABLE,
EXCLUDED_PLATFORMS=cfg.EXCLUDED_PLATFORMS,
EXCLUDED_SINGLE_EXT=cfg.EXCLUDED_SINGLE_EXT,
EXCLUDED_SINGLE_FILES=cfg.EXCLUDED_SINGLE_FILES,

1
backend/endpoints/responses/config.py
View File

@@ -5,6 +5,7 @@ from config.config_manager import EjsControls
class ConfigResponse(TypedDict):
CONFIG_FILE_MOUNTED: bool
CONFIG_FILE_WRITABLE: bool
EXCLUDED_PLATFORMS: list[str]
EXCLUDED_SINGLE_EXT: list[str]
EXCLUDED_SINGLE_FILES: list[str]

1
frontend/src/__generated__/models/ConfigResponse.ts generated
View File

@@ -5,6 +5,7 @@
import type { EjsControls } from './EjsControls';
export type ConfigResponse = {
CONFIG_FILE_MOUNTED: boolean;
CONFIG_FILE_WRITABLE: boolean;
EXCLUDED_PLATFORMS: Array<string>;
EXCLUDED_SINGLE_EXT: Array<string>;
EXCLUDED_SINGLE_FILES: Array<string>;

2
frontend/src/components/Settings/LibraryManagement/Config/Excluded.vue
View File

@@ -63,7 +63,7 @@ const editable = ref(false);
variant="text"
icon="mdi-cog"
@click="editable = !editable"
:disabled="!config.CONFIG_FILE_MOUNTED"
:disabled="!config.CONFIG_FILE_WRITABLE"
/>
</template>
<template #content>

2
frontend/src/components/Settings/LibraryManagement/Config/PlatformBinding.vue
View File

@@ -48,7 +48,7 @@ const editable = ref(false);
variant="text"
icon="mdi-cog"
@click="editable = !editable"
:disabled="!config.CONFIG_FILE_MOUNTED"
:disabled="!config.CONFIG_FILE_WRITABLE"
/>
</template>
<template #content>

2
frontend/src/components/Settings/LibraryManagement/Config/PlatformVersions.vue
View File

@@ -50,7 +50,7 @@ const editable = ref(false);
variant="text"
icon="mdi-cog"
@click="editable = !editable"
:disabled="!config.CONFIG_FILE_MOUNTED"
:disabled="!config.CONFIG_FILE_WRITABLE"
/>
</template>
<template #content>

1
frontend/src/stores/config.ts
View File

@@ -13,6 +13,7 @@ type ExclusionTypes =
const defaultConfig = {
CONFIG_FILE_MOUNTED: false,
CONFIG_FILE_WRITABLE: false,
EXCLUDED_PLATFORMS: [],
EXCLUDED_SINGLE_EXT: [],
EXCLUDED_SINGLE_FILES: [],

18
frontend/src/views/Settings/LibraryManagement.vue
View File

@@ -204,10 +204,22 @@ onUnmounted(() => {
variant="tonal"
class="my-2"
>
<template #title> Configuration file not mounted </template>
<template #title>Configuration file not mounted!</template>
<template #text>
The config.yml file is not mounted or writable. Any changes made to
the configuration will not persist after the application restarts.
The config.yml file has not been mounted. Any changes made to the
configuration will not persist after the application restarts.
</template>
</v-alert>
<v-alert
v-else-if="!config.CONFIG_FILE_WRITABLE"
type="warning"
variant="tonal"
class="my-2"
>
<template #title>Configuration file not writable!</template>
<template #text>
The config.yml file is not writable. Any changes made to the
configuration will not persist after the application restarts.
</template>
</v-alert>
<v-tabs-window v-model="tab">