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

Last change on this file since 9142 was 9141, checked in by Henrik Bettermann, 12 years ago

Adjust student base data section on slips. Display certificate code and full name.
  • Property svn:keywords set to Id
File size: 17.8 KB
Line 
1## $Id: utils.py 9141 2012-09-01 07:15:42Z henrik $
2##
3## Copyright (C) 2011 Uli Fouquet & Henrik Bettermann
4## This program is free software; you can redistribute it and/or modify
5## it under the terms of the GNU General Public License as published by
6## the Free Software Foundation; either version 2 of the License, or
7## (at your option) any later version.
8##
9## This program is distributed in the hope that it will be useful,
10## but WITHOUT ANY WARRANTY; without even the implied warranty of
11## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12## GNU General Public License for more details.
13##
14## You should have received a copy of the GNU General Public License
15## along with this program; if not, write to the Free Software
16## Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17##
18"""General helper functions and utilities for the student section.
19"""
20import grok
21from time import time
22from reportlab.lib import colors
23from reportlab.lib.units import cm
24from reportlab.lib.pagesizes import A4
25from reportlab.lib.styles import getSampleStyleSheet
26from reportlab.platypus import Paragraph, Image, Table, Spacer
27from zope.component import getUtility, createObject
28from zope.formlib.form import setUpEditWidgets
29from zope.i18n import translate
30from waeup.kofa.interfaces import (
31    IExtFileStore, IKofaUtils, RETURNING, PAID, CLEARED)
32from waeup.kofa.interfaces import MessageFactory as _
33from waeup.kofa.students.interfaces import IStudentsUtils
34
35SLIP_STYLE = [
36    ('VALIGN',(0,0),(-1,-1),'TOP'),
37    #('FONT', (0,0), (-1,-1), 'Helvetica', 11),
38    ]
39
40CONTENT_STYLE = [
41    ('VALIGN',(0,0),(-1,-1),'TOP'),
42    #('FONT', (0,0), (-1,-1), 'Helvetica', 8),
43    #('TEXTCOLOR',(0,0),(-1,0),colors.white),
44    ('BACKGROUND',(0,0),(-1,0),colors.black),
45    ]
46
47FONT_SIZE = 10
48FONT_COLOR = 'black'
49
50def formatted_label(color=FONT_COLOR, size=FONT_SIZE):
51    tag1 ='<font color=%s size=%d>' % (color, size)
52    return tag1 + '%s:</font>'
53
54def trans(text, lang):
55    # shortcut
56    return translate(text, 'waeup.kofa', target_language=lang)
57
58def formatted_text(text, color=FONT_COLOR, size=FONT_SIZE):
59    """Turn `text`, `color` and `size` into an HTML snippet.
60
61    The snippet is suitable for use with reportlab and generating PDFs.
62    Wraps the `text` into a ``<font>`` tag with passed attributes.
63
64    Also non-strings are converted. Raw strings are expected to be
65    utf-8 encoded (usually the case for widgets etc.).
66
67    Finally, a br tag is added if widgets contain div tags
68    which are not supported by reportlab.
69
70    The returned snippet is unicode type.
71    """
72    try:
73        # In unit tests IKofaUtils has not been registered
74        portal_language = getUtility(IKofaUtils).PORTAL_LANGUAGE
75    except:
76        portal_language = 'en'
77    if not isinstance(text, unicode):
78        if isinstance(text, basestring):
79            text = text.decode('utf-8')
80        else:
81            text = unicode(text)
82    # Mainly for boolean values we need our customized
83    # localisation of the zope domain
84    text = translate(text, 'zope', target_language=portal_language)
85    text = text.replace('</div>', '<br /></div>')
86    tag1 = u'<font color="%s" size="%d">' % (color, size)
87    return tag1 + u'%s</font>' % text
88
89def generate_student_id():
90    students = grok.getSite()['students']
91    new_id = students.unique_student_id
92    return new_id
93
94def set_up_widgets(view, ignore_request=False):
95    view.adapters = {}
96    view.widgets = setUpEditWidgets(
97        view.form_fields, view.prefix, view.context, view.request,
98        adapters=view.adapters, for_display=True,
99        ignore_request=ignore_request
100        )
101
102def render_student_data(studentview):
103    """Render student table for an existing frame.
104    """
105    width, height = A4
106    set_up_widgets(studentview, ignore_request=True)
107    data_left = []
108    data_right = []
109    style = getSampleStyleSheet()
110    img = getUtility(IExtFileStore).getFileByContext(
111        studentview.context, attr='passport.jpg')
112    if img is None:
113        from waeup.kofa.browser import DEFAULT_PASSPORT_IMAGE_PATH
114        img = open(DEFAULT_PASSPORT_IMAGE_PATH, 'rb')
115    doc_img = Image(img.name, width=4*cm, height=4*cm, kind='bound')
116    data_left.append([doc_img])
117    #data.append([Spacer(1, 12)])
118    portal_language = getUtility(IKofaUtils).PORTAL_LANGUAGE
119
120    f_label = formatted_label(size=12) % _('Name')
121    f_label = Paragraph(f_label, style["Normal"])
122    f_text = formatted_text(studentview.context.display_fullname, size=12)
123    f_text = Paragraph(f_text, style["Normal"])
124    data_right.append([f_label,f_text])
125
126    for widget in studentview.widgets:
127        if 'name' in widget.name:
128            continue
129        f_label = formatted_label(size=12) % translate(
130            widget.label.strip(), 'waeup.kofa',
131            target_language=portal_language)
132        f_label = Paragraph(f_label, style["Normal"])
133        f_text = formatted_text(widget(), size=12)
134        f_text = Paragraph(f_text, style["Normal"])
135        data_right.append([f_label,f_text])
136
137    if hasattr(studentview.context, 'certcode'):
138        f_label = formatted_label(size=12) % _('Study Course')
139        f_label = Paragraph(f_label, style["Normal"])
140        f_text = formatted_text(studentview.context.certcode, size=12)
141        f_text = Paragraph(f_text, style["Normal"])
142        data_right.append([f_label,f_text])
143
144    table_left = Table(data_left,style=SLIP_STYLE)
145    table_right = Table(data_right,style=SLIP_STYLE, colWidths=[5*cm, 6*cm])
146    table = Table([[table_left, table_right],],style=SLIP_STYLE)
147    return table
148
149def render_table_data(tableheader,tabledata):
150    """Render children table for an existing frame.
151    """
152    data = []
153    #data.append([Spacer(1, 12)])
154    line = []
155    style = getSampleStyleSheet()
156    for element in tableheader:
157        field = formatted_text(element[0], color='white')
158        field = Paragraph(field, style["Normal"])
159        line.append(field)
160    data.append(line)
161    for ticket in tabledata:
162        line = []
163        for element in tableheader:
164              field = formatted_text(getattr(ticket,element[1],u' '))
165              field = Paragraph(field, style["Normal"])
166              line.append(field)
167        data.append(line)
168    table = Table(data,colWidths=[
169        element[2]*cm for element in tableheader], style=CONTENT_STYLE)
170    return table
171
172def get_signature_table(signatures, lang='en'):
173    """Return a reportlab table containing signature fields (with date).
174    """
175    style = getSampleStyleSheet()
176    space_width = 0.4  # width in cm of space between signatures
177    table_width = 16.0 # supposed width of signature table in cms
178    # width of signature cells in cm...
179    sig_col_width = table_width - ((len(signatures) - 1) * space_width)
180    sig_col_width = sig_col_width / len(signatures)
181    data = []
182    col_widths = [] # widths of columns
183
184    sig_style = [
185        ('VALIGN',(0,-1),(-1,-1),'TOP'),
186        ('FONT', (0,0), (-1,-1), 'Helvetica-BoldOblique', 12),
187        ('BOTTOMPADDING', (0,0), (-1,0), 36),
188        ('TOPPADDING', (0,-1), (-1,-1), 0),
189        ]
190    for num, elem in enumerate(signatures):
191        # draw a line above each signature cell (not: empty cells in between)
192        sig_style.append(
193            ('LINEABOVE', (num*2,-1), (num*2, -1), 1, colors.black))
194
195    row = []
196    for signature in signatures:
197        row.append(trans(_('Date:'), lang))
198        row.append('')
199        if len(signatures) > 1:
200            col_widths.extend([sig_col_width*cm, space_width*cm])
201        else:
202            col_widths.extend([sig_col_width/2*cm, sig_col_width/2*cm])
203            row.append('') # empty spaceholder on right
204    data.append(row[:-1])
205    data.extend(([''],)*3) # insert 3 empty rows...
206    row = []
207    for signature in signatures:
208        row.append(Paragraph(trans(signature, lang), style["Normal"]))
209        row.append('')
210    data.append(row[:-1])
211    table = Table(data, style=sig_style, repeatRows=len(data),
212                  colWidths=col_widths)
213    return table
214
215def docs_as_flowables(view, lang='en'):
216    """Create reportlab flowables out of scanned docs.
217    """
218    # XXX: fix circular import problem
219    from waeup.kofa.students.viewlets import FileManager
220    from waeup.kofa.browser import DEFAULT_IMAGE_PATH
221    from waeup.kofa.browser.pdf import NORMAL_STYLE, ENTRY1_STYLE
222    style = getSampleStyleSheet()
223    data = []
224
225    # Collect viewlets
226    fm = FileManager(view.context, view.request, view)
227    fm.update()
228    if fm.viewlets:
229        sc_translation = trans(_('Scanned Documents'), lang)
230        data.append(Paragraph(sc_translation, style["Heading3"]))
231        # Insert list of scanned documents
232        table_data = []
233        for viewlet in fm.viewlets:
234            f_label = Paragraph(trans(viewlet.label, lang), ENTRY1_STYLE)
235            img_path = getattr(getUtility(IExtFileStore).getFileByContext(
236                view.context, attr=viewlet.download_name), 'name', None)
237            f_text = Paragraph(trans(_('(not provided)'),lang), ENTRY1_STYLE)
238            if img_path is None:
239                pass
240            elif not img_path[-4:] in ('.jpg', '.JPG'):
241                # reportlab requires jpg images, I think.
242                f_text = Paragraph('%s (not displayable)' % (
243                    viewlet.title,), ENTRY1_STYLE)
244            else:
245                f_text = Image(img_path, width=2*cm, height=1*cm, kind='bound')
246            table_data.append([f_label, f_text])
247        if table_data:
248            # safety belt; empty tables lead to problems.
249            data.append(Table(table_data, style=SLIP_STYLE))
250    return data
251
252class StudentsUtils(grok.GlobalUtility):
253    """A collection of methods subject to customization.
254    """
255    grok.implements(IStudentsUtils)
256
257    def getReturningData(self, student):
258        """ Define what happens after school fee payment
259        depending on the student's senate verdict.
260
261        In the base configuration current level is always increased
262        by 100 no matter which verdict has been assigned.
263        """
264        new_level = student['studycourse'].current_level + 100
265        new_session = student['studycourse'].current_session + 1
266        return new_session, new_level
267
268    def setReturningData(self, student):
269        """ Define what happens after school fee payment
270        depending on the student's senate verdict.
271
272        This method folllows the same algorithm as getReturningData but
273        it also sets the new values.
274        """
275        new_session, new_level = self.getReturningData(student)
276        student['studycourse'].current_level = new_level
277        student['studycourse'].current_session = new_session
278        verdict = student['studycourse'].current_verdict
279        student['studycourse'].current_verdict = '0'
280        student['studycourse'].previous_verdict = verdict
281        return
282
283    def setPaymentDetails(self, category, student):
284        """Create Payment object and set the payment data of a student for
285        the payment category specified.
286
287        """
288        p_item = u''
289        amount = 0.0
290        p_session = student['studycourse'].current_session
291        p_level = student['studycourse'].current_level
292        session = str(p_session)
293        try:
294            academic_session = grok.getSite()['configuration'][session]
295        except KeyError:
296            return _(u'Session configuration object is not available.'), None
297        if category == 'schoolfee':
298            try:
299                certificate = student['studycourse'].certificate
300                p_item = certificate.code
301            except (AttributeError, TypeError):
302                return _('Study course data are incomplete.'), None
303            if student.state == CLEARED:
304                amount = getattr(certificate, 'school_fee_1', 0.0)
305            elif student.state == RETURNING:
306                # In case of returning school fee payment the payment session
307                # and level contain the values of the session the student
308                # has paid for.
309                p_session, p_level = self.getReturningData(student)
310                amount = getattr(certificate, 'school_fee_2', 0.0)
311            elif student.is_postgrad and student.state == PAID:
312                # Returning postgraduate students also pay for the next session
313                # but their level always remains the same.
314                p_session += 1
315                amount = getattr(certificate, 'school_fee_2', 0.0)
316        elif category == 'clearance':
317            p_item = student['studycourse'].certificate.code
318            amount = academic_session.clearance_fee
319        elif category == 'bed_allocation':
320            p_item = self.getAccommodationDetails(student)['bt']
321            amount = academic_session.booking_fee
322        if amount in (0.0, None):
323            return _(u'Amount could not be determined.'), None
324        for key in student['payments'].keys():
325            ticket = student['payments'][key]
326            if ticket.p_state == 'paid' and\
327               ticket.p_category == category and \
328               ticket.p_item == p_item and \
329               ticket.p_session == p_session:
330                  return _('This type of payment has already been made.'), None
331        payment = createObject(u'waeup.StudentOnlinePayment')
332        timestamp = ("%d" % int(time()*10000))[1:]
333        payment.p_id = "p%s" % timestamp
334        payment.p_category = category
335        payment.p_item = p_item
336        payment.p_session = p_session
337        payment.p_level = p_level
338        payment.amount_auth = amount
339        return None, payment
340
341    def getAccommodationDetails(self, student):
342        """Determine the accommodation dates of a student.
343        """
344        d = {}
345        d['error'] = u''
346        hostels = grok.getSite()['hostels']
347        d['booking_session'] = hostels.accommodation_session
348        d['allowed_states'] = hostels.accommodation_states
349        d['startdate'] = hostels.startdate
350        d['enddate'] = hostels.enddate
351        d['expired'] = hostels.expired
352        # Determine bed type
353        studycourse = student['studycourse']
354        certificate = getattr(studycourse,'certificate',None)
355        entry_session = studycourse.entry_session
356        current_level = studycourse.current_level
357        if not (entry_session and current_level and certificate):
358            return
359        end_level = certificate.end_level
360        if entry_session == grok.getSite()['hostels'].accommodation_session:
361            bt = 'fr'
362        elif current_level >= end_level:
363            bt = 'fi'
364        else:
365            bt = 're'
366        if student.sex == 'f':
367            sex = 'female'
368        else:
369            sex = 'male'
370        special_handling = 'regular'
371        d['bt'] = u'%s_%s_%s' % (special_handling,sex,bt)
372        return d
373
374    def selectBed(self, available_beds):
375        """Select a bed from a list of available beds.
376
377        In the base configuration we select the first bed found,
378        but can also randomize the selection if we like.
379        """
380        return available_beds[0]
381
382    def renderPDF(self, view, filename='slip.pdf', student=None,
383                  studentview=None, tableheader=None, tabledata=None,
384                  note=None, signatures=None):
385        """Render pdf slips for various pages.
386        """
387        # XXX: we have to fix the import problems here.
388        from waeup.kofa.browser.interfaces import IPDFCreator
389        from waeup.kofa.browser.pdf import NORMAL_STYLE, ENTRY1_STYLE
390        style = getSampleStyleSheet()
391        creator = getUtility(IPDFCreator)
392        data = []
393        doc_title = view.label
394        author = '%s (%s)' % (view.request.principal.title,
395                              view.request.principal.id)
396        footer_text = view.label
397        if getattr(student, 'student_id', None) is not None:
398            footer_text = "%s - %s - " % (student.student_id, footer_text)
399
400        # Insert history
401        if not filename.startswith('payment'):
402            data.extend(creator.fromStringList(student.history.messages))
403
404        # Insert student data table
405        portal_language = getUtility(IKofaUtils).PORTAL_LANGUAGE
406        if student is not None:
407            bd_translation = trans(_('Base Data'), portal_language)
408            data.append(Paragraph(bd_translation, style["Heading3"]))
409            data.append(render_student_data(studentview))
410
411        # Insert widgets
412        data.append(Paragraph(view.title, style["Heading3"]))
413        portal_language = getUtility(IKofaUtils).PORTAL_LANGUAGE
414        separators = getattr(self, 'SEPARATORS_DICT', {})
415        table = creator.getWidgetsTable(
416            view.form_fields, view.context, None, lang=portal_language,
417            separators=separators)
418        data.append(table)
419
420        # Insert scanned docs
421        data.extend(docs_as_flowables(view, portal_language))
422
423        # Insert content table (optionally on second page)
424        if tabledata and tableheader:
425            #data.append(PageBreak())
426            data.append(Spacer(1, 20))
427            data.append(Paragraph(view.content_title, style["Heading3"]))
428            contenttable = render_table_data(tableheader,tabledata)
429            data.append(contenttable)
430
431        # Insert signatures
432        if signatures:
433            data.append(Spacer(1, 20))
434            signaturetable = get_signature_table(signatures)
435            data.append(signaturetable)
436
437        view.response.setHeader(
438            'Content-Type', 'application/pdf')
439        try:
440            pdf_stream = creator.create_pdf(
441                data, None, doc_title, author=author, footer=footer_text,
442                note=note)
443        except IOError:
444            view.flash('Error in image file.')
445            return view.redirect(view.url(view.context))
446        return pdf_stream
447
448    VERDICTS_DICT = {
449        '0': _('(not yet)'),
450        'A': 'Successful student',
451        'B': 'Student with carryover courses',
452        'C': 'Student on probation',
453        }
454
455    SEPARATORS_DICT = {
456        }
457
458    #: A prefix used when generating new student ids. Each student id will
459    #: start with this string. The default is 'K' for ``Kofa``.
460    STUDENT_ID_PREFIX = u'K'
Note: See TracBrowser for help on using the repository browser.