kodi/webmanager-mvp
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

feat: preffered startup paths

Browse Source
This commit is contained in:
kodi
2026-03-12 14:47:39 +01:00
parent 559b881b6d
commit ed34d6202f
16 changed files with 644 additions and 13 deletions
Download Patch File Download Diff File Expand all files Collapse all files
webui/backend/app/__pycache__/dependencies.cpython-313.pyc
BIN
View File
Binary file not shown.
webui/backend/app/api/__pycache__/schemas.cpython-313.pyc
BIN
View File
Binary file not shown.
webui/backend/app/api/schemas.py
+5 -1
View File
@@ -96,10 +96,14 @@ class FileInfoResponse(BaseModel):
class SettingsResponse(BaseModel):
show_thumbnails: bool
preferred_startup_path_left: str | None = None
preferred_startup_path_right: str | None = None
class SettingsUpdateRequest(BaseModel):
show_thumbnails: bool
show_thumbnails: bool | None = None
preferred_startup_path_left: str | None = None
preferred_startup_path_right: str | None = None
class TaskListItem(BaseModel):
webui/backend/app/dependencies.py
+1 -1
View File
@@ -111,4 +111,4 @@ async def get_search_service() -> SearchService:
async def get_settings_service() -> SettingsService:
return SettingsService(repository=get_settings_repository())
return SettingsService(repository=get_settings_repository(), path_guard=get_path_guard())
webui/backend/app/services/__pycache__/settings_service.cpython-313.pyc
BIN
View File
Binary file not shown.
webui/backend/app/services/settings_service.py
+35 -3
View File
@@ -2,22 +2,54 @@ from __future__ import annotations
from backend.app.api.schemas import SettingsResponse, SettingsUpdateRequest
from backend.app.db.settings_repository import SettingsRepository
from backend.app.security.path_guard import PathGuard
class SettingsService:
def __init__(self, repository: SettingsRepository):
def __init__(self, repository: SettingsRepository, path_guard: PathGuard):
self._repository = repository
self._path_guard = path_guard
def get_settings(self) -> SettingsResponse:
values = self._repository.get_settings()
return SettingsResponse(show_thumbnails=self._as_bool(values.get("show_thumbnails"), default=False))
preferred_left = self._as_optional_str(values.get("preferred_startup_path_left"))
preferred_right = self._as_optional_str(values.get("preferred_startup_path_right"))
legacy_preferred = self._as_optional_str(values.get("preferred_startup_path"))
return SettingsResponse(
show_thumbnails=self._as_bool(values.get("show_thumbnails"), default=False),
preferred_startup_path_left=preferred_left or legacy_preferred,
preferred_startup_path_right=preferred_right,
)
def update_settings(self, request: SettingsUpdateRequest) -> SettingsResponse:
self._repository.set_setting("show_thumbnails", "true" if request.show_thumbnails else "false")
if request.show_thumbnails is not None:
self._repository.set_setting("show_thumbnails", "true" if request.show_thumbnails else "false")
if request.preferred_startup_path_left is not None:
self._set_directory_setting("preferred_startup_path_left", request.preferred_startup_path_left)
if request.preferred_startup_path_right is not None:
self._set_directory_setting("preferred_startup_path_right", request.preferred_startup_path_right)
return self.get_settings()
def _set_directory_setting(self, key: str, value: str) -> None:
normalized = value.strip()
if not normalized:
self._repository.set_setting(key, "")
return
resolved = self._path_guard.resolve_directory_path(normalized)
self._repository.set_setting(key, resolved.relative)
@staticmethod
def _as_bool(value: str | None, default: bool) -> bool:
if value is None:
return default
return value.strip().lower() in {"1", "true", "yes", "on"}
@staticmethod
def _as_optional_str(value: str | None) -> str | None:
if value is None:
return None
normalized = value.strip()
return normalized or None
webui/backend/data/tasks.db
BIN
View File
Binary file not shown.
webui/backend/tests/golden/__pycache__/test_api_settings_golden.cpython-313.pyc
BIN
View File
Binary file not shown.
webui/backend/tests/golden/__pycache__/test_ui_smoke_golden.cpython-313.pyc
BIN
View File
Binary file not shown.
webui/backend/tests/golden/test_api_settings_golden.py
+119 -7
View File
@@ -13,14 +13,22 @@ sys.path.insert(0, str(Path(__file__).resolve().parents[3]))
from backend.app.dependencies import get_settings_service
from backend.app.db.settings_repository import SettingsRepository
from backend.app.main import app
from backend.app.security.path_guard import PathGuard
from backend.app.services.settings_service import SettingsService
class SettingsApiGoldenTest(unittest.TestCase):
def setUp(self) -> None:
self.temp_dir = tempfile.TemporaryDirectory()
repository = SettingsRepository(str(Path(self.temp_dir.name) / "tasks.db"))
service = SettingsService(repository=repository)
self.root_path = Path(self.temp_dir.name) / "storage1"
self.root_path.mkdir()
(self.root_path / "docs").mkdir()
(self.root_path / "file.txt").write_text("sample", encoding="utf-8")
repository = SettingsRepository(str(Path(self.temp_dir.name) / "settings.db"))
service = SettingsService(
repository=repository,
path_guard=PathGuard({"storage1": str(self.root_path)}),
)
async def _override_settings_service() -> SettingsService:
return service
@@ -45,14 +53,118 @@ class SettingsApiGoldenTest(unittest.TestCase):
response = self._request("GET", "/api/settings")
self.assertEqual(response.status_code, 200)
self.assertEqual(response.json(), {"show_thumbnails": False})
self.assertEqual(
response.json(),
{
"show_thumbnails": False,
"preferred_startup_path_left": None,
"preferred_startup_path_right": None,
},
)
def test_settings_update_persistence(self) -> None:
response = self._request("POST", "/api/settings", {"show_thumbnails": True})
def test_settings_legacy_single_path_is_used_only_for_left_fallback(self) -> None:
repository = SettingsRepository(str(Path(self.temp_dir.name) / "settings.db"))
repository.set_setting("preferred_startup_path", "storage1/docs")
response = self._request("GET", "/api/settings")
self.assertEqual(response.status_code, 200)
self.assertEqual(response.json(), {"show_thumbnails": True})
self.assertEqual(self._request("GET", "/api/settings").json(), {"show_thumbnails": True})
self.assertEqual(
response.json(),
{
"show_thumbnails": False,
"preferred_startup_path_left": "storage1/docs",
"preferred_startup_path_right": None,
},
)
def test_settings_update_persistence_left_and_right(self) -> None:
response = self._request(
"POST",
"/api/settings",
{
"show_thumbnails": True,
"preferred_startup_path_left": "storage1/docs",
"preferred_startup_path_right": "storage1/docs",
},
)
self.assertEqual(response.status_code, 200)
self.assertEqual(
response.json(),
{
"show_thumbnails": True,
"preferred_startup_path_left": "storage1/docs",
"preferred_startup_path_right": "storage1/docs",
},
)
self.assertEqual(
self._request("GET", "/api/settings").json(),
{
"show_thumbnails": True,
"preferred_startup_path_left": "storage1/docs",
"preferred_startup_path_right": "storage1/docs",
},
)
def test_settings_preferred_startup_path_left_persistence(self) -> None:
response = self._request("POST", "/api/settings", {"preferred_startup_path_left": "storage1/docs"})
self.assertEqual(response.status_code, 200)
self.assertEqual(response.json()["preferred_startup_path_left"], "storage1/docs")
self.assertEqual(response.json()["preferred_startup_path_right"], None)
def test_settings_preferred_startup_path_right_persistence(self) -> None:
response = self._request("POST", "/api/settings", {"preferred_startup_path_right": "storage1/docs"})
self.assertEqual(response.status_code, 200)
self.assertEqual(response.json()["preferred_startup_path_left"], None)
self.assertEqual(response.json()["preferred_startup_path_right"], "storage1/docs")
def test_settings_preferred_startup_path_empty_string_resets_only_left_to_null(self) -> None:
self._request(
"POST",
"/api/settings",
{
"preferred_startup_path_left": "storage1/docs",
"preferred_startup_path_right": "storage1/docs",
},
)
response = self._request("POST", "/api/settings", {"preferred_startup_path_left": " "})
self.assertEqual(response.status_code, 200)
self.assertEqual(response.json()["preferred_startup_path_left"], None)
self.assertEqual(response.json()["preferred_startup_path_right"], "storage1/docs")
def test_settings_preferred_startup_path_left_rejects_file_path(self) -> None:
response = self._request("POST", "/api/settings", {"preferred_startup_path_left": "storage1/file.txt"})
self.assertEqual(response.status_code, 409)
self.assertEqual(response.json()["error"]["code"], "path_type_conflict")
def test_settings_preferred_startup_path_right_rejects_file_path(self) -> None:
response = self._request("POST", "/api/settings", {"preferred_startup_path_right": "storage1/file.txt"})
self.assertEqual(response.status_code, 409)
self.assertEqual(response.json()["error"]["code"], "path_type_conflict")
def test_settings_preferred_startup_path_left_rejects_traversal(self) -> None:
response = self._request("POST", "/api/settings", {"preferred_startup_path_left": "storage1/../etc"})
self.assertEqual(response.status_code, 403)
self.assertEqual(response.json()["error"]["code"], "path_traversal_detected")
def test_settings_preferred_startup_path_right_rejects_invalid_root_alias(self) -> None:
response = self._request("POST", "/api/settings", {"preferred_startup_path_right": "unknown/docs"})
self.assertEqual(response.status_code, 403)
self.assertEqual(response.json()["error"]["code"], "invalid_root_alias")
def test_settings_preferred_startup_path_left_rejects_missing_directory(self) -> None:
response = self._request("POST", "/api/settings", {"preferred_startup_path_left": "storage1/missing"})
self.assertEqual(response.status_code, 404)
self.assertEqual(response.json()["error"]["code"], "path_not_found")
if __name__ == "__main__":
webui/backend/tests/golden/test_ui_smoke_golden.py
+12
View File
@@ -65,6 +65,11 @@ class UiSmokeGoldenTest(unittest.TestCase):
self.assertIn('id="settings-logs-tab"', body)
self.assertIn('id="settings-show-thumbnails"', body)
self.assertIn("Show thumbnails", body)
self.assertIn('id="settings-startup-path-left"', body)
self.assertIn('id="settings-startup-path-right"', body)
self.assertIn("Preferred startup path (left)", body)
self.assertIn("Preferred startup path (right)", body)
self.assertIn('id="settings-general-save-btn"', body)
self.assertIn('id="settings-logs-list"', body)
self.assertIn('id="viewer-content"', body)
self.assertIn('id="editor-modal"', body)
@@ -118,6 +123,13 @@ class UiSmokeGoldenTest(unittest.TestCase):
self.assertIn('async function loadSettings()', app_js)
self.assertIn('await loadSettings();', app_js)
self.assertIn('settings.showThumbnailsInput.onchange = handleShowThumbnailsChange;', app_js)
self.assertIn('settings.generalSaveButton.onclick = handlePreferredStartupPathSave;', app_js)
self.assertIn('preferredStartupPathLeft', app_js)
self.assertIn('preferredStartupPathRight', app_js)
self.assertIn('preferred_startup_path_left', app_js)
self.assertIn('preferred_startup_path_right', app_js)
self.assertIn('paneState("left").currentPath = settingsState.preferredStartupPathLeft || "/Volumes";', app_js)
self.assertIn('paneState("right").currentPath = settingsState.preferredStartupPathRight || "/Volumes";', app_js)
self.assertIn('"/api/settings"', app_js)
self.assertIn('`/api/files/thumbnail?', app_js)
self.assertIn('function createMediaSlot(entry)', app_js)
webui/html/app.js
+55 -1
View File
@@ -48,6 +48,8 @@ let settingsState = {
activeTab: "general",
logsLoaded: false,
showThumbnails: false,
preferredStartupPathLeft: null,
preferredStartupPathRight: null,
};
let searchState = {
pane: "left",
@@ -202,6 +204,10 @@ function settingsElements() {
logsTab: document.getElementById("settings-logs-tab"),
generalPanel: document.getElementById("settings-general-panel"),
showThumbnailsInput: document.getElementById("settings-show-thumbnails"),
startupPathLeftInput: document.getElementById("settings-startup-path-left"),
startupPathRightInput: document.getElementById("settings-startup-path-right"),
generalError: document.getElementById("settings-general-error"),
generalSaveButton: document.getElementById("settings-general-save-btn"),
logsPanel: document.getElementById("settings-logs-panel"),
logsList: document.getElementById("settings-logs-list"),
logsError: document.getElementById("settings-logs-error"),
@@ -394,21 +400,38 @@ function createMediaSlot(entry) {
async function loadSettings() {
const data = await apiRequest("GET", "/api/settings");
settingsState.showThumbnails = !!data.show_thumbnails;
settingsState.preferredStartupPathLeft = data.preferred_startup_path_left || null;
settingsState.preferredStartupPathRight = data.preferred_startup_path_right || null;
const elements = settingsElements();
if (elements.showThumbnailsInput) {
elements.showThumbnailsInput.checked = settingsState.showThumbnails;
}
if (elements.startupPathLeftInput) {
elements.startupPathLeftInput.value = settingsState.preferredStartupPathLeft || "";
}
if (elements.startupPathRightInput) {
elements.startupPathRightInput.value = settingsState.preferredStartupPathRight || "";
}
}
async function saveSettings(update) {
const data = await apiRequest("POST", "/api/settings", update);
settingsState.showThumbnails = !!data.show_thumbnails;
settingsState.preferredStartupPathLeft = data.preferred_startup_path_left || null;
settingsState.preferredStartupPathRight = data.preferred_startup_path_right || null;
const elements = settingsElements();
if (elements.showThumbnailsInput) {
elements.showThumbnailsInput.checked = settingsState.showThumbnails;
}
if (elements.startupPathLeftInput) {
elements.startupPathLeftInput.value = settingsState.preferredStartupPathLeft || "";
}
if (elements.startupPathRightInput) {
elements.startupPathRightInput.value = settingsState.preferredStartupPathRight || "";
}
renderPaneItems("left");
renderPaneItems("right");
return data;
}
function updateActionButtons() {
@@ -1679,6 +1702,22 @@ async function handleShowThumbnailsChange(event) {
}
}
async function handlePreferredStartupPathSave() {
const settings = settingsElements();
const leftValue = settings.startupPathLeftInput ? settings.startupPathLeftInput.value : "";
const rightValue = settings.startupPathRightInput ? settings.startupPathRightInput.value : "";
settings.generalError.textContent = "";
try {
await saveSettings({
preferred_startup_path_left: leftValue,
preferred_startup_path_right: rightValue,
});
setStatus("Preferred startup paths saved");
} catch (err) {
settings.generalError.textContent = err.message;
}
}
function closeSettings() {
settingsElements().overlay.classList.add("hidden");
}
@@ -1686,6 +1725,7 @@ function closeSettings() {
async function openSettings(tab = "general") {
const elements = settingsElements();
elements.overlay.classList.remove("hidden");
elements.generalError.textContent = "";
setSettingsTab(tab);
if (settingsState.activeTab === "logs") {
await loadHistoryForSettings();
@@ -2147,6 +2187,7 @@ function setupEvents() {
await loadHistoryForSettings();
};
settings.showThumbnailsInput.onchange = handleShowThumbnailsChange;
settings.generalSaveButton.onclick = handlePreferredStartupPathSave;
settings.overlay.onclick = (event) => {
if (event.target === settings.overlay) {
closeSettings();
@@ -2255,7 +2296,20 @@ async function init() {
setActivePane("left");
setupEvents();
await loadSettings();
await Promise.all([loadBrowsePane("left"), loadBrowsePane("right")]);
paneState("left").currentPath = settingsState.preferredStartupPathLeft || "/Volumes";
paneState("right").currentPath = settingsState.preferredStartupPathRight || "/Volumes";
await loadBrowsePane("left");
if (paneState("left").currentPath !== "/Volumes" && document.getElementById("left-browse-error").textContent) {
setError("left-browse-error", "");
paneState("left").currentPath = "/Volumes";
await loadBrowsePane("left");
}
await loadBrowsePane("right");
if (paneState("right").currentPath !== "/Volumes" && document.getElementById("right-browse-error").textContent) {
setError("right-browse-error", "");
paneState("right").currentPath = "/Volumes";
await loadBrowsePane("right");
}
}
init();
webui/html/index.html
+12
View File
@@ -95,6 +95,18 @@
<span>Show thumbnails</span>
</label>
<div class="popup-meta">Image thumbnails are available for jpg, jpeg, png and webp files.</div>
<label class="settings-field" for="settings-startup-path-left">
<span>Preferred startup path (left)</span>
<input id="settings-startup-path-left" type="text" autocomplete="off" placeholder="/Volumes or storage1/path">
</label>
<label class="settings-field" for="settings-startup-path-right">
<span>Preferred startup path (right)</span>
<input id="settings-startup-path-right" type="text" autocomplete="off" placeholder="/Volumes or storage1/path">
</label>
<div id="settings-general-error" class="error"></div>
<div class="settings-actions">
<button id="settings-general-save-btn" type="button">Save</button>
</div>
</section>
<section id="settings-logs-panel" class="settings-panel hidden" role="tabpanel" aria-labelledby="settings-logs-tab">
<div id="settings-logs-error" class="error"></div>
webui/html/style.css
+15
View File
@@ -417,6 +417,21 @@ button:disabled {
margin: 10px 0 8px;
}
.settings-field {
display: grid;
gap: 6px;
margin: 10px 0 6px;
}
.settings-field input {
width: 100%;
}
.settings-actions {
display: flex;
margin-top: 8px;
}
.list li.is-selected {
background: var(--color-selection-bg);
box-shadow: inset 0 0 0 1px var(--color-selection-border);