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

Last change on this file since 17936 was 17727, checked in by Henrik Bettermann, 8 months ago

Students can set metric number if acceptance fee has been paid.
  • Property svn:keywords set to Id
File size: 14.2 KB
Line 
1## $Id: utils.py 17727 2024-03-25 10:33:29Z 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','union')
93        req_payments_titles = 'ICT, Student Union and Logbook'
94        # All ND and HND part time do not pay for logbook and union
95        if student.current_mode.endswith('_pt'):
96            req_payments = ('ict_entre',)
97            req_payments_titles = 'ICT'
98        # HND1 and HND2 full time do not pay for LOGBOOK
99        elif student.current_mode == 'hnd_ft' and student.state in (
100            CLEARED, RETURNING):
101            req_payments = ('union', 'ict_entre')
102            req_payments_titles = 'Student Union and ICT'
103        # ND2 FULL TIME do not pay LOGBOOK
104        elif student.current_mode == 'nd_ft' and student.state == RETURNING:
105            req_payments = ('ict_entre', 'union')
106            req_payments_titles = 'Student Union and ICT'
107        num = 0
108        if len(student['payments']):
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 samePaymentMade(self, student, category, p_item, p_session):
119        if category in ('transcript',):
120            return False
121        for key in student['payments'].keys():
122            ticket = student['payments'][key]
123            if ticket.p_state == 'paid' and\
124               ticket.p_category == category and \
125               ticket.p_item == p_item and \
126               ticket.p_session == p_session:
127                  return True
128        return False
129
130    def setPaymentDetails(self, category, student,
131            previous_session=None, previous_level=None, combi=[]):
132        """Create a payment ticket and set the payment data of a
133        student for the payment category specified.
134        """
135        p_item = u''
136        amount = 0.0
137        if previous_session:
138            if previous_session < student['studycourse'].entry_session:
139                return _('The previous session must not fall below '
140                         'your entry session.'), None
141            if category == 'schoolfee':
142                # School fee is always paid for the following session
143                if previous_session > student['studycourse'].current_session:
144                    return _('This is not a previous session.'), None
145            else:
146                if previous_session > student['studycourse'].current_session - 1:
147                    return _('This is not a previous session.'), None
148            p_session = previous_session
149            p_level = previous_level
150            p_current = False
151        else:
152            p_session = student['studycourse'].current_session
153            p_level = student['studycourse'].current_level
154            p_current = True
155        # The following fout fees are part of the school fee which must be
156        # paid before tuition fee. They are paid for next session.
157        if category in ('ict_entre', 'logbook_combo', 'siwess_combo', 'union') and \
158            student.state == RETURNING and not previous_session:
159            p_session, p_level = self.getReturningData(student)
160        academic_session = self._getSessionConfiguration(p_session)
161        if academic_session == None:
162            return _(u'Session configuration object is not available.'), None
163        # Determine fee.
164        if category == 'schoolfee':
165            try:
166                certificate = student['studycourse'].certificate
167                p_item = certificate.code
168            except (AttributeError, TypeError):
169                return _('Study course data are incomplete.'), None
170            if previous_session:
171                amount = getattr(certificate, 'school_fee_1', 0.0)
172            else:
173                if student.state == CLEARED:
174                    amount = getattr(certificate, 'school_fee_1', 0.0)
175                elif student.state == RETURNING:
176                    amount = getattr(certificate, 'school_fee_1', 0.0)
177                    # In case of returning school fee payment the
178                    # payment session and level contain the values of
179                    # the session the student has paid for. Payment
180                    # session is always next session.
181                    p_session, p_level = self.getReturningData(student)
182                    academic_session = self._getSessionConfiguration(p_session)
183                    if academic_session == None:
184                        return _(
185                            u'Session configuration object is not available.'
186                            ), None
187                elif student.is_postgrad and student.state == PAID:
188                    # Returning postgraduate students also pay for the
189                    # next session but their level always remains the
190                    # same.
191                    amount = getattr(certificate, 'school_fee_1', 0.0)
192                    p_session += 1
193                    academic_session = self._getSessionConfiguration(p_session)
194                    if academic_session == None:
195                        return _(
196                            u'Session configuration object is not available.'
197                            ), None
198            rpm, rpt = self._requiredPaymentsMade(student, p_session)
199            if not rpm:
200                return 'Pay %s fee(s) first.' % rpt, None
201        elif category == 'clearance':
202            try:
203                p_item = student['studycourse'].certificate.code
204            except (AttributeError, TypeError):
205                return _('Study course data are incomplete.'), None
206            amount = academic_session.clearance_fee
207        elif category == 'bed_allocation':
208            acco_details = self.getAccommodationDetails(student)
209            p_session = acco_details['booking_session']
210            p_item = acco_details['bt']
211            amount = academic_session.booking_fee
212        elif category == 'hostel_maintenance':
213            amount = 0.0
214            booking_session = grok.getSite()['hostels'].accommodation_session
215            bedticket = student['accommodation'].get(str(booking_session), None)
216            if bedticket is not None and bedticket.bed is not None:
217                p_session = booking_session
218                p_item = bedticket.bed_coordinates
219                if bedticket.bed.__parent__.maint_fee > 0:
220                    amount = bedticket.bed.__parent__.maint_fee
221                else:
222                    # fallback
223                    amount = academic_session.maint_fee
224            else:
225                return _(u'No bed allocated.'), None
226        else:
227            fee_name = category + '_fee'
228            amount = getattr(academic_session, fee_name, 0.0)
229        if amount in (0.0, None):
230            return _('Amount could not be determined.'), None
231        if self.samePaymentMade(student, category, p_item, p_session):
232            return _('This type of payment has already been made.'), None
233        if self._isPaymentDisabled(p_session, category, student):
234            return _('This category of payments has been disabled.'), None
235        payment = createObject(u'waeup.StudentOnlinePayment')
236        timestamp = ("%d" % int(time()*10000))[1:]
237        payment.p_id = "p%s" % timestamp
238        payment.p_category = category
239        payment.p_item = p_item
240        payment.p_session = p_session
241        payment.p_level = p_level
242        payment.p_current = p_current
243        payment.amount_auth = amount
244        return None, payment
245
246    def constructMatricNumber(self, student):
247        faccode = student.faccode
248        #depcode = student.depcode
249        #certcode = student.certcode
250        clearance_paid = False
251        if len(student['payments']):
252            for ticket in student['payments'].values():
253                if ticket.p_state == 'paid' and \
254                    ticket.p_category == 'clearance' and \
255                    ticket.p_session == student.entry_session:
256                        clearance_paid = True
257                        break
258        if not clearance_paid or not student.is_fresh:
259            return _('Matriculation number cannot be set.'), None
260        year = unicode(student.entry_session)[2:]
261        # SASND1809001
262        if student.current_mode == 'nd_ft':
263            next_integer = grok.getSite()['configuration'].next_matric_integer
264            if next_integer == 0:
265                return _('Matriculation number cannot be set.'), None
266            return None, "%s/ND/%s/%05d" % (faccode, year, next_integer)
267
268        # SASNH1809001
269        if student.current_mode == 'hnd_ft':
270            next_integer = grok.getSite()['configuration'].next_matric_integer_2
271            if next_integer == 0:
272                return _('Matriculation number cannot be set.'), None
273            return None, "%s/HD/%s/%05d" % (faccode, year, next_integer)
274
275        # SASPT1809001
276        if student.current_mode in ('nd_pt', 'hnd_pt'):
277            next_integer = grok.getSite()['configuration'].next_matric_integer_3
278            if next_integer == 0:
279                return _('Matriculation number cannot be set.'), None
280            return None, "%s/PT/%s/%05d" % (faccode, year, next_integer)
281
282        return _('Matriculation number cannot be set.'), None
283
284
285    def increaseMatricInteger(self, student):
286        """Increase counter for matric numbers.
287        """
288        if student.current_mode == 'nd_ft':
289            grok.getSite()['configuration'].next_matric_integer += 1
290            return
291        elif student.current_mode == 'hnd_ft':
292            grok.getSite()['configuration'].next_matric_integer_2 += 1
293            return
294        elif student.current_mode in ('nd_pt', 'hnd_pt'):
295            grok.getSite()['configuration'].next_matric_integer_3 += 1
296            return
297        return
298
299    def getAccommodationDetails(self, student):
300        """Determine the accommodation data of a student.
301        """
302        d = {}
303        d['error'] = u''
304        hostels = grok.getSite()['hostels']
305        d['booking_session'] = hostels.accommodation_session
306        d['allowed_states'] = hostels.accommodation_states
307        d['startdate'] = hostels.startdate
308        d['enddate'] = hostels.enddate
309        d['expired'] = hostels.expired
310        # Determine bed type
311        studycourse = student['studycourse']
312        certificate = getattr(studycourse,'certificate',None)
313        entry_session = studycourse.entry_session
314        current_level = studycourse.current_level
315        if None in (entry_session, current_level, certificate):
316            return d
317        bt = 'all'
318        if student.sex == 'f':
319            sex = 'female'
320        else:
321            sex = 'male'
322        special_handling = 'regular'
323        d['bt'] = u'%s_%s_%s' % (special_handling,sex,bt)
324        return d
Note: See TracBrowser for help on using the repository browser.