Changeset 15878

Timestamp:

9 Dec 2019, 21:39:51 (5 years ago)

Author:

Henrik Bettermann

Message:

Add file upload facilities for statement of result upload.

Location:

main/kofacustom.iuokada/trunk/src/kofacustom/iuokada/applicants

Files:

• applicant.py (modified) (2 diffs)
• browser.py (modified) (6 diffs)
• browser_templates/applicantdisplaypage.pt (added)
• browser_templates/applicanteditpage.pt (added)
• tests/test_browser.py (modified) (2 diffs)

main/kofacustom.iuokada/trunk/src/kofacustom/iuokada/applicants/applicant.py

@@ -19 +19 @@
 import grok
 from zope.interface import implementedBy
+from zope.component import getUtility
+from waeup.kofa.interfaces import IExtFileStore
 from waeup.kofa.applicants.applicant import ApplicantFactory
 from waeup.kofa.utils.helpers import attrs_to_fields
@@ -24 +26 @@
 from kofacustom.iuokada.applicants.interfaces import(
     ICustomApplicant, ICustomUGApplicantEdit, ICustomPGApplicantEdit, IPUTMEApplicantEdit)
+
+@grok.subscribe(ICustomApplicant, grok.IObjectRemovedEvent)
+def custom_handle_applicant_removed(applicant, event):
+    """If an applicant is removed also pdf files of this applicant are removed.
+    """
+    file_store = getUtility(IExtFileStore)
+    file_store.deleteFileByContext(applicant, attr='stateresult.pdf')
+    return
 
 class CustomApplicant(NigeriaApplicant):

main/kofacustom.iuokada/trunk/src/kofacustom/iuokada/applicants/browser.py

