Changeset 9209 for main/waeup.kofa/branches/uli-zc-async/src/waeup/kofa/students/utils.py

Timestamp:

20 Sep 2012, 08:49:37 (12 years ago)

Author:

uli

Message:

Merge changes from update branch (includes trunk changes until r9107).

Location:

main/waeup.kofa/branches/uli-zc-async

Files:

• . (modified) (1 prop)
• src/waeup/kofa/students/utils.py (modified) (19 diffs)

main/waeup.kofa/branches/uli-zc-async/src/waeup/kofa/students/utils.py

@@ -19 +19 @@
 """
 import grok
-from random import SystemRandom as r
 from time import time
-from datetime import datetime
-from zope.i18n import translate
-from zope.component import getUtility, createObject
-from reportlab.pdfgen import canvas
 from reportlab.lib import colors
 from reportlab.lib.units import cm
-from reportlab.lib.enums import TA_RIGHT
 from reportlab.lib.pagesizes import A4
-from reportlab.lib.styles import getSampleStyleSheet, ParagraphStyle
-from reportlab.platypus import (Frame, Paragraph, Image, PageBreak, Table,
-                                Spacer)
-from reportlab.platypus.tables import TableStyle
-from reportlab.platypus.flowables import PageBreak
-from zope.component import getUtility
+from reportlab.lib.styles import getSampleStyleSheet
+from reportlab.platypus import Paragraph, Image, Table, Spacer
+from zope.component import getUtility, createObject
 from zope.formlib.form import setUpEditWidgets
-
+from zope.i18n import translate
 from waeup.kofa.interfaces import (
     IExtFileStore, IKofaUtils, RETURNING, PAID, CLEARED)
 from waeup.kofa.interfaces import MessageFactory as _
 from waeup.kofa.students.interfaces import IStudentsUtils
-from waeup.kofa.utils.helpers import now
 
 SLIP_STYLE = [
@@ -127 +117 @@
     #data.append([Spacer(1, 12)])
     portal_language = getUtility(IKofaUtils).PORTAL_LANGUAGE
+
+    f_label = formatted_label(size=12) % _('Name')
+    f_label = Paragraph(f_label, style["Normal"])
+    f_text = formatted_text(studentview.context.display_fullname, size=12)
+    f_text = Paragraph(f_text, style["Normal"])
+    data_right.append([f_label,f_text])
+
     for widget in studentview.widgets:
-        if widget.name == 'form.adm_code':
+        if 'name' in widget.name:
             continue
         f_label = formatted_label(size=12) % translate(
@@ -137 +134 @@
         f_text = Paragraph(f_text, style["Normal"])
         data_right.append([f_label,f_text])
+
+    if hasattr(studentview.context, 'certcode'):
+        f_label = formatted_label(size=12) % _('Study Course')
+        f_label = Paragraph(f_label, style["Normal"])
+        f_text = formatted_text(
+            studentview.context['studycourse'].certificate.longtitle(), size=12)
+        f_text = Paragraph(f_text, style["Normal"])
+        data_right.append([f_label,f_text])
+
+        f_label = formatted_label(size=12) % _('Department')
+        f_label = Paragraph(f_label, style["Normal"])
+        f_text = formatted_text(
+            studentview.context[
+            'studycourse'].certificate.__parent__.__parent__.longtitle(),
+            size=12)
+        f_text = Paragraph(f_text, style["Normal"])
+        data_right.append([f_label,f_text])
+
+        f_label = formatted_label(size=12) % _('Faculty')
+        f_label = Paragraph(f_label, style["Normal"])
+        f_text = formatted_text(
+            studentview.context[
+            'studycourse'].certificate.__parent__.__parent__.__parent__.longtitle(),
+            size=12)
+        f_text = Paragraph(f_text, style["Normal"])
+        data_right.append([f_label,f_text])
+
     table_left = Table(data_left,style=SLIP_STYLE)
     table_right = Table(data_right,style=SLIP_STYLE, colWidths=[5*cm, 6*cm])
@@ -165 +189 @@
     return table
 
+def get_signature_table(signatures, lang='en'):
+    """Return a reportlab table containing signature fields (with date).
+    """
+    style = getSampleStyleSheet()
+    space_width = 0.4  # width in cm of space between signatures
+    table_width = 16.0 # supposed width of signature table in cms
+    # width of signature cells in cm...
+    sig_col_width = table_width - ((len(signatures) - 1) * space_width)
+    sig_col_width = sig_col_width / len(signatures)
+    data = []
+    col_widths = [] # widths of columns
+
+    sig_style = [
+        ('VALIGN',(0,-1),(-1,-1),'TOP'),
+        ('FONT', (0,0), (-1,-1), 'Helvetica-BoldOblique', 12),
+        ('BOTTOMPADDING', (0,0), (-1,0), 36),
+        ('TOPPADDING', (0,-1), (-1,-1), 0),
+        ]
+    for num, elem in enumerate(signatures):
+        # draw a line above each signature cell (not: empty cells in between)
+        sig_style.append(
+            ('LINEABOVE', (num*2,-1), (num*2, -1), 1, colors.black))
+
+    row = []
+    for signature in signatures:
+        row.append(trans(_('Date:'), lang))
+        row.append('')
+        if len(signatures) > 1:
+            col_widths.extend([sig_col_width*cm, space_width*cm])
+        else:
+            col_widths.extend([sig_col_width/2*cm, sig_col_width/2*cm])
+            row.append('') # empty spaceholder on right
+    data.append(row[:-1])
+    data.extend(([''],)*3) # insert 3 empty rows...
+    row = []
+    for signature in signatures:
+        row.append(Paragraph(trans(signature, lang), style["Normal"]))
+        row.append('')
+    data.append(row[:-1])
+    table = Table(data, style=sig_style, repeatRows=len(data),
+                  colWidths=col_widths)
+    return table
+
 def docs_as_flowables(view, lang='en'):
     """Create reportlab flowables out of scanned docs.
