source: main/waeup.kofa/trunk/src/waeup/kofa/applicants/pdf.py @ 17335

Last change on this file since 17335 was 16057, checked in by Henrik Bettermann, 5 years ago

Render proper application slips in all tests.

  • Property svn:keywords set to Id
File size: 9.2 KB
RevLine 
[7415]1## $Id: pdf.py 16057 2020-04-18 08:12:53Z henrik $
[7390]2##
[7398]3## Copyright (C) 2011 Uli Fouquet & Henrik Bettermann
[7390]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"""
19Generate PDF docs for applicants.
20"""
21import grok
[10310]22from reportlab.platypus import Paragraph, Spacer, Table
23from reportlab.lib.units import cm
[7390]24from zope.component import getUtility
[8059]25from zope.i18n import translate
[8046]26from waeup.kofa.applicants.interfaces import IApplicant, IApplicantsUtils
[7811]27from waeup.kofa.browser import DEFAULT_PASSPORT_IMAGE_PATH
[8059]28from waeup.kofa.browser.interfaces import IPDFCreator
[10596]29from waeup.kofa.browser.pdf import SMALL_PARA_STYLE, ENTRY1_STYLE, get_qrcode
[7819]30from waeup.kofa.interfaces import IExtFileStore, IPDF, IKofaUtils
[7811]31from waeup.kofa.interfaces import MessageFactory as _
[8059]32from waeup.kofa.widgets.datewidget import FriendlyDateDisplayWidget
[7390]33
[10310]34SLIP_STYLE = [
35    ('VALIGN',(0,0),(-1,-1),'TOP'),
36    #('FONT', (0,0), (-1,-1), 'Helvetica', 11),
37    ]
38
[7390]39class PDFApplicationSlip(grok.Adapter):
[8059]40    """Create a PDF application slip for applicants.
41    """
42    # XXX: Many things in here are reusable. We might want to split
43    # things. Possibly move parts to IPDFCreator?
[7390]44    grok.context(IApplicant)
45    grok.implements(IPDF)
46    grok.name('application_slip')
47
48    form_fields =  grok.AutoFields(IApplicant).omit(
[10310]49        'locked', 'course_admitted', 'suspended',
50        )
[8013]51    form_fields['date_of_birth'].custom_widget = FriendlyDateDisplayWidget('le')
[10310]52    column_two_fields = ('applicant_id', 'reg_number',
53        'firstname', 'middlename', 'lastname')
[10319]54    two_columns_design_fields = []
[7390]55
56    @property
[11869]57    def note(self):
[11871]58        note = getattr(self.context.__parent__, 'application_slip_notice', None)
[11872]59        if note:
60            return '<br /><br />' + note
61        return
[11869]62
63    @property
[10222]64    def target(self):
65        return getattr(self.context.__parent__, 'prefix', None)
66
67    @property
[7390]68    def title(self):
69        container_title = self.context.__parent__.title
[7819]70        portal_language = getUtility(IKofaUtils).PORTAL_LANGUAGE
[7714]71        ar_translation = translate(_('Application Record'),
[7811]72            'waeup.kofa', target_language=portal_language)
[7714]73        return '%s - %s %s' % (container_title,
74            ar_translation, self.context.application_number)
[7390]75
76    def _getCourseAdmittedLink(self, view):
77        """Return link, title and code in html format to the certificate
78           admitted.
79        """
80        course_admitted = self.context.course_admitted
[16057]81        if course_admitted is not None:
82            if view is None:
83                title = course_admitted.title
84                code = course_admitted.code
85                return '%s - %s' %(code,title)
86            if getattr(course_admitted, '__parent__',None):
87                url = view.url(course_admitted)
88                title = course_admitted.title
89                code = course_admitted.code
90                return '<a href="%s">%s - %s</a>' %(url,code,title)
[7390]91        return ''
92
[8091]93    def _getDeptAndFaculty(self):
94        """Return long titles of department and faculty.
[7390]95
[8091]96        Returns a list [department_title, faculty_title]
[7390]97
[8091]98        If the context applicant has no course admitted or dept. and
99        faculty cannot be determined, ``None`` is returned.
[7390]100        """
101        course_admitted = self.context.course_admitted
102        dept = getattr(
103                getattr(course_admitted, '__parent__', None),
104                '__parent__', None)
105        faculty = getattr(dept, '__parent__', None)
[10650]106        return [x is not None and x.longtitle or x for x in dept, faculty]
[7390]107
[10329]108    def _addLoginInformation(self):
[8286]109        if self.context.state == 'created':
[8313]110            comment = translate(_(
[10329]111                '\n Proceed to the login page of the portal' +
[7409]112                ' and enter your new credentials:' +
[8313]113                ' user name= ${a}, password = ${b}. ' +
114                'Change your password when you have logged in.',
115                mapping = {
[8059]116                    'a':self.context.student_id,
117                    'b':self.context.application_number}
[8313]118                ))
[10330]119            return comment
120        return
[7409]121
[9949]122    def _getPDFCreator(self):
123        return getUtility(IPDFCreator)
124
[8552]125    def __call__(self, view=None, note=None):
[8059]126        """Return a PDF representation of the context applicant.
[7390]127
[8059]128        If no `view` is given, the course admitted field will be an
129        empty string and author will be set as ``'unknown'``.
130
131        If a `view` is given, author will be set as the calling
132        principal.
133        """
[8095]134        doc_title = '\n'.join([x.strip() for x in self.title.split(' - ')])
[8059]135        data = []
[14065]136        topMargin = 1.5
[14063]137        if len(self.title.split(' - ')) > 2:
[14065]138            topMargin = 1.8
[8091]139        portal_language = getUtility(IKofaUtils).PORTAL_LANGUAGE
140        separators = getUtility(IApplicantsUtils).SEPARATORS_DICT
[9949]141        creator = self._getPDFCreator()
[8059]142
143        # append history
[8091]144        data.extend(creator.fromStringList(self.context.history.messages))
[10333]145        data.append(Spacer(1, 5))
[8059]146
[15587]147        if self.context.__parent__.with_picture:
[10319]148
[15587]149            # create three-column header table
150            # append photograph to the left
151            img_path = getattr(
152                getUtility(IExtFileStore).getFileByContext(self.context),
153                'name', DEFAULT_PASSPORT_IMAGE_PATH)
154            data_left = [[creator.getImage(img_path)]]
155            table_left = Table(data_left,style=SLIP_STYLE)
[10596]156
[15587]157            # append base data table to the middle
158            fields = [
159                field for field in self.form_fields
160                    if field.__name__ in self.column_two_fields]
161            table_middle = creator.getWidgetsTable(
162                fields, self.context, None, lang=portal_language,
163                separators=None, colWidths=[5*cm, 4.5*cm])
164
165            # append QR code to the right
166            if view is not None:
167                url = view.url(self.context, 'application_slip.pdf')
168                data_right = [[get_qrcode(url, width=70.0)]]
169                table_right = Table(data_right,style=SLIP_STYLE)
170            else:
171                table_right = None
172
173            header_table = Table(
174                [[table_left, table_middle, table_right],],style=SLIP_STYLE)
175            data.append(header_table)
176
[10596]177        else:
[15587]178            fields = [
179                field for field in self.form_fields
180                    if field.__name__ in self.column_two_fields]
181            data.append(creator.getWidgetsTable(
182                fields, self.context, None, lang=portal_language,
183                separators=None, colWidths=[7*cm, 10*cm]))
[10596]184
[10310]185        # append widgets except those already added in column two
[10329]186        # and those in two_columns_design_fields
[8091]187        dept, faculty = self._getDeptAndFaculty()
[10310]188        fields = [
189            field for field in self.form_fields
[10319]190                if not field.__name__ in self.column_two_fields and
191                not field.__name__ in self.two_columns_design_fields]
[8091]192        data.append(creator.getWidgetsTable(
[10310]193            fields, self.context, view, lang=portal_language,
[8091]194            domain='waeup.kofa', separators=separators,
195            course_label='Admitted Course of Study:',
196            course_link=self._getCourseAdmittedLink(view),
[14849]197            dept=dept, faculty=faculty, colWidths=[7*cm, 10*cm]))
[8059]198
[10329]199        # append two-column table of widgets of those fields defined in
200        # two_columns_design_fields
201        if len(self.two_columns_design_fields):
202            fields = [
203                field for field in self.form_fields
204                    if not field.__name__ in self.column_two_fields and
205                    field.__name__ in self.two_columns_design_fields]
206            if fields:
207                data.append(creator.getWidgetsTable(
208                    fields, self.context, view, lang=portal_language,
209                    domain='waeup.kofa', separators=separators,
210                    twoDataCols=True))
[9948]211
[15587]212        # append QR Code if without picture
213        if not self.context.__parent__.with_picture and view is not None:
214            data.append(Spacer(1, 5))
215            url = view.url(self.context, 'application_slip.pdf')
216            data_right = [[get_qrcode(url, width=70.0)]]
217            table_right = Table(data_right,style=SLIP_STYLE)
218            data.append(get_qrcode(url, width=70.0))
219
[10329]220        # append login information
[10332]221        note = None
222        login_information = self._addLoginInformation()
223        if not None in (self.note, login_information):
224            note = self.note + login_information
225        elif self.note:
226            note = self.note
227        elif login_information:
228            note = login_information
[10329]229
[14065]230        return creator.create_pdf(data, None, doc_title, note=note,
231            topMargin=topMargin)
Note: See TracBrowser for help on using the repository browser.