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

Last change on this file since 13505 was 13505, checked in by Henrik Bettermann, 9 years ago

Just return an error message.
  • Property svn:keywords set to Id
File size: 41.8 KB
Line 
1## $Id: utils.py 13505 2015-11-27 05:02:30Z 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 students 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.event import notify
28from zope.schema.interfaces import ConstraintNotSatisfied
29from zope.component import getUtility, createObject
30from zope.formlib.form import setUpEditWidgets
31from zope.i18n import translate
32from waeup.kofa.interfaces import (
33    IExtFileStore, IKofaUtils, RETURNING, PAID, CLEARED,
34    academic_sessions_vocab)
35from waeup.kofa.interfaces import MessageFactory as _
36from waeup.kofa.students.interfaces import IStudentsUtils
37from waeup.kofa.students.workflow import ADMITTED
38from waeup.kofa.students.vocabularies import StudyLevelSource, MatNumNotInSource
39from waeup.kofa.browser.pdf import (
40    ENTRY1_STYLE, format_html, NOTE_STYLE, HEADING_STYLE,
41    get_signature_tables, get_qrcode)
42from waeup.kofa.browser.interfaces import IPDFCreator
43from waeup.kofa.utils.helpers import to_timezone
44
45SLIP_STYLE = [
46    ('VALIGN',(0,0),(-1,-1),'TOP'),
47    #('FONT', (0,0), (-1,-1), 'Helvetica', 11),
48    ]
49
50CONTENT_STYLE = [
51    ('VALIGN',(0,0),(-1,-1),'TOP'),
52    #('FONT', (0,0), (-1,-1), 'Helvetica', 8),
53    #('TEXTCOLOR',(0,0),(-1,0),colors.white),
54    #('BACKGROUND',(0,0),(-1,0),colors.black),
55    ('INNERGRID', (0,0), (-1,-1), 0.25, colors.black),
56    ('BOX', (0,0), (-1,-1), 1, colors.black),
57
58    ]
59
60FONT_SIZE = 10
61FONT_COLOR = 'black'
62
63def trans(text, lang):
64    # shortcut
65    return translate(text, 'waeup.kofa', target_language=lang)
66
67def formatted_text(text, color=FONT_COLOR, lang='en'):
68    """Turn `text`, `color` and `size` into an HTML snippet.
69
70    The snippet is suitable for use with reportlab and generating PDFs.
71    Wraps the `text` into a ``<font>`` tag with passed attributes.
72
73    Also non-strings are converted. Raw strings are expected to be
74    utf-8 encoded (usually the case for widgets etc.).
75
76    Finally, a br tag is added if widgets contain div tags
77    which are not supported by reportlab.
78
79    The returned snippet is unicode type.
80    """
81    if not isinstance(text, unicode):
82        if isinstance(text, basestring):
83            text = text.decode('utf-8')
84        else:
85            text = unicode(text)
86    if text == 'None':
87        text = ''
88    # Mainly for boolean values we need our customized
89    # localisation of the zope domain
90    text = translate(text, 'zope', target_language=lang)
91    text = text.replace('</div>', '<br /></div>')
92    tag1 = u'<font color="%s">' % (color)
93    return tag1 + u'%s</font>' % text
94
95def generate_student_id():
96    students = grok.getSite()['students']
97    new_id = students.unique_student_id
98    return new_id
99
100def set_up_widgets(view, ignore_request=False):
101    view.adapters = {}
102    view.widgets = setUpEditWidgets(
103        view.form_fields, view.prefix, view.context, view.request,
104        adapters=view.adapters, for_display=True,
105        ignore_request=ignore_request
106        )
107
108def render_student_data(studentview, context, omit_fields=(),
109                        lang='en', slipname=None):
110    """Render student table for an existing frame.
111    """
112    width, height = A4
113    set_up_widgets(studentview, ignore_request=True)
114    data_left = []
115    data_middle = []
116    style = getSampleStyleSheet()
117    img = getUtility(IExtFileStore).getFileByContext(
118        studentview.context, attr='passport.jpg')
119    if img is None:
120        from waeup.kofa.browser import DEFAULT_PASSPORT_IMAGE_PATH
121        img = open(DEFAULT_PASSPORT_IMAGE_PATH, 'rb')
122    doc_img = Image(img.name, width=4*cm, height=4*cm, kind='bound')
123    data_left.append([doc_img])
124    #data.append([Spacer(1, 12)])
125
126    f_label = trans(_('Name:'), lang)
127    f_label = Paragraph(f_label, ENTRY1_STYLE)
128    f_text = formatted_text(studentview.context.display_fullname)
129    f_text = Paragraph(f_text, ENTRY1_STYLE)
130    data_middle.append([f_label,f_text])
131
132    for widget in studentview.widgets:
133        if 'name' in widget.name:
134            continue
135        f_label = translate(
136            widget.label.strip(), 'waeup.kofa',
137            target_language=lang)
138        f_label = Paragraph('%s:' % f_label, ENTRY1_STYLE)
139        f_text = formatted_text(widget(), lang=lang)
140        f_text = Paragraph(f_text, ENTRY1_STYLE)
141        data_middle.append([f_label,f_text])
142
143    if getattr(studentview.context, 'certcode', None):
144        if not 'certificate' in omit_fields:
145            f_label = trans(_('Study Course:'), lang)
146            f_label = Paragraph(f_label, ENTRY1_STYLE)
147            f_text = formatted_text(
148                studentview.context['studycourse'].certificate.longtitle)
149            f_text = Paragraph(f_text, ENTRY1_STYLE)
150            data_middle.append([f_label,f_text])
151        if not 'department' in omit_fields:
152            f_label = trans(_('Department:'), lang)
153            f_label = Paragraph(f_label, ENTRY1_STYLE)
154            f_text = formatted_text(
155                studentview.context[
156                'studycourse'].certificate.__parent__.__parent__.longtitle,
157                )
158            f_text = Paragraph(f_text, ENTRY1_STYLE)
159            data_middle.append([f_label,f_text])
160        if not 'faculty' in omit_fields:
161            f_label = trans(_('Faculty:'), lang)
162            f_label = Paragraph(f_label, ENTRY1_STYLE)
163            f_text = formatted_text(
164                studentview.context[
165                'studycourse'].certificate.__parent__.__parent__.__parent__.longtitle,
166                )
167            f_text = Paragraph(f_text, ENTRY1_STYLE)
168            data_middle.append([f_label,f_text])
169        if not 'current_mode' in omit_fields:
170            studymodes_dict = getUtility(IKofaUtils).STUDY_MODES_DICT
171            sm = studymodes_dict[studentview.context.current_mode]
172            f_label = trans(_('Study Mode:'), lang)
173            f_label = Paragraph(f_label, ENTRY1_STYLE)
174            f_text = formatted_text(sm)
175            f_text = Paragraph(f_text, ENTRY1_STYLE)
176            data_middle.append([f_label,f_text])
177        if not 'entry_session' in omit_fields:
178            f_label = trans(_('Entry Session:'), lang)
179            f_label = Paragraph(f_label, ENTRY1_STYLE)
180            entry_session = studentview.context.entry_session
181            entry_session = academic_sessions_vocab.getTerm(entry_session).title
182            f_text = formatted_text(entry_session)
183            f_text = Paragraph(f_text, ENTRY1_STYLE)
184            data_middle.append([f_label,f_text])
185        # Requested by Uniben, does not really make sense
186        if not 'current_level' in omit_fields:
187            f_label = trans(_('Current Level:'), lang)
188            f_label = Paragraph(f_label, ENTRY1_STYLE)
189            current_level = studentview.context['studycourse'].current_level
190            studylevelsource = StudyLevelSource().factory
191            current_level = studylevelsource.getTitle(
192                studentview.context, current_level)
193            f_text = formatted_text(current_level)
194            f_text = Paragraph(f_text, ENTRY1_STYLE)
195            data_middle.append([f_label,f_text])
196        if not 'date_of_birth' in omit_fields:
197            f_label = trans(_('Date of Birth:'), lang)
198            f_label = Paragraph(f_label, ENTRY1_STYLE)
199            date_of_birth = studentview.context.date_of_birth
200            tz = getUtility(IKofaUtils).tzinfo
201            date_of_birth = to_timezone(date_of_birth, tz)
202            if date_of_birth is not None:
203                date_of_birth = date_of_birth.strftime("%d/%m/%Y")
204            f_text = formatted_text(date_of_birth)
205            f_text = Paragraph(f_text, ENTRY1_STYLE)
206            data_middle.append([f_label,f_text])
207
208    # append QR code to the right
209    if slipname:
210        url = studentview.url(context, slipname)
211        data_right = [[get_qrcode(url, width=70.0)]]
212        table_right = Table(data_right,style=SLIP_STYLE)
213    else:
214        table_right = None
215
216    table_left = Table(data_left,style=SLIP_STYLE)
217    table_middle = Table(data_middle,style=SLIP_STYLE, colWidths=[5*cm, 5*cm])
218    table = Table([[table_left, table_middle, table_right],],style=SLIP_STYLE)
219    return table
220
221def render_table_data(tableheader, tabledata, lang='en'):
222    """Render children table for an existing frame.
223    """
224    data = []
225    #data.append([Spacer(1, 12)])
226    line = []
227    style = getSampleStyleSheet()
228    for element in tableheader:
229        field = '<strong>%s</strong>' % formatted_text(element[0], lang=lang)
230        field = Paragraph(field, style["Normal"])
231        line.append(field)
232    data.append(line)
233    for ticket in tabledata:
234        line = []
235        for element in tableheader:
236              field = formatted_text(getattr(ticket,element[1],u' '))
237              field = Paragraph(field, style["Normal"])
238              line.append(field)
239        data.append(line)
240    table = Table(data,colWidths=[
241        element[2]*cm for element in tableheader], style=CONTENT_STYLE)
242    return table
243
244def render_transcript_data(view, tableheader, levels_data, lang='en'):
245    """Render children table for an existing frame.
246    """
247    data = []
248    style = getSampleStyleSheet()
249    for level in levels_data:
250        level_obj = level['level']
251        tickets = level['tickets_1'] + level['tickets_2'] + level['tickets_3']
252        headerline = []
253        tabledata = []
254        subheader = '%s %s, %s %s' % (
255            trans(_('Session'), lang),
256            view.session_dict[level_obj.level_session],
257            trans(_('Level'), lang),
258            view.level_dict[level_obj.level])
259        data.append(Paragraph(subheader, HEADING_STYLE))
260        for element in tableheader:
261            field = '<strong>%s</strong>' % formatted_text(element[0])
262            field = Paragraph(field, style["Normal"])
263            headerline.append(field)
264        tabledata.append(headerline)
265        for ticket in tickets:
266            ticketline = []
267            for element in tableheader:
268                  field = formatted_text(getattr(ticket,element[1],u' '))
269                  field = Paragraph(field, style["Normal"])
270                  ticketline.append(field)
271            tabledata.append(ticketline)
272        table = Table(tabledata,colWidths=[
273            element[2]*cm for element in tableheader], style=CONTENT_STYLE)
274        data.append(table)
275        sgpa = '%s: %s' % (trans('Sessional GPA (rectified)', lang), level['sgpa'])
276        data.append(Paragraph(sgpa, style["Normal"]))
277    return data
278
279def docs_as_flowables(view, lang='en'):
280    """Create reportlab flowables out of scanned docs.
281    """
282    # XXX: fix circular import problem
283    from waeup.kofa.browser.fileviewlets import FileManager
284    from waeup.kofa.browser import DEFAULT_IMAGE_PATH
285    style = getSampleStyleSheet()
286    data = []
287
288    # Collect viewlets
289    fm = FileManager(view.context, view.request, view)
290    fm.update()
291    if fm.viewlets:
292        sc_translation = trans(_('Scanned Documents'), lang)
293        data.append(Paragraph(sc_translation, HEADING_STYLE))
294        # Insert list of scanned documents
295        table_data = []
296        for viewlet in fm.viewlets:
297            if viewlet.file_exists:
298                # Show viewlet only if file exists
299                f_label = Paragraph(trans(viewlet.label, lang), ENTRY1_STYLE)
300                img_path = getattr(getUtility(IExtFileStore).getFileByContext(
301                    view.context, attr=viewlet.download_name), 'name', None)
302                #f_text = Paragraph(trans(_('(not provided)'),lang), ENTRY1_STYLE)
303                if img_path is None:
304                    pass
305                elif not img_path[-4:] in ('.jpg', '.JPG'):
306                    # reportlab requires jpg images, I think.
307                    f_text = Paragraph('%s (not displayable)' % (
308                        viewlet.title,), ENTRY1_STYLE)
309                else:
310                    f_text = Image(img_path, width=2*cm, height=1*cm, kind='bound')
311                table_data.append([f_label, f_text])
312        if table_data:
313            # safety belt; empty tables lead to problems.
314            data.append(Table(table_data, style=SLIP_STYLE))
315    return data
316
317class StudentsUtils(grok.GlobalUtility):
318    """A collection of methods subject to customization.
319    """
320    grok.implements(IStudentsUtils)
321
322    def getReturningData(self, student):
323        """ Define what happens after school fee payment
324        depending on the student's senate verdict.
325        In the base configuration current level is always increased
326        by 100 no matter which verdict has been assigned.
327        """
328        new_level = student['studycourse'].current_level + 100
329        new_session = student['studycourse'].current_session + 1
330        return new_session, new_level
331
332    def setReturningData(self, student):
333        """ Define what happens after school fee payment
334        depending on the student's senate verdict.
335        This method folllows the same algorithm as `getReturningData` but
336        it also sets the new values.
337        """
338        new_session, new_level = self.getReturningData(student)
339        try:
340            student['studycourse'].current_level = new_level
341        except ConstraintNotSatisfied:
342            # Do not change level if level exceeds the
343            # certificate's end_level.
344            pass
345        student['studycourse'].current_session = new_session
346        verdict = student['studycourse'].current_verdict
347        student['studycourse'].current_verdict = '0'
348        student['studycourse'].previous_verdict = verdict
349        return
350
351    def _getSessionConfiguration(self, session):
352        try:
353            return grok.getSite()['configuration'][str(session)]
354        except KeyError:
355            return None
356
357    def _isPaymentDisabled(self, p_session, category, student):
358        academic_session = self._getSessionConfiguration(p_session)
359        if category == 'schoolfee' and \
360            'sf_all' in academic_session.payment_disabled:
361            return True
362        return False
363
364    def samePaymentMade(self, student, category, p_item, p_session):
365        for key in student['payments'].keys():
366            ticket = student['payments'][key]
367            if ticket.p_state == 'paid' and\
368               ticket.p_category == category and \
369               ticket.p_item == p_item and \
370               ticket.p_session == p_session:
371                  return True
372        return False
373
374    def setPaymentDetails(self, category, student,
375            previous_session, previous_level):
376        """Create a payment ticket and set the payment data of a
377        student for the payment category specified.
378        """
379        p_item = u''
380        amount = 0.0
381        if previous_session:
382            if previous_session < student['studycourse'].entry_session:
383                return _('The previous session must not fall below '
384                         'your entry session.'), None
385            if category == 'schoolfee':
386                # School fee is always paid for the following session
387                if previous_session > student['studycourse'].current_session:
388                    return _('This is not a previous session.'), None
389            else:
390                if previous_session > student['studycourse'].current_session - 1:
391                    return _('This is not a previous session.'), None
392            p_session = previous_session
393            p_level = previous_level
394            p_current = False
395        else:
396            p_session = student['studycourse'].current_session
397            p_level = student['studycourse'].current_level
398            p_current = True
399        academic_session = self._getSessionConfiguration(p_session)
400        if academic_session == None:
401            return _(u'Session configuration object is not available.'), None
402        # Determine fee.
403        if category == 'schoolfee':
404            try:
405                certificate = student['studycourse'].certificate
406                p_item = certificate.code
407            except (AttributeError, TypeError):
408                return _('Study course data are incomplete.'), None
409            if previous_session:
410                # Students can pay for previous sessions in all
411                # workflow states.  Fresh students are excluded by the
412                # update method of the PreviousPaymentAddFormPage.
413                if previous_level == 100:
414                    amount = getattr(certificate, 'school_fee_1', 0.0)
415                else:
416                    amount = getattr(certificate, 'school_fee_2', 0.0)
417            else:
418                if student.state == CLEARED:
419                    amount = getattr(certificate, 'school_fee_1', 0.0)
420                elif student.state == RETURNING:
421                    # In case of returning school fee payment the
422                    # payment session and level contain the values of
423                    # the session the student has paid for. Payment
424                    # session is always next session.
425                    p_session, p_level = self.getReturningData(student)
426                    academic_session = self._getSessionConfiguration(p_session)
427                    if academic_session == None:
428                        return _(
429                            u'Session configuration object is not available.'
430                            ), None
431                    amount = getattr(certificate, 'school_fee_2', 0.0)
432                elif student.is_postgrad and student.state == PAID:
433                    # Returning postgraduate students also pay for the
434                    # next session but their level always remains the
435                    # same.
436                    p_session += 1
437                    academic_session = self._getSessionConfiguration(p_session)
438                    if academic_session == None:
439                        return _(
440                            u'Session configuration object is not available.'
441                            ), None
442                    amount = getattr(certificate, 'school_fee_2', 0.0)
443        elif category == 'clearance':
444            try:
445                p_item = student['studycourse'].certificate.code
446            except (AttributeError, TypeError):
447                return _('Study course data are incomplete.'), None
448            amount = academic_session.clearance_fee
449        elif category == 'bed_allocation':
450            p_item = self.getAccommodationDetails(student)['bt']
451            amount = academic_session.booking_fee
452        elif category == 'hostel_maintenance':
453            amount = 0.0
454            bedticket = student['accommodation'].get(
455                str(student.current_session), None)
456            if bedticket is not None and bedticket.bed is not None:
457                p_item = bedticket.bed_coordinates
458                if bedticket.bed.__parent__.maint_fee > 0:
459                    amount = bedticket.bed.__parent__.maint_fee
460                else:
461                    # fallback
462                    amount = academic_session.maint_fee
463            else:
464                return _(u'No bed allocated.'), None
465        elif category == 'transcript':
466            amount = academic_session.transcript_fee
467        elif category == 'late_registration':
468            amount = academic_session.late_registration_fee
469        if amount in (0.0, None):
470            return _('Amount could not be determined.'), None
471        if self.samePaymentMade(student, category, p_item, p_session):
472            return _('This type of payment has already been made.'), None
473        if self._isPaymentDisabled(p_session, category, student):
474            return _('Payment temporarily disabled.'), None
475        payment = createObject(u'waeup.StudentOnlinePayment')
476        timestamp = ("%d" % int(time()*10000))[1:]
477        payment.p_id = "p%s" % timestamp
478        payment.p_category = category
479        payment.p_item = p_item
480        payment.p_session = p_session
481        payment.p_level = p_level
482        payment.p_current = p_current
483        payment.amount_auth = amount
484        return None, payment
485
486    def setBalanceDetails(self, category, student,
487            balance_session, balance_level, balance_amount):
488        """Create a balance payment ticket and set the payment data
489        as selected by the student.
490        """
491        p_item = u'Balance'
492        p_session = balance_session
493        p_level = balance_level
494        p_current = False
495        amount = balance_amount
496        academic_session = self._getSessionConfiguration(p_session)
497        if academic_session == None:
498            return _(u'Session configuration object is not available.'), None
499        if amount in (0.0, None) or amount < 0:
500            return _('Amount must be greater than 0.'), None
501        if self.samePaymentMade(student, 'balance', p_item, p_session):
502            return _('This type of payment has already been made.'), None
503        payment = createObject(u'waeup.StudentOnlinePayment')
504        timestamp = ("%d" % int(time()*10000))[1:]
505        payment.p_id = "p%s" % timestamp
506        payment.p_category = category
507        payment.p_item = p_item
508        payment.p_session = p_session
509        payment.p_level = p_level
510        payment.p_current = p_current
511        payment.amount_auth = amount
512        return None, payment
513
514    def increaseMatricInteger(self, student):
515        """Increase counter for matric numbers.
516        This counter can be a centrally stored attribute or an attribute of
517        faculties, departments or certificates. In the base package the counter
518        is as an attribute of the site configuration container.
519        """
520        grok.getSite()['configuration'].next_matric_integer += 1
521        return
522
523    def constructMatricNumber(self, student):
524        """Fetch the matric number counter which fits the student and
525        construct the new matric number of the student.
526        In the base package the counter is returned which is as an attribute
527        of the site configuration container.
528        """
529        next_integer = grok.getSite()['configuration'].next_matric_integer
530        if next_integer == 0:
531            return _('Matriculation number cannot be set.'), None
532        return None, unicode(next_integer)
533
534    def setMatricNumber(self, student):
535        """Set matriculation number of student. If the student's matric number
536        is unset a new matric number is
537        constructed according to the matriculation number construction rules
538        defined in the `constructMatricNumber` method. The new matric number is
539        set, the students catalog updated. The corresponding matric number
540        counter is increased by one.
541
542        This method is tested but not used in the base package. It can
543        be used in custom packages by adding respective views
544        and by customizing `increaseMatricInteger` and `constructMatricNumber`
545        according to the university's matriculation number construction rules.
546
547        The method can be disabled by setting the counter to zero.
548        """
549        if student.matric_number is not None:
550            return _('Matriculation number already set.'), None
551        if student.certcode is None:
552            return _('No certificate assigned.'), None
553        error, matric_number = self.constructMatricNumber(student)
554        if error:
555            return error, None
556        try:
557            student.matric_number = matric_number
558        except MatNumNotInSource:
559            return _('Matriculation number %s exists.' % matric_number), None
560        notify(grok.ObjectModifiedEvent(student))
561        self.increaseMatricInteger(student)
562        return None, matric_number
563
564    def getAccommodationDetails(self, student):
565        """Determine the accommodation data of a student.
566        """
567        d = {}
568        d['error'] = u''
569        hostels = grok.getSite()['hostels']
570        d['booking_session'] = hostels.accommodation_session
571        d['allowed_states'] = hostels.accommodation_states
572        d['startdate'] = hostels.startdate
573        d['enddate'] = hostels.enddate
574        d['expired'] = hostels.expired
575        # Determine bed type
576        studycourse = student['studycourse']
577        certificate = getattr(studycourse,'certificate',None)
578        entry_session = studycourse.entry_session
579        current_level = studycourse.current_level
580        if None in (entry_session, current_level, certificate):
581            return d
582        end_level = certificate.end_level
583        if current_level == 10:
584            bt = 'pr'
585        elif entry_session == grok.getSite()['hostels'].accommodation_session:
586            bt = 'fr'
587        elif current_level >= end_level:
588            bt = 'fi'
589        else:
590            bt = 're'
591        if student.sex == 'f':
592            sex = 'female'
593        else:
594            sex = 'male'
595        special_handling = 'regular'
596        d['bt'] = u'%s_%s_%s' % (special_handling,sex,bt)
597        return d
598
599    def checkAccommodationRequirements(self, student, acc_details):
600        if acc_details.get('expired', False):
601            startdate = acc_details.get('startdate')
602            enddate = acc_details.get('enddate')
603            if startdate and enddate:
604                tz = getUtility(IKofaUtils).tzinfo
605                startdate = to_timezone(
606                    startdate, tz).strftime("%d/%m/%Y %H:%M:%S")
607                enddate = to_timezone(
608                    enddate, tz).strftime("%d/%m/%Y %H:%M:%S")
609                return _("Outside booking period: ${a} - ${b}",
610                         mapping = {'a': startdate, 'b': enddate})
611            else:
612                return _("Outside booking period.")
613        if not acc_details.get('bt'):
614            return _("Your data are incomplete.")
615        if not student.state in acc_details['allowed_states']:
616            return _("You are in the wrong registration state.")
617        if student['studycourse'].current_session != acc_details[
618            'booking_session']:
619            return _('Your current session does not '
620                     'match accommodation session.')
621        if str(acc_details['booking_session']) in student['accommodation'].keys():
622            return _('You already booked a bed space in '
623                     'current accommodation session.')
624        return
625
626    def selectBed(self, available_beds, desired_hostel=None):
627        """Select a bed from a filtered list of available beds.
628        In the base configuration beds are sorted by the sort id
629        of the hostel and the bed number. The first bed found in
630        this sorted list is taken.
631        """
632        sorted_beds = sorted(available_beds,
633                key=lambda bed: 1000 * bed.__parent__.sort_id + bed.bed_number)
634        if desired_hostel:
635            # Filter desired hostel beds
636            filtered_beds = [bed for bed in sorted_beds
637                             if bed.bed_id.startswith(desired_hostel)]
638            if not filtered_beds:
639                return
640            return filtered_beds[0]
641        return sorted_beds[0]
642
643    def _admissionText(self, student, portal_language):
644        inst_name = grok.getSite()['configuration'].name
645        text = trans(_(
646            'This is to inform you that you have been provisionally'
647            ' admitted into ${a} as follows:', mapping = {'a': inst_name}),
648            portal_language)
649        return text
650
651    def renderPDFAdmissionLetter(self, view, student=None, omit_fields=(),
652                                 pre_text=None, post_text=None,):
653        """Render pdf admission letter.
654        """
655        if student is None:
656            return
657        style = getSampleStyleSheet()
658        creator = self.getPDFCreator(student)
659        portal_language = getUtility(IKofaUtils).PORTAL_LANGUAGE
660        data = []
661        doc_title = view.label
662        author = '%s (%s)' % (view.request.principal.title,
663                              view.request.principal.id)
664        footer_text = view.label.split('\n')
665        if len(footer_text) > 1:
666            # We can add a department in first line
667            footer_text = footer_text[1]
668        else:
669            # Only the first line is used for the footer
670            footer_text = footer_text[0]
671        if getattr(student, 'student_id', None) is not None:
672            footer_text = "%s - %s - " % (student.student_id, footer_text)
673
674        # Text before student data
675        if pre_text is None:
676            html = format_html(self._admissionText(student, portal_language))
677        else:
678            html = format_html(pre_text)
679        if html:
680            data.append(Paragraph(html, NOTE_STYLE))
681            data.append(Spacer(1, 20))
682
683        # Student data
684        data.append(render_student_data(view, student,
685                    omit_fields, lang=portal_language,
686                    slipname='admission_slip.pdf'))
687
688        # Text after student data
689        data.append(Spacer(1, 20))
690        if post_text is None:
691            datelist = student.history.messages[0].split()[0].split('-')
692            creation_date = u'%s/%s/%s' % (datelist[2], datelist[1], datelist[0])
693            post_text = trans(_(
694                'Your Kofa student record was created on ${a}.',
695                mapping = {'a': creation_date}),
696                portal_language)
697        #html = format_html(post_text)
698        #data.append(Paragraph(html, NOTE_STYLE))
699
700        # Create pdf stream
701        view.response.setHeader(
702            'Content-Type', 'application/pdf')
703        pdf_stream = creator.create_pdf(
704            data, None, doc_title, author=author, footer=footer_text,
705            note=post_text)
706        return pdf_stream
707
708    def getPDFCreator(self, context):
709        """Get a pdf creator suitable for `context`.
710        The default implementation always returns the default creator.
711        """
712        return getUtility(IPDFCreator)
713
714    def renderPDF(self, view, filename='slip.pdf', student=None,
715                  studentview=None,
716                  tableheader=[], tabledata=[],
717                  note=None, signatures=None, sigs_in_footer=(),
718                  show_scans=True, topMargin=1.5,
719                  omit_fields=()):
720        """Render pdf slips for various pages.
721        """
722        portal_language = getUtility(IKofaUtils).PORTAL_LANGUAGE
723        # XXX: tell what the different parameters mean
724        style = getSampleStyleSheet()
725        creator = self.getPDFCreator(student)
726        data = []
727        doc_title = view.label
728        author = '%s (%s)' % (view.request.principal.title,
729                              view.request.principal.id)
730        footer_text = view.label.split('\n')
731        if len(footer_text) > 1:
732            # We can add a department in first line, second line is used
733            footer_text = footer_text[1]
734        else:
735            # Only the first line is used for the footer
736            footer_text = footer_text[0]
737        if getattr(student, 'student_id', None) is not None:
738            footer_text = "%s - %s - " % (student.student_id, footer_text)
739
740        # Insert student data table
741        if student is not None:
742            bd_translation = trans(_('Base Data'), portal_language)
743            data.append(Paragraph(bd_translation, HEADING_STYLE))
744            data.append(render_student_data(
745                studentview, view.context, omit_fields, lang=portal_language,
746                slipname=filename))
747
748        # Insert widgets
749        if view.form_fields:
750            data.append(Paragraph(view.title, HEADING_STYLE))
751            separators = getattr(self, 'SEPARATORS_DICT', {})
752            table = creator.getWidgetsTable(
753                view.form_fields, view.context, None, lang=portal_language,
754                separators=separators)
755            data.append(table)
756
757        # Insert scanned docs
758        if show_scans:
759            data.extend(docs_as_flowables(view, portal_language))
760
761        # Insert history
762        if filename.startswith('clearance'):
763            hist_translation = trans(_('Workflow History'), portal_language)
764            data.append(Paragraph(hist_translation, HEADING_STYLE))
765            data.extend(creator.fromStringList(student.history.messages))
766
767        # Insert content tables (optionally on second page)
768        if hasattr(view, 'tabletitle'):
769            for i in range(len(view.tabletitle)):
770                if tabledata[i] and tableheader[i]:
771                    #data.append(PageBreak())
772                    #data.append(Spacer(1, 20))
773                    data.append(Paragraph(view.tabletitle[i], HEADING_STYLE))
774                    data.append(Spacer(1, 8))
775                    contenttable = render_table_data(tableheader[i],tabledata[i])
776                    data.append(contenttable)
777
778        # Insert signatures
779        # XXX: We are using only sigs_in_footer in waeup.kofa, so we
780        # do not have a test for the following lines.
781        if signatures and not sigs_in_footer:
782            data.append(Spacer(1, 20))
783            # Render one signature table per signature to
784            # get date and signature in line.
785            for signature in signatures:
786                signaturetables = get_signature_tables(signature)
787                data.append(signaturetables[0])
788
789        view.response.setHeader(
790            'Content-Type', 'application/pdf')
791        try:
792            pdf_stream = creator.create_pdf(
793                data, None, doc_title, author=author, footer=footer_text,
794                note=note, sigs_in_footer=sigs_in_footer, topMargin=topMargin)
795        except IOError:
796            view.flash('Error in image file.')
797            return view.redirect(view.url(view.context))
798        return pdf_stream
799
800    gpa_boundaries = ((1, 'Fail'),
801                      (1.5, 'Pass'),
802                      (2.4, '3rd Class'),
803                      (3.5, '2nd Class Lower'),
804                      (4.5, '2nd Class Upper'),
805                      (5, '1st Class'))
806
807    def getClassFromCGPA(self, gpa):
808        if gpa < self.gpa_boundaries[0][0]:
809            return 0, self.gpa_boundaries[0][1]
810        if gpa < self.gpa_boundaries[1][0]:
811            return 1, self.gpa_boundaries[1][1]
812        if gpa < self.gpa_boundaries[2][0]:
813            return 2, self.gpa_boundaries[2][1]
814        if gpa < self.gpa_boundaries[3][0]:
815            return 3, self.gpa_boundaries[3][1]
816        if gpa < self.gpa_boundaries[4][0]:
817            return 4, self.gpa_boundaries[4][1]
818        if gpa <= self.gpa_boundaries[5][0]:
819            return 5, self.gpa_boundaries[5][1]
820        return 'N/A'
821
822    def renderPDFTranscript(self, view, filename='transcript.pdf',
823                  student=None,
824                  studentview=None,
825                  note=None, signatures=None, sigs_in_footer=(),
826                  show_scans=True, topMargin=1.5,
827                  omit_fields=(),
828                  tableheader=None):
829        """Render pdf slips for transcripts.
830        """
831        portal_language = getUtility(IKofaUtils).PORTAL_LANGUAGE
832        # XXX: tell what the different parameters mean
833        style = getSampleStyleSheet()
834        creator = self.getPDFCreator(student)
835        data = []
836        doc_title = view.label
837        author = '%s (%s)' % (view.request.principal.title,
838                              view.request.principal.id)
839        footer_text = view.label.split('\n')
840        if len(footer_text) > 2:
841            # We can add a department in first line
842            footer_text = footer_text[1]
843        else:
844            # Only the first line is used for the footer
845            footer_text = footer_text[0]
846        if getattr(student, 'student_id', None) is not None:
847            footer_text = "%s - %s - " % (student.student_id, footer_text)
848
849        # Insert student data table
850        if student is not None:
851            #bd_translation = trans(_('Base Data'), portal_language)
852            #data.append(Paragraph(bd_translation, HEADING_STYLE))
853            data.append(render_student_data(
854                studentview, view.context,
855                omit_fields, lang=portal_language,
856                slipname=filename))
857
858        transcript_data = view.context.getTranscriptData()
859        levels_data = transcript_data[0]
860        gpa = transcript_data[1]
861
862        contextdata = []
863        f_label = trans(_('Course of Study:'), portal_language)
864        f_label = Paragraph(f_label, ENTRY1_STYLE)
865        f_text = formatted_text(view.context.certificate.longtitle)
866        f_text = Paragraph(f_text, ENTRY1_STYLE)
867        contextdata.append([f_label,f_text])
868
869        f_label = trans(_('Faculty:'), portal_language)
870        f_label = Paragraph(f_label, ENTRY1_STYLE)
871        f_text = formatted_text(
872            view.context.certificate.__parent__.__parent__.__parent__.longtitle)
873        f_text = Paragraph(f_text, ENTRY1_STYLE)
874        contextdata.append([f_label,f_text])
875
876        f_label = trans(_('Department:'), portal_language)
877        f_label = Paragraph(f_label, ENTRY1_STYLE)
878        f_text = formatted_text(
879            view.context.certificate.__parent__.__parent__.longtitle)
880        f_text = Paragraph(f_text, ENTRY1_STYLE)
881        contextdata.append([f_label,f_text])
882
883        f_label = trans(_('Entry Session:'), portal_language)
884        f_label = Paragraph(f_label, ENTRY1_STYLE)
885        f_text = formatted_text(
886            view.session_dict.get(view.context.entry_session))
887        f_text = Paragraph(f_text, ENTRY1_STYLE)
888        contextdata.append([f_label,f_text])
889
890        f_label = trans(_('Entry Mode:'), portal_language)
891        f_label = Paragraph(f_label, ENTRY1_STYLE)
892        f_text = formatted_text(view.studymode_dict.get(
893            view.context.entry_mode))
894        f_text = Paragraph(f_text, ENTRY1_STYLE)
895        contextdata.append([f_label,f_text])
896
897        f_label = trans(_('Cumulative GPA:'), portal_language)
898        f_label = Paragraph(f_label, ENTRY1_STYLE)
899        f_text = formatted_text('%s (%s)' % (gpa, self.getClassFromCGPA(gpa)[1]))
900        f_text = Paragraph(f_text, ENTRY1_STYLE)
901        contextdata.append([f_label,f_text])
902
903        contexttable = Table(contextdata,style=SLIP_STYLE)
904        data.append(contexttable)
905
906        transcripttables = render_transcript_data(
907            view, tableheader, levels_data, lang=portal_language)
908        data.extend(transcripttables)
909
910        # Insert signatures
911        # XXX: We are using only sigs_in_footer in waeup.kofa, so we
912        # do not have a test for the following lines.
913        if signatures and not sigs_in_footer:
914            data.append(Spacer(1, 20))
915            # Render one signature table per signature to
916            # get date and signature in line.
917            for signature in signatures:
918                signaturetables = get_signature_tables(signature)
919                data.append(signaturetables[0])
920
921        view.response.setHeader(
922            'Content-Type', 'application/pdf')
923        try:
924            pdf_stream = creator.create_pdf(
925                data, None, doc_title, author=author, footer=footer_text,
926                note=note, sigs_in_footer=sigs_in_footer, topMargin=topMargin)
927        except IOError:
928            view.flash(_('Error in image file.'))
929            return view.redirect(view.url(view.context))
930        return pdf_stream
931
932    def maxCredits(self, studylevel):
933        """Return maximum credits.
934        At some universities maximum credits is not constant, it
935        depends on the student's study level. Set `maxCredits` None or 0
936        in order to deactivate the limitation.
937        """
938        return 50
939
940    def maxCreditsExceeded(self, studylevel, course):
941        max_credits = self.maxCredits(studylevel)
942        if max_credits and \
943            studylevel.total_credits + course.credits > max_credits:
944            return max_credits
945        return 0
946
947    def getBedCoordinates(self, bedticket):
948        """Return descriptive bed coordinates.
949        This method can be used to customize the `display_coordinates`
950        property method in order to  display a
951        customary description of the bed space.
952        """
953        return bedticket.bed_coordinates
954
955    def clearance_disabled_message(self, student):
956        try:
957            session_config = grok.getSite()[
958                'configuration'][str(student.current_session)]
959        except KeyError:
960            return _('Session configuration object is not available.')
961        if not session_config.clearance_enabled:
962            return _('Clearance is disabled for this session.')
963        return None
964
965    #: A dictionary which maps widget names to headlines. The headline
966    #: is rendered in forms and on pdf slips above the respective
967    #: display or input widget. There are no separating headlines
968    #: in the base package.
969    SEPARATORS_DICT = {}
970
971    #: A tuple containing names of file upload viewlets which are not shown
972    #: on the `StudentClearanceManageFormPage`. Nothing is being skipped
973    #: in the base package. This attribute makes only sense, if intermediate
974    #: custom packages are being used, like we do for all Nigerian portals.
975    SKIP_UPLOAD_VIEWLETS = ()
976
977    #: A tuple containing the names of registration states in which changing of
978    #: passport pictures is allowed.
979    PORTRAIT_CHANGE_STATES = (ADMITTED,)
980
981    #: A tuple containing all exporter names referring to students or
982    #: subobjects thereof.
983    STUDENT_EXPORTER_NAMES = ('students', 'studentstudycourses',
984            'studentstudylevels', 'coursetickets',
985            'studentpayments', 'studentunpaidpayments',
986            'bedtickets', 'paymentsoverview',
987            'studylevelsoverview', 'combocard', 'bursary')
988
989    #: A tuple containing all exporter names needed for backing
990    #: up student data
991    STUDENT_BACKUP_EXPORTER_NAMES = ('students', 'studentstudycourses',
992            'studentstudylevels', 'coursetickets',
993            'studentpayments', 'bedtickets')
994
995    #: A prefix used when generating new student ids. Each student id will
996    #: start with this string. The default is 'K' for Kofa.
997    STUDENT_ID_PREFIX = u'K'
Note: See TracBrowser for help on using the repository browser.