Rework SIP Package generation and download

docs/HISTORY.txt

@@ -5,6 +5,7 @@ Changelog
 ---------------------
 
 - Bump docxcompose version to 1.0.1 [njohner]
+- Improve SIP package generation and download. [phgross]
 - Fix qa tests. [lgraf]
 - Disable properties action for teams. [deiferni]
 - Add source vocabularies for workspace invitations and todo responsibles. [njohner]

opengever/disposition/browser/configure.zcml

@@ -38,6 +38,20 @@
       permission="opengever.disposition.DownloadSIPPackage"
       />
 
+  <browser:page
+      class=".ech0160.ECH0160StoreView"
+      for="opengever.disposition.interfaces.IDisposition"
+      name="ech0160_store"
+      permission="zope2.View"
+      />
+
+  <browser:page
+      class=".ech0160.ECH0160DownloadView"
+      for="opengever.disposition.interfaces.IDisposition"
+      name="ech0160_download"
+      permission="opengever.disposition.DownloadSIPPackage"
+      />
+
   <browser:page
       class=".overview.DispositionOverview"
       for="opengever.disposition.interfaces.IDisposition"

opengever/disposition/browser/ech0160.py

@@ -1,5 +1,9 @@
 from opengever.base.stream import TempfileStreamIterator
+from opengever.disposition import _
 from opengever.disposition.ech0160.sippackage import SIPPackage
+from plone import api
+from plone.namedfile.utils import set_headers
+from plone.namedfile.utils import stream_data
 from Products.Five import BrowserView
 from pyxb.utils.domutils import BindingDOMSupport
 from tempfile import TemporaryFile
@@ -34,3 +38,33 @@ def create_zipfile(self, package):
             package.write_to_zipfile(zipfile)
 
         return tmpfile
+
+
+class ECH0160StoreView(BrowserView):
+    """A view which generates and store's the SIP package as a blob file.
+    """
+
+    def __call__(self):
+        self.context.store_sip_package()
+        msg = _('msg_sip_package_sucessfully_generated',
+                default=u'SIP Package generated successfully.')
+        api.portal.show_message(msg, request=self.request, type='info')
+        return self.request.RESPONSE.redirect(self.context.absolute_url())
+
+
+class ECH0160DownloadView(BrowserView):
+    """View which streams the existing SIP Package. Redirect and show status
+    message when SIP package does not exist.
+    """
+
+    def __call__(self):
+        if not self.context.has_sip_package():
+            msg = _('msg_no_sip_package_generated',
+                    default=u'No SIP Package generated for this disposition.')
+            api.portal.show_message(msg, request=self.request, type='error')
+            return self.request.RESPONSE.redirect(self.context.absolute_url())
+
+        sip_package = self.context.get_sip_package()
+        set_headers(sip_package, self.request.response,
+                    u'{}.zip'.format(self.context.get_sip_name()))
+        return stream_data(sip_package)

opengever/disposition/browser/overview.py

@@ -76,7 +76,7 @@ def get_actions(self):
             {'id': 'sip_download',
              'label': _('label_dispositon_package_download',
                         default=u'Download disposition package'),
-             'url': '{}/ech0160_export'.format(self.context.absolute_url()),
+             'url': '{}/ech0160_download'.format(self.context.absolute_url()),
              'visible': self.sip_download_available(),
              'class': 'sip_download'},
             {'id': 'removal_protocol',
@@ -88,6 +88,15 @@ def get_actions(self):
         ]
 
     def sip_download_available(self):
+        if api.user.has_permission(
+            'opengever.disposition: Download SIP Package',
+            obj=self.context):
+
+            return self.context.has_sip_package()
+
+        return None
+
+    def sip_store_available(self):
         return api.user.has_permission(
             'opengever.disposition: Download SIP Package',
             obj=self.context)

opengever/disposition/disposition.py

@@ -2,6 +2,7 @@
 from Acquisition import aq_parent
 from collective import dexteritytextindexer
 from datetime import date
+from DateTime import DateTime
 from opengever.activity import notification_center
 from opengever.activity.roles import DISPOSITION_ARCHIVIST_ROLE
 from opengever.activity.roles import DISPOSITION_RECORDS_MANAGER_ROLE
