Changeset 7097 for main/waeup.sirp/trunk/src/waeup/sirp/students

Timestamp:

12 Nov 2011, 22:30:27 (13 years ago)

Author:

Henrik Bettermann

Message:

Implement StudentFileNameChooser? and StudentFileStoreHandler?.

Define viewlet manager FileManager? in viewlets.py and define display and upload viewlets for the StudentClearanceDisplayFormPage?.

Also define image views. Since these views are part of the viewlets they are defined also in the viewlets module. In browser.py we only add an empty files_changed list attribute to the StudentClearanceManageFormPage?. This will be needed for logging (to be done).

Location:

main/waeup.sirp/trunk/src/waeup/sirp/students

Files:

• browser.py (modified) (1 diff)
• browser_templates/filedisplay.pt (added)
• browser_templates/fileupload.pt (added)
• browser_templates/imagedisplay.pt (added)
• browser_templates/imageupload.pt (added)
• student.py (modified) (3 diffs)
• viewlets.py (modified) (2 diffs)

main/waeup.sirp/trunk/src/waeup/sirp/students/browser.py

@@ -470 +470 @@
     title = 'Clearance Data'
     pnav = 4
+    files_changed = []
 
     form_fields['date_of_birth'].custom_widget = FriendlyDateWidget('le-year')

main/waeup.sirp/trunk/src/waeup/sirp/students/student.py

