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

Last change on this file since 10694 was 10655, checked in by Henrik Bettermann, 11 years ago

Implement an VirtualApplicantsExportJobContainer? which allows to export applicants locally. On each container page there is now an'Export applicants' button which directs to the exports overview page. Unlike student exporters, the applicants exporter can't be configured. It just exports all applicants in the container.

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