source: main/waeup.kofa/trunk/src/waeup/kofa/students/browser.py @ 9421

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

Reorganize ICourseTicket. Add ICourseTicketImport which validates a new field called level_session.

Customize checkConversion of CourseTicketProcessor?:
If level_session is provided in row the importer checks if
the parent studylevel exists and if its level_session
attribute corresponds with the expected value in row. The error message
then tells us why course result import fails.

  • Property svn:keywords set to Id
File size: 84.4 KB
RevLine 
[7191]1## $Id: browser.py 9420 2012-10-25 21:52:10Z henrik $
2##
[6621]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 students and related components.
19"""
[7006]20import sys
[6621]21import grok
[7275]22from urllib import urlencode
[7256]23from datetime import datetime
[8143]24from copy import deepcopy
[7015]25from zope.event import notify
[7723]26from zope.i18n import translate
[6996]27from zope.catalog.interfaces import ICatalog
[7386]28from zope.component import queryUtility, getUtility, createObject
[8099]29from zope.schema.interfaces import ConstraintNotSatisfied
[7386]30from zope.formlib.textwidgets import BytesDisplayWidget
[6621]31from hurry.workflow.interfaces import IWorkflowInfo, IWorkflowState
[7811]32from waeup.kofa.accesscodes import (
[8420]33    invalidate_accesscode, get_access_code)
[7811]34from waeup.kofa.accesscodes.workflow import USED
[9217]35from waeup.kofa.browser.layout import (
[7819]36    KofaPage, KofaEditFormPage, KofaAddFormPage, KofaDisplayFormPage,
[9217]37    KofaForm, NullValidator)
38from waeup.kofa.browser.pages import ContactAdminForm
[7811]39from waeup.kofa.browser.breadcrumbs import Breadcrumb
40from waeup.kofa.browser.resources import datepicker, datatable, tabs, warning
41from waeup.kofa.browser.layout import jsaction, action, UtilityView
[8779]42from waeup.kofa.browser.interfaces import ICaptchaManager
[7811]43from waeup.kofa.interfaces import (
[7819]44    IKofaObject, IUserAccount, IExtFileStore, IPasswordValidator, IContactForm,
[9124]45    IKofaUtils, IUniversity, IObjectHistory)
[7811]46from waeup.kofa.interfaces import MessageFactory as _
[8170]47from waeup.kofa.widgets.datewidget import (
48    FriendlyDateWidget, FriendlyDateDisplayWidget,
49    FriendlyDatetimeDisplayWidget)
[7868]50from waeup.kofa.widgets.restwidget import ReSTDisplayWidget
[7811]51from waeup.kofa.students.interfaces import (
[7993]52    IStudentsContainer, IStudent,
53    IUGStudentClearance,IPGStudentClearance,
[6859]54    IStudentPersonal, IStudentBase, IStudentStudyCourse,
[9138]55    IStudentStudyCourseTransfer,
[7538]56    IStudentAccommodation, IStudentStudyLevel,
[6877]57    ICourseTicket, ICourseTicketAdd, IStudentPaymentsContainer,
[9148]58    IStudentOnlinePayment, IStudentPreviousPayment,
59    IBedTicket, IStudentsUtils, IStudentRequestPW
[6621]60    )
[7811]61from waeup.kofa.students.catalog import search
[8779]62from waeup.kofa.students.workflow import (CREATED, ADMITTED, PAID,
[9028]63    CLEARANCE, REQUESTED, RETURNING, CLEARED, REGISTERED, VALIDATED,
64    FORBIDDEN_POSTGRAD_TRANS)
[7811]65from waeup.kofa.students.studylevel import StudentStudyLevel, CourseTicket
66from waeup.kofa.students.vocabularies import StudyLevelSource
67from waeup.kofa.browser.resources import toggleall
68from waeup.kofa.hostels.hostel import NOT_OCCUPIED
[8737]69from waeup.kofa.utils.helpers import get_current_principal, to_timezone
[8857]70from waeup.kofa.mandates.mandate import PasswordMandate
[6621]71
[8779]72grok.context(IKofaObject) # Make IKofaObject the default context
73
[8737]74# Save function used for save methods in pages
75def msave(view, **data):
76    changed_fields = view.applyData(view.context, **data)
77    # Turn list of lists into single list
78    if changed_fields:
79        changed_fields = reduce(lambda x,y: x+y, changed_fields.values())
80    # Inform catalog if certificate has changed
81    # (applyData does this only for the context)
82    if 'certificate' in changed_fields:
83        notify(grok.ObjectModifiedEvent(view.context.student))
84    fields_string = ' + '.join(changed_fields)
85    view.flash(_('Form has been saved.'))
86    if fields_string:
87        view.context.writeLogMessage(view, 'saved: %s' % fields_string)
88    return
89
[7145]90def emit_lock_message(view):
[7642]91    """Flash a lock message.
92    """
[7723]93    view.flash(_('The requested form is locked (read-only).'))
[7133]94    view.redirect(view.url(view.context))
95    return
96
[8921]97def translated_values(view):
98    lang = view.request.cookies.get('kofa.language')
99    for value in view.context.values():
[9328]100        # We have to unghostify (according to Tres Seaver) the __dict__
101        # by activating the object, otherwise value_dict will be empty
102        # when calling the first time.
[9330]103        value._p_activate()
[8921]104        value_dict = dict([i for i in value.__dict__.items()])
105        value_dict['mandatory_bool'] = value.mandatory
106        value_dict['mandatory'] = translate(str(value.mandatory), 'zope',
107            target_language=lang)
108        value_dict['carry_over'] = translate(str(value.carry_over), 'zope',
109            target_language=lang)
110        value_dict['automatic'] = translate(str(value.automatic), 'zope',
111            target_language=lang)
112        yield value_dict
113
[6629]114class StudentsBreadcrumb(Breadcrumb):
115    """A breadcrumb for the students container.
116    """
117    grok.context(IStudentsContainer)
[7723]118    title = _('Students')
[6629]119
[7459]120    @property
121    def target(self):
122        user = get_current_principal()
123        if getattr(user, 'user_type', None) == 'student':
124            return None
125        return self.viewname
126
[6818]127class StudentBreadcrumb(Breadcrumb):
128    """A breadcrumb for the student container.
129    """
130    grok.context(IStudent)
131
132    def title(self):
[7364]133        return self.context.display_fullname
[6818]134
[6635]135class SudyCourseBreadcrumb(Breadcrumb):
136    """A breadcrumb for the student study course.
137    """
138    grok.context(IStudentStudyCourse)
139
[9140]140    def title(self):
141        if self.context.is_current:
142            return _('Study Course')
143        else:
144            return _('Previous Study Course')
145
[6635]146class PaymentsBreadcrumb(Breadcrumb):
147    """A breadcrumb for the student payments folder.
148    """
[6859]149    grok.context(IStudentPaymentsContainer)
[7723]150    title = _('Payments')
[6635]151
[6870]152class OnlinePaymentBreadcrumb(Breadcrumb):
[7251]153    """A breadcrumb for payments.
[6870]154    """
[6877]155    grok.context(IStudentOnlinePayment)
[6870]156
157    @property
158    def title(self):
159        return self.context.p_id
160
[6635]161class AccommodationBreadcrumb(Breadcrumb):
162    """A breadcrumb for the student accommodation folder.
163    """
164    grok.context(IStudentAccommodation)
[7723]165    title = _('Accommodation')
[6635]166
[6994]167class BedTicketBreadcrumb(Breadcrumb):
168    """A breadcrumb for bed tickets.
169    """
170    grok.context(IBedTicket)
[7009]171
[6994]172    @property
173    def title(self):
[7723]174        return _('Bed Ticket ${a}',
175            mapping = {'a':self.context.getSessionString()})
[6994]176
[6776]177class StudyLevelBreadcrumb(Breadcrumb):
178    """A breadcrumb for course lists.
179    """
180    grok.context(IStudentStudyLevel)
181
182    @property
183    def title(self):
[7834]184        return self.context.level_title
[6776]185
[7819]186class StudentsContainerPage(KofaPage):
[6626]187    """The standard view for student containers.
[6621]188    """
189    grok.context(IStudentsContainer)
190    grok.name('index')
[7240]191    grok.require('waeup.viewStudentsContainer')
[6695]192    grok.template('containerpage')
[7723]193    label = _('Student Section')
[7735]194    search_button = _('Search')
[6642]195    pnav = 4
[6621]196
[6626]197    def update(self, *args, **kw):
198        datatable.need()
199        form = self.request.form
200        self.hitlist = []
201        if 'searchterm' in form and form['searchterm']:
202            self.searchterm = form['searchterm']
203            self.searchtype = form['searchtype']
204        elif 'old_searchterm' in form:
205            self.searchterm = form['old_searchterm']
206            self.searchtype = form['old_searchtype']
207        else:
208            if 'search' in form:
[7745]209                self.flash(_('Empty search string'))
[6626]210            return
[7068]211        if self.searchtype == 'current_session':
[8081]212            try:
213                self.searchterm = int(self.searchterm)
214            except ValueError:
[8404]215                self.flash(_('Only year dates allowed (e.g. 2011).'))
[8081]216                return
[6626]217        self.hitlist = search(query=self.searchterm,
218            searchtype=self.searchtype, view=self)
219        if not self.hitlist:
[8404]220            self.flash(_('No student found.'))
[6626]221        return
222
[7819]223class StudentsContainerManagePage(KofaPage):
[6626]224    """The manage page for student containers.
[6622]225    """
226    grok.context(IStudentsContainer)
227    grok.name('manage')
[7136]228    grok.require('waeup.manageStudent')
[6695]229    grok.template('containermanagepage')
[6642]230    pnav = 4
[7723]231    label = _('Manage student section')
[7735]232    search_button = _('Search')
233    remove_button = _('Remove selected')
[6622]234
[6626]235    def update(self, *args, **kw):
236        datatable.need()
[6820]237        toggleall.need()
[7329]238        warning.need()
[6626]239        form = self.request.form
240        self.hitlist = []
241        if 'searchterm' in form and form['searchterm']:
242            self.searchterm = form['searchterm']
243            self.searchtype = form['searchtype']
244        elif 'old_searchterm' in form:
245            self.searchterm = form['old_searchterm']
246            self.searchtype = form['old_searchtype']
247        else:
248            if 'search' in form:
[7745]249                self.flash(_('Empty search string'))
[6626]250            return
[8082]251        if self.searchtype == 'current_session':
252            try:
253                self.searchterm = int(self.searchterm)
254            except ValueError:
255                self.flash('Only year dates allowed (e.g. 2011).')
256                return
[6626]257        if not 'entries' in form:
258            self.hitlist = search(query=self.searchterm,
259                searchtype=self.searchtype, view=self)
260            if not self.hitlist:
[7723]261                self.flash(_('No student found.'))
[7459]262            if 'remove' in form:
[7723]263                self.flash(_('No item selected.'))
[6626]264            return
265        entries = form['entries']
266        if isinstance(entries, basestring):
267            entries = [entries]
268        deleted = []
269        for entry in entries:
270            if 'remove' in form:
271                del self.context[entry]
272                deleted.append(entry)
273        self.hitlist = search(query=self.searchterm,
274            searchtype=self.searchtype, view=self)
275        if len(deleted):
[7723]276            self.flash(_('Successfully removed: ${a}',
277                mapping = {'a':', '.join(deleted)}))
[6622]278        return
279
[7819]280class StudentAddFormPage(KofaAddFormPage):
[6622]281    """Add-form to add a student.
282    """
283    grok.context(IStudentsContainer)
[7136]284    grok.require('waeup.manageStudent')
[6622]285    grok.name('addstudent')
[7357]286    form_fields = grok.AutoFields(IStudent).select(
[7520]287        'firstname', 'middlename', 'lastname', 'reg_number')
[7723]288    label = _('Add student')
[6642]289    pnav = 4
[6622]290
[7723]291    @action(_('Create student record'), style='primary')
[6622]292    def addStudent(self, **data):
293        student = createObject(u'waeup.Student')
294        self.applyData(student, **data)
[6652]295        self.context.addStudent(student)
[7723]296        self.flash(_('Student record created.'))
[6651]297        self.redirect(self.url(self.context[student.student_id], 'index'))
[6622]298        return
299
[9338]300class LoginAsStudentStep1(KofaEditFormPage):
301    """ View to temporarily set a student password.
302    """
303    grok.context(IStudent)
304    grok.name('loginasstep1')
305    grok.require('waeup.loginAsStudent')
306    grok.template('loginasstep1')
307    pnav = 4
308
309    def label(self):
310        return _(u'Set temporary password for ${a}',
311            mapping = {'a':self.context.display_fullname})
312
313    @action('Set password now', style='primary')
314    def setPassword(self, *args, **data):
315        kofa_utils = getUtility(IKofaUtils)
316        password = kofa_utils.genPassword()
317        self.context.setTempPassword(self.request.principal.id, password)
318        self.context.writeLogMessage(
319            self, 'temp_password generated: %s' % password)
320        args = {'password':password}
321        self.redirect(self.url(self.context) +
322            '/loginasstep2?%s' % urlencode(args))
323        return
324
325class LoginAsStudentStep2(KofaPage):
326    """ View to temporarily login as student with a temporary password.
327    """
328    grok.context(IStudent)
329    grok.name('loginasstep2')
330    grok.require('waeup.Public')
331    grok.template('loginasstep2')
332    login_button = _('Login now')
333    pnav = 4
334
335    def label(self):
336        return _(u'Login as ${a}',
337            mapping = {'a':self.context.student_id})
338
339    def update(self, SUBMIT=None, password=None):
340        self.password = password
341        if SUBMIT is not None:
342            self.flash(_('You successfully logged in as student.'))
343            self.redirect(self.url(self.context))
344        return
345
[7819]346class StudentBaseDisplayFormPage(KofaDisplayFormPage):
[6631]347    """ Page to display student base data
348    """
[6622]349    grok.context(IStudent)
350    grok.name('index')
[6660]351    grok.require('waeup.viewStudent')
[6695]352    grok.template('basepage')
[8983]353    form_fields = grok.AutoFields(IStudentBase).omit('password', 'suspended')
[6642]354    pnav = 4
[6622]355
356    @property
357    def label(self):
[8983]358        if self.context.suspended:
[9124]359            return _('${a}: Base Data (account deactivated)',
[8983]360                mapping = {'a':self.context.display_fullname})
361        return  _('${a}: Base Data',
[7723]362            mapping = {'a':self.context.display_fullname})
[6631]363
[6699]364    @property
365    def hasPassword(self):
366        if self.context.password:
[7723]367            return _('set')
368        return _('unset')
[6699]369
[9141]370class StudentBasePDFFormPage(KofaDisplayFormPage):
371    """ Page to display student base data in pdf files.
372    """
373
[9374]374    def __init__(self, context, request, omit_fields):
375        self.omit_fields = omit_fields
376        super(StudentBasePDFFormPage, self).__init__(context, request)
377
378    @property
379    def form_fields(self):
380        form_fields = grok.AutoFields(IStudentBase)
381        for field in self.omit_fields:
382            form_fields = form_fields.omit(field)
383        return form_fields
384
[7229]385class ContactStudentForm(ContactAdminForm):
386    grok.context(IStudent)
[7230]387    grok.name('contactstudent')
[7275]388    grok.require('waeup.viewStudent')
[7229]389    pnav = 4
390    form_fields = grok.AutoFields(IContactForm).select('subject', 'body')
391
[7275]392    def update(self, subject=u''):
393        self.form_fields.get('subject').field.default = subject
394        self.subject = subject
395        return
396
[7229]397    def label(self):
[7723]398        return _(u'Send message to ${a}',
399            mapping = {'a':self.context.display_fullname})
[7229]400
[7459]401    @action('Send message now', style='primary')
[7229]402    def send(self, *args, **data):
[7234]403        try:
[7403]404            email = self.request.principal.email
[7234]405        except AttributeError:
[7403]406            email = self.config.email_admin
407        usertype = getattr(self.request.principal,
408                           'user_type', 'system').title()
[7819]409        kofa_utils = getUtility(IKofaUtils)
[7811]410        success = kofa_utils.sendContactForm(
[7403]411                self.request.principal.title,email,
412                self.context.display_fullname,self.context.email,
413                self.request.principal.id,usertype,
414                self.config.name,
415                data['body'],data['subject'])
[7229]416        if success:
[7723]417            self.flash(_('Your message has been sent.'))
[7229]418        else:
[7723]419            self.flash(_('An smtp server error occurred.'))
[7229]420        return
421
[9191]422class ExportPDFAdmissionSlipPage(UtilityView, grok.View):
423    """Deliver a PDF Admission slip.
424    """
425    grok.context(IStudent)
426    grok.name('admission_slip.pdf')
427    grok.require('waeup.viewStudent')
428    prefix = 'form'
429
430    form_fields = grok.AutoFields(IStudentBase).select('student_id', 'reg_number')
431
432    @property
433    def label(self):
434        portal_language = getUtility(IKofaUtils).PORTAL_LANGUAGE
435        return translate(_('Admission Letter of'),
436            'waeup.kofa', target_language=portal_language) \
437            + ' %s' % self.context.display_fullname
438
439    def render(self):
440        students_utils = getUtility(IStudentsUtils)
441        return students_utils.renderPDFAdmissionLetter(self,
442            self.context.student)
443
[7819]444class StudentBaseManageFormPage(KofaEditFormPage):
[7133]445    """ View to manage student base data
[6631]446    """
447    grok.context(IStudent)
[7133]448    grok.name('manage_base')
[7136]449    grok.require('waeup.manageStudent')
[9124]450    form_fields = grok.AutoFields(IStudentBase).omit(
451        'student_id', 'adm_code', 'suspended')
[6695]452    grok.template('basemanagepage')
[7723]453    label = _('Manage base data')
[6642]454    pnav = 4
[6631]455
[6638]456    def update(self):
457        datepicker.need() # Enable jQuery datepicker in date fields.
[7134]458        tabs.need()
[7490]459        self.tab1 = self.tab2 = ''
460        qs = self.request.get('QUERY_STRING', '')
461        if not qs:
462            qs = 'tab1'
463        setattr(self, qs, 'active')
[6638]464        super(StudentBaseManageFormPage, self).update()
465        self.wf_info = IWorkflowInfo(self.context)
466        return
467
[7723]468    @action(_('Save'), style='primary')
[6638]469    def save(self, **data):
[6701]470        form = self.request.form
[6790]471        password = form.get('password', None)
472        password_ctl = form.get('control_password', None)
473        if password:
[7147]474            validator = getUtility(IPasswordValidator)
475            errors = validator.validate_password(password, password_ctl)
476            if errors:
477                self.flash( ' '.join(errors))
478                return
479        changed_fields = self.applyData(self.context, **data)
[6771]480        # Turn list of lists into single list
481        if changed_fields:
482            changed_fields = reduce(lambda x,y: x+y, changed_fields.values())
[7147]483        else:
484            changed_fields = []
485        if password:
[9273]486            # Now we know that the form has no errors and can set password
[7147]487            IUserAccount(self.context).setPassword(password)
488            changed_fields.append('password')
489        fields_string = ' + '.join(changed_fields)
[7723]490        self.flash(_('Form has been saved.'))
[6644]491        if fields_string:
[8735]492            self.context.writeLogMessage(self, 'saved: % s' % fields_string)
[6638]493        return
494
[9273]495class StudentTriggerTransitionFormPage(KofaEditFormPage):
496    """ View to manage student base data
497    """
498    grok.context(IStudent)
499    grok.name('trigtrans')
500    grok.require('waeup.triggerTransition')
501    grok.template('trigtrans')
502    label = _('Trigger registration transition')
503    pnav = 4
504
505    def getTransitions(self):
506        """Return a list of dicts of allowed transition ids and titles.
507
508        Each list entry provides keys ``name`` and ``title`` for
509        internal name and (human readable) title of a single
510        transition.
511        """
512        wf_info = IWorkflowInfo(self.context)
513        allowed_transitions = [t for t in wf_info.getManualTransitions()
514            if not t[0].startswith('pay')]
515        if self.context.is_postgrad:
516            allowed_transitions = [t for t in allowed_transitions
517                if not t[0] in FORBIDDEN_POSTGRAD_TRANS]
518        return [dict(name='', title=_('No transition'))] +[
519            dict(name=x, title=y) for x, y in allowed_transitions]
520
521    @action(_('Save'), style='primary')
522    def save(self, **data):
523        form = self.request.form
524        if form.has_key('transition') and form['transition']:
525            transition_id = form['transition']
526            wf_info = IWorkflowInfo(self.context)
527            wf_info.fireTransition(transition_id)
528        return
529
[9124]530class StudentActivatePage(UtilityView, grok.View):
531    """ Activate student account
532    """
533    grok.context(IStudent)
534    grok.name('activate')
535    grok.require('waeup.manageStudent')
536
537    def update(self):
538        self.context.suspended = False
539        self.context.writeLogMessage(self, 'account activated')
540        history = IObjectHistory(self.context)
541        history.addMessage('Student account activated')
542        self.flash(_('Student account has been activated.'))
543        self.redirect(self.url(self.context))
544        return
545
546    def render(self):
547        return
548
549class StudentDeactivatePage(UtilityView, grok.View):
550    """ Deactivate student account
551    """
552    grok.context(IStudent)
553    grok.name('deactivate')
554    grok.require('waeup.manageStudent')
555
556    def update(self):
557        self.context.suspended = True
558        self.context.writeLogMessage(self, 'account deactivated')
559        history = IObjectHistory(self.context)
560        history.addMessage('Student account deactivated')
561        self.flash(_('Student account has been deactivated.'))
562        self.redirect(self.url(self.context))
563        return
564
565    def render(self):
566        return
567
[7819]568class StudentClearanceDisplayFormPage(KofaDisplayFormPage):
[6631]569    """ Page to display student clearance data
570    """
571    grok.context(IStudent)
572    grok.name('view_clearance')
[6660]573    grok.require('waeup.viewStudent')
[6642]574    pnav = 4
[6631]575
576    @property
[8099]577    def separators(self):
578        return getUtility(IStudentsUtils).SEPARATORS_DICT
579
580    @property
[7993]581    def form_fields(self):
[8472]582        if self.context.is_postgrad:
[8977]583            form_fields = grok.AutoFields(
584                IPGStudentClearance).omit('clearance_locked')
[7993]585        else:
[8977]586            form_fields = grok.AutoFields(
587                IUGStudentClearance).omit('clearance_locked')
[7993]588        return form_fields
589
590    @property
[6631]591    def label(self):
[7723]592        return _('${a}: Clearance Data',
593            mapping = {'a':self.context.display_fullname})
[6631]594
[7277]595class ExportPDFClearanceSlipPage(grok.View):
596    """Deliver a PDF slip of the context.
597    """
598    grok.context(IStudent)
599    grok.name('clearance.pdf')
600    grok.require('waeup.viewStudent')
601    prefix = 'form'
[9375]602    omit_fields = ('password', 'suspended', 'phone', 'adm_code', 'sex')
[7277]603
604    @property
[7993]605    def form_fields(self):
[8472]606        if self.context.is_postgrad:
[8977]607            form_fields = grok.AutoFields(
608                IPGStudentClearance).omit('clearance_locked')
[7993]609        else:
[8977]610            form_fields = grok.AutoFields(
611                IUGStudentClearance).omit('clearance_locked')
[7993]612        return form_fields
613
614    @property
[7723]615    def title(self):
[7819]616        portal_language = getUtility(IKofaUtils).PORTAL_LANGUAGE
[7811]617        return translate(_('Clearance Data'), 'waeup.kofa',
[7723]618            target_language=portal_language)
619
620    @property
[7277]621    def label(self):
[7819]622        portal_language = getUtility(IKofaUtils).PORTAL_LANGUAGE
[9026]623        return translate(_('Clearance Slip of'),
[7811]624            'waeup.kofa', target_language=portal_language) \
[7723]625            + ' %s' % self.context.display_fullname
[7277]626
[9010]627    def _signatures(self):
628        if self.context.state == CLEARED:
629            return (_('Student Signature'), _('Clearance Officer Signature'))
630        return
631
[7277]632    def render(self):
[9141]633        studentview = StudentBasePDFFormPage(self.context.student,
[9375]634            self.request, self.omit_fields)
[7277]635        students_utils = getUtility(IStudentsUtils)
636        return students_utils.renderPDF(
[7318]637            self, 'clearance.pdf',
[9010]638            self.context.student, studentview, signatures=self._signatures())
[7277]639
[7819]640class StudentClearanceManageFormPage(KofaEditFormPage):
[8120]641    """ Page to manage student clearance data
[6631]642    """
643    grok.context(IStudent)
[8119]644    grok.name('manage_clearance')
[7136]645    grok.require('waeup.manageStudent')
[7134]646    grok.template('clearanceeditpage')
[7723]647    label = _('Manage clearance data')
[6642]648    pnav = 4
[6650]649
[7993]650    @property
[8099]651    def separators(self):
652        return getUtility(IStudentsUtils).SEPARATORS_DICT
653
654    @property
[7993]655    def form_fields(self):
[8472]656        if self.context.is_postgrad:
[8977]657            form_fields = grok.AutoFields(IPGStudentClearance).omit('clr_code')
[7993]658        else:
[8977]659            form_fields = grok.AutoFields(IUGStudentClearance).omit('clr_code')
[7993]660        return form_fields
661
[6650]662    def update(self):
663        datepicker.need() # Enable jQuery datepicker in date fields.
[7134]664        tabs.need()
[7490]665        self.tab1 = self.tab2 = ''
666        qs = self.request.get('QUERY_STRING', '')
667        if not qs:
668            qs = 'tab1'
669        setattr(self, qs, 'active')
[6650]670        return super(StudentClearanceManageFormPage, self).update()
671
[7723]672    @action(_('Save'), style='primary')
[6695]673    def save(self, **data):
[6762]674        msave(self, **data)
[6695]675        return
676
[7459]677class StudentClearPage(UtilityView, grok.View):
[7158]678    """ Clear student by clearance officer
679    """
680    grok.context(IStudent)
681    grok.name('clear')
682    grok.require('waeup.clearStudent')
683
684    def update(self):
685        if self.context.state == REQUESTED:
686            IWorkflowInfo(self.context).fireTransition('clear')
[7723]687            self.flash(_('Student has been cleared.'))
[7158]688        else:
[7723]689            self.flash(_('Student is in wrong state.'))
[7158]690        self.redirect(self.url(self.context,'view_clearance'))
691        return
692
693    def render(self):
694        return
695
[7459]696class StudentRejectClearancePage(UtilityView, grok.View):
[7158]697    """ Reject clearance by clearance officers
698    """
699    grok.context(IStudent)
700    grok.name('reject_clearance')
701    grok.require('waeup.clearStudent')
702
703    def update(self):
704        if self.context.state == CLEARED:
705            IWorkflowInfo(self.context).fireTransition('reset4')
[7723]706            message = _('Clearance has been annulled.')
[7275]707            self.flash(message)
[7158]708        elif self.context.state == REQUESTED:
709            IWorkflowInfo(self.context).fireTransition('reset3')
[7723]710            message = _('Clearance request has been rejected.')
[7275]711            self.flash(message)
[7158]712        else:
[7723]713            self.flash(_('Student is in wrong state.'))
[7334]714            self.redirect(self.url(self.context,'view_clearance'))
[7275]715            return
716        args = {'subject':message}
717        self.redirect(self.url(self.context) +
718            '/contactstudent?%s' % urlencode(args))
[7158]719        return
720
721    def render(self):
722        return
723
[7819]724class StudentPersonalDisplayFormPage(KofaDisplayFormPage):
[6631]725    """ Page to display student personal data
726    """
727    grok.context(IStudent)
728    grok.name('view_personal')
[6660]729    grok.require('waeup.viewStudent')
[6631]730    form_fields = grok.AutoFields(IStudentPersonal)
[7386]731    form_fields['perm_address'].custom_widget = BytesDisplayWidget
[6642]732    pnav = 4
[6631]733
734    @property
735    def label(self):
[7723]736        return _('${a}: Personal Data',
737            mapping = {'a':self.context.display_fullname})
[6631]738
[8903]739class StudentPersonalManageFormPage(KofaEditFormPage):
740    """ Page to manage personal data
[6631]741    """
742    grok.context(IStudent)
[8903]743    grok.name('manage_personal')
744    grok.require('waeup.manageStudent')
[6631]745    form_fields = grok.AutoFields(IStudentPersonal)
[8903]746    label = _('Manage personal data')
[6642]747    pnav = 4
[6631]748
[7723]749    @action(_('Save'), style='primary')
[6762]750    def save(self, **data):
751        msave(self, **data)
752        return
753
[8903]754class StudentPersonalEditFormPage(StudentPersonalManageFormPage):
755    """ Page to edit personal data
756    """
757    grok.name('edit_personal')
758    grok.require('waeup.handleStudent')
759    label = _('Edit personal data')
760    pnav = 4
761
[7819]762class StudyCourseDisplayFormPage(KofaDisplayFormPage):
[6635]763    """ Page to display the student study course data
764    """
765    grok.context(IStudentStudyCourse)
766    grok.name('index')
[6660]767    grok.require('waeup.viewStudent')
[6775]768    grok.template('studycoursepage')
[6642]769    pnav = 4
[6635]770
771    @property
[8972]772    def form_fields(self):
773        if self.context.is_postgrad:
774            form_fields = grok.AutoFields(IStudentStudyCourse).omit(
775                'current_verdict', 'previous_verdict')
776        else:
777            form_fields = grok.AutoFields(IStudentStudyCourse)
778        return form_fields
779
780    @property
[6635]781    def label(self):
[9140]782        if self.context.is_current:
783            return _('${a}: Study Course',
784                mapping = {'a':self.context.__parent__.display_fullname})
785        else:
786            return _('${a}: Previous Study Course',
787                mapping = {'a':self.context.__parent__.display_fullname})
[6635]788
[6912]789    @property
790    def current_mode(self):
[7641]791        if self.context.certificate is not None:
[7841]792            studymodes_dict = getUtility(IKofaUtils).STUDY_MODES_DICT
[7681]793            return studymodes_dict[self.context.certificate.study_mode]
[7171]794        return
[7642]795
[7171]796    @property
797    def department(self):
[7205]798        if self.context.certificate is not None:
[7171]799            return self.context.certificate.__parent__.__parent__
800        return
[6912]801
[7171]802    @property
803    def faculty(self):
[7205]804        if self.context.certificate is not None:
[7171]805            return self.context.certificate.__parent__.__parent__.__parent__
806        return
807
[9140]808    @property
809    def prev_studycourses(self):
810        if self.context.is_current:
811            if self.context.__parent__.get('studycourse_2', None) is not None:
812                return (
813                        {'href':self.url(self.context.student) + '/studycourse_1',
814                        'title':_('First Study Course, ')},
815                        {'href':self.url(self.context.student) + '/studycourse_2',
816                        'title':_('Second Study Course')}
817                        )
818            if self.context.__parent__.get('studycourse_1', None) is not None:
819                return (
820                        {'href':self.url(self.context.student) + '/studycourse_1',
821                        'title':_('First Study Course')},
822                        )
823        return
824
[7819]825class StudyCourseManageFormPage(KofaEditFormPage):
[6649]826    """ Page to edit the student study course data
827    """
828    grok.context(IStudentStudyCourse)
[6775]829    grok.name('manage')
[7136]830    grok.require('waeup.manageStudent')
[6775]831    grok.template('studycoursemanagepage')
[7723]832    label = _('Manage study course')
[6649]833    pnav = 4
[7723]834    taboneactions = [_('Save'),_('Cancel')]
835    tabtwoactions = [_('Remove selected levels'),_('Cancel')]
836    tabthreeactions = [_('Add study level')]
[6649]837
[8972]838    @property
839    def form_fields(self):
840        if self.context.is_postgrad:
841            form_fields = grok.AutoFields(IStudentStudyCourse).omit(
842                'current_verdict', 'previous_verdict')
843        else:
844            form_fields = grok.AutoFields(IStudentStudyCourse)
845        return form_fields
846
[6775]847    def update(self):
[9139]848        if not self.context.is_current:
849            emit_lock_message(self)
850            return
[6775]851        super(StudyCourseManageFormPage, self).update()
852        tabs.need()
[7484]853        self.tab1 = self.tab2 = ''
854        qs = self.request.get('QUERY_STRING', '')
855        if not qs:
856            qs = 'tab1'
857        setattr(self, qs, 'active')
[7490]858        warning.need()
859        datatable.need()
860        return
[6775]861
[7723]862    @action(_('Save'), style='primary')
[6761]863    def save(self, **data):
[8099]864        try:
865            msave(self, **data)
866        except ConstraintNotSatisfied:
867            # The selected level might not exist in certificate
868            self.flash(_('Current level not available for certificate.'))
869            return
[8081]870        notify(grok.ObjectModifiedEvent(self.context.__parent__))
[6761]871        return
872
[6775]873    @property
874    def level_dict(self):
875        studylevelsource = StudyLevelSource().factory
876        for code in studylevelsource.getValues(self.context):
877            title = studylevelsource.getTitle(self.context, code)
878            yield(dict(code=code, title=title))
879
[7723]880    @action(_('Add study level'))
[6774]881    def addStudyLevel(self, **data):
[6775]882        level_code = self.request.form.get('addlevel', None)
[8323]883        studylevel = createObject(u'waeup.StudentStudyLevel')
[6775]884        studylevel.level = int(level_code)
[9255]885        studylevel.level_session = self.context.current_session
[6775]886        try:
[6782]887            self.context.addStudentStudyLevel(
888                self.context.certificate,studylevel)
[7723]889            self.flash(_('Study level has been added.'))
[6775]890        except KeyError:
[7723]891            self.flash(_('This level exists.'))
[7484]892        self.redirect(self.url(self.context, u'@@manage')+'?tab2')
[6774]893        return
894
[7723]895    @jsaction(_('Remove selected levels'))
[6775]896    def delStudyLevels(self, **data):
897        form = self.request.form
898        if form.has_key('val_id'):
899            child_id = form['val_id']
900        else:
[7723]901            self.flash(_('No study level selected.'))
[7484]902            self.redirect(self.url(self.context, '@@manage')+'?tab2')
[6775]903            return
904        if not isinstance(child_id, list):
905            child_id = [child_id]
906        deleted = []
907        for id in child_id:
[7723]908            del self.context[id]
909            deleted.append(id)
[6775]910        if len(deleted):
[7723]911            self.flash(_('Successfully removed: ${a}',
912                mapping = {'a':', '.join(deleted)}))
[9332]913            self.context.writeLogMessage(
914                self,'removed: %s' % ', '.join(deleted))
[7484]915        self.redirect(self.url(self.context, u'@@manage')+'?tab2')
[6775]916        return
[6774]917
[9138]918class StudentTransferFormPage(KofaAddFormPage):
919    """Page to transfer the student.
920    """
921    grok.context(IStudent)
922    grok.name('transfer')
923    grok.require('waeup.manageStudent')
924    label = _('Transfer student')
925    form_fields = grok.AutoFields(IStudentStudyCourseTransfer).omit(
926        'entry_mode', 'entry_session')
927    pnav = 4
928
929    def update(self):
930        super(StudentTransferFormPage, self).update()
931        warning.need()
932        return
933
934    @jsaction(_('Transfer'))
935    def transferStudent(self, **data):
936        error = self.context.transfer(**data)
937        if error == -1:
938            self.flash(_('Current level does not match certificate levels.'))
939        elif error == -2:
940            self.flash(_('Former study course record incomplete.'))
941        elif error == -3:
942            self.flash(_('Maximum number of transfers exceeded.'))
943        else:
944            self.flash(_('Successfully transferred.'))
945        return
946
[7819]947class StudyLevelDisplayFormPage(KofaDisplayFormPage):
[6774]948    """ Page to display student study levels
949    """
950    grok.context(IStudentStudyLevel)
951    grok.name('index')
952    grok.require('waeup.viewStudent')
[6775]953    form_fields = grok.AutoFields(IStudentStudyLevel)
[9161]954    form_fields[
955        'validation_date'].custom_widget = FriendlyDatetimeDisplayWidget('le')
[6783]956    grok.template('studylevelpage')
[6774]957    pnav = 4
958
[7310]959    def update(self):
960        super(StudyLevelDisplayFormPage, self).update()
961        datatable.need()
962        return
963
[6774]964    @property
[8141]965    def translated_values(self):
[8921]966        return translated_values(self)
[8141]967
968    @property
[6774]969    def label(self):
[7833]970        # Here we know that the cookie has been set
971        lang = self.request.cookies.get('kofa.language')
[7811]972        level_title = translate(self.context.level_title, 'waeup.kofa',
[7723]973            target_language=lang)
974        return _('${a}: Study Level ${b}', mapping = {
[8736]975            'a':self.context.student.display_fullname,
[7723]976            'b':level_title})
[6774]977
[6803]978    @property
979    def total_credits(self):
980        total_credits = 0
981        for key, val in self.context.items():
982            total_credits += val.credits
983        return total_credits
984
[7459]985class ExportPDFCourseRegistrationSlipPage(UtilityView, grok.View):
[7028]986    """Deliver a PDF slip of the context.
987    """
988    grok.context(IStudentStudyLevel)
989    grok.name('course_registration.pdf')
990    grok.require('waeup.viewStudent')
991    form_fields = grok.AutoFields(IStudentStudyLevel)
992    prefix = 'form'
[9375]993    omit_fields = ('password', 'suspended', 'phone', 'adm_code', 'sex')
[7028]994
995    @property
[7723]996    def title(self):
[7819]997        portal_language = getUtility(IKofaUtils).PORTAL_LANGUAGE
[7811]998        return translate(_('Level Data'), 'waeup.kofa',
[7723]999            target_language=portal_language)
1000
1001    @property
1002    def content_title(self):
[7819]1003        portal_language = getUtility(IKofaUtils).PORTAL_LANGUAGE
[7811]1004        return translate(_('Course List'), 'waeup.kofa',
[7723]1005            target_language=portal_language)
1006
1007    @property
[7028]1008    def label(self):
[7819]1009        portal_language = getUtility(IKofaUtils).PORTAL_LANGUAGE
[7811]1010        lang = self.request.cookies.get('kofa.language', portal_language)
1011        level_title = translate(self.context.level_title, 'waeup.kofa',
[7723]1012            target_language=lang)
[8141]1013        return translate(_('Course Registration Slip'),
[7811]1014            'waeup.kofa', target_language=portal_language) \
[7723]1015            + ' %s' % level_title
[7028]1016
1017    def render(self):
[7819]1018        portal_language = getUtility(IKofaUtils).PORTAL_LANGUAGE
[7811]1019        Sem = translate(_('Sem.'), 'waeup.kofa', target_language=portal_language)
1020        Code = translate(_('Code'), 'waeup.kofa', target_language=portal_language)
1021        Title = translate(_('Title'), 'waeup.kofa', target_language=portal_language)
1022        Dept = translate(_('Dept.'), 'waeup.kofa', target_language=portal_language)
1023        Faculty = translate(_('Faculty'), 'waeup.kofa', target_language=portal_language)
1024        Cred = translate(_('Cred.'), 'waeup.kofa', target_language=portal_language)
[9320]1025        Mand = translate(_('Requ.'), 'waeup.kofa', target_language=portal_language)
[7811]1026        Score = translate(_('Score'), 'waeup.kofa', target_language=portal_language)
[9141]1027        studentview = StudentBasePDFFormPage(self.context.student,
[9375]1028            self.request, self.omit_fields)
[7150]1029        students_utils = getUtility(IStudentsUtils)
[7318]1030        tabledata = sorted(self.context.values(),
1031            key=lambda value: str(value.semester) + value.code)
[7186]1032        return students_utils.renderPDF(
[7318]1033            self, 'course_registration.pdf',
[8736]1034            self.context.student, studentview,
[7723]1035            tableheader=[(Sem,'semester', 1.5),(Code,'code', 2.5),
1036                         (Title,'title', 5),
1037                         (Dept,'dcode', 1.5), (Faculty,'fcode', 1.5),
1038                         (Cred, 'credits', 1.5),
1039                         (Mand, 'mandatory', 1.5),
[8141]1040                         (Score, 'score', 1.5),
1041                         #('Auto', 'automatic', 1.5)
[7304]1042                         ],
[7318]1043            tabledata=tabledata)
[7028]1044
[7819]1045class StudyLevelManageFormPage(KofaEditFormPage):
[6792]1046    """ Page to edit the student study level data
1047    """
1048    grok.context(IStudentStudyLevel)
1049    grok.name('manage')
[7136]1050    grok.require('waeup.manageStudent')
[6792]1051    grok.template('studylevelmanagepage')
[9161]1052    form_fields = grok.AutoFields(IStudentStudyLevel).omit(
1053        'validation_date', 'validated_by')
[6792]1054    pnav = 4
[7723]1055    taboneactions = [_('Save'),_('Cancel')]
1056    tabtwoactions = [_('Add course ticket'),
1057        _('Remove selected tickets'),_('Cancel')]
[6792]1058
1059    def update(self):
[9139]1060        if not self.context.__parent__.is_current:
1061            emit_lock_message(self)
1062            return
[6792]1063        super(StudyLevelManageFormPage, self).update()
1064        tabs.need()
[7484]1065        self.tab1 = self.tab2 = ''
1066        qs = self.request.get('QUERY_STRING', '')
1067        if not qs:
1068            qs = 'tab1'
1069        setattr(self, qs, 'active')
[7490]1070        warning.need()
1071        datatable.need()
[6792]1072        return
1073
1074    @property
[8921]1075    def translated_values(self):
1076        return translated_values(self)
1077
1078    @property
[6792]1079    def label(self):
[7833]1080        # Here we know that the cookie has been set
1081        lang = self.request.cookies.get('kofa.language')
[7811]1082        level_title = translate(self.context.level_title, 'waeup.kofa',
[7723]1083            target_language=lang)
1084        return _('Manage study level ${a}',
1085            mapping = {'a':level_title})
[6792]1086
[7723]1087    @action(_('Save'), style='primary')
[6792]1088    def save(self, **data):
1089        msave(self, **data)
1090        return
1091
[7723]1092    @action(_('Add course ticket'))
[6795]1093    def addCourseTicket(self, **data):
1094        self.redirect(self.url(self.context, '@@add'))
[6792]1095
[7723]1096    @jsaction(_('Remove selected tickets'))
[6792]1097    def delCourseTicket(self, **data):
1098        form = self.request.form
1099        if form.has_key('val_id'):
1100            child_id = form['val_id']
1101        else:
[7723]1102            self.flash(_('No ticket selected.'))
[7484]1103            self.redirect(self.url(self.context, '@@manage')+'?tab2')
[6792]1104            return
1105        if not isinstance(child_id, list):
1106            child_id = [child_id]
1107        deleted = []
1108        for id in child_id:
[7723]1109            del self.context[id]
1110            deleted.append(id)
[6792]1111        if len(deleted):
[7723]1112            self.flash(_('Successfully removed: ${a}',
1113                mapping = {'a':', '.join(deleted)}))
[9332]1114            self.context.writeLogMessage(
1115                self,'removed: %s' % ', '.join(deleted))
[7484]1116        self.redirect(self.url(self.context, u'@@manage')+'?tab2')
[6792]1117        return
1118
[7459]1119class ValidateCoursesPage(UtilityView, grok.View):
[7334]1120    """ Validate course list by course adviser
1121    """
1122    grok.context(IStudentStudyLevel)
1123    grok.name('validate_courses')
1124    grok.require('waeup.validateStudent')
1125
1126    def update(self):
[9139]1127        if not self.context.__parent__.is_current:
1128            emit_lock_message(self)
1129            return
[7334]1130        if str(self.context.__parent__.current_level) != self.context.__name__:
[7723]1131            self.flash(_('This level does not correspond current level.'))
[8736]1132        elif self.context.student.state == REGISTERED:
1133            IWorkflowInfo(self.context.student).fireTransition(
[7642]1134                'validate_courses')
[7723]1135            self.flash(_('Course list has been validated.'))
[7334]1136        else:
[7723]1137            self.flash(_('Student is in the wrong state.'))
[7334]1138        self.redirect(self.url(self.context))
1139        return
1140
1141    def render(self):
1142        return
1143
[7459]1144class RejectCoursesPage(UtilityView, grok.View):
[7334]1145    """ Reject course list by course adviser
1146    """
1147    grok.context(IStudentStudyLevel)
1148    grok.name('reject_courses')
1149    grok.require('waeup.validateStudent')
1150
1151    def update(self):
[9139]1152        if not self.context.__parent__.is_current:
1153            emit_lock_message(self)
1154            return
[7334]1155        if str(self.context.__parent__.current_level) != self.context.__name__:
[7723]1156            self.flash(_('This level does not correspond current level.'))
[7334]1157            self.redirect(self.url(self.context))
1158            return
[8736]1159        elif self.context.student.state == VALIDATED:
1160            IWorkflowInfo(self.context.student).fireTransition('reset8')
[7723]1161            message = _('Course list request has been annulled.')
[7334]1162            self.flash(message)
[8736]1163        elif self.context.student.state == REGISTERED:
1164            IWorkflowInfo(self.context.student).fireTransition('reset7')
[7723]1165            message = _('Course list request has been rejected:')
[7334]1166            self.flash(message)
1167        else:
[7723]1168            self.flash(_('Student is in the wrong state.'))
[7334]1169            self.redirect(self.url(self.context))
1170            return
1171        args = {'subject':message}
[8736]1172        self.redirect(self.url(self.context.student) +
[7334]1173            '/contactstudent?%s' % urlencode(args))
1174        return
1175
1176    def render(self):
1177        return
1178
[7819]1179class CourseTicketAddFormPage(KofaAddFormPage):
[6808]1180    """Add a course ticket.
[6795]1181    """
1182    grok.context(IStudentStudyLevel)
1183    grok.name('add')
[7136]1184    grok.require('waeup.manageStudent')
[7723]1185    label = _('Add course ticket')
[9420]1186    form_fields = grok.AutoFields(ICourseTicketAdd)
[6795]1187    pnav = 4
1188
[9139]1189    def update(self):
1190        if not self.context.__parent__.is_current:
1191            emit_lock_message(self)
1192            return
1193        super(CourseTicketAddFormPage, self).update()
1194        return
1195
[7723]1196    @action(_('Add course ticket'))
[6795]1197    def addCourseTicket(self, **data):
[8325]1198        ticket = createObject(u'waeup.CourseTicket')
[6795]1199        course = data['course']
[6802]1200        ticket.automatic = False
[8141]1201        ticket.carry_over = False
[6795]1202        try:
[8920]1203            self.context.addCourseTicket(ticket, course)
[6795]1204        except KeyError:
[7723]1205            self.flash(_('The ticket exists.'))
[6795]1206            return
[7723]1207        self.flash(_('Successfully added ${a}.',
1208            mapping = {'a':ticket.code}))
[7484]1209        self.redirect(self.url(self.context, u'@@manage')+'?tab2')
[6795]1210        return
1211
[7834]1212    @action(_('Cancel'), validator=NullValidator)
[6795]1213    def cancel(self, **data):
1214        self.redirect(self.url(self.context))
1215
[7819]1216class CourseTicketDisplayFormPage(KofaDisplayFormPage):
[6796]1217    """ Page to display course tickets
1218    """
1219    grok.context(ICourseTicket)
1220    grok.name('index')
1221    grok.require('waeup.viewStudent')
1222    form_fields = grok.AutoFields(ICourseTicket)
1223    pnav = 4
1224
1225    @property
1226    def label(self):
[7723]1227        return _('${a}: Course Ticket ${b}', mapping = {
[8736]1228            'a':self.context.student.display_fullname,
[7723]1229            'b':self.context.code})
[6796]1230
[7819]1231class CourseTicketManageFormPage(KofaEditFormPage):
[6796]1232    """ Page to manage course tickets
1233    """
1234    grok.context(ICourseTicket)
1235    grok.name('manage')
[7136]1236    grok.require('waeup.manageStudent')
[9420]1237    form_fields = grok.AutoFields(ICourseTicket)
1238    form_fields['title'].for_display = True
1239    form_fields['fcode'].for_display = True
1240    form_fields['dcode'].for_display = True
1241    form_fields['semester'].for_display = True
1242    form_fields['passmark'].for_display = True
1243    form_fields['credits'].for_display = True
1244    form_fields['mandatory'].for_display = True
1245    form_fields['automatic'].for_display = True
[6796]1246    pnav = 4
1247
1248    @property
1249    def label(self):
[7723]1250        return _('Manage course ticket ${a}', mapping = {'a':self.context.code})
[6796]1251
[7459]1252    @action('Save', style='primary')
[6796]1253    def save(self, **data):
1254        msave(self, **data)
1255        return
1256
[7819]1257class PaymentsManageFormPage(KofaEditFormPage):
[6869]1258    """ Page to manage the student payments
[7642]1259
1260    This manage form page is for both students and students officers.
[6869]1261    """
1262    grok.context(IStudentPaymentsContainer)
[6940]1263    grok.name('index')
[7181]1264    grok.require('waeup.payStudent')
[6869]1265    form_fields = grok.AutoFields(IStudentPaymentsContainer)
1266    grok.template('paymentsmanagepage')
1267    pnav = 4
1268
[6940]1269    def unremovable(self, ticket):
[7251]1270        usertype = getattr(self.request.principal, 'user_type', None)
1271        if not usertype:
1272            return False
1273        return (self.request.principal.user_type == 'student' and ticket.r_code)
[6940]1274
[6869]1275    @property
1276    def label(self):
[7723]1277        return _('${a}: Payments',
1278            mapping = {'a':self.context.__parent__.display_fullname})
[6869]1279
1280    def update(self):
1281        super(PaymentsManageFormPage, self).update()
1282        datatable.need()
[7329]1283        warning.need()
[6869]1284        return
1285
[7723]1286    @jsaction(_('Remove selected tickets'))
[6869]1287    def delPaymentTicket(self, **data):
1288        form = self.request.form
1289        if form.has_key('val_id'):
1290            child_id = form['val_id']
1291        else:
[7723]1292            self.flash(_('No payment selected.'))
[6940]1293            self.redirect(self.url(self.context))
[6869]1294            return
1295        if not isinstance(child_id, list):
1296            child_id = [child_id]
1297        deleted = []
1298        for id in child_id:
[6992]1299            # Students are not allowed to remove used payment tickets
[6940]1300            if not self.unremovable(self.context[id]):
[7723]1301                del self.context[id]
1302                deleted.append(id)
[6869]1303        if len(deleted):
[7723]1304            self.flash(_('Successfully removed: ${a}',
1305                mapping = {'a': ', '.join(deleted)}))
[8735]1306            self.context.writeLogMessage(
[8885]1307                self,'removed: %s' % ', '.join(deleted))
[6940]1308        self.redirect(self.url(self.context))
[6869]1309        return
1310
[7723]1311    @action(_('Add online payment ticket'))
[6869]1312    def addPaymentTicket(self, **data):
1313        self.redirect(self.url(self.context, '@@addop'))
1314
[7819]1315class OnlinePaymentAddFormPage(KofaAddFormPage):
[6869]1316    """ Page to add an online payment ticket
1317    """
1318    grok.context(IStudentPaymentsContainer)
1319    grok.name('addop')
[7181]1320    grok.require('waeup.payStudent')
[6877]1321    form_fields = grok.AutoFields(IStudentOnlinePayment).select(
[6869]1322        'p_category')
[7723]1323    label = _('Add online payment')
[6869]1324    pnav = 4
[7642]1325
[7723]1326    @action(_('Create ticket'), style='primary')
[6869]1327    def createTicket(self, **data):
[7024]1328        p_category = data['p_category']
[9148]1329        previous_session = data.get('p_session', None)
1330        previous_level = data.get('p_level', None)
[7024]1331        student = self.context.__parent__
1332        if p_category == 'bed_allocation' and student[
1333            'studycourse'].current_session != grok.getSite()[
[8685]1334            'hostels'].accommodation_session:
[7024]1335                self.flash(
[7723]1336                    _('Your current session does not match ' + \
1337                    'accommodation session.'))
[7024]1338                self.redirect(self.url(self.context))
1339                return
[7150]1340        students_utils = getUtility(IStudentsUtils)
[9148]1341        error, payment = students_utils.setPaymentDetails(
1342            p_category, student, previous_session, previous_level)
[8595]1343        if error is not None:
1344            self.flash(error)
[9204]1345            if 'previous session' in error:
[9148]1346                self.redirect(self.url(self.context) + '/@@addpp')
1347                return
[8081]1348            self.redirect(self.url(self.context))
1349            return
[6869]1350        self.context[payment.p_id] = payment
[7723]1351        self.flash(_('Payment ticket created.'))
[6940]1352        self.redirect(self.url(self.context))
[6869]1353        return
1354
[9383]1355    @action(_('Cancel'), validator=NullValidator)
1356    def cancel(self, **data):
1357        self.redirect(self.url(self.context))
1358
[9148]1359class PreviousPaymentAddFormPage(OnlinePaymentAddFormPage):
1360    """ Page to add an online payment ticket for previous sessions
1361    """
1362    grok.context(IStudentPaymentsContainer)
1363    grok.name('addpp')
1364    grok.require('waeup.payStudent')
1365    form_fields = grok.AutoFields(IStudentPreviousPayment).select(
1366        'p_category', 'p_session', 'p_level')
1367    label = _('Add previous session online payment')
1368    pnav = 4
1369
[7819]1370class OnlinePaymentDisplayFormPage(KofaDisplayFormPage):
[6869]1371    """ Page to view an online payment ticket
1372    """
[6877]1373    grok.context(IStudentOnlinePayment)
[6869]1374    grok.name('index')
1375    grok.require('waeup.viewStudent')
[6877]1376    form_fields = grok.AutoFields(IStudentOnlinePayment)
[8170]1377    form_fields[
1378        'creation_date'].custom_widget = FriendlyDatetimeDisplayWidget('le')
1379    form_fields[
1380        'payment_date'].custom_widget = FriendlyDatetimeDisplayWidget('le')
[6869]1381    pnav = 4
1382
1383    @property
1384    def label(self):
[7723]1385        return _('${a}: Online Payment Ticket ${b}', mapping = {
[8736]1386            'a':self.context.student.display_fullname,
[7723]1387            'b':self.context.p_id})
[6869]1388
[8420]1389class OnlinePaymentApprovePage(UtilityView, grok.View):
[6930]1390    """ Callback view
1391    """
1392    grok.context(IStudentOnlinePayment)
[8420]1393    grok.name('approve')
1394    grok.require('waeup.managePortal')
[6930]1395
1396    def update(self):
[8428]1397        success, msg, log = self.context.approveStudentPayment()
1398        if log is not None:
[8735]1399            self.context.writeLogMessage(self,log)
[8420]1400        self.flash(msg)
[6940]1401        return
[6930]1402
1403    def render(self):
[6940]1404        self.redirect(self.url(self.context, '@@index'))
[6930]1405        return
1406
[8420]1407class OnlinePaymentFakeApprovePage(OnlinePaymentApprovePage):
1408    """ Approval view for students.
1409
1410    This view is used for browser tests only and
1411    must be neutralized in custom pages!
1412    """
1413
1414    grok.name('fake_approve')
1415    grok.require('waeup.payStudent')
1416
[7459]1417class ExportPDFPaymentSlipPage(UtilityView, grok.View):
[7019]1418    """Deliver a PDF slip of the context.
1419    """
1420    grok.context(IStudentOnlinePayment)
[8262]1421    grok.name('payment_slip.pdf')
[7019]1422    grok.require('waeup.viewStudent')
1423    form_fields = grok.AutoFields(IStudentOnlinePayment)
[8173]1424    form_fields['creation_date'].custom_widget = FriendlyDatetimeDisplayWidget('le')
1425    form_fields['payment_date'].custom_widget = FriendlyDatetimeDisplayWidget('le')
[7019]1426    prefix = 'form'
[8258]1427    note = None
[9375]1428    omit_fields = ('password', 'suspended', 'phone', 'adm_code', 'sex')
[7019]1429
1430    @property
[8262]1431    def title(self):
1432        portal_language = getUtility(IKofaUtils).PORTAL_LANGUAGE
1433        return translate(_('Payment Data'), 'waeup.kofa',
1434            target_language=portal_language)
1435
1436    @property
[7019]1437    def label(self):
[8262]1438        portal_language = getUtility(IKofaUtils).PORTAL_LANGUAGE
1439        return translate(_('Online Payment Slip'),
1440            'waeup.kofa', target_language=portal_language) \
1441            + ' %s' % self.context.p_id
[7019]1442
1443    def render(self):
[8262]1444        #if self.context.p_state != 'paid':
1445        #    self.flash('Ticket not yet paid.')
1446        #    self.redirect(self.url(self.context))
1447        #    return
[9141]1448        studentview = StudentBasePDFFormPage(self.context.student,
[9375]1449            self.request, self.omit_fields)
[7150]1450        students_utils = getUtility(IStudentsUtils)
[8262]1451        return students_utils.renderPDF(self, 'payment_slip.pdf',
[8736]1452            self.context.student, studentview, note=self.note)
[7019]1453
[6992]1454
[7819]1455class AccommodationManageFormPage(KofaEditFormPage):
[7009]1456    """ Page to manage bed tickets.
[7642]1457
1458    This manage form page is for both students and students officers.
[6635]1459    """
1460    grok.context(IStudentAccommodation)
1461    grok.name('index')
[7181]1462    grok.require('waeup.handleAccommodation')
[6635]1463    form_fields = grok.AutoFields(IStudentAccommodation)
[6992]1464    grok.template('accommodationmanagepage')
[6642]1465    pnav = 4
[7723]1466    officers_only_actions = [_('Remove selected')]
[6635]1467
1468    @property
1469    def label(self):
[7723]1470        return _('${a}: Accommodation',
1471            mapping = {'a':self.context.__parent__.display_fullname})
[6637]1472
[6992]1473    def update(self):
1474        super(AccommodationManageFormPage, self).update()
1475        datatable.need()
[7329]1476        warning.need()
[6992]1477        return
1478
[7723]1479    @jsaction(_('Remove selected'))
[7009]1480    def delBedTickets(self, **data):
[7240]1481        if getattr(self.request.principal, 'user_type', None) == 'student':
[7723]1482            self.flash(_('You are not allowed to remove bed tickets.'))
[7017]1483            self.redirect(self.url(self.context))
1484            return
[6992]1485        form = self.request.form
1486        if form.has_key('val_id'):
1487            child_id = form['val_id']
1488        else:
[7723]1489            self.flash(_('No bed ticket selected.'))
[6992]1490            self.redirect(self.url(self.context))
1491            return
1492        if not isinstance(child_id, list):
1493            child_id = [child_id]
1494        deleted = []
1495        for id in child_id:
[7068]1496            del self.context[id]
1497            deleted.append(id)
[6992]1498        if len(deleted):
[7723]1499            self.flash(_('Successfully removed: ${a}',
1500                mapping = {'a':', '.join(deleted)}))
[8735]1501            self.context.writeLogMessage(
1502                self,'removed: % s' % ', '.join(deleted))
[6992]1503        self.redirect(self.url(self.context))
1504        return
1505
[7009]1506    @property
1507    def selected_actions(self):
[7240]1508        if getattr(self.request.principal, 'user_type', None) == 'student':
[7642]1509            return [action for action in self.actions
1510                    if not action.label in self.officers_only_actions]
1511        return self.actions
[7009]1512
[7819]1513class BedTicketAddPage(KofaPage):
[6992]1514    """ Page to add an online payment ticket
1515    """
1516    grok.context(IStudentAccommodation)
1517    grok.name('add')
[7181]1518    grok.require('waeup.handleAccommodation')
[6992]1519    grok.template('enterpin')
[6993]1520    ac_prefix = 'HOS'
[7723]1521    label = _('Add bed ticket')
[6992]1522    pnav = 4
[7723]1523    buttonname = _('Create bed ticket')
[6993]1524    notice = ''
[9188]1525    with_ac = True
[6992]1526
1527    def update(self, SUBMIT=None):
[8736]1528        student = self.context.student
[7150]1529        students_utils = getUtility(IStudentsUtils)
[7186]1530        acc_details  = students_utils.getAccommodationDetails(student)
[8688]1531        if acc_details.get('expired', False):
1532            startdate = acc_details.get('startdate')
1533            enddate = acc_details.get('enddate')
1534            if startdate and enddate:
1535                tz = getUtility(IKofaUtils).tzinfo
1536                startdate = to_timezone(
1537                    startdate, tz).strftime("%d/%m/%Y %H:%M:%S")
1538                enddate = to_timezone(
1539                    enddate, tz).strftime("%d/%m/%Y %H:%M:%S")
1540                self.flash(_("Outside booking period: ${a} - ${b}",
1541                    mapping = {'a': startdate, 'b': enddate}))
1542            else:
1543                self.flash(_("Outside booking period."))
1544            self.redirect(self.url(self.context))
1545            return
[7369]1546        if not acc_details:
[7723]1547            self.flash(_("Your data are incomplete."))
[7369]1548            self.redirect(self.url(self.context))
1549            return
[6996]1550        if not student.state in acc_details['allowed_states']:
[7723]1551            self.flash(_("You are in the wrong registration state."))
[6992]1552            self.redirect(self.url(self.context))
1553            return
[7642]1554        if student['studycourse'].current_session != acc_details[
1555            'booking_session']:
[7061]1556            self.flash(
[7723]1557                _('Your current session does not match accommodation session.'))
[7061]1558            self.redirect(self.url(self.context))
1559            return
1560        if str(acc_details['booking_session']) in self.context.keys():
[7642]1561            self.flash(
[7723]1562                _('You already booked a bed space in current ' \
1563                    + 'accommodation session.'))
[7004]1564            self.redirect(self.url(self.context))
1565            return
[9188]1566        if self.with_ac:
1567            self.ac_series = self.request.form.get('ac_series', None)
1568            self.ac_number = self.request.form.get('ac_number', None)
[6992]1569        if SUBMIT is None:
1570            return
[9188]1571        if self.with_ac:
1572            pin = '%s-%s-%s' % (self.ac_prefix, self.ac_series, self.ac_number)
1573            code = get_access_code(pin)
1574            if not code:
1575                self.flash(_('Activation code is invalid.'))
1576                return
[7060]1577        # Search and book bed
[6997]1578        cat = queryUtility(ICatalog, name='beds_catalog', default=None)
1579        entries = cat.searchResults(
[7003]1580            owner=(student.student_id,student.student_id))
1581        if len(entries):
[9188]1582            # If bed space has been manually allocated use this bed
[7003]1583            bed = [entry for entry in entries][0]
[7060]1584        else:
1585            # else search for other available beds
1586            entries = cat.searchResults(
1587                bed_type=(acc_details['bt'],acc_details['bt']))
1588            available_beds = [
1589                entry for entry in entries if entry.owner == NOT_OCCUPIED]
1590            if available_beds:
[7150]1591                students_utils = getUtility(IStudentsUtils)
[7186]1592                bed = students_utils.selectBed(available_beds)
[7060]1593                bed.bookBed(student.student_id)
1594            else:
[7723]1595                self.flash(_('There is no free bed in your category ${a}.',
1596                    mapping = {'a':acc_details['bt']}))
[7060]1597                return
[9188]1598        if self.with_ac:
1599            # Mark pin as used (this also fires a pin related transition)
1600            if code.state == USED:
1601                self.flash(_('Activation code has already been used.'))
[6992]1602                return
[9188]1603            else:
1604                comment = _(u'invalidated')
1605                # Here we know that the ac is in state initialized so we do not
1606                # expect an exception, but the owner might be different
1607                if not invalidate_accesscode(
1608                    pin,comment,self.context.student.student_id):
1609                    self.flash(_('You are not the owner of this access code.'))
1610                    return
[7060]1611        # Create bed ticket
[6992]1612        bedticket = createObject(u'waeup.BedTicket')
[9189]1613        if self.with_ac:
1614            bedticket.booking_code = pin
[6994]1615        bedticket.booking_session = acc_details['booking_session']
[6996]1616        bedticket.bed_type = acc_details['bt']
[7006]1617        bedticket.bed = bed
[6996]1618        hall_title = bed.__parent__.hostel_name
[9199]1619        coordinates = bed.coordinates[1:]
[6996]1620        block, room_nr, bed_nr = coordinates
[7723]1621        bc = _('${a}, Block ${b}, Room ${c}, Bed ${d} (${e})', mapping = {
1622            'a':hall_title, 'b':block,
1623            'c':room_nr, 'd':bed_nr,
1624            'e':bed.bed_type})
[7819]1625        portal_language = getUtility(IKofaUtils).PORTAL_LANGUAGE
[7723]1626        bedticket.bed_coordinates = translate(
[7811]1627            bc, 'waeup.kofa',target_language=portal_language)
[6996]1628        key = str(acc_details['booking_session'])
1629        self.context[key] = bedticket
[9411]1630        self.context.writeLogMessage(self, 'booked: %s' % bed.bed_id)
[7723]1631        self.flash(_('Bed ticket created and bed booked: ${a}',
1632            mapping = {'a':bedticket.bed_coordinates}))
[6992]1633        self.redirect(self.url(self.context))
1634        return
1635
[7819]1636class BedTicketDisplayFormPage(KofaDisplayFormPage):
[6994]1637    """ Page to display bed tickets
1638    """
1639    grok.context(IBedTicket)
1640    grok.name('index')
[7181]1641    grok.require('waeup.handleAccommodation')
[6994]1642    form_fields = grok.AutoFields(IBedTicket)
[9201]1643    form_fields['booking_date'].custom_widget = FriendlyDatetimeDisplayWidget('le')
[6994]1644    pnav = 4
1645
1646    @property
1647    def label(self):
[7723]1648        return _('Bed Ticket for Session ${a}',
1649            mapping = {'a':self.context.getSessionString()})
[6994]1650
[7459]1651class ExportPDFBedTicketSlipPage(UtilityView, grok.View):
[7027]1652    """Deliver a PDF slip of the context.
1653    """
1654    grok.context(IBedTicket)
1655    grok.name('bed_allocation.pdf')
[7181]1656    grok.require('waeup.handleAccommodation')
[7027]1657    form_fields = grok.AutoFields(IBedTicket)
[8173]1658    form_fields['booking_date'].custom_widget = FriendlyDatetimeDisplayWidget('le')
[7027]1659    prefix = 'form'
[9375]1660    omit_fields = ('password', 'suspended', 'phone', 'adm_code', 'sex')
[7027]1661
1662    @property
[7723]1663    def title(self):
[7819]1664        portal_language = getUtility(IKofaUtils).PORTAL_LANGUAGE
[7811]1665        return translate(_('Bed Allocation Data'), 'waeup.kofa',
[7723]1666            target_language=portal_language)
1667
1668    @property
[7027]1669    def label(self):
[7819]1670        portal_language = getUtility(IKofaUtils).PORTAL_LANGUAGE
[9201]1671        #return translate(_('Bed Allocation: '),
1672        #    'waeup.kofa', target_language=portal_language) \
1673        #    + ' %s' % self.context.bed_coordinates
1674        return translate(_('Bed Allocation Slip'),
[7811]1675            'waeup.kofa', target_language=portal_language) \
[9201]1676            + ' %s' % self.context.getSessionString()
[7027]1677
1678    def render(self):
[9141]1679        studentview = StudentBasePDFFormPage(self.context.student,
[9375]1680            self.request, self.omit_fields)
[7150]1681        students_utils = getUtility(IStudentsUtils)
[7186]1682        return students_utils.renderPDF(
[7318]1683            self, 'bed_allocation.pdf',
[8736]1684            self.context.student, studentview)
[7027]1685
[7459]1686class BedTicketRelocationPage(UtilityView, grok.View):
[7015]1687    """ Callback view
1688    """
1689    grok.context(IBedTicket)
1690    grok.name('relocate')
1691    grok.require('waeup.manageHostels')
1692
[7059]1693    # Relocate student if student parameters have changed or the bed_type
1694    # of the bed has changed
[7015]1695    def update(self):
[8736]1696        student = self.context.student
[7150]1697        students_utils = getUtility(IStudentsUtils)
[7186]1698        acc_details  = students_utils.getAccommodationDetails(student)
[7068]1699        if self.context.bed != None and \
1700              'reserved' in self.context.bed.bed_type:
[7723]1701            self.flash(_("Students in reserved beds can't be relocated."))
[7068]1702            self.redirect(self.url(self.context))
1703            return
[7059]1704        if acc_details['bt'] == self.context.bed_type and \
[7068]1705                self.context.bed != None and \
[7059]1706                self.context.bed.bed_type == self.context.bed_type:
[7723]1707            self.flash(_("Student can't be relocated."))
[7068]1708            self.redirect(self.url(self.context))
[7015]1709            return
[7068]1710        # Search a bed
[7015]1711        cat = queryUtility(ICatalog, name='beds_catalog', default=None)
1712        entries = cat.searchResults(
[7068]1713            owner=(student.student_id,student.student_id))
1714        if len(entries) and self.context.bed == None:
1715            # If booking has been cancelled but other bed space has been
1716            # manually allocated after cancellation use this bed
1717            new_bed = [entry for entry in entries][0]
1718        else:
1719            # Search for other available beds
1720            entries = cat.searchResults(
1721                bed_type=(acc_details['bt'],acc_details['bt']))
1722            available_beds = [
1723                entry for entry in entries if entry.owner == NOT_OCCUPIED]
1724            if available_beds:
[7150]1725                students_utils = getUtility(IStudentsUtils)
[7186]1726                new_bed = students_utils.selectBed(available_beds)
[7068]1727                new_bed.bookBed(student.student_id)
1728            else:
[7723]1729                self.flash(_('There is no free bed in your category ${a}.',
1730                    mapping = {'a':acc_details['bt']}))
[7068]1731                self.redirect(self.url(self.context))
1732                return
[7642]1733        # Release old bed if exists
[7068]1734        if self.context.bed != None:
1735            self.context.bed.owner = NOT_OCCUPIED
1736            notify(grok.ObjectModifiedEvent(self.context.bed))
[7015]1737        # Alocate new bed
1738        self.context.bed_type = acc_details['bt']
[7068]1739        self.context.bed = new_bed
1740        hall_title = new_bed.__parent__.hostel_name
[9199]1741        coordinates = new_bed.coordinates[1:]
[7015]1742        block, room_nr, bed_nr = coordinates
[7723]1743        bc = _('${a}, Block ${b}, Room ${c}, Bed ${d} (${e})', mapping = {
1744            'a':hall_title, 'b':block,
1745            'c':room_nr, 'd':bed_nr,
1746            'e':new_bed.bed_type})
[7819]1747        portal_language = getUtility(IKofaUtils).PORTAL_LANGUAGE
[7723]1748        self.context.bed_coordinates = translate(
[7811]1749            bc, 'waeup.kofa',target_language=portal_language)
[9411]1750        self.context.writeLogMessage(self, 'relocated: %s' % new_bed.bed_id)
[7723]1751        self.flash(_('Student relocated: ${a}',
1752            mapping = {'a':self.context.bed_coordinates}))
[7015]1753        self.redirect(self.url(self.context))
1754        return
1755
1756    def render(self):
1757        return
1758
[7819]1759class StudentHistoryPage(KofaPage):
[6637]1760    """ Page to display student clearance data
1761    """
1762    grok.context(IStudent)
1763    grok.name('history')
[6660]1764    grok.require('waeup.viewStudent')
[6637]1765    grok.template('studenthistory')
[6642]1766    pnav = 4
[6637]1767
1768    @property
1769    def label(self):
[7723]1770        return _('${a}: History', mapping = {'a':self.context.display_fullname})
[6694]1771
1772# Pages for students only
1773
[7819]1774class StudentBaseEditFormPage(KofaEditFormPage):
[7133]1775    """ View to edit student base data
1776    """
1777    grok.context(IStudent)
1778    grok.name('edit_base')
1779    grok.require('waeup.handleStudent')
1780    form_fields = grok.AutoFields(IStudentBase).select(
1781        'email', 'phone')
[7723]1782    label = _('Edit base data')
[7133]1783    pnav = 4
1784
[7723]1785    @action(_('Save'), style='primary')
[7133]1786    def save(self, **data):
1787        msave(self, **data)
1788        return
1789
[7819]1790class StudentChangePasswordPage(KofaEditFormPage):
[7144]1791    """ View to manage student base data
[6756]1792    """
1793    grok.context(IStudent)
[7114]1794    grok.name('change_password')
[6694]1795    grok.require('waeup.handleStudent')
[7144]1796    grok.template('change_password')
[7723]1797    label = _('Change password')
[6694]1798    pnav = 4
1799
[7723]1800    @action(_('Save'), style='primary')
[7144]1801    def save(self, **data):
1802        form = self.request.form
1803        password = form.get('change_password', None)
1804        password_ctl = form.get('change_password_repeat', None)
1805        if password:
[7147]1806            validator = getUtility(IPasswordValidator)
1807            errors = validator.validate_password(password, password_ctl)
1808            if not errors:
1809                IUserAccount(self.context).setPassword(password)
[8735]1810                self.context.writeLogMessage(self, 'saved: password')
[7723]1811                self.flash(_('Password changed.'))
[6756]1812            else:
[7147]1813                self.flash( ' '.join(errors))
[6756]1814        return
1815
[7819]1816class StudentFilesUploadPage(KofaPage):
[7114]1817    """ View to upload files by student
1818    """
1819    grok.context(IStudent)
1820    grok.name('change_portrait')
[7127]1821    grok.require('waeup.uploadStudentFile')
[7114]1822    grok.template('filesuploadpage')
[7723]1823    label = _('Upload portrait')
[7114]1824    pnav = 4
1825
[7133]1826    def update(self):
[8736]1827        if self.context.student.state != ADMITTED:
[7145]1828            emit_lock_message(self)
[7133]1829            return
1830        super(StudentFilesUploadPage, self).update()
1831        return
1832
[7819]1833class StartClearancePage(KofaPage):
[6770]1834    grok.context(IStudent)
1835    grok.name('start_clearance')
1836    grok.require('waeup.handleStudent')
1837    grok.template('enterpin')
[7723]1838    label = _('Start clearance')
[6770]1839    ac_prefix = 'CLR'
1840    notice = ''
1841    pnav = 4
[7723]1842    buttonname = _('Start clearance now')
[6770]1843
[7133]1844    @property
1845    def all_required_fields_filled(self):
1846        if self.context.email and self.context.phone:
1847            return True
1848        return False
1849
1850    @property
1851    def portrait_uploaded(self):
1852        store = getUtility(IExtFileStore)
1853        if store.getFileByContext(self.context, attr=u'passport.jpg'):
1854            return True
1855        return False
1856
[6770]1857    def update(self, SUBMIT=None):
[7671]1858        if not self.context.state == ADMITTED:
[7745]1859            self.flash(_("Wrong state"))
[6936]1860            self.redirect(self.url(self.context))
1861            return
[7133]1862        if not self.portrait_uploaded:
[7723]1863            self.flash(_("No portrait uploaded."))
[7133]1864            self.redirect(self.url(self.context, 'change_portrait'))
1865            return
1866        if not self.all_required_fields_filled:
[7723]1867            self.flash(_("Not all required fields filled."))
[7133]1868            self.redirect(self.url(self.context, 'edit_base'))
1869            return
[6770]1870        self.ac_series = self.request.form.get('ac_series', None)
1871        self.ac_number = self.request.form.get('ac_number', None)
1872
1873        if SUBMIT is None:
1874            return
1875        pin = '%s-%s-%s' % (self.ac_prefix, self.ac_series, self.ac_number)
1876        code = get_access_code(pin)
1877        if not code:
[7723]1878            self.flash(_('Activation code is invalid.'))
[6770]1879            return
1880        if code.state == USED:
[7723]1881            self.flash(_('Activation code has already been used.'))
[6770]1882            return
[8974]1883        # Mark pin as used (this also fires a pin related transition)
1884        # and fire transition start_clearance
1885        comment = _(u"invalidated")
1886        # Here we know that the ac is in state initialized so we do not
1887        # expect an exception, but the owner might be different
1888        if not invalidate_accesscode(pin, comment, self.context.student_id):
1889            self.flash(_('You are not the owner of this access code.'))
1890            return
1891        self.context.clr_code = pin
[6770]1892        IWorkflowInfo(self.context).fireTransition('start_clearance')
[7723]1893        self.flash(_('Clearance process has been started.'))
[6770]1894        self.redirect(self.url(self.context,'cedit'))
1895        return
1896
[6695]1897class StudentClearanceEditFormPage(StudentClearanceManageFormPage):
1898    """ View to edit student clearance data by student
1899    """
1900    grok.context(IStudent)
1901    grok.name('cedit')
1902    grok.require('waeup.handleStudent')
[7723]1903    label = _('Edit clearance data')
[6718]1904
[7993]1905    @property
1906    def form_fields(self):
[8472]1907        if self.context.is_postgrad:
[8974]1908            form_fields = grok.AutoFields(IPGStudentClearance).omit(
[8977]1909                'clearance_locked', 'clr_code')
[7993]1910        else:
[8974]1911            form_fields = grok.AutoFields(IUGStudentClearance).omit(
[8977]1912                'clearance_locked', 'clr_code')
[7993]1913        return form_fields
1914
[6718]1915    def update(self):
1916        if self.context.clearance_locked:
[7145]1917            emit_lock_message(self)
[6718]1918            return
1919        return super(StudentClearanceEditFormPage, self).update()
[6719]1920
[7723]1921    @action(_('Save'), style='primary')
[6722]1922    def save(self, **data):
1923        self.applyData(self.context, **data)
[7723]1924        self.flash(_('Clearance form has been saved.'))
[6722]1925        return
1926
[7253]1927    def dataNotComplete(self):
[7642]1928        """To be implemented in the customization package.
1929        """
[7253]1930        return False
1931
[7723]1932    @action(_('Save and request clearance'), style='primary')
[7186]1933    def requestClearance(self, **data):
[6722]1934        self.applyData(self.context, **data)
[7253]1935        if self.dataNotComplete():
1936            self.flash(self.dataNotComplete())
1937            return
[7723]1938        self.flash(_('Clearance form has been saved.'))
[9021]1939        if self.context.clr_code:
1940            self.redirect(self.url(self.context, 'request_clearance'))
1941        else:
1942            # We bypass the request_clearance page if student
1943            # has been imported in state 'clearance started' and
1944            # no clr_code was entered before.
1945            state = IWorkflowState(self.context).getState()
1946            if state != CLEARANCE:
1947                # This shouldn't happen, but the application officer
1948                # might have forgotten to lock the form after changing the state
1949                self.flash(_('This form cannot be submitted. Wrong state!'))
1950                return
1951            IWorkflowInfo(self.context).fireTransition('request_clearance')
1952            self.flash(_('Clearance has been requested.'))
1953            self.redirect(self.url(self.context))
[6722]1954        return
1955
[7819]1956class RequestClearancePage(KofaPage):
[6769]1957    grok.context(IStudent)
1958    grok.name('request_clearance')
1959    grok.require('waeup.handleStudent')
1960    grok.template('enterpin')
[7723]1961    label = _('Request clearance')
1962    notice = _('Enter the CLR access code used for starting clearance.')
[6769]1963    ac_prefix = 'CLR'
1964    pnav = 4
[7723]1965    buttonname = _('Request clearance now')
[6769]1966
1967    def update(self, SUBMIT=None):
1968        self.ac_series = self.request.form.get('ac_series', None)
1969        self.ac_number = self.request.form.get('ac_number', None)
1970        if SUBMIT is None:
1971            return
1972        pin = '%s-%s-%s' % (self.ac_prefix, self.ac_series, self.ac_number)
[9021]1973        if self.context.clr_code and self.context.clr_code != pin:
[7723]1974            self.flash(_("This isn't your CLR access code."))
[6769]1975            return
1976        state = IWorkflowState(self.context).getState()
1977        if state != CLEARANCE:
[9021]1978            # This shouldn't happen, but the application officer
1979            # might have forgotten to lock the form after changing the state
[7723]1980            self.flash(_('This form cannot be submitted. Wrong state!'))
[6769]1981            return
1982        IWorkflowInfo(self.context).fireTransition('request_clearance')
[7723]1983        self.flash(_('Clearance has been requested.'))
[6769]1984        self.redirect(self.url(self.context))
[6789]1985        return
[6806]1986
[8471]1987class StartSessionPage(KofaPage):
[6944]1988    grok.context(IStudentStudyCourse)
[8471]1989    grok.name('start_session')
[6944]1990    grok.require('waeup.handleStudent')
1991    grok.template('enterpin')
[8471]1992    label = _('Start session')
[6944]1993    ac_prefix = 'SFE'
1994    notice = ''
1995    pnav = 4
[8471]1996    buttonname = _('Start now')
[6944]1997
1998    def update(self, SUBMIT=None):
[9139]1999        if not self.context.is_current:
2000            emit_lock_message(self)
2001            return
2002        super(StartSessionPage, self).update()
[8471]2003        if not self.context.next_session_allowed:
2004            self.flash(_("You are not entitled to start session."))
[6944]2005            self.redirect(self.url(self.context))
2006            return
2007        self.ac_series = self.request.form.get('ac_series', None)
2008        self.ac_number = self.request.form.get('ac_number', None)
2009
2010        if SUBMIT is None:
2011            return
2012        pin = '%s-%s-%s' % (self.ac_prefix, self.ac_series, self.ac_number)
2013        code = get_access_code(pin)
2014        if not code:
[7723]2015            self.flash(_('Activation code is invalid.'))
[6944]2016            return
2017        # Mark pin as used (this also fires a pin related transition)
2018        if code.state == USED:
[7723]2019            self.flash(_('Activation code has already been used.'))
[6944]2020            return
2021        else:
[7723]2022            comment = _(u"invalidated")
[6944]2023            # Here we know that the ac is in state initialized so we do not
[8471]2024            # expect an error, but the owner might be different
[6944]2025            if not invalidate_accesscode(
[8736]2026                pin,comment,self.context.student.student_id):
[7723]2027                self.flash(_('You are not the owner of this access code.'))
[6944]2028                return
[8736]2029        if self.context.student.state == CLEARED:
2030            IWorkflowInfo(self.context.student).fireTransition(
[6944]2031                'pay_first_school_fee')
[8736]2032        elif self.context.student.state == RETURNING:
2033            IWorkflowInfo(self.context.student).fireTransition(
[6944]2034                'pay_school_fee')
[8736]2035        elif self.context.student.state == PAID:
2036            IWorkflowInfo(self.context.student).fireTransition(
[8471]2037                'pay_pg_fee')
2038        self.flash(_('Session started.'))
[6944]2039        self.redirect(self.url(self.context))
2040        return
2041
[7819]2042class AddStudyLevelFormPage(KofaEditFormPage):
[6806]2043    """ Page for students to add current study levels
2044    """
2045    grok.context(IStudentStudyCourse)
2046    grok.name('add')
2047    grok.require('waeup.handleStudent')
2048    grok.template('studyleveladdpage')
2049    form_fields = grok.AutoFields(IStudentStudyCourse)
2050    pnav = 4
2051
2052    @property
2053    def label(self):
2054        studylevelsource = StudyLevelSource().factory
2055        code = self.context.current_level
2056        title = studylevelsource.getTitle(self.context, code)
[7723]2057        return _('Add current level ${a}', mapping = {'a':title})
[6806]2058
2059    def update(self):
[9139]2060        if not self.context.is_current:
2061            emit_lock_message(self)
2062            return
[8736]2063        if self.context.student.state != PAID:
[7145]2064            emit_lock_message(self)
[6806]2065            return
2066        super(AddStudyLevelFormPage, self).update()
2067        return
2068
[7723]2069    @action(_('Create course list now'), style='primary')
[6806]2070    def addStudyLevel(self, **data):
[8323]2071        studylevel = createObject(u'waeup.StudentStudyLevel')
[6806]2072        studylevel.level = self.context.current_level
2073        studylevel.level_session = self.context.current_session
2074        try:
2075            self.context.addStudentStudyLevel(
2076                self.context.certificate,studylevel)
2077        except KeyError:
[7723]2078            self.flash(_('This level exists.'))
[6806]2079        self.redirect(self.url(self.context))
2080        return
[6808]2081
[7819]2082class StudyLevelEditFormPage(KofaEditFormPage):
[6808]2083    """ Page to edit the student study level data by students
2084    """
2085    grok.context(IStudentStudyLevel)
2086    grok.name('edit')
2087    grok.require('waeup.handleStudent')
2088    grok.template('studyleveleditpage')
2089    form_fields = grok.AutoFields(IStudentStudyLevel).omit(
2090        'level_session', 'level_verdict')
2091    pnav = 4
[8642]2092    max_credits = 50
[6808]2093
2094    def update(self):
[9139]2095        if not self.context.__parent__.is_current:
2096            emit_lock_message(self)
2097            return
[9257]2098        if self.context.student.state != PAID or \
2099            not self.context.is_current_level:
[7539]2100            emit_lock_message(self)
2101            return
[6808]2102        super(StudyLevelEditFormPage, self).update()
2103        datatable.need()
[7329]2104        warning.need()
[6808]2105        return
2106
2107    @property
2108    def label(self):
[7833]2109        # Here we know that the cookie has been set
2110        lang = self.request.cookies.get('kofa.language')
[7811]2111        level_title = translate(self.context.level_title, 'waeup.kofa',
[7723]2112            target_language=lang)
[8920]2113        return _('Edit course list of ${a}',
[7723]2114            mapping = {'a':level_title})
[6808]2115
2116    @property
2117    def total_credits(self):
2118        total_credits = 0
2119        for key, val in self.context.items():
2120            total_credits += val.credits
2121        return total_credits
2122
[8921]2123    @property
2124    def translated_values(self):
2125        return translated_values(self)
2126
[7723]2127    @action(_('Add course ticket'))
[6808]2128    def addCourseTicket(self, **data):
2129        self.redirect(self.url(self.context, 'ctadd'))
2130
[9280]2131    def _delCourseTicket(self, **data):
[6808]2132        form = self.request.form
2133        if form.has_key('val_id'):
2134            child_id = form['val_id']
2135        else:
[7723]2136            self.flash(_('No ticket selected.'))
[6808]2137            self.redirect(self.url(self.context, '@@edit'))
2138            return
2139        if not isinstance(child_id, list):
2140            child_id = [child_id]
2141        deleted = []
2142        for id in child_id:
[6940]2143            # Students are not allowed to remove core tickets
[7665]2144            if not self.context[id].mandatory:
[7723]2145                del self.context[id]
2146                deleted.append(id)
[6808]2147        if len(deleted):
[7723]2148            self.flash(_('Successfully removed: ${a}',
2149                mapping = {'a':', '.join(deleted)}))
[9332]2150            self.context.writeLogMessage(
2151                self,'removed: %s' % ', '.join(deleted))
[6808]2152        self.redirect(self.url(self.context, u'@@edit'))
2153        return
2154
[9280]2155    @jsaction(_('Remove selected tickets'))
2156    def delCourseTicket(self, **data):
2157        self._delCourseTicket(**data)
2158        return
2159
2160    def _registerCourses(self, **data):
[9252]2161        if self.context.student.is_postgrad:
2162            self.flash(_(
2163                "You are a postgraduate student, "
2164                "your course list can't bee registered."))
2165            self.redirect(self.url(self.context))
2166            return
[8642]2167        if self.total_credits > self.max_credits:
2168            self.flash(_('Maximum credits of ${a} exceeded.',
2169                mapping = {'a':self.max_credits}))
2170            return
[8736]2171        IWorkflowInfo(self.context.student).fireTransition(
[7642]2172            'register_courses')
[7723]2173        self.flash(_('Course list has been registered.'))
[6810]2174        self.redirect(self.url(self.context))
2175        return
2176
[9280]2177    @action(_('Register course list'), style='primary')
2178    def registerCourses(self, **data):
2179        self._registerCourses(**data)
2180        return
2181
2182
[6808]2183class CourseTicketAddFormPage2(CourseTicketAddFormPage):
2184    """Add a course ticket by student.
2185    """
2186    grok.name('ctadd')
2187    grok.require('waeup.handleStudent')
[9420]2188    form_fields = grok.AutoFields(ICourseTicketAdd)
[6808]2189
[7539]2190    def update(self):
[9257]2191        if self.context.student.state != PAID or \
2192            not self.context.is_current_level:
[7539]2193            emit_lock_message(self)
2194            return
2195        super(CourseTicketAddFormPage2, self).update()
2196        return
2197
[7723]2198    @action(_('Add course ticket'))
[6808]2199    def addCourseTicket(self, **data):
[7642]2200        # Safety belt
[8736]2201        if self.context.student.state != PAID:
[7539]2202            return
[8325]2203        ticket = createObject(u'waeup.CourseTicket')
[6808]2204        course = data['course']
2205        ticket.automatic = False
[8920]2206        ticket.carry_over = False
[6808]2207        try:
[8920]2208            self.context.addCourseTicket(ticket, course)
[6808]2209        except KeyError:
[7723]2210            self.flash(_('The ticket exists.'))
[6808]2211            return
[7723]2212        self.flash(_('Successfully added ${a}.',
2213            mapping = {'a':ticket.code}))
[6808]2214        self.redirect(self.url(self.context, u'@@edit'))
2215        return
[7369]2216
2217
[7819]2218class SetPasswordPage(KofaPage):
2219    grok.context(IKofaObject)
[7660]2220    grok.name('setpassword')
2221    grok.require('waeup.Anonymous')
2222    grok.template('setpassword')
[7723]2223    label = _('Set password for first-time login')
[7660]2224    ac_prefix = 'PWD'
2225    pnav = 0
[7738]2226    set_button = _('Set')
[7660]2227
2228    def update(self, SUBMIT=None):
2229        self.reg_number = self.request.form.get('reg_number', None)
2230        self.ac_series = self.request.form.get('ac_series', None)
2231        self.ac_number = self.request.form.get('ac_number', None)
2232
2233        if SUBMIT is None:
2234            return
2235        hitlist = search(query=self.reg_number,
2236            searchtype='reg_number', view=self)
2237        if not hitlist:
[7723]2238            self.flash(_('No student found.'))
[7660]2239            return
2240        if len(hitlist) != 1:   # Cannot happen but anyway
[7723]2241            self.flash(_('More than one student found.'))
[7660]2242            return
2243        student = hitlist[0].context
2244        self.student_id = student.student_id
2245        student_pw = student.password
2246        pin = '%s-%s-%s' % (self.ac_prefix, self.ac_series, self.ac_number)
2247        code = get_access_code(pin)
2248        if not code:
[7723]2249            self.flash(_('Access code is invalid.'))
[7660]2250            return
2251        if student_pw and pin == student.adm_code:
[7723]2252            self.flash(_(
2253                'Password has already been set. Your Student Id is ${a}',
2254                mapping = {'a':self.student_id}))
[7660]2255            return
2256        elif student_pw:
2257            self.flash(
[7723]2258                _('Password has already been set. You are using the ' +
2259                'wrong Access Code.'))
[7660]2260            return
2261        # Mark pin as used (this also fires a pin related transition)
2262        # and set student password
2263        if code.state == USED:
[7723]2264            self.flash(_('Access code has already been used.'))
[7660]2265            return
2266        else:
[7723]2267            comment = _(u"invalidated")
[7660]2268            # Here we know that the ac is in state initialized so we do not
2269            # expect an exception
2270            invalidate_accesscode(pin,comment)
2271            IUserAccount(student).setPassword(self.ac_number)
2272            student.adm_code = pin
[7723]2273        self.flash(_('Password has been set. Your Student Id is ${a}',
2274            mapping = {'a':self.student_id}))
[7811]2275        return
[8779]2276
2277class StudentRequestPasswordPage(KofaAddFormPage):
2278    """Captcha'd registration page for applicants.
2279    """
2280    grok.name('requestpw')
2281    grok.require('waeup.Anonymous')
2282    grok.template('requestpw')
2283    form_fields = grok.AutoFields(IStudentRequestPW).select(
[8854]2284        'firstname','number','email')
[8779]2285    label = _('Request password for first-time login')
2286
2287    def update(self):
2288        # Handle captcha
2289        self.captcha = getUtility(ICaptchaManager).getCaptcha()
2290        self.captcha_result = self.captcha.verify(self.request)
2291        self.captcha_code = self.captcha.display(self.captcha_result.error_code)
2292        return
2293
2294    def _redirect(self, email, password, student_id):
2295        # Forward only email to landing page in base package.
2296        self.redirect(self.url(self.context, 'requestpw_complete',
2297            data = dict(email=email)))
2298        return
2299
2300    def _pw_used(self):
[8780]2301        # XXX: False if password has not been used. We need an extra
2302        #      attribute which remembers if student logged in.
[8779]2303        return True
2304
[8854]2305    @action(_('Send login credentials to email address'), style='primary')
[8779]2306    def get_credentials(self, **data):
2307        if not self.captcha_result.is_valid:
2308            # Captcha will display error messages automatically.
2309            # No need to flash something.
2310            return
[8854]2311        number = data.get('number','')
[8779]2312        firstname = data.get('firstname','')
2313        cat = getUtility(ICatalog, name='students_catalog')
2314        results = list(
[8854]2315            cat.searchResults(reg_number=(number, number)))
2316        if not results:
2317            results = list(
2318                cat.searchResults(matric_number=(number, number)))
[8779]2319        if results:
2320            student = results[0]
2321            if getattr(student,'firstname',None) is None:
2322                self.flash(_('An error occurred.'))
2323                return
2324            elif student.firstname.lower() != firstname.lower():
2325                # Don't tell the truth here. Anonymous must not
2326                # know that a record was found and only the firstname
2327                # verification failed.
2328                self.flash(_('No student record found.'))
2329                return
2330            elif student.password is not None and self._pw_used:
2331                self.flash(_('Your password has already been set and used. '
2332                             'Please proceed to the login page.'))
2333                return
2334            # Store email address but nothing else.
2335            student.email = data['email']
2336            notify(grok.ObjectModifiedEvent(student))
2337        else:
2338            # No record found, this is the truth.
2339            self.flash(_('No student record found.'))
2340            return
2341
2342        kofa_utils = getUtility(IKofaUtils)
2343        password = kofa_utils.genPassword()
[8857]2344        mandate = PasswordMandate()
[8853]2345        mandate.params['password'] = password
[8858]2346        mandate.params['user'] = student
[8853]2347        site = grok.getSite()
2348        site['mandates'].addMandate(mandate)
[8779]2349        # Send email with credentials
[8853]2350        args = {'mandate_id':mandate.mandate_id}
2351        mandate_url = self.url(site) + '/mandate?%s' % urlencode(args)
2352        url_info = u'Confirmation link: %s' % mandate_url
[8779]2353        msg = _('You have successfully requested a password for the')
2354        if kofa_utils.sendCredentials(IUserAccount(student),
[8853]2355            password, url_info, msg):
[8779]2356            email_sent = student.email
2357        else:
2358            email_sent = None
2359        self._redirect(email=email_sent, password=password,
2360            student_id=student.student_id)
[8856]2361        ob_class = self.__implemented__.__name__.replace('waeup.kofa.','')
2362        self.context.logger.info(
2363            '%s - %s (%s) - %s' % (ob_class, number, student.student_id, email_sent))
[8779]2364        return
2365
2366class StudentRequestPasswordEmailSent(KofaPage):
2367    """Landing page after successful password request.
2368
2369    """
2370    grok.name('requestpw_complete')
2371    grok.require('waeup.Public')
2372    grok.template('requestpwmailsent')
2373    label = _('Your password request was successful.')
2374
2375    def update(self, email=None, student_id=None, password=None):
2376        self.email = email
2377        self.password = password
2378        self.student_id = student_id
[8974]2379        return
Note: See TracBrowser for help on using the repository browser.