Changeset 12448

Timestamp:

12 Jan 2015, 11:00:55 (10 years ago)

Author:

Henrik Bettermann

Message:

Move base file viewlets to browser package.

Location:

main/waeup.kofa/trunk/src/waeup/kofa

Files:

• browser/fileviewlets.py (added)
• documents/fileviewlets.py (modified) (1 diff)
• students/fileviewlets.py (modified) (10 diffs)
• students/utils.py (modified) (1 diff)

main/waeup.kofa/trunk/src/waeup/kofa/documents/fileviewlets.py

@@ -20 +20 @@
 from waeup.kofa.interfaces import MessageFactory as _
 from waeup.kofa.browser.layout import UtilityView
-from waeup.kofa.students.fileviewlets import (
+from waeup.kofa.browser.fileviewlets import (
     FileDisplay, FileUpload, Image)
 

main/waeup.kofa/trunk/src/waeup/kofa/students/fileviewlets.py

@@ -28 +28 @@
 from waeup.kofa.students.interfaces import IStudent, IStudentsUtils
 
+from waeup.kofa.browser.fileviewlets import (
+    FileDisplay, FileUpload, Image)
+
 from waeup.kofa.browser.layout import (
     default_filedisplay_template,
@@ -37 +40 @@
     ExportPDFClearanceSlipPage, StudentFilesUploadPage)
 
-from waeup.kofa.utils.helpers import get_fileformat
-
 grok.context(IKofaObject) # Make IKofaObject the default context
 grok.templatedir('browser_templates')
 
-ALLOWED_FILE_EXTENSIONS = ('jpg', 'png', 'pdf', 'tif', 'fpm')
+# File viewlet baseclasses for student base page
 
-def handle_file_delete(context, view, download_name):
-    """Handle deletion of student file.
-
-    """
-    store = getUtility(IExtFileStore)
-    store.deleteFileByContext(context, attr=download_name)
-    context.writeLogMessage(view, 'deleted: %s' % download_name)
-    view.flash(_('${a} deleted.', mapping = {'a':download_name}))
-    return
-
-def handle_file_upload(upload, context, view, max_size, download_name=None):
-    """Handle upload of student file.
-
-    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.
-    """
-    # Check some file requirements first
-    size = file_size(upload)
-    if size > max_size:
-        view.flash(_('Uploaded file is too big.'), type="danger")
-        return False
-    upload.seek(0) # file pointer moved when determining size
-    dummy,ext = os.path.splitext(upload.filename)
-    # fpm files are expected to be fingerprint minutiae, file
-    # format is not yet checked
-    if ext == '.fpm':
-        file_format = 'fpm'
-    else:
-        file_format = get_fileformat(None, upload.read(512))
-        upload.seek(0) # same here
-    if file_format is None:
-        view.flash(_('Could not determine file type.'), type="danger")
-        return False
-    basename, expected_ext = os.path.splitext(download_name)
-    if expected_ext:
-        if '.' + file_format != expected_ext:
-            view.flash(_('${a} file format expected.',
-                mapping = {'a':expected_ext[1:]}), type="danger")
-            return False
-    else:
-        if not file_format in ALLOWED_FILE_EXTENSIONS:
-            view.flash(
-                _('Only the following extensions are allowed: ${a}',
-                mapping = {'a':', '.join(ALLOWED_FILE_EXTENSIONS)}),
-                type="danger")
-            return False
-        download_name += '.' + file_format
-    store = getUtility(IExtFileStore)
-    file_id = IFileStoreNameChooser(context).chooseName(attr=download_name)
-    store.createFile(file_id, upload)
-    context.writeLogMessage(view, 'uploaded: %s (%s)' % (
-        download_name,upload.filename))
-    view.flash(_('File ${a} uploaded.', mapping = {'a':download_name}))
-    return True
-
-# File viewlets for student base page
-
-class FileManager(grok.ViewletManager):
-    """Viewlet manager for uploading files, preferably scanned images.
-    """
-    grok.name('files')
-
-class FileDisplay(grok.Viewlet):
+class StudentFileDisplay(FileDisplay):
     """Base file display viewlet.
     """
     grok.baseclass()
     grok.context(IStudent)
-    grok.viewletmanager(FileManager)
     grok.view(StudentClearanceDisplayFormPage)
-    template = default_filedisplay_template
     grok.order(1)
     grok.require('waeup.viewStudent')
-    label = _(u'File')
-    title = _(u'Scan')
 
-    @property
-    def download_filename(self):
-        return self.download_name
 
-    @property
-    def file_exists(self):
-        image = getUtility(IExtFileStore).getFileByContext(
-            self.context, attr=self.download_name)
-        if image:
-            return True
-        else:
-            return False
-
-class FileUpload(FileDisplay):
+class StudentFileUpload(FileUpload):
     """Base upload viewlet.
     """
     grok.baseclass()
     grok.context(IStudent)
-    grok.viewletmanager(FileManager)
     grok.view(StudentClearanceManageFormPage)
-    template = default_fileupload_template
     grok.require('waeup.uploadStudentFile')
-    tab_redirect = '#tab2-top'
-    mus = 1024 * 150
-    upload_button =_('Upload selected file')
-    delete_button = _('Delete')
 
     @property
@@ -155 +70 @@
         return True
 
-    @property
-    def input_name(self):
-        return "%s" % self.__name__
 
-    def update(self):
-        self.max_upload_size = string_from_bytes(self.mus)
-        delete_button = self.request.form.get(
-            'delete_%s' % self.input_name, None)
-        upload_button = self.request.form.get(
-            'upload_%s' % self.input_name, None)
-        if delete_button:
-            handle_file_delete(
-                context=self.context, view=self.view,
-                download_name=self.download_name)
-            self.view.redirect(
-                self.view.url(
-                    self.context, self.view.__name__) + self.tab_redirect)
-            return
-        if upload_button:
-            upload = self.request.form.get(self.input_name, None)
-            if upload:
-                # We got a fresh upload
-                handle_file_upload(upload,
-                    self.context, self.view, self.mus, self.download_name)
-                self.view.redirect(
-                    self.view.url(
-                        self.context, self.view.__name__) + self.tab_redirect)
-            else:
-                self.view.flash(_('No local file selected.'), type="danger")
-                self.view.redirect(
-                    self.view.url(
-                        self.context, self.view.__name__) + self.tab_redirect)
-        return
+class StudentImage(Image):
+    """Renders images for students.
+    """
+    grok.baseclass()
+    grok.context(IStudent)
+    grok.require('waeup.viewStudent')
 
-class PassportDisplay(FileDisplay):
+
+# File viewlets for student base page
+
+class PassportDisplay(StudentFileDisplay):
     """Passport display viewlet.
     """
@@ -200 +92 @@
     download_name = u'passport.jpg'
 
-class PassportUploadManage(FileUpload):
+
+class PassportUploadManage(StudentFileUpload):
     """Passport upload viewlet for officers.
     """
@@ -213 +106 @@
     tab_redirect = '#tab2'
 
+
 class PassportUploadEdit(PassportUploadManage):
     """Passport upload viewlet for students.
@@ -219 +113 @@
     grok.require('waeup.uploadStudentFile')
 
-class BirthCertificateDisplay(FileDisplay):
+
+class BirthCertificateDisplay(StudentFileDisplay):
     """Birth Certificate display viewlet.
     """
@@ -227 +122 @@
     download_name = u'birth_certificate'
 
+
 class BirthCertificateSlip(BirthCertificateDisplay):
     grok.view(ExportPDFClearanceSlipPage)
 
-class BirthCertificateUpload(FileUpload):
+
+class BirthCertificateUpload(StudentFileUpload):
     """Birth Certificate upload viewlet.
     """
@@ -240 +137 @@
     tab_redirect = '#tab2-top'
 
-class Image(grok.View):
-    """Renders images for students.
-    """
-    grok.baseclass()
-    grok.context(IStudent)
-    grok.require('waeup.viewStudent')
 
-    @property
-    def download_filename(self):
-        return self.download_name
-
-    def render(self):
-        # A filename chooser turns a context into a filename suitable
-        # for file storage.
-        image = getUtility(IExtFileStore).getFileByContext(
-            self.context, attr=self.download_name)
-        if image is None:
-            # show placeholder image
-            self.response.setHeader('Content-Type', 'image/jpeg')
-            return open(DEFAULT_IMAGE_PATH, 'rb').read()
-        dummy,ext = os.path.splitext(image.name)
-        if ext == '.jpg':
-            self.response.setHeader('Content-Type', 'image/jpeg')
-        elif ext == '.fpm':
-            self.response.setHeader('Content-Type', 'application/binary')
-        elif ext == '.png':
-            self.response.setHeader('Content-Type', 'image/png')
-        elif ext == '.tif':
-            self.response.setHeader('Content-Type', 'image/tiff')
-        elif ext == '.pdf':
-            self.response.setHeader('Content-Type', 'application/pdf')
-            self.response.setHeader('Content-Disposition',
-                'attachment; filename="%s.pdf' % self.download_filename)
-        return image
-
-class Passport(Image):
+class Passport(StudentImage):
     """Renders jpeg passport picture.
     """
@@ -282 +145 @@
     grok.context(IStudent)
 
-class ApplicationSlipImage(Image):
+
+class ApplicationSlipImage(StudentImage):
     """Renders application slip scan.
     """
@@ -288 +152 @@
     download_name = u'application_slip'
 
-class BirthCertificateImage(Image):
+
+class BirthCertificateImage(StudentImage):
     """Renders birth certificate scan.
     """

main/waeup.kofa/trunk/src/waeup/kofa/students/utils.py

@@ -281 +281 @@
     """
     # XXX: fix circular import problem
-    from waeup.kofa.students.fileviewlets import FileManager
+    from waeup.kofa.browser.fileviewlets import FileManager
     from waeup.kofa.browser import DEFAULT_IMAGE_PATH
     style = getSampleStyleSheet()