mirror of
https://github.com/ARUP-CAS/aiscr-qgis-amcr-viewer.git
synced 2026-10-11 13:27:33 +02:00
Compare commits
17
Commits
v2.1.4
...
6e95973296
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
6e95973296 | ||
|
|
05e62bd23c | ||
|
|
7c0401c11b | ||
|
|
b7090b7549 | ||
|
|
74090a80c6 | ||
|
|
e5b0716fd6 | ||
|
|
2c5146aa34 | ||
|
|
3d58168ac9 | ||
|
|
1a1ae606c6 | ||
|
|
25ba50b889 | ||
|
|
72f5985f89 | ||
|
|
5117247fb7 | ||
|
|
d14b2854f7 | ||
|
|
222fe03bb8 | ||
|
|
236907b9df | ||
|
|
49fbd91cea | ||
|
|
62d9ebd6f0 |
No files matched your search
@@ -0,0 +1,24 @@
|
||||
# Jednotné kódování a konce řádků napříč editory.
|
||||
# Vzor: aiscr-management (quality_baseline/foundations/editorconfig.ini)
|
||||
root = true
|
||||
|
||||
[*]
|
||||
charset = utf-8
|
||||
end_of_line = lf
|
||||
insert_final_newline = true
|
||||
trim_trailing_whitespace = true
|
||||
|
||||
# Zdrojáky bez BOM – pyqgis4-checker na BOM spadne (viz AGENTS.md)
|
||||
[*.py]
|
||||
indent_style = space
|
||||
indent_size = 4
|
||||
|
||||
[*.md]
|
||||
trim_trailing_whitespace = false
|
||||
|
||||
# Heslář zapisuje plugin s BOM a CRLF (kvůli Excelu) – needitovat ručně
|
||||
[amcr_viewer/codelists/heslar.csv]
|
||||
charset = utf-8-bom
|
||||
end_of_line = crlf
|
||||
insert_final_newline = unset
|
||||
trim_trailing_whitespace = unset
|
||||
@@ -0,0 +1,10 @@
|
||||
# Textové soubory v repozitáři s LF; vzor: aiscr-management
|
||||
# (quality_baseline/foundations/gitattributes.fragment)
|
||||
* text=auto eol=lf
|
||||
|
||||
# Heslář generuje plugin (BOM + CRLF kvůli Excelu) – ukládat bajt po bajtu
|
||||
amcr_viewer/codelists/heslar.csv -text
|
||||
|
||||
# Binární soubory
|
||||
*.png binary
|
||||
*.zip binary
|
||||
@@ -0,0 +1,16 @@
|
||||
# Dependabot hlídá jen GitHub Actions: akce jsou ve workflow připnuté
|
||||
# na SHA s komentářem verze a Dependabot umí obojí povýšit naráz.
|
||||
# Plugin nemá pip/npm manifest a verze nástrojů (ruff, flake8 …) se
|
||||
# v workflow drží napevno vědomě – viz AGENTS.md.
|
||||
# Vzor: aiscr-management/.github/dependabot.yml
|
||||
|
||||
version: 2
|
||||
updates:
|
||||
- package-ecosystem: "github-actions"
|
||||
directory: "/"
|
||||
schedule:
|
||||
interval: "weekly"
|
||||
open-pull-requests-limit: 5
|
||||
target-branch: main
|
||||
commit-message:
|
||||
prefix: "ci"
|
||||
@@ -28,6 +28,7 @@ env:
|
||||
DETECT_SECRETS: detect-secrets==1.5.0
|
||||
FLAKE8: flake8==7.3.0
|
||||
RUFF: ruff==0.16.5
|
||||
OPENSPEC: 1.14.0
|
||||
|
||||
jobs:
|
||||
# --------------------------------------------------------------------
|
||||
@@ -39,7 +40,7 @@ jobs:
|
||||
|
||||
steps:
|
||||
- name: Checkout code
|
||||
uses: actions/checkout@df4cb1c069e1874edd31b4311f1884172cec0e10 # v6.0.3
|
||||
uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
|
||||
|
||||
- name: Set up Python
|
||||
uses: actions/setup-python@5fda3b95a4ea91299a34e894583c3862153e4b97 # v7.0.0
|
||||
@@ -92,7 +93,7 @@ jobs:
|
||||
|
||||
steps:
|
||||
- name: Checkout code
|
||||
uses: actions/checkout@df4cb1c069e1874edd31b4311f1884172cec0e10 # v6.0.3
|
||||
uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
|
||||
|
||||
# Pozor: skript končí kódem 0 i když něco najde, výsledek je jen
|
||||
# v logu. Prázdný log (samotná hlavička) znamená čisto.
|
||||
@@ -110,6 +111,24 @@ jobs:
|
||||
exit 1
|
||||
fi
|
||||
|
||||
# --------------------------------------------------------------------
|
||||
# OpenSpec – artefakty změn v openspec/ musí projít validací
|
||||
# --------------------------------------------------------------------
|
||||
openspec:
|
||||
name: OpenSpec
|
||||
runs-on: ubuntu-latest
|
||||
|
||||
steps:
|
||||
- name: Checkout code
|
||||
uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
|
||||
|
||||
# Verze CLI napevno – formát validace se mezi verzemi mění.
|
||||
# Node je v ubuntu-latest předinstalovaný.
|
||||
- name: openspec validate
|
||||
run: |
|
||||
npx --yes @fission-ai/openspec@${{ env.OPENSPEC }} \
|
||||
validate --all --strict --no-interactive
|
||||
|
||||
# --------------------------------------------------------------------
|
||||
# 3. Načtení pluginu ve skutečném QGIS, v obou podporovaných verzích
|
||||
# --------------------------------------------------------------------
|
||||
@@ -125,7 +144,7 @@ jobs:
|
||||
|
||||
steps:
|
||||
- name: Checkout code
|
||||
uses: actions/checkout@df4cb1c069e1874edd31b4311f1884172cec0e10 # v6.0.3
|
||||
uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
|
||||
|
||||
- name: Smoke test
|
||||
run: |
|
||||
@@ -142,7 +161,7 @@ jobs:
|
||||
|
||||
steps:
|
||||
- name: Checkout code
|
||||
uses: actions/checkout@df4cb1c069e1874edd31b4311f1884172cec0e10 # v6.0.3
|
||||
uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
|
||||
|
||||
- name: Zip plugin
|
||||
run: zip -r amcr_viewer.zip amcr_viewer -x "*.git*"
|
||||
|
||||
@@ -22,7 +22,7 @@ jobs:
|
||||
steps:
|
||||
# 1. Stáhne kód z tagu, který běh spustil
|
||||
- name: Checkout code
|
||||
uses: actions/checkout@df4cb1c069e1874edd31b4311f1884172cec0e10 # v6.0.3
|
||||
uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
|
||||
|
||||
# 2. Vytvoří ZIP (předpokládá, že kód je ve složce 'amcr_viewer')
|
||||
- name: Zip Plugin
|
||||
@@ -34,7 +34,7 @@ jobs:
|
||||
# 3. Založí koncept releasu i s přílohou
|
||||
# Tagy s pomlčkou (v2.0.0-alpha.1) se označí jako pre-release.
|
||||
- name: Create draft release with asset
|
||||
uses: softprops/action-gh-release@b4309332981a82ec1c5618f44dd2e27cc8bfbfda # v3.0.0
|
||||
uses: softprops/action-gh-release@efb35369e0ad2afab669f228072c1b0d510eae64 # v3.0.3
|
||||
with:
|
||||
files: amcr_viewer.zip
|
||||
draft: true
|
||||
|
||||
@@ -0,0 +1,41 @@
|
||||
name: Release PR Checks
|
||||
|
||||
# Hlídá bump verze a changelog v okamžiku, kdy se release větev
|
||||
# version/vX.Y.Z slévá do main – tady poprvé jde skutečně o to, co se
|
||||
# vydá, a zapomenutý bump by se jinak dostal rovnou k tagu a releasu.
|
||||
#
|
||||
# Kontroly viz tests/check_version_bump.py: verze v metadata.txt musí jít
|
||||
# nahoru, první položka changelogu musí patřit nové verzi, CITATION.cff
|
||||
# musí mít stejnou verzi (a posunuté date-released) a název větve musí
|
||||
# odpovídat verzi, kterou nese.
|
||||
|
||||
on:
|
||||
pull_request:
|
||||
branches:
|
||||
- main
|
||||
|
||||
permissions:
|
||||
contents: read
|
||||
|
||||
jobs:
|
||||
version-bump:
|
||||
name: Kontrola verze a changelogu
|
||||
runs-on: ubuntu-latest
|
||||
if: startsWith(github.head_ref, 'version/')
|
||||
|
||||
steps:
|
||||
- name: Checkout code
|
||||
uses: actions/checkout@df4cb1c069e1874edd31b4311f1884172cec0e10 # v6.0.3
|
||||
with:
|
||||
fetch-depth: 0
|
||||
|
||||
- name: Set up Python
|
||||
uses: actions/setup-python@5fda3b95a4ea91299a34e894583c3862153e4b97 # v7.0.0
|
||||
with:
|
||||
python-version: '3.12'
|
||||
|
||||
- name: Verze a changelog
|
||||
run: |
|
||||
python3 tests/check_version_bump.py \
|
||||
"${{ github.event.pull_request.base.sha }}" \
|
||||
"${{ github.head_ref }}"
|
||||
@@ -17,9 +17,36 @@ Zdroj dat: https://digiarchiv.aiscr.cz/ · Nápověda: https://amcr-help.aiscr.c
|
||||
Tento repozitář je jedním ze **sourozeneckých repozitářů** ekosystému AIS CR.
|
||||
Centrální governance a AI konfigurace spravuje hub **`aiscr-management`**; konvence
|
||||
v tomto souboru jsou s tímto vzorem sladěné a zjednodušené pro potřeby jednoho
|
||||
QGIS pluginu. Těžkou mašinerii hubu (složka `.agents/`, OpenSpec, sync skripty,
|
||||
multi-assistant generování) tento repozitář **záměrně nepřebírá**. Při širších
|
||||
otázkách governance má přednost vzor z `aiscr-management`.
|
||||
QGIS pluginu. Z hubu přebírá **OpenSpec** ve stupni `change-tracked` (viz
|
||||
níže). Ostatní mašinerii hubu (složka `.agents/`, sync skripty, vlastní
|
||||
schémata OpenSpec, multi-assistant generování) tento repozitář **záměrně
|
||||
nepřebírá**. Při širších otázkách governance má přednost vzor
|
||||
z `aiscr-management`.
|
||||
|
||||
## OpenSpec
|
||||
|
||||
Repozitář používá OpenSpec ve stupni **`change-tracked`**: plánovací
|
||||
artefakty změn (`proposal.md`, delta spec, `design.md`, `tasks.md`) žijí
|
||||
v `openspec/changes/<slug>/`, trvalé specifikace v `openspec/specs/` se
|
||||
**neudržují**. Stupeň a kontext pro agenty jsou v `openspec/config.yaml`;
|
||||
změna stupně se dělá vědomě společně s hubem, ne v rámci rozpracované práce.
|
||||
|
||||
- **Kdy založit změnu:** práce, která mění chování (co uživatel vidí,
|
||||
atributy vrstev, kontrakt s API digiarchivu, uložená nastavení), zasahuje
|
||||
víc repozitářů nebo mění pravidla / AI konfiguraci / CI.
|
||||
- **Kdy ne:** překlepy a formátování, bump závislostí či pinů nástrojů bez
|
||||
změny chování, přegenerování odvozených souborů.
|
||||
- **Postup:** `openspec new change <slug>` → artefakty → `openspec validate
|
||||
<slug> --strict` → implementace (až na výslovný pokyn) → po merge
|
||||
`openspec archive <slug> --skip-specs` (archiv
|
||||
`openspec/changes/archive/RRRR-MM-DD-<slug>/`).
|
||||
- Artefakty změny jdou **ve stejném PR** jako implementace; v popisu PR
|
||||
odkaž na adresář změny.
|
||||
- Používá se vestavěné schéma `spec-driven`; vlastní schémata hubu se sem
|
||||
nepřenášejí. CLI: `npx @fission-ai/openspec@1.14.0` (nebo lokálně
|
||||
nainstalované `openspec`); bez CLI lze artefakty psát i ručně.
|
||||
- Asistentské povrchy (`.claude/`, `.github/prompts/` …) doručuje sync
|
||||
z hubu; v tomto repozitáři se ručně nezakládají ani necommitují.
|
||||
|
||||
## Struktura repozitáře
|
||||
|
||||
@@ -33,7 +60,8 @@ amcr_viewer/ # vlastní kód pluginu (toto se balí do releasu)
|
||||
metadata.txt # metadata pluginu + verze + changelog
|
||||
i18n/ # překlady (.ts)
|
||||
*.png # ikony
|
||||
.github/workflows/ # CI – release pluginu
|
||||
.github/workflows/ # CI – kontroly kvality a release pluginu
|
||||
openspec/ # OpenSpec – konfigurace a plánovací artefakty změn
|
||||
README.md # uživatelská dokumentace (anglicky)
|
||||
```
|
||||
|
||||
@@ -163,6 +191,7 @@ flatpak run --command=sh org.qgis.qgis -c \
|
||||
- PR musí mířit do správné `version/v2.x.y` větve.
|
||||
- Před požádáním o review projdi kontrolní seznam v šabloně (zejména bump verze
|
||||
v `metadata.txt`, pokud měníš chování).
|
||||
- Mění-li PR chování, obsahuje i odpovídající změnu v `openspec/changes/`.
|
||||
- V popisu PR uveď **podíl AI** (např. „text navržen AI, ručně zkontrolováno")
|
||||
a odkaz na související issue, pokud existuje.
|
||||
|
||||
|
||||
+1
-1
@@ -25,5 +25,5 @@ abstract: >-
|
||||
the Digital archive of the Archaeological Map of the
|
||||
Czech Republic (https://digiarchiv.aiscr.cz/).
|
||||
license: GPL-3.0
|
||||
version: '2.1.4'
|
||||
version: '2.2.0'
|
||||
date-released: '2026-10-01'
|
||||
@@ -106,12 +106,16 @@ to see.
|
||||
* They are then saved encrypted in the **QGIS Authentication Manager** (DPAPI
|
||||
on Windows, Keychain on macOS, encrypted SQLite on Linux). QGIS will ask for
|
||||
its master password.
|
||||
* Stored credentials are reused across QGIS sessions. If the session cookie
|
||||
expires mid-download, the plugin re-authenticates automatically and repeats
|
||||
the request.
|
||||
* Stored credentials are reused across QGIS sessions. The plugin checks
|
||||
the login state before every download (via the `islogged` endpoint)
|
||||
and, when the session cookie has expired, re-authenticates
|
||||
automatically. If re-authentication is not possible, a warning in the
|
||||
message bar says the download runs anonymously (access level A only);
|
||||
a failed check never blocks the download.
|
||||
* Reopening the login dialog lets you change the e-mail (leave the password
|
||||
blank to keep the stored one) or remove the credentials entirely
|
||||
(*Odebrat uložené přihlašovací údaje*).
|
||||
(*Odebrat uložené přihlašovací údaje*). Removing them also logs you out
|
||||
of the Digital Archive, so the next download runs anonymously.
|
||||
|
||||
### 3.3 The filter dialog
|
||||
|
||||
@@ -138,11 +142,11 @@ restriction". Click *Vybrat…* to open a searchable, checkable list.
|
||||
| Lokalita – typ | — | ✓ | — | `f_typ_lokality` |
|
||||
| Lokalita – druh | — | ✓ | — | `f_druh_lokality` |
|
||||
| Lokalita – jistota určení | — | ✓ | — | `f_jistota` |
|
||||
| Lokalita - stav dochování | — | ✓ | — | `f_lokalita_zachovalost` |
|
||||
| Lokalita – stav dochování | — | ✓ | — | `f_lokalita_zachovalost` |
|
||||
| Období | ✓ | ✓ | ✓ | `f_obdobi` |
|
||||
| Kategorie nálezu | — | — | ✓ | `f_kategorie` |
|
||||
| Druh nálezu | — | — | ✓ | `f_druh_nalezu` |
|
||||
| Specifikace nálezu | — | — | ✓ | `f_specifikace` |
|
||||
| Materiál | — | — | ✓ | `f_specifikace` |
|
||||
| Okolnosti nálezu | — | — | ✓ | `f_nalezove_okolnosti` |
|
||||
| Nálezce | — | — | ✓ | `f_nalezce` |
|
||||
| Datum nálezu | — | — | ✓ | `samostatny_nalez_datum_nalezu` |
|
||||
@@ -294,6 +298,7 @@ order *common → entity-specific → `pristupnost` → component fields*.
|
||||
| `komponenta` | Komponenta | Component identifier. |
|
||||
| `komponenta_areal` | Areál | Activity area \[settlement / burial area / field / …\]. |
|
||||
| `komponenta_obdobi` | Období | Period \[Neolithic / High Middle Ages–Modern Period / …\]. |
|
||||
| `prvek_vaha` | Váha prvku | Feature weight: 1/*n*, where *n* is the number of features created from the same documentation unit after the period/area filters, so the weights of one documentation unit sum to 1. |
|
||||
|
||||
### 3.5 When a query returns nothing
|
||||
|
||||
@@ -347,6 +352,8 @@ AGENTS.md contributor and AI-agent guidelines
|
||||
| Purpose | Endpoint | Notes |
|
||||
| --- | --- | --- |
|
||||
| Login | `POST https://digiarchiv.aiscr.cz/api/user/login` | Returns a session cookie. Errors arrive with HTTP 200 and an `error` key. |
|
||||
| Logout | `GET https://digiarchiv.aiscr.cz/api/user/logout` | Called when the stored credentials are removed. |
|
||||
| Login state | `GET https://digiarchiv.aiscr.cz/api/user/islogged` | `{"remaining": <s>}` when logged in, `{"error":"nologged"}` otherwise; checked before each download. |
|
||||
| Search | `GET https://digiarchiv.aiscr.cz/api/search/query` | `entity=akce\|lokalita\|samostatny_nalez\|pian`, `mapa=true`, paginated. |
|
||||
| Translations | `GET https://digiarchiv.aiscr.cz/api/assets/i18n/cs.json` | Code → Czech label; cached in memory for the session. |
|
||||
| Codelists | `GET https://api.aiscr.cz/2.2/oai` | OAI-PMH `ListRecords`, with resumption tokens. |
|
||||
|
||||
@@ -343,7 +343,7 @@ class AmcrFilterDialog(QDialog):
|
||||
layout.addWidget(self.picker_jistota)
|
||||
|
||||
self.picker_lokalita_zachovalost = self.setup_picker(
|
||||
"Lokalita - stav dochování",
|
||||
"Lokalita – stav dochování",
|
||||
'lokalita_zachovalost',
|
||||
LOKALITA_ZACHOVALOST
|
||||
)
|
||||
@@ -370,7 +370,7 @@ class AmcrFilterDialog(QDialog):
|
||||
layout.addWidget(self.picker_druh_nalezu)
|
||||
|
||||
self.picker_specifikace = self.setup_picker(
|
||||
"Specifikace nálezu",
|
||||
"Materiál",
|
||||
'specifikace',
|
||||
SPECIFIKACE
|
||||
)
|
||||
@@ -1033,6 +1033,10 @@ class LoginDialog(QDialog):
|
||||
self.accept()
|
||||
|
||||
def _forget_credentials(self):
|
||||
# Lazy import to avoid an import cycle
|
||||
# (amcr_tools imports LoginDialog lazily as well)
|
||||
from . import amcr_tools
|
||||
|
||||
settings = QSettings()
|
||||
existing_id = settings.value(self.SETTINGS_KEY, "")
|
||||
if existing_id:
|
||||
@@ -1040,11 +1044,17 @@ class LoginDialog(QDialog):
|
||||
existing_id
|
||||
)
|
||||
settings.remove(self.SETTINGS_KEY)
|
||||
QMessageBox.information(
|
||||
self,
|
||||
"Hotovo",
|
||||
"Uložené přihlašovací údaje byly odebrány."
|
||||
)
|
||||
|
||||
# Without credentials the session in memory would otherwise stay
|
||||
# logged in until QGIS is restarted
|
||||
if amcr_tools.logout_from_api():
|
||||
zprava = ("Uložené přihlašovací údaje byly odebrány "
|
||||
"a uživatel byl odhlášen.")
|
||||
else:
|
||||
zprava = ("Uložené přihlašovací údaje byly odebrány. Server "
|
||||
"se nepodařilo kontaktovat, další stahování ale "
|
||||
"proběhne anonymně.")
|
||||
QMessageBox.information(self, "Hotovo", zprava)
|
||||
self.reject()
|
||||
|
||||
# ------------------------------------------------------------------
|
||||
|
||||
+208
-31
@@ -157,6 +157,125 @@ def _get_session() -> requests.Session | None:
|
||||
return AMCR_SESSION
|
||||
|
||||
|
||||
def logout_from_api() -> bool:
|
||||
"""
|
||||
Logs the current session out on the server (GET /api/user/logout)
|
||||
and drops it from memory, so the next download runs anonymously
|
||||
(or logs in again only if credentials are stored).
|
||||
The local session is dropped even when the server cannot be
|
||||
reached. Returns True when the server confirmed the logout or there
|
||||
was no session at all.
|
||||
"""
|
||||
global AMCR_SESSION
|
||||
session = AMCR_SESSION
|
||||
AMCR_SESSION = None
|
||||
if session is None:
|
||||
return True
|
||||
|
||||
url = "https://digiarchiv.aiscr.cz/api/user/logout"
|
||||
try:
|
||||
response = session.get(url, timeout=10)
|
||||
response.raise_for_status()
|
||||
except requests.exceptions.RequestException as e:
|
||||
_log(f"Odhlášení na serveru se nezdařilo: {e} – session "
|
||||
"zahozena jen lokálně.", Qgis.MessageLevel.Warning)
|
||||
return False
|
||||
_log("Uživatel odhlášen.")
|
||||
return True
|
||||
|
||||
|
||||
def _check_islogged(session) -> bool | None:
|
||||
"""
|
||||
Asks the server whether the session is logged in
|
||||
(GET /api/user/islogged; the check does not extend the session).
|
||||
Returns True when logged in, False when the server reports
|
||||
'nologged', or None when the check itself failed (network error,
|
||||
invalid JSON) or the response has an unknown shape.
|
||||
"""
|
||||
url = "https://digiarchiv.aiscr.cz/api/user/islogged"
|
||||
try:
|
||||
body = session.get(url, timeout=10).json()
|
||||
except (requests.exceptions.RequestException, ValueError) as e:
|
||||
_log(f"Stav přihlášení se nepodařilo ověřit: {e}",
|
||||
Qgis.MessageLevel.Warning)
|
||||
return None
|
||||
|
||||
if not isinstance(body, dict):
|
||||
_log("Neznámý formát odpovědi islogged – pokračuji dál.",
|
||||
Qgis.MessageLevel.Warning)
|
||||
return None
|
||||
if "remaining" in body:
|
||||
# Only the remaining seconds are logged, never a user profile
|
||||
_log(f"Session je přihlášená (zbývá {body['remaining']} s).")
|
||||
return True
|
||||
if body.get("error"):
|
||||
_log(f"Server session neuznává ({body['error']}).",
|
||||
Qgis.MessageLevel.Warning)
|
||||
return False
|
||||
_log("Neznámý formát odpovědi islogged – pokračuji dál.",
|
||||
Qgis.MessageLevel.Warning)
|
||||
return None
|
||||
|
||||
|
||||
def _ensure_logged_in() -> str:
|
||||
"""
|
||||
Verifies before a download that the user is logged in, whenever
|
||||
a session exists or credentials are stored; renews the session
|
||||
once when it has expired. Returns one of:
|
||||
|
||||
* "anonymous" – no session and no stored credentials (nothing
|
||||
to check, no request is sent)
|
||||
* "logged_in" – the current session is valid
|
||||
* "relogged" – the session had expired and was renewed
|
||||
* "fallback" – a login was expected but could not be established;
|
||||
the download will run anonymously
|
||||
* "unknown" – the check itself failed; the download proceeds
|
||||
with the current session
|
||||
"""
|
||||
global AMCR_SESSION
|
||||
|
||||
session = _get_session()
|
||||
if session is None:
|
||||
# _get_session() has already tried the stored credentials;
|
||||
# their presence therefore means the login failed
|
||||
from .amcr_dialog import LoginDialog
|
||||
username, password = LoginDialog.get_credentials()
|
||||
if username and password:
|
||||
_log("Přihlášení se nezdařilo – stahuji anonymně.",
|
||||
Qgis.MessageLevel.Warning)
|
||||
return "fallback"
|
||||
return "anonymous"
|
||||
|
||||
stav = _check_islogged(session)
|
||||
if stav is None:
|
||||
return "unknown"
|
||||
if stav:
|
||||
return "logged_in"
|
||||
|
||||
# The server no longer accepts the session – drop it and try
|
||||
# one re-login with the stored credentials
|
||||
AMCR_SESSION = None
|
||||
from .amcr_dialog import LoginDialog
|
||||
username, password = LoginDialog.get_credentials()
|
||||
if not (username and password):
|
||||
_log("Session vypršela a přihlašovací údaje nejsou uloženy "
|
||||
"– stahuji anonymně.", Qgis.MessageLevel.Warning)
|
||||
return "fallback"
|
||||
|
||||
session = login_to_api(username, password)
|
||||
if session is None:
|
||||
return "fallback"
|
||||
|
||||
stav = _check_islogged(session)
|
||||
if stav is None:
|
||||
return "unknown"
|
||||
if stav:
|
||||
return "relogged"
|
||||
_log("Nová session nebyla serverem uznána – stahuji anonymně.",
|
||||
Qgis.MessageLevel.Warning)
|
||||
return "fallback"
|
||||
|
||||
|
||||
def _api_get_json(url, params, timeout=30) -> dict:
|
||||
"""
|
||||
Performs a GET request and returns the parsed JSON body.
|
||||
@@ -168,7 +287,13 @@ def _api_get_json(url, params, timeout=30) -> dict:
|
||||
|
||||
def _is_auth_error(resp: requests.Response, body) -> bool:
|
||||
"""The API returns auth errors with status 200 –
|
||||
the body must be checked."""
|
||||
the body must be checked.
|
||||
|
||||
Fallback only: the current server signals an expired session
|
||||
by silently answering as anonymous (HTTP 200, no 'error'), so
|
||||
this check never triggers on expiry today – the login state is
|
||||
verified upfront by _ensure_logged_in() instead. Kept for the
|
||||
day the API starts returning 401 or an explicit error text."""
|
||||
if resp.status_code == 401:
|
||||
return True
|
||||
if not isinstance(body, dict):
|
||||
@@ -261,6 +386,49 @@ def tr_code(code):
|
||||
return TRANSLATIONS.get(code, code)
|
||||
|
||||
|
||||
def _component_entries(dj_meta, komps, passes):
|
||||
"""
|
||||
Builds the feature metadata entries of the "Načíst komponenty"
|
||||
mode: one entry per component that passes the given predicate,
|
||||
with the weight 1/n where n is the number of passing components,
|
||||
so the weights of one documentation unit sum to 1 even when a
|
||||
period/area filter removes some of them. A documentation unit
|
||||
without components gets a single entry with empty component
|
||||
fields and weight 1.
|
||||
|
||||
dj_meta: metadata shared by the documentation unit (spread into
|
||||
every entry); komps: its component documents; passes: predicate
|
||||
komp -> bool deciding whether a component becomes a feature.
|
||||
"""
|
||||
if not komps:
|
||||
# DJ without components – still one feature, weight 1
|
||||
return [{
|
||||
**dj_meta,
|
||||
'komponenta_id': "",
|
||||
'komponenta_areal': "",
|
||||
'komponenta_obdobi': "",
|
||||
'vaha': 1,
|
||||
}]
|
||||
|
||||
prochazejici = [komp for komp in komps if passes(komp)]
|
||||
vaha = 1 / len(prochazejici) if prochazejici else 1
|
||||
|
||||
return [
|
||||
{
|
||||
**dj_meta,
|
||||
'komponenta_id': komp.get('ident_cely', ""),
|
||||
'komponenta_areal': (
|
||||
komp.get('komponenta_areal') or {}
|
||||
).get('value', ""),
|
||||
'komponenta_obdobi': (
|
||||
komp.get('komponenta_obdobi') or {}
|
||||
).get('value', ""),
|
||||
'vaha': vaha,
|
||||
}
|
||||
for komp in prochazejici
|
||||
]
|
||||
|
||||
|
||||
def komp_projde_filtrem(komp, filter_areal, filter_datace, filters):
|
||||
# 'or {}' – the key may be present with a None value
|
||||
areal_id = (komp.get('komponenta_areal') or {}).get('id', "")
|
||||
@@ -292,6 +460,27 @@ def load_amcr_data(canvas, bb, filters=None,
|
||||
return
|
||||
_LOADING = True
|
||||
|
||||
# Login state is verified before the first query: an expired
|
||||
# session would otherwise silently degrade the result to
|
||||
# access level A without any error
|
||||
try:
|
||||
login_stav = _ensure_logged_in()
|
||||
except Exception as e:
|
||||
# The check must never block the download nor leave _LOADING
|
||||
# stuck – an unexpected error means "proceed as today"
|
||||
QgsMessageLog.logMessage(
|
||||
f"Ověření stavu přihlášení selhalo: {e}",
|
||||
"AMČR", Qgis.MessageLevel.Warning
|
||||
)
|
||||
login_stav = "unknown"
|
||||
if login_stav == "fallback":
|
||||
iface.messageBar().pushMessage(
|
||||
"AMCR",
|
||||
"Přihlášení se nepodařilo obnovit – stahování proběhne "
|
||||
"anonymně a bude obsahovat jen záznamy s přístupností A.",
|
||||
level=Qgis.MessageLevel.Warning
|
||||
)
|
||||
|
||||
load_translations()
|
||||
|
||||
# --- 1. COORDINATE TRANSFORMATION ---
|
||||
@@ -680,28 +869,16 @@ def load_amcr_data(canvas, bb, filters=None,
|
||||
# One feature per component –
|
||||
# all data on a single row, no relations needed
|
||||
if komps:
|
||||
for komp in komps:
|
||||
if not komp_projde_filtrem(
|
||||
komp, filter_areal,
|
||||
# The weight is 1/n of the components
|
||||
# that pass the period/area filter,
|
||||
# so one DJ sums to 1
|
||||
for komp_meta in _component_entries(
|
||||
dj_meta, komps,
|
||||
lambda k: komp_projde_filtrem(
|
||||
k, filter_areal,
|
||||
filter_datace, filters
|
||||
):
|
||||
continue
|
||||
|
||||
komp_meta = {
|
||||
**dj_meta,
|
||||
'komponenta_id': komp.get(
|
||||
'ident_cely',
|
||||
""
|
||||
),
|
||||
'komponenta_areal': (
|
||||
komp.get('komponenta_areal')
|
||||
or {}
|
||||
).get('value', ""),
|
||||
'komponenta_obdobi': (
|
||||
komp.get('komponenta_obdobi')
|
||||
or {}
|
||||
).get('value', ""),
|
||||
}
|
||||
)
|
||||
):
|
||||
pian_lookup[dj_pian_value].append(
|
||||
komp_meta)
|
||||
target_pian_ids_count += 1
|
||||
@@ -711,15 +888,12 @@ def load_amcr_data(canvas, bb, filters=None,
|
||||
if filter_areal or filter_datace:
|
||||
continue
|
||||
|
||||
empty_meta = {
|
||||
**dj_meta,
|
||||
'komponenta_id': "",
|
||||
'komponenta_areal': "",
|
||||
'komponenta_obdobi': "",
|
||||
}
|
||||
pian_lookup[dj_pian_value].append(
|
||||
empty_meta)
|
||||
target_pian_ids_count += 1
|
||||
for komp_meta in _component_entries(
|
||||
dj_meta, [], lambda k: True
|
||||
):
|
||||
pian_lookup[dj_pian_value].append(
|
||||
komp_meta)
|
||||
target_pian_ids_count += 1
|
||||
else:
|
||||
target_pian_ids_count += 1
|
||||
pian_lookup[dj_pian_value].append(dj_meta)
|
||||
@@ -1056,6 +1230,7 @@ def load_amcr_data(canvas, bb, filters=None,
|
||||
"poznamka": "Poznámka/bližší popis",
|
||||
"pred_org": "Předáno organizaci",
|
||||
"evidencni": "Evidenční číslo",
|
||||
"prvek_vaha": "Váha prvku",
|
||||
}
|
||||
|
||||
if komponenty == "true":
|
||||
@@ -1063,6 +1238,7 @@ def load_amcr_data(canvas, bb, filters=None,
|
||||
QgsField("komponenta", QMetaType.Type.QString),
|
||||
QgsField("komponenta_areal", QMetaType.Type.QString),
|
||||
QgsField("komponenta_obdobi", QMetaType.Type.QString),
|
||||
QgsField("prvek_vaha", QMetaType.Type.Double),
|
||||
]
|
||||
|
||||
for vl in layers:
|
||||
@@ -1209,6 +1385,7 @@ def load_amcr_data(canvas, bb, filters=None,
|
||||
meta.get('komponenta_id', ""),
|
||||
meta.get('komponenta_areal', ""),
|
||||
meta.get('komponenta_obdobi', ""),
|
||||
meta.get('vaha', 1),
|
||||
])
|
||||
|
||||
feat.setAttributes(atributy)
|
||||
|
||||
@@ -8,7 +8,7 @@ name=AMČR Viewer
|
||||
qgisMinimumVersion=3.44.0
|
||||
qgisMaximumVersion=4.99.0
|
||||
description=Viewing and downloading the AMČR data.
|
||||
version=2.1.4
|
||||
version=2.2.0
|
||||
author=David Spáčil
|
||||
email=spacil@arub.cz
|
||||
|
||||
@@ -23,7 +23,14 @@ repository=https://github.com/ARUP-CAS/aiscr-qgis-amcr-viewer
|
||||
hasProcessingProvider=no
|
||||
# Uncomment the following line and add your changelog:
|
||||
changelog=
|
||||
Plný seznam změn v češtině je dostupný zde: https://github.com/ARUP-CAS/aiscr-qgis-amcr-viewer/releases/tag/v2.1.1
|
||||
Plný seznam změn v češtině je dostupný zde: https://github.com/ARUP-CAS/aiscr-qgis-amcr-viewer/releases/tag/v2.2.0
|
||||
v2.2.0 (2026-09-02)
|
||||
* Filter labels unified: "Specifikace nálezu" renamed to "Materiál" to match the attribute alias
|
||||
* README rewritten to match the current state of the code
|
||||
* Tables for Akce and Lokality contain a field with feature weight, when Komponenty rendering is enabled; the weights of one documentation unit sum to 1 also with period/area filters
|
||||
* The login state is verified before each download via /api/user/islogged; an expired session is renewed automatically
|
||||
* When a logged-in download falls back to anonymous access, a message bar warning says so (only access level A data)
|
||||
* Removing the stored credentials also logs the user out of the Digital Archive
|
||||
v2.1.4 (2026-10-01)
|
||||
* Removed unused generated resources.py and the bundled flake8 config, so the plugin passes the plugins.qgis.org scan without custom configuration
|
||||
v2.1.3 (2026-10-01)
|
||||
|
||||
Whitespace-only changes.
@@ -0,0 +1,2 @@
|
||||
schema: spec-driven
|
||||
created: 2026-10-02
|
||||
@@ -0,0 +1,49 @@
|
||||
## Context
|
||||
|
||||
`load_amcr_data` in `amcr_viewer/amcr_tools.py` (section B) builds, for each
|
||||
DJ with a PIAN and *Načíst komponenty* on, one metadata dict per component
|
||||
and appends it to `pian_lookup[pian_id]`. The weight is set as
|
||||
`'vaha': 1/komps_count` with `komps_count = len(komps)` computed **before**
|
||||
the loop that skips components failing `komp_projde_filtrem`. The empty-DJ
|
||||
branch leaves `vaha` out and the feature builder falls back to
|
||||
`meta.get('vaha', 1)`.
|
||||
|
||||
## Goals / Non-Goals
|
||||
|
||||
**Goals:** weights of one DJ sum to 1 under any filter; the rule is
|
||||
testable offline.
|
||||
|
||||
**Non-Goals:** weighting across DJs or across records that share one PIAN
|
||||
(a PIAN shared by several DJs still yields several features – the weight
|
||||
only de-duplicates components of one DJ, as #55 asked); changing the layer
|
||||
schema.
|
||||
|
||||
## Decisions
|
||||
|
||||
1. **Filter first, then weigh.** Build the list of passing components, then
|
||||
set `vaha = 1/len(passing)`. Alternative – a second counting pass with
|
||||
`sum(komp_projde_filtrem(...))` – duplicates the filter call and drifts
|
||||
if the filter changes (#70 replaces it).
|
||||
2. **Extract a small pure helper** (e.g. `_component_entries(dj_meta, komps,
|
||||
passes)` returning the list of per-component dicts with `vaha`, where
|
||||
`passes` is a predicate) so the smoke test can check weights without
|
||||
QGIS layers or network. The helper must not depend on how components are
|
||||
selected, so #70 can pass a different predicate.
|
||||
3. **Explicit weight 1 for a DJ without components** instead of relying on
|
||||
the `meta.get('vaha', 1)` default – the default stays as a safety net.
|
||||
|
||||
## Risks / Trade-offs
|
||||
|
||||
- Floating-point: 1/3 weights sum to 0.999…; acceptable for analyses,
|
||||
test with a tolerance.
|
||||
- The helper extraction touches a long function; keep the diff limited to
|
||||
the component branch.
|
||||
|
||||
## Verification
|
||||
|
||||
- Smoke test cases: 4 components no filter → 4×0.25; filter keeps 1 of 4 →
|
||||
weight 1; keeps 2 of 3 → 2×0.5; no components → 1 entry, weight 1.
|
||||
- Full AGENTS.md check set (ltr + stable smoke test, pyqgis4-checker).
|
||||
- Manual QGIS test by the user: download akce with *Načíst komponenty* and
|
||||
a period filter, check in the attribute table that `prvek_vaha` sums to 1
|
||||
per `dj_id`.
|
||||
@@ -0,0 +1,42 @@
|
||||
## Why
|
||||
|
||||
Issue #55 added the `prvek_vaha` (feature weight) attribute: when *Načíst
|
||||
komponenty* is on, every component of a documentation unit (DJ) becomes its
|
||||
own feature on the same PIAN geometry, and the weight 1/*n* lets spatial
|
||||
analyses count the geometry once. The unreleased implementation on
|
||||
`version/v2.2.0` takes *n* from **all** components of the DJ, before the
|
||||
period/area filter. With a component filter active the weights of one DJ no
|
||||
longer sum to 1 (DJ with 4 components, 1 passes the Neolithic filter → one
|
||||
feature with weight 0.25 instead of 1), so weighted counts are wrong exactly
|
||||
when users filter. See the comment on #55.
|
||||
|
||||
## What Changes
|
||||
|
||||
- *n* in `prvek_vaha = 1/n` is the number of component features actually
|
||||
created for the DJ, i.e. components that pass the period/area filters.
|
||||
- The weights of all features created from one DJ sum to 1 with or without
|
||||
filters.
|
||||
- A DJ without components keeps its single feature with weight 1 (today the
|
||||
value comes from a default; it becomes explicit).
|
||||
- `README.md` documents `prvek_vaha` in the component fields table (it is
|
||||
missing there today).
|
||||
- Changelog entry under v2.2.0 in `amcr_viewer/metadata.txt` is extended
|
||||
(the feature is unreleased, no separate version bump).
|
||||
|
||||
## Capabilities
|
||||
|
||||
### New Capabilities
|
||||
- `component-features`: one feature per component of a fieldwork event or
|
||||
site, and the weight attribute that de-duplicates shared geometries.
|
||||
|
||||
### Modified Capabilities
|
||||
|
||||
## Impact
|
||||
|
||||
- `amcr_viewer/amcr_tools.py` – component feature creation in
|
||||
`load_amcr_data` (section B, attribute parsing).
|
||||
- `tests/smoke_test.py` – offline check of the weights.
|
||||
- `README.md`, `amcr_viewer/metadata.txt` (changelog only).
|
||||
- No change to the digiarchiv API contract, layer schema or stored settings.
|
||||
- `filter-components-via-component-endpoint` (#70) changes how components
|
||||
are selected; it builds on this change and must keep the weight rule.
|
||||
+35
@@ -0,0 +1,35 @@
|
||||
# Spec Delta
|
||||
|
||||
## Purpose
|
||||
|
||||
Describes how components of fieldwork events and sites become map features
|
||||
and how their weight lets spatial analyses count a shared geometry once.
|
||||
|
||||
## ADDED Requirements
|
||||
|
||||
### Requirement: Weight of component features sums to one per DJ
|
||||
When components are loaded as features, each feature SHALL carry the weight
|
||||
`prvek_vaha = 1/n`, where *n* is the number of features created from the
|
||||
same documentation unit in this download. Components excluded by the period
|
||||
or area filter SHALL NOT count towards *n*.
|
||||
|
||||
#### Scenario: No component filter
|
||||
- **WHEN** a documentation unit has 4 components and no period or area filter is set
|
||||
- **THEN** 4 features are created, each with weight 0.25
|
||||
|
||||
#### Scenario: Filter keeps some components
|
||||
- **WHEN** a documentation unit has 4 components and the period filter matches 1 of them
|
||||
- **THEN** 1 feature is created with weight 1
|
||||
|
||||
#### Scenario: Filter keeps two of three components
|
||||
- **WHEN** a documentation unit has 3 components and the filter matches 2 of them
|
||||
- **THEN** 2 features are created, each with weight 0.5, and their weights sum to 1
|
||||
|
||||
### Requirement: Documentation unit without components has weight one
|
||||
When components are loaded and a documentation unit has no component, the
|
||||
single feature created for it SHALL have weight 1 and empty component
|
||||
fields.
|
||||
|
||||
#### Scenario: DJ without components, no filter
|
||||
- **WHEN** a documentation unit with a PIAN has no components and no component filter is set
|
||||
- **THEN** one feature is created with empty component fields and weight 1
|
||||
@@ -0,0 +1,37 @@
|
||||
# Tasks
|
||||
|
||||
## 1. Weight computed from passing components
|
||||
|
||||
- [x] 1.1 In `amcr_viewer/amcr_tools.py` extract the per-component entry
|
||||
building of the *Načíst komponenty* branch into a pure helper that takes
|
||||
the DJ metadata, the component list and a pass predicate, filters first
|
||||
and sets `vaha = 1/len(passing)`; set `vaha = 1` explicitly for a DJ
|
||||
without components; verify with `python3 tests/check_sources.py`,
|
||||
`flake8 --isolated amcr_viewer/` and `ruff check .`
|
||||
- [x] 1.2 Extend `tests/smoke_test.py` with an offline case for the helper
|
||||
(4 components no filter → 4×0.25; 1 of 4 passes → 1.0; 2 of 3 pass →
|
||||
2×0.5, sum 1 within tolerance; no components → 1 entry, weight 1);
|
||||
verify the smoke test passes in `qgis/qgis:ltr` and `qgis/qgis:stable`
|
||||
|
||||
## 2. Documentation
|
||||
|
||||
- [x] 2.1 Add `prvek_vaha` (alias *Váha prvku*) to the component fields
|
||||
table in `README.md` with the rule "1/n, n = features created from the
|
||||
same documentation unit after filters"; verify by reading the rendered
|
||||
table
|
||||
- [x] 2.2 Extend the v2.2.0 changelog bullet about the feature weight in
|
||||
`amcr_viewer/metadata.txt` (weights of one documentation unit sum to 1
|
||||
also with period/area filters); no version bump – 2.2.0 is unreleased and
|
||||
`CITATION.cff` already says 2.2.0; verify both versions match
|
||||
|
||||
## 3. Verification
|
||||
|
||||
- [x] 3.1 Run the full local check set from `AGENTS.md` (check_sources,
|
||||
bandit, detect-secrets `--all-files`, flake8 `--isolated`, ruff,
|
||||
pyqgis4-checker log empty, smoke test ltr + stable); verify all clean
|
||||
- [x] 3.2 Manual test in QGIS (user): akce in a small window with *Načíst
|
||||
komponenty* and one period filter; verify in the attribute table that
|
||||
`prvek_vaha` sums to 1 per `dj_id`
|
||||
- Verified by the maintainer 2026-10-02: akce and lokality with
|
||||
*Načíst komponenty*, without and with a period filter – weights sum
|
||||
to 1 per DJ and are computed only from the filtered components
|
||||
@@ -0,0 +1,2 @@
|
||||
schema: spec-driven
|
||||
created: 2026-10-02
|
||||
@@ -0,0 +1,81 @@
|
||||
# Design
|
||||
|
||||
## Context
|
||||
|
||||
- The session lives only in memory (`amcr_tools.AMCR_SESSION`, a
|
||||
`requests.Session` with the `JSESSIONID` cookie). `_get_session()` logs in
|
||||
from stored credentials only when no session object exists, so after QGIS
|
||||
start the first download always logs in; an expired session object is
|
||||
reused forever.
|
||||
- All data requests of a download go through `_api_get_json()` (main query
|
||||
pages and PIAN batches). `_is_auth_error()` there reacts to HTTP 401 or
|
||||
error text – neither occurs on expiry (see proposal.md – Why).
|
||||
- Server behaviour (verified 2026-10-02, live API):
|
||||
`GET /api/user/islogged` → `{"remaining": <s>}` when logged in,
|
||||
`{"error": "nologged"}` otherwise, both HTTP 200. It does not extend the
|
||||
session; any `search/query` does.
|
||||
- Codelists (`amcr_codelists.py`) use plain `requests.get` without the
|
||||
session – unaffected by login state.
|
||||
|
||||
## Goals / Non-Goals
|
||||
|
||||
**Goals:**
|
||||
- One check at the start of `load_amcr_data`, before the first data request.
|
||||
- Reuse existing login code (`login_to_api`, `LoginDialog.get_credentials`).
|
||||
- Testable offline: the check takes its HTTP behaviour from the session
|
||||
object so the smoke test can inject a fake.
|
||||
|
||||
**Non-Goals:**
|
||||
- Checking before every page / PIAN batch (a download takes seconds to
|
||||
minutes and every data request renews the sliding timeout).
|
||||
- Refactoring session handling into a class.
|
||||
|
||||
## Decisions
|
||||
|
||||
1. **New helper `_ensure_logged_in() -> str`** in `amcr_tools.py`, returning
|
||||
one of `"anonymous"` (no session, no credentials – nothing to check),
|
||||
`"logged_in"`, `"relogged"`, `"fallback"` (expected login, ended
|
||||
anonymous), `"unknown"` (check failed, proceeding).
|
||||
Flow: get session via `_get_session()` (logs in if needed); if none and no
|
||||
credentials → `anonymous`; if none but credentials → login failed →
|
||||
`fallback`; otherwise call `islogged`; `remaining` → `logged_in`;
|
||||
`nologged` → drop session, re-login once, verify again → `relogged` or
|
||||
`fallback`; exception / non-JSON → `unknown`.
|
||||
*Alternative:* re-login unconditionally before each download – simpler,
|
||||
but one POST with the password per download and no way to distinguish a
|
||||
real failure; rejected.
|
||||
*Alternative:* compare `remaining` with a local timestamp of last request
|
||||
– fragile (server timeout may change); rejected.
|
||||
2. **Caller decides UI.** `load_amcr_data` pushes the message bar warning on
|
||||
`fallback`; the helper only logs (keeps it free of `iface` for the test).
|
||||
3. **Interpretation of the response:** logged in iff the body is a dict with
|
||||
key `remaining`. Anything else with an `error` key → not logged in. Unknown
|
||||
shape → `unknown` (do not trigger a re-login loop on a format change).
|
||||
4. **Keep `_is_auth_error`** as a fallback, with a comment that the current
|
||||
server never triggers it; removing it brings no benefit and it still
|
||||
covers a possible future 401.
|
||||
5. **Never log the response of `islogged?wantsUser=true`** – we do not use
|
||||
that parameter at all; only `remaining` (number) is logged.
|
||||
|
||||
6. **Logout on credential removal** – new `logout_from_api()` in
|
||||
`amcr_tools.py` called from `LoginDialog._forget_credentials`. The local
|
||||
session is dropped first and unconditionally; the server call is best
|
||||
effort (a failure is logged and reported in the dialog text). Without
|
||||
it, the in-memory session would keep downloading logged-in data until
|
||||
QGIS restarts even though the user believes he is "forgotten".
|
||||
|
||||
## Risks / Trade-offs
|
||||
|
||||
- [Extra request per download] → only for logged-in / credential users; cost
|
||||
~100 ms.
|
||||
- [Session expires during a very long download] → practically impossible:
|
||||
each page request renews the 1 h sliding timeout.
|
||||
- [Re-login prompts for the QGIS master password] → `get_credentials()` is
|
||||
already called on first download after start; behaviour unchanged.
|
||||
- [`islogged` endpoint changes shape] → `unknown`, logged warning, download
|
||||
proceeds as today (no regression).
|
||||
|
||||
## Migration Plan
|
||||
|
||||
Plain plugin update; no settings or data migration. Rollback = previous
|
||||
release.
|
||||
@@ -0,0 +1,59 @@
|
||||
# Proposal
|
||||
|
||||
## Why
|
||||
|
||||
Login to digiarchiv expires after 1 h of inactivity (`sessionTimeout: 3600`)
|
||||
and the server then silently treats the request as anonymous: HTTP 200, no
|
||||
`error`, only `pristupnost=A` data. The plugin detects expiry only by HTTP 401
|
||||
or error text, which never arrives, so a logged-in user who downloads again
|
||||
after a pause gets incomplete data without any warning (issue #72, verified
|
||||
manually in QGIS and against the live API).
|
||||
|
||||
## What Changes
|
||||
|
||||
- Before each download the plugin checks the login state with
|
||||
`GET /api/user/islogged` whenever the user is (or should be) logged in –
|
||||
i.e. an in-memory session exists or credentials are stored.
|
||||
- When the server answers `{"error": "nologged"}` and credentials are stored,
|
||||
the plugin logs in again and continues the download with the new session.
|
||||
- When the re-login fails (or credentials are missing), the plugin warns in
|
||||
the QGIS message bar that the download runs anonymously and returns only
|
||||
records with access level A – not only in the log.
|
||||
- Removing the stored credentials (*Odebrat uložené přihlašovací údaje*)
|
||||
also logs the session out on the server (`GET /api/user/logout`) and
|
||||
drops it from memory; today it stays logged in until QGIS restarts.
|
||||
- When the check itself cannot be completed (network error, invalid JSON),
|
||||
the download is not blocked; the plugin logs a warning and proceeds.
|
||||
- The existing error-text based detection (`_is_auth_error`) stays as
|
||||
a fallback; it is documented as not triggered by the current server.
|
||||
- Version bump + changelog (`metadata.txt`, `CITATION.cff`).
|
||||
|
||||
Out of scope:
|
||||
|
||||
- Keeping the session alive in the background (polling `islogged` does not
|
||||
extend it anyway).
|
||||
- Showing the user's access level in the UI (`islogged?wantsUser=true`).
|
||||
- Codelist updates: `amcr_codelists` calls the API with plain `requests`
|
||||
without the session, so login state does not affect them today.
|
||||
|
||||
## Capabilities
|
||||
|
||||
### New Capabilities
|
||||
|
||||
- `amcr-session`: login session against digiarchiv – validating the session
|
||||
before a download, transparent re-login and informing the user when data
|
||||
are downloaded anonymously.
|
||||
|
||||
### Modified Capabilities
|
||||
|
||||
<!-- none – openspec/specs/ is empty -->
|
||||
|
||||
## Impact
|
||||
|
||||
- Code: `amcr_viewer/amcr_dialog.py` (logout when credentials are
|
||||
removed); `amcr_viewer/amcr_tools.py` (logout helper, new login-state check, call at the start
|
||||
of `load_amcr_data`, message bar warning); `tests/smoke_test.py` (offline
|
||||
test of the check with a mocked HTTP session).
|
||||
- API: one extra `GET /api/user/islogged` per download, only when the user is
|
||||
logged in or has stored credentials; anonymous users are unaffected.
|
||||
- No new dependencies; Qt5/Qt6 compatibility rules from `AGENTS.md` apply.
|
||||
+70
@@ -0,0 +1,70 @@
|
||||
# Spec Delta
|
||||
|
||||
## Purpose
|
||||
|
||||
Keeps a logged-in user's data downloads from digiarchiv running under a valid
|
||||
login, and makes it visible when a download falls back to anonymous access.
|
||||
|
||||
## ADDED Requirements
|
||||
|
||||
### Requirement: Login state is verified before a download
|
||||
Before starting a data download, the plugin SHALL ask the server whether the
|
||||
current session is logged in, whenever an in-memory session exists or login
|
||||
credentials are stored. Users with neither SHALL download anonymously without
|
||||
this check.
|
||||
|
||||
#### Scenario: Valid session
|
||||
- **WHEN** a session exists and the server reports it as logged in
|
||||
- **THEN** the download proceeds with that session and no re-login happens
|
||||
|
||||
#### Scenario: Anonymous user without stored credentials
|
||||
- **WHEN** no session exists and no credentials are stored
|
||||
- **THEN** no login-state request is sent and the download proceeds anonymously without a warning
|
||||
|
||||
### Requirement: Expired login is renewed transparently
|
||||
When the server reports the session as not logged in and credentials are
|
||||
stored, the plugin SHALL log in again and run the whole download with the new
|
||||
session.
|
||||
|
||||
#### Scenario: Session expired after inactivity
|
||||
- **WHEN** the user downloads data more than one hour after the previous download within the same QGIS run
|
||||
- **THEN** the plugin logs in again with the stored credentials and the download returns the same records as for a fresh login
|
||||
|
||||
#### Scenario: No session yet, credentials stored
|
||||
- **WHEN** the first download after QGIS start is requested and credentials are stored
|
||||
- **THEN** the plugin logs in and verifies that the new session is logged in before downloading
|
||||
|
||||
### Requirement: Anonymous fallback is reported to the user
|
||||
When the plugin expected to be logged in but cannot obtain a logged-in
|
||||
session, it SHALL show a warning in the QGIS message bar stating that the
|
||||
download runs anonymously and contains only records with access level A.
|
||||
|
||||
#### Scenario: Re-login fails
|
||||
- **WHEN** the session has expired and logging in again with stored credentials fails
|
||||
- **THEN** a warning appears in the message bar and the download continues anonymously
|
||||
|
||||
#### Scenario: Session expired and credentials removed
|
||||
- **WHEN** an in-memory session has expired and no credentials are stored any more
|
||||
- **THEN** a warning appears in the message bar and the download continues anonymously
|
||||
|
||||
### Requirement: Failed state check does not block the download
|
||||
If the login-state check cannot be completed (network error or a response
|
||||
that is not valid JSON), the plugin SHALL log a warning and proceed with the
|
||||
download using the current session.
|
||||
|
||||
#### Scenario: Login-state endpoint unreachable
|
||||
- **WHEN** the login-state request fails with a network error
|
||||
- **THEN** a warning is written to the log and the download is attempted as usual
|
||||
|
||||
### Requirement: Removing stored credentials logs the user out
|
||||
When the user removes the stored credentials, the plugin SHALL log the
|
||||
current session out on the server and discard it, so that later downloads
|
||||
run anonymously without restarting QGIS.
|
||||
|
||||
#### Scenario: Credentials removed while logged in
|
||||
- **WHEN** the user removes the stored credentials while a logged-in session exists
|
||||
- **THEN** the session is logged out on the server and the next download is anonymous without a warning
|
||||
|
||||
#### Scenario: Server unreachable during logout
|
||||
- **WHEN** the logout request fails with a network error
|
||||
- **THEN** the session is still discarded locally and the user is told the next download will be anonymous
|
||||
@@ -0,0 +1,53 @@
|
||||
# Tasks
|
||||
|
||||
## 1. Login-state check
|
||||
|
||||
- [x] 1.1 Add `_ensure_logged_in()` to `amcr_viewer/amcr_tools.py` per
|
||||
design.md (statuses `anonymous` / `logged_in` / `relogged` / `fallback` /
|
||||
`unknown`, `GET /api/user/islogged` with the current session, one re-login
|
||||
on `nologged`); verify with `python3 tests/check_sources.py` and
|
||||
`ruff check .`
|
||||
- [x] 1.2 Add a comment to `_is_auth_error` that the current server never
|
||||
returns such an error on expiry and the check is kept as a fallback;
|
||||
verify by reading the diff
|
||||
- [x] 1.3 Extend `tests/smoke_test.py` with offline cases using a fake
|
||||
session object (valid session, `nologged` + successful re-login,
|
||||
`nologged` + failed re-login, no credentials, network error); verify the
|
||||
smoke test passes in `qgis/qgis:ltr` and `qgis/qgis:stable`
|
||||
|
||||
## 2. Integration into the download
|
||||
|
||||
- [x] 2.1 Call `_ensure_logged_in()` in `load_amcr_data` after the
|
||||
re-entrancy guard, before the first query; on `fallback` push a message
|
||||
bar warning (Czech, scoped `Qgis.MessageLevel.Warning`) that the download
|
||||
runs anonymously and contains only access level A; verify by smoke test
|
||||
and code review
|
||||
- [x] 2.2 Live check without credentials: anonymous download path sends no
|
||||
`islogged` request and a made-up `JSESSIONID` yields `nologged`
|
||||
(curl / probe script in scratch); verify outputs recorded in the PR
|
||||
- [x] 2.3 Update `README.md` if it describes login/session behaviour; verify
|
||||
the text matches the new behaviour (or note that nothing needed changing)
|
||||
|
||||
## 2b. Logout when credentials are removed
|
||||
|
||||
- [x] 2b.1 Add `logout_from_api()` to `amcr_tools.py` and call it from
|
||||
`LoginDialog._forget_credentials`; extend the smoke test (session
|
||||
logged out + dropped, network error still drops it, no session = no
|
||||
request); update README and changelog; verify smoke test ltr + stable
|
||||
- [x] 2b.2 Manual test in QGIS: log in, download, remove the stored
|
||||
credentials, download again; verify the log shows "Uživatel odhlášen"
|
||||
and the count drops to the anonymous one
|
||||
|
||||
## 3. Release preparation and verification
|
||||
|
||||
- [x] 3.1 Add changelog entries under v2.2.0 in `amcr_viewer/metadata.txt`
|
||||
(the fix ships with 2.2.0; `CITATION.cff` already says 2.2.0 and
|
||||
`date-released` moves on release day); verify both versions match
|
||||
- [x] 3.2 Run the full local check set from `AGENTS.md` (check_sources,
|
||||
bandit, detect-secrets `--all-files`, flake8 `--isolated`, ruff,
|
||||
pyqgis4-checker log empty, smoke test ltr + stable); verify all clean
|
||||
- [x] 3.3 Manual test in QGIS with a researcher account: download SN for
|
||||
whole CZ, simulate expiry in the Python console with
|
||||
`amcr_tools.AMCR_SESSION.get("https://digiarchiv.aiscr.cz/api/user/logout")`,
|
||||
download again; verify log shows re-login and the count matches the
|
||||
logged-in count (not the anonymous one)
|
||||
@@ -0,0 +1,65 @@
|
||||
schema: spec-driven
|
||||
|
||||
# Seeded from aiscr-management
|
||||
# .agents/canonical_configs/templates/openspec/config_seed.yaml;
|
||||
# from now on the content is owned by this repository.
|
||||
|
||||
context: |
|
||||
Repository: aiscr-qgis-amcr-viewer — QGIS plugin (AMČR Viewer) for
|
||||
downloading and visualising data from the AMČR Digital Archive
|
||||
(digiarchiv.aiscr.cz).
|
||||
|
||||
OpenSpec posture: change-tracked.
|
||||
This is the local reading of a posture declared and owned by the
|
||||
management hub (aiscr-management, .agents/sync/repos.toml):
|
||||
- change-tracked — change-scoped planning artifacts live under
|
||||
`openspec/changes/`; no durable capability specs are maintained here.
|
||||
Do not edit this line to unblock work in progress. Changing posture is
|
||||
a decision taken deliberately with the hub and then applied here.
|
||||
|
||||
When OpenSpec fires: behaviour-changing work (user-visible behaviour,
|
||||
layer attributes, the digiarchiv API contract the plugin relies on,
|
||||
stored settings), cross-repo work, and governance-touching work. Not
|
||||
typo and formatting fixes, dependency or tool-pin bumps that change no
|
||||
behaviour, or refreshing a generated surface from its source.
|
||||
|
||||
Repository conventions: `AGENTS.md` is the single source of truth
|
||||
(Qt5/Qt6 rules, versioning, branches, checks). Plugin code lives in
|
||||
`amcr_viewer/` (entry point `amcr_viewer.py`, API and layers in
|
||||
`amcr_tools.py`, dialogs in `amcr_dialog.py`, codelists in
|
||||
`amcr_codelists.py`). User documentation is `README.md` (English);
|
||||
planning artifacts, commits and PRs are in Czech or English as the
|
||||
author prefers, code and identifiers in English.
|
||||
|
||||
rules:
|
||||
proposal:
|
||||
- State what changes for a user of the plugin, not only in the code
|
||||
- Name the affected modules under amcr_viewer/ explicitly
|
||||
- Say when the change depends on or affects the digiarchiv API or
|
||||
another AIS CR repository, and where
|
||||
specs:
|
||||
- Use RFC 2119 keywords (SHALL/MUST/SHOULD/MAY)
|
||||
- Use Given/When/Then scenarios for testable contracts
|
||||
- Describe behaviour the plugin guarantees, not how the code does it
|
||||
design:
|
||||
- Record the alternatives considered and why the chosen one won
|
||||
- Respect the QGIS 3.44 minimum and Qt5/Qt6 rules from AGENTS.md
|
||||
- Name the verification that will show the change worked
|
||||
tasks:
|
||||
- Order tasks so each one is independently verifiable
|
||||
- Name the command or check that proves each group is done
|
||||
- Include the version bump (metadata.txt + CITATION.cff) when
|
||||
behaviour changes
|
||||
- Include a final verification task that runs the checks from
|
||||
AGENTS.md (check_sources, bandit, detect-secrets, flake8, ruff,
|
||||
pyqgis4-checker, smoke test in qgis/qgis:ltr and :stable)
|
||||
|
||||
operations:
|
||||
apply:
|
||||
guidance:
|
||||
- Completed artifacts are not approval to implement; wait for an
|
||||
explicit request to apply the change
|
||||
archive:
|
||||
guidance:
|
||||
- Posture is change-tracked, so archive with --skip-specs (no
|
||||
openspec/specs/ tree is maintained)
|
||||
@@ -0,0 +1,188 @@
|
||||
# -*- coding: utf-8 -*-
|
||||
"""
|
||||
Guards the release PR (version/vX.Y.Z -> main).
|
||||
|
||||
Checks that the version actually moved forward and that the three places
|
||||
that name it agree, because plugins.qgis.org and Zenodo both read from
|
||||
files a human has to remember to touch by hand:
|
||||
|
||||
* amcr_viewer/metadata.txt: version= must be higher than on main, and the
|
||||
first changelog entry must be for that exact version
|
||||
* CITATION.cff: version must match metadata.txt, and date-released must
|
||||
not be left pointing at the old release
|
||||
* the branch name (version/vX.Y.Z) must match metadata.txt, so a stray
|
||||
push to the wrong release branch is caught before merge
|
||||
|
||||
Run from the repository root:
|
||||
|
||||
python3 tests/check_version_bump.py <base_sha> <head_ref>
|
||||
"""
|
||||
|
||||
import datetime
|
||||
import re
|
||||
import subprocess
|
||||
import sys
|
||||
|
||||
METADATA = "amcr_viewer/metadata.txt"
|
||||
CITATION = "CITATION.cff"
|
||||
|
||||
VERZE_METADATA = re.compile(r"^version=(.+)$", re.MULTILINE)
|
||||
VERZE_CITATION = re.compile(r"^version:\s*'?([^'\n]+)'?\s*$", re.MULTILINE)
|
||||
DATUM_CITATION = re.compile(r"^date-released:\s*'?([^'\n]+)'?\s*$",
|
||||
re.MULTILINE)
|
||||
# Přeskočí úvodní řádek "Plný seznam změn ... /vX.Y.Z" a najde první
|
||||
# skutečnou položku changelogu.
|
||||
POLOZKA_CHANGELOGU = re.compile(r"^\s+v([0-9][^\s(]*)\s*\(", re.MULTILINE)
|
||||
BRANCH_VERZE = re.compile(r"^version/v(.+)$")
|
||||
|
||||
nalezy = []
|
||||
|
||||
|
||||
def nacti_na_base(base_sha, cesta):
|
||||
vysledek = subprocess.run(
|
||||
["git", "show", f"{base_sha}:{cesta}"],
|
||||
capture_output=True, text=True,
|
||||
)
|
||||
if vysledek.returncode != 0:
|
||||
nalezy.append(f"{cesta}: na cílové větvi nejde přečíst "
|
||||
f"(git show {base_sha}:{cesta} selhalo)")
|
||||
return None
|
||||
return vysledek.stdout
|
||||
|
||||
|
||||
def nacti(cesta):
|
||||
with open(cesta, encoding="utf-8") as f:
|
||||
return f.read()
|
||||
|
||||
|
||||
def hledej(vzor, text, cesta, popis):
|
||||
shoda = vzor.search(text)
|
||||
if not shoda:
|
||||
nalezy.append(f"{cesta}: {popis} nenalezeno")
|
||||
return None
|
||||
return shoda.group(1).strip()
|
||||
|
||||
|
||||
def verze_tuple(verze):
|
||||
jadro = verze.split("-", 1)[0]
|
||||
try:
|
||||
return tuple(int(c) for c in jadro.split("."))
|
||||
except ValueError:
|
||||
return None
|
||||
|
||||
|
||||
def je_bump(stara, nova):
|
||||
if stara == nova:
|
||||
return False
|
||||
stara_t, nova_t = verze_tuple(stara), verze_tuple(nova)
|
||||
if stara_t is None or nova_t is None:
|
||||
# Nestandardní formát verze – nejde spolehlivě porovnat čísly,
|
||||
# stačí tedy, že se řetězec liší.
|
||||
return True
|
||||
if nova_t != stara_t:
|
||||
return nova_t > stara_t
|
||||
# Stejné jádro (např. "-alpha" přípona): bump platí, pokud se text
|
||||
# liší a nejde o couvnutí z release na prerelease.
|
||||
return "-" in stara or "-" not in nova
|
||||
|
||||
|
||||
def datum(text):
|
||||
try:
|
||||
return datetime.date.fromisoformat(text)
|
||||
except ValueError:
|
||||
return None
|
||||
|
||||
|
||||
def main():
|
||||
if len(sys.argv) != 3:
|
||||
print("použití: check_version_bump.py <base_sha> <head_ref>")
|
||||
return 2
|
||||
base_sha, head_ref = sys.argv[1], sys.argv[2]
|
||||
|
||||
base_metadata = nacti_na_base(base_sha, METADATA)
|
||||
base_citation = nacti_na_base(base_sha, CITATION)
|
||||
head_metadata = nacti(METADATA)
|
||||
head_citation = nacti(CITATION)
|
||||
|
||||
if base_metadata is None or base_citation is None:
|
||||
# Bez base souborů nejde nic dalšího smysluplně ověřit.
|
||||
print("Nálezy:")
|
||||
for nalez in nalezy:
|
||||
print(f" {nalez}")
|
||||
return 1
|
||||
|
||||
stara_verze = hledej(VERZE_METADATA, base_metadata, METADATA,
|
||||
"verze na cílové větvi (version=)")
|
||||
nova_verze = hledej(VERZE_METADATA, head_metadata, METADATA,
|
||||
"verze (version=)")
|
||||
stara_citation_verze = hledej(VERZE_CITATION, base_citation, CITATION,
|
||||
"verze na cílové větvi (version:)")
|
||||
nova_citation_verze = hledej(VERZE_CITATION, head_citation, CITATION,
|
||||
"verze (version:)")
|
||||
stare_datum = hledej(DATUM_CITATION, base_citation, CITATION,
|
||||
"date-released na cílové větvi")
|
||||
nove_datum = hledej(DATUM_CITATION, head_citation, CITATION,
|
||||
"date-released")
|
||||
|
||||
if None in (stara_verze, nova_verze, stara_citation_verze,
|
||||
nova_citation_verze, stare_datum, nove_datum):
|
||||
print("Nálezy:")
|
||||
for nalez in nalezy:
|
||||
print(f" {nalez}")
|
||||
return 1
|
||||
|
||||
# 1. metadata.txt: verze musí jít dopředu.
|
||||
if not je_bump(stara_verze, nova_verze):
|
||||
nalezy.append(
|
||||
f"{METADATA}: verze nepovýšena ({stara_verze} -> {nova_verze})")
|
||||
|
||||
# 2. metadata.txt: první položka changelogu musí patřit nové verzi.
|
||||
prvni_polozka = POLOZKA_CHANGELOGU.search(head_metadata)
|
||||
if not prvni_polozka:
|
||||
nalezy.append(f"{METADATA}: v changelog= nenalezena žádná položka "
|
||||
f"'vX.Y.Z (...)'")
|
||||
elif prvni_polozka.group(1) != nova_verze:
|
||||
nalezy.append(
|
||||
f"{METADATA}: první položka changelogu je pro "
|
||||
f"v{prvni_polozka.group(1)}, ale version={nova_verze}")
|
||||
|
||||
# 3. CITATION.cff: verze musí souhlasit s metadata.txt.
|
||||
if nova_citation_verze != nova_verze:
|
||||
nalezy.append(
|
||||
f"{CITATION}: version: {nova_citation_verze} neodpovídá "
|
||||
f"{METADATA} version={nova_verze}")
|
||||
|
||||
# 4. CITATION.cff: date-released se musí posunout, a ne dozadu.
|
||||
stary_datum_obj, novy_datum_obj = datum(stare_datum), datum(nove_datum)
|
||||
if stary_datum_obj is None or novy_datum_obj is None:
|
||||
nalezy.append(f"{CITATION}: date-released není platné datum "
|
||||
f"ISO 8601 ({stare_datum!r} -> {nove_datum!r})")
|
||||
elif novy_datum_obj < stary_datum_obj:
|
||||
nalezy.append(
|
||||
f"{CITATION}: date-released couvlo ({stare_datum} -> "
|
||||
f"{nove_datum})")
|
||||
elif (nove_datum == stare_datum
|
||||
and stara_citation_verze != nova_citation_verze):
|
||||
nalezy.append(
|
||||
f"{CITATION}: version se změnila, ale date-released zůstalo "
|
||||
f"na {stare_datum}")
|
||||
|
||||
# 5. Název release větve musí odpovídat verzi, kterou nese.
|
||||
shoda_branch = BRANCH_VERZE.match(head_ref)
|
||||
if shoda_branch and shoda_branch.group(1) != nova_verze:
|
||||
nalezy.append(
|
||||
f"větev {head_ref!r} neodpovídá {METADATA} "
|
||||
f"version={nova_verze}")
|
||||
|
||||
if nalezy:
|
||||
print("Nálezy:")
|
||||
for nalez in nalezy:
|
||||
print(f" {nalez}")
|
||||
return 1
|
||||
print(f"Kontrola verze a changelogu: v{stara_verze} -> v{nova_verze}, "
|
||||
f"bez nálezů")
|
||||
return 0
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
sys.exit(main())
|
||||
@@ -19,6 +19,8 @@ import os
|
||||
import sys
|
||||
import traceback
|
||||
|
||||
import requests
|
||||
|
||||
# Offscreen, otherwise the dialogs need an X server
|
||||
os.environ.setdefault("QT_QPA_PLATFORM", "offscreen")
|
||||
|
||||
@@ -117,10 +119,254 @@ def filtr_datumu():
|
||||
return hodnota
|
||||
|
||||
|
||||
class FalesnaSession:
|
||||
"""Offline stand-in for requests.Session: returns canned JSON
|
||||
bodies for GET /api/user/islogged and counts the requests."""
|
||||
|
||||
def __init__(self, tela):
|
||||
# tela: a list of (body, exception) pairs – one per GET call,
|
||||
# consumed in order; None body means raise the exception
|
||||
self.tela = list(tela)
|
||||
self.get_volani = 0
|
||||
|
||||
def get(self, url, timeout=0):
|
||||
self.get_volani += 1
|
||||
polozka = self.tela.pop(0)
|
||||
# A bare dict is a plain body; (None, exception) means raise
|
||||
if isinstance(polozka, tuple):
|
||||
tela, vyjimka = polozka
|
||||
else:
|
||||
tela, vyjimka = polozka, None
|
||||
if tela is None and vyjimka is not None:
|
||||
raise vyjimka
|
||||
|
||||
class Odpoved:
|
||||
def __init__(self, tela):
|
||||
self.telo = tela
|
||||
self.text = str(tela)
|
||||
|
||||
def json(self):
|
||||
if isinstance(self.telo, Exception):
|
||||
raise self.telo
|
||||
return self.telo
|
||||
|
||||
return Odpoved(tela)
|
||||
|
||||
|
||||
def prihlasovaci_stav():
|
||||
"""
|
||||
_ensure_logged_in with a fake session and monkeypatched login /
|
||||
credentials / _get_session – everything stays offline.
|
||||
|
||||
Each case: (name, expected status, islogged bodies of the current
|
||||
session, islogged bodies after re-login, fake login result,
|
||||
stored credentials, expected number of islogged GETs).
|
||||
"""
|
||||
pripady = [
|
||||
# Valid session – no re-login, no extra request
|
||||
("platná session", "logged_in",
|
||||
[{"remaining": 3500}], [], None, ("", ""), 1),
|
||||
# nologged + successful re-login, verified again
|
||||
("expired + re-login", "relogged",
|
||||
[{"error": "nologged"}], [{"remaining": 1800}],
|
||||
"session", ("uzivatel", "heslo"), 1),
|
||||
# nologged + failed re-login
|
||||
("expired + selhaný re-login", "fallback",
|
||||
[{"error": "nologged"}], [], None, ("uzivatel", "heslo"), 1),
|
||||
# nologged + no stored credentials
|
||||
("expired bez údajů", "fallback",
|
||||
[{"error": "nologged"}], [], None, ("", ""), 1),
|
||||
# No session and no credentials – no request at all
|
||||
("anonym bez údajů", "anonymous",
|
||||
[], [], None, ("", ""), 0),
|
||||
# Network error during the check
|
||||
("chyba sítě", "unknown",
|
||||
[(None, requests.exceptions.ConnectionError("probe"))],
|
||||
[], None, ("", ""), 1),
|
||||
# 200 but invalid JSON
|
||||
("neplatný JSON", "unknown",
|
||||
[(None, ValueError("Invalid JSON"))],
|
||||
[], None, ("", ""), 1),
|
||||
]
|
||||
|
||||
tools = amcr_viewer.amcr_tools
|
||||
puvodni = (tools.login_to_api, tools._get_session,
|
||||
dialog.LoginDialog.__dict__["get_credentials"])
|
||||
try:
|
||||
return _prihlasovaci_stav(pripady, tools)
|
||||
finally:
|
||||
# Leave the modules as they were found, even when a case fails
|
||||
(tools.login_to_api, tools._get_session,
|
||||
dialog.LoginDialog.get_credentials) = puvodni
|
||||
tools.AMCR_SESSION = None
|
||||
|
||||
|
||||
def _prihlasovaci_stav(pripady, tools):
|
||||
"""Runs the cases of prihlasovaci_stav()."""
|
||||
vysledky = []
|
||||
for (nazev, ocekavano, tela, tela_po_loginu, login_vysledek,
|
||||
kredity, get_volani) in pripady:
|
||||
|
||||
# The current session (None = _get_session returns None);
|
||||
# a successful fake re-login produces a new fake session
|
||||
session = FalesnaSession(tela) if tela else None
|
||||
login_hodnota = FalesnaSession(tela_po_loginu) \
|
||||
if login_vysledek else None
|
||||
|
||||
tools.AMCR_SESSION = session
|
||||
|
||||
def fake_login(hodnota):
|
||||
# Like the real login_to_api: stores the session globally
|
||||
def login(uzivatel, heslo):
|
||||
if hodnota is not None:
|
||||
tools.AMCR_SESSION = hodnota
|
||||
return hodnota
|
||||
return login
|
||||
|
||||
tools.login_to_api = fake_login(login_hodnota)
|
||||
tools._get_session = (lambda s: lambda: s)(session) \
|
||||
if session else (lambda: None)
|
||||
dialog.LoginDialog.get_credentials = staticmethod(
|
||||
(lambda k: lambda: k)(kredity)
|
||||
)
|
||||
|
||||
stav = tools._ensure_logged_in()
|
||||
assert stav == ocekavano, f"{nazev}: {stav} != {ocekavano}"
|
||||
|
||||
# The old session object must have been used for the checks
|
||||
if session is not None:
|
||||
assert session.get_volani == get_volani, \
|
||||
f"{nazev}: {session.get_volani} != {get_volani}"
|
||||
|
||||
# The returned fake login session must become the global one
|
||||
# and its login state must have been verified as well
|
||||
if ocekavano == "relogged":
|
||||
assert login_hodnota is not None
|
||||
assert tools.AMCR_SESSION is login_hodnota
|
||||
assert login_hodnota.get_volani == 1, \
|
||||
f"{nazev}: nová session nebyla ověřena"
|
||||
|
||||
vysledky.append(f"{nazev} → {stav}")
|
||||
|
||||
return ", ".join(vysledky)
|
||||
|
||||
|
||||
def odhlaseni():
|
||||
"""logout_from_api with a fake session – offline."""
|
||||
tools = amcr_viewer.amcr_tools
|
||||
puvodni = tools.AMCR_SESSION
|
||||
try:
|
||||
# Logged-in session: one GET to /logout, session dropped
|
||||
session = FalesnaSession([{"msg": "logged out"}])
|
||||
session_get = session.get
|
||||
urls = []
|
||||
|
||||
def get(url, timeout=0):
|
||||
urls.append(url)
|
||||
odpoved = session_get(url, timeout)
|
||||
odpoved.raise_for_status = lambda: None
|
||||
return odpoved
|
||||
|
||||
session.get = get
|
||||
tools.AMCR_SESSION = session
|
||||
assert tools.logout_from_api() is True
|
||||
assert tools.AMCR_SESSION is None
|
||||
assert urls and urls[0].endswith("/api/user/logout"), urls
|
||||
|
||||
# Network error: session still dropped locally
|
||||
chyba = FalesnaSession(
|
||||
[(None, requests.exceptions.ConnectionError("probe"))]
|
||||
)
|
||||
tools.AMCR_SESSION = chyba
|
||||
assert tools.logout_from_api() is False
|
||||
assert tools.AMCR_SESSION is None
|
||||
assert chyba.get_volani == 1
|
||||
|
||||
# No session: nothing to do, no request
|
||||
assert tools.logout_from_api() is True
|
||||
finally:
|
||||
tools.AMCR_SESSION = puvodni
|
||||
return "odhlášení, chyba sítě → zahozeno lokálně, bez session → nic"
|
||||
|
||||
|
||||
def vaha_komponent():
|
||||
"""
|
||||
_component_entries: the weight is 1/n of the components that pass
|
||||
the predicate, so the weights of one documentation unit sum to 1
|
||||
even with a period/area filter active.
|
||||
|
||||
The cases come from the spec of the fix (issue #55); the sums are
|
||||
compared with a tolerance because 1/3 weights add up to 0.999…
|
||||
"""
|
||||
tools = amcr_viewer.amcr_tools
|
||||
|
||||
def komponenta(ident, areal=None, obdobi=None):
|
||||
return {
|
||||
"ident_cely": ident,
|
||||
"komponenta_areal": ({"id": areal} if areal else None),
|
||||
"komponenta_obdobi": ({"id": obdobi} if obdobi else None),
|
||||
}
|
||||
|
||||
dj_meta = {"dj_id": "X-M-000001"}
|
||||
|
||||
# 4 components, no filter: 4 features, each 0.25
|
||||
komps = [komponenta(f"K{i}") for i in range(4)]
|
||||
zaznamy = tools._component_entries(dj_meta, komps, lambda k: True)
|
||||
assert len(zaznamy) == 4, len(zaznamy)
|
||||
assert all(z["vaha"] == 0.25 for z in zaznamy), \
|
||||
[z["vaha"] for z in zaznamy]
|
||||
|
||||
# Period filter keeps 1 of 4: single feature with weight 1
|
||||
komps = [
|
||||
komponenta("K0", obdobi="neolit"),
|
||||
komponenta("K1"), komponenta("K2"), komponenta("K3"),
|
||||
]
|
||||
zaznamy = tools._component_entries(
|
||||
dj_meta, komps, lambda k: k["komponenta_obdobi"] is not None
|
||||
)
|
||||
assert len(zaznamy) == 1, len(zaznamy)
|
||||
assert zaznamy[0]["vaha"] == 1.0, zaznamy[0]["vaha"]
|
||||
|
||||
# Filter keeps 2 of 3: 2 features, each 0.5, sum 1 within tolerance
|
||||
komps = [
|
||||
komponenta("K0", obdobi="neolit"), komponenta("K1", obdobi="bronz"),
|
||||
komponenta("K2"),
|
||||
]
|
||||
zaznamy = tools._component_entries(
|
||||
dj_meta, komps, lambda k: k["komponenta_obdobi"] is not None
|
||||
)
|
||||
assert len(zaznamy) == 2, len(zaznamy)
|
||||
assert all(z["vaha"] == 0.5 for z in zaznamy), \
|
||||
[z["vaha"] for z in zaznamy]
|
||||
assert abs(sum(z["vaha"] for z in zaznamy) - 1) < 1e-9
|
||||
|
||||
# Sum with tolerance also for an indivisible split (1/3)
|
||||
komps = [komponenta(f"K{i}") for i in range(3)]
|
||||
zaznamy = tools._component_entries(dj_meta, komps, lambda k: True)
|
||||
assert abs(sum(z["vaha"] for z in zaznamy) - 1) < 1e-9
|
||||
|
||||
# No components: one entry with empty component fields, weight 1
|
||||
zaznamy = tools._component_entries(dj_meta, [], lambda k: True)
|
||||
assert len(zaznamy) == 1, zaznamy
|
||||
assert zaznamy[0]["vaha"] == 1, zaznamy[0]["vaha"]
|
||||
assert zaznamy[0]["komponenta_id"] == ""
|
||||
|
||||
# The shared DJ metadata and component fields travel along
|
||||
komps = [komponenta("K0", areal="sidelni", obdobi="neolit")]
|
||||
zaznamy = tools._component_entries(dj_meta, komps, lambda k: True)
|
||||
assert zaznamy[0]["dj_id"] == "X-M-000001"
|
||||
assert zaznamy[0]["komponenta_id"] == "K0"
|
||||
|
||||
return "4×0.25; 1/4 → 1.0; 2/3 → 2×0.5; prázdné → 1"
|
||||
|
||||
|
||||
zkouska("scoped enumy", enumy)
|
||||
zkouska("UpdateCodelistsTask", uloha)
|
||||
zkouska("filtrační dialogy", dialogy)
|
||||
zkouska("filtr podle data", filtr_datumu)
|
||||
zkouska("stav přihlášení", prihlasovaci_stav)
|
||||
zkouska("odhlášení", odhlaseni)
|
||||
zkouska("váha komponent", vaha_komponent)
|
||||
|
||||
qgs.exitQgis()
|
||||
|
||||
|
||||
Reference in new issue
Block a user