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

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: xmas-app
-Version: 0.9.0
+Version: 0.11.0
 Summary: The XLeitstelle model-driven application schema app.
 License: EUPL-1.2-or-later
 License-File: LICENSE
@@ -13,10 +13,11 @@ Classifier: License :: OSI Approved :: European Union Public Licence 1.2 (EUPL 1
 Classifier: Operating System :: OS Independent
 Classifier: Programming Language :: Python :: 3
 Requires-Dist: nicegui (>=2.20,<3.0)
+Requires-Dist: pydantic-extra-types[semver]
 Requires-Dist: pydantic-settings (>=2.0,<3.0)
 Requires-Dist: xplan-tools (>=1.10.3)
 Project-URL: Homepage, https://gitlab.opencode.de/xleitstelle/xmas-app
-Project-URL: Issues, https://gitlab.opencode.de/xleitstelle/xplanung/xmas-app/-/issues
+Project-URL: Issues, https://gitlab.opencode.de/xleitstelle/xmas-app/-/issues
 Description-Content-Type: text/markdown
 
 # XMAS-App
@@ -106,7 +107,7 @@ pixi shell
 then run
 
 ```shell
-xplan-gui
+xmas-app
 ```
 
 ### Optional: batch import test data to the database using xplan-tools
@@ -125,10 +126,11 @@ done
 (on Windows:):
 ```cmd
 for %f in (*.gml) do xplan-tools convert "%f" postgresql://postgres:postgres@127.0.0.1:55432/postgres
-cd ```
+```
+
+## License
 
-### Notes
+The code in this repository is licensed under the [EUPL-1.2-or-later](https://joinup.ec.europa.eu/collection/eupl)
 
-We set PGGSSENCMODE=disable and PGSSLMODE=disable at runtime to avoid Windows security and file locking issues in local development.
-This does not affect production deployments, which can use secure defaults.
+&copy; [XLeitstelle](https://xleitstelle.de), 2025
 

{xmas_app-0.9.0 → xmas_app-0.11.0}/README.md

@@ -85,7 +85,7 @@ pixi shell
 then run
 
 ```shell
-xplan-gui
+xmas-app
 ```
 
 ### Optional: batch import test data to the database using xplan-tools
@@ -104,9 +104,10 @@ done
 (on Windows:):
 ```cmd
 for %f in (*.gml) do xplan-tools convert "%f" postgresql://postgres:postgres@127.0.0.1:55432/postgres
-cd ```
+```
+
+## License
 
-### Notes
+The code in this repository is licensed under the [EUPL-1.2-or-later](https://joinup.ec.europa.eu/collection/eupl)
 
-We set PGGSSENCMODE=disable and PGSSLMODE=disable at runtime to avoid Windows security and file locking issues in local development.
-This does not affect production deployments, which can use secure defaults.
+© [XLeitstelle](https://xleitstelle.de), 2025

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

@@ -1,6 +1,6 @@
 [project]
 name = "xmas-app"
-version = "0.9.0"
+version = "0.11.0"
 description = "The XLeitstelle model-driven application schema app."
 authors = [{ name = "Tobias Kraft", email = "tobias.kraft@gv.hamburg.de" }]
 classifiers = [
@@ -15,6 +15,7 @@ license = "EUPL-1.2-or-later"
 license-files = ["LICENSE"]
 dependencies = [
     "pydantic-settings>=2.0,<3.0",
+    "pydantic-extra-types[semver]",
     "xplan-tools>=1.10.3",
     "nicegui>=2.20,<3.0",
     # "uvicorn[standard]>=0.29,<0.31"
@@ -25,7 +26,7 @@ requires-python = ">=3.11,<3.14"
 
 [project.urls]
 Homepage = "https://gitlab.opencode.de/xleitstelle/xmas-app"
-Issues = "https://gitlab.opencode.de/xleitstelle/xplanung/xmas-app/-/issues"
+Issues = "https://gitlab.opencode.de/xleitstelle/xmas-app/-/issues"
 
 [project.scripts]
 xmas-app = "xmas_app.main:run_server"
@@ -51,6 +52,21 @@ libgdal-core = ">=3.9.1,<4"
 python = { version = "3.11.*", build = "*_cpython*" }
 openssl = "3.3.*"
 
+[tool.pixi.tasks.release]
+args = [
+    { "arg" = "version", "default" = "minor" }
+]
+cmd = """
+pixi workspace version {{version}}
+&& pixi lock
+&& git add pyproject.toml pixi.lock
+&& git commit -m "bump to $(pixi workspace version get)"
+&& git tag $(pixi workspace version get)
+&& git push
+&& git push --tags
+&& pixi workspace version get
+"""
+
 [dependency-groups]
 dev = ["pre-commit>=4", "ruff>=0.8"]
 build = ["poetry>=2.0.0"]

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.9.0 → xmas_app-0.11.0}/xmas_app/form.py

@@ -710,7 +710,9 @@ class ModelForm:
                                             ui.select(
                                                 options,
                                                 label=prop_info["typename"],
-                                                on_change=self._set_stylesheetId_and_schriftinhalt,
+                                                on_change=self._set_stylesheetId_and_schriftinhalt
+                                                if self.editable
+                                                else None,
                                                 multiple=prop_info["list"],
                                                 clearable=prop_info["nullable"],
                                                 validation=None

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

@@ -1,21 +1,9 @@
-import os
-
-import pydantic
-import pydantic_core
-from nicegui.observables import ObservableSet
-from xplan_tools.util import get_geometry_type_from_wkt
-
-from xmas_app.schema import ErrorDetail, ErrorResponse, SplitPayload, SplitSuccess
-from xmas_app.split_service import PlanSplitService, SplitValidationError
-
-os.environ["PGGSSENCMODE"] = "disable"
-os.environ["PGSSLMODE"] = "disable"
-
 import asyncio
 import importlib
 import inspect
 import io
 import logging
+import os
 import re
 from contextlib import asynccontextmanager
 from functools import partial
@@ -24,10 +12,30 @@ from tempfile import NamedTemporaryFile
 from typing import Any, Literal
 from uuid import uuid4
 
+import pydantic
+import pydantic_core
+from nicegui.observables import ObservableSet
 from pydantic import ValidationError
 from starlette.applications import Starlette
+from xplan_tools.util import get_geometry_type_from_wkt
 
-log_dir = Path(__file__).parent / "logs"
+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
+
+
+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"
 
@@ -43,20 +51,7 @@ if not logger.handlers:
     logger.addHandler(fh)
     logger.debug(f"Writing logs to {log_file}")
 
-
-# ui.timer(
-#     1.0,
-#     lambda: (
-#         print("bindings:", len(binding.bindings)),
-#         print("a. links:", len(binding.active_links)),
-#         print("b. props:", len(binding.bindable_properties)),
-#         print(
-#             "c. link elements:", "\n".join([str(link) for link in binding.active_links])
-#         ),
-#     ),
-# )
-
-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
@@ -133,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:
@@ -157,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,
@@ -170,7 +167,7 @@ async def plan_tree(
             tree.update()
 
     app.storage.client["user_agent"] = request.headers.get("user-agent", None)
-    qgis = app.storage.client["user_agent"] == "QGIS XGeoStd Plugin"
+    qgis = app.storage.client["user_agent"].startswith(settings.qgis_plugin_name)
     if qgis:
         ui.add_head_html('<script src="qrc:///qtwebchannel/qwebchannel.js"></script>')
 
@@ -244,23 +241,17 @@ async def plan_tree(
                     if feature.get_geom_wkt():
                         ui.button("Zum Feature springen").on(
                             "click",
-                            lambda e, origin=origin, target=target: highlight_feature(
-                                e, str(origin), str(target)
-                            ),
+                            lambda e, target=target: highlight_feature(e, str(target)),
                         )
 
                     ui.button("Feature selektieren").on(
                         "click",
-                        lambda e, origin=origin, target=target: select_feature(
-                            e, str(origin), str(target)
-                        ),
+                        lambda e, target=target: select_feature(e, str(target)),
                     )
 
                     ui.button("Attributformular öffnen").on(
                         "click",
-                        lambda e, origin=origin, target=target: show_attribute_form(
-                            e, str(origin), str(target)
-                        ),
+                        lambda e, target=target: show_attribute_form(e, str(target)),
                     )
 
                     # ui.button(
@@ -308,12 +299,12 @@ async def plan_tree(
                 return
             action_dialog.open()
 
-    async def highlight_feature(e: ClickEventArguments, origin: str, target: str):
+    async def highlight_feature(e: ClickEventArguments, target: str):
         logger.debug("highlight_feature called")
         try:
             logger.info("Sending highlight_feature to QWebChannel handler")
             ui.run_javascript(f"""new QWebChannel(qt.webChannelTransport, function (channel) {{
-                                        channel.objects.handler.highlight_feature("{origin}", "{target}")
+                                        channel.objects.handler.highlight_feature("{target}")
                                 }});""")
         except Exception as ex:
             logger.error(
@@ -322,12 +313,12 @@ async def plan_tree(
         finally:
             e.sender.props(remove="loading")
 
-    async def show_attribute_form(e: ClickEventArguments, origin: str, target: str):
+    async def show_attribute_form(e: ClickEventArguments, target: str):
         logger.debug("show_attribute_form called")
         try:
             logger.info("Sending show_attribute_form to QWebChannel handler")
             ui.run_javascript(f"""new QWebChannel(qt.webChannelTransport, function (channel) {{
-                                        channel.objects.handler.show_attribute_form("{origin}", "{target}")
+                                        channel.objects.handler.show_attribute_form("{target}")
                                 }});""")
         except Exception as ex:
             logger.error(
@@ -336,12 +327,12 @@ async def plan_tree(
         finally:
             e.sender.props(remove="loading")
 
-    async def select_feature(e: ClickEventArguments, origin: str, target: str):
+    async def select_feature(e: ClickEventArguments, target: str):
         logger.debug("highlight_feature called")
         try:
             logger.info("Sending select_feature to QWebChannel handler")
             ui.run_javascript(f"""new QWebChannel(qt.webChannelTransport, function (channel) {{
-                                        channel.objects.handler.select_feature("{origin}", "{target}")
+                                        channel.objects.handler.select_feature("{target}")
                                 }});""")
         except Exception as ex:
             logger.error(f"Exception while select_feature called: {ex}", exc_info=True)
@@ -397,7 +388,7 @@ async def plan_tree(
         nodes,
         on_select=show_menu,
         tick_strategy=None,
-    ).props("accordion")
+    ).props("accordion no-transition")
 
     notification.spinner = False
     notification.type = "positive"
@@ -410,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,
@@ -434,7 +425,7 @@ async def plans(
     ui.dropdown_button.default_props("flat square no-caps")
     ui.select.default_props("square filled dense")
     app.storage.client["user_agent"] = request.headers.get("user-agent", None)
-    qgis = app.storage.client["user_agent"] == "QGIS XGeoStd Plugin"
+    qgis = app.storage.client["user_agent"].startswith(settings.qgis_plugin_name)
     if qgis:
         ui.add_head_html('<script src="qrc:///qtwebchannel/qwebchannel.js"></script>')
 
@@ -733,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,
@@ -865,7 +856,7 @@ async def feature(
     app.storage.client["parent_id"] = parentId
     app.storage.client["user_agent"] = request.headers.get("user-agent", None)
 
-    qgis = app.storage.client["user_agent"] == "QGIS XGeoStd Plugin"
+    qgis = app.storage.client["user_agent"].startswith(settings.qgis_plugin_name)
 
     ui.colors(
         # primary=f"{'#f0f0f0' if qgis else 'rgb(157 157 156)'}",
@@ -964,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,
@@ -1059,7 +1050,7 @@ def get_associations(
 
     app.storage.client["user_agent"] = request.headers.get("user-agent", None)
 
-    qgis = app.storage.client["user_agent"] == "QGIS XGeoStd Plugin"
+    qgis = app.storage.client["user_agent"].startswith(settings.qgis_plugin_name)
 
     feature_data = {}
 
@@ -1146,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={
@@ -1167,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.9.0 → xmas_app-0.11.0}/xmas_app/settings.py

@@ -2,7 +2,9 @@ import os
 from typing import Any, Dict, List, Literal, Optional, TypedDict
 
 from pydantic import HttpUrl
+from pydantic_extra_types.semver import _VersionPydanticAnnotation
 from pydantic_settings import BaseSettings, SettingsConfigDict
+from semver import Version
 from xplan_tools.interface.db import DBRepository
 
 
@@ -52,6 +54,8 @@ class Settings(BaseSettings):
     codelist_repo: HttpUrl = HttpUrl(
         "https://registry.gdi-de.org/codelist/de.xleitstelle.xplanung"
     )
+    qgis_plugin_name: str = "XMAS-Plugin"
+    qgis_plugin_min_version: _VersionPydanticAnnotation = Version(major=0, minor=10)
 
     model_config = SettingsConfigDict(env_file=".env", env_file_encoding="utf-8")