source: main/waeup.sirp/trunk/src/waeup/sirp/applicants/browser.py @ 6017

Last change on this file since 6017 was 6015, checked in by uli, 14 years ago

Make form for applicants container manage page require datatables.
File size: 15.1 KB
Line 
1##
2## browser.py
3## Login : <uli@pu.smp.net>
4## Started on  Sun Jun 27 11:03:10 2010 Uli Fouquet
5## $Id$
6##
7## Copyright (C) 2010 Uli Fouquet
8## This program is free software; you can redistribute it and/or modify
9## it under the terms of the GNU General Public License as published by
10## the Free Software Foundation; either version 2 of the License, or
11## (at your option) any later version.
12##
13## This program is distributed in the hope that it will be useful,
14## but WITHOUT ANY WARRANTY; without even the implied warranty of
15## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16## GNU General Public License for more details.
17##
18## You should have received a copy of the GNU General Public License
19## along with this program; if not, write to the Free Software
20## Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
21##
22"""UI components for basic applicants and related components.
23"""
24import grok
25
26from datetime import datetime
27from hurry.jquery import jquery
28from hurry.jqueryui import jqueryui
29from zope.component import getUtility, getAllUtilitiesRegisteredFor
30from zope.formlib.widgets import FileWidget, DateWidget
31from zope.securitypolicy.interfaces import IPrincipalRoleManager
32from waeup.sirp.browser import (
33    WAeUPPage, WAeUPEditFormPage, WAeUPAddFormPage,
34    WAeUPDisplayFormPage, NullValidator)
35from waeup.sirp.browser.pages import LoginPage
36from waeup.sirp.interfaces import IWAeUPObject
37from waeup.sirp.browser.resources import datepicker, tabs, datatable
38from waeup.sirp.browser.viewlets import (
39    AddActionButton, ManageActionButton, PrimaryNavTab,
40    )
41from waeup.sirp.browser.breadcrumbs import Breadcrumb
42from waeup.sirp.applicants import get_applicant_data, ResultEntry, Applicant
43from waeup.sirp.applicants.interfaces import (
44    IApplicant, IApplicantPrincipal, IApplicantPDEEditData,
45    IApplicantsRoot, IApplicantsContainer, IApplicantsContainerProvider,
46    )
47from waeup.sirp.widgets.passportwidget import (
48    PassportWidget, PassportDisplayWidget
49    )
50#from zope.formlib.objectwidget import ObjectWidget
51from zope.formlib.sequencewidget import ListSequenceWidget, SequenceDisplayWidget
52from zope.formlib.widget import CustomWidgetFactory
53from waeup.sirp.utils.helpers import ReST2HTML
54from waeup.sirp.widgets.objectwidget import (
55    WAeUPObjectWidget, WAeUPObjectDisplayWidget)
56from waeup.sirp.widgets.multilistwidget import (
57    MultiListWidget, MultiListDisplayWidget)
58from waeup.sirp.image.browser.widget import (
59    ThumbnailWidget, EncodingImageFileWidget,
60    )
61
62results_widget = CustomWidgetFactory(
63    WAeUPObjectWidget, ResultEntry)
64
65results_display_widget = CustomWidgetFactory(
66    WAeUPObjectDisplayWidget, ResultEntry)
67
68#list_results_widget = CustomWidgetFactory(
69#    ListSequenceWidget, subwidget=results_widget)
70
71list_results_widget = CustomWidgetFactory(
72    MultiListWidget, subwidget=results_widget)
73
74list_results_display_widget = CustomWidgetFactory(
75    MultiListDisplayWidget, subwidget=results_display_widget)
76
77#: A date widget that renders with CSS class `datepicker` thus
78#  enabling : the jQuery datepicker for this field if the form loaded
79#  the jQuery code.
80FriendlyDateWidget = CustomWidgetFactory(
81    DateWidget, cssClass='datepicker')
82
83class ApplicationsPage(WAeUPPage):
84    grok.context(IApplicantsRoot)
85    grok.name('index')
86    title = 'Applicants'
87    pnav = 3
88
89    def update(self):
90        super(ApplicationsPage, self).update()
91        datatable.need()
92        return
93
94    def getApplications(self):
95        """Get a list of all stored applicant containers.
96        """
97        for key, val in self.context.items():
98            url = self.url(val)
99            yield(dict(url=url, name=key, container=val))
100
101class ManageApplicantsRootActionButton(ManageActionButton):
102    grok.context(IApplicantsRoot)
103    grok.view(ApplicationsPage)
104    text = 'Manage applicant containers'
105
106class ApplicantsRootEditPage(WAeUPPage):
107    grok.context(IApplicantsRoot)
108    grok.name('manage')
109    grok.template('applicantsrooteditpage')
110    title = 'Edit applicants containers'
111    pnav = 3
112
113    def update(self, entries=None, DELETE=None, CANCEL=None):
114        if CANCEL is not None:
115            self.redirect(self.url(self.context))
116            return
117        if DELETE is None:
118            return
119        if entries is None:
120            return
121        if not isinstance(entries, list):
122            entries = [entries]
123        for name in entries:
124            del self.context[name]
125            self.flash('Deleted "%s"' % name)
126        return
127
128    def getApplications(self):
129        """Get a list of all stored applicant containers.
130        """
131        for key, val in self.context.items():
132            url = self.url(val)
133            yield(dict(url=url, name=key))
134
135class AddApplicantsContainerActionButton(AddActionButton):
136    grok.context(IApplicantsRoot)
137    grok.view(ApplicantsRootEditPage)
138    text = 'Add applicants container'
139
140class AddApplicantsContainer(WAeUPPage):
141    grok.context(IApplicantsRoot)
142    grok.name('add')
143    grok.template('addcontainer')
144    title = 'Add applicants container'
145    pnav = 3
146
147    def update(self, providername=None, name=None, title=None,
148               description=None, ADD=None, CANCEL=None):
149        if CANCEL is not None:
150            self.redirect(self.url(self.context))
151            return
152        if ADD is None:
153            return
154        if not name:
155            self.flash('Error: you must give a name')
156            return
157        if name in self.context.keys():
158            self.flash('A container of the given name already exists')
159            return
160        # Add new applicants container...
161        provider = getUtility(IApplicantsContainerProvider,
162                              name=providername)
163        container = provider.factory()
164        if title:
165            container.title = title
166        if description:
167            container.description = description
168        self.context[name] = container
169        self.flash('Added "%s".' % name)
170        self.redirect(self.url(self.context))
171        return
172       
173    def getContainerProviders(self):
174        """Get a list of applicants container providers.
175
176        Applicants container providers are named utilities that help
177        to create applicants containers of different types
178        (JAMB-based, non-JAMB-based, etc.).
179
180        The list returned contains dicts::
181
182          {'name': <utility_name>,
183           'provider': <provider instance>}
184
185        where `utility_name` is the name under which the respective
186        provider utility is registered and `provider` is the real
187        provider instance.
188
189        The `utility_name` can be used to lookup the utility anew (for
190        instance after submitting a form) and the `provider` instance
191        can be used to create new instances of the respective
192        applicants container type.
193        """
194        providers = getAllUtilitiesRegisteredFor(IApplicantsContainerProvider)
195        result = [
196            {'name': getattr(x, 'grokcore.component.directive.name'),
197             'provider': x}
198             for x in providers
199            ]
200        return result
201
202class ApplicantsRootBreadcrumb(Breadcrumb):
203    """A breadcrumb for applicantsroot.
204    """
205    grok.context(IApplicantsRoot)
206    title = u'Applicants'
207   
208class ApplicantsContainerBreadcrumb(Breadcrumb):
209    """A breadcrumb for applicantscontainers.
210    """
211    grok.context(IApplicantsContainer)
212
213class ApplicantsTab(PrimaryNavTab):
214    """Faculties-tab in primary navigation.
215    """
216    grok.context(IWAeUPObject)
217    grok.order(3)
218    grok.require('waeup.View')
219    grok.template('primarynavtab')
220
221    pnav = 3
222    tab_title = u'Applicants'
223
224    @property
225    def link_target(self):
226        return self.view.application_url('applicants')
227
228class ApplicantsContainerPage(WAeUPPage):
229    """The standard view for regular applicant containers.
230    """
231    grok.context(IApplicantsContainer)
232    grok.name('index')
233    pnav = 3
234   
235    @property
236    def title(self):
237        return "Applicants Container: %s" % getattr(
238            self.context, '__name__', 'unnamed')
239
240    @property
241    def label(self):
242        return self.title
243
244    def descriptionToHTML(self):
245        return ReST2HTML(self.context.description)
246
247class ManageApplicantsContainerActionButton(ManageActionButton):
248    grok.context(IApplicantsContainer)
249    grok.view(ApplicantsContainerPage)
250    text = 'Manage'
251
252
253class ManageApplicantsContainer(WAeUPEditFormPage):
254    grok.context(IApplicantsContainer)
255    grok.name('manage')
256    grok.template('form_manage_applicants_container')
257    form_fields = grok.AutoFields(IApplicantsContainer)
258    # Use friendlier date widget...
259    form_fields['startdate'].custom_widget = FriendlyDateWidget
260    form_fields['enddate'].custom_widget = FriendlyDateWidget
261
262    @property
263    def title(self):
264        return "Manage applicants container: %s" % getattr(
265            self.context, '__name__', 'unnamed')
266   
267    @property
268    def label(self):
269        return self.title
270
271    pnav = 3
272
273    def update(self):
274        datepicker.need() # Enable jQuery datepicker in date fields.
275        tabs.need()
276        datatable.need()  # Enable jQurey datatables for contents listing
277        return super(ManageApplicantsContainer, self).update()
278
279    @grok.action('Save')
280    def apply(self, **data):
281        self.applyData(self.context, **data)
282        self.flash('Data saved.')
283        return
284       
285    @grok.action('Back')
286    def cancel(self, **data):
287        self.redirect(self.url(self.context))
288        return
289
290class LoginApplicant(WAeUPPage):
291    grok.context(IApplicantsContainer)
292    grok.name('login')
293    grok.require('zope.Public')
294
295    title = u'Login'
296   
297    @property
298    def label(self):
299        return self.title
300
301    pnav = 3
302    prefix = u'APP'
303   
304    def update(self, SUBMIT=None):
305        self.ac_series = self.request.form.get('form.ac_series', None)
306        self.ac_number = self.request.form.get('form.ac_number', None)
307        if SUBMIT is None:
308            return
309
310        if self.request.principal.id == 'zope.anybody':
311            self.flash('Entered credentials are invalid')
312            return
313
314        if not IApplicantPrincipal.providedBy(self.request.principal):
315            # Don't care if user is already authenticated as non-applicant
316            return
317
318        pin = self.request.principal.access_code
319        if pin not in self.context.keys():
320            # Create applicant record
321            applicant = Applicant()
322            applicant.access_code = pin
323            self.context[pin] = applicant
324           
325        # Assign current principal the owner role on created applicant
326        # record
327        role_manager = IPrincipalRoleManager(self.context)
328        role_manager.assignRoleToPrincipal(
329            'waeup.ApplicationOwner', self.request.principal.id)
330        self.redirect(self.url(self.context[pin], 'edit'))
331        return
332
333#class AddApplicant(WAeUPAddFormPage):
334#    grok.context(IApplicantsContainer)
335#    grok.name('add')
336#    form_fields = grok.AutoFields(IApplicant)
337#    form_fields['fst_sit_results'].custom_widget = list_results_widget
338#    form_fields['passport'].custom_widget = EncodingImageFileWidget
339#    label = 'Add Applicant'
340#    title = 'Add Applicant'
341#    pnav = 1
342#
343#    @grok.action('Add applicant')
344#    def addApplicant(self, **data):
345#        from waeup.sirp.jambtables.applicants import Applicant
346#        applicant = Applicant()
347#        self.applyData(applicant, **data)
348#        # XXX: temporarily disabled.
349#        #self.context[applicant.reg_no] = applicant
350#        try:
351#            self.context[applicant.access_code] = applicant
352#        except KeyError:
353#            self.flash('The given access code is already in use!')
354#            return
355#        self.redirect(self.url(self.context))
356
357class DisplayApplicant(WAeUPDisplayFormPage):
358    grok.context(IApplicant)
359    grok.name('index')
360    grok.require('waeup.viewApplication')
361    form_fields = grok.AutoFields(IApplicant).omit('locked')
362    form_fields['fst_sit_results'].custom_widget = list_results_display_widget
363    #form_fields['passport'].custom_widget = PassportDisplayWidget
364    form_fields['passport'].custom_widget = ThumbnailWidget
365    #form_fields['passport'].custom_widget = EncodingImageFileWidget
366    label = 'Applicant'
367    title = 'Applicant'
368    pnav = 3
369
370class EditApplicantStudent(WAeUPEditFormPage):
371    """An applicant-centered edit view for applicant data.
372    """
373    grok.context(IApplicant)
374    grok.name('edit')
375    grok.require('waeup.editApplication')
376    form_fields = grok.AutoFields(IApplicantPDEEditData).omit('locked')
377    #form_fields['passport'].custom_widget = FileWidget
378    #form_fields['passport'].custom_widget = PassportWidget
379    form_fields['passport'].custom_widget = EncodingImageFileWidget
380    grok.template('form_edit_pde')
381
382    def emitLockMessage(self):
383        self.flash('The requested form is locked (read-only)')
384        self.redirect(self.url(self.context))
385        return
386   
387    def update(self):
388        if self.context.locked:
389            self.emitLockMessage()
390            return
391        super(EditApplicantStudent, self).update()
392        return
393
394    def filteredWidgets(self):
395        for widget in self.widgets:
396            if widget.name == 'form.confirm_passport':
397                continue
398            yield widget
399
400    @property
401    def label(self):
402        # XXX: Use current/upcoming session
403        return 'Apply for Post UDE Screening Test (2009/2010)'
404    title = 'Edit Application'
405    pnav = 3
406
407    @grok.action('Save')
408    def save(self, **data):
409        if self.context.locked:
410            self.emitLockMessage()
411            return
412        self.applyData(self.context, **data)
413        self.context._p_changed = True
414        return
415
416    @grok.action('Final Submit')
417    def finalsubmit(self, **data):
418        if self.context.locked:
419            self.emitLockMessage()
420            return
421        self.applyData(self.context, **data)
422        self.context._p_changed = True
423        if not self.dataComplete():
424            self.flash('Data yet not complete.')
425            return
426        self.context.locked = True
427        return
428
429    def dataComplete(self):
430        if context.confirm_passport is not True:
431            return False
432        if len(self.errors) > 0:
433            return False
434        return True
435
436class EditApplicantFull(WAeUPEditFormPage):
437    """A full edit view for applicant data.
438
439    This one is meant to be used by officers only.
440    """
441    grok.context(IApplicant)
442    grok.name('edit_full')
443    grok.require('waeup.editFullApplication')
444    form_fields = grok.AutoFields(IApplicantPDEEditData).omit('locked')
445    form_fields['passport'].custom_widget = EncodingImageFileWidget
446    grok.template('form_edit_full')
447
448    def update(self):
449        if self.context.locked:
450            self.emitLockMessage()
451            return
452        super(EditApplicantFull, self).update()
453        return
454
455    def filteredWidgets(self):
456        for widget in self.widgets:
457            if widget.name == 'form.confirm_passport':
458                continue
459            yield widget
460
461    @property
462    def label(self):
463        return 'Application for %s' % self.context.access_code
464    title = 'Edit Application'
465    pnav = 3
466
467    @grok.action('Save')
468    def save(self, **data):
469        self.applyData(self.context, **data)
470        self.context._p_changed = True
471        return
Note: See TracBrowser for help on using the repository browser.