xmas-app 0.10.0__tar.gz → 0.11.0__tar.gz

{xmas_app-0.10.0 → xmas_app-0.11.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: xmas-app
-Version: 0.10.0
+Version: 0.11.0
 Summary: The XLeitstelle model-driven application schema app.
 License: EUPL-1.2-or-later
 License-File: LICENSE

{xmas_app-0.10.0 → xmas_app-0.11.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "xmas-app"
-version = "0.10.0"
+version = "0.11.0"
 description = "The XLeitstelle model-driven application schema app."
 authors = [{ name = "Tobias Kraft", email = "tobias.kraft@gv.hamburg.de" }]
 classifiers = [

xmas_app-0.11.0/xmas_app/deps/version_guard.py

@@ -0,0 +1,26 @@
+from fastapi import Header, HTTPException
+from semver import format_version, parse
+
+from xmas_app.settings import settings
+
+
+async def enforce_plugin_version(
+    user_agent: str = Header(...),
+):
+    if not user_agent.startswith(settings.qgis_plugin_name):
+        return
+    try:
+        _, plugin_version = user_agent.split("/")
+        client_v = parse(plugin_version)
+    except Exception:
+        raise HTTPException(
+            status_code=400,
+            detail=f"Invalid {settings.qgis_plugin_name} user-agent header: '{user_agent}'",
+        )
+
+    if client_v < settings.qgis_plugin_min_version:
+        # 426 Upgrade Required is appropriate
+        raise HTTPException(
+            status_code=426,
+            detail=f"Plugin version {settings.qgis_plugin_min_version}+ required, got {format_version(**client_v)}",
+        )

{xmas_app-0.10.0 → xmas_app-0.11.0}/xmas_app/main.py

@@ -3,6 +3,7 @@ import importlib
 import inspect
 import io
 import logging
+import os
 import re
 from contextlib import asynccontextmanager
 from functools import partial
@@ -18,10 +19,23 @@ from pydantic import ValidationError
 from starlette.applications import Starlette
 from xplan_tools.util import get_geometry_type_from_wkt
 
+from xmas_app.deps.version_guard import enforce_plugin_version
 from xmas_app.schema import ErrorDetail, ErrorResponse, SplitPayload, SplitSuccess
 from xmas_app.split_service import PlanSplitService, SplitValidationError
 
-log_dir = Path(__file__).parent / "logs"
+
+def _resolve_log_dir() -> Path:
+    # If launched from QGIS plugin
+    if os.getenv("XMAS_APP_FROM_PLUGIN") == "1":
+        plugin_dir = os.getenv("XMAS_APP_PLUGIN_DIR")
+        if plugin_dir:
+            return Path(plugin_dir) / "webapp_logs"
+
+    # default: local repo logs (dev)
+    return Path(__file__).parent / "logs"
+
+
+log_dir = _resolve_log_dir()
 log_dir.mkdir(exist_ok=True)
 log_file = log_dir / "xmas_app.log"
 
@@ -37,7 +51,7 @@ if not logger.handlers:
     logger.addHandler(fh)
     logger.debug(f"Writing logs to {log_file}")
 
-from fastapi import APIRouter, HTTPException, Request, status
+from fastapi import APIRouter, Depends, HTTPException, Request, status
 from nicegui import app, run, ui
 from nicegui.events import ClickEventArguments, ValueChangeEventArguments
 from xplan_tools.interface import repo_factory
@@ -114,10 +128,8 @@ async def get_model_for_select(
     )
 
 
-@ui.page("/")
-def index(
-    request: Request,
-):
+@ui.page("/", dependencies=[Depends(enforce_plugin_version)])
+def index():
     """
     Render the main index page of the XPlan-GUI application.
     Args:
@@ -138,7 +150,11 @@ def index(
     )
 
 
-@ui.page("/plan-tree/{id}", reconnect_timeout=5)
+@ui.page(
+    "/plan-tree/{id}",
+    reconnect_timeout=5,
+    dependencies=[Depends(enforce_plugin_version)],
+)
 async def plan_tree(
     request: Request,
     id: str,
@@ -385,7 +401,7 @@ async def plan_tree(
     tree_filter.bind_value_to(tree, "filter")
 
 
-@ui.page("/plans")
+@ui.page("/plans", dependencies=[Depends(enforce_plugin_version)])
 async def plans(
     request: Request,
     appschema: str = settings.appschema,
@@ -708,7 +724,7 @@ async def plans(
         new_plan_select.set_value(new_plan_select.options[0])
 
 
-@ui.page("/feature/{id}")
+@ui.page("/feature/{id}", dependencies=[Depends(enforce_plugin_version)])
 async def feature(
     request: Request,
     id: str,
@@ -939,7 +955,7 @@ async def feature(
             await add_form(feature_type, feature)
 
 
-@ui.page("/feature/{id}/associations")
+@ui.page("/feature/{id}/associations", dependencies=[Depends(enforce_plugin_version)])
 def get_associations(
     request: Request,
     id: str,
@@ -1121,20 +1137,22 @@ def validate_featuretype(
     return "OK"
 
 
-@app.post("/insert-features", status_code=201)
+@app.post(
+    "/insert-features", status_code=201, dependencies=[Depends(enforce_plugin_version)]
+)
 async def insert_features(payload: InsertPayload):
     """Insert a number of features."""
     await crud.create(payload)
 
 
-@app.post("/update-features")
+@app.post("/update-features", dependencies=[Depends(enforce_plugin_version)])
 async def update_features(payload: UpdatePayload):
     """Update a number of features."""
     await crud.update(payload)
 
 
 @app.post(
-    "/split_tool",
+    "/split-tool",
     response_model=SplitSuccess,
     status_code=status.HTTP_201_CREATED,  # semantically 'created'
     responses={
@@ -1142,6 +1160,7 @@ async def update_features(payload: UpdatePayload):
         422: {"model": ErrorResponse, "description": "Validation Error"},
         500: {"model": ErrorResponse, "description": "Server Error"},
     },
+    dependencies=[Depends(enforce_plugin_version)],
 )
 async def receive_split_plans(payload: SplitPayload) -> SplitSuccess:
     logger.info("Split plans endpoint reached.")

{xmas_app-0.10.0 → xmas_app-0.11.0}/xmas_app/settings.py

@@ -55,7 +55,7 @@ class Settings(BaseSettings):
         "https://registry.gdi-de.org/codelist/de.xleitstelle.xplanung"
     )
     qgis_plugin_name: str = "XMAS-Plugin"
-    qgis_plugin_min_version: _VersionPydanticAnnotation = Version(major=0, minor=9)
+    qgis_plugin_min_version: _VersionPydanticAnnotation = Version(major=0, minor=10)
 
     model_config = SettingsConfigDict(env_file=".env", env_file_encoding="utf-8")