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

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