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

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

Add option which allows students to select a desired hostel before booking accommodation.
  • Property svn:keywords set to Id
File size: 42.0 KB
Line 
1## $Id: utils.py 13457 2015-11-16 09:05: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:
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                # Should not happen because this is already checked
465                # in the browser module, but anyway ...
466                portal_language = getUtility(IKofaUtils).PORTAL_LANGUAGE
467                p_item = trans(_('no bed allocated'), portal_language)
468        elif category == 'transcript':
469            amount = academic_session.transcript_fee
470        elif category == 'late_registration':
471            amount = academic_session.late_registration_fee
472        if amount in (0.0, None):
473            return _('Amount could not be determined.'), None
474        if self.samePaymentMade(student, category, p_item, p_session):
475            return _('This type of payment has already been made.'), None
476        if self._isPaymentDisabled(p_session, category, student):
477            return _('Payment temporarily disabled.'), None
478        payment = createObject(u'waeup.StudentOnlinePayment')
479        timestamp = ("%d" % int(time()*10000))[1:]
480        payment.p_id = "p%s" % timestamp
481        payment.p_category = category
482        payment.p_item = p_item
483        payment.p_session = p_session
484        payment.p_level = p_level
485        payment.p_current = p_current
486        payment.amount_auth = amount
487        return None, payment
488
489    def setBalanceDetails(self, category, student,
490            balance_session, balance_level, balance_amount):
491        """Create a balance payment ticket and set the payment data
492        as selected by the student.
493        """
494        p_item = u'Balance'
495        p_session = balance_session
496        p_level = balance_level
497        p_current = False
498        amount = balance_amount
499        academic_session = self._getSessionConfiguration(p_session)
500        if academic_session == None:
501            return _(u'Session configuration object is not available.'), None
502        if amount in (0.0, None) or amount < 0:
503            return _('Amount must be greater than 0.'), None
504        if self.samePaymentMade(student, 'balance', p_item, p_session):
505            return _('This type of payment has already been made.'), None
506        payment = createObject(u'waeup.StudentOnlinePayment')
507        timestamp = ("%d" % int(time()*10000))[1:]
508        payment.p_id = "p%s" % timestamp
509        payment.p_category = category
510        payment.p_item = p_item
511        payment.p_session = p_session
512        payment.p_level = p_level
513        payment.p_current = p_current
514        payment.amount_auth = amount
515        return None, payment
516
517    def increaseMatricInteger(self, student):
518        """Increase counter for matric numbers.
519        This counter can be a centrally stored attribute or an attribute of
520        faculties, departments or certificates. In the base package the counter
521        is as an attribute of the site configuration container.
522        """
523        grok.getSite()['configuration'].next_matric_integer += 1
524        return
525
526    def constructMatricNumber(self, student):
527        """Fetch the matric number counter which fits the student and
528        construct the new matric number of the student.
529        In the base package the counter is returned which is as an attribute
530        of the site configuration container.
531        """
532        next_integer = grok.getSite()['configuration'].next_matric_integer
533        if next_integer == 0:
534            return _('Matriculation number cannot be set.'), None
535        return None, unicode(next_integer)
536
537    def setMatricNumber(self, student):
538        """Set matriculation number of student. If the student's matric number
539        is unset a new matric number is
540        constructed according to the matriculation number construction rules
541        defined in the `constructMatricNumber` method. The new matric number is
542        set, the students catalog updated. The corresponding matric number
543        counter is increased by one.
544
545        This method is tested but not used in the base package. It can
546        be used in custom packages by adding respective views
547        and by customizing `increaseMatricInteger` and `constructMatricNumber`
548        according to the university's matriculation number construction rules.
549
550        The method can be disabled by setting the counter to zero.
551        """
552        if student.matric_number is not None:
553            return _('Matriculation number already set.'), None
554        if student.certcode is None:
555            return _('No certificate assigned.'), None
556        error, matric_number = self.constructMatricNumber(student)
557        if error:
558            return error, None
559        try:
560            student.matric_number = matric_number
561        except MatNumNotInSource:
562            return _('Matriculation number %s exists.' % matric_number), None
563        notify(grok.ObjectModifiedEvent(student))
564        self.increaseMatricInteger(student)
565        return None, matric_number
566
567    def getAccommodationDetails(self, student):
568        """Determine the accommodation data of a student.
569        """
570        d = {}
571        d['error'] = u''
572        hostels = grok.getSite()['hostels']
573        d['booking_session'] = hostels.accommodation_session
574        d['allowed_states'] = hostels.accommodation_states
575        d['startdate'] = hostels.startdate
576        d['enddate'] = hostels.enddate
577        d['expired'] = hostels.expired
578        # Determine bed type
579        studycourse = student['studycourse']
580        certificate = getattr(studycourse,'certificate',None)
581        entry_session = studycourse.entry_session
582        current_level = studycourse.current_level
583        if None in (entry_session, current_level, certificate):
584            return d
585        end_level = certificate.end_level
586        if current_level == 10:
587            bt = 'pr'
588        elif entry_session == grok.getSite()['hostels'].accommodation_session:
589            bt = 'fr'
590        elif current_level >= end_level:
591            bt = 'fi'
592        else:
593            bt = 're'
594        if student.sex == 'f':
595            sex = 'female'
596        else:
597            sex = 'male'
598        special_handling = 'regular'
599        d['bt'] = u'%s_%s_%s' % (special_handling,sex,bt)
600        return d
601
602    def checkAccommodationRequirements(self, student, acc_details):
603        if acc_details.get('expired', False):
604            startdate = acc_details.get('startdate')
605            enddate = acc_details.get('enddate')
606            if startdate and enddate:
607                tz = getUtility(IKofaUtils).tzinfo
608                startdate = to_timezone(
609                    startdate, tz).strftime("%d/%m/%Y %H:%M:%S")
610                enddate = to_timezone(
611                    enddate, tz).strftime("%d/%m/%Y %H:%M:%S")
612                return _("Outside booking period: ${a} - ${b}",
613                         mapping = {'a': startdate, 'b': enddate})
614            else:
615                return _("Outside booking period.")
616        if not acc_details.get('bt'):
617            return _("Your data are incomplete.")
618        if not student.state in acc_details['allowed_states']:
619            return _("You are in the wrong registration state.")
620        if student['studycourse'].current_session != acc_details[
621            'booking_session']:
622            return _('Your current session does not '
623                     'match accommodation session.')
624        if str(acc_details['booking_session']) in student['accommodation'].keys():
625            return _('You already booked a bed space in '
626                     'current accommodation session.')
627        return
628
629    def selectBed(self, available_beds, desired_hostel=None):
630        """Select a bed from a filtered list of available beds.
631        In the base configuration beds are sorted by the sort id
632        of the hostel and the bed number. The first bed found in
633        this sorted list is taken.
634        """
635        sorted_beds = sorted(available_beds,
636                key=lambda bed: 1000 * bed.__parent__.sort_id + bed.bed_number)
637        if desired_hostel:
638            # Filter desired hostel beds
639            filtered_beds = [bed for bed in sorted_beds
640                             if bed.bed_id.startswith(desired_hostel)]
641            if not filtered_beds:
642                return
643            return filtered_beds[0]
644        return sorted_beds[0]
645
646    def _admissionText(self, student, portal_language):
647        inst_name = grok.getSite()['configuration'].name
648        text = trans(_(
649            'This is to inform you that you have been provisionally'
650            ' admitted into ${a} as follows:', mapping = {'a': inst_name}),
651            portal_language)
652        return text
653
654    def renderPDFAdmissionLetter(self, view, student=None, omit_fields=(),
655                                 pre_text=None, post_text=None,):
656        """Render pdf admission letter.
657        """
658        if student is None:
659            return
660        style = getSampleStyleSheet()
661        creator = self.getPDFCreator(student)
662        portal_language = getUtility(IKofaUtils).PORTAL_LANGUAGE
663        data = []
664        doc_title = view.label
665        author = '%s (%s)' % (view.request.principal.title,
666                              view.request.principal.id)
667        footer_text = view.label.split('\n')
668        if len(footer_text) > 1:
669            # We can add a department in first line
670            footer_text = footer_text[1]
671        else:
672            # Only the first line is used for the footer
673            footer_text = footer_text[0]
674        if getattr(student, 'student_id', None) is not None:
675            footer_text = "%s - %s - " % (student.student_id, footer_text)
676
677        # Text before student data
678        if pre_text is None:
679            html = format_html(self._admissionText(student, portal_language))
680        else:
681            html = format_html(pre_text)
682        if html:
683            data.append(Paragraph(html, NOTE_STYLE))
684            data.append(Spacer(1, 20))
685
686        # Student data
687        data.append(render_student_data(view, student,
688                    omit_fields, lang=portal_language,
689                    slipname='admission_slip.pdf'))
690
691        # Text after student data
692        data.append(Spacer(1, 20))
693        if post_text is None:
694            datelist = student.history.messages[0].split()[0].split('-')
695            creation_date = u'%s/%s/%s' % (datelist[2], datelist[1], datelist[0])
696            post_text = trans(_(
697                'Your Kofa student record was created on ${a}.',
698                mapping = {'a': creation_date}),
699                portal_language)
700        #html = format_html(post_text)
701        #data.append(Paragraph(html, NOTE_STYLE))
702
703        # Create pdf stream
704        view.response.setHeader(
705            'Content-Type', 'application/pdf')
706        pdf_stream = creator.create_pdf(
707            data, None, doc_title, author=author, footer=footer_text,
708            note=post_text)
709        return pdf_stream
710
711    def getPDFCreator(self, context):
712        """Get a pdf creator suitable for `context`.
713        The default implementation always returns the default creator.
714        """
715        return getUtility(IPDFCreator)
716
717    def renderPDF(self, view, filename='slip.pdf', student=None,
718                  studentview=None,
719                  tableheader=[], tabledata=[],
720                  note=None, signatures=None, sigs_in_footer=(),
721                  show_scans=True, topMargin=1.5,
722                  omit_fields=()):
723        """Render pdf slips for various pages.
724        """
725        portal_language = getUtility(IKofaUtils).PORTAL_LANGUAGE
726        # XXX: tell what the different parameters mean
727        style = getSampleStyleSheet()
728        creator = self.getPDFCreator(student)
729        data = []
730        doc_title = view.label
731        author = '%s (%s)' % (view.request.principal.title,
732                              view.request.principal.id)
733        footer_text = view.label.split('\n')
734        if len(footer_text) > 1:
735            # We can add a department in first line, second line is used
736            footer_text = footer_text[1]
737        else:
738            # Only the first line is used for the footer
739            footer_text = footer_text[0]
740        if getattr(student, 'student_id', None) is not None:
741            footer_text = "%s - %s - " % (student.student_id, footer_text)
742
743        # Insert student data table
744        if student is not None:
745            bd_translation = trans(_('Base Data'), portal_language)
746            data.append(Paragraph(bd_translation, HEADING_STYLE))
747            data.append(render_student_data(
748                studentview, view.context, omit_fields, lang=portal_language,
749                slipname=filename))
750
751        # Insert widgets
752        if view.form_fields:
753            data.append(Paragraph(view.title, HEADING_STYLE))
754            separators = getattr(self, 'SEPARATORS_DICT', {})
755            table = creator.getWidgetsTable(
756                view.form_fields, view.context, None, lang=portal_language,
757                separators=separators)
758            data.append(table)
759
760        # Insert scanned docs
761        if show_scans:
762            data.extend(docs_as_flowables(view, portal_language))
763
764        # Insert history
765        if filename.startswith('clearance'):
766            hist_translation = trans(_('Workflow History'), portal_language)
767            data.append(Paragraph(hist_translation, HEADING_STYLE))
768            data.extend(creator.fromStringList(student.history.messages))
769
770        # Insert content tables (optionally on second page)
771        if hasattr(view, 'tabletitle'):
772            for i in range(len(view.tabletitle)):
773                if tabledata[i] and tableheader[i]:
774                    #data.append(PageBreak())
775                    #data.append(Spacer(1, 20))
776                    data.append(Paragraph(view.tabletitle[i], HEADING_STYLE))
777                    data.append(Spacer(1, 8))
778                    contenttable = render_table_data(tableheader[i],tabledata[i])
779                    data.append(contenttable)
780
781        # Insert signatures
782        # XXX: We are using only sigs_in_footer in waeup.kofa, so we
783        # do not have a test for the following lines.
784        if signatures and not sigs_in_footer:
785            data.append(Spacer(1, 20))
786            # Render one signature table per signature to
787            # get date and signature in line.
788            for signature in signatures:
789                signaturetables = get_signature_tables(signature)
790                data.append(signaturetables[0])
791
792        view.response.setHeader(
793            'Content-Type', 'application/pdf')
794        try:
795            pdf_stream = creator.create_pdf(
796                data, None, doc_title, author=author, footer=footer_text,
797                note=note, sigs_in_footer=sigs_in_footer, topMargin=topMargin)
798        except IOError:
799            view.flash('Error in image file.')
800            return view.redirect(view.url(view.context))
801        return pdf_stream
802
803    gpa_boundaries = ((1, 'Fail'),
804                      (1.5, 'Pass'),
805                      (2.4, '3rd Class'),
806                      (3.5, '2nd Class Lower'),
807                      (4.5, '2nd Class Upper'),
808                      (5, '1st Class'))
809
810    def getClassFromCGPA(self, gpa):
811        if gpa < self.gpa_boundaries[0][0]:
812            return 0, self.gpa_boundaries[0][1]
813        if gpa < self.gpa_boundaries[1][0]:
814            return 1, self.gpa_boundaries[1][1]
815        if gpa < self.gpa_boundaries[2][0]:
816            return 2, self.gpa_boundaries[2][1]
817        if gpa < self.gpa_boundaries[3][0]:
818            return 3, self.gpa_boundaries[3][1]
819        if gpa < self.gpa_boundaries[4][0]:
820            return 4, self.gpa_boundaries[4][1]
821        if gpa <= self.gpa_boundaries[5][0]:
822            return 5, self.gpa_boundaries[5][1]
823        return 'N/A'
824
825    def renderPDFTranscript(self, view, filename='transcript.pdf',
826                  student=None,
827                  studentview=None,
828                  note=None, signatures=None, sigs_in_footer=(),
829                  show_scans=True, topMargin=1.5,
830                  omit_fields=(),
831                  tableheader=None):
832        """Render pdf slips for transcripts.
833        """
834        portal_language = getUtility(IKofaUtils).PORTAL_LANGUAGE
835        # XXX: tell what the different parameters mean
836        style = getSampleStyleSheet()
837        creator = self.getPDFCreator(student)
838        data = []
839        doc_title = view.label
840        author = '%s (%s)' % (view.request.principal.title,
841                              view.request.principal.id)
842        footer_text = view.label.split('\n')
843        if len(footer_text) > 2:
844            # We can add a department in first line
845            footer_text = footer_text[1]
846        else:
847            # Only the first line is used for the footer
848            footer_text = footer_text[0]
849        if getattr(student, 'student_id', None) is not None:
850            footer_text = "%s - %s - " % (student.student_id, footer_text)
851
852        # Insert student data table
853        if student is not None:
854            #bd_translation = trans(_('Base Data'), portal_language)
855            #data.append(Paragraph(bd_translation, HEADING_STYLE))
856            data.append(render_student_data(
857                studentview, view.context,
858                omit_fields, lang=portal_language,
859                slipname=filename))
860
861        transcript_data = view.context.getTranscriptData()
862        levels_data = transcript_data[0]
863        gpa = transcript_data[1]
864
865        contextdata = []
866        f_label = trans(_('Course of Study:'), portal_language)
867        f_label = Paragraph(f_label, ENTRY1_STYLE)
868        f_text = formatted_text(view.context.certificate.longtitle)
869        f_text = Paragraph(f_text, ENTRY1_STYLE)
870        contextdata.append([f_label,f_text])
871
872        f_label = trans(_('Faculty:'), portal_language)
873        f_label = Paragraph(f_label, ENTRY1_STYLE)
874        f_text = formatted_text(
875            view.context.certificate.__parent__.__parent__.__parent__.longtitle)
876        f_text = Paragraph(f_text, ENTRY1_STYLE)
877        contextdata.append([f_label,f_text])
878
879        f_label = trans(_('Department:'), portal_language)
880        f_label = Paragraph(f_label, ENTRY1_STYLE)
881        f_text = formatted_text(
882            view.context.certificate.__parent__.__parent__.longtitle)
883        f_text = Paragraph(f_text, ENTRY1_STYLE)
884        contextdata.append([f_label,f_text])
885
886        f_label = trans(_('Entry Session:'), portal_language)
887        f_label = Paragraph(f_label, ENTRY1_STYLE)
888        f_text = formatted_text(
889            view.session_dict.get(view.context.entry_session))
890        f_text = Paragraph(f_text, ENTRY1_STYLE)
891        contextdata.append([f_label,f_text])
892
893        f_label = trans(_('Entry Mode:'), portal_language)
894        f_label = Paragraph(f_label, ENTRY1_STYLE)
895        f_text = formatted_text(view.studymode_dict.get(
896            view.context.entry_mode))
897        f_text = Paragraph(f_text, ENTRY1_STYLE)
898        contextdata.append([f_label,f_text])
899
900        f_label = trans(_('Cumulative GPA:'), portal_language)
901        f_label = Paragraph(f_label, ENTRY1_STYLE)
902        f_text = formatted_text('%s (%s)' % (gpa, self.getClassFromCGPA(gpa)[1]))
903        f_text = Paragraph(f_text, ENTRY1_STYLE)
904        contextdata.append([f_label,f_text])
905
906        contexttable = Table(contextdata,style=SLIP_STYLE)
907        data.append(contexttable)
908
909        transcripttables = render_transcript_data(
910            view, tableheader, levels_data, lang=portal_language)
911        data.extend(transcripttables)
912
913        # Insert signatures
914        # XXX: We are using only sigs_in_footer in waeup.kofa, so we
915        # do not have a test for the following lines.
916        if signatures and not sigs_in_footer:
917            data.append(Spacer(1, 20))
918            # Render one signature table per signature to
919            # get date and signature in line.
920            for signature in signatures:
921                signaturetables = get_signature_tables(signature)
922                data.append(signaturetables[0])
923
924        view.response.setHeader(
925            'Content-Type', 'application/pdf')
926        try:
927            pdf_stream = creator.create_pdf(
928                data, None, doc_title, author=author, footer=footer_text,
929                note=note, sigs_in_footer=sigs_in_footer, topMargin=topMargin)
930        except IOError:
931            view.flash(_('Error in image file.'))
932            return view.redirect(view.url(view.context))
933        return pdf_stream
934
935    def maxCredits(self, studylevel):
936        """Return maximum credits.
937        At some universities maximum credits is not constant, it
938        depends on the student's study level. Set `maxCredits` None or 0
939        in order to deactivate the limitation.
940        """
941        return 50
942
943    def maxCreditsExceeded(self, studylevel, course):
944        max_credits = self.maxCredits(studylevel)
945        if max_credits and \
946            studylevel.total_credits + course.credits > max_credits:
947            return max_credits
948        return 0
949
950    def getBedCoordinates(self, bedticket):
951        """Return descriptive bed coordinates.
952        This method can be used to customize the `display_coordinates`
953        property method in order to  display a
954        customary description of the bed space.
955        """
956        return bedticket.bed_coordinates
957
958    def clearance_disabled_message(self, student):
959        try:
960            session_config = grok.getSite()[
961                'configuration'][str(student.current_session)]
962        except KeyError:
963            return _('Session configuration object is not available.')
964        if not session_config.clearance_enabled:
965            return _('Clearance is disabled for this session.')
966        return None
967
968    #: A dictionary which maps widget names to headlines. The headline
969    #: is rendered in forms and on pdf slips above the respective
970    #: display or input widget. There are no separating headlines
971    #: in the base package.
972    SEPARATORS_DICT = {}
973
974    #: A tuple containing names of file upload viewlets which are not shown
975    #: on the `StudentClearanceManageFormPage`. Nothing is being skipped
976    #: in the base package. This attribute makes only sense, if intermediate
977    #: custom packages are being used, like we do for all Nigerian portals.
978    SKIP_UPLOAD_VIEWLETS = ()
979
980    #: A tuple containing the names of registration states in which changing of
981    #: passport pictures is allowed.
982    PORTRAIT_CHANGE_STATES = (ADMITTED,)
983
984    #: A tuple containing all exporter names referring to students or
985    #: subobjects thereof.
986    STUDENT_EXPORTER_NAMES = ('students', 'studentstudycourses',
987            'studentstudylevels', 'coursetickets',
988            'studentpayments', 'studentunpaidpayments',
989            'bedtickets', 'paymentsoverview',
990            'studylevelsoverview', 'combocard', 'bursary')
991
992    #: A tuple containing all exporter names needed for backing
993    #: up student data
994    STUDENT_BACKUP_EXPORTER_NAMES = ('students', 'studentstudycourses',
995            'studentstudylevels', 'coursetickets',
996            'studentpayments', 'bedtickets')
997
998    #: A prefix used when generating new student ids. Each student id will
999    #: start with this string. The default is 'K' for Kofa.
1000    STUDENT_ID_PREFIX = u'K'
Note: See TracBrowser for help on using the repository browser.