add plan documents

Author: nmaarnio

arho_feature_template/core/models.py

@@ -15,6 +15,8 @@
 from arho_feature_template.utils.misc_utils import LANGUAGE, get_layer_by_name, iface
 
 if TYPE_CHECKING:
+    from datetime import datetime
+
     from qgis.core import QgsFeature, QgsGeometry
 
 
@@ -255,7 +257,7 @@ def from_feature(cls, feature: QgsFeature) -> RegulationConfig:
             id=feature["id"],
             regulation_code=feature["value"],
             name=feature["name"][LANGUAGE],
-            description=feature["description"][LANGUAGE],
+            description=feature["description"][LANGUAGE] if feature["description"] else "",
             status=feature["status"],
             level=feature["level"],
             parent_id=feature["parent_id"],
@@ -370,5 +372,26 @@ class Plan:
     producers_plan_identifier: str | None = None
     organisation_id: str | None = None
     general_regulations: list[RegulationGroup] = field(default_factory=list)
+    documents: list[Document] = field(default_factory=list)
     geom: QgsGeometry | None = None
     id_: int | None = None
+
+
+@dataclass
+class Document:
+    name: str | None = None
+    url: str | None = None
+    type_of_document_id: str | None = None
+    decision: bool | None = None
+    # permanent_document_identifier: str | None = None
+    category_of_publicity_id: str | None = None
+    personal_data_content_id: str | None = None
+    retention_time_id: str | None = None
+    language_id: str | None = None
+    document_date: datetime | None = None
+    # exported_at: str | None = None
+    # exported_file_key:
+    confirmation_date: datetime | None = None
+    arrival_date: datetime | None = None
+    plan_id: int | None = None
+    id_: int | None = None

arho_feature_template/core/plan_manager.py

