source: main/waeup.aaue/trunk/src/waeup/aaue/students/utils.py @ 13459

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

Customize _isPaymentDisabled.
  • Property svn:keywords set to Id
File size: 12.3 KB
Line 
1## $Id: utils.py 13454 2015-11-13 13:56:02Z 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##
18import grok
19from time import time
20from zope.component import createObject
21from waeup.kofa.interfaces import (
22    ADMITTED, CLEARED, RETURNING, PAID, academic_sessions_vocab)
23from kofacustom.nigeria.students.utils import NigeriaStudentsUtils
24from waeup.kofa.accesscodes import create_accesscode
25from waeup.kofa.students.utils import trans
26from waeup.aaue.interswitch.browser import gateway_net_amt
27from waeup.aaue.interfaces import MessageFactory as _
28
29class CustomStudentsUtils(NigeriaStudentsUtils):
30    """A collection of customized methods.
31
32    """
33
34    PORTRAIT_CHANGE_STATES = (ADMITTED, RETURNING)
35
36    gpa_boundaries = ((1, 'FRNS'),
37                      (1.5, 'Pass'),
38                      (2.4, '3rd Class Honours'),
39                      (3.5, '2nd Class Honours Lower Division'),
40                      (4.5, '2nd Class Honours Upper Division'),
41                      (5, '1st Class Honours'))
42
43    def increaseMatricInteger(self, student):
44        """Increase counter for matric numbers.
45        This counter can be a centrally stored attribute or an attribute of
46        faculties, departments or certificates. In the base package the counter
47        is as an attribute of the site configuration container.
48        """
49        if student.current_mode in ('ug_pt', 'de_pt'):
50            grok.getSite()['configuration'].next_matric_integer += 1
51            return
52        grok.getSite()['configuration'].next_matric_integer_2 += 1
53        return
54
55    def constructMatricNumber(self, student):
56        faccode = student.faccode
57        depcode = student.depcode
58        year = unicode(student.entry_session)[2:]
59        if not student.state in (PAID, ) or not student.is_fresh or \
60            student.current_mode == 'found':
61            return _('Matriculation number cannot be set.'), None
62        if student.current_mode in ('ug_pt', 'de_pt'):
63            next_integer = grok.getSite()['configuration'].next_matric_integer
64            if next_integer == 0:
65                return _('Matriculation number cannot be set.'), None
66            return None, "PTP/%s/%s/%s/%05d" % (
67                faccode, depcode, year, next_integer)
68        next_integer = grok.getSite()['configuration'].next_matric_integer_2
69        if next_integer == 0:
70            return _('Matriculation number cannot be set.'), None
71        if student.faccode in ('FBM', 'FCS'):
72            return None, "CMS/%s/%s/%s/%05d" % (
73                faccode, depcode, year, next_integer)
74        return None, "%s/%s/%s/%05d" % (faccode, depcode, year, next_integer)
75
76    def getReturningData(self, student):
77        """ This method defines what happens after school fee payment
78        of returning students depending on the student's senate verdict.
79        """
80        prev_level = student['studycourse'].current_level
81        cur_verdict = student['studycourse'].current_verdict
82        if cur_verdict in ('A','B','L','M','N','Z',):
83            # Successful student
84            new_level = divmod(int(prev_level),100)[0]*100 + 100
85        elif cur_verdict == 'C':
86            # Student on probation
87            new_level = int(prev_level) + 10
88        else:
89            # Student is somehow in an undefined state.
90            # Level has to be set manually.
91            new_level = prev_level
92        new_session = student['studycourse'].current_session + 1
93        return new_session, new_level
94
95    def _isPaymentDisabled(self, p_session, category, student):
96        academic_session = self._getSessionConfiguration(p_session)
97        if category == 'schoolfee' and \
98            'sf_all' in academic_session.payment_disabled:
99            return True
100        if category == 'hostel_maintenance' and \
101            'maint_all' in academic_session.payment_disabled:
102            return True
103        return False
104
105    def setPaymentDetails(self, category, student,
106            previous_session=None, previous_level=None):
107        """Create Payment object and set the payment data of a student for
108        the payment category specified.
109
110        """
111        details = {}
112        p_item = u''
113        amount = 0.0
114        error = u''
115        if previous_session:
116            return _('Previous session payment not yet implemented.'), None
117        p_session = student['studycourse'].current_session
118        p_level = student['studycourse'].current_level
119        p_current = True
120        academic_session = self._getSessionConfiguration(p_session)
121        if academic_session == None:
122            return _(u'Session configuration object is not available.'), None
123        # Determine fee.
124        if category == 'transfer':
125            amount = academic_session.transfer_fee
126        elif category == 'transcript':
127            amount = academic_session.transcript_fee
128        elif category == 'bed_allocation':
129            amount = academic_session.booking_fee
130        elif category == 'hostel_maintenance':
131            amount = 0.0
132            bedticket = student['accommodation'].get(
133                str(student.current_session), None)
134            if bedticket:
135                p_item = bedticket.bed_coordinates
136                if bedticket.bed.__parent__.maint_fee > 0:
137                    amount = bedticket.bed.__parent__.maint_fee
138                else:
139                    # fallback
140                    amount = academic_session.maint_fee
141            else:
142                # Should not happen because this is already checked
143                # in the browser module, but anyway ...
144                portal_language = getUtility(IKofaUtils).PORTAL_LANGUAGE
145                p_item = trans(_('no bed allocated'), portal_language)
146        elif category == 'welfare':
147            amount = academic_session.welfare_fee
148        elif category == 'union':
149            amount = academic_session.union_fee
150        elif category == 'lapel':
151            amount = academic_session.lapel_fee
152        elif category == 'matric_gown':
153            amount = academic_session.matric_gown_fee
154        elif category == 'concessional':
155            amount = academic_session.concession_fee
156        elif category.startswith('clearance'):
157            if student.faccode == 'FP':
158                amount = academic_session.clearance_fee_fp
159            elif student.current_mode.endswith('_pt'):
160                amount = academic_session.clearance_fee_pt
161            elif student.faccode in ('FBM', 'FCS'):
162                amount = academic_session.clearance_fee_med
163            else:
164                amount = academic_session.clearance_fee
165            p_item = student['studycourse'].certificate.code
166            # Add Matric Gown Fee and Lapel Fee
167            if category.endswith('_incl'):
168                if amount is None:
169                    # Otherwise we can't add somtehing
170                    amount = 0.0
171                amount += gateway_net_amt(academic_session.matric_gown_fee) + \
172                    gateway_net_amt(academic_session.lapel_fee)
173        elif category == 'late_registration':
174            amount = academic_session.late_registration_fee
175        elif category.startswith('schoolfee'):
176            try:
177                certificate = student['studycourse'].certificate
178                p_item = certificate.code
179            except (AttributeError, TypeError):
180                return _('Study course data are incomplete.'), None
181            if student.state == CLEARED:
182                if student.is_foreigner:
183                    amount = getattr(certificate, 'school_fee_3', 0.0)
184                else:
185                    amount = getattr(certificate, 'school_fee_1', 0.0)
186            elif student.state == RETURNING:
187                # In case of returning school fee payment the payment session
188                # and level contain the values of the session the student
189                # has paid for.
190                p_session, p_level = self.getReturningData(student)
191                try:
192                    academic_session = grok.getSite()[
193                        'configuration'][str(p_session)]
194                except KeyError:
195                    return _(u'Session configuration object is not available.'), None
196                if student.is_foreigner:
197                    amount = getattr(certificate, 'school_fee_4', 0.0)
198                else:
199                    amount = getattr(certificate, 'school_fee_2', 0.0)
200            else:
201                return _('Wrong state.'), None
202            if amount in (0.0, None):
203                return _(u'Amount could not be determined.'), None
204            # Add Student Union Fee and Welfare Assurance
205            if category == 'schoolfee_incl':
206                amount += gateway_net_amt(academic_session.welfare_fee) + \
207                    gateway_net_amt(academic_session.union_fee)
208        if amount in (0.0, None):
209            return _(u'Amount could not be determined.'), None
210        # Add session specific penalty fee.
211        if category.startswith('schoolfee') and student.is_postgrad:
212            amount += academic_session.penalty_pg
213        elif category.startswith('schoolfee'):
214            amount += academic_session.penalty_ug
215        # Create ticket.
216        for key in student['payments'].keys():
217            ticket = student['payments'][key]
218            if ticket.p_state == 'paid' and\
219               ticket.p_category == category and \
220               ticket.p_item == p_item and \
221               ticket.p_session == p_session:
222                  return _('This type of payment has already been made.'), None
223        if self._isPaymentDisabled(p_session, category, student):
224            return _('Payment temporarily disabled.'), None
225        payment = createObject(u'waeup.StudentOnlinePayment')
226        timestamp = ("%d" % int(time()*10000))[1:]
227        payment.p_id = "p%s" % timestamp
228        payment.p_category = category
229        payment.p_item = p_item
230        payment.p_session = p_session
231        payment.p_level = p_level
232        payment.p_current = p_current
233        payment.amount_auth = amount
234        return None, payment
235
236    def _admissionText(self, student, portal_language):
237        inst_name = grok.getSite()['configuration'].name
238        entry_session = student['studycourse'].entry_session
239        entry_session = academic_sessions_vocab.getTerm(entry_session).title
240        text = trans(_(
241            'This is to inform you that you have been offered provisional'
242            ' admission into ${a} for the ${b} academic session as follows:',
243            mapping = {'a': inst_name, 'b': entry_session}),
244            portal_language)
245        return text
246
247    def maxCredits(self, studylevel):
248        """Return maximum credits.
249
250        """
251        return 48
252
253    def getBedCoordinates(self, bedticket):
254        """Return descriptive bed coordinates.
255        This method can be used to customize the `display_coordinates`
256        property method in order to  display a
257        customary description of the bed space.
258        """
259        bc = bedticket.bed_coordinates.split(',')
260        if len(bc) == 4:
261            return bc[0]
262        return bedticket.bed_coordinates
263
264    def getAccommodationDetails(self, student):
265        """Determine the accommodation data of a student.
266        """
267        d = {}
268        d['error'] = u''
269        hostels = grok.getSite()['hostels']
270        d['booking_session'] = hostels.accommodation_session
271        d['allowed_states'] = hostels.accommodation_states
272        d['startdate'] = hostels.startdate
273        d['enddate'] = hostels.enddate
274        d['expired'] = hostels.expired
275        # Determine bed type
276        bt = 'all'
277        if student.sex == 'f':
278            sex = 'female'
279        else:
280            sex = 'male'
281        special_handling = 'regular'
282        d['bt'] = u'%s_%s_%s' % (special_handling,sex,bt)
283        return d
284
285    # AAUE prefix
286    STUDENT_ID_PREFIX = u'E'
Note: See TracBrowser for help on using the repository browser.