@@ -17 +17 @@
 Container for the various objects owned by students.
 """
+import os
 import grok
 from grok import index
@@ -23 +24 @@
 from hurry.workflow.interfaces import IWorkflowState, IWorkflowInfo
 from zope.securitypolicy.interfaces import IPrincipalRoleManager
-from waeup.sirp.interfaces import IObjectHistory, IUserAccount
+from waeup.sirp.interfaces import (
+    IObjectHistory, IUserAccount, IFileStoreNameChooser, IFileStoreHandler)
+from waeup.sirp.image import WAeUPImageFile
+from waeup.sirp.imagestorage import DefaultFileStoreHandler
 from waeup.sirp.students.interfaces import (
     IStudent, IStudentNavigation, IStudentClearanceEdit,
@@ -136 +140 @@
         user, target, comment))
     return
+
+#: The file id marker for student files
+STUDENT_FILE_STORE_NAME = 'file-student'
+
+class StudentFileNameChooser(grok.Adapter):
+    """A file id chooser for :class:`Applicant` objects.
+
+    `context` is an :class:`Applicant` instance.
+
+    The :class:`ApplicantImageNameChooser` can build/check file ids
+    for :class:`Applicant` objects suitable for use with
+    :class:`ExtFileStore` instances. The delivered file_id contains
+    the file id marker for :class:`Applicant` object and the
+    registration number or access code of the context applicant. Also
+    the name of the connected applicant container will be part of the
+    generated file id.
+
+    This chooser is registered as an adapter providing
+    :class:`waeup.sirp.interfaces.IFileStoreNameChooser`.
+
+    File store name choosers like this one are only convenience
+    components to ease the task of creating file ids for applicant
+    objects. You are nevertheless encouraged to use them instead of
+    manually setting up filenames for applicants.
+
+    .. seealso:: :mod:`waeup.sirp.imagestorage`
+
+    """
+    grok.context(IStudent)
+    grok.implements(IFileStoreNameChooser)
+
+    def checkName(self, name=None, attr=None):
+        """Check whether the given name is a valid file id for the context.
+
+        Returns ``True`` only if `name` equals the result of
+        :meth:`chooseName`.
+
+        """
+        return name == self.chooseName()
+
+    def chooseName(self, name=None, attr=None):
+        """Get a valid file id for student context.
+
+        *Example:*
+
+        For a student with student id ``'A123456'`` and
+        with attr ``'nice_image'`` stored in
+        the students container this chooser would create:
+
+          ``'__file-student__students/A/A123456/nice_image_A123456.jpg'``
+
+        meaning that the nice image of this applicant would be
+        stored in the site-wide file storage in path:
+
+          ``students/A/A123456/nice_image_A123456.jpg``
+
+        """
+        first_character = self.context.student_id[0]
+        marked_filename = '__%s__%s/%s/%s_%s.jpg' % (
+            STUDENT_FILE_STORE_NAME, first_character,
+            self.context.student_id, attr, self.context.student_id)
+        return marked_filename
+
+
+class StudentFileStoreHandler(DefaultFileStoreHandler, grok.GlobalUtility):
+    """Student specific file handling.
+
+    This handler knows in which path in a filestore to store student
+    files and how to turn this kind of data into some (browsable)
+    file object.
+
+    It is called from the global file storage, when it wants to
+    get/store a file with a file id starting with
+    ``__file-student__`` (the marker string for student files).
+
+    Like each other file store handler it does not handle the files
+    really (this is done by the global file store) but only computes
+    paths and things like this.
+    """
+    grok.implements(IFileStoreHandler)
+    grok.name(STUDENT_FILE_STORE_NAME)
+
+    def pathFromFileID(self, store, root, file_id):
+        """All applicants images are filed in directory ``applicants``.
+        """
+        marker, filename, basename, ext = store.extractMarker(file_id)
+        return os.path.join(root, 'students', filename)
+
+    def createFile(self, store, root, filename, file_id, file):
+        """Create a browsable file-like object.
+        """
+        # possible other actions: check for jpeg format
+        path = self.pathFromFileID(store, root, file_id)
+        return file, path, WAeUPImageFile(filename, file_id)

main/waeup.sirp/trunk/src/waeup/sirp/students/viewlets.py

@@ -1 +1 @@
 import grok
+from zope.component import getUtility
 from zope.interface import Interface
-from waeup.sirp.interfaces import IWAeUPObject
+from waeup.sirp.interfaces import (
+    IWAeUPObject, IExtFileStore, IFileStoreNameChooser)
+from waeup.sirp.utils.helpers import string_from_bytes, file_size
+from waeup.sirp.browser import DEFAULT_IMAGE_PATH
+from waeup.sirp.students.browser import (
+    StudentClearanceDisplayFormPage, StudentClearanceManageFormPage)
 
 grok.context(IWAeUPObject) # Make IWAeUPObject the default context
@@ -190 +196 @@
         rel_link = '/students/%s' % self.request.principal.id
         return self.view.application_url() + rel_link
+
+def handle_img_upload(upload, context, view, max_size, attr=None):
+    """Handle upload of applicant image.
+
+    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_size:
+        view.flash('Uploaded image is too big!')
+        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 FileManager(grok.ViewletManager):
+    """Viewlet manager for uploading files, preferably scanned images.
+    """
+    grok.name('files')
+
+class FileDisplay(grok.Viewlet):
+    """Base file display viewlet.
+    """
+    grok.baseclass()
+    grok.viewletmanager(FileManager)
+    grok.view(StudentClearanceDisplayFormPage)
+    grok.template('filedisplay')
+    grok.order(1)
+    grok.require('waeup.viewStudent')
+    label = u'Some Text:'
+    img_src = u'filename.jpg'
+    attr = None
+
+class FileUpload(FileDisplay):
+    """Base upload viewlet.
+    """
+    grok.baseclass()
+    grok.viewletmanager(FileManager)
+    grok.view(StudentClearanceManageFormPage)
+    grok.template('fileupload')
+    grok.require('waeup.manageStudents')
+    mus = 1024 * 150
+    input_name = u'form.filename'
+
+    def update(self):
+        self.max_upload_size = string_from_bytes(self.mus)
+        upload = self.request.form.get(self.input_name, None)
+        if upload:
+            # We got a fresh upload
+            file_changed = handle_img_upload(
+                upload, self.context, self.view, self.mus, self.attr)
+            if file_changed is False:  # False is not None!
+                self.redirect(self.view.url(self.context))
+                return # error during image upload. Ignore other values
+            else:
+                self.view.files_changed += self.img_src
+        return
+
+class BirthCertificateDisplay(FileDisplay):
+    """Birth Certificate upload viewlet.
+    """
+    grok.order(1)
+    label = u'Birth Certificate:'
+    img_src = u'birth_certificate.jpg'
+    attr = u'birth_certificate'
+
+class BirthCertificateUpload(FileUpload):
+    """Birth Certificate upload viewlet.
+    """
+    grok.order(1)
+    label = u'Birth Certificate:'
+    mus = 1024 * 150
+    img_src = u'birth_certificate.jpg'
+    input_name = u'form.birth_certificate'
+    attr = u'birth_certificate'
+
+class Image(grok.View):
+    """Renders image for students.
+    """
+    grok.name('none.jpg')
+    grok.view(StudentClearanceManageFormPage)
+    grok.require('waeup.viewStudent')
+    grok.baseclass()
+    attr = None
+
+    def render(self):
+        # A filename chooser turns a context into a filename suitable
+        # for file storage.
+        image = getUtility(IExtFileStore).getFileByContext(
+            self.context, attr=self.attr)
+        self.response.setHeader(
+            'Content-Type', 'image/jpeg')
+        if image is None:
+            # show placeholder image
+            return open(DEFAULT_IMAGE_PATH, 'rb').read()
+        return image
+
+class BirthCertificateImage(Image):
+    """Renders birth certificate.
+    """
+    grok.name('birth_certificate.jpg')
+    attr = u'birth_certificate'