@@ -19 +19 @@
 """
 import grok
+import os
+from zope.component import getUtility
 from zope.formlib.textwidgets import BytesDisplayWidget
+from waeup.kofa.interfaces import (
+    IExtFileStore, IFileStoreNameChooser)
+from waeup.kofa.utils.helpers import string_from_bytes, file_size, now
 from waeup.kofa.applicants.browser import (
     ApplicantRegistrationPage, ApplicantsContainerPage)
@@ -43 +48 @@
     )
 from kofacustom.iuokada.applicants.interfaces import (
-    ICustomPGApplicant, ICustomUGApplicant,
+    ICustomPGApplicant, ICustomUGApplicant, ICustomApplicant,
     ICustomPGApplicantEdit, ICustomUGApplicantEdit,
     ICustomApplicantOnlinePayment
     )
 from kofacustom.iuokada.interfaces import MessageFactory as _
+
+MAX_FILE_UPLOAD_SIZE = 1024 * 500
+
+def handle_file_upload(upload, context, view, attr=None):
+    """Handle upload of applicant files.
+
+    Returns `True` in case of success or `False`.
+
+    Please note that file pointer passed in (`upload`) most probably
+    points to end of file when leaving this function.
+    """
+    size = file_size(upload)
+    if size > MAX_FILE_UPLOAD_SIZE:
+        view.flash(_('Uploaded file is too big!'))
+        return False
+    dummy, ext = os.path.splitext(upload.filename)
+    ext.lower()
+    if ext != '.pdf':
+        view.flash(_('pdf file extension expected.'))
+        return False
+    upload.seek(0) # file pointer moved when determining size
+    store = getUtility(IExtFileStore)
+    file_id = IFileStoreNameChooser(context).chooseName(attr=attr)
+    store.createFile(file_id, upload)
+    return True
 
 class CustomApplicantsContainerPage(ApplicantsContainerPage):
@@ -73 +103 @@
 
     @property
+    def file_links(self):
+        html = ''
+        pdf = getUtility(IExtFileStore).getFileByContext(
+            self.context, attr='stateresult.pdf')
+        if pdf:
+            html += '<a href="%s">Statement of Result</a>' % self.url(
+                self.context, 'stateresult.pdf')
+        return html
+
+    @property
     def form_fields(self):
         if self.target is not None and self.target.startswith('pg'):
@@ -112 +152 @@
         return form_fields
 
+    def update(self):
+        super(CustomApplicantManageFormPage, self).update()
+        upload_stateresult = self.request.form.get('form.stateresult', None)
+        if upload_stateresult:
+            # We got a fresh stateresult upload
+            success = handle_file_upload(
+                upload_stateresult, self.context, self, attr='stateresult.pdf')
+            if success:
+                self.context.writeLogMessage(self, 'saved: stateresult')
+            else:
+                self.upload_success = False
+        self.max_file_upload_size = string_from_bytes(MAX_FILE_UPLOAD_SIZE)
+        return
+
 class CustomApplicantEditFormPage(NigeriaApplicantEditFormPage):
     """An applicant-centered edit view for applicant data.
     """
 
+    def dataNotComplete(self, data):
+        store = getUtility(IExtFileStore)
+        if self.context.__parent__.with_picture:
+            store = getUtility(IExtFileStore)
+            if not store.getFileByContext(self.context, attr=u'passport.jpg'):
+                return _('No passport picture uploaded.')
+            if not self.request.form.get('confirm_passport', False):
+                return _('Passport picture confirmation box not ticked.')
+        if self.context.subtype == 'transfer' and \
+            not store.getFileByContext(self.context, attr=u'stateresult.pdf'):
+            return _('No statement of result pdf file uploaded.')
+        return False
+
     @property
     def form_fields(self):
@@ -129 +196 @@
         form_fields['reg_number'].for_display = True
         return form_fields
+
+    def update(self):
+        if self.context.locked or (
+            self.context.__parent__.expired and
+            self.context.__parent__.strict_deadline):
+            self.emit_lock_message()
+            return
+        super(CustomApplicantEditFormPage, self).update()
+        upload_stateresult = self.request.form.get('form.stateresult', None)
+        if upload_stateresult:
+            # We got a fresh stateresult upload
+            success = handle_file_upload(
+                upload_stateresult, self.context, self, attr='stateresult.pdf')
+            if not success:
+                self.upload_success = False
+        self.max_file_upload_size = string_from_bytes(MAX_FILE_UPLOAD_SIZE)
+        return
 
 class CustomPDFApplicationSlip(NigeriaPDFApplicationSlip):
@@ -152 +236 @@
         return form_fields
 
+class StateResult(grok.View):
+    """Renders the pdf form extension for applicants.
+    """
+    grok.name('stateresult.pdf')
+    grok.context(ICustomApplicant)
+    grok.require('waeup.viewApplication')
+
+    def render(self):
+        pdf = getUtility(IExtFileStore).getFileByContext(
+            self.context, attr='stateresult.pdf')
+        self.response.setHeader('Content-Type', 'application/pdf')
+        return pdf

main/kofacustom.iuokada/trunk/src/kofacustom/iuokada/applicants/tests/test_browser.py

@@ -19 +19 @@
 Test the applicant-related UI components.
 """
+import grok
+import datetime
+import pytz
 import os
-import datetime
+from StringIO import StringIO
+from zope.event import notify
 from zope.component import createObject, getUtility
 from zope.catalog.interfaces import ICatalog
 from zope.intid.interfaces import IIntIds
 from hurry.workflow.interfaces import IWorkflowState
+from zope.component import createObject, getUtility
+from waeup.kofa.configuration import SessionConfiguration
+from waeup.kofa.interfaces import (
+    IUserAccount, IExtFileStore, IFileStoreNameChooser)
 from kofacustom.iuokada.testing import FunctionalLayer
+from waeup.kofa.applicants.container import ApplicantsContainer
 from waeup.kofa.browser.tests.test_pdf import samples_dir
-from waeup.kofa.applicants.tests.test_browser import ApplicantsFullSetup
+from waeup.kofa.applicants.tests.test_browser import (ApplicantsFullSetup,
+    ApplicantsFullSetup, container_name_1, session_1)
 from waeup.kofa.applicants.tests.test_batching import ApplicantImportExportSetup
 from kofacustom.iuokada.applicants.export import CustomApplicantExporter
