source: main/kofacustom.edopoly/trunk/src/kofacustom/edopoly/students/utils.py @ 15344

Last change on this file since 15344 was 15344, checked in by Henrik Bettermann, 6 years ago

Customize increaseMatricInteger.
  • Property svn:keywords set to Id
File size: 13.0 KB
Line 
1## $Id: utils.py 15344 2019-03-06 21:21:38Z 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##
18from time import time
19import grok
20from zope.component import createObject, getUtility
21from waeup.kofa.interfaces import (IKofaUtils,
22    CLEARED, RETURNING, PAID, REGISTERED, VALIDATED)
23from kofacustom.nigeria.students.utils import NigeriaStudentsUtils
24from kofacustom.edopoly.interfaces import MessageFactory as _
25
26class CustomStudentsUtils(NigeriaStudentsUtils):
27    """A collection of customized methods.
28
29    """
30
31    # prefix
32    STUDENT_ID_PREFIX = u'U'
33
34    def warnCreditsOOR(self, studylevel, course=None):
35        """No maximum credits.
36        """
37        return
38
39    def GPABoundaries(self, faccode=None, depcode=None,
40                            certcode=None, student=None):
41        if student and student.current_mode.startswith('dp'):
42                return ((1, 'IRNS / NER / NYV'),
43                        (2, 'Pass'),
44                        (2.5, 'Lower Credit'),
45                        (3, 'Upper Credit'),
46                        (3.5, 'Distinction'))
47        elif student:
48            return ((1, 'FRNS / NER / NYV'),
49                    (1.5, 'Pass'),
50                    (2.4, '3rd Class Honours'),
51                    (3.5, '2nd Class Honours Lower Division'),
52                    (4.5, '2nd Class Honours Upper Division'),
53                    (5, '1st Class Honours'))
54        # Session Results Presentations depend on certificate
55        results = None
56        if certcode:
57            cat = queryUtility(ICatalog, name='certificates_catalog')
58            results = list(
59                cat.searchResults(code=(certcode, certcode)))
60        if results and results[0].study_mode.startswith('dp'):
61            return ((1, 'IRNS / NER / NYV'),
62                    (2, 'Pass'),
63                    (2.5, 'Lower Credit'),
64                    (3, 'Upper Credit'),
65                    (3.5, 'Distinction'))
66        else:
67            return ((1, 'FRNS / NER / NYV'),
68                    (1.5, 'Pass'),
69                    (2.4, '3rd Class Honours'),
70                    (3.5, '2nd Class Honours Lower Division'),
71                    (4.5, '2nd Class Honours Upper Division'),
72                    (5, '1st Class Honours'))
73
74    def getClassFromCGPA(self, gpa, student):
75        gpa_boundaries = self.GPABoundaries(student=student)
76        if gpa < gpa_boundaries[0][0]:
77            return 0, gpa_boundaries[0][1]
78        if gpa < gpa_boundaries[1][0]:
79            return 1, gpa_boundaries[1][1]
80        if gpa < gpa_boundaries[2][0]:
81            return 2, gpa_boundaries[2][1]
82        if gpa < gpa_boundaries[3][0]:
83            return 3, gpa_boundaries[3][1]
84        if gpa < gpa_boundaries[4][0]:
85            return 4, gpa_boundaries[4][1]
86        if gpa <= gpa_boundaries[5][0]:
87            return 5, gpa_boundaries[5][1]
88        return 'N/A'
89
90    def _requiredPaymentsMade(self, student, session):
91        # SIWESS fee requirement removed on 18/01/2019
92        req_payments = ('ict_entre', 'logbook_combo')
93        req_payments_titles = 'ICT and Logbook'
94        if len(student['payments']):
95            # All ND and HND part time do not pay for LOGBOOK
96            if student.current_mode.endswith('_pt'):
97                req_payments = ('ict_entre',)
98                req_payments_titles = 'ICT'
99            # HND1 and HND2 full time do not pay for LOGBOOK
100            elif student.current_mode == 'hnd_ft' and student.state in (
101                CLEARED, RETURNING):
102                req_payments = ('ict_entre',)
103                req_payments_titles = 'ICT'
104            # ND2 FULL TIME do not pay LOGBOOK
105            elif student.current_mode == 'nd_ft' and student.state == RETURNING:
106                req_payments = ('ict_entre',)
107                req_payments_titles = 'ICT'
108            num = 0
109            for ticket in student['payments'].values():
110                if ticket.p_state == 'paid' and \
111                    ticket.p_category in req_payments and \
112                    ticket.p_session == session:
113                    num += 1
114            if num == len(req_payments):
115                return True, None
116        return False, req_payments_titles
117
118    def setPaymentDetails(self, category, student,
119            previous_session, previous_level):
120        """Create a payment ticket and set the payment data of a
121        student for the payment category specified.
122        """
123        p_item = u''
124        amount = 0.0
125        if previous_session:
126            if previous_session < student['studycourse'].entry_session:
127                return _('The previous session must not fall below '
128                         'your entry session.'), None
129            if category == 'schoolfee':
130                # School fee is always paid for the following session
131                if previous_session > student['studycourse'].current_session:
132                    return _('This is not a previous session.'), None
133            else:
134                if previous_session > student['studycourse'].current_session - 1:
135                    return _('This is not a previous session.'), None
136            p_session = previous_session
137            p_level = previous_level
138            p_current = False
139        else:
140            p_session = student['studycourse'].current_session
141            p_level = student['studycourse'].current_level
142            p_current = True
143        academic_session = self._getSessionConfiguration(p_session)
144        if academic_session == None:
145            return _(u'Session configuration object is not available.'), None
146        # Determine fee.
147        # The following three fees are part of the school fee which must be
148        # paid before tuition fee.
149        if category in ('ict_entre', 'logbook_combo', 'siwess_combo') and \
150            student.state == RETURNING and not previous_session:
151            p_session, p_level = self.getReturningData(student)
152        if category == 'schoolfee':
153            try:
154                certificate = student['studycourse'].certificate
155                p_item = certificate.code
156            except (AttributeError, TypeError):
157                return _('Study course data are incomplete.'), None
158            if previous_session:
159                amount = getattr(certificate, 'school_fee_1', 0.0)
160            else:
161                amount = getattr(certificate, 'school_fee_1', 0.0)
162                if student.state == RETURNING:
163                    # In case of returning school fee payment the
164                    # payment session and level contain the values of
165                    # the session the student has paid for. Payment
166                    # session is always next session.
167                    p_session, p_level = self.getReturningData(student)
168                    academic_session = self._getSessionConfiguration(p_session)
169                    if academic_session == None:
170                        return _(
171                            u'Session configuration object is not available.'
172                            ), None
173                   
174                elif student.is_postgrad and student.state == PAID:
175                    # Returning postgraduate students also pay for the
176                    # next session but their level always remains the
177                    # same.
178                    p_session += 1
179                    academic_session = self._getSessionConfiguration(p_session)
180                    if academic_session == None:
181                        return _(
182                            u'Session configuration object is not available.'
183                            ), None
184            rpm, rpt = self._requiredPaymentsMade(student, p_session)
185            if not rpm:
186                return 'Pay %s fee(s) first.' % rpt, None
187        elif category == 'clearance':
188            try:
189                p_item = student['studycourse'].certificate.code
190            except (AttributeError, TypeError):
191                return _('Study course data are incomplete.'), None
192            amount = academic_session.clearance_fee
193        elif category == 'bed_allocation':
194            p_item = self.getAccommodationDetails(student)['bt']
195            amount = academic_session.booking_fee
196        elif category == 'hostel_maintenance':
197            amount = 0.0
198            bedticket = student['accommodation'].get(
199                str(student.current_session), None)
200            if bedticket is not None and bedticket.bed is not None:
201                p_item = bedticket.bed_coordinates
202                if bedticket.bed.__parent__.maint_fee > 0:
203                    amount = bedticket.bed.__parent__.maint_fee
204                else:
205                    # fallback
206                    amount = academic_session.maint_fee
207            else:
208                return _(u'No bed allocated.'), None
209        else:
210            fee_name = category + '_fee'
211            amount = getattr(academic_session, fee_name, 0.0)
212        if amount in (0.0, None):
213            return _('Amount could not be determined.'), None
214        if self.samePaymentMade(student, category, p_item, p_session):
215            return _('This type of payment has already been made.'), None
216        if self._isPaymentDisabled(p_session, category, student):
217            return _('This category of payments has been disabled.'), None
218        payment = createObject(u'waeup.StudentOnlinePayment')
219        timestamp = ("%d" % int(time()*10000))[1:]
220        payment.p_id = "p%s" % timestamp
221        payment.p_category = category
222        payment.p_item = p_item
223        payment.p_session = p_session
224        payment.p_level = p_level
225        payment.p_current = p_current
226        payment.amount_auth = amount
227        return None, payment
228
229    def constructMatricNumber(self, student):
230        faccode = student.faccode
231        #depcode = student.depcode
232        #certcode = student.certcode
233        year = unicode(student.entry_session)[2:]
234        if not student.state in (PAID, ) or not student.is_fresh:
235            return _('Matriculation number cannot be set.'), None
236
237        # SASND1809001
238        if student.current_mode == 'nd_ft':
239            next_integer = grok.getSite()['configuration'].next_matric_integer
240            if next_integer == 0:
241                return _('Matriculation number cannot be set.'), None
242            return None, "%s/ND/%s/%05d" % (faccode, year, next_integer)
243
244        # SASNH1809001
245        if student.current_mode == 'hnd_ft':
246            next_integer = grok.getSite()['configuration'].next_matric_integer_2
247            if next_integer == 0:
248                return _('Matriculation number cannot be set.'), None
249            return None, "%s/HD/%s/%05d" % (faccode, year, next_integer)
250
251        # SASPT1809001
252        if student.current_mode in ('nd_pt', 'hnd_pt'):
253            next_integer = grok.getSite()['configuration'].next_matric_integer_3
254            if next_integer == 0:
255                return _('Matriculation number cannot be set.'), None
256            return None, "%s/PT/%s/%05d" % (faccode, year, next_integer)
257
258        return _('Matriculation number cannot be set.'), None
259
260
261    def increaseMatricInteger(self, student):
262        """Increase counter for matric numbers.
263        """
264        if student.current_mode == 'nd_ft':
265            grok.getSite()['configuration'].next_matric_integer += 1
266            return
267        elif student.current_mode == 'hnd_ft':
268            grok.getSite()['configuration'].next_matric_integer_2 += 1
269            return
270        elif student.current_mode in ('nd_pt', 'hnd_pt'):
271            grok.getSite()['configuration'].next_matric_integer_3 += 1
272            return
273        return
274
275    def getAccommodationDetails(self, student):
276        """Determine the accommodation data of a student.
277        """
278        d = {}
279        d['error'] = u''
280        hostels = grok.getSite()['hostels']
281        d['booking_session'] = hostels.accommodation_session
282        d['allowed_states'] = hostels.accommodation_states
283        d['startdate'] = hostels.startdate
284        d['enddate'] = hostels.enddate
285        d['expired'] = hostels.expired
286        # Determine bed type
287        studycourse = student['studycourse']
288        certificate = getattr(studycourse,'certificate',None)
289        entry_session = studycourse.entry_session
290        current_level = studycourse.current_level
291        if None in (entry_session, current_level, certificate):
292            return d
293        bt = 'all'
294        if student.sex == 'f':
295            sex = 'female'
296        else:
297            sex = 'male'
298        special_handling = 'regular'
299        d['bt'] = u'%s_%s_%s' % (special_handling,sex,bt)
300        return d
Note: See TracBrowser for help on using the repository browser.