Allow SPV users to update protocol excerpt to proposal dossier

Author: Acrop146

docs/public/dev-manual/api/api_changelog.rst

@@ -14,6 +14,7 @@ Other Changes
 ^^^^^^^^^^^^^
 - ``@membership-notes``: Add endpoint to update a note on a membership.
 - ``@ris-return-excerpt``: Add endpoint to allow users from spv to create a proposal excerpt in a dossier they do not have view permission in.
+- ``@ris-update-excerpt``: Add endpoint to allow users from spv to update a proposal excerpt in a dossier they do not have view permission in.
 
 
 2025.8.0 (2025-08-22)

docs/public/dev-manual/api/proposals.rst

@@ -165,11 +165,10 @@ Protokollauszug im Antragsdossier ablegen
 =========================================
 
 Mit dem ``@ris-return-excerpt`` Endpoint können Protokollauszüge aus der SPV
-ins Antragsdossier eingereichtwerden. Der Endpoint erwartet als Pfad Parameter:
+ins Antragsdossier eingereicht werden. Der Endpoint erwartet als Pfad Parameter:
 
 - Mandant ID
 - relative Dossierpfad
-- Vermerk als String
 
 
 **Beispiel-Request**:
@@ -187,6 +186,44 @@ ins Antragsdossier eingereichtwerden. Der Endpoint erwartet als Pfad Parameter:
 **Beispiel-Response**:
 
 
+   .. sourcecode:: http
+
+      HTTP/1.1 200 OK
+      Content-Type: application/json
+
+      {
+        "path": "ordnungssystem/dossier-2/document-2",
+        "intid": 3,
+        "url": "http://gever.onegovgever.ch/fd/ordnungssystem/dossier-2/document-2",
+        "current_version_id": 1,
+      }
+
+
+Protokollauszug im Antragsdossier aktualisieren
+===============================================
+
+Mit dem ``@ris-update-excerpt`` Endpoint können Protokollauszüge aus der SPV
+im Antragsdossier aktualisiert werden. Der Endpoint erwartet als Pfad Parameter:
+
+- Mandant ID
+- relative Dokumentpfad vom Protokollauszug
+
+
+**Beispiel-Request**:
+
+   .. sourcecode:: http
+
+      POST ordnungssystem/dossier-1/document-1/@ris-update-excerpt HTTP/1.1
+      Accept: application/json
+
+      {
+        "target_admin_unit_id": "fd",
+        "target_document_relative_path": "ordnungssystem/dossier-1/document-1"
+      }
+
+**Beispiel-Response**:
+
+
    .. sourcecode:: http
 
       HTTP/1.1 200 OK

opengever/core/profiles/default/rolemap.xml

@@ -290,6 +290,11 @@
       <role name="Member" />
     </permission>
 
+    <permission name="opengever.ris: Update Excerpt" acquire="False">
+      <role name="Manager" />
+      <role name="Member" />
+    </permission>
+
     <!-- SHARING -->
     <permission name="Sharing page: Delegate Administrator role" acquire="True">
       <role name="Administrator" />

opengever/core/upgrades/20251023104506_add_ris_update_excerpt_permission/__init__ .py

@@ -0,0 +1,10 @@
+<rolemap>
+  <permissions>
+
+    <permission name="opengever.ris: Update Excerpt" acquire="True">
+      <role name="Manager" />
+      <role name="Member" />
+    </permission>
+
+  </permissions>
+</rolemap>

opengever/core/upgrades/20251023104506_add_ris_update_excerpt_permission/rolemap.xml

@@ -0,0 +1,9 @@
+from ftw.upgrade import UpgradeStep
+
+
+class AddRisUpdateExcerptPermission(UpgradeStep):
+    """Add ris update excerpt permission.
+    """
+
+    def __call__(self):
+        self.install_upgrade_profile()

opengever/core/upgrades/20251023104506_add_ris_update_excerpt_permission/upgrade.py

@@ -50,6 +50,15 @@
       layer="opengever.base.interfaces.IOpengeverBaseLayer"
       />
 
+  <plone:service
+      name="@ris-update-excerpt"
+      for="opengever.document.document.IDocumentSchema"
+      method="POST"
+      factory="opengever.ris.browser.ris_excerpt.RISUpdateExcerptService"
+      permission="opengever.ris.UpdateExcerpt"
+      layer="opengever.base.interfaces.IOpengeverBaseLayer"
+      />
+
   <browser:page
       name="receive-ris-return-excerpt"
       for="opengever.dossier.behaviors.dossier.IDossierMarker"
@@ -58,4 +67,12 @@
       layer="opengever.ogds.base.interfaces.IInternalOpengeverRequestLayer"
       />
 
