## $Id: browser.py 9770 2012-12-05 08:33:04Z henrik $ ## ## Copyright (C) 2011 Uli Fouquet & Henrik Bettermann ## This program is free software; you can redistribute it and/or modify ## it under the terms of the GNU General Public License as published by ## the Free Software Foundation; either version 2 of the License, or ## (at your option) any later version. ## ## This program is distributed in the hope that it will be useful, ## but WITHOUT ANY WARRANTY; without even the implied warranty of ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the ## GNU General Public License for more details. ## ## You should have received a copy of the GNU General Public License ## along with this program; if not, write to the Free Software ## Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA ## """UI components for students and related components. """ import sys import grok from urllib import urlencode from datetime import datetime from copy import deepcopy from zope.event import notify from zope.i18n import translate from zope.catalog.interfaces import ICatalog from zope.component import queryUtility, getUtility, createObject from zope.schema.interfaces import ConstraintNotSatisfied, RequiredMissing from zope.formlib.textwidgets import BytesDisplayWidget from hurry.workflow.interfaces import IWorkflowInfo, IWorkflowState from waeup.kofa.accesscodes import ( invalidate_accesscode, get_access_code) from waeup.kofa.accesscodes.workflow import USED from waeup.kofa.browser.layout import ( KofaPage, KofaEditFormPage, KofaAddFormPage, KofaDisplayFormPage, KofaForm, NullValidator) from waeup.kofa.browser.pages import ContactAdminForm from waeup.kofa.browser.breadcrumbs import Breadcrumb from waeup.kofa.browser.resources import datepicker, datatable, tabs, warning from waeup.kofa.browser.layout import jsaction, action, UtilityView from waeup.kofa.browser.interfaces import ICaptchaManager from waeup.kofa.interfaces import ( IKofaObject, IUserAccount, IExtFileStore, IPasswordValidator, IContactForm, IKofaUtils, IUniversity, IObjectHistory, academic_sessions) from waeup.kofa.interfaces import MessageFactory as _ from waeup.kofa.widgets.datewidget import ( FriendlyDateWidget, FriendlyDateDisplayWidget, FriendlyDatetimeDisplayWidget) from waeup.kofa.widgets.restwidget import ReSTDisplayWidget from waeup.kofa.students.interfaces import ( IStudentsContainer, IStudent, IUGStudentClearance,IPGStudentClearance, IStudentPersonal, IStudentPersonalEdit, IStudentBase, IStudentStudyCourse, IStudentStudyCourseTransfer, IStudentAccommodation, IStudentStudyLevel, ICourseTicket, ICourseTicketAdd, IStudentPaymentsContainer, IStudentOnlinePayment, IStudentPreviousPayment, IBedTicket, IStudentsUtils, IStudentRequestPW ) from waeup.kofa.students.catalog import search from waeup.kofa.students.workflow import (CREATED, ADMITTED, PAID, CLEARANCE, REQUESTED, RETURNING, CLEARED, REGISTERED, VALIDATED, FORBIDDEN_POSTGRAD_TRANS) from waeup.kofa.students.studylevel import StudentStudyLevel, CourseTicket from waeup.kofa.students.vocabularies import StudyLevelSource from waeup.kofa.browser.resources import toggleall from waeup.kofa.hostels.hostel import NOT_OCCUPIED from waeup.kofa.utils.helpers import get_current_principal, to_timezone from waeup.kofa.mandates.mandate import PasswordMandate grok.context(IKofaObject) # Make IKofaObject the default context # Save function used for save methods in pages def msave(view, **data): changed_fields = view.applyData(view.context, **data) # Turn list of lists into single list if changed_fields: changed_fields = reduce(lambda x,y: x+y, changed_fields.values()) # Inform catalog if certificate has changed # (applyData does this only for the context) if 'certificate' in changed_fields: notify(grok.ObjectModifiedEvent(view.context.student)) fields_string = ' + '.join(changed_fields) view.flash(_('Form has been saved.')) if fields_string: view.context.writeLogMessage(view, 'saved: %s' % fields_string) return def emit_lock_message(view): """Flash a lock message. """ view.flash(_('The requested form is locked (read-only).')) view.redirect(view.url(view.context)) return def translated_values(view): """Translate course ticket attribute values to be displayed on studylevel pages. """ lang = view.request.cookies.get('kofa.language') for value in view.context.values(): # We have to unghostify (according to Tres Seaver) the __dict__ # by activating the object, otherwise value_dict will be empty # when calling the first time. value._p_activate() value_dict = dict([i for i in value.__dict__.items()]) value_dict['removable_by_student'] = value.removable_by_student value_dict['mandatory'] = translate(str(value.mandatory), 'zope', target_language=lang) value_dict['carry_over'] = translate(str(value.carry_over), 'zope', target_language=lang) value_dict['automatic'] = translate(str(value.automatic), 'zope', target_language=lang) value_dict['grade'] = value.grade value_dict['weight'] = value.weight yield value_dict class StudentsBreadcrumb(Breadcrumb): """A breadcrumb for the students container. """ grok.context(IStudentsContainer) title = _('Students') @property def target(self): user = get_current_principal() if getattr(user, 'user_type', None) == 'student': return None return self.viewname class StudentBreadcrumb(Breadcrumb): """A breadcrumb for the student container. """ grok.context(IStudent) def title(self): return self.context.display_fullname class SudyCourseBreadcrumb(Breadcrumb): """A breadcrumb for the student study course. """ grok.context(IStudentStudyCourse) def title(self): if self.context.is_current: return _('Study Course') else: return _('Previous Study Course') class PaymentsBreadcrumb(Breadcrumb): """A breadcrumb for the student payments folder. """ grok.context(IStudentPaymentsContainer) title = _('Payments') class OnlinePaymentBreadcrumb(Breadcrumb): """A breadcrumb for payments. """ grok.context(IStudentOnlinePayment) @property def title(self): return self.context.p_id class AccommodationBreadcrumb(Breadcrumb): """A breadcrumb for the student accommodation folder. """ grok.context(IStudentAccommodation) title = _('Accommodation') class BedTicketBreadcrumb(Breadcrumb): """A breadcrumb for bed tickets. """ grok.context(IBedTicket) @property def title(self): return _('Bed Ticket ${a}', mapping = {'a':self.context.getSessionString()}) class StudyLevelBreadcrumb(Breadcrumb): """A breadcrumb for course lists. """ grok.context(IStudentStudyLevel) @property def title(self): return self.context.level_title class StudentsContainerPage(KofaPage): """The standard view for student containers. """ grok.context(IStudentsContainer) grok.name('index') grok.require('waeup.viewStudentsContainer') grok.template('containerpage') label = _('Student Section') search_button = _('Search') pnav = 4 def update(self, *args, **kw): datatable.need() form = self.request.form self.hitlist = [] if 'searchterm' in form and form['searchterm']: self.searchterm = form['searchterm'] self.searchtype = form['searchtype'] elif 'old_searchterm' in form: self.searchterm = form['old_searchterm'] self.searchtype = form['old_searchtype'] else: if 'search' in form: self.flash(_('Empty search string')) return if self.searchtype == 'current_session': try: self.searchterm = int(self.searchterm) except ValueError: self.flash(_('Only year dates allowed (e.g. 2011).')) return self.hitlist = search(query=self.searchterm, searchtype=self.searchtype, view=self) if not self.hitlist: self.flash(_('No student found.')) return class StudentsContainerManagePage(KofaPage): """The manage page for student containers. """ grok.context(IStudentsContainer) grok.name('manage') grok.require('waeup.manageStudent') grok.template('containermanagepage') pnav = 4 label = _('Manage student section') search_button = _('Search') remove_button = _('Remove selected') def update(self, *args, **kw): datatable.need() toggleall.need() warning.need() form = self.request.form self.hitlist = [] if 'searchterm' in form and form['searchterm']: self.searchterm = form['searchterm'] self.searchtype = form['searchtype'] elif 'old_searchterm' in form: self.searchterm = form['old_searchterm'] self.searchtype = form['old_searchtype'] else: if 'search' in form: self.flash(_('Empty search string')) return if self.searchtype == 'current_session': try: self.searchterm = int(self.searchterm) except ValueError: self.flash('Only year dates allowed (e.g. 2011).') return if not 'entries' in form: self.hitlist = search(query=self.searchterm, searchtype=self.searchtype, view=self) if not self.hitlist: self.flash(_('No student found.')) if 'remove' in form: self.flash(_('No item selected.')) return entries = form['entries'] if isinstance(entries, basestring): entries = [entries] deleted = [] for entry in entries: if 'remove' in form: del self.context[entry] deleted.append(entry) self.hitlist = search(query=self.searchterm, searchtype=self.searchtype, view=self) if len(deleted): self.flash(_('Successfully removed: ${a}', mapping = {'a':', '.join(deleted)})) return class StudentAddFormPage(KofaAddFormPage): """Add-form to add a student. """ grok.context(IStudentsContainer) grok.require('waeup.manageStudent') grok.name('addstudent') form_fields = grok.AutoFields(IStudent).select( 'firstname', 'middlename', 'lastname', 'reg_number') label = _('Add student') pnav = 4 @action(_('Create student record'), style='primary') def addStudent(self, **data): student = createObject(u'waeup.Student') self.applyData(student, **data) self.context.addStudent(student) self.flash(_('Student record created.')) self.redirect(self.url(self.context[student.student_id], 'index')) return class LoginAsStudentStep1(KofaEditFormPage): """ View to temporarily set a student password. """ grok.context(IStudent) grok.name('loginasstep1') grok.require('waeup.loginAsStudent') grok.template('loginasstep1') pnav = 4 def label(self): return _(u'Set temporary password for ${a}', mapping = {'a':self.context.display_fullname}) @action('Set password now', style='primary') def setPassword(self, *args, **data): kofa_utils = getUtility(IKofaUtils) password = kofa_utils.genPassword() self.context.setTempPassword(self.request.principal.id, password) self.context.writeLogMessage( self, 'temp_password generated: %s' % password) args = {'password':password} self.redirect(self.url(self.context) + '/loginasstep2?%s' % urlencode(args)) return class LoginAsStudentStep2(KofaPage): """ View to temporarily login as student with a temporary password. """ grok.context(IStudent) grok.name('loginasstep2') grok.require('waeup.Public') grok.template('loginasstep2') login_button = _('Login now') pnav = 4 def label(self): return _(u'Login as ${a}', mapping = {'a':self.context.student_id}) def update(self, SUBMIT=None, password=None): self.password = password if SUBMIT is not None: self.flash(_('You successfully logged in as student.')) self.redirect(self.url(self.context)) return class StudentBaseDisplayFormPage(KofaDisplayFormPage): """ Page to display student base data """ grok.context(IStudent) grok.name('index') grok.require('waeup.viewStudent') grok.template('basepage') form_fields = grok.AutoFields(IStudentBase).omit( 'password', 'suspended', 'suspended_comment') pnav = 4 @property def label(self): if self.context.suspended: return _('${a}: Base Data (account deactivated)', mapping = {'a':self.context.display_fullname}) return _('${a}: Base Data', mapping = {'a':self.context.display_fullname}) @property def hasPassword(self): if self.context.password: return _('set') return _('unset') class StudentBasePDFFormPage(KofaDisplayFormPage): """ Page to display student base data in pdf files. """ def __init__(self, context, request, omit_fields): self.omit_fields = omit_fields super(StudentBasePDFFormPage, self).__init__(context, request) @property def form_fields(self): form_fields = grok.AutoFields(IStudentBase) for field in self.omit_fields: form_fields = form_fields.omit(field) return form_fields class ContactStudentForm(ContactAdminForm): grok.context(IStudent) grok.name('contactstudent') grok.require('waeup.viewStudent') pnav = 4 form_fields = grok.AutoFields(IContactForm).select('subject', 'body') def update(self, subject=u'', body=u''): self.form_fields.get('subject').field.default = subject self.form_fields.get('body').field.default = body return super(ContactStudentForm, self).update() def label(self): return _(u'Send message to ${a}', mapping = {'a':self.context.display_fullname}) @action('Send message now', style='primary') def send(self, *args, **data): try: email = self.request.principal.email except AttributeError: email = self.config.email_admin usertype = getattr(self.request.principal, 'user_type', 'system').title() kofa_utils = getUtility(IKofaUtils) success = kofa_utils.sendContactForm( self.request.principal.title,email, self.context.display_fullname,self.context.email, self.request.principal.id,usertype, self.config.name, data['body'],data['subject']) if success: self.flash(_('Your message has been sent.')) else: self.flash(_('An smtp server error occurred.')) return class ExportPDFAdmissionSlipPage(UtilityView, grok.View): """Deliver a PDF Admission slip. """ grok.context(IStudent) grok.name('admission_slip.pdf') grok.require('waeup.viewStudent') prefix = 'form' form_fields = grok.AutoFields(IStudentBase).select('student_id', 'reg_number') @property def label(self): portal_language = getUtility(IKofaUtils).PORTAL_LANGUAGE return translate(_('Admission Letter of'), 'waeup.kofa', target_language=portal_language) \ + ' %s' % self.context.display_fullname def render(self): students_utils = getUtility(IStudentsUtils) return students_utils.renderPDFAdmissionLetter(self, self.context.student) class StudentBaseManageFormPage(KofaEditFormPage): """ View to manage student base data """ grok.context(IStudent) grok.name('manage_base') grok.require('waeup.manageStudent') form_fields = grok.AutoFields(IStudentBase).omit( 'student_id', 'adm_code', 'suspended') grok.template('basemanagepage') label = _('Manage base data') pnav = 4 def update(self): datepicker.need() # Enable jQuery datepicker in date fields. tabs.need() self.tab1 = self.tab2 = '' qs = self.request.get('QUERY_STRING', '') if not qs: qs = 'tab1' setattr(self, qs, 'active') super(StudentBaseManageFormPage, self).update() self.wf_info = IWorkflowInfo(self.context) return @action(_('Save'), style='primary') def save(self, **data): form = self.request.form password = form.get('password', None) password_ctl = form.get('control_password', None) if password: validator = getUtility(IPasswordValidator) errors = validator.validate_password(password, password_ctl) if errors: self.flash( ' '.join(errors)) return changed_fields = self.applyData(self.context, **data) # Turn list of lists into single list if changed_fields: changed_fields = reduce(lambda x,y: x+y, changed_fields.values()) else: changed_fields = [] if password: # Now we know that the form has no errors and can set password IUserAccount(self.context).setPassword(password) changed_fields.append('password') fields_string = ' + '.join(changed_fields) self.flash(_('Form has been saved.')) if fields_string: self.context.writeLogMessage(self, 'saved: % s' % fields_string) return class StudentTriggerTransitionFormPage(KofaEditFormPage): """ View to manage student base data """ grok.context(IStudent) grok.name('trigtrans') grok.require('waeup.triggerTransition') grok.template('trigtrans') label = _('Trigger registration transition') pnav = 4 def getTransitions(self): """Return a list of dicts of allowed transition ids and titles. Each list entry provides keys ``name`` and ``title`` for internal name and (human readable) title of a single transition. """ wf_info = IWorkflowInfo(self.context) allowed_transitions = [t for t in wf_info.getManualTransitions() if not t[0].startswith('pay')] if self.context.is_postgrad: allowed_transitions = [t for t in allowed_transitions if not t[0] in FORBIDDEN_POSTGRAD_TRANS] return [dict(name='', title=_('No transition'))] +[ dict(name=x, title=y) for x, y in allowed_transitions] @action(_('Save'), style='primary') def save(self, **data): form = self.request.form if 'transition' in form and form['transition']: transition_id = form['transition'] wf_info = IWorkflowInfo(self.context) wf_info.fireTransition(transition_id) return class StudentActivatePage(UtilityView, grok.View): """ Activate student account """ grok.context(IStudent) grok.name('activate') grok.require('waeup.manageStudent') def update(self): self.context.suspended = False self.context.writeLogMessage(self, 'account activated') history = IObjectHistory(self.context) history.addMessage('Student account activated') self.flash(_('Student account has been activated.')) self.redirect(self.url(self.context)) return def render(self): return class StudentDeactivatePage(UtilityView, grok.View): """ Deactivate student account """ grok.context(IStudent) grok.name('deactivate') grok.require('waeup.manageStudent') def update(self): self.context.suspended = True self.context.writeLogMessage(self, 'account deactivated') history = IObjectHistory(self.context) history.addMessage('Student account deactivated') self.flash(_('Student account has been deactivated.')) self.redirect(self.url(self.context)) return def render(self): return class StudentClearanceDisplayFormPage(KofaDisplayFormPage): """ Page to display student clearance data """ grok.context(IStudent) grok.name('view_clearance') grok.require('waeup.viewStudent') pnav = 4 @property def separators(self): return getUtility(IStudentsUtils).SEPARATORS_DICT @property def form_fields(self): if self.context.is_postgrad: form_fields = grok.AutoFields( IPGStudentClearance).omit('clearance_locked') else: form_fields = grok.AutoFields( IUGStudentClearance).omit('clearance_locked') if not getattr(self.context, 'officer_comment'): form_fields = form_fields.omit('officer_comment') else: form_fields['officer_comment'].custom_widget = BytesDisplayWidget return form_fields @property def label(self): return _('${a}: Clearance Data', mapping = {'a':self.context.display_fullname}) class ExportPDFClearanceSlipPage(grok.View): """Deliver a PDF slip of the context. """ grok.context(IStudent) grok.name('clearance_slip.pdf') grok.require('waeup.viewStudent') prefix = 'form' omit_fields = ( 'password', 'suspended', 'phone', 'adm_code', 'suspended_comment') @property def form_fields(self): if self.context.is_postgrad: form_fields = grok.AutoFields( IPGStudentClearance).omit('clearance_locked') else: form_fields = grok.AutoFields( IUGStudentClearance).omit('clearance_locked') if not getattr(self.context, 'officer_comment'): form_fields = form_fields.omit('officer_comment') return form_fields @property def title(self): portal_language = getUtility(IKofaUtils).PORTAL_LANGUAGE return translate(_('Clearance Data'), 'waeup.kofa', target_language=portal_language) @property def label(self): portal_language = getUtility(IKofaUtils).PORTAL_LANGUAGE return translate(_('Clearance Slip of'), 'waeup.kofa', target_language=portal_language) \ + ' %s' % self.context.display_fullname def _signatures(self): isStudent = getattr( self.request.principal, 'user_type', None) == 'student' if not isStudent and self.context.state in (CLEARED, ): return (_('Student Signature'), _('Clearance Officer Signature')) return def _sigsInFooter(self): isStudent = getattr( self.request.principal, 'user_type', None) == 'student' if not isStudent and self.context.state in (CLEARED, ): return (_('Date, Student Signature'), _('Date, Clearance Officer Signature'), ) return () def render(self): studentview = StudentBasePDFFormPage(self.context.student, self.request, self.omit_fields) students_utils = getUtility(IStudentsUtils) return students_utils.renderPDF( self, 'clearance_slip.pdf', self.context.student, studentview, signatures=self._signatures(), sigs_in_footer=self._sigsInFooter()) class StudentClearanceManageFormPage(KofaEditFormPage): """ Page to manage student clearance data """ grok.context(IStudent) grok.name('manage_clearance') grok.require('waeup.manageStudent') grok.template('clearanceeditpage') label = _('Manage clearance data') pnav = 4 @property def separators(self): return getUtility(IStudentsUtils).SEPARATORS_DICT @property def form_fields(self): if self.context.is_postgrad: form_fields = grok.AutoFields(IPGStudentClearance).omit('clr_code') else: form_fields = grok.AutoFields(IUGStudentClearance).omit('clr_code') return form_fields def update(self): datepicker.need() # Enable jQuery datepicker in date fields. tabs.need() self.tab1 = self.tab2 = '' qs = self.request.get('QUERY_STRING', '') if not qs: qs = 'tab1' setattr(self, qs, 'active') return super(StudentClearanceManageFormPage, self).update() @action(_('Save'), style='primary') def save(self, **data): msave(self, **data) return class StudentClearPage(UtilityView, grok.View): """ Clear student by clearance officer """ grok.context(IStudent) grok.name('clear') grok.require('waeup.clearStudent') def update(self): if self.context.state == REQUESTED: IWorkflowInfo(self.context).fireTransition('clear') self.flash(_('Student has been cleared.')) else: self.flash(_('Student is in wrong state.')) self.redirect(self.url(self.context,'view_clearance')) return def render(self): return class StudentRejectClearancePage(KofaEditFormPage): """ Reject clearance by clearance officers """ grok.context(IStudent) grok.name('reject_clearance') label = _('Reject clearance') grok.require('waeup.clearStudent') form_fields = grok.AutoFields( IUGStudentClearance).select('officer_comment') @action(_('Save comment and reject clearance now'), style='primary') def reject(self, **data): if self.context.state == CLEARED: IWorkflowInfo(self.context).fireTransition('reset4') message = _('Clearance has been annulled.') self.flash(message) elif self.context.state == REQUESTED: IWorkflowInfo(self.context).fireTransition('reset3') message = _('Clearance request has been rejected.') self.flash(message) else: self.flash(_('Student is in wrong state.')) self.redirect(self.url(self.context,'view_clearance')) return self.applyData(self.context, **data) comment = data['officer_comment'] if comment: self.context.writeLogMessage( self, 'comment: %s' % comment.replace('\n', '
')) args = {'subject':message, 'body':comment} else: args = {'subject':message,} self.redirect(self.url(self.context) + '/contactstudent?%s' % urlencode(args)) return #def render(self): # return class StudentPersonalDisplayFormPage(KofaDisplayFormPage): """ Page to display student personal data """ grok.context(IStudent) grok.name('view_personal') grok.require('waeup.viewStudent') form_fields = grok.AutoFields(IStudentPersonal) form_fields['perm_address'].custom_widget = BytesDisplayWidget form_fields[ 'personal_updated'].custom_widget = FriendlyDatetimeDisplayWidget('le') pnav = 4 @property def label(self): return _('${a}: Personal Data', mapping = {'a':self.context.display_fullname}) class StudentPersonalManageFormPage(KofaEditFormPage): """ Page to manage personal data """ grok.context(IStudent) grok.name('manage_personal') grok.require('waeup.manageStudent') form_fields = grok.AutoFields(IStudentPersonal) form_fields['personal_updated'].for_display = True form_fields[ 'personal_updated'].custom_widget = FriendlyDatetimeDisplayWidget('le') label = _('Manage personal data') pnav = 4 @action(_('Save'), style='primary') def save(self, **data): msave(self, **data) return class StudentPersonalEditFormPage(KofaEditFormPage): """ Page to edit personal data """ grok.context(IStudent) grok.name('edit_personal') grok.require('waeup.handleStudent') form_fields = grok.AutoFields(IStudentPersonalEdit).omit('personal_updated') label = _('Edit personal data') pnav = 4 @action(_('Save/Confirm'), style='primary') def save(self, **data): msave(self, **data) self.context.personal_updated = datetime.utcnow() return class StudyCourseDisplayFormPage(KofaDisplayFormPage): """ Page to display the student study course data """ grok.context(IStudentStudyCourse) grok.name('index') grok.require('waeup.viewStudent') grok.template('studycoursepage') pnav = 4 @property def form_fields(self): if self.context.is_postgrad: form_fields = grok.AutoFields(IStudentStudyCourse).omit( 'previous_verdict') else: form_fields = grok.AutoFields(IStudentStudyCourse) return form_fields @property def label(self): if self.context.is_current: return _('${a}: Study Course', mapping = {'a':self.context.__parent__.display_fullname}) else: return _('${a}: Previous Study Course', mapping = {'a':self.context.__parent__.display_fullname}) @property def current_mode(self): if self.context.certificate is not None: studymodes_dict = getUtility(IKofaUtils).STUDY_MODES_DICT return studymodes_dict[self.context.certificate.study_mode] return @property def department(self): if self.context.certificate is not None: return self.context.certificate.__parent__.__parent__ return @property def faculty(self): if self.context.certificate is not None: return self.context.certificate.__parent__.__parent__.__parent__ return @property def prev_studycourses(self): if self.context.is_current: if self.context.__parent__.get('studycourse_2', None) is not None: return ( {'href':self.url(self.context.student) + '/studycourse_1', 'title':_('First Study Course, ')}, {'href':self.url(self.context.student) + '/studycourse_2', 'title':_('Second Study Course')} ) if self.context.__parent__.get('studycourse_1', None) is not None: return ( {'href':self.url(self.context.student) + '/studycourse_1', 'title':_('First Study Course')}, ) return class StudyCourseManageFormPage(KofaEditFormPage): """ Page to edit the student study course data """ grok.context(IStudentStudyCourse) grok.name('manage') grok.require('waeup.manageStudent') grok.template('studycoursemanagepage') label = _('Manage study course') pnav = 4 taboneactions = [_('Save'),_('Cancel')] tabtwoactions = [_('Remove selected levels'),_('Cancel')] tabthreeactions = [_('Add study level')] @property def form_fields(self): if self.context.is_postgrad: form_fields = grok.AutoFields(IStudentStudyCourse).omit( 'previous_verdict') else: form_fields = grok.AutoFields(IStudentStudyCourse) return form_fields def update(self): if not self.context.is_current: emit_lock_message(self) return super(StudyCourseManageFormPage, self).update() tabs.need() self.tab1 = self.tab2 = '' qs = self.request.get('QUERY_STRING', '') if not qs: qs = 'tab1' setattr(self, qs, 'active') warning.need() datatable.need() return @action(_('Save'), style='primary') def save(self, **data): try: msave(self, **data) except ConstraintNotSatisfied: # The selected level might not exist in certificate self.flash(_('Current level not available for certificate.')) return notify(grok.ObjectModifiedEvent(self.context.__parent__)) return @property def level_dict(self): studylevelsource = StudyLevelSource().factory for code in studylevelsource.getValues(self.context): title = studylevelsource.getTitle(self.context, code) yield(dict(code=code, title=title)) @property def session_dict(self): yield(dict(code='', title='--')) for item in academic_sessions(): code = item[1] title = item[0] yield(dict(code=code, title=title)) @action(_('Add study level')) def addStudyLevel(self, **data): level_code = self.request.form.get('addlevel', None) level_session = self.request.form.get('level_session', None) if not level_session: self.flash(_('You must select a session for the level.')) self.redirect(self.url(self.context, u'@@manage')+'?tab2') return studylevel = createObject(u'waeup.StudentStudyLevel') studylevel.level = int(level_code) studylevel.level_session = int(level_session) try: self.context.addStudentStudyLevel( self.context.certificate,studylevel) self.flash(_('Study level has been added.')) except KeyError: self.flash(_('This level exists.')) self.redirect(self.url(self.context, u'@@manage')+'?tab2') return @jsaction(_('Remove selected levels')) def delStudyLevels(self, **data): form = self.request.form if 'val_id' in form: child_id = form['val_id'] else: self.flash(_('No study level selected.')) self.redirect(self.url(self.context, '@@manage')+'?tab2') return if not isinstance(child_id, list): child_id = [child_id] deleted = [] for id in child_id: del self.context[id] deleted.append(id) if len(deleted): self.flash(_('Successfully removed: ${a}', mapping = {'a':', '.join(deleted)})) self.context.writeLogMessage( self,'removed: %s' % ', '.join(deleted)) self.redirect(self.url(self.context, u'@@manage')+'?tab2') return class StudentTransferFormPage(KofaAddFormPage): """Page to transfer the student. """ grok.context(IStudent) grok.name('transfer') grok.require('waeup.manageStudent') label = _('Transfer student') form_fields = grok.AutoFields(IStudentStudyCourseTransfer).omit( 'entry_mode', 'entry_session') pnav = 4 def update(self): super(StudentTransferFormPage, self).update() warning.need() return @jsaction(_('Transfer')) def transferStudent(self, **data): error = self.context.transfer(**data) if error == -1: self.flash(_('Current level does not match certificate levels.')) elif error == -2: self.flash(_('Former study course record incomplete.')) elif error == -3: self.flash(_('Maximum number of transfers exceeded.')) else: self.flash(_('Successfully transferred.')) return class StudyLevelDisplayFormPage(KofaDisplayFormPage): """ Page to display student study levels """ grok.context(IStudentStudyLevel) grok.name('index') grok.require('waeup.viewStudent') form_fields = grok.AutoFields(IStudentStudyLevel) form_fields[ 'validation_date'].custom_widget = FriendlyDatetimeDisplayWidget('le') grok.template('studylevelpage') pnav = 4 def update(self): super(StudyLevelDisplayFormPage, self).update() datatable.need() return @property def translated_values(self): return translated_values(self) @property def label(self): # Here we know that the cookie has been set lang = self.request.cookies.get('kofa.language') level_title = translate(self.context.level_title, 'waeup.kofa', target_language=lang) return _('${a}: Study Level ${b}', mapping = { 'a':self.context.student.display_fullname, 'b':level_title}) class ExportPDFCourseRegistrationSlipPage(UtilityView, grok.View): """Deliver a PDF slip of the context. """ grok.context(IStudentStudyLevel) grok.name('course_registration_slip.pdf') grok.require('waeup.viewStudent') form_fields = grok.AutoFields(IStudentStudyLevel) form_fields[ 'validation_date'].custom_widget = FriendlyDatetimeDisplayWidget('le') prefix = 'form' omit_fields = ( 'password', 'suspended', 'phone', 'adm_code', 'sex', 'suspended_comment') @property def title(self): portal_language = getUtility(IKofaUtils).PORTAL_LANGUAGE return translate(_('Level Data'), 'waeup.kofa', target_language=portal_language) @property def content_title(self): portal_language = getUtility(IKofaUtils).PORTAL_LANGUAGE return translate(_('Course List'), 'waeup.kofa', target_language=portal_language) @property def label(self): portal_language = getUtility(IKofaUtils).PORTAL_LANGUAGE lang = self.request.cookies.get('kofa.language', portal_language) level_title = translate(self.context.level_title, 'waeup.kofa', target_language=lang) return translate(_('Course Registration Slip'), 'waeup.kofa', target_language=portal_language) \ + ' %s' % level_title def render(self): portal_language = getUtility(IKofaUtils).PORTAL_LANGUAGE Sem = translate(_('Sem.'), 'waeup.kofa', target_language=portal_language) Code = translate(_('Code'), 'waeup.kofa', target_language=portal_language) Title = translate(_('Title'), 'waeup.kofa', target_language=portal_language) Dept = translate(_('Dept.'), 'waeup.kofa', target_language=portal_language) Faculty = translate(_('Faculty'), 'waeup.kofa', target_language=portal_language) Cred = translate(_('Cred.'), 'waeup.kofa', target_language=portal_language) Mand = translate(_('Requ.'), 'waeup.kofa', target_language=portal_language) Score = translate(_('Score'), 'waeup.kofa', target_language=portal_language) studentview = StudentBasePDFFormPage(self.context.student, self.request, self.omit_fields) students_utils = getUtility(IStudentsUtils) tabledata = sorted(self.context.values(), key=lambda value: str(value.semester) + value.code) return students_utils.renderPDF( self, 'course_registration_slip.pdf', self.context.student, studentview, tableheader=[(Sem,'semester', 1.5),(Code,'code', 2.5), (Title,'title', 5), (Dept,'dcode', 1.5), (Faculty,'fcode', 1.5), (Cred, 'credits', 1.5), (Mand, 'mandatory', 1.5), (Score, 'score', 1.5), #('Auto', 'automatic', 1.5) ], tabledata=tabledata) class StudyLevelManageFormPage(KofaEditFormPage): """ Page to edit the student study level data """ grok.context(IStudentStudyLevel) grok.name('manage') grok.require('waeup.manageStudent') grok.template('studylevelmanagepage') form_fields = grok.AutoFields(IStudentStudyLevel).omit( 'validation_date', 'validated_by', 'total_credits', 'gpa') pnav = 4 taboneactions = [_('Save'),_('Cancel')] tabtwoactions = [_('Add course ticket'), _('Remove selected tickets'),_('Cancel')] def update(self): if not self.context.__parent__.is_current: emit_lock_message(self) return super(StudyLevelManageFormPage, self).update() tabs.need() self.tab1 = self.tab2 = '' qs = self.request.get('QUERY_STRING', '') if not qs: qs = 'tab1' setattr(self, qs, 'active') warning.need() datatable.need() return @property def translated_values(self): return translated_values(self) @property def label(self): # Here we know that the cookie has been set lang = self.request.cookies.get('kofa.language') level_title = translate(self.context.level_title, 'waeup.kofa', target_language=lang) return _('Manage study level ${a}', mapping = {'a':level_title}) @action(_('Save'), style='primary') def save(self, **data): msave(self, **data) return @action(_('Add course ticket')) def addCourseTicket(self, **data): self.redirect(self.url(self.context, '@@add')) @jsaction(_('Remove selected tickets')) def delCourseTicket(self, **data): form = self.request.form if 'val_id' in form: child_id = form['val_id'] else: self.flash(_('No ticket selected.')) self.redirect(self.url(self.context, '@@manage')+'?tab2') return if not isinstance(child_id, list): child_id = [child_id] deleted = [] for id in child_id: del self.context[id] deleted.append(id) if len(deleted): self.flash(_('Successfully removed: ${a}', mapping = {'a':', '.join(deleted)})) self.context.writeLogMessage( self,'removed: %s' % ', '.join(deleted)) self.redirect(self.url(self.context, u'@@manage')+'?tab2') return class ValidateCoursesPage(UtilityView, grok.View): """ Validate course list by course adviser """ grok.context(IStudentStudyLevel) grok.name('validate_courses') grok.require('waeup.validateStudent') def update(self): if not self.context.__parent__.is_current: emit_lock_message(self) return if str(self.context.__parent__.current_level) != self.context.__name__: self.flash(_('This level does not correspond current level.')) elif self.context.student.state == REGISTERED: IWorkflowInfo(self.context.student).fireTransition( 'validate_courses') self.flash(_('Course list has been validated.')) else: self.flash(_('Student is in the wrong state.')) self.redirect(self.url(self.context)) return def render(self): return class RejectCoursesPage(UtilityView, grok.View): """ Reject course list by course adviser """ grok.context(IStudentStudyLevel) grok.name('reject_courses') grok.require('waeup.validateStudent') def update(self): if not self.context.__parent__.is_current: emit_lock_message(self) return if str(self.context.__parent__.current_level) != self.context.__name__: self.flash(_('This level does not correspond current level.')) self.redirect(self.url(self.context)) return elif self.context.student.state == VALIDATED: IWorkflowInfo(self.context.student).fireTransition('reset8') message = _('Course list request has been annulled.') self.flash(message) elif self.context.student.state == REGISTERED: IWorkflowInfo(self.context.student).fireTransition('reset7') message = _('Course list request has been rejected:') self.flash(message) else: self.flash(_('Student is in the wrong state.')) self.redirect(self.url(self.context)) return args = {'subject':message} self.redirect(self.url(self.context.student) + '/contactstudent?%s' % urlencode(args)) return def render(self): return class CourseTicketAddFormPage(KofaAddFormPage): """Add a course ticket. """ grok.context(IStudentStudyLevel) grok.name('add') grok.require('waeup.manageStudent') label = _('Add course ticket') form_fields = grok.AutoFields(ICourseTicketAdd) pnav = 4 def update(self): if not self.context.__parent__.is_current: emit_lock_message(self) return super(CourseTicketAddFormPage, self).update() return @action(_('Add course ticket')) def addCourseTicket(self, **data): students_utils = getUtility(IStudentsUtils) ticket = createObject(u'waeup.CourseTicket') course = data['course'] ticket.automatic = False ticket.carry_over = False max_credits = students_utils.maxCreditsExceeded(self.context, course) if max_credits: self.flash(_( 'Total credits exceed ${a}.', mapping = {'a': max_credits})) return try: self.context.addCourseTicket(ticket, course) except KeyError: self.flash(_('The ticket exists.')) return self.flash(_('Successfully added ${a}.', mapping = {'a':ticket.code})) self.redirect(self.url(self.context, u'@@manage')+'?tab2') return @action(_('Cancel'), validator=NullValidator) def cancel(self, **data): self.redirect(self.url(self.context)) class CourseTicketDisplayFormPage(KofaDisplayFormPage): """ Page to display course tickets """ grok.context(ICourseTicket) grok.name('index') grok.require('waeup.viewStudent') form_fields = grok.AutoFields(ICourseTicket) grok.template('courseticketpage') pnav = 4 @property def label(self): return _('${a}: Course Ticket ${b}', mapping = { 'a':self.context.student.display_fullname, 'b':self.context.code}) class CourseTicketManageFormPage(KofaEditFormPage): """ Page to manage course tickets """ grok.context(ICourseTicket) grok.name('manage') grok.require('waeup.manageStudent') form_fields = grok.AutoFields(ICourseTicket) form_fields['title'].for_display = True form_fields['fcode'].for_display = True form_fields['dcode'].for_display = True form_fields['semester'].for_display = True form_fields['passmark'].for_display = True form_fields['credits'].for_display = True form_fields['mandatory'].for_display = False form_fields['automatic'].for_display = True form_fields['carry_over'].for_display = True pnav = 4 grok.template('courseticketmanagepage') @property def label(self): return _('Manage course ticket ${a}', mapping = {'a':self.context.code}) @action('Save', style='primary') def save(self, **data): msave(self, **data) return class PaymentsManageFormPage(KofaEditFormPage): """ Page to manage the student payments This manage form page is for both students and students officers. """ grok.context(IStudentPaymentsContainer) grok.name('index') grok.require('waeup.payStudent') form_fields = grok.AutoFields(IStudentPaymentsContainer) grok.template('paymentsmanagepage') pnav = 4 def unremovable(self, ticket): usertype = getattr(self.request.principal, 'user_type', None) if not usertype: return False return (self.request.principal.user_type == 'student' and ticket.r_code) @property def label(self): return _('${a}: Payments', mapping = {'a':self.context.__parent__.display_fullname}) def update(self): super(PaymentsManageFormPage, self).update() datatable.need() warning.need() return @jsaction(_('Remove selected tickets')) def delPaymentTicket(self, **data): form = self.request.form if 'val_id' in form: child_id = form['val_id'] else: self.flash(_('No payment selected.')) self.redirect(self.url(self.context)) return if not isinstance(child_id, list): child_id = [child_id] deleted = [] for id in child_id: # Students are not allowed to remove used payment tickets if not self.unremovable(self.context[id]): del self.context[id] deleted.append(id) if len(deleted): self.flash(_('Successfully removed: ${a}', mapping = {'a': ', '.join(deleted)})) self.context.writeLogMessage( self,'removed: %s' % ', '.join(deleted)) self.redirect(self.url(self.context)) return #@action(_('Add online payment ticket')) #def addPaymentTicket(self, **data): # self.redirect(self.url(self.context, '@@addop')) class OnlinePaymentAddFormPage(KofaAddFormPage): """ Page to add an online payment ticket """ grok.context(IStudentPaymentsContainer) grok.name('addop') grok.template('onlinepaymentaddform') grok.require('waeup.payStudent') form_fields = grok.AutoFields(IStudentOnlinePayment).select( 'p_category') label = _('Add online payment') pnav = 4 @property def selectable_categories(self): categories = getUtility(IKofaUtils).SELECTABLE_PAYMENT_CATEGORIES return sorted(categories.items()) @action(_('Create ticket'), style='primary') def createTicket(self, **data): p_category = data['p_category'] previous_session = data.get('p_session', None) previous_level = data.get('p_level', None) student = self.context.__parent__ if p_category == 'bed_allocation' and student[ 'studycourse'].current_session != grok.getSite()[ 'hostels'].accommodation_session: self.flash( _('Your current session does not match ' + \ 'accommodation session.')) return if 'maintenance' in p_category: current_session = str(student['studycourse'].current_session) if not current_session in student['accommodation']: self.flash(_('You have not yet booked accommodation.')) return students_utils = getUtility(IStudentsUtils) error, payment = students_utils.setPaymentDetails( p_category, student, previous_session, previous_level) if error is not None: self.flash(error) return self.context[payment.p_id] = payment self.flash(_('Payment ticket created.')) self.redirect(self.url(self.context)) return @action(_('Cancel'), validator=NullValidator) def cancel(self, **data): self.redirect(self.url(self.context)) class PreviousPaymentAddFormPage(OnlinePaymentAddFormPage): """ Page to add an online payment ticket for previous sessions """ grok.context(IStudentPaymentsContainer) grok.name('addpp') grok.template('previouspaymentaddform') grok.require('waeup.payStudent') form_fields = grok.AutoFields(IStudentPreviousPayment).select( 'p_category', 'p_session', 'p_level') label = _('Add previous session online payment') pnav = 4 def update(self): if self.context.student.before_payment: self.flash(_("No previous payment to be made.")) self.redirect(self.url(self.context)) super(PreviousPaymentAddFormPage, self).update() return class OnlinePaymentDisplayFormPage(KofaDisplayFormPage): """ Page to view an online payment ticket """ grok.context(IStudentOnlinePayment) grok.name('index') grok.require('waeup.viewStudent') form_fields = grok.AutoFields(IStudentOnlinePayment) form_fields[ 'creation_date'].custom_widget = FriendlyDatetimeDisplayWidget('le') form_fields[ 'payment_date'].custom_widget = FriendlyDatetimeDisplayWidget('le') pnav = 4 @property def label(self): return _('${a}: Online Payment Ticket ${b}', mapping = { 'a':self.context.student.display_fullname, 'b':self.context.p_id}) class OnlinePaymentApprovePage(UtilityView, grok.View): """ Callback view """ grok.context(IStudentOnlinePayment) grok.name('approve') grok.require('waeup.managePortal') def update(self): success, msg, log = self.context.approveStudentPayment() if log is not None: # Add log message to students.log self.context.writeLogMessage(self,log) # Add log message to payments.log self.context.logger.info( '%s,%s,%s,%s,%s,,,,,,,,,,,,' % ( self.context.student.student_id, self.context.p_id, self.context.p_category, self.context.amount_auth, self.context.r_code)) self.flash(msg) return def render(self): self.redirect(self.url(self.context, '@@index')) return class OnlinePaymentFakeApprovePage(OnlinePaymentApprovePage): """ Approval view for students. This view is used for browser tests only and must be neutralized in custom pages! """ grok.name('fake_approve') grok.require('waeup.payStudent') class ExportPDFPaymentSlipPage(UtilityView, grok.View): """Deliver a PDF slip of the context. """ grok.context(IStudentOnlinePayment) grok.name('payment_slip.pdf') grok.require('waeup.viewStudent') form_fields = grok.AutoFields(IStudentOnlinePayment) form_fields['creation_date'].custom_widget = FriendlyDatetimeDisplayWidget('le') form_fields['payment_date'].custom_widget = FriendlyDatetimeDisplayWidget('le') prefix = 'form' note = None omit_fields = ( 'password', 'suspended', 'phone', 'adm_code', 'sex', 'suspended_comment') @property def title(self): portal_language = getUtility(IKofaUtils).PORTAL_LANGUAGE return translate(_('Payment Data'), 'waeup.kofa', target_language=portal_language) @property def label(self): portal_language = getUtility(IKofaUtils).PORTAL_LANGUAGE return translate(_('Online Payment Slip'), 'waeup.kofa', target_language=portal_language) \ + ' %s' % self.context.p_id def render(self): #if self.context.p_state != 'paid': # self.flash('Ticket not yet paid.') # self.redirect(self.url(self.context)) # return studentview = StudentBasePDFFormPage(self.context.student, self.request, self.omit_fields) students_utils = getUtility(IStudentsUtils) return students_utils.renderPDF(self, 'payment_slip.pdf', self.context.student, studentview, note=self.note) class AccommodationManageFormPage(KofaEditFormPage): """ Page to manage bed tickets. This manage form page is for both students and students officers. """ grok.context(IStudentAccommodation) grok.name('index') grok.require('waeup.handleAccommodation') form_fields = grok.AutoFields(IStudentAccommodation) grok.template('accommodationmanagepage') pnav = 4 officers_only_actions = [_('Remove selected')] @property def label(self): return _('${a}: Accommodation', mapping = {'a':self.context.__parent__.display_fullname}) def update(self): super(AccommodationManageFormPage, self).update() datatable.need() warning.need() return @jsaction(_('Remove selected')) def delBedTickets(self, **data): if getattr(self.request.principal, 'user_type', None) == 'student': self.flash(_('You are not allowed to remove bed tickets.')) self.redirect(self.url(self.context)) return form = self.request.form if 'val_id' in form: child_id = form['val_id'] else: self.flash(_('No bed ticket selected.')) self.redirect(self.url(self.context)) return if not isinstance(child_id, list): child_id = [child_id] deleted = [] for id in child_id: del self.context[id] deleted.append(id) if len(deleted): self.flash(_('Successfully removed: ${a}', mapping = {'a':', '.join(deleted)})) self.context.writeLogMessage( self,'removed: % s' % ', '.join(deleted)) self.redirect(self.url(self.context)) return @property def selected_actions(self): if getattr(self.request.principal, 'user_type', None) == 'student': return [action for action in self.actions if not action.label in self.officers_only_actions] return self.actions class BedTicketAddPage(KofaPage): """ Page to add an online payment ticket """ grok.context(IStudentAccommodation) grok.name('add') grok.require('waeup.handleAccommodation') grok.template('enterpin') ac_prefix = 'HOS' label = _('Add bed ticket') pnav = 4 buttonname = _('Create bed ticket') notice = '' with_ac = True def update(self, SUBMIT=None): student = self.context.student students_utils = getUtility(IStudentsUtils) acc_details = students_utils.getAccommodationDetails(student) if acc_details.get('expired', False): startdate = acc_details.get('startdate') enddate = acc_details.get('enddate') if startdate and enddate: tz = getUtility(IKofaUtils).tzinfo startdate = to_timezone( startdate, tz).strftime("%d/%m/%Y %H:%M:%S") enddate = to_timezone( enddate, tz).strftime("%d/%m/%Y %H:%M:%S") self.flash(_("Outside booking period: ${a} - ${b}", mapping = {'a': startdate, 'b': enddate})) else: self.flash(_("Outside booking period.")) self.redirect(self.url(self.context)) return if not acc_details: self.flash(_("Your data are incomplete.")) self.redirect(self.url(self.context)) return if not student.state in acc_details['allowed_states']: self.flash(_("You are in the wrong registration state.")) self.redirect(self.url(self.context)) return if student['studycourse'].current_session != acc_details[ 'booking_session']: self.flash( _('Your current session does not match accommodation session.')) self.redirect(self.url(self.context)) return if str(acc_details['booking_session']) in self.context.keys(): self.flash( _('You already booked a bed space in current ' \ + 'accommodation session.')) self.redirect(self.url(self.context)) return if self.with_ac: self.ac_series = self.request.form.get('ac_series', None) self.ac_number = self.request.form.get('ac_number', None) if SUBMIT is None: return if self.with_ac: pin = '%s-%s-%s' % (self.ac_prefix, self.ac_series, self.ac_number) code = get_access_code(pin) if not code: self.flash(_('Activation code is invalid.')) return # Search and book bed cat = queryUtility(ICatalog, name='beds_catalog', default=None) entries = cat.searchResults( owner=(student.student_id,student.student_id)) if len(entries): # If bed space has been manually allocated use this bed bed = [entry for entry in entries][0] # Safety belt for paranoids: Does this bed really exist on portal? # XXX: Can be remove if nobody complains. if bed.__parent__.__parent__ is None: self.flash(_('System error: Please contact the adminsitrator.')) self.context.writeLogMessage(self, 'fatal error: %s' % bed.bed_id) return else: # else search for other available beds entries = cat.searchResults( bed_type=(acc_details['bt'],acc_details['bt'])) available_beds = [ entry for entry in entries if entry.owner == NOT_OCCUPIED] if available_beds: students_utils = getUtility(IStudentsUtils) bed = students_utils.selectBed(available_beds) # Safety belt for paranoids: Does this bed really exist in portal? # XXX: Can be remove if nobody complains. if bed.__parent__.__parent__ is None: self.flash(_('System error: Please contact the adminsitrator.')) self.context.writeLogMessage(self, 'fatal error: %s' % bed.bed_id) return bed.bookBed(student.student_id) else: self.flash(_('There is no free bed in your category ${a}.', mapping = {'a':acc_details['bt']})) return if self.with_ac: # Mark pin as used (this also fires a pin related transition) if code.state == USED: self.flash(_('Activation code has already been used.')) return else: comment = _(u'invalidated') # Here we know that the ac is in state initialized so we do not # expect an exception, but the owner might be different if not invalidate_accesscode( pin,comment,self.context.student.student_id): self.flash(_('You are not the owner of this access code.')) return # Create bed ticket bedticket = createObject(u'waeup.BedTicket') if self.with_ac: bedticket.booking_code = pin bedticket.booking_session = acc_details['booking_session'] bedticket.bed_type = acc_details['bt'] bedticket.bed = bed hall_title = bed.__parent__.hostel_name coordinates = bed.coordinates[1:] block, room_nr, bed_nr = coordinates bc = _('${a}, Block ${b}, Room ${c}, Bed ${d} (${e})', mapping = { 'a':hall_title, 'b':block, 'c':room_nr, 'd':bed_nr, 'e':bed.bed_type}) portal_language = getUtility(IKofaUtils).PORTAL_LANGUAGE bedticket.bed_coordinates = translate( bc, 'waeup.kofa',target_language=portal_language) self.context.addBedTicket(bedticket) self.context.writeLogMessage(self, 'booked: %s' % bed.bed_id) self.flash(_('Bed ticket created and bed booked: ${a}', mapping = {'a':bedticket.bed_coordinates})) self.redirect(self.url(self.context)) return class BedTicketDisplayFormPage(KofaDisplayFormPage): """ Page to display bed tickets """ grok.context(IBedTicket) grok.name('index') grok.require('waeup.handleAccommodation') form_fields = grok.AutoFields(IBedTicket) form_fields['booking_date'].custom_widget = FriendlyDatetimeDisplayWidget('le') pnav = 4 @property def label(self): return _('Bed Ticket for Session ${a}', mapping = {'a':self.context.getSessionString()}) class ExportPDFBedTicketSlipPage(UtilityView, grok.View): """Deliver a PDF slip of the context. """ grok.context(IBedTicket) grok.name('bed_allocation_slip.pdf') grok.require('waeup.handleAccommodation') form_fields = grok.AutoFields(IBedTicket) form_fields['booking_date'].custom_widget = FriendlyDatetimeDisplayWidget('le') prefix = 'form' omit_fields = ( 'password', 'suspended', 'phone', 'adm_code', 'suspended_comment') @property def title(self): portal_language = getUtility(IKofaUtils).PORTAL_LANGUAGE return translate(_('Bed Allocation Data'), 'waeup.kofa', target_language=portal_language) @property def label(self): portal_language = getUtility(IKofaUtils).PORTAL_LANGUAGE #return translate(_('Bed Allocation: '), # 'waeup.kofa', target_language=portal_language) \ # + ' %s' % self.context.bed_coordinates return translate(_('Bed Allocation Slip'), 'waeup.kofa', target_language=portal_language) \ + ' %s' % self.context.getSessionString() def render(self): studentview = StudentBasePDFFormPage(self.context.student, self.request, self.omit_fields) students_utils = getUtility(IStudentsUtils) return students_utils.renderPDF( self, 'bed_allocation_slip.pdf', self.context.student, studentview) class BedTicketRelocationPage(UtilityView, grok.View): """ Callback view """ grok.context(IBedTicket) grok.name('relocate') grok.require('waeup.manageHostels') # Relocate student if student parameters have changed or the bed_type # of the bed has changed def update(self): student = self.context.student students_utils = getUtility(IStudentsUtils) acc_details = students_utils.getAccommodationDetails(student) if self.context.bed != None and \ 'reserved' in self.context.bed.bed_type: self.flash(_("Students in reserved beds can't be relocated.")) self.redirect(self.url(self.context)) return if acc_details['bt'] == self.context.bed_type and \ self.context.bed != None and \ self.context.bed.bed_type == self.context.bed_type: self.flash(_("Student can't be relocated.")) self.redirect(self.url(self.context)) return # Search a bed cat = queryUtility(ICatalog, name='beds_catalog', default=None) entries = cat.searchResults( owner=(student.student_id,student.student_id)) if len(entries) and self.context.bed == None: # If booking has been cancelled but other bed space has been # manually allocated after cancellation use this bed new_bed = [entry for entry in entries][0] else: # Search for other available beds entries = cat.searchResults( bed_type=(acc_details['bt'],acc_details['bt'])) available_beds = [ entry for entry in entries if entry.owner == NOT_OCCUPIED] if available_beds: students_utils = getUtility(IStudentsUtils) new_bed = students_utils.selectBed(available_beds) new_bed.bookBed(student.student_id) else: self.flash(_('There is no free bed in your category ${a}.', mapping = {'a':acc_details['bt']})) self.redirect(self.url(self.context)) return # Release old bed if exists if self.context.bed != None: self.context.bed.owner = NOT_OCCUPIED notify(grok.ObjectModifiedEvent(self.context.bed)) # Alocate new bed self.context.bed_type = acc_details['bt'] self.context.bed = new_bed hall_title = new_bed.__parent__.hostel_name coordinates = new_bed.coordinates[1:] block, room_nr, bed_nr = coordinates bc = _('${a}, Block ${b}, Room ${c}, Bed ${d} (${e})', mapping = { 'a':hall_title, 'b':block, 'c':room_nr, 'd':bed_nr, 'e':new_bed.bed_type}) portal_language = getUtility(IKofaUtils).PORTAL_LANGUAGE self.context.bed_coordinates = translate( bc, 'waeup.kofa',target_language=portal_language) self.context.writeLogMessage(self, 'relocated: %s' % new_bed.bed_id) self.flash(_('Student relocated: ${a}', mapping = {'a':self.context.bed_coordinates})) self.redirect(self.url(self.context)) return def render(self): return class StudentHistoryPage(KofaPage): """ Page to display student clearance data """ grok.context(IStudent) grok.name('history') grok.require('waeup.viewStudent') grok.template('studenthistory') pnav = 4 @property def label(self): return _('${a}: History', mapping = {'a':self.context.display_fullname}) # Pages for students only class StudentBaseEditFormPage(KofaEditFormPage): """ View to edit student base data """ grok.context(IStudent) grok.name('edit_base') grok.require('waeup.handleStudent') form_fields = grok.AutoFields(IStudentBase).select( 'email', 'phone') label = _('Edit base data') pnav = 4 @action(_('Save'), style='primary') def save(self, **data): msave(self, **data) return class StudentChangePasswordPage(KofaEditFormPage): """ View to manage student base data """ grok.context(IStudent) grok.name('change_password') grok.require('waeup.handleStudent') grok.template('change_password') label = _('Change password') pnav = 4 @action(_('Save'), style='primary') def save(self, **data): form = self.request.form password = form.get('change_password', None) password_ctl = form.get('change_password_repeat', None) if password: validator = getUtility(IPasswordValidator) errors = validator.validate_password(password, password_ctl) if not errors: IUserAccount(self.context).setPassword(password) self.context.writeLogMessage(self, 'saved: password') self.flash(_('Password changed.')) else: self.flash( ' '.join(errors)) return class StudentFilesUploadPage(KofaPage): """ View to upload files by student """ grok.context(IStudent) grok.name('change_portrait') grok.require('waeup.uploadStudentFile') grok.template('filesuploadpage') label = _('Upload portrait') pnav = 4 def update(self): if self.context.student.state != ADMITTED: emit_lock_message(self) return super(StudentFilesUploadPage, self).update() return class StartClearancePage(KofaPage): grok.context(IStudent) grok.name('start_clearance') grok.require('waeup.handleStudent') grok.template('enterpin') label = _('Start clearance') ac_prefix = 'CLR' notice = '' pnav = 4 buttonname = _('Start clearance now') @property def all_required_fields_filled(self): if self.context.email and self.context.phone: return True return False @property def portrait_uploaded(self): store = getUtility(IExtFileStore) if store.getFileByContext(self.context, attr=u'passport.jpg'): return True return False def update(self, SUBMIT=None): if not self.context.state == ADMITTED: self.flash(_("Wrong state")) self.redirect(self.url(self.context)) return if not self.portrait_uploaded: self.flash(_("No portrait uploaded.")) self.redirect(self.url(self.context, 'change_portrait')) return if not self.all_required_fields_filled: self.flash(_("Not all required fields filled.")) self.redirect(self.url(self.context, 'edit_base')) return self.ac_series = self.request.form.get('ac_series', None) self.ac_number = self.request.form.get('ac_number', None) if SUBMIT is None: return pin = '%s-%s-%s' % (self.ac_prefix, self.ac_series, self.ac_number) code = get_access_code(pin) if not code: self.flash(_('Activation code is invalid.')) return if code.state == USED: self.flash(_('Activation code has already been used.')) return # Mark pin as used (this also fires a pin related transition) # and fire transition start_clearance comment = _(u"invalidated") # Here we know that the ac is in state initialized so we do not # expect an exception, but the owner might be different if not invalidate_accesscode(pin, comment, self.context.student_id): self.flash(_('You are not the owner of this access code.')) return self.context.clr_code = pin IWorkflowInfo(self.context).fireTransition('start_clearance') self.flash(_('Clearance process has been started.')) self.redirect(self.url(self.context,'cedit')) return class StudentClearanceEditFormPage(StudentClearanceManageFormPage): """ View to edit student clearance data by student """ grok.context(IStudent) grok.name('cedit') grok.require('waeup.handleStudent') label = _('Edit clearance data') @property def form_fields(self): if self.context.is_postgrad: form_fields = grok.AutoFields(IPGStudentClearance).omit( 'clearance_locked', 'clr_code', 'officer_comment') else: form_fields = grok.AutoFields(IUGStudentClearance).omit( 'clearance_locked', 'clr_code', 'officer_comment') return form_fields def update(self): if self.context.clearance_locked: emit_lock_message(self) return return super(StudentClearanceEditFormPage, self).update() @action(_('Save'), style='primary') def save(self, **data): self.applyData(self.context, **data) self.flash(_('Clearance form has been saved.')) return def dataNotComplete(self): """To be implemented in the customization package. """ return False @action(_('Save and request clearance'), style='primary') def requestClearance(self, **data): self.applyData(self.context, **data) if self.dataNotComplete(): self.flash(self.dataNotComplete()) return self.flash(_('Clearance form has been saved.')) if self.context.clr_code: self.redirect(self.url(self.context, 'request_clearance')) else: # We bypass the request_clearance page if student # has been imported in state 'clearance started' and # no clr_code was entered before. state = IWorkflowState(self.context).getState() if state != CLEARANCE: # This shouldn't happen, but the application officer # might have forgotten to lock the form after changing the state self.flash(_('This form cannot be submitted. Wrong state!')) return IWorkflowInfo(self.context).fireTransition('request_clearance') self.flash(_('Clearance has been requested.')) self.redirect(self.url(self.context)) return class RequestClearancePage(KofaPage): grok.context(IStudent) grok.name('request_clearance') grok.require('waeup.handleStudent') grok.template('enterpin') label = _('Request clearance') notice = _('Enter the CLR access code used for starting clearance.') ac_prefix = 'CLR' pnav = 4 buttonname = _('Request clearance now') def update(self, SUBMIT=None): self.ac_series = self.request.form.get('ac_series', None) self.ac_number = self.request.form.get('ac_number', None) if SUBMIT is None: return pin = '%s-%s-%s' % (self.ac_prefix, self.ac_series, self.ac_number) if self.context.clr_code and self.context.clr_code != pin: self.flash(_("This isn't your CLR access code.")) return state = IWorkflowState(self.context).getState() if state != CLEARANCE: # This shouldn't happen, but the application officer # might have forgotten to lock the form after changing the state self.flash(_('This form cannot be submitted. Wrong state!')) return IWorkflowInfo(self.context).fireTransition('request_clearance') self.flash(_('Clearance has been requested.')) self.redirect(self.url(self.context)) return class StartSessionPage(KofaPage): grok.context(IStudentStudyCourse) grok.name('start_session') grok.require('waeup.handleStudent') grok.template('enterpin') label = _('Start session') ac_prefix = 'SFE' notice = '' pnav = 4 buttonname = _('Start now') def update(self, SUBMIT=None): if not self.context.is_current: emit_lock_message(self) return super(StartSessionPage, self).update() if not self.context.next_session_allowed: self.flash(_("You are not entitled to start session.")) self.redirect(self.url(self.context)) return self.ac_series = self.request.form.get('ac_series', None) self.ac_number = self.request.form.get('ac_number', None) if SUBMIT is None: return pin = '%s-%s-%s' % (self.ac_prefix, self.ac_series, self.ac_number) code = get_access_code(pin) if not code: self.flash(_('Activation code is invalid.')) return # Mark pin as used (this also fires a pin related transition) if code.state == USED: self.flash(_('Activation code has already been used.')) return else: comment = _(u"invalidated") # Here we know that the ac is in state initialized so we do not # expect an error, but the owner might be different if not invalidate_accesscode( pin,comment,self.context.student.student_id): self.flash(_('You are not the owner of this access code.')) return try: if self.context.student.state == CLEARED: IWorkflowInfo(self.context.student).fireTransition( 'pay_first_school_fee') elif self.context.student.state == RETURNING: IWorkflowInfo(self.context.student).fireTransition( 'pay_school_fee') elif self.context.student.state == PAID: IWorkflowInfo(self.context.student).fireTransition( 'pay_pg_fee') except ConstraintNotSatisfied: self.flash(_('An error occurred, please contact the system administrator.')) return self.flash(_('Session started.')) self.redirect(self.url(self.context)) return class AddStudyLevelFormPage(KofaEditFormPage): """ Page for students to add current study levels """ grok.context(IStudentStudyCourse) grok.name('add') grok.require('waeup.handleStudent') grok.template('studyleveladdpage') form_fields = grok.AutoFields(IStudentStudyCourse) pnav = 4 @property def label(self): studylevelsource = StudyLevelSource().factory code = self.context.current_level title = studylevelsource.getTitle(self.context, code) return _('Add current level ${a}', mapping = {'a':title}) def update(self): if not self.context.is_current: emit_lock_message(self) return if self.context.student.state != PAID: emit_lock_message(self) return super(AddStudyLevelFormPage, self).update() return @action(_('Create course list now'), style='primary') def addStudyLevel(self, **data): studylevel = createObject(u'waeup.StudentStudyLevel') studylevel.level = self.context.current_level studylevel.level_session = self.context.current_session try: self.context.addStudentStudyLevel( self.context.certificate,studylevel) except KeyError: self.flash(_('This level exists.')) except RequiredMissing: self.flash(_('Your data are incomplete')) self.redirect(self.url(self.context)) return class StudyLevelEditFormPage(KofaEditFormPage): """ Page to edit the student study level data by students """ grok.context(IStudentStudyLevel) grok.name('edit') grok.require('waeup.handleStudent') grok.template('studyleveleditpage') form_fields = grok.AutoFields(IStudentStudyLevel).omit( 'level_session', 'level_verdict') pnav = 4 max_credits = 50 def update(self): if not self.context.__parent__.is_current: emit_lock_message(self) return if self.context.student.state != PAID or \ not self.context.is_current_level: emit_lock_message(self) return super(StudyLevelEditFormPage, self).update() datatable.need() warning.need() return @property def label(self): # Here we know that the cookie has been set lang = self.request.cookies.get('kofa.language') level_title = translate(self.context.level_title, 'waeup.kofa', target_language=lang) return _('Edit course list of ${a}', mapping = {'a':level_title}) @property def translated_values(self): return translated_values(self) @action(_('Add course ticket')) def addCourseTicket(self, **data): self.redirect(self.url(self.context, 'ctadd')) def _delCourseTicket(self, **data): form = self.request.form if 'val_id' in form: child_id = form['val_id'] else: self.flash(_('No ticket selected.')) self.redirect(self.url(self.context, '@@edit')) return if not isinstance(child_id, list): child_id = [child_id] deleted = [] for id in child_id: # Students are not allowed to remove core tickets if id in self.context and \ self.context[id].removable_by_student: del self.context[id] deleted.append(id) if len(deleted): self.flash(_('Successfully removed: ${a}', mapping = {'a':', '.join(deleted)})) self.context.writeLogMessage( self,'removed: %s' % ', '.join(deleted)) self.redirect(self.url(self.context, u'@@edit')) return @jsaction(_('Remove selected tickets')) def delCourseTicket(self, **data): self._delCourseTicket(**data) return def _registerCourses(self, **data): if self.context.student.is_postgrad: self.flash(_( "You are a postgraduate student, " "your course list can't bee registered.")) self.redirect(self.url(self.context)) return if self.context.total_credits > self.max_credits: self.flash(_('Maximum credits of ${a} exceeded.', mapping = {'a':self.max_credits})) return IWorkflowInfo(self.context.student).fireTransition( 'register_courses') self.flash(_('Course list has been registered.')) self.redirect(self.url(self.context)) return @action(_('Register course list'), style='primary') def registerCourses(self, **data): self._registerCourses(**data) return class CourseTicketAddFormPage2(CourseTicketAddFormPage): """Add a course ticket by student. """ grok.name('ctadd') grok.require('waeup.handleStudent') form_fields = grok.AutoFields(ICourseTicketAdd) def update(self): if self.context.student.state != PAID or \ not self.context.is_current_level: emit_lock_message(self) return super(CourseTicketAddFormPage2, self).update() return @action(_('Add course ticket')) def addCourseTicket(self, **data): students_utils = getUtility(IStudentsUtils) # Safety belt if self.context.student.state != PAID: return ticket = createObject(u'waeup.CourseTicket') course = data['course'] ticket.automatic = False ticket.carry_over = False max_credits = students_utils.maxCreditsExceeded(self.context, course) if max_credits: self.flash(_( 'Your total credits exceed ${a}.', mapping = {'a': max_credits})) return try: self.context.addCourseTicket(ticket, course) except KeyError: self.flash(_('The ticket exists.')) return self.flash(_('Successfully added ${a}.', mapping = {'a':ticket.code})) self.redirect(self.url(self.context, u'@@edit')) return class SetPasswordPage(KofaPage): grok.context(IKofaObject) grok.name('setpassword') grok.require('waeup.Anonymous') grok.template('setpassword') label = _('Set password for first-time login') ac_prefix = 'PWD' pnav = 0 set_button = _('Set') def update(self, SUBMIT=None): self.reg_number = self.request.form.get('reg_number', None) self.ac_series = self.request.form.get('ac_series', None) self.ac_number = self.request.form.get('ac_number', None) if SUBMIT is None: return hitlist = search(query=self.reg_number, searchtype='reg_number', view=self) if not hitlist: self.flash(_('No student found.')) return if len(hitlist) != 1: # Cannot happen but anyway self.flash(_('More than one student found.')) return student = hitlist[0].context self.student_id = student.student_id student_pw = student.password pin = '%s-%s-%s' % (self.ac_prefix, self.ac_series, self.ac_number) code = get_access_code(pin) if not code: self.flash(_('Access code is invalid.')) return if student_pw and pin == student.adm_code: self.flash(_( 'Password has already been set. Your Student Id is ${a}', mapping = {'a':self.student_id})) return elif student_pw: self.flash( _('Password has already been set. You are using the ' + 'wrong Access Code.')) return # Mark pin as used (this also fires a pin related transition) # and set student password if code.state == USED: self.flash(_('Access code has already been used.')) return else: comment = _(u"invalidated") # Here we know that the ac is in state initialized so we do not # expect an exception invalidate_accesscode(pin,comment) IUserAccount(student).setPassword(self.ac_number) student.adm_code = pin self.flash(_('Password has been set. Your Student Id is ${a}', mapping = {'a':self.student_id})) return class StudentRequestPasswordPage(KofaAddFormPage): """Captcha'd registration page for applicants. """ grok.name('requestpw') grok.require('waeup.Anonymous') grok.template('requestpw') form_fields = grok.AutoFields(IStudentRequestPW).select( 'firstname','number','email') label = _('Request password for first-time login') def update(self): # Handle captcha self.captcha = getUtility(ICaptchaManager).getCaptcha() self.captcha_result = self.captcha.verify(self.request) self.captcha_code = self.captcha.display(self.captcha_result.error_code) return def _redirect(self, email, password, student_id): # Forward only email to landing page in base package. self.redirect(self.url(self.context, 'requestpw_complete', data = dict(email=email))) return def _pw_used(self): # XXX: False if password has not been used. We need an extra # attribute which remembers if student logged in. return True @action(_('Send login credentials to email address'), style='primary') def get_credentials(self, **data): if not self.captcha_result.is_valid: # Captcha will display error messages automatically. # No need to flash something. return number = data.get('number','') firstname = data.get('firstname','') cat = getUtility(ICatalog, name='students_catalog') results = list( cat.searchResults(reg_number=(number, number))) if not results: results = list( cat.searchResults(matric_number=(number, number))) if results: student = results[0] if getattr(student,'firstname',None) is None: self.flash(_('An error occurred.')) return elif student.firstname.lower() != firstname.lower(): # Don't tell the truth here. Anonymous must not # know that a record was found and only the firstname # verification failed. self.flash(_('No student record found.')) return elif student.password is not None and self._pw_used: self.flash(_('Your password has already been set and used. ' 'Please proceed to the login page.')) return # Store email address but nothing else. student.email = data['email'] notify(grok.ObjectModifiedEvent(student)) else: # No record found, this is the truth. self.flash(_('No student record found.')) return kofa_utils = getUtility(IKofaUtils) password = kofa_utils.genPassword() mandate = PasswordMandate() mandate.params['password'] = password mandate.params['user'] = student site = grok.getSite() site['mandates'].addMandate(mandate) # Send email with credentials args = {'mandate_id':mandate.mandate_id} mandate_url = self.url(site) + '/mandate?%s' % urlencode(args) url_info = u'Confirmation link: %s' % mandate_url msg = _('You have successfully requested a password for the') if kofa_utils.sendCredentials(IUserAccount(student), password, url_info, msg): email_sent = student.email else: email_sent = None self._redirect(email=email_sent, password=password, student_id=student.student_id) ob_class = self.__implemented__.__name__.replace('waeup.kofa.','') self.context.logger.info( '%s - %s (%s) - %s' % (ob_class, number, student.student_id, email_sent)) return class StudentRequestPasswordEmailSent(KofaPage): """Landing page after successful password request. """ grok.name('requestpw_complete') grok.require('waeup.Public') grok.template('requestpwmailsent') label = _('Your password request was successful.') def update(self, email=None, student_id=None, password=None): self.email = email self.password = password self.student_id = student_id return