@@ -91 +101 @@
         open(path, 'wb').write(self.browser.contents)
         print "Sample application_slip.pdf written to %s" % path
+
+    def test_upload_stateresult_by_manager(self):
+        # Add trans applicants container
+        self.transcontainer = ApplicantsContainer()
+        self.transcontainer.mode = 'create'
+        self.transcontainer.code = u'ug%s' % session_1
+        self.transcontainer.prefix = u'ug'
+        self.transcontainer.application_category = u'no'
+        self.transcontainer.year = session_1
+        self.transcontainer.application_fee = 300.0
+        self.transcontainer.title = u'This is the ug%s container' % session_1
+        self.app['applicants'][self.transcontainer.code] = self.transcontainer
+        delta = datetime.timedelta(days=10)
+        self.transcontainer.startdate = datetime.datetime.now(pytz.utc) - delta
+        self.transcontainer.enddate = datetime.datetime.now(pytz.utc) + delta
+        # Add applicant
+        transapplicant = createObject(u'waeup.Applicant')
+        transapplicant.firstname = u'Anna'
+        transapplicant.lastname = u'Post'
+        transapplicant.subtype = 'transfer'
+        self.app['applicants'][self.transcontainer.code].addApplicant(transapplicant)
+        self.transapplicant = self.app['applicants'][self.transcontainer.code][
+            transapplicant.application_number]
+        self.transapplicant_view_path = ('http://localhost/app/applicants/ug%s/%s'
+            % (session_1, transapplicant.application_number))
+        self.transapplicant_manage_path = ('http://localhost/app/applicants/ug%s/%s/manage'
+            % (session_1, transapplicant.application_number))
+        # Login
+        self.browser.addHeader('Authorization', 'Basic mgr:mgrpw')
+        self.browser.open(self.transapplicant_manage_path)
+        # Create a pseudo file with acceptable size
+        pdf_content = 'A' * 1024 * 300  # A string of 300 KB size
+        pseudo_pdf = StringIO(pdf_content)
+        ctrl = self.browser.getControl(name='form.stateresult')
+        file_ctrl = ctrl.mech_control
+        file_ctrl.add_file(pseudo_pdf, filename='myform.pdf')
+        self.browser.getControl("Save").click() # submit form
+        # Even though the form could not be saved ...
+        self.assertTrue('Required input is missing' in self.browser.contents)
+        # ... the file has been successfully uploaded
+        pdf_url = self.transapplicant_manage_path.replace('manage', 'stateresult.pdf')
+        self.browser.open(pdf_url)
+        self.assertEqual(
+            self.browser.headers['content-type'], 'application/pdf')
+        self.assertEqual(len(self.browser.contents), 307200)
+        # There is really a file stored for the applicant
+        storage = getUtility(IExtFileStore)
+        file_id = IFileStoreNameChooser(self.transapplicant).chooseName(
+            attr='stateresult.pdf')
+        # The stored file can be fetched
+        fd = storage.getFile(file_id)
+        file_len = len(fd.read())
+        self.assertEqual(file_len, 307200)
+        # A file link is displayed on the edit view ...
+        self.browser.open(self.transapplicant_manage_path)
+        self.assertTrue('<a href="stateresult.pdf">' in self.browser.contents)
+        # ... and on the dislay view
+        self.browser.open(self.transapplicant_view_path)
+        self.assertTrue('stateresult.pdf">Statement of Result</a>'
+            in self.browser.contents)
+        # Adding file is properly logged
+        logfile = os.path.join(
+            self.app['datacenter'].storage, 'logs', 'applicants.log')
+        logcontent = open(logfile).read()
+        self.assertTrue(
+            'zope.mgr - kofacustom.iuokada.applicants.browser.CustomApplicantManageFormPage'
+            ' - %s - saved: stateresult'
+            % (self.transapplicant.applicant_id)
+            in logcontent)
+        # When an applicant is removed, also the pdf files are gone.
+        del self.app['applicants'][self.transcontainer.code][self.transapplicant.application_number]
+        fd = storage.getFile(file_id)
+        self.assertTrue(fd is None)