@@ -11,31 +12,39 @@
 from opengever.base.source import SolrObjPathSourceBinder
 from opengever.disposition import _
 from opengever.disposition.appraisal import IAppraisal
+from opengever.disposition.ech0160.sippackage import SIPPackage
 from opengever.disposition.interfaces import IDisposition
 from opengever.disposition.interfaces import IDuringDossierDestruction
 from opengever.disposition.interfaces import IHistoryStorage
 from opengever.dossier.base import DOSSIER_STATES_OFFERABLE
 from opengever.dossier.behaviors.dossier import IDossier
 from opengever.ogds.base.utils import get_current_admin_unit
 from opengever.ogds.base.utils import ogds_service
+from path import Path
 from persistent.dict import PersistentDict
 from persistent.list import PersistentList
 from plone import api
 from plone.autoform.directives import write_permission
 from plone.dexterity.content import Container
+from plone.namedfile.file import NamedBlobFile
 from plone.supermodel import model
+from pyxb.utils.domutils import BindingDOMSupport
+from tempfile import TemporaryFile
 from z3c.relationfield.schema import RelationChoice
 from z3c.relationfield.schema import RelationList
 from zExceptions import Unauthorized
+from zipfile import ZIP_DEFLATED
+from zipfile import ZipFile
 from zope import schema
+from zope.annotation import IAnnotations
 from zope.annotation.interfaces import IAnnotations
 from zope.component import getUtility
 from zope.globalrequest import getRequest
 from zope.i18n import translate
 from zope.interface import alsoProvides
 from zope.interface import implements
 from zope.intid.interfaces import IIntIds
-
+import os
 
 DESTROY_PERMISSION = 'opengever.dossier: Destroy dossier'
 
@@ -293,3 +302,38 @@ def get_all_archivists(self):
                 archivists.append(principal)
 
         return archivists
+
+    def store_sip_package(self):
+        self._sip_package = self.generate_sip_package()
+
+    def remove_sip_package(self):
+        self._sip_package = None
+
+    def generate_sip_package(self):
+        package = SIPPackage(self)
+        zip_file = self.create_zipfile(package)
+        zip_file.seek(0)
+        return NamedBlobFile(zip_file.read(), contentType='application/zip')
+
+    def create_zipfile(self, package):
+        tmpfile = TemporaryFile()
+        BindingDOMSupport.SetDefaultNamespace(u'http://bar.admin.ch/arelda/v4')
+        with ZipFile(tmpfile, 'w', ZIP_DEFLATED, True) as zipfile:
+            package.write_to_zipfile(zipfile)
+
+        return tmpfile
+
+    def has_sip_package(self):
+        return bool(self.get_sip_package())
+
+    def get_sip_package(self):
+        return getattr(self, '_sip_package', None)
+
+    def get_sip_name(self):
+        name = u'SIP_{}_{}'.format(
+            DateTime().strftime('%Y%m%d'),
+            api.portal.get().getId().upper())
+        if self.transfer_number:
+            name = u'{}_{}'.format(name, self.transfer_number)
+
+        return name

opengever/disposition/handlers.py

@@ -16,10 +16,15 @@ def disposition_state_changed(context, event):
 
     if event.action == 'disposition-transition-close':
         context.destroy_dossiers()
+        context.remove_sip_package()
 
     if event.action == 'disposition-transition-appraised-to-closed':
         context.mark_dossiers_as_archived()
         context.destroy_dossiers()