@@ -10,6 +10,7 @@
 
 from arho_feature_template.core.lambda_service import LambdaService
 from arho_feature_template.core.models import (
+    Document,
     FeatureTemplateLibrary,
     Plan,
     PlanFeature,
@@ -26,6 +27,7 @@
 from arho_feature_template.gui.tools.inspect_plan_features_tool import InspectPlanFeatures
 from arho_feature_template.project.layers.code_layers import PlanRegulationGroupTypeLayer, code_layers
 from arho_feature_template.project.layers.plan_layers import (
+    DocumentLayer,
     LandUseAreaLayer,
     LandUsePointLayer,
     LineLayer,
@@ -479,6 +481,11 @@ def save_plan(plan: Plan) -> QgsFeature:
             regulation_group_feature = save_regulation_group(regulation_group, plan_id)
             save_regulation_group_association(regulation_group_feature["id"], PlanLayer.name, plan_id)
 
+    # Save documents
+    for document in plan.documents:
+        document.plan_id = feature["id"]
+        save_document(document)
+
     return feature
 
 
@@ -587,3 +594,17 @@ def save_proposition(proposition: Proposition) -> QgsFeature:
     )
 
     return feature
+
+
+def save_document(document: Document) -> QgsFeature:
+    feature = DocumentLayer.feature_from_model(document)
+    layer = DocumentLayer.get_from_project()
+
+    _save_feature(
+        feature=feature,
+        layer=layer,
+        id_=document.id_,
+        edit_text="Asiakirjan lisäys" if document.id_ is None else "Asiakirjan muokkaus",
+    )
+
+    return feature

arho_feature_template/gui/components/code_combobox.py

@@ -83,7 +83,12 @@ def populate_from_code_layer(self, layer_type: type[AbstractCodeLayer]) -> None:
             items[code_feature["id"]] = item
 
             item.setText(0, code_feature["name"][LANGUAGE])
-            item.setToolTip(0, code_feature["description"][LANGUAGE])
+            item.setToolTip(
+                0,
+                code_feature["description"][LANGUAGE]
+                if code_feature["description"]
+                else code_feature["name"][LANGUAGE],
+            )
             item.setData(0, Qt.UserRole, code_feature["id"])
 
             if code_feature["value"] in layer_type.category_only_codes:

arho_feature_template/gui/components/plan_document_widget.py

@@ -0,0 +1,169 @@
+from __future__ import annotations
+
+from importlib import resources
+from typing import TYPE_CHECKING
+
+from qgis.core import QgsApplication
+from qgis.gui import QgsDateTimeEdit
+from qgis.PyQt import uic
+from qgis.PyQt.QtCore import Qt, pyqtSignal
+from qgis.PyQt.QtWidgets import QCheckBox, QFormLayout, QLabel, QMenu, QToolButton, QWidget
+
+from arho_feature_template.core.models import Document
+from arho_feature_template.project.layers.code_layers import (
+    CategoryOfPublicityLayer,
+    LanguageLayer,
+    PersonalDataContentLayer,
+    RetentionTimeLayer,
+    TypeOfDocumentLayer,
+)
+
+if TYPE_CHECKING:
+    from datetime import datetime
+
+    from qgis.PyQt.QtWidgets import QLineEdit, QPushButton
+
+    from arho_feature_template.gui.components.code_combobox import CodeComboBox, HierarchicalCodeComboBox
+
+
+ui_path = resources.files(__package__) / "plan_document_widget.ui"
+FormClass, _ = uic.loadUiType(ui_path)
+
+
+class DocumentWidget(QWidget, FormClass):  # type: ignore
+    """A widget representation of a plan document."""
+
+    delete_signal = pyqtSignal(QWidget)
+
+    def __init__(self, document: Document, parent=None):
+        super().__init__(parent)
+        self.setupUi(self)
+
+        # TYPES
+        self.name: QLineEdit
+        self.url: QLineEdit
+        self.url_label: QLabel
+        self.document_type: CodeComboBox
+        self.document_type_label: QLabel
+        self.publicity: CodeComboBox
+        self.publicity_label: QLabel
+        self.decision: QCheckBox
+        self.decision_label: QLabel
+        self.language: CodeComboBox
+        self.language_label: QLabel
+        self.retention_time: HierarchicalCodeComboBox
+        self.retention_time_label: QLabel
+        self.personal_data_content: CodeComboBox
+        self.personal_data_content_label: QLabel
+        self.document_date: QgsDateTimeEdit
+        self.document_date_label: QLabel
+
+        self.add_field_btn: QPushButton
+        self.del_btn: QPushButton
+        self.form_layout: QFormLayout
+        self.expand_hide_btn: QToolButton
+
+        # INIT
+        self.document = document
+
+        self.document_type.populate_from_code_layer(TypeOfDocumentLayer)
+        self.publicity.populate_from_code_layer(CategoryOfPublicityLayer)
+        self.language.populate_from_code_layer(LanguageLayer)
+        self.language.setCurrentIndex(1)
+        self.retention_time.populate_from_code_layer(RetentionTimeLayer)
+        self.personal_data_content.populate_from_code_layer(PersonalDataContentLayer)
+
+        # List of widgets for hiding / showing
+        self.widgets: list[tuple[QLabel, QWidget]] = [
+            (self.url_label, self.url),
+            (self.document_type_label, self.document_type),
+            (self.publicity_label, self.publicity),
+            (self.decision_label, self.decision),
+            (self.language_label, self.language),
+            (self.retention_time_label, self.retention_time),
+            (self.personal_data_content_label, self.personal_data_content),
+            (self.document_date_label, self.document_date),
+        ]
+        self.arrival_date_widget: QgsDateTimeEdit | None = None
+        self.confirmation_date_widget: QgsDateTimeEdit | None = None
+
+        add_field_menu = QMenu(self)
+        add_field_menu.addAction("Saapumispäivämäärä").triggered.connect(self._add_arrival_date)
+        add_field_menu.addAction("Vahvistuspäivämäärä").triggered.connect(self._add_confirmation_date)
+        self.add_field_btn.setMenu(add_field_menu)
+        self.add_field_btn.setIcon(QgsApplication.getThemeIcon("mActionAdd.svg"))
+        self.del_btn.setIcon(QgsApplication.getThemeIcon("mActionDeleteSelected.svg"))
+        self.del_btn.clicked.connect(lambda: self.delete_signal.emit(self))
+
+        self.expanded = True
+        self.expand_hide_btn.clicked.connect(self._on_expand_hide_btn_clicked)
+
+        # Set values from input Document model
+        self.name.setText(document.name)
+        self.url.setText(document.url)
+        self.document_type.set_value(document.type_of_document_id)
+        self.publicity.set_value(document.category_of_publicity_id)
+        self.decision.setChecked(document.decision is True)
+        if document.language_id:
+            self.language.set_value(document.language_id)
+        self.retention_time.set_value(document.retention_time_id)
+        self.personal_data_content.set_value(document.personal_data_content_id)
+        if document.arrival_date:
+            self._add_arrival_date(document.arrival_date)
+        if document.confirmation_date:
+            self._add_confirmation_date(document.confirmation_date)
+
+    def _add_widgets(self, label: QLabel, widget: QWidget):
+        self.form_layout.addRow(label, widget)
+        self.widgets.append((label, widget))
+        if not self.expanded:
+            self._on_expand_hide_btn_clicked()
+
+    def _add_arrival_date(self, default_value: datetime | None = None):
+        if not self.arrival_date_widget:
+            self.arrival_date_widget = QgsDateTimeEdit()
+            self.arrival_date_widget.setDisplayFormat("d.M.yyyy")
+            if default_value:
+                self.arrival_date_widget.setDateTime(default_value)
+            self._add_widgets(QLabel("Saapumispäivämäärä"), self.arrival_date_widget)
+
+    def _add_confirmation_date(self, default_value: datetime | None = None):
+        if not self.confirmation_date_widget:
+            self.confirmation_date_widget = QgsDateTimeEdit()
+            self.confirmation_date_widget.setDisplayFormat("d.M.yyyy")
+            if default_value:
+                self.confirmation_date_widget.setDateTime(default_value)
+            self._add_widgets(QLabel("Vahvistuspäivämäärä"), self.confirmation_date_widget)
+
+    def _on_expand_hide_btn_clicked(self):
+        if self.expanded:
+            for label, value_widget in self.widgets:
+                self.form_layout.removeWidget(label)
+                label.hide()
+                self.form_layout.removeWidget(value_widget)
+                value_widget.hide()
+            self.expand_hide_btn.setArrowType(Qt.ArrowType.DownArrow)
+            self.expanded = False
+        else:
+            for label, value_widget in self.widgets:
+                self.form_layout.addRow(label, value_widget)
+                label.show()
+                value_widget.show()
+            self.expand_hide_btn.setArrowType(Qt.ArrowType.UpArrow)
+            self.expanded = True
+
+    def into_model(self) -> Document:
+        return Document(
+            name=self.name.text(),
+            url=self.url.text(),
+            type_of_document_id=self.document_type.value(),
+            decision=self.decision.isChecked(),
+            category_of_publicity_id=self.publicity.value(),
+            personal_data_content_id=self.personal_data_content.value(),
+            retention_time_id=self.retention_time.value(),
+            language_id=self.language.value(),
+            document_date=self.document_date.date(),
+            # exported_at=self.document.exported_at,
+            plan_id=self.document.plan_id,
+            id_=self.document.id_,
+        )