Changeset 12421

Timestamp:

8 Jan 2015, 11:59:47 (10 years ago)

Author:

Henrik Bettermann

Message:

Split viewlets module like in Ikoba.

Location:

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

Files:

• fileviewlets.py (added)
• utils.py (modified) (1 diff)
• viewlets.py (modified) (3 diffs)

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

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

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

@@ -16 +16 @@
 ## Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
 ##
-import os
 import grok
 from zope.component import getUtility
 from zope.interface import Interface
 from zope.i18n import translate
-from waeup.kofa.interfaces import (
-    IKofaObject, IExtFileStore, IFileStoreNameChooser)
+from waeup.kofa.interfaces import IExtFileStore, IKofaObject
 from waeup.kofa.interfaces import MessageFactory as _
-from waeup.kofa.utils.helpers import string_from_bytes, file_size
-from waeup.kofa.browser import DEFAULT_IMAGE_PATH
 from waeup.kofa.browser.viewlets import (
     PrimaryNavTab, ManageActionButton, AddActionButton)
-from waeup.kofa.browser.layout import (
-    default_primary_nav_template, default_filedisplay_template,
-    default_fileupload_template)
+from waeup.kofa.browser.layout import default_primary_nav_template
 from waeup.kofa.students.workflow import (
     ADMITTED, PAID, REQUESTED, RETURNING, CLEARED, REGISTERED,
     VALIDATED, GRADUATED, TRANSCRIPT)
 from waeup.kofa.students.browser import (
-    StudentClearanceManageFormPage,
-    StudentBaseManageFormPage, StudentFilesUploadPage,
-    ExportPDFClearanceSlipPage, StudentsContainerPage,
+    StudentsContainerPage,
     StudentsContainerManagePage, StudentBaseDisplayFormPage,
     StudentClearanceDisplayFormPage, StudentPersonalDisplayFormPage,
@@ -50 +42 @@
     IStudentPaymentsContainer, IStudentsUtils
     )
-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')
 
 class StudentManageSidebar(grok.ViewletManager):
@@ -804 +794 @@
             ]
         return targets
-
-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
-
-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.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')
-    download_name = u'filename.jpg'
-
-    @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):
-    """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
-    def show_viewlet(self):
-        students_utils = getUtility(IStudentsUtils)
-        if self.__name__ in students_utils.SKIP_UPLOAD_VIEWLETS:
-            return False
-        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 PassportDisplay(FileDisplay):
-    """Passport display viewlet.
-    """
-    grok.order(1)
-    grok.context(IStudent)
-    grok.view(StudentBaseDisplayFormPage)
-    grok.require('waeup.viewStudent')
-    grok.template('imagedisplay')
-    label = _(u'Passport Picture')
-    download_name = u'passport.jpg'
-
-class PassportUploadManage(FileUpload):
-    """Passport upload viewlet for officers.
-    """
-    grok.order(1)
-    grok.context(IStudent)
-    grok.view(StudentBaseManageFormPage)
-    grok.require('waeup.manageStudent')
-    grok.template('imageupload')
-    label = _(u'Passport Picture (jpg only)')
-    mus = 1024 * 50
-    download_name = u'passport.jpg'
-    tab_redirect = '#tab2'
-
-class PassportUploadEdit(PassportUploadManage):
-    """Passport upload viewlet for students.
-    """
-    grok.view(StudentFilesUploadPage)
-    grok.require('waeup.uploadStudentFile')
-
-class BirthCertificateDisplay(FileDisplay):
-    """Birth Certificate display viewlet.
-    """
-    grok.order(1)
-    label = _(u'Birth Certificate')
-    title = _(u'Birth Certificate Scan')
-    download_name = u'birth_certificate'
-
-class BirthCertificateSlip(BirthCertificateDisplay):
-    grok.view(ExportPDFClearanceSlipPage)
-
-class BirthCertificateUpload(FileUpload):
-    """Birth Certificate upload viewlet.
-    """
-    grok.order(1)
-    label = _(u'Birth Certificate')
-    title = _(u'Birth Certificate Scan')
-    mus = 1024 * 150
-    download_name = u'birth_certificate'
-    tab_redirect = '#tab2-top'
-
-class Image(grok.View):
-    """Renders images for students.
-    """
-    grok.baseclass()
-    grok.name('none.jpg')
-    grok.context(IStudent)
-    grok.require('waeup.viewStudent')
-    download_name = u'none.jpg'
-
-    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 == '.pdf':
-            self.response.setHeader('Content-Type', 'application/pdf')
-        elif ext == '.tif':
-            self.response.setHeader('Content-Type', 'image/tiff')
-        return image
-
-class Passport(Image):
-    """Renders jpeg passport picture.
-    """
-    grok.name('passport.jpg')
-    download_name = u'passport.jpg'
-    grok.context(IStudent)
-
-class ApplicationSlipImage(Image):
-    """Renders application slip scan.
-    """
-    grok.name('application_slip')
-    download_name = u'application_slip'
-
-class BirthCertificateImage(Image):
-    """Renders birth certificate scan.
-    """
-    grok.name('birth_certificate')
-    download_name = u'birth_certificate'