+        context.remove_sip_package()
+
+    if event.action == 'disposition-transition-dispose':
+        context.store_sip_package()
 
     storage = IHistoryStorage(context)
     storage.add(event.action,

opengever/disposition/locales/de/LC_MESSAGES/opengever.disposition.po

@@ -1,7 +1,7 @@
 msgid ""
 msgstr ""
 "Project-Id-Version: PACKAGE VERSION\n"
-"POT-Creation-Date: 2018-03-19 12:59+0000\n"
+"POT-Creation-Date: 2019-07-25 14:32+0000\n"
 "PO-Revision-Date: YEAR-MO-DA HO:MI +ZONE\n"
 "Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
 "Language-Team: LANGUAGE <[email protected]>\n"
@@ -273,6 +273,16 @@ msgstr "Angebot abgelehnt durch ${user}"
 msgid "msg_disposition_updated"
 msgstr "Aktualisiert durch ${user}"
 
+#. Default: "No SIP Package generated for this disposition."
+#: ./opengever/disposition/browser/ech0160.py
+msgid "msg_no_sip_package_generated"
+msgstr "Es wurde noch kein SIP Paket generiert für dieses Angebot."
+
+#. Default: "SIP Package generated successfully."
+#: ./opengever/disposition/browser/ech0160.py
+msgid "msg_sip_package_sucessfully_generated"
+msgstr "SIP Paket erfolgreich generiert."
+
 #. Default: "Period"
 #: ./opengever/disposition/browser/templates/overview.pt
 msgid "period"

opengever/disposition/locales/fr/LC_MESSAGES/opengever.disposition.po

@@ -1,21 +1,20 @@
 msgid ""
 msgstr ""
 "Project-Id-Version: PACKAGE VERSION\n"
-"POT-Creation-Date: 2018-03-19 12:59+0000\n"
+"POT-Creation-Date: 2019-07-25 14:32+0000\n"
 "PO-Revision-Date: 2018-05-22 10:09+0000\n"
 "Last-Translator: Niklaus Johner <[email protected]>\n"
-"Language-Team: French <https://translations.onegovgever.ch/projects/onegov-"
-"gever/opengever-disposition/fr/>\n"
-"Language: fr\n"
+"Language-Team: French <https://translations.onegovgever.ch/projects/onegov-gever/opengever-disposition/fr/>\n"
 "MIME-Version: 1.0\n"
 "Content-Type: text/plain; charset=utf-8\n"
 "Content-Transfer-Encoding: 8bit\n"
 "Plural-Forms: nplurals=2; plural=n > 1;\n"
-"X-Generator: Weblate 2.13.1\n"
 "Language-Code: en\n"
 "Language-Name: English\n"
 "Preferred-Encodings: utf-8 latin1\n"
 "Domain: DOMAIN\n"
+"Language: fr\n"
+"X-Generator: Weblate 2.13.1\n"
 
 #: ./opengever/disposition/browser/excel_export.py
 msgid "The report could not been generated."
@@ -276,6 +275,16 @@ msgstr "Offre refusée par ${user}"
 msgid "msg_disposition_updated"
 msgstr "Actualisé par ${user}"
 
+#. Default: "No SIP Package generated for this disposition."
+#: ./opengever/disposition/browser/ech0160.py
+msgid "msg_no_sip_package_generated"
+msgstr ""
+
+#. Default: "SIP Package generated successfully."
+#: ./opengever/disposition/browser/ech0160.py
+msgid "msg_sip_package_sucessfully_generated"
+msgstr ""
+
 #. Default: "Period"
 #: ./opengever/disposition/browser/templates/overview.pt
 msgid "period"

opengever/disposition/locales/opengever.disposition.pot

@@ -4,7 +4,7 @@
 msgid ""
 msgstr ""
 "Project-Id-Version: PACKAGE VERSION\n"
-"POT-Creation-Date: 2018-03-19 12:59+0000\n"
+"POT-Creation-Date: 2019-07-25 14:32+0000\n"
 "PO-Revision-Date: YEAR-MO-DA HO:MI +ZONE\n"
 "Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
 "Language-Team: LANGUAGE <[email protected]>\n"
@@ -276,6 +276,16 @@ msgstr ""
 msgid "msg_disposition_updated"
 msgstr ""
 
+#. Default: "No SIP Package generated for this disposition."
+#: ./opengever/disposition/browser/ech0160.py
+msgid "msg_no_sip_package_generated"
+msgstr ""
+
+#. Default: "SIP Package generated successfully."
+#: ./opengever/disposition/browser/ech0160.py
+msgid "msg_sip_package_sucessfully_generated"
+msgstr ""
+
 #. Default: "Period"
 #: ./opengever/disposition/browser/templates/overview.pt
 msgid "period"

opengever/disposition/tests/test_disposition.py

@@ -224,3 +224,40 @@ def test_reset_date_of_submission_for_dropped_dossiers(self, browser):
             None, ILifeCycle(self.offered_dossier_to_destroy).date_of_submission)
         self.assertEquals(
             date.today(), ILifeCycle(self.expired_dossier).date_of_submission)
