## $Id: viewlets.py 15422 2019-05-24 09:11:40Z 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 ## import grok from zope.component import getUtility from zope.i18n import translate from zope.interface import Interface from waeup.kofa.browser.layout import default_primary_nav_template from waeup.kofa.browser.viewlets import ( PrimaryNavTab, ManageActionButton, AddActionButton) from waeup.kofa.interfaces import MessageFactory as _ from waeup.kofa.interfaces import IExtFileStore, IKofaObject from waeup.kofa.students.browser import ( StudentsContainerPage, StudentsContainerManagePage, StudentBaseDisplayFormPage, StudentClearanceDisplayFormPage, StudentPersonalDisplayFormPage, StudyCourseDisplayFormPage, StudyLevelDisplayFormPage, CourseTicketDisplayFormPage, OnlinePaymentDisplayFormPage, BedTicketDisplayFormPage, StudentClearanceEditFormPage, StudentPersonalEditFormPage, PaymentsManageFormPage, StudyCourseTranscriptPage) from waeup.kofa.students.interfaces import ( IStudentsContainer, IStudent, IStudentStudyCourse, IStudentStudyLevel, ICourseTicket, IStudentOnlinePayment, IBedTicket, IStudentPaymentsContainer, IStudentsUtils, ) from waeup.kofa.students.workflow import ( ADMITTED, PAID, REQUESTED, CLEARED, REGISTERED, VALIDATED, GRADUATED, TRANSREQ, TRANSVAL, TRANSREL) grok.context(IKofaObject) # Make IKofaObject the default context grok.templatedir('browser_templates') class StudentManageSidebar(grok.ViewletManager): grok.name('left_studentmanage') class StudentManageLink(grok.Viewlet): """A link displayed in the student box which shows up for StudentNavigation objects. """ grok.baseclass() grok.viewletmanager(StudentManageSidebar) grok.context(IKofaObject) grok.view(Interface) grok.order(5) grok.require('waeup.viewStudent') link = 'index' text = _(u'Base Data') def render(self): url = self.view.url(self.context.student, self.link) # Here we know that the cookie has been set lang = self.request.cookies.get('kofa.language') text = translate( self.text, 'waeup.kofa', target_language=lang) if not self.link: return '' return u'
  • %s
  • ' % ( url, text) class StudentManageApplicationLink(StudentManageLink): grok.order(1) link = 'application_slip' text = _(u'Application Slip') def render(self): slip = getUtility(IExtFileStore).getFileByContext( self.context.student, attr=self.link) if slip: lang = self.request.cookies.get('kofa.language') text = translate( self.text, 'waeup.kofa', target_language=lang) url = self.view.url(self.context.student, self.link) return u'
  • %s
  • ' % ( url, text) return '' class StudentManageBaseLink(StudentManageLink): grok.order(2) link = 'index' text = _(u'Base Data') class StudentManageClearanceLink(StudentManageLink): grok.order(3) grok.name('studentmanageclearancelink') link = 'view_clearance' text = _(u'Clearance Data') class StudentManagePersonalLink(StudentManageLink): grok.order(4) grok.name('studentmanagepersonallink') link = 'view_personal' text = _(u'Personal Data') class StudentManageStudyCourseLink(StudentManageLink): grok.order(5) link = 'studycourse' text = _(u'Study Course') class StudentManagePaymentsLink(StudentManageLink): grok.order(6) grok.require('waeup.viewStudent') link = 'payments' text = _(u'Payments') class StudentManageAccommodationLink(StudentManageLink): grok.order(7) grok.name('studentmanageaccommodationlink') grok.require('waeup.handleAccommodation') link = 'accommodation' text = _(u'Accommodation') class StudentManageHistoryLink(StudentManageLink): grok.order(8) link = 'history' text = _(u'History') class StudentManageTranscriptLink(StudentManageLink): grok.order(9) link = 'final_transcript' text = _(u'Final Transcript') def render(self): slip = getUtility(IExtFileStore).getFileByContext( self.context.student, attr=self.link) if slip: lang = self.request.cookies.get('kofa.language') text = translate( self.text, 'waeup.kofa', target_language=lang) url = self.view.url(self.context.student, self.link) return u'
  • %s
  • ' % ( url, text) return '' class StudentsContainerManageActionButton(ManageActionButton): grok.order(1) grok.context(IStudentsContainer) grok.view(StudentsContainerPage) grok.require('waeup.manageStudent') text = _('Manage students section') class StudentsContainerAddActionButton(AddActionButton): grok.order(1) grok.context(IStudentsContainer) grok.view(StudentsContainerManagePage) grok.require('waeup.manageStudent') text = _('Add student') target = 'addstudent' class ContactActionButton(ManageActionButton): grok.order(5) grok.context(IStudent) grok.view(StudentBaseDisplayFormPage) grok.require('waeup.manageStudent') icon = 'actionicon_mail.png' text = _('Send email') target = 'contactstudent' class StudentBaseManageActionButton(ManageActionButton): grok.order(1) grok.context(IStudent) grok.view(StudentBaseDisplayFormPage) grok.require('waeup.manageStudent') text = _('Manage') target = 'manage_base' class StudentTrigTransActionButton(ManageActionButton): grok.order(2) grok.context(IStudent) grok.view(StudentBaseDisplayFormPage) grok.require('waeup.triggerTransition') icon = 'actionicon_trigtrans.png' text = _(u'Trigger transition') target = 'trigtrans' class StudentLoginAsActionButton(ManageActionButton): grok.order(3) grok.context(IStudent) grok.view(StudentBaseDisplayFormPage) grok.require('waeup.loginAsStudent') icon = 'actionicon_mask.png' text = _(u'Login as student') target = 'loginasstep1' class AdmissionSlipActionButton(ManageActionButton): grok.order(4) grok.context(IStudent) grok.view(StudentBaseDisplayFormPage) grok.require('waeup.viewStudent') icon = 'actionicon_pdf.png' text = _('Download admission letter') target = 'admission_slip.pdf' class StudentTransferButton(ManageActionButton): grok.order(6) grok.context(IStudent) grok.view(StudentBaseDisplayFormPage) grok.require('waeup.manageStudent') text = _('Transfer student') target = 'transfer' icon = 'actionicon_redo.png' class StudentDeactivateActionButton(ManageActionButton): grok.order(7) grok.context(IStudent) grok.view(StudentBaseDisplayFormPage) grok.require('waeup.manageStudent') text = _('Deactivate account') target = 'deactivate' icon = 'actionicon_traffic_lights_red.png' @property def target_url(self): if self.context.suspended: return '' return self.view.url(self.view.context, self.target) @property def onclick(self): return "return window.confirm(%s);" % _( "'A history message will be added. Are you sure?'") class StudentActivateActionButton(ManageActionButton): grok.order(7) grok.context(IStudent) grok.view(StudentBaseDisplayFormPage) grok.require('waeup.manageStudent') text = _('Activate account') target = 'activate' icon = 'actionicon_traffic_lights_green.png' @property def target_url(self): if not self.context.suspended: return '' return self.view.url(self.view.context, self.target) @property def onclick(self): return "return window.confirm(%s);" % _( "'A history message will be added. Are you sure?'") class StudentClearanceManageActionButton(ManageActionButton): grok.order(1) grok.context(IStudent) grok.view(StudentClearanceDisplayFormPage) grok.require('waeup.manageStudent') text = _('Manage') target = 'manage_clearance' class StudentClearActionButton(ManageActionButton): grok.order(2) grok.context(IStudent) grok.view(StudentClearanceDisplayFormPage) grok.require('waeup.clearStudent') text = _('Clear student') target = 'clear' icon = 'actionicon_accept.png' @property def target_url(self): cdm = getUtility( IStudentsUtils).clearance_disabled_message(self.context) if cdm: return '' if self.context.state != REQUESTED: return '' return self.view.url(self.view.context, self.target) class StudentRejectClearanceActionButton(ManageActionButton): grok.order(3) grok.context(IStudent) grok.view(StudentClearanceDisplayFormPage) grok.require('waeup.clearStudent') text = _('Reject clearance') target = 'reject_clearance' icon = 'actionicon_reject.png' @property def target_url(self): cdm = getUtility( IStudentsUtils).clearance_disabled_message(self.context) if cdm: return '' if self.context.state not in (REQUESTED, CLEARED): return '' return self.view.url(self.view.context, self.target) class ClearanceSlipActionButton(ManageActionButton): grok.order(4) grok.context(IStudent) grok.view(StudentClearanceDisplayFormPage) grok.require('waeup.viewStudent') icon = 'actionicon_pdf.png' text = _('Download clearance slip') target = 'clearance_slip.pdf' class ClearanceViewActionButton(ManageActionButton): grok.order(1) grok.context(IStudent) grok.view(StudentClearanceEditFormPage) grok.require('waeup.viewStudent') icon = 'actionicon_view.png' text = _('View') target = 'view_clearance' class PersonalViewActionButton(ManageActionButton): grok.order(1) grok.context(IStudent) grok.view(StudentPersonalEditFormPage) grok.require('waeup.viewStudent') icon = 'actionicon_view.png' text = _('View') target = 'view_personal' class StudentPersonalManageActionButton(ManageActionButton): grok.order(1) grok.context(IStudent) grok.view(StudentPersonalDisplayFormPage) grok.require('waeup.manageStudent') text = _('Manage') target = 'manage_personal' class StudentPersonalEditActionButton(ManageActionButton): grok.order(2) grok.context(IStudent) grok.view(StudentPersonalDisplayFormPage) grok.require('waeup.handleStudent') text = _('Edit') target = 'edit_personal' class StudyCourseManageActionButton(ManageActionButton): grok.order(1) grok.context(IStudentStudyCourse) grok.view(StudyCourseDisplayFormPage) grok.require('waeup.manageStudent') text = _('Manage') target = 'manage' @property def target_url(self): if self.context.is_current: return self.view.url(self.view.context, self.target) return False class RevertTransferActionButton(ManageActionButton): grok.order(1) grok.context(IStudentStudyCourse) grok.view(StudyCourseDisplayFormPage) grok.require('waeup.manageStudent') icon = 'actionicon_undo.png' text = _('Reactivate this study course (revert previous transfer)') target = 'revert_transfer' @property def target_url(self): if self.context.is_previous: return self.view.url(self.view.context.__parent__, self.target) return False class StudyLevelManageActionButton(ManageActionButton): grok.order(1) grok.context(IStudentStudyLevel) grok.view(StudyLevelDisplayFormPage) grok.require('waeup.manageStudent') text = _('Manage') target = 'manage' @property def target_url(self): is_current = self.context.__parent__.is_current if not is_current: return '' return self.view.url(self.view.context, self.target) class StudentValidateCoursesActionButton(ManageActionButton): grok.order(3) grok.context(IStudentStudyLevel) grok.view(StudyLevelDisplayFormPage) grok.require('waeup.validateStudent') text = _('Validate courses') target = 'validate_courses' icon = 'actionicon_accept.png' @property def target_url(self): if not self.context.__parent__.is_current: return '' if self.context.student.state != REGISTERED: return '' if str(self.context.__parent__.current_level) != self.context.__name__: return '' return self.view.url(self.view.context, self.target) class StudentRejectCoursesActionButton(ManageActionButton): grok.order(4) grok.context(IStudentStudyLevel) grok.view(StudyLevelDisplayFormPage) grok.require('waeup.validateStudent') text = _('Reject courses') target = 'reject_courses' icon = 'actionicon_reject.png' @property def target_url(self): if not self.context.__parent__.is_current: return '' if self.context.student.state not in (VALIDATED, REGISTERED): return '' if str(self.context.__parent__.current_level) != self.context.__name__: return '' return self.view.url(self.view.context, self.target) class StudentUnregisterCoursesActionButton(ManageActionButton): grok.order(5) grok.context(IStudentStudyLevel) grok.view(StudyLevelDisplayFormPage) grok.require('waeup.handleStudent') text = _('Unregister courses') target = 'unregister_courses' icon = 'actionicon_reject.png' @property def target_url(self): if not self.context.__parent__.is_current: return '' if self.context.student.state != REGISTERED: return '' if str(self.context.__parent__.current_level) != self.context.__name__: return '' return self.view.url(self.view.context, self.target) class CourseRegistrationSlipActionButton(ManageActionButton): grok.order(6) grok.context(IStudentStudyLevel) grok.view(StudyLevelDisplayFormPage) grok.require('waeup.viewStudent') icon = 'actionicon_pdf.png' text = _('Download course registration slip') target = 'course_registration_slip.pdf' @property def target_url(self): is_current = self.context.__parent__.is_current if not is_current: return '' return self.view.url(self.view.context, self.target) class CourseTicketManageActionButton(ManageActionButton): grok.order(1) grok.context(ICourseTicket) grok.view(CourseTicketDisplayFormPage) grok.require('waeup.manageStudent') text = _('Manage') target = 'manage' class PaymentReceiptActionButton(ManageActionButton): grok.order(9) # This button should always be the last one. grok.context(IStudentOnlinePayment) grok.view(OnlinePaymentDisplayFormPage) grok.require('waeup.viewStudent') icon = 'actionicon_pdf.png' text = _('Download payment slip') target = 'payment_slip.pdf' @property def target_url(self): #if self.context.p_state != 'paid': # return '' return self.view.url(self.view.context, self.target) class ApprovePaymentActionButton(ManageActionButton): grok.order(8) grok.context(IStudentOnlinePayment) grok.view(OnlinePaymentDisplayFormPage) grok.require('waeup.managePortal') icon = 'actionicon_accept.png' text = _('Approve payment') target = 'approve' @property def target_url(self): if self.context.p_state == 'paid': return '' return self.view.url(self.view.context, self.target) class BedTicketSlipActionButton(ManageActionButton): grok.order(1) grok.context(IBedTicket) grok.view(BedTicketDisplayFormPage) grok.require('waeup.handleAccommodation') icon = 'actionicon_pdf.png' text = _('Download bed allocation slip') target = 'bed_allocation_slip.pdf' class RelocateStudentActionButton(ManageActionButton): grok.order(2) grok.context(IBedTicket) grok.view(BedTicketDisplayFormPage) grok.require('waeup.manageHostels') icon = 'actionicon_reload.png' text = _('Relocate student') target = 'relocate' class StudentBaseActionButton(ManageActionButton): grok.order(1) grok.context(IStudent) grok.view(StudentBaseDisplayFormPage) grok.require('waeup.handleStudent') text = _('Edit') target = 'edit_base' class StudentPasswordActionButton(ManageActionButton): grok.order(2) grok.context(IStudent) grok.view(StudentBaseDisplayFormPage) grok.require('waeup.handleStudent') icon = 'actionicon_key.png' text = _('Change password') target = 'change_password' class StudentPassportActionButton(ManageActionButton): grok.order(3) grok.context(IStudent) grok.view(StudentBaseDisplayFormPage) grok.require('waeup.handleStudent') icon = 'actionicon_portrait.png' text = _('Change portrait') target = 'change_portrait' @property def target_url(self): PORTRAIT_CHANGE_STATES = getUtility( IStudentsUtils).PORTRAIT_CHANGE_STATES if self.context.state not in PORTRAIT_CHANGE_STATES: return '' return self.view.url(self.view.context, self.target) class StudentClearanceStartActionButton(ManageActionButton): grok.order(1) grok.context(IStudent) grok.view(StudentClearanceDisplayFormPage) grok.require('waeup.handleStudent') icon = 'actionicon_start.gif' text = _('Start clearance') target = 'start_clearance' @property def target_url(self): if self.context.state != ADMITTED: return '' return self.view.url(self.view.context, self.target) class StudentClearanceEditActionButton(ManageActionButton): grok.order(1) grok.context(IStudent) grok.view(StudentClearanceDisplayFormPage) grok.require('waeup.handleStudent') text = _('Edit') target = 'cedit' @property def target_url(self): if self.context.clearance_locked: return '' return self.view.url(self.view.context, self.target) class StartSessionActionButton(ManageActionButton): grok.order(1) grok.context(IStudentStudyCourse) grok.view(StudyCourseDisplayFormPage) grok.require('waeup.handleStudent') icon = 'actionicon_start.gif' text = _('Start new session') target = 'start_session' @property def target_url(self): if self.context.next_session_allowed and self.context.is_current: return self.view.url(self.view.context, self.target) return False class AddStudyLevelActionButton(AddActionButton): grok.order(1) grok.context(IStudentStudyCourse) grok.view(StudyCourseDisplayFormPage) grok.require('waeup.handleStudent') text = _('Add course list') target = 'add' @property def target_url(self): student = self.view.context.student condition1 = student.state != PAID condition2 = str(student['studycourse'].current_level) in \ self.view.context.keys() condition3 = not self.context.is_current if condition1 or condition2 or condition3: return '' return self.view.url(self.view.context, self.target) class StudyLevelEditActionButton(ManageActionButton): grok.order(2) grok.context(IStudentStudyLevel) grok.view(StudyLevelDisplayFormPage) grok.require('waeup.editStudyLevel') text = _('Edit course list') target = 'edit' @property def target_url(self): student = self.view.context.student condition1 = student.state == PAID condition2 = self.view.context.is_current_level is_current = self.context.__parent__.is_current if condition1 and condition2 and is_current: return self.view.url(self.view.context, self.target) return '' class AddPaymentActionButton(AddActionButton): grok.order(1) grok.context(IStudentPaymentsContainer) grok.view(PaymentsManageFormPage) grok.require('waeup.payStudent') text = _('Add current session payment ticket') target = 'addop' class AddPreviousPaymentActionButton(AddActionButton): grok.order(2) grok.context(IStudentPaymentsContainer) grok.view(PaymentsManageFormPage) grok.require('waeup.payStudent') grok.name('addpreviouspaymentactionbutton') text = _('Add previous session payment ticket') target = 'addpp' @property def target_url(self): student = self.view.context.student if student.before_payment or not self.target: return '' return self.view.url(self.view.context, self.target) class AddBalancePaymentActionButton(AddActionButton): grok.order(3) grok.context(IStudentPaymentsContainer) grok.view(PaymentsManageFormPage) grok.require('waeup.manageStudent') grok.name('addbalancepaymentactionbutton') text = _('Add balance payment ticket') target = 'addbp' @property def target_url(self): if not self.target: return '' return self.view.url(self.view.context, self.target) class StudyCourseTranscriptActionButton(ManageActionButton): grok.order(2) grok.name('transcript') grok.context(IStudentStudyCourse) grok.view(StudyCourseDisplayFormPage) grok.require('waeup.viewTranscript') text = _('Transcript') target = 'transcript' icon = 'actionicon_transcript.png' @property def target_url(self): final_slip = getUtility(IExtFileStore).getFileByContext( self.context.student, attr='final_transcript') if self.context.student.transcript_enabled and not final_slip: return self.view.url(self.view.context, self.target) return False class RequestTranscriptActionButton(ManageActionButton): grok.order(8) grok.context(IStudent) grok.view(StudentBaseDisplayFormPage) grok.require('waeup.handleStudent') text = _('Request transcript') target = 'request_transcript' icon = 'actionicon_transcript.png' @property def target_url(self): if self.context.state != GRADUATED: return '' return self.view.url(self.view.context, self.target) class ValidateTranscriptActionButton(ManageActionButton): grok.order(8) grok.context(IStudentStudyCourse) grok.view(StudyCourseTranscriptPage) grok.require('waeup.processTranscript') text = _('Validate transcript') target = 'validate_transcript' icon = 'actionicon_transcript.png' @property def target_url(self): if self.context.student.state != TRANSREQ: return '' return self.view.url(self.view.context, self.target) class ReleaseTranscriptActionButton(ManageActionButton): grok.order(8) grok.context(IStudentStudyCourse) grok.view(StudyCourseTranscriptPage) grok.require('waeup.processTranscript') text = _('Release transcript') target = 'release_transcript' icon = 'actionicon_transcript.png' @property def target_url(self): if self.context.student.state != TRANSVAL: return '' return self.view.url(self.view.context, self.target) class TranscriptSlipActionButton(ManageActionButton): grok.order(1) grok.name('transcript_slip') grok.context(IStudentStudyCourse) grok.view(StudyCourseTranscriptPage) grok.require('waeup.viewTranscript') text = _('Academic Transcript') target = 'transcript.pdf' icon = 'actionicon_pdf.png' @property def target_url(self): final_slip = getUtility(IExtFileStore).getFileByContext( self.context.student, attr='final_transcript') if self.context.student.transcript_enabled \ and not final_slip: return self.view.url(self.view.context, self.target) return False class SignTranscriptActionButton(ManageActionButton): grok.order(2) grok.context(IStudentStudyCourse) grok.view(StudyCourseTranscriptPage) grok.require('waeup.signTranscript') text = _('Sign transcript electronically') target = 'sign_transcript' icon = 'actionicon_transcript.png' @property def target_url(self): if self.context.student.state != TRANSVAL: return '' return self.view.url(self.view.context, self.target) @property def onclick(self): return "return window.confirm(%s);" % _( "'Signing a transcript electronically cannot be revoked. " "The electronic signature replaces your handwritten signature.\\n\\n" "You really want to sign the transcript?'") class StudentsTab(PrimaryNavTab): """Students tab in primary navigation. """ grok.context(IKofaObject) grok.order(4) grok.require('waeup.viewStudentsContainer') grok.name('studentstab') pnav = 4 tab_title = _(u'Students') @property def link_target(self): return self.view.application_url('students') class PrimaryStudentNavManager(grok.ViewletManager): """Viewlet manager for the primary navigation tab. """ grok.name('primary_nav_student') class PrimaryStudentNavTab(grok.Viewlet): """Base for primary student nav tabs. """ grok.baseclass() grok.context(IKofaObject) grok.viewletmanager(PrimaryStudentNavManager) template = default_primary_nav_template grok.order(1) grok.require('waeup.Authenticated') pnav = 0 tab_title = u'Some Text' @property def link_target(self): return self.view.application_url() @property def active(self): view_pnav = getattr(self.view, 'pnav', 0) if view_pnav == self.pnav: return 'active' return '' class MyStudentDataTab(PrimaryStudentNavTab): """MyData dropdown tab in primary navigation. """ grok.order(3) grok.require('waeup.viewMyStudentDataTab') grok.template('mydatadropdowntabs') grok.name('mystudentdatatab') pnav = 4 tab_title = _(u'My Data') @property def active(self): view_pnav = getattr(self.view, 'pnav', 0) if view_pnav == self.pnav: return 'active dropdown' return 'dropdown' @property def targets(self): student = grok.getSite()['students'][self.request.principal.id] student_url = self.view.url(student) app_slip = getUtility(IExtFileStore).getFileByContext( student, 'application_slip') targets = [] if app_slip: targets = [{'url': student_url + '/application_slip', 'title': _('Application Slip')}, ] targets += [ {'url': student_url, 'title': 'Base Data'}, {'url': student_url + '/view_clearance', 'title': _('Clearance Data')}, {'url': student_url + '/view_personal', 'title': _('Personal Data')}, {'url': student_url + '/studycourse', 'title': _('Study Course')}, {'url': student_url + '/payments', 'title': _('Payments')}, {'url': student_url + '/accommodation', 'title': _('Accommodation Data')}, {'url': student_url + '/history', 'title': _('History')}, ] return targets