+  <browser:page
+      name="receive-ris-update-excerpt"
+      for="opengever.document.document.IDocumentSchema"
+      class="opengever.ris.browser.ris_excerpt.RISUpdateExcerptReceive"
+      permission="zope.Public"
+      layer="opengever.ogds.base.interfaces.IInternalOpengeverRequestLayer"
+      />
+
 </configure>

opengever/ris/browser/configure.zcml

@@ -1,15 +1,21 @@
 from Acquisition import aq_inContextOf
 from Acquisition import aq_inner
+from opengever.base.interfaces import IDataCollector
 from opengever.base.json_response import JSONResponse
 from opengever.base.security import elevated_privileges
 from opengever.base.transport import PrivilegedReceiveObject
 from opengever.base.transport import Transporter
+from opengever.document.versioner import Versioner
+from opengever.journal.handlers import journal_entry_factory
+from opengever.ogds.base.utils import encode_after_json
+from opengever.ris import _
 from plone import api
 from plone.protect.interfaces import IDisableCSRFProtection
 from plone.restapi.deserializer import json_body
 from plone.restapi.services import Service
 from z3c.relationfield.relation import RelationValue
 from zExceptions import BadRequest
+from zope.component import getAdapters
 from zope.component import getUtility
 from zope.interface import alsoProvides
 from zope.intid.interfaces import IIntIds
@@ -52,6 +58,39 @@ def reply(self):
         return result
 
 
+class RISUpdateExcerptService(Service):
+
+    def reply(self):
+        alsoProvides(self.request, IDisableCSRFProtection)
+
+        if not api.user.has_permission("View", obj=self.context):
+            return JSONResponse(self.request).error("Forbidden", status=403).dump()
+
+        data = json_body(self.request) or {}
+        target_cid = data.get("target_admin_unit_id")
+        container_path = data.get("target_doc_relative_path")
+
+        if not target_cid or not container_path:
+            return (
+                JSONResponse(self.request)
+                .error(
+                    "Target admin_unit_id and paths are required.",
+                    status=400,
+                )
+                .dump()
+            )
+
+        container_path = container_path.lstrip("/")
+
+        result = Transporter().transport_to(
+            obj=self.context,
+            target_cid=target_cid,
+            container_path=container_path,
+            view="receive-ris-update-excerpt",
+        )
+        return result
+
+
 class RISReturnExcerptReceive(PrivilegedReceiveObject):
     """Receiver on the target dossier. Runs with elevated privileges."""
 
@@ -127,3 +166,56 @@ def receive(self):
                 pass
 
         return document
+
+
+class RISUpdateExcerptReceive(RISReturnExcerptReceive):
+    """Receiver on the target dossier. Runs with elevated privileges."""
+
+    def _apply_payload_as_new_version(self, gever_doc, payload):
+        Versioner(gever_doc).create_initial_version()
+
+        data = encode_after_json(payload)
+
+        for name, collector in getAdapters((gever_doc,), IDataCollector):
+            if name in data:
+                collector.insert(data[name])
+
+        file = data["field-data"]["IDocumentSchema"].get("file")
+        if file:
+            gever_doc.update_file(
+                file["data"],
+                content_type=file.get("content-type"),
+                filename=file.get("filename"),
+                create_version=True,
+            )
+
+            journal_entry_factory(
+                context=gever_doc,
+                action="Update proposal excerpt from SPV",
+                title=_("excerpt_was_replaced", default="Excerpt was replaced"),
+            )
+        api.content.transition(obj=gever_doc, transition="document-transition-finalize")
+
+        return gever_doc
+
+    def receive(self):
+        document = self.container
+        transporter = Transporter()
+        payload = transporter._extract_data(self.request)
+
+        if document is None:
+            raise BadRequest("Invalid 'doc_relative_path' (object not found).")
+
+        try:
+            with elevated_privileges():
+                if document.is_final_document():
+                    api.content.transition(
+                        obj=document, transition="document-transition-reopen"
+                    )
+
+                document = self._apply_payload_as_new_version(document, payload)
+
+        except Exception:
+            pass
+
+        return document

opengever/ris/browser/ris_excerpt.py

@@ -112,3 +112,8 @@ msgstr "Thema"
 #: ./opengever/ris/viewlets/byline.py
 msgid "label_workflow_state"
 msgstr "Status"
+
+#. Default: "Excerpt was replaced"
+#: ./opengever/ris/browser/ris_excerpt.py
+msgid "excerpt_was_replaced"
+msgstr "Protokollauszug ersetzt"

opengever/ris/locales/de/LC_MESSAGES/opengever.ris.po

@@ -112,3 +112,8 @@ msgstr "Topic"
 #: ./opengever/ris/viewlets/byline.py
 msgid "label_workflow_state"
 msgstr "State"
+
+#. Default: "Excerpt was replaced"
+#: ./opengever/ris/browser/ris_excerpt.py
+msgid "excerpt_was_replaced"
+msgstr "Excerpt was replaced"