+
+    @browsing
+    def test_sip_package_is_genarated_and_stored_on_dispose(self, browser):
+        self.login(self.records_manager, browser)
+
+        self.set_workflow_state('disposition-state-appraised', self.disposition)
+
+        browser.open(self.disposition, view='overview')
+        browser.click_on('disposition-transition-dispose')
+
+        self.assertEquals(['Item state changed.'], info_messages())
+        self.assertTrue(self.disposition.has_sip_package())
+
+        # Download is possible
+        self.assertIn(
+            'Download disposition package', browser.css('ul.actions li').text)
+
+    @browsing
+    def test_sip_package_is_removed_on_close(self, browser):
+        self.login(self.records_manager, browser)
+
+        self.disposition.store_sip_package()
+        self.set_workflow_state('disposition-state-appraised', self.disposition)
+        browser.open(self.disposition, view='overview')
+
+        browser.click_on('disposition-transition-dispose')
+        self.assertTrue(self.disposition.has_sip_package())
+
+        with self.login(self.archivist, browser=browser):
+            browser.open(self.disposition, view='overview')
+            browser.click_on('disposition-transition-archive')
+
+        browser.open(self.disposition, view='overview')
+        browser.click_on('disposition-transition-close')
+
+        self.assertEquals(['Item state changed.'], info_messages())
+        self.assertFalse(self.disposition.has_sip_package())

opengever/disposition/tests/test_ech0160export.py

@@ -1,7 +1,10 @@
 from datetime import datetime
 from ftw.testbrowser import browsing
+from ftw.testbrowser.pages.statusmessages import error_messages
+from ftw.testbrowser.pages.statusmessages import info_messages
 from ftw.testing import freeze
 from opengever.testing import IntegrationTestCase
+import os
 
 
 class TesteCH0160Deployment(IntegrationTestCase):
@@ -22,3 +25,50 @@ def test_returns_zip_file_stream(self, browser):
             self.assertEquals(
                 'inline; filename="SIP_20160611_PLONE_10xy.zip"',
                 self.request.response.headers.get('content-disposition'))
+
+
+class TestECH0160StoreView(IntegrationTestCase):
+
+    @browsing
+    def test_generates_sip_package_and_stores_it_as_a_blob_on_the_filesystem(self, browser):
+        self.login(self.records_manager, browser=browser)
+
+        self.set_workflow_state('disposition-state-disposed', self.disposition)
+        self.disposition.transfer_number = "10xy"
+        self.assertFalse(self.disposition.has_sip_package())
+
+        with freeze(datetime(2016, 6, 11)):
+            browser.open(self.disposition, view='ech0160_store')
+
+        self.assertEquals(
+            ['SIP Package generated successfully.'], info_messages())
+        self.assertTrue(self.disposition.has_sip_package())
+
+
+class TestECH0160DownloadView(IntegrationTestCase):
+
+    @browsing
+    def test_shows_status_message_when_no_zip_is_stored(self, browser):
+        self.login(self.archivist, browser=browser)
+
+        self.set_workflow_state('disposition-state-disposed', self.disposition)
+        browser.open(self.disposition, view='ech0160_download')
+        self.assertEquals([u'No SIP Package generated for this disposition.'],
+                          error_messages())
+
+    @browsing
+    def test_streams_zip_when_sip_package_is_stored(self, browser):
+        self.login(self.archivist, browser=browser)
+
+        self.set_workflow_state('disposition-state-disposed', self.disposition)
+        self.disposition.transfer_number = "10xy"
+        self.disposition.store_sip_package()
+
+        with freeze(datetime(2016, 6, 11)):
+            browser.open(self.disposition, view='ech0160_download')
+
+        self.assertEquals(
+            'application/zip', browser.headers.get('content-type'))
+        self.assertEquals(
+            "attachment; filename*=UTF-8''SIP_20160611_PLONE_10xy.zip",
+            browser.headers.get('content-disposition'))