source: main/waeup.kofa/trunk/src/waeup/kofa/students/utils.py @ 10576

Last change on this file since 10576 was 10576, checked in by Henrik Bettermann, 11 years ago

Add browser components.
  • Property svn:keywords set to Id
File size: 33.3 KB
Line 
1## $Id: utils.py 10576 2013-09-02 06:42:16Z henrik $
2##
3## Copyright (C) 2011 Uli Fouquet & Henrik Bettermann
4## This program is free software; you can redistribute it and/or modify
5## it under the terms of the GNU General Public License as published by
6## the Free Software Foundation; either version 2 of the License, or
7## (at your option) any later version.
8##
9## This program is distributed in the hope that it will be useful,
10## but WITHOUT ANY WARRANTY; without even the implied warranty of
11## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12## GNU General Public License for more details.
13##
14## You should have received a copy of the GNU General Public License
15## along with this program; if not, write to the Free Software
16## Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17##
18"""General helper functions and utilities for the student section.
19"""
20import grok
21from time import time
22from reportlab.lib import colors
23from reportlab.lib.units import cm
24from reportlab.lib.pagesizes import A4
25from reportlab.lib.styles import getSampleStyleSheet
26from reportlab.platypus import Paragraph, Image, Table, Spacer
27from zope.schema.interfaces import ConstraintNotSatisfied
28from zope.component import getUtility, createObject
29from zope.formlib.form import setUpEditWidgets
30from zope.i18n import translate
31from waeup.kofa.interfaces import (
32    IExtFileStore, IKofaUtils, RETURNING, PAID, CLEARED,
33    academic_sessions_vocab)
34from waeup.kofa.interfaces import MessageFactory as _
35from waeup.kofa.students.interfaces import IStudentsUtils
36from waeup.kofa.browser.pdf import (
37    ENTRY1_STYLE, format_html, NOTE_STYLE, HEADING_STYLE,
38    get_signature_tables)
39from waeup.kofa.browser.interfaces import IPDFCreator
40from waeup.kofa.utils.helpers import to_timezone
41
42SLIP_STYLE = [
43    ('VALIGN',(0,0),(-1,-1),'TOP'),
44    #('FONT', (0,0), (-1,-1), 'Helvetica', 11),
45    ]
46
47CONTENT_STYLE = [
48    ('VALIGN',(0,0),(-1,-1),'TOP'),
49    #('FONT', (0,0), (-1,-1), 'Helvetica', 8),
50    #('TEXTCOLOR',(0,0),(-1,0),colors.white),
51    #('BACKGROUND',(0,0),(-1,0),colors.black),
52    ('INNERGRID', (0,0), (-1,-1), 0.25, colors.black),
53    ('BOX', (0,0), (-1,-1), 1, colors.black),
54
55    ]
56
57FONT_SIZE = 10
58FONT_COLOR = 'black'
59
60def trans(text, lang):
61    # shortcut
62    return translate(text, 'waeup.kofa', target_language=lang)
63
64def formatted_text(text, color=FONT_COLOR, lang='en'):
65    """Turn `text`, `color` and `size` into an HTML snippet.
66
67    The snippet is suitable for use with reportlab and generating PDFs.
68    Wraps the `text` into a ``<font>`` tag with passed attributes.
69
70    Also non-strings are converted. Raw strings are expected to be
71    utf-8 encoded (usually the case for widgets etc.).
72
73    Finally, a br tag is added if widgets contain div tags
74    which are not supported by reportlab.
75
76    The returned snippet is unicode type.
77    """
78    if not isinstance(text, unicode):
79        if isinstance(text, basestring):
80            text = text.decode('utf-8')
81        else:
82            text = unicode(text)
83    if text == 'None':
84        text = ''
85    # Mainly for boolean values we need our customized
86    # localisation of the zope domain
87    text = translate(text, 'zope', target_language=lang)
88    text = text.replace('</div>', '<br /></div>')
89    tag1 = u'<font color="%s">' % (color)
90    return tag1 + u'%s</font>' % text
91
92def generate_student_id():
93    students = grok.getSite()['students']
94    new_id = students.unique_student_id
95    return new_id
96
97def set_up_widgets(view, ignore_request=False):
98    view.adapters = {}
99    view.widgets = setUpEditWidgets(
100        view.form_fields, view.prefix, view.context, view.request,
101        adapters=view.adapters, for_display=True,
102        ignore_request=ignore_request
103        )
104
105def render_student_data(studentview, omit_fields=(), lang='en'):
106    """Render student table for an existing frame.
107    """
108    width, height = A4
109    set_up_widgets(studentview, ignore_request=True)
110    data_left = []
111    data_right = []
112    style = getSampleStyleSheet()
113    img = getUtility(IExtFileStore).getFileByContext(
114        studentview.context, attr='passport.jpg')
115    if img is None:
116        from waeup.kofa.browser import DEFAULT_PASSPORT_IMAGE_PATH
117        img = open(DEFAULT_PASSPORT_IMAGE_PATH, 'rb')
118    doc_img = Image(img.name, width=4*cm, height=4*cm, kind='bound')
119    data_left.append([doc_img])
120    #data.append([Spacer(1, 12)])
121
122    f_label = trans(_('Name:'), lang)
123    f_label = Paragraph(f_label, ENTRY1_STYLE)
124    f_text = formatted_text(studentview.context.display_fullname)
125    f_text = Paragraph(f_text, ENTRY1_STYLE)
126    data_right.append([f_label,f_text])
127
128    for widget in studentview.widgets:
129        if 'name' in widget.name:
130            continue
131        f_label = translate(
132            widget.label.strip(), 'waeup.kofa',
133            target_language=lang)
134        f_label = Paragraph('%s:' % f_label, ENTRY1_STYLE)
135        f_text = formatted_text(widget(), lang=lang)
136        f_text = Paragraph(f_text, ENTRY1_STYLE)
137        data_right.append([f_label,f_text])
138
139    if getattr(studentview.context, 'certcode', None):
140        if not 'certificate' in omit_fields:
141            f_label = trans(_('Study Course:'), lang)
142            f_label = Paragraph(f_label, ENTRY1_STYLE)
143            f_text = formatted_text(
144                studentview.context['studycourse'].certificate.longtitle())
145            f_text = Paragraph(f_text, ENTRY1_STYLE)
146            data_right.append([f_label,f_text])
147        if not 'department' in omit_fields:
148            f_label = trans(_('Department:'), lang)
149            f_label = Paragraph(f_label, ENTRY1_STYLE)
150            f_text = formatted_text(
151                studentview.context[
152                'studycourse'].certificate.__parent__.__parent__.longtitle(),
153                )
154            f_text = Paragraph(f_text, ENTRY1_STYLE)
155            data_right.append([f_label,f_text])
156        if not 'faculty' in omit_fields:
157            f_label = trans(_('Faculty:'), lang)
158            f_label = Paragraph(f_label, ENTRY1_STYLE)
159            f_text = formatted_text(
160                studentview.context[
161                'studycourse'].certificate.__parent__.__parent__.__parent__.longtitle(),
162                )
163            f_text = Paragraph(f_text, ENTRY1_STYLE)
164            data_right.append([f_label,f_text])
165        if not 'entry_session' in omit_fields:
166            f_label = trans(_('Entry Session:'), lang)
167            f_label = Paragraph(f_label, ENTRY1_STYLE)
168            entry_session = studentview.context['studycourse'].entry_session
169            entry_session = academic_sessions_vocab.getTerm(entry_session).title
170            f_text = formatted_text(entry_session)
171            f_text = Paragraph(f_text, ENTRY1_STYLE)
172            data_right.append([f_label,f_text])
173        if not 'date_of_birth' in omit_fields:
174            f_label = trans(_('Date of Birth:'), lang)
175            f_label = Paragraph(f_label, ENTRY1_STYLE)
176            date_of_birth = studentview.context.date_of_birth
177            tz = getUtility(IKofaUtils).tzinfo
178            date_of_birth = to_timezone(date_of_birth, tz)
179            if date_of_birth is not None:
180                date_of_birth = date_of_birth.strftime("%d/%m/%Y")
181            f_text = formatted_text(date_of_birth)
182            f_text = Paragraph(f_text, ENTRY1_STYLE)
183            data_right.append([f_label,f_text])
184
185    table_left = Table(data_left,style=SLIP_STYLE)
186    table_right = Table(data_right,style=SLIP_STYLE, colWidths=[5*cm, 6*cm])
187    table = Table([[table_left, table_right],],style=SLIP_STYLE)
188    return table
189
190def render_table_data(tableheader, tabledata, lang='en'):
191    """Render children table for an existing frame.
192    """
193    data = []
194    #data.append([Spacer(1, 12)])
195    line = []
196    style = getSampleStyleSheet()
197    for element in tableheader:
198        field = '<strong>%s</strong>' % formatted_text(element[0], lang=lang)
199        field = Paragraph(field, style["Normal"])
200        line.append(field)
201    data.append(line)
202    for ticket in tabledata:
203        line = []
204        for element in tableheader:
205              field = formatted_text(getattr(ticket,element[1],u' '))
206              field = Paragraph(field, style["Normal"])
207              line.append(field)
208        data.append(line)
209    table = Table(data,colWidths=[
210        element[2]*cm for element in tableheader], style=CONTENT_STYLE)
211    return table
212
213def render_transcript_data(view, tableheader, levels_data, lang='en'):
214    """Render children table for an existing frame.
215    """
216    data = []
217    style = getSampleStyleSheet()
218    for level in levels_data:
219        level_obj = level['level']
220        tickets = level['tickets_1'] + level['tickets_2'] + level['tickets_3']
221        headerline = []
222        tabledata = []
223        subheader = '%s %s, %s %s' % (
224            trans(_('Session'), lang),
225            view.session_dict[level_obj.level_session],
226            trans(_('Level'), lang),
227            view.level_dict[level_obj.level])
228        data.append(Paragraph(subheader, HEADING_STYLE))
229        for element in tableheader:
230            field = '<strong>%s</strong>' % formatted_text(element[0])
231            field = Paragraph(field, style["Normal"])
232            headerline.append(field)
233        tabledata.append(headerline)
234        for ticket in tickets:
235            ticketline = []
236            for element in tableheader:
237                  field = formatted_text(getattr(ticket,element[1],u' '))
238                  field = Paragraph(field, style["Normal"])
239                  ticketline.append(field)
240            tabledata.append(ticketline)
241        table = Table(tabledata,colWidths=[
242            element[2]*cm for element in tableheader], style=CONTENT_STYLE)
243        data.append(table)
244        sgpa = '%s: %s' % (trans('Sessional GPA (rectified)', lang), level['sgpa'])
245        data.append(Paragraph(sgpa, style["Normal"]))
246    return data
247
248def docs_as_flowables(view, lang='en'):
249    """Create reportlab flowables out of scanned docs.
250    """
251    # XXX: fix circular import problem
252    from waeup.kofa.students.viewlets import FileManager
253    from waeup.kofa.browser import DEFAULT_IMAGE_PATH
254    style = getSampleStyleSheet()
255    data = []
256
257    # Collect viewlets
258    fm = FileManager(view.context, view.request, view)
259    fm.update()
260    if fm.viewlets:
261        sc_translation = trans(_('Scanned Documents'), lang)
262        data.append(Paragraph(sc_translation, HEADING_STYLE))
263        # Insert list of scanned documents
264        table_data = []
265        for viewlet in fm.viewlets:
266            if viewlet.file_exists:
267                # Show viewlet only if file exists
268                f_label = Paragraph(trans(viewlet.label, lang), ENTRY1_STYLE)
269                img_path = getattr(getUtility(IExtFileStore).getFileByContext(
270                    view.context, attr=viewlet.download_name), 'name', None)
271                #f_text = Paragraph(trans(_('(not provided)'),lang), ENTRY1_STYLE)
272                if img_path is None:
273                    pass
274                elif not img_path[-4:] in ('.jpg', '.JPG'):
275                    # reportlab requires jpg images, I think.
276                    f_text = Paragraph('%s (not displayable)' % (
277                        viewlet.title,), ENTRY1_STYLE)
278                else:
279                    f_text = Image(img_path, width=2*cm, height=1*cm, kind='bound')
280                table_data.append([f_label, f_text])
281        if table_data:
282            # safety belt; empty tables lead to problems.
283            data.append(Table(table_data, style=SLIP_STYLE))
284    return data
285
286class StudentsUtils(grok.GlobalUtility):
287    """A collection of methods subject to customization.
288    """
289    grok.implements(IStudentsUtils)
290
291    def getReturningData(self, student):
292        """ Define what happens after school fee payment
293        depending on the student's senate verdict.
294
295        In the base configuration current level is always increased
296        by 100 no matter which verdict has been assigned.
297        """
298        new_level = student['studycourse'].current_level + 100
299        new_session = student['studycourse'].current_session + 1
300        return new_session, new_level
301
302    def setReturningData(self, student):
303        """ Define what happens after school fee payment
304        depending on the student's senate verdict.
305
306        This method folllows the same algorithm as getReturningData but
307        it also sets the new values.
308        """
309        new_session, new_level = self.getReturningData(student)
310        try:
311            student['studycourse'].current_level = new_level
312        except ConstraintNotSatisfied:
313            # Do not change level if level exceeds the
314            # certificate's end_level.
315            pass
316        student['studycourse'].current_session = new_session
317        verdict = student['studycourse'].current_verdict
318        student['studycourse'].current_verdict = '0'
319        student['studycourse'].previous_verdict = verdict
320        return
321
322    def _getSessionConfiguration(self, session):
323        try:
324            return grok.getSite()['configuration'][str(session)]
325        except KeyError:
326            return None
327
328    def setPaymentDetails(self, category, student,
329            previous_session, previous_level):
330        """Create Payment object and set the payment data of a student for
331        the payment category specified.
332
333        """
334        p_item = u''
335        amount = 0.0
336        if previous_session:
337            if previous_session < student['studycourse'].entry_session:
338                return _('The previous session must not fall below '
339                         'your entry session.'), None
340            if category == 'schoolfee':
341                # School fee is always paid for the following session
342                if previous_session > student['studycourse'].current_session:
343                    return _('This is not a previous session.'), None
344            else:
345                if previous_session > student['studycourse'].current_session - 1:
346                    return _('This is not a previous session.'), None
347            p_session = previous_session
348            p_level = previous_level
349            p_current = False
350        else:
351            p_session = student['studycourse'].current_session
352            p_level = student['studycourse'].current_level
353            p_current = True
354        academic_session = self._getSessionConfiguration(p_session)
355        if academic_session == None:
356            return _(u'Session configuration object is not available.'), None
357        # Determine fee.
358        if category == 'schoolfee':
359            try:
360                certificate = student['studycourse'].certificate
361                p_item = certificate.code
362            except (AttributeError, TypeError):
363                return _('Study course data are incomplete.'), None
364            if previous_session:
365                # Students can pay for previous sessions in all
366                # workflow states.  Fresh students are excluded by the
367                # update method of the PreviousPaymentAddFormPage.
368                if previous_level == 100:
369                    amount = getattr(certificate, 'school_fee_1', 0.0)
370                else:
371                    amount = getattr(certificate, 'school_fee_2', 0.0)
372            else:
373                if student.state == CLEARED:
374                    amount = getattr(certificate, 'school_fee_1', 0.0)
375                elif student.state == RETURNING:
376                    # In case of returning school fee payment the
377                    # payment session and level contain the values of
378                    # the session the student has paid for. Payment
379                    # session is always next session.
380                    p_session, p_level = self.getReturningData(student)
381                    academic_session = self._getSessionConfiguration(p_session)
382                    if academic_session == None:
383                        return _(
384                            u'Session configuration object is not available.'
385                            ), None
386                    amount = getattr(certificate, 'school_fee_2', 0.0)
387                elif student.is_postgrad and student.state == PAID:
388                    # Returning postgraduate students also pay for the
389                    # next session but their level always remains the
390                    # same.
391                    p_session += 1
392                    academic_session = self._getSessionConfiguration(p_session)
393                    if academic_session == None:
394                        return _(
395                            u'Session configuration object is not available.'
396                            ), None
397                    amount = getattr(certificate, 'school_fee_2', 0.0)
398        elif category == 'clearance':
399            try:
400                p_item = student['studycourse'].certificate.code
401            except (AttributeError, TypeError):
402                return _('Study course data are incomplete.'), None
403            amount = academic_session.clearance_fee
404        elif category == 'bed_allocation':
405            p_item = self.getAccommodationDetails(student)['bt']
406            amount = academic_session.booking_fee
407        elif category == 'hostel_maintenance':
408            amount = academic_session.maint_fee
409            bedticket = student['accommodation'].get(
410                str(student.current_session), None)
411            if bedticket:
412                p_item = bedticket.bed_coordinates
413            else:
414                # Should not happen because this is already checked
415                # in the browser module, but anyway ...
416                portal_language = getUtility(IKofaUtils).PORTAL_LANGUAGE
417                p_item = trans(_('no bed allocated'), portal_language)
418        elif category == 'transcript':
419            amount = academic_session.transcript_fee
420        if amount in (0.0, None):
421            return _('Amount could not be determined.'), None
422        for key in student['payments'].keys():
423            ticket = student['payments'][key]
424            if ticket.p_state == 'paid' and\
425               ticket.p_category == category and \
426               ticket.p_item == p_item and \
427               ticket.p_session == p_session:
428                  return _('This type of payment has already been made.'), None
429        payment = createObject(u'waeup.StudentOnlinePayment')
430        timestamp = ("%d" % int(time()*10000))[1:]
431        payment.p_id = "p%s" % timestamp
432        payment.p_category = category
433        payment.p_item = p_item
434        payment.p_session = p_session
435        payment.p_level = p_level
436        payment.p_current = p_current
437        payment.amount_auth = amount
438        return None, payment
439
440    def setBalanceDetails(self, category, student,
441            balance_session, balance_level, balance_amount):
442        """Create Payment object and set the payment data of a student for.
443
444        """
445        p_item = u'Balance'
446        p_session = balance_session
447        p_level = balance_level
448        p_current = False
449        amount = balance_amount
450        academic_session = self._getSessionConfiguration(p_session)
451        if academic_session == None:
452            return _(u'Session configuration object is not available.'), None
453        if amount in (0.0, None) or amount < 0:
454            return _('Amount must be greater than 0.'), None
455        for key in student['payments'].keys():
456            ticket = student['payments'][key]
457            if ticket.p_state == 'paid' and\
458               ticket.p_category == 'balance' and \
459               ticket.p_item == p_item and \
460               ticket.p_session == p_session:
461                  return _('This type of payment has already been made.'), None
462        payment = createObject(u'waeup.StudentOnlinePayment')
463        timestamp = ("%d" % int(time()*10000))[1:]
464        payment.p_id = "p%s" % timestamp
465        payment.p_category = category
466        payment.p_item = p_item
467        payment.p_session = p_session
468        payment.p_level = p_level
469        payment.p_current = p_current
470        payment.amount_auth = amount
471        return None, payment
472
473    def getAccommodationDetails(self, student):
474        """Determine the accommodation data of a student.
475        """
476        d = {}
477        d['error'] = u''
478        hostels = grok.getSite()['hostels']
479        d['booking_session'] = hostels.accommodation_session
480        d['allowed_states'] = hostels.accommodation_states
481        d['startdate'] = hostels.startdate
482        d['enddate'] = hostels.enddate
483        d['expired'] = hostels.expired
484        # Determine bed type
485        studycourse = student['studycourse']
486        certificate = getattr(studycourse,'certificate',None)
487        entry_session = studycourse.entry_session
488        current_level = studycourse.current_level
489        if None in (entry_session, current_level, certificate):
490            return d
491        end_level = certificate.end_level
492        if current_level == 10:
493            bt = 'pr'
494        elif entry_session == grok.getSite()['hostels'].accommodation_session:
495            bt = 'fr'
496        elif current_level >= end_level:
497            bt = 'fi'
498        else:
499            bt = 're'
500        if student.sex == 'f':
501            sex = 'female'
502        else:
503            sex = 'male'
504        special_handling = 'regular'
505        d['bt'] = u'%s_%s_%s' % (special_handling,sex,bt)
506        return d
507
508    def selectBed(self, available_beds):
509        """Select a bed from a list of available beds.
510
511        In the base configuration we select the first bed found,
512        but can also randomize the selection if we like.
513        """
514        return available_beds[0]
515
516    def _admissionText(self, student, portal_language):
517        inst_name = grok.getSite()['configuration'].name
518        text = trans(_(
519            'This is to inform you that you have been provisionally'
520            ' admitted into ${a} as follows:', mapping = {'a': inst_name}),
521            portal_language)
522        return text
523
524    def renderPDFAdmissionLetter(self, view, student=None, omit_fields=()):
525        """Render pdf admission letter.
526        """
527        if student is None:
528            return
529        style = getSampleStyleSheet()
530        creator = self.getPDFCreator(student)
531        portal_language = getUtility(IKofaUtils).PORTAL_LANGUAGE
532        data = []
533        doc_title = view.label
534        author = '%s (%s)' % (view.request.principal.title,
535                              view.request.principal.id)
536        footer_text = view.label.split('\n')
537        if len(footer_text) > 1:
538            # We can add a department in first line
539            footer_text = footer_text[1]
540        else:
541            # Only the first line is used for the footer
542            footer_text = footer_text[0]
543        if getattr(student, 'student_id', None) is not None:
544            footer_text = "%s - %s - " % (student.student_id, footer_text)
545
546        # Admission text
547        html = format_html(self._admissionText(student, portal_language))
548        data.append(Paragraph(html, NOTE_STYLE))
549        data.append(Spacer(1, 20))
550
551        # Student data
552        data.append(render_student_data(view, omit_fields, lang=portal_language))
553
554        # Insert history
555        data.append(Spacer(1, 20))
556        datelist = student.history.messages[0].split()[0].split('-')
557        creation_date = u'%s/%s/%s' % (datelist[2], datelist[1], datelist[0])
558        text = trans(_(
559            'Your Kofa student record was created on ${a}.',
560            mapping = {'a': creation_date}),
561            portal_language)
562        html = format_html(text)
563        data.append(Paragraph(html, NOTE_STYLE))
564
565        # Create pdf stream
566        view.response.setHeader(
567            'Content-Type', 'application/pdf')
568        pdf_stream = creator.create_pdf(
569            data, None, doc_title, author=author, footer=footer_text,
570            note=None)
571        return pdf_stream
572
573    def getPDFCreator(self, context):
574        """Get a pdf creator suitable for `context`.
575
576        The default implementation always returns the default creator.
577        """
578        return getUtility(IPDFCreator)
579
580    def renderPDF(self, view, filename='slip.pdf', student=None,
581                  studentview=None,
582                  tableheader=[], tabledata=[],
583                  note=None, signatures=None, sigs_in_footer=(),
584                  show_scans=True, topMargin=1.5,
585                  omit_fields=()):
586        """Render pdf slips for various pages.
587        """
588        portal_language = getUtility(IKofaUtils).PORTAL_LANGUAGE
589        # XXX: tell what the different parameters mean
590        style = getSampleStyleSheet()
591        creator = self.getPDFCreator(student)
592        data = []
593        doc_title = view.label
594        author = '%s (%s)' % (view.request.principal.title,
595                              view.request.principal.id)
596        footer_text = view.label.split('\n')
597        if len(footer_text) > 2:
598            # We can add a department in first line
599            footer_text = footer_text[1]
600        else:
601            # Only the first line is used for the footer
602            footer_text = footer_text[0]
603        if getattr(student, 'student_id', None) is not None:
604            footer_text = "%s - %s - " % (student.student_id, footer_text)
605
606        # Insert student data table
607        if student is not None:
608            bd_translation = trans(_('Base Data'), portal_language)
609            data.append(Paragraph(bd_translation, HEADING_STYLE))
610            data.append(render_student_data(
611                studentview, omit_fields, lang=portal_language))
612
613        # Insert widgets
614        if view.form_fields:
615            data.append(Paragraph(view.title, HEADING_STYLE))
616            separators = getattr(self, 'SEPARATORS_DICT', {})
617            table = creator.getWidgetsTable(
618                view.form_fields, view.context, None, lang=portal_language,
619                separators=separators)
620            data.append(table)
621
622        # Insert scanned docs
623        if show_scans:
624            data.extend(docs_as_flowables(view, portal_language))
625
626        # Insert history
627        if filename.startswith('clearance'):
628            hist_translation = trans(_('Workflow History'), portal_language)
629            data.append(Paragraph(hist_translation, HEADING_STYLE))
630            data.extend(creator.fromStringList(student.history.messages))
631
632        # Insert content tables (optionally on second page)
633        if hasattr(view, 'tabletitle'):
634            for i in range(len(view.tabletitle)):
635                if tabledata[i] and tableheader[i]:
636                    #data.append(PageBreak())
637                    #data.append(Spacer(1, 20))
638                    data.append(Paragraph(view.tabletitle[i], HEADING_STYLE))
639                    data.append(Spacer(1, 8))
640                    contenttable = render_table_data(tableheader[i],tabledata[i])
641                    data.append(contenttable)
642
643        # Insert signatures
644        # XXX: We are using only sigs_in_footer in waeup.kofa, so we
645        # do not have a test for the following lines.
646        if signatures and not sigs_in_footer:
647            data.append(Spacer(1, 20))
648            # Render one signature table per signature to
649            # get date and signature in line.
650            for signature in signatures:
651                signaturetables = get_signature_tables(signature)
652                data.append(signaturetables[0])
653
654        view.response.setHeader(
655            'Content-Type', 'application/pdf')
656        try:
657            pdf_stream = creator.create_pdf(
658                data, None, doc_title, author=author, footer=footer_text,
659                note=note, sigs_in_footer=sigs_in_footer, topMargin=topMargin)
660        except IOError:
661            view.flash('Error in image file.')
662            return view.redirect(view.url(view.context))
663        return pdf_stream
664
665    gpa_boundaries = (1, 1.5, 2.4, 3.5, 4.5, 5)
666
667    def getClassFromCGPA(self, gpa):
668        if gpa < self.gpa_boundaries[0]:
669            return 0, 'Fail'
670        if gpa < self.gpa_boundaries[1]:
671            return 1, 'Pass'
672        if gpa < self.gpa_boundaries[2]:
673            return 2, '3rd Class'
674        if gpa < self.gpa_boundaries[3]:
675            return 3, '2nd Class Lower'
676        if gpa < self.gpa_boundaries[4]:
677            return 4, '2nd Class Upper'
678        if gpa <= self.gpa_boundaries[5]:
679            return 5, '1st Class'
680        return 999, 'N/A'
681
682    def renderPDFTranscript(self, view, filename='transcript.pdf',
683                  student=None,
684                  studentview=None,
685                  note=None, signatures=None, sigs_in_footer=(),
686                  show_scans=True, topMargin=1.5,
687                  omit_fields=(),
688                  tableheader=None):
689        """Render pdf slips for transcript.
690        """
691        portal_language = getUtility(IKofaUtils).PORTAL_LANGUAGE
692        # XXX: tell what the different parameters mean
693        style = getSampleStyleSheet()
694        creator = self.getPDFCreator(student)
695        data = []
696        doc_title = view.label
697        author = '%s (%s)' % (view.request.principal.title,
698                              view.request.principal.id)
699        footer_text = view.label.split('\n')
700        if len(footer_text) > 2:
701            # We can add a department in first line
702            footer_text = footer_text[1]
703        else:
704            # Only the first line is used for the footer
705            footer_text = footer_text[0]
706        if getattr(student, 'student_id', None) is not None:
707            footer_text = "%s - %s - " % (student.student_id, footer_text)
708
709        # Insert student data table
710        if student is not None:
711            #bd_translation = trans(_('Base Data'), portal_language)
712            #data.append(Paragraph(bd_translation, HEADING_STYLE))
713            data.append(render_student_data(
714                studentview, omit_fields, lang=portal_language))
715
716
717        transcript_data = view.context.getTranscriptData()
718        levels_data = transcript_data[0]
719        gpa = transcript_data[1]
720
721        contextdata = []
722        f_label = trans(_('Course of Study:'), portal_language)
723        f_label = Paragraph(f_label, ENTRY1_STYLE)
724        f_text = formatted_text(view.context.certificate.longtitle())
725        f_text = Paragraph(f_text, ENTRY1_STYLE)
726        contextdata.append([f_label,f_text])
727
728        f_label = trans(_('Faculty:'), portal_language)
729        f_label = Paragraph(f_label, ENTRY1_STYLE)
730        f_text = formatted_text(
731            view.context.certificate.__parent__.__parent__.__parent__.longtitle())
732        f_text = Paragraph(f_text, ENTRY1_STYLE)
733        contextdata.append([f_label,f_text])
734
735        f_label = trans(_('Department:'), portal_language)
736        f_label = Paragraph(f_label, ENTRY1_STYLE)
737        f_text = formatted_text(
738            view.context.certificate.__parent__.__parent__.longtitle())
739        f_text = Paragraph(f_text, ENTRY1_STYLE)
740        contextdata.append([f_label,f_text])
741
742        f_label = trans(_('Entry Session:'), portal_language)
743        f_label = Paragraph(f_label, ENTRY1_STYLE)
744        f_text = formatted_text(
745            view.session_dict.get(view.context.entry_session))
746        f_text = Paragraph(f_text, ENTRY1_STYLE)
747        contextdata.append([f_label,f_text])
748
749        f_label = trans(_('Entry Mode:'), portal_language)
750        f_label = Paragraph(f_label, ENTRY1_STYLE)
751        f_text = formatted_text(view.studymode_dict.get(
752            view.context.entry_mode))
753        f_text = Paragraph(f_text, ENTRY1_STYLE)
754        contextdata.append([f_label,f_text])
755
756        f_label = trans(_('Cumulative GPA:'), portal_language)
757        f_label = Paragraph(f_label, ENTRY1_STYLE)
758        f_text = formatted_text('%s (%s)' % (gpa, self.getClassFromCGPA(gpa)[1]))
759        f_text = Paragraph(f_text, ENTRY1_STYLE)
760        contextdata.append([f_label,f_text])
761
762        contexttable = Table(contextdata,style=SLIP_STYLE)
763        data.append(contexttable)
764
765        transcripttables = render_transcript_data(
766            view, tableheader, levels_data, lang=portal_language)
767        data.extend(transcripttables)
768
769        # Insert signatures
770        # XXX: We are using only sigs_in_footer in waeup.kofa, so we
771        # do not have a test for the following lines.
772        if signatures and not sigs_in_footer:
773            data.append(Spacer(1, 20))
774            # Render one signature table per signature to
775            # get date and signature in line.
776            for signature in signatures:
777                signaturetables = get_signature_tables(signature)
778                data.append(signaturetables[0])
779
780        view.response.setHeader(
781            'Content-Type', 'application/pdf')
782        try:
783            pdf_stream = creator.create_pdf(
784                data, None, doc_title, author=author, footer=footer_text,
785                note=note, sigs_in_footer=sigs_in_footer, topMargin=topMargin)
786        except IOError:
787            view.flash(_('Error in image file.'))
788            return view.redirect(view.url(view.context))
789        return pdf_stream
790
791    def maxCredits(self, studylevel):
792        """Return maximum credits.
793
794        In some universities maximum credits is not constant, it
795        depends on the student's study level.
796        """
797        return 50
798
799    def maxCreditsExceeded(self, studylevel, course):
800        max_credits = self.maxCredits(studylevel)
801        if max_credits and \
802            studylevel.total_credits + course.credits > max_credits:
803            return max_credits
804        return 0
805
806    def getBedCoordinates(self, bedticket):
807        """Return bed coordinates.
808
809        This method can be used to customize the display_coordinates
810        property method.
811        """
812        return bedticket.bed_coordinates
813
814    VERDICTS_DICT = {
815        '0': _('(not yet)'),
816        'A': 'Successful student',
817        'B': 'Student with carryover courses',
818        'C': 'Student on probation',
819        }
820
821    SEPARATORS_DICT = {
822        }
823
824    SKIP_UPLOAD_VIEWLETS = ()
825
826    #: A prefix used when generating new student ids. Each student id will
827    #: start with this string. The default is 'K' for ``Kofa``.
828    STUDENT_ID_PREFIX = u'K'
Note: See TracBrowser for help on using the repository browser.