source: main/waeup.kofa/trunk/src/waeup/kofa/hostels/browser.py @ 13455

Last change on this file since 13455 was 13445, checked in by Henrik Bettermann, 9 years ago

Accommodation session must not be changed if hostels are not empty.
  • Property svn:keywords set to Id
File size: 13.9 KB
Line 
1## $Id: browser.py 13445 2015-11-12 09:03:47Z henrik $
2##
3## Copyright (C) 2011 Uli Fouquet & Henrik Bettermann
4## This program is free software; you can redistribute it and/or modify
5## it under the terms of the GNU General Public License as published by
6## the Free Software Foundation; either version 2 of the License, or
7## (at your option) any later version.
8##
9## This program is distributed in the hope that it will be useful,
10## but WITHOUT ANY WARRANTY; without even the implied warranty of
11## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12## GNU General Public License for more details.
13##
14## You should have received a copy of the GNU General Public License
15## along with this program; if not, write to the Free Software
16## Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17##
18"""UI components for hostels and related components.
19"""
20import grok
21import sys
22from zope.i18n import translate
23from zope.component import getUtility
24from zope.catalog.interfaces import ICatalog
25from waeup.kofa.browser.layout import (
26    KofaEditFormPage, KofaAddFormPage, KofaDisplayFormPage,
27    NullValidator, UtilityView)
28from waeup.kofa.browser.breadcrumbs import Breadcrumb
29from waeup.kofa.browser.layout import default_primary_nav_template
30from waeup.kofa.browser.pages import delSubobjects
31from waeup.kofa.browser.viewlets import (
32    ManageActionButton, PrimaryNavTab)
33from waeup.kofa.browser.layout import jsaction, action
34from waeup.kofa.interfaces import IKofaObject, IKofaUtils, DOCLINK
35from waeup.kofa.interfaces import MessageFactory as _
36from waeup.kofa.hostels.vocabularies import NOT_OCCUPIED
37from waeup.kofa.hostels.hostel import Hostel
38from waeup.kofa.hostels.interfaces import (
39    IHostelsContainer, IHostel, IBed)
40from waeup.kofa.widgets.datewidget import FriendlyDatetimeDisplayWidget
41
42# Save function used for save methods in manager pages
43def msave(view, **data):
44    changed_fields = view.applyData(view.context, **data)
45    # Turn list of lists into single list
46    if changed_fields:
47        changed_fields = reduce(lambda x,y: x+y, changed_fields.values())
48    fields_string = ' + '.join(changed_fields)
49    view.context._p_changed = True
50    view.flash(_('Form has been saved.'))
51    if fields_string:
52        view.context.writeLogMessage(view, 'saved: %s' % fields_string)
53    return
54
55class HostelsTab(PrimaryNavTab):
56    """Hostels tab in primary navigation.
57    """
58
59    grok.context(IKofaObject)
60    grok.order(5)
61    grok.require('waeup.viewHostels')
62    grok.name('hostelstab')
63    template = default_primary_nav_template
64    pnav = 5
65    tab_title = _(u'Hostels')
66
67    @property
68    def link_target(self):
69        return self.view.application_url('hostels')
70
71class HostelsBreadcrumb(Breadcrumb):
72    """A breadcrumb for the hostels container.
73    """
74    grok.context(IHostelsContainer)
75    title = _(u'Hostels')
76
77class HostelBreadcrumb(Breadcrumb):
78    """A breadcrumb for the hostel container.
79    """
80    grok.context(IHostel)
81
82    def title(self):
83        return self.context.hostel_name
84
85class BedBreadcrumb(Breadcrumb):
86    """A breadcrumb for the hostel container.
87    """
88    grok.context(IBed)
89
90    def title(self):
91        co = self.context.coordinates
92        return _('Block ${a}, Room ${b}, Bed ${c}',
93            mapping = {'a':co[1], 'b':co[2], 'c':co[3]})
94
95class HostelsContainerPage(KofaDisplayFormPage):
96    """The standard view for hostels containers.
97    """
98    grok.context(IHostelsContainer)
99    grok.name('index')
100    grok.require('waeup.viewHostels')
101    grok.template('containerpage')
102    label = _('Accommodation Section')
103    pnav = 5
104    form_fields = grok.AutoFields(IHostelsContainer)
105    form_fields[
106        'startdate'].custom_widget = FriendlyDatetimeDisplayWidget('le')
107    form_fields[
108        'enddate'].custom_widget = FriendlyDatetimeDisplayWidget('le')
109
110class HostelsContainerManageActionButton(ManageActionButton):
111    grok.order(1)
112    grok.context(IHostelsContainer)
113    grok.view(HostelsContainerPage)
114    grok.require('waeup.manageHostels')
115    text = _('Manage accommodation section')
116
117class HostelsContainerManagePage(KofaEditFormPage):
118    """The manage page for hostel containers.
119    """
120    grok.context(IHostelsContainer)
121    grok.name('manage')
122    grok.require('waeup.manageHostels')
123    grok.template('containermanagepage')
124    pnav = 5
125    label = _('Manage accommodation section')
126    form_fields = grok.AutoFields(IHostelsContainer)
127    taboneactions = [_('Save')]
128    tabtwoactions = [_('Add hostel'),
129        _('Clear all hostels'),
130        _('Remove selected')]
131    doclink = DOCLINK + '/hostels.html#accommodation-section'
132
133    # It's quite dangerous to remove entire hostels with its content (beds).
134    # Thus, this remove method should be combined with an archiving function.
135    @jsaction(_('Remove selected'))
136    def delHostels(self, **data):
137        form = self.request.form
138        if 'val_id' in form:
139            deleted = []
140            child_id = form['val_id']
141            if not isinstance(child_id, list):
142                child_id = [child_id]
143            for id in child_id:
144                deleted.append(id)
145            self.context.writeLogMessage(
146                self, 'deleted: % s' % ', '.join(deleted))
147        delSubobjects(self, redirect='@@manage', tab='2')
148        return
149
150    @action(_('Add hostel'), validator=NullValidator)
151    def addSubunit(self, **data):
152        self.redirect(self.url(self.context, 'addhostel'))
153        return
154
155    @jsaction(_('Clear all hostels'), style='danger')
156    def clearHostels(self, **data):
157        self.context.clearAllHostels()
158        self.flash(_('All hostels cleared.'))
159        self.context.writeLogMessage(self, 'all hostels cleared')
160        self.redirect(self.url(self.context, '@@manage')+'#tab2')
161        return
162
163    @action(_('Save'), style='primary')
164    def save(self, **data):
165        if data['accommodation_session'] != self.context.accommodation_session:
166            catalog = getUtility(ICatalog, name='beds_catalog')
167            beds = catalog.searchResults(bed_type=(None,None))
168            if len(beds):
169                self.flash(_('You can\'t change the booking session '
170                             'before clearing all hostels.'),
171                           type='warning')
172                return
173        self.applyData(self.context, **data)
174        self.flash(_('Settings have been saved.'))
175        return
176
177class ReleaseExpiredAllocationsPage(UtilityView, grok.View):
178    """Release all expired allocated beds.
179    """
180    grok.context(IHostelsContainer)
181    grok.name('releaseexpired')
182    grok.require('waeup.manageHostels')
183
184    def update(self, n=7):
185        released = self.context.releaseExpiredAllocations(n)
186        if len(released):
187            message = ', '.join(released)
188            self.context.writeLogMessage(self, 'released: %s' % message)
189            flash_msg = _('Successfully released beds: ${a}', mapping = {'a':message})
190        else:
191            flash_msg = _('No bed released.')
192        self.flash(flash_msg, type='success')
193        self.redirect(self.url(self.context))
194        return
195
196    def render(self):
197        return
198
199class HostelAddFormPage(KofaAddFormPage):
200    """Add-form to add a hostel.
201    """
202    grok.context(IHostelsContainer)
203    grok.require('waeup.manageHostels')
204    grok.name('addhostel')
205    #grok.template('hosteladdpage')
206    form_fields = grok.AutoFields(IHostel).omit('beds_reserved', 'hostel_id')
207    label = _('Add hostel')
208    pnav = 5
209    doclink = DOCLINK + '/hostels.html#accommodation-section'
210
211    @action(_('Create hostel'))
212    def addHostel(self, **data):
213        hostel = Hostel()
214        self.applyData(hostel, **data)
215        hostel.hostel_id = data['hostel_name'].lower().replace(
216            ' ','-').replace('_','-').replace('.','')
217        try:
218            self.context.addHostel(hostel)
219        except KeyError:
220            self.flash(_('The hostel already exists.'), type='warning')
221            return
222        self.flash(_('Hostel created.'))
223        self.context.writeLogMessage(self, 'added: % s' % data['hostel_name'])
224        self.redirect(self.url(self.context[hostel.hostel_id], 'index'))
225        return
226
227class HostelDisplayFormPage(KofaDisplayFormPage):
228    """ Page to display hostel data
229    """
230    grok.context(IHostel)
231    grok.name('index')
232    grok.require('waeup.viewHostels')
233    grok.template('hostelpage')
234    form_fields = grok.AutoFields(IHostel).omit('beds_reserved')
235    pnav = 5
236
237    @property
238    def label(self):
239        return self.context.hostel_name
240
241class HostelManageActionButton(ManageActionButton):
242    grok.order(1)
243    grok.context(IHostel)
244    grok.view(HostelDisplayFormPage)
245    grok.require('waeup.manageHostels')
246    text = _('Manage')
247    target = 'manage'
248
249class HostelManageFormPage(KofaEditFormPage):
250    """ View to edit hostel data
251    """
252    grok.context(IHostel)
253    grok.name('manage')
254    grok.require('waeup.manageHostels')
255    form_fields = grok.AutoFields(IHostel).omit('hostel_id', 'beds_reserved')
256    grok.template('hostelmanagepage')
257    label = _('Manage hostel')
258    pnav = 5
259    taboneactions = [_('Save')]
260    tabtwoactions = [_('Update all beds'),
261        _('Switch reservation of selected beds'),
262        _('Release selected beds'),
263        _('Clear hostel')]
264    not_occupied = NOT_OCCUPIED
265    doclink = DOCLINK + '/hostels.html#browser-pages'
266
267    @property
268    def students_url(self):
269        return self.url(grok.getSite(),'students')
270
271    @action(_('Save'), style='primary')
272    def save(self, **data):
273        msave(self, **data)
274        return
275
276    @action(_('Update all beds'), style='primary',
277            warning=_('Attention: The updater removes all reservation flags of existing beds.'
278                        ' You really want to update?'))
279    def updateBeds(self, **data):
280        removed, added, modified, modified_beds = self.context.updateBeds()
281        message = '%d empty beds removed, %d beds added, %d occupied beds modified (%s)' % (
282            removed, added, modified, modified_beds)
283        flash_message = _(
284            '${a} empty beds removed, ${b} beds added, '
285            + '${c} occupied beds modified (${d})',
286            mapping = {'a':removed, 'b':added, 'c':modified, 'd':modified_beds})
287        self.flash(flash_message)
288        self.context.writeLogMessage(self, message)
289        self.redirect(self.url(self.context, '@@manage')+'#tab2')
290        return
291
292    @action(_('Switch reservation of selected beds'))
293    def switchReservations(self, **data):
294        form = self.request.form
295        if 'val_id' in form:
296            child_id = form['val_id']
297        else:
298            self.flash(_('No item selected.'), type='warning')
299            self.redirect(self.url(self.context, '@@manage')+'#tab2')
300            return
301        if not isinstance(child_id, list):
302            child_id = [child_id]
303        switched = [] # for log file
304        switched_translated = [] # for flash message
305        # Here we know that the cookie has been set
306        preferred_language = self.request.cookies.get('kofa.language')
307        for bed_id in child_id:
308            message = self.context[bed_id].switchReservation()
309            switched.append('%s (%s)' % (bed_id,message))
310            m_translated = translate(message, 'waeup.kofa',
311                target_language=preferred_language)
312            switched_translated.append('%s (%s)' % (bed_id,m_translated))
313        if len(switched):
314            message = ', '.join(switched)
315            m_translated = ', '.join(switched_translated)
316            self.flash(_('Successfully switched beds: ${a}',
317                mapping = {'a':m_translated}))
318            self.context.writeLogMessage(self, 'switched: %s' % message)
319            self.redirect(self.url(self.context, '@@manage')+'#tab2')
320        return
321
322    @action(_('Release selected beds'))
323    def releaseBeds(self, **data):
324        form = self.request.form
325        if 'val_id' in form:
326            child_id = form['val_id']
327        else:
328            self.flash(_('No item selected.'), type='warning')
329            self.redirect(self.url(self.context, '@@manage')+'#tab2')
330            return
331        if not isinstance(child_id, list):
332            child_id = [child_id]
333        released = []
334        for bed_id in child_id:
335            message = self.context[bed_id].releaseBed()
336            if message:
337                released.append('%s (%s)' % (bed_id,message))
338        if len(released):
339            message = ', '.join(released)
340            self.flash(_('Successfully released beds: ${a}',
341                mapping = {'a':message}))
342            self.context.writeLogMessage(self, 'released: %s' % message)
343            self.redirect(self.url(self.context, '@@manage')+'#tab2')
344        else:
345            self.flash(_('No allocated bed selected.'), type='warning')
346            self.redirect(self.url(self.context, '@@manage')+'#tab2')
347        return
348
349    @jsaction(_('Clear hostel'), style='danger')
350    def clearHostel(self, **data):
351        self.context.clearHostel()
352        self.flash(_('Hostel cleared.'))
353        self.context.writeLogMessage(self, 'cleared')
354        self.redirect(self.url(self.context, '@@manage')+'#tab2')
355        return
356
357class BedManageFormPage(KofaEditFormPage):
358    """ View to edit bed data
359    """
360    grok.context(IBed)
361    grok.name('index')
362    grok.require('waeup.manageHostels')
363    form_fields = grok.AutoFields(IBed).omit(
364        'bed_id', 'bed_number', 'bed_type')
365    label = _('Allocate student')
366    pnav = 5
367    doclink = DOCLINK + '/hostels.html#manage-bed'
368
369    @action(_('Save'))
370    def save(self, **data):
371        if data['owner'] == NOT_OCCUPIED:
372            self.flash(_('No valid student id.'), type='warning')
373            self.redirect(self.url(self.context))
374            return
375        msave(self, **data)
376        self.redirect(self.url(self.context.__parent__, '@@manage')+'#tab2')
377        return
378
379    def update(self):
380        if self.context.owner != NOT_OCCUPIED:
381            # Don't use this form for exchanging students.
382            # Beds must be released first before they can be allocated to
383            # other students.
384            self.redirect(self.url(self.context.__parent__, '@@manage')+'#tab2')
385        return
Note: See TracBrowser for help on using the repository browser.