@@ -190 +257 @@
             if img_path is None:
                 pass
-            elif not img_path.endswith('.jpg'):
+            elif not img_path[-4:] in ('.jpg', '.JPG'):
                 # reportlab requires jpg images, I think.
-                f_text = Paragraph('%s (Not displayable)' % (
+                f_text = Paragraph('%s (not displayable)' % (
                     viewlet.title,), ENTRY1_STYLE)
             else:
@@ -202 +269 @@
     return data
 
-def insert_footer(pdf,width,style,text=None, number_of_pages=1):
-      """Render the whole footer frame.
-      """
-      story = []
-      frame_footer = Frame(1*cm,0,width-(2*cm),1*cm)
-      tz = getUtility(IKofaUtils).tzinfo
-      timestamp = now(tz).strftime("%d/%m/%Y %H:%M:%S %Z")
-      left_text = '<font size=10>%s</font>' % timestamp
-      story.append(Paragraph(left_text, style["Normal"]))
-      frame_footer.addFromList(story,pdf)
-      story = []
-      frame_footer = Frame(1*cm,0,width-(2*cm),1*cm)
-      portal_language = getUtility(IKofaUtils).PORTAL_LANGUAGE
-      right_text = translate(_('<font size=10>${a} Page ${b} of ${c}</font>',
-          mapping = {'a':text, 'b':pdf.getPageNumber(), 'c':number_of_pages}),
-          'waeup.kofa', target_language=portal_language)
-      story.append(Paragraph(right_text, style["Right"]))
-      frame_footer.addFromList(story,pdf)
-
 class StudentsUtils(grok.GlobalUtility):
     """A collection of methods subject to customization.
@@ -227 +275 @@
 
     def getReturningData(self, student):
-        """ This method defines what happens after school fee payment
+        """ Define what happens after school fee payment
         depending on the student's senate verdict.
 
@@ -238 +286 @@
 
     def setReturningData(self, student):
-        """ This method defines what happens after school fee payment
-        depending on the student's senate verdict. It folllows
-        the same algorithm as getReturningData but it also sets the new
-        values
-
-        In the base configuration current level is always increased
-        by 100 no matter which verdict has been assigned.
+        """ Define what happens after school fee payment
+        depending on the student's senate verdict.
+
+        This method folllows the same algorithm as getReturningData but
+        it also sets the new values.
         """
         new_session, new_level = self.getReturningData(student)
@@ -250 +296 @@
         student['studycourse'].current_session = new_session
         verdict = student['studycourse'].current_verdict
-        student['studycourse'].current_verdict = 'NY'
+        student['studycourse'].current_verdict = '0'
         student['studycourse'].previous_verdict = verdict
         return
 
-    def setPaymentDetails(self, category, student):
+    def setPaymentDetails(self, category, student,
+            previous_session, previous_level):
         """Create Payment object and set the payment data of a student for
         the payment category specified.
 
         """
-        details = {}
         p_item = u''
         amount = 0.0
-        error = u''
-        p_session = student['studycourse'].current_session
-        p_level = student['studycourse'].current_level
+        if previous_session:
+            p_session = previous_session
+            p_level = previous_level
+            p_current = False
+        else:
+            p_session = student['studycourse'].current_session
+            p_level = student['studycourse'].current_level
+            p_current = True
         session = str(p_session)
         try:
@@ -276 +327 @@
             except (AttributeError, TypeError):
                 return _('Study course data are incomplete.'), None
-            if student.state == CLEARED:
-                amount = getattr(certificate, 'school_fee_1', 0.0)
-            elif student.state == RETURNING:
-                # In case of returning school fee payment the payment session
-                # and level contain the values of the session the student
-                # has paid for.
-                p_session, p_level = self.getReturningData(student)
-                amount = getattr(certificate, 'school_fee_2', 0.0)
-            elif student.is_postgrad and student.state == PAID:
-                # Returning postgraduate students also pay for the next session
-                # but their level always remains the same.
-                p_session += 1
-                amount = getattr(certificate, 'school_fee_2', 0.0)
+            if previous_session:
+                if previous_session < student['studycourse'].entry_session:
+                    return _('The previous session must not fall below '
+                             'your entry session.'), None
+                if previous_session > student['studycourse'].current_session - 1:
+                    return _('This is not a previous session.'), None
+                if previous_level == 100:
+                    amount = getattr(certificate, 'school_fee_1', 0.0)
+                else:
+                    amount = getattr(certificate, 'school_fee_2', 0.0)
+            else:
+                if student.state == CLEARED:
+                    amount = getattr(certificate, 'school_fee_1', 0.0)
+                elif student.state == RETURNING:
+                    # In case of returning school fee payment the payment session
+                    # and level contain the values of the session the student
+                    # has paid for.
+                    p_session, p_level = self.getReturningData(student)
+                    amount = getattr(certificate, 'school_fee_2', 0.0)
+                elif student.is_postgrad and student.state == PAID:
+                    # Returning postgraduate students also pay for the next session
+                    # but their level always remains the same.
+                    p_session += 1
+                    amount = getattr(certificate, 'school_fee_2', 0.0)
         elif category == 'clearance':
-            p_item = student['studycourse'].certificate.code
+            try:
+                p_item = student['studycourse'].certificate.code
+            except (AttributeError, TypeError):
+                return _('Study course data are incomplete.'), None
             amount = academic_session.clearance_fee
         elif category == 'bed_allocation':
@@ -296 +361 @@
             amount = academic_session.booking_fee
         if amount in (0.0, None):
-            return _(u'Amount could not be determined.'), None
+            return _('Amount could not be determined.' +
+                     ' Would you like to pay for a previous session?'), None
         for key in student['payments'].keys():
             ticket = student['payments'][key]
@@ -303 +369 @@
                ticket.p_item == p_item and \
                ticket.p_session == p_session:
-                  return _('This type of payment has already been made.'), None
+                  return _('This type of payment has already been made.' +
+                           ' Would you like to pay for a previous session?'), None
         payment = createObject(u'waeup.StudentOnlinePayment')
-        timestamp = "%d" % int(time()*1000)
+        timestamp = ("%d" % int(time()*10000))[1:]
         payment.p_id = "p%s" % timestamp
         payment.p_category = category
@@ -311 +378 @@
         payment.p_session = p_session
         payment.p_level = p_level
+        payment.p_current = p_current
         payment.amount_auth = amount
         return None, payment
@@ -330 +398 @@
         entry_session = studycourse.entry_session
         current_level = studycourse.current_level
-        if not (entry_session and current_level and certificate):
-            return
+        if None in (entry_session, current_level, certificate):
+            return d
         end_level = certificate.end_level
-        if entry_session == grok.getSite()['hostels'].accommodation_session:
+        if current_level == 10:
+            bt = 'pr'
+        elif entry_session == grok.getSite()['hostels'].accommodation_session:
             bt = 'fr'
         elif current_level >= end_level:
@@ -355 +425 @@
         return available_beds[0]
 
+    def renderPDFAdmissionLetter(self, view, student=None):
+        """Render pdf admission letter.
+        """
+        # XXX: we have to fix the import problems here.
+        from waeup.kofa.browser.interfaces import IPDFCreator
+        from waeup.kofa.browser.pdf import format_html, NOTE_STYLE
+        if student is None:
+            return
+        style = getSampleStyleSheet()
+        creator = getUtility(IPDFCreator)
+        data = []
+        doc_title = view.label
+        author = '%s (%s)' % (view.request.principal.title,
+                              view.request.principal.id)
+        footer_text = view.label
+        if getattr(student, 'student_id', None) is not None:
+            footer_text = "%s - %s - " % (student.student_id, footer_text)
+
+        # Admission text
+        portal_language = getUtility(IKofaUtils).PORTAL_LANGUAGE
+        inst_name = grok.getSite()['configuration'].name
+        text = trans(_(
+            'This is to inform you that you have been provisionally'
+            ' admitted into ${a} as follows:', mapping = {'a': inst_name}),
+            portal_language)
+        html = format_html(text)
+        data.append(Paragraph(html, NOTE_STYLE))
+        data.append(Spacer(1, 20))
+
+        # Student data
+        data.append(render_student_data(view))
+
+        # Insert history
+        data.append(Spacer(1, 20))
+        datelist = student.history.messages[0].split()[0].split('-')
+        creation_date = u'%s/%s/%s' % (datelist[2], datelist[1], datelist[0])
+        text = trans(_(
+            'Your Kofa student record was created on ${a}.',
+            mapping = {'a': creation_date}),
+            portal_language)
+        html = format_html(text)
+        data.append(Paragraph(html, NOTE_STYLE))
+
+        # Create pdf stream
+        view.response.setHeader(
+            'Content-Type', 'application/pdf')
+        pdf_stream = creator.create_pdf(
+            data, None, doc_title, author=author, footer=footer_text,
+            note=None)
+        return pdf_stream
+
     def renderPDF(self, view, filename='slip.pdf', student=None,
                   studentview=None, tableheader=None, tabledata=None,
-                  note=None):
+                  note=None, signatures=None):
         """Render pdf slips for various pages.
         """
@@ -373 +494 @@
             footer_text = "%s - %s - " % (student.student_id, footer_text)
 
+        # Insert history
+        if not filename.startswith('payment'):
+            data.extend(creator.fromStringList(student.history.messages))
+
         # Insert student data table
         portal_language = getUtility(IKofaUtils).PORTAL_LANGUAGE
@@ -381 +506 @@
 
         # Insert widgets
-        data.append(Paragraph(view.title, style["Heading3"]))
-        portal_language = getUtility(IKofaUtils).PORTAL_LANGUAGE
-        separators = getattr(self, 'SEPARATORS_DICT', {})
-        table = creator.getWidgetsTable(
-            view.form_fields, view.context, None, lang=portal_language,
-            separators=separators)
-        data.append(table)
+        if view.form_fields:
+            data.append(Paragraph(view.title, style["Heading3"]))
+            portal_language = getUtility(IKofaUtils).PORTAL_LANGUAGE
+            separators = getattr(self, 'SEPARATORS_DICT', {})
+            table = creator.getWidgetsTable(
+                view.form_fields, view.context, None, lang=portal_language,
+                separators=separators)
+            data.append(table)
 
         # Insert scanned docs
@@ -399 +525 @@
             contenttable = render_table_data(tableheader,tabledata)
             data.append(contenttable)
+
+        # Insert signatures
+        if signatures:
+            data.append(Spacer(1, 20))
+            signaturetable = get_signature_table(signatures)
+            data.append(signaturetable)
 
         view.response.setHeader(
@@ -412 +544 @@
 
     VERDICTS_DICT = {
-        'NY': _('(not yet)'),
+        '0': _('(not yet)'),
         'A': 'Successful student',
         'B': 'Student with carryover courses',