source: main/waeup.kofa/trunk/src/waeup/kofa/applicants/browser.py @ 9004

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

Add boolean field 'suspended' to IStudent and IApplicant and extend authentication (checkPassword) slightly. Test will follow
  • Property svn:keywords set to Id
File size: 39.7 KB
Line 
1## $Id: browser.py 8983 2012-07-12 11:43:12Z 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"""UI components for basic applicants and related components.
19"""
20import os
21import sys
22import grok
23from datetime import datetime, date
24from zope.event import notify
25from zope.component import getUtility, createObject, getAdapter
26from zope.catalog.interfaces import ICatalog
27from zope.i18n import translate
28from hurry.workflow.interfaces import (
29    IWorkflowInfo, IWorkflowState, InvalidTransitionError)
30from waeup.kofa.applicants.interfaces import (
31    IApplicant, IApplicantEdit, IApplicantsRoot,
32    IApplicantsContainer, IApplicantsContainerAdd,
33    MAX_UPLOAD_SIZE, IApplicantOnlinePayment, IApplicantsUtils,
34    IApplicantRegisterUpdate
35    )
36from waeup.kofa.applicants.applicant import search
37from waeup.kofa.applicants.workflow import (
38    INITIALIZED, STARTED, PAID, SUBMITTED, ADMITTED)
39from waeup.kofa.browser import (
40    KofaPage, KofaEditFormPage, KofaAddFormPage, KofaDisplayFormPage,
41    DEFAULT_PASSPORT_IMAGE_PATH)
42from waeup.kofa.browser.interfaces import ICaptchaManager
43from waeup.kofa.browser.breadcrumbs import Breadcrumb
44from waeup.kofa.browser.resources import toggleall
45from waeup.kofa.browser.layout import (
46    NullValidator, jsaction, action, UtilityView, JSAction)
47from waeup.kofa.browser.pages import add_local_role, del_local_roles
48from waeup.kofa.browser.resources import datepicker, tabs, datatable, warning
49from waeup.kofa.interfaces import (
50    IKofaObject, ILocalRolesAssignable, IExtFileStore, IPDF,
51    IFileStoreNameChooser, IPasswordValidator, IUserAccount, IKofaUtils)
52from waeup.kofa.interfaces import MessageFactory as _
53from waeup.kofa.permissions import get_users_with_local_roles
54from waeup.kofa.students.interfaces import IStudentsUtils
55from waeup.kofa.utils.helpers import string_from_bytes, file_size, now
56from waeup.kofa.widgets.datewidget import (
57    FriendlyDateDisplayWidget, FriendlyDateDisplayWidget,
58    FriendlyDatetimeDisplayWidget)
59from waeup.kofa.widgets.htmlwidget import HTMLDisplayWidget
60
61grok.context(IKofaObject) # Make IKofaObject the default context
62
63class SubmitJSAction(JSAction):
64
65    msg = _('\'You can not edit your application records after final submission.'
66            ' You really want to submit?\'')
67
68class submitaction(grok.action):
69
70    def __call__(self, success):
71        action = SubmitJSAction(self.label, success=success, **self.options)
72        self.actions.append(action)
73        return action
74
75class ApplicantsRootPage(KofaDisplayFormPage):
76    grok.context(IApplicantsRoot)
77    grok.name('index')
78    grok.require('waeup.Public')
79    form_fields = grok.AutoFields(IApplicantsRoot)
80    form_fields['description'].custom_widget = HTMLDisplayWidget
81    label = _('Application Section')
82    search_button = _('Search')
83    pnav = 3
84
85    def update(self):
86        super(ApplicantsRootPage, self).update()
87        return
88
89    @property
90    def introduction(self):
91        # Here we know that the cookie has been set
92        lang = self.request.cookies.get('kofa.language')
93        html = self.context.description_dict.get(lang,'')
94        if html == '':
95            portal_language = getUtility(IKofaUtils).PORTAL_LANGUAGE
96            html = self.context.description_dict.get(portal_language,'')
97        return html
98
99class ApplicantsSearchPage(KofaPage):
100    grok.context(IApplicantsRoot)
101    grok.name('search')
102    grok.require('waeup.viewApplication')
103    label = _('Search applicants')
104    search_button = _('Search')
105    pnav = 3
106
107    def update(self, *args, **kw):
108        datatable.need()
109        form = self.request.form
110        self.results = []
111        if 'searchterm' in form and form['searchterm']:
112            self.searchterm = form['searchterm']
113            self.searchtype = form['searchtype']
114        elif 'old_searchterm' in form:
115            self.searchterm = form['old_searchterm']
116            self.searchtype = form['old_searchtype']
117        else:
118            if 'search' in form:
119                self.flash(_('Empty search string'))
120            return
121        self.results = search(query=self.searchterm,
122            searchtype=self.searchtype, view=self)
123        if not self.results:
124            self.flash(_('No applicant found.'))
125        return
126
127class ApplicantsRootManageFormPage(KofaEditFormPage):
128    grok.context(IApplicantsRoot)
129    grok.name('manage')
130    grok.template('applicantsrootmanagepage')
131    form_fields = grok.AutoFields(IApplicantsRoot)
132    label = _('Manage application section')
133    pnav = 3
134    grok.require('waeup.manageApplication')
135    taboneactions = [_('Save')]
136    tabtwoactions = [_('Add applicants container'), _('Remove selected')]
137    tabthreeactions1 = [_('Remove selected local roles')]
138    tabthreeactions2 = [_('Add local role')]
139    subunits = _('Applicants Containers')
140
141    def update(self):
142        tabs.need()
143        datatable.need()
144        warning.need()
145        self.tab1 = self.tab2 = self.tab3 = ''
146        qs = self.request.get('QUERY_STRING', '')
147        if not qs:
148            qs = 'tab1'
149        setattr(self, qs, 'active')
150        return super(ApplicantsRootManageFormPage, self).update()
151
152    def getLocalRoles(self):
153        roles = ILocalRolesAssignable(self.context)
154        return roles()
155
156    def getUsers(self):
157        """Get a list of all users.
158        """
159        for key, val in grok.getSite()['users'].items():
160            url = self.url(val)
161            yield(dict(url=url, name=key, val=val))
162
163    def getUsersWithLocalRoles(self):
164        return get_users_with_local_roles(self.context)
165
166    @jsaction(_('Remove selected'))
167    def delApplicantsContainers(self, **data):
168        form = self.request.form
169        if form.has_key('val_id'):
170            child_id = form['val_id']
171        else:
172            self.flash(_('No container selected!'))
173            self.redirect(self.url(self.context, '@@manage')+'?tab2')
174            return
175        if not isinstance(child_id, list):
176            child_id = [child_id]
177        deleted = []
178        for id in child_id:
179            try:
180                del self.context[id]
181                deleted.append(id)
182            except:
183                self.flash(_('Could not delete:') + ' %s: %s: %s' % (
184                        id, sys.exc_info()[0], sys.exc_info()[1]))
185        if len(deleted):
186            self.flash(_('Successfully removed: ${a}',
187                mapping = {'a':', '.join(deleted)}))
188        self.redirect(self.url(self.context, '@@manage')+'?tab2')
189        return
190
191    @action(_('Add applicants container'), validator=NullValidator)
192    def addApplicantsContainer(self, **data):
193        self.redirect(self.url(self.context, '@@add'))
194        return
195
196    @action(_('Add local role'), validator=NullValidator)
197    def addLocalRole(self, **data):
198        return add_local_role(self,3, **data)
199
200    @action(_('Remove selected local roles'))
201    def delLocalRoles(self, **data):
202        return del_local_roles(self,3,**data)
203
204    def _description(self):
205        view = ApplicantsRootPage(
206            self.context,self.request)
207        view.setUpWidgets()
208        return view.widgets['description']()
209
210    @action(_('Save'), style='primary')
211    def save(self, **data):
212        self.applyData(self.context, **data)
213        self.context.description_dict = self._description()
214        self.flash(_('Form has been saved.'))
215        return
216
217class ApplicantsContainerAddFormPage(KofaAddFormPage):
218    grok.context(IApplicantsRoot)
219    grok.require('waeup.manageApplication')
220    grok.name('add')
221    grok.template('applicantscontaineraddpage')
222    label = _('Add applicants container')
223    pnav = 3
224
225    form_fields = grok.AutoFields(
226        IApplicantsContainerAdd).omit('code').omit('title')
227
228    def update(self):
229        datepicker.need() # Enable jQuery datepicker in date fields.
230        return super(ApplicantsContainerAddFormPage, self).update()
231
232    @action(_('Add applicants container'))
233    def addApplicantsContainer(self, **data):
234        year = data['year']
235        code = u'%s%s' % (data['prefix'], year)
236        appcats_dict = getUtility(IApplicantsUtils).APP_TYPES_DICT
237        title = appcats_dict[data['prefix']][0]
238        title = u'%s %s/%s' % (title, year, year + 1)
239        if code in self.context.keys():
240            self.flash(
241                _('An applicants container for the same application type and entrance year exists already in the database.'))
242            return
243        # Add new applicants container...
244        container = createObject(u'waeup.ApplicantsContainer')
245        self.applyData(container, **data)
246        container.code = code
247        container.title = title
248        self.context[code] = container
249        self.flash(_('Added:') + ' "%s".' % code)
250        self.redirect(self.url(self.context, u'@@manage'))
251        return
252
253    @action(_('Cancel'), validator=NullValidator)
254    def cancel(self, **data):
255        self.redirect(self.url(self.context, '@@manage'))
256
257class ApplicantsRootBreadcrumb(Breadcrumb):
258    """A breadcrumb for applicantsroot.
259    """
260    grok.context(IApplicantsRoot)
261    title = _(u'Applicants')
262
263class ApplicantsContainerBreadcrumb(Breadcrumb):
264    """A breadcrumb for applicantscontainers.
265    """
266    grok.context(IApplicantsContainer)
267
268class ApplicantBreadcrumb(Breadcrumb):
269    """A breadcrumb for applicants.
270    """
271    grok.context(IApplicant)
272
273    @property
274    def title(self):
275        """Get a title for a context.
276        """
277        return self.context.application_number
278
279class OnlinePaymentBreadcrumb(Breadcrumb):
280    """A breadcrumb for payments.
281    """
282    grok.context(IApplicantOnlinePayment)
283
284    @property
285    def title(self):
286        return self.context.p_id
287
288class ApplicantsStatisticsPage(KofaDisplayFormPage):
289    """Some statistics about applicants in a container.
290    """
291    grok.context(IApplicantsContainer)
292    grok.name('statistics')
293    grok.require('waeup.viewApplicationStatistics')
294    grok.template('applicantcontainerstatistics')
295
296    @property
297    def label(self):
298        return "%s" % self.context.title
299
300class ApplicantsContainerPage(KofaDisplayFormPage):
301    """The standard view for regular applicant containers.
302    """
303    grok.context(IApplicantsContainer)
304    grok.name('index')
305    grok.require('waeup.Public')
306    grok.template('applicantscontainerpage')
307    pnav = 3
308
309    form_fields = grok.AutoFields(IApplicantsContainer).omit('title')
310    form_fields['description'].custom_widget = HTMLDisplayWidget
311    form_fields[
312        'startdate'].custom_widget = FriendlyDatetimeDisplayWidget('le')
313    form_fields[
314        'enddate'].custom_widget = FriendlyDatetimeDisplayWidget('le')
315
316    @property
317    def introduction(self):
318        # Here we know that the cookie has been set
319        lang = self.request.cookies.get('kofa.language')
320        html = self.context.description_dict.get(lang,'')
321        if html == '':
322            portal_language = getUtility(IKofaUtils).PORTAL_LANGUAGE
323            html = self.context.description_dict.get(portal_language,'')
324        return html
325
326    @property
327    def label(self):
328        return "%s" % self.context.title
329
330class ApplicantsContainerManageFormPage(KofaEditFormPage):
331    grok.context(IApplicantsContainer)
332    grok.name('manage')
333    grok.template('applicantscontainermanagepage')
334    form_fields = grok.AutoFields(IApplicantsContainer).omit('title')
335    taboneactions = [_('Save'),_('Cancel')]
336    tabtwoactions = [_('Remove selected'),_('Cancel'),
337        _('Create students from selected')]
338    tabthreeactions1 = [_('Remove selected local roles')]
339    tabthreeactions2 = [_('Add local role')]
340    # Use friendlier date widget...
341    grok.require('waeup.manageApplication')
342
343    @property
344    def label(self):
345        return _('Manage applicants container')
346
347    pnav = 3
348
349    @property
350    def showApplicants(self):
351        if len(self.context) < 5000:
352            return True
353        return False
354
355    def update(self):
356        datepicker.need() # Enable jQuery datepicker in date fields.
357        tabs.need()
358        toggleall.need()
359        self.tab1 = self.tab2 = self.tab3 = ''
360        qs = self.request.get('QUERY_STRING', '')
361        if not qs:
362            qs = 'tab1'
363        setattr(self, qs, 'active')
364        warning.need()
365        datatable.need()  # Enable jQurey datatables for contents listing
366        return super(ApplicantsContainerManageFormPage, self).update()
367
368    def getLocalRoles(self):
369        roles = ILocalRolesAssignable(self.context)
370        return roles()
371
372    def getUsers(self):
373        """Get a list of all users.
374        """
375        for key, val in grok.getSite()['users'].items():
376            url = self.url(val)
377            yield(dict(url=url, name=key, val=val))
378
379    def getUsersWithLocalRoles(self):
380        return get_users_with_local_roles(self.context)
381
382    def _description(self):
383        view = ApplicantsContainerPage(
384            self.context,self.request)
385        view.setUpWidgets()
386        return view.widgets['description']()
387
388    @action(_('Save'), style='primary')
389    def save(self, **data):
390        self.applyData(self.context, **data)
391        self.context.description_dict = self._description()
392        # Always refresh title. So we can change titles
393        # if APP_TYPES_DICT has been edited.
394        appcats_dict = getUtility(IApplicantsUtils).APP_TYPES_DICT
395        title = appcats_dict[self.context.prefix][0]
396        self.context.title = u'%s %s/%s' % (
397            title, self.context.year, self.context.year + 1)
398        self.flash(_('Form has been saved.'))
399        return
400
401    @jsaction(_('Remove selected'))
402    def delApplicant(self, **data):
403        form = self.request.form
404        if form.has_key('val_id'):
405            child_id = form['val_id']
406        else:
407            self.flash(_('No applicant selected!'))
408            self.redirect(self.url(self.context, '@@manage')+'?tab2')
409            return
410        if not isinstance(child_id, list):
411            child_id = [child_id]
412        deleted = []
413        for id in child_id:
414            try:
415                del self.context[id]
416                deleted.append(id)
417            except:
418                self.flash(_('Could not delete:') + ' %s: %s: %s' % (
419                        id, sys.exc_info()[0], sys.exc_info()[1]))
420        if len(deleted):
421            self.flash(_('Successfully removed: ${a}',
422                mapping = {'a':', '.join(deleted)}))
423        self.redirect(self.url(self.context, u'@@manage')+'?tab2')
424        return
425
426    @action(_('Create students from selected'))
427    def createStudents(self, **data):
428        form = self.request.form
429        if form.has_key('val_id'):
430            child_id = form['val_id']
431        else:
432            self.flash(_('No applicant selected!'))
433            self.redirect(self.url(self.context, '@@manage')+'?tab2')
434            return
435        if not isinstance(child_id, list):
436            child_id = [child_id]
437        created = []
438        for id in child_id:
439            success, msg = self.context[id].createStudent(view=self)
440            if success:
441                created.append(id)
442        if len(created):
443            self.flash(_('${a} students successfully created.',
444                mapping = {'a': len(created)}))
445        else:
446            self.flash(_('No student could be created.'))
447        self.redirect(self.url(self.context, u'@@manage')+'?tab2')
448        return
449
450    @action(_('Cancel'), validator=NullValidator)
451    def cancel(self, **data):
452        self.redirect(self.url(self.context))
453        return
454
455    @action(_('Add local role'), validator=NullValidator)
456    def addLocalRole(self, **data):
457        return add_local_role(self,3, **data)
458
459    @action(_('Remove selected local roles'))
460    def delLocalRoles(self, **data):
461        return del_local_roles(self,3,**data)
462
463class ApplicantAddFormPage(KofaAddFormPage):
464    """Add-form to add an applicant.
465    """
466    grok.context(IApplicantsContainer)
467    grok.require('waeup.manageApplication')
468    grok.name('addapplicant')
469    #grok.template('applicantaddpage')
470    form_fields = grok.AutoFields(IApplicant).select(
471        'firstname', 'middlename', 'lastname',
472        'email', 'phone')
473    label = _('Add applicant')
474    pnav = 3
475
476    @action(_('Create application record'))
477    def addApplicant(self, **data):
478        applicant = createObject(u'waeup.Applicant')
479        self.applyData(applicant, **data)
480        self.context.addApplicant(applicant)
481        self.flash(_('Applicant record created.'))
482        self.redirect(
483            self.url(self.context[applicant.application_number], 'index'))
484        return
485
486class ApplicantDisplayFormPage(KofaDisplayFormPage):
487    """A display view for applicant data.
488    """
489    grok.context(IApplicant)
490    grok.name('index')
491    grok.require('waeup.viewApplication')
492    grok.template('applicantdisplaypage')
493    form_fields = grok.AutoFields(IApplicant).omit(
494        'locked', 'course_admitted', 'password', 'suspended')
495    label = _('Applicant')
496    pnav = 3
497    hide_hint = False
498
499    @property
500    def separators(self):
501        return getUtility(IApplicantsUtils).SEPARATORS_DICT
502
503    def update(self):
504        self.passport_url = self.url(self.context, 'passport.jpg')
505        # Mark application as started if applicant logs in for the first time
506        usertype = getattr(self.request.principal, 'user_type', None)
507        if usertype == 'applicant' and \
508            IWorkflowState(self.context).getState() == INITIALIZED:
509            IWorkflowInfo(self.context).fireTransition('start')
510        return
511
512    @property
513    def hasPassword(self):
514        if self.context.password:
515            return _('set')
516        return _('unset')
517
518    @property
519    def label(self):
520        container_title = self.context.__parent__.title
521        return _('${a} <br /> Application Record ${b}', mapping = {
522            'a':container_title, 'b':self.context.application_number})
523
524    def getCourseAdmitted(self):
525        """Return link, title and code in html format to the certificate
526           admitted.
527        """
528        course_admitted = self.context.course_admitted
529        if getattr(course_admitted, '__parent__',None):
530            url = self.url(course_admitted)
531            title = course_admitted.title
532            code = course_admitted.code
533            return '<a href="%s">%s - %s</a>' %(url,code,title)
534        return ''
535
536class ApplicantBaseDisplayFormPage(ApplicantDisplayFormPage):
537    grok.context(IApplicant)
538    grok.name('base')
539    form_fields = grok.AutoFields(IApplicant).select(
540        'applicant_id', 'firstname', 'lastname','email', 'course1')
541
542class CreateStudentPage(UtilityView, grok.View):
543    """Create a student object from applicant data.
544    """
545    grok.context(IApplicant)
546    grok.name('createstudent')
547    grok.require('waeup.manageStudent')
548
549    def update(self):
550        msg = self.context.createStudent(view=self)[1]
551        self.flash(msg)
552        self.redirect(self.url(self.context))
553        return
554
555    def render(self):
556        return
557
558class CreateAllStudentsPage(UtilityView, grok.View):
559    """Create all student objects from applicant data
560    in a container.
561
562    This is a hidden page, no link or button will
563    be provided and only PortalManagers can do this.
564    """
565    grok.context(IApplicantsContainer)
566    grok.name('createallstudents')
567    grok.require('waeup.managePortal')
568
569    def update(self):
570        cat = getUtility(ICatalog, name='applicants_catalog')
571        results = list(cat.searchResults(state=(ADMITTED, ADMITTED)))
572        created = []
573        for result in results:
574            if not self.context.has_key(result.application_number):
575                continue
576            success, msg = result.createStudent(view=self)
577            if success:
578                created.append(result.applicant_id)
579            else:
580                ob_class = self.__implemented__.__name__.replace('waeup.kofa.','')
581                self.context.__parent__.logger.info(
582                    '%s - %s - %s' % (ob_class, result.applicant_id, msg))
583        if len(created):
584            self.flash(_('${a} students successfully created.',
585                mapping = {'a': len(created)}))
586        else:
587            self.flash(_('No student could be created.'))
588        self.redirect(self.url(self.context, u'@@manage')+'?tab2')
589        return
590
591    def render(self):
592        return
593
594class ApplicationFeePaymentAddPage(UtilityView, grok.View):
595    """ Page to add an online payment ticket
596    """
597    grok.context(IApplicant)
598    grok.name('addafp')
599    grok.require('waeup.payApplicant')
600    factory = u'waeup.ApplicantOnlinePayment'
601
602    def update(self):
603        for key in self.context.keys():
604            ticket = self.context[key]
605            if ticket.p_state == 'paid':
606                  self.flash(
607                      _('This type of payment has already been made.'))
608                  self.redirect(self.url(self.context))
609                  return
610        applicants_utils = getUtility(IApplicantsUtils)
611        container = self.context.__parent__
612        payment = createObject(self.factory)
613        error = applicants_utils.setPaymentDetails(container, payment)
614        if error is not None:
615            self.flash(error)
616            self.redirect(self.url(self.context))
617            return
618        self.context[payment.p_id] = payment
619        self.flash(_('Payment ticket created.'))
620        self.redirect(self.url(payment))
621        return
622
623    def render(self):
624        return
625
626
627class OnlinePaymentDisplayFormPage(KofaDisplayFormPage):
628    """ Page to view an online payment ticket
629    """
630    grok.context(IApplicantOnlinePayment)
631    grok.name('index')
632    grok.require('waeup.viewApplication')
633    form_fields = grok.AutoFields(IApplicantOnlinePayment)
634    form_fields[
635        'creation_date'].custom_widget = FriendlyDatetimeDisplayWidget('le')
636    form_fields[
637        'payment_date'].custom_widget = FriendlyDatetimeDisplayWidget('le')
638    pnav = 3
639
640    @property
641    def label(self):
642        return _('${a}: Online Payment Ticket ${b}', mapping = {
643            'a':self.context.__parent__.display_fullname,
644            'b':self.context.p_id})
645
646class OnlinePaymentApprovePage(UtilityView, grok.View):
647    """ Approval view
648    """
649    grok.context(IApplicantOnlinePayment)
650    grok.name('approve')
651    grok.require('waeup.managePortal')
652
653    def update(self):
654        success, msg, log = self.context.approveApplicantPayment()
655        if log is not None:
656            self.context.__parent__.writeLogMessage(self, log)
657        self.flash(msg)
658        return
659
660    def render(self):
661        self.redirect(self.url(self.context, '@@index'))
662        return
663
664class ExportPDFPaymentSlipPage(UtilityView, grok.View):
665    """Deliver a PDF slip of the context.
666    """
667    grok.context(IApplicantOnlinePayment)
668    grok.name('payment_slip.pdf')
669    grok.require('waeup.viewApplication')
670    form_fields = grok.AutoFields(IApplicantOnlinePayment)
671    form_fields['creation_date'].custom_widget = FriendlyDatetimeDisplayWidget('le')
672    form_fields['payment_date'].custom_widget = FriendlyDatetimeDisplayWidget('le')
673    prefix = 'form'
674    note = None
675
676    @property
677    def title(self):
678        portal_language = getUtility(IKofaUtils).PORTAL_LANGUAGE
679        return translate(_('Payment Data'), 'waeup.kofa',
680            target_language=portal_language)
681
682    @property
683    def label(self):
684        portal_language = getUtility(IKofaUtils).PORTAL_LANGUAGE
685        return translate(_('Online Payment Slip'),
686            'waeup.kofa', target_language=portal_language) \
687            + ' %s' % self.context.p_id
688
689    def render(self):
690        #if self.context.p_state != 'paid':
691        #    self.flash(_('Ticket not yet paid.'))
692        #    self.redirect(self.url(self.context))
693        #    return
694        applicantview = ApplicantBaseDisplayFormPage(self.context.__parent__,
695            self.request)
696        students_utils = getUtility(IStudentsUtils)
697        return students_utils.renderPDF(self,'payment_slip.pdf',
698            self.context.__parent__, applicantview, note=self.note)
699
700class ExportPDFPage(UtilityView, grok.View):
701    """Deliver a PDF slip of the context.
702    """
703    grok.context(IApplicant)
704    grok.name('application_slip.pdf')
705    grok.require('waeup.viewApplication')
706    prefix = 'form'
707
708    def update(self):
709        if self.context.state in ('initialized', 'started'):
710            self.flash(
711                _('Please pay before trying to download the application slip.'))
712            return self.redirect(self.url(self.context))
713        return
714
715    def render(self):
716        pdfstream = getAdapter(self.context, IPDF, name='application_slip')(
717            view=self)
718        self.response.setHeader(
719            'Content-Type', 'application/pdf')
720        return pdfstream
721
722def handle_img_upload(upload, context, view):
723    """Handle upload of applicant image.
724
725    Returns `True` in case of success or `False`.
726
727    Please note that file pointer passed in (`upload`) most probably
728    points to end of file when leaving this function.
729    """
730    size = file_size(upload)
731    if size > MAX_UPLOAD_SIZE:
732        view.flash(_('Uploaded image is too big!'))
733        return False
734    dummy, ext = os.path.splitext(upload.filename)
735    ext.lower()
736    if ext != '.jpg':
737        view.flash(_('jpg file extension expected.'))
738        return False
739    upload.seek(0) # file pointer moved when determining size
740    store = getUtility(IExtFileStore)
741    file_id = IFileStoreNameChooser(context).chooseName()
742    store.createFile(file_id, upload)
743    return True
744
745class ApplicantManageFormPage(KofaEditFormPage):
746    """A full edit view for applicant data.
747    """
748    grok.context(IApplicant)
749    grok.name('manage')
750    grok.require('waeup.manageApplication')
751    form_fields = grok.AutoFields(IApplicant)
752    form_fields['student_id'].for_display = True
753    form_fields['applicant_id'].for_display = True
754    grok.template('applicanteditpage')
755    manage_applications = True
756    pnav = 3
757    display_actions = [[_('Save'), _('Final Submit')],
758        [_('Add online payment ticket'),_('Remove selected tickets')]]
759
760    @property
761    def separators(self):
762        return getUtility(IApplicantsUtils).SEPARATORS_DICT
763
764    def update(self):
765        datepicker.need() # Enable jQuery datepicker in date fields.
766        warning.need()
767        super(ApplicantManageFormPage, self).update()
768        self.wf_info = IWorkflowInfo(self.context)
769        self.max_upload_size = string_from_bytes(MAX_UPLOAD_SIZE)
770        self.passport_changed = None
771        upload = self.request.form.get('form.passport', None)
772        if upload:
773            # We got a fresh upload
774            self.passport_changed = handle_img_upload(
775                upload, self.context, self)
776        return
777
778    @property
779    def label(self):
780        container_title = self.context.__parent__.title
781        return _('${a} <br /> Application Form ${b}', mapping = {
782            'a':container_title, 'b':self.context.application_number})
783
784    def getTransitions(self):
785        """Return a list of dicts of allowed transition ids and titles.
786
787        Each list entry provides keys ``name`` and ``title`` for
788        internal name and (human readable) title of a single
789        transition.
790        """
791        allowed_transitions = [t for t in self.wf_info.getManualTransitions()
792            if not t[0] == 'pay']
793        return [dict(name='', title=_('No transition'))] +[
794            dict(name=x, title=y) for x, y in allowed_transitions]
795
796    @action(_('Save'), style='primary')
797    def save(self, **data):
798        form = self.request.form
799        password = form.get('password', None)
800        password_ctl = form.get('control_password', None)
801        if password:
802            validator = getUtility(IPasswordValidator)
803            errors = validator.validate_password(password, password_ctl)
804            if errors:
805                self.flash( ' '.join(errors))
806                return
807        if self.passport_changed is False:  # False is not None!
808            return # error during image upload. Ignore other values
809        changed_fields = self.applyData(self.context, **data)
810        # Turn list of lists into single list
811        if changed_fields:
812            changed_fields = reduce(lambda x,y: x+y, changed_fields.values())
813        else:
814            changed_fields = []
815        if self.passport_changed:
816            changed_fields.append('passport')
817        if password:
818            # Now we know that the form has no errors and can set password ...
819            IUserAccount(self.context).setPassword(password)
820            changed_fields.append('password')
821        fields_string = ' + '.join(changed_fields)
822        trans_id = form.get('transition', None)
823        if trans_id:
824            self.wf_info.fireTransition(trans_id)
825        self.flash(_('Form has been saved.'))
826        if fields_string:
827            self.context.writeLogMessage(self, 'saved: % s' % fields_string)
828        return
829
830    def unremovable(self, ticket):
831        return False
832
833    # This method is also used by the ApplicantEditFormPage
834    def delPaymentTickets(self, **data):
835        form = self.request.form
836        if form.has_key('val_id'):
837            child_id = form['val_id']
838        else:
839            self.flash(_('No payment selected.'))
840            self.redirect(self.url(self.context))
841            return
842        if not isinstance(child_id, list):
843            child_id = [child_id]
844        deleted = []
845        for id in child_id:
846            # Applicants are not allowed to remove used payment tickets
847            if not self.unremovable(self.context[id]):
848                try:
849                    del self.context[id]
850                    deleted.append(id)
851                except:
852                    self.flash(_('Could not delete:') + ' %s: %s: %s' % (
853                            id, sys.exc_info()[0], sys.exc_info()[1]))
854        if len(deleted):
855            self.flash(_('Successfully removed: ${a}',
856                mapping = {'a':', '.join(deleted)}))
857            self.context.writeLogMessage(
858                self, 'removed: % s' % ', '.join(deleted))
859        return
860
861    # We explicitely want the forms to be validated before payment tickets
862    # can be created. If no validation is requested, use
863    # 'validator=NullValidator' in the action directive
864    @action(_('Add online payment ticket'))
865    def addPaymentTicket(self, **data):
866        self.redirect(self.url(self.context, '@@addafp'))
867        return
868
869    @jsaction(_('Remove selected tickets'))
870    def removePaymentTickets(self, **data):
871        self.delPaymentTickets(**data)
872        self.redirect(self.url(self.context) + '/@@manage')
873        return
874
875class ApplicantEditFormPage(ApplicantManageFormPage):
876    """An applicant-centered edit view for applicant data.
877    """
878    grok.context(IApplicantEdit)
879    grok.name('edit')
880    grok.require('waeup.handleApplication')
881    form_fields = grok.AutoFields(IApplicantEdit).omit(
882        'locked', 'course_admitted', 'student_id',
883        'screening_score', 'suspended'
884        )
885    form_fields['applicant_id'].for_display = True
886    form_fields['reg_number'].for_display = True
887    grok.template('applicanteditpage')
888    manage_applications = False
889
890    @property
891    def display_actions(self):
892        state = IWorkflowState(self.context).getState()
893        if state == INITIALIZED:
894            actions = [[],[]]
895        elif state == STARTED:
896            actions = [[_('Save')],
897                [_('Add online payment ticket'),_('Remove selected tickets')]]
898        elif state == PAID:
899            actions = [[_('Save'), _('Final Submit')],
900                [_('Remove selected tickets')]]
901        else:
902            actions = [[],[]]
903        return actions
904
905    def unremovable(self, ticket):
906        state = IWorkflowState(self.context).getState()
907        return ticket.r_code or state in (INITIALIZED, SUBMITTED)
908
909    def emit_lock_message(self):
910        self.flash(_('The requested form is locked (read-only).'))
911        self.redirect(self.url(self.context))
912        return
913
914    def update(self):
915        if self.context.locked or (
916            self.context.__parent__.expired and
917            self.context.__parent__.strict_deadline):
918            self.emit_lock_message()
919            return
920        super(ApplicantEditFormPage, self).update()
921        return
922
923    def dataNotComplete(self):
924        store = getUtility(IExtFileStore)
925        if not store.getFileByContext(self.context, attr=u'passport.jpg'):
926            return _('No passport picture uploaded.')
927        if not self.request.form.get('confirm_passport', False):
928            return _('Passport picture confirmation box not ticked.')
929        return False
930
931    # We explicitely want the forms to be validated before payment tickets
932    # can be created. If no validation is requested, use
933    # 'validator=NullValidator' in the action directive
934    @action(_('Add online payment ticket'))
935    def addPaymentTicket(self, **data):
936        self.redirect(self.url(self.context, '@@addafp'))
937        return
938
939    @jsaction(_('Remove selected tickets'))
940    def removePaymentTickets(self, **data):
941        self.delPaymentTickets(**data)
942        self.redirect(self.url(self.context) + '/@@edit')
943        return
944
945    @action(_('Save'), style='primary')
946    def save(self, **data):
947        if self.passport_changed is False:  # False is not None!
948            return # error during image upload. Ignore other values
949        self.applyData(self.context, **data)
950        self.flash('Form has been saved.')
951        return
952
953    @submitaction(_('Final Submit'))
954    def finalsubmit(self, **data):
955        if self.passport_changed is False:  # False is not None!
956            return # error during image upload. Ignore other values
957        if self.dataNotComplete():
958            self.flash(self.dataNotComplete())
959            return
960        self.applyData(self.context, **data)
961        state = IWorkflowState(self.context).getState()
962        # This shouldn't happen, but the application officer
963        # might have forgotten to lock the form after changing the state
964        if state != PAID:
965            self.flash(_('The form cannot be submitted. Wrong state!'))
966            return
967        IWorkflowInfo(self.context).fireTransition('submit')
968        # application_date is used in export files for sorting.
969        # We can thus store utc.
970        self.context.application_date = datetime.utcnow()
971        self.context.locked = True
972        self.flash(_('Form has been submitted.'))
973        self.redirect(self.url(self.context))
974        return
975
976class PassportImage(grok.View):
977    """Renders the passport image for applicants.
978    """
979    grok.name('passport.jpg')
980    grok.context(IApplicant)
981    grok.require('waeup.viewApplication')
982
983    def render(self):
984        # A filename chooser turns a context into a filename suitable
985        # for file storage.
986        image = getUtility(IExtFileStore).getFileByContext(self.context)
987        self.response.setHeader(
988            'Content-Type', 'image/jpeg')
989        if image is None:
990            # show placeholder image
991            return open(DEFAULT_PASSPORT_IMAGE_PATH, 'rb').read()
992        return image
993
994class ApplicantRegistrationPage(KofaAddFormPage):
995    """Captcha'd registration page for applicants.
996    """
997    grok.context(IApplicantsContainer)
998    grok.name('register')
999    grok.require('waeup.Anonymous')
1000    grok.template('applicantregister')
1001
1002    @property
1003    def form_fields(self):
1004        form_fields = None
1005        if self.context.mode == 'update':
1006            form_fields = grok.AutoFields(IApplicantRegisterUpdate).select(
1007                'firstname','reg_number','email')
1008        else: #if self.context.mode == 'create':
1009            form_fields = grok.AutoFields(IApplicantEdit).select(
1010                'firstname', 'middlename', 'lastname', 'email', 'phone')
1011        return form_fields
1012
1013    @property
1014    def label(self):
1015        return _('Apply for ${a}',
1016            mapping = {'a':self.context.title})
1017
1018    def update(self):
1019        if self.context.expired:
1020            self.flash(_('Outside application period.'))
1021            self.redirect(self.url(self.context))
1022            return
1023        # Handle captcha
1024        self.captcha = getUtility(ICaptchaManager).getCaptcha()
1025        self.captcha_result = self.captcha.verify(self.request)
1026        self.captcha_code = self.captcha.display(self.captcha_result.error_code)
1027        return
1028
1029    def _redirect(self, email, password, applicant_id):
1030        # Forward only email to landing page in base package.
1031        self.redirect(self.url(self.context, 'registration_complete',
1032            data = dict(email=email)))
1033        return
1034
1035    @action(_('Get login credentials'), style='primary')
1036    def register(self, **data):
1037        if not self.captcha_result.is_valid:
1038            # Captcha will display error messages automatically.
1039            # No need to flash something.
1040            return
1041        if self.context.mode == 'create':
1042            # Add applicant
1043            applicant = createObject(u'waeup.Applicant')
1044            self.applyData(applicant, **data)
1045            self.context.addApplicant(applicant)
1046            applicant.reg_number = applicant.applicant_id
1047            notify(grok.ObjectModifiedEvent(applicant))
1048        elif self.context.mode == 'update':
1049            # Update applicant
1050            reg_number = data.get('reg_number','')
1051            firstname = data.get('firstname','')
1052            cat = getUtility(ICatalog, name='applicants_catalog')
1053            results = list(
1054                cat.searchResults(reg_number=(reg_number, reg_number)))
1055            if results:
1056                applicant = results[0]
1057                if getattr(applicant,'firstname',None) is None:
1058                    self.flash(_('An error occurred.'))
1059                    return
1060                elif applicant.firstname.lower() != firstname.lower():
1061                    # Don't tell the truth here. Anonymous must not
1062                    # know that a record was found and only the firstname
1063                    # verification failed.
1064                    self.flash(_('No application record found.'))
1065                    return
1066                elif applicant.password is not None and \
1067                    applicant.state != INITIALIZED:
1068                    self.flash(_('Your password has already been set and used. '
1069                                 'Please proceed to the login page.'))
1070                    return
1071                # Store email address but nothing else.
1072                applicant.email = data['email']
1073                notify(grok.ObjectModifiedEvent(applicant))
1074            else:
1075                # No record found, this is the truth.
1076                self.flash(_('No application record found.'))
1077                return
1078        else:
1079            # Does not happen but anyway ...
1080            return
1081        kofa_utils = getUtility(IKofaUtils)
1082        password = kofa_utils.genPassword()
1083        IUserAccount(applicant).setPassword(password)
1084        # Send email with credentials
1085        login_url = self.url(grok.getSite(), 'login')
1086        url_info = u'Login: %s' % login_url
1087        msg = _('You have successfully been registered for the')
1088        if kofa_utils.sendCredentials(IUserAccount(applicant),
1089            password, url_info, msg):
1090            email_sent = applicant.email
1091        else:
1092            email_sent = None
1093        self._redirect(email=email_sent, password=password,
1094            applicant_id=applicant.applicant_id)
1095        return
1096
1097class ApplicantRegistrationEmailSent(KofaPage):
1098    """Landing page after successful registration.
1099
1100    """
1101    grok.name('registration_complete')
1102    grok.require('waeup.Public')
1103    grok.template('applicantregemailsent')
1104    label = _('Your registration was successful.')
1105
1106    def update(self, email=None, applicant_id=None, password=None):
1107        self.email = email
1108        self.password = password
1109        self.applicant_id = applicant_id
1110        return
Note: See TracBrowser for help on using the repository browser.