source: main/waeup.fceokene/trunk/src/waeup/fceokene/students/utils.py @ 16891

Last change on this file since 16891 was 16891, checked in by Henrik Bettermann, 3 years ago

Make third_semester payment conditional on number registered at p_level.
  • Property svn:keywords set to Id
File size: 21.4 KB
Line 
1## $Id: utils.py 16891 2022-03-16 21:17:42Z 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
19import random
20from time import time
21from zope.component import createObject, getUtility
22from waeup.kofa.interfaces import (
23    CLEARED, RETURNING, PAID, ADMITTED, CLEARANCE, REQUESTED)
24from kofacustom.nigeria.students.utils import NigeriaStudentsUtils
25from waeup.kofa.accesscodes import create_accesscode
26from waeup.kofa.interfaces import CLEARED, RETURNING
27from waeup.fceokene.interfaces import MessageFactory as _
28from waeup.kofa.browser.interfaces import IPDFCreator
29from waeup.kofa.students.utils import trans
30
31# Very special school fee configuration, should be moved to
32# a seperate file.
33
34ARTS = ('CRS','ISS','HIS','MUS','ECO','GEO','POL','SOS','CCA','ECU',
35        'THA','GED','GSE','PES','SPC','ENG','FRE','ARB','HAU','IGB',
36        'YOR','NCRS','NISS','NHIS','NMUS','NECO','NGEO','NPOL',
37        'NCCA','NECU','NTHA','NGED','NGSE','NPES','NSPC','NENG',
38        'NFRE','NARB','NHAU','NIGB','NYOR','NSOS')
39
40GATEWAY_AMT = 0.0
41
42class CustomStudentsUtils(NigeriaStudentsUtils):
43    """A collection of customized methods.
44
45    """
46
47    def selectBed(self, available_beds):
48        """Randomly select a bed from the list of available beds.
49        """
50        return random.choice(available_beds)
51
52    def getReturningData(self, student):
53        """ This method defines what happens after school fee payment
54        of returning students depending on the student's senate verdict.
55        """
56        prev_level = student['studycourse'].current_level
57        cur_verdict = student['studycourse'].current_verdict
58        if cur_verdict in ('A','B','L','M','N','Z',):
59            # Successful student
60            new_level = divmod(int(prev_level),100)[0]*100 + 100
61        elif cur_verdict in ('C','O'):
62            # Student on probation
63            new_level = int(prev_level) + 10
64        else:
65            # Student is somehow in an undefined state.
66            # Level has to be set manually.
67            new_level = prev_level
68        if cur_verdict == 'O':
69            new_session = student['studycourse'].current_session
70        else:
71            new_session = student['studycourse'].current_session + 1
72        return new_session, new_level
73
74    def _nce3PaymentMade(self, student, p_level):
75        if len(student['payments']):
76            for ticket in student['payments'].values():
77                if ticket.p_state in ('paid', 'scholarship', 'waived') and \
78                    ticket.p_level == p_level and \
79                    ticket.p_category == 'schoolfee':
80                    return True
81        return False
82
83    def setPaymentDetails(self, category, student,
84            previous_session=None, previous_level=None, combi=[]):
85        """Create Payment object and set the payment data of a student for
86        the payment category specified.
87
88        """
89        details = {}
90        p_item = u''
91        amount = 0.0
92        error = u''
93        if previous_session:
94            return _('Previous session payment not yet implemented.'), None
95        p_session = student['studycourse'].current_session
96        p_level = student['studycourse'].current_level
97        p_current = True
98        academic_session = self._getSessionConfiguration(p_session)
99        if academic_session == None:
100            return _(u'Session configuration object is not available.'), None
101        # Determine fee.
102        if category == 'transfer':
103            amount = academic_session.transfer_fee
104        elif category == 'gown':
105            amount = academic_session.gown_fee
106        elif category == 'bed_allocation':
107            amount = academic_session.booking_fee
108        elif category == 'hostel_maintenance':
109            current_session = student['studycourse'].current_session
110            bedticket = student['accommodation'].get(str(current_session), None)
111            if bedticket is not None and bedticket.bed is not None:
112                p_item = bedticket.bed_coordinates
113                if bedticket.bed.__parent__.maint_fee > 0:
114                    amount = bedticket.bed.__parent__.maint_fee
115            else:
116                return _(u'No bed space allocated.'), None
117            if student.current_mode.endswith('_sw') \
118                or student.current_mode == 'pd_ft':
119                amount *= 0.625
120        elif category == 'clearance':
121            amount = academic_session.clearance_fee
122            try:
123                p_item = student['studycourse'].certificate.code
124            except (AttributeError, TypeError):
125                return _('Study course data are incomplete.'), None
126            if student.state not in (ADMITTED, CLEARANCE, REQUESTED, CLEARED):
127                return _(u'Acceptance Fee payments not allowed.'), None
128        elif category == 'third_semester' and student.current_mode == 'nce_ft' \
129            and p_level in (300, 310, 320, 400, 410, 420):
130            if not self._nce3PaymentMade(student, p_level):
131                return _(u'Make NCE 3 school fee payment first.'), None
132            if student.depcode in ARTS:
133                amount = 7688.0
134            else:
135                amount = 7938.0
136            no_additional_courses = 0
137            courses_level = student['studycourse'].get(str(p_level))
138            if courses_level and len(courses_level)> 6:
139                no_additional_courses = len(courses_level)-6
140                amount += 2000.0 * no_additional_courses
141        elif category.startswith('schoolfee'):
142            if category == 'schoolfee_pde1':
143                if not student.current_mode.startswith('pd'):
144                    return _('You are not a PDE student.'), None
145                if student.state != CLEARED:
146                        return _('You are not a fresh student.'), None
147            p_item =  student.certcode
148            if not p_item:
149                return _('Study course data are incomplete.'), None
150            if student.state not in (CLEARED, RETURNING):
151                return _('Wrong state.'), None
152            # PDE repeater
153            if student.current_verdict == 'OPDE':
154                amount = 23000
155            # PDE new
156            elif student.current_mode == 'pd_ft' and student.state == CLEARED:
157                amount = 70000
158                if category == 'schoolfee_pde1':
159                    amount = 40000
160            # PDE
161            elif student.current_mode == 'pd_ft':
162                amount = 35300
163
164            #Short Duration ICT Programs
165            elif p_item in ('CCO','DPMTS','DTPGD') and \
166                 student.state == CLEARED:
167                amount = 15000
168            elif p_item in ('ADTPGD','ADPMTS') and \
169                 student.state == CLEARED:
170                amount = 16000
171            elif p_item in ('ADPMTSI','ADTPGDI','DPMTSI','DTPGDI') and \
172                 student.state == CLEARED:
173                amount = 25000
174            elif p_item in ('ADPMTSA','ADTPGDA') and \
175               student.state == CLEARED:
176                amount = 35000
177
178            # UG
179            elif student.current_mode == 'ug_ft':
180                if student.state == CLEARED:
181                    amount = 65650
182                # Introducing repeater fee for 'ug_ft' for 1st time
183                # on 15/03/2016
184                elif student.current_verdict == 'O':
185                    amount = 56150
186                else:
187                    amount = 56150
188            # NCE
189            elif not student.current_mode.endswith('_sw'):
190                # PRENCE
191                if student.current_level == 10 and student.state == CLEARED:
192                    if student.depcode in ARTS:
193                        amount = 24500
194                    else:
195                        amount = 25000
196                # NCE I fresh
197                elif student.current_level == 100 and student.state == CLEARED:
198                    if student.depcode in ARTS:
199                        amount = 28000
200                    else:
201                        amount = 28500
202                    # SIWES Fee
203                    if student.depcode in ('AGE', 'BED', 'FAA', 'HEC', 'CSC', 'MUS') \
204                       or student.certcode in ('NCECHECSC', 'NCEBIOCSC', 'NCEPHYCSC', 'NCEPHECSC',):
205                        amount += 3000
206                # NCE II
207                elif student.current_level in (100, 110, 120) and \
208                    student.state == RETURNING:
209                    if student.depcode in ARTS:
210                        amount = 24500
211                    else:
212                        amount = 25000
213                # NCE III
214                elif student.current_level in (200, 210, 220):
215                    if student.depcode in ARTS:
216                        amount = 15375
217                    else:
218                        amount = 15875
219                # NCE III repeater
220                elif student.current_level in (300, 310, 320) and \
221                    student.current_verdict == 'O':
222                    if student.depcode in ARTS:
223                        amount = 13475
224                    else:
225                        amount = 13975
226                # NCE III spillover
227                elif student.current_level in (300, 310, 320) and \
228                    student.current_verdict == 'B':
229                    if student.depcode in ARTS:
230                        amount = 13475
231                    else:
232                        amount = 13975
233                # NCE III second spillover
234                elif student.current_level in (400, 410, 420) and \
235                    student.current_verdict == 'B':
236                    if student.depcode in ARTS:
237                        amount = 13475
238                    else:
239                        amount = 13975
240            else:
241                # NCE I fresh sw
242                if student.current_level == 100 and student.state == CLEARED:
243                    if student.depcode in ARTS:
244                        amount = 23100
245                    else:
246                        amount = 23600
247                # NCE II fresh sw
248                elif student.current_level == 200 and student.state == CLEARED:
249                    if student.depcode in ARTS:
250                        amount = 19000
251                    else:
252                        amount = 19500
253                # NCE II sw
254                elif student.current_level in (100, 110, 120) and \
255                    student.state == RETURNING:
256                    if student.depcode in ARTS:
257                        amount = 19000
258                    else:
259                        amount = 19500
260                # NCE III sw
261                elif student.current_level in (200, 210, 220):
262                    if student.depcode in ARTS:
263                        amount = 21000
264                    else:
265                        amount = 21500
266                # NCE IV sw
267                elif student.current_level in (300, 310, 320):
268                    if student.depcode in ARTS:
269                        amount = 19000
270                    else:
271                        amount = 19500
272                # NCE V sw
273                elif student.current_level in (400, 410, 420):
274                    if student.depcode in ARTS:
275                        amount = 19000
276                    else:
277                        amount = 19500
278                # NCE V spillover sw
279                elif student.current_level in (500, 510, 520) and \
280                    student.current_verdict == 'B':
281                    if student.depcode in ARTS:
282                        amount = 17500
283                    else:
284                        amount = 18000
285                # NCE V second spillover sw
286                elif student.current_level in (600, 610, 620) and \
287                    student.current_verdict == 'B':
288                    if student.depcode in ARTS:
289                        amount = 17500
290                    else:
291                        amount = 18000
292            # NCE student payment can be disabled by
293            # setting the base school fee to -1
294            if academic_session.school_fee_base == -1 and \
295                student.current_mode.startswith('nce'):
296                return _(u'School fee payment is disabled.'), None
297            if student.state == RETURNING:
298                # Override p_session and p_level
299                p_session, p_level = self.getReturningData(student)
300                academic_session = self._getSessionConfiguration(p_session)
301                if academic_session == None:
302                    return _(u'Session configuration object is not available.'), None
303
304        if amount in (0.0, None):
305            return _(u'Amount could not be determined.'), None
306
307        # Add session and level specific penalty fee.
308        if category == 'schoolfee' and student.current_mode in (
309            'ug_ft', 'de_ft') and student.state != CLEARED:
310            amount += academic_session.penalty_ug_ft
311        elif category == 'schoolfee' and student.current_mode in (
312            'nce_ft',) and student['studycourse'].previous_verdict != 'O':
313            # NCE I fresh
314            if student.current_level == 100 and student.state == CLEARED:
315                amount += academic_session.penalty_nce1_ft
316            # NCE II
317            elif student.current_level in (100, 110, 120) and \
318                student.state == RETURNING:
319                amount += academic_session.penalty_nce2_ft
320            # NCE III (except repeaters and spillovers)
321            elif student.current_level in (200, 210, 220):
322                amount += academic_session.penalty_nce3_ft
323        elif category == 'schoolfee' and student.current_mode in ('nce_sw',
324            'nce_pt') and student['studycourse'].previous_verdict != 'O':
325            # NCE I fresh
326            if student.current_level == 100 and student.state == CLEARED:
327                amount += academic_session.penalty_nce1_pt
328            # NCE II
329            elif student.current_level in (100, 110, 120) and \
330                student.state == RETURNING:
331                amount += academic_session.penalty_nce2_pt
332            # NCE III (except repeaters and spillovers)
333            elif student.current_level in (200, 210, 220):
334                amount += academic_session.penalty_nce3_pt
335        elif category == 'schoolfee' and student.current_mode in ('prence',):
336            amount += academic_session.penalty_prence
337        if self.samePaymentMade(student, category, p_item, p_session):
338            return _('This type of payment has already been made.'), None
339        if self._isPaymentDisabled(p_session, category, student):
340            return _('This category of payments has been disabled.'), None
341        payment = createObject(u'waeup.StudentOnlinePayment')
342        timestamp = ("%d" % int(time()*10000))[1:]
343        payment.p_id = "p%s" % timestamp
344        payment.p_category = category
345        payment.p_item = p_item
346        payment.p_session = p_session
347        payment.p_level = p_level
348        payment.p_current = p_current
349        payment.amount_auth = float(amount) + GATEWAY_AMT
350        return None, payment
351
352    def getAccommodationDetails(self, student):
353        """Determine the accommodation data of a student.
354        """
355        d = {}
356        d['error'] = u''
357        hostels = grok.getSite()['hostels']
358        d['booking_session'] = hostels.accommodation_session
359        d['allowed_states'] = hostels.accommodation_states
360        d['startdate'] = hostels.startdate
361        d['enddate'] = hostels.enddate
362        d['expired'] = hostels.expired
363        # Determine bed type
364        studycourse = student['studycourse']
365        certificate = getattr(studycourse,'certificate',None)
366        current_level = studycourse.current_level
367        if None in (current_level, certificate):
368            return d
369        end_level = certificate.end_level
370        if current_level == 10:
371            bt = 'pr'
372        elif current_level == 100:
373            bt = 'fr'
374        elif current_level >= 300:
375            bt = 'fi'
376        else:
377            bt = 're'
378        if student.sex == 'f':
379            sex = 'female'
380        else:
381            sex = 'male'
382        special_handling = 'regular'
383        if certificate.study_mode == 'ug_ft':
384            special_handling = 'ugft'
385        d['bt'] = u'%s_%s_%s' % (special_handling,sex,bt)
386        return d
387
388    #def warnCreditsOOR(self, studylevel, course=None):
389    #    """Return message if credits are out of range.
390    #    """
391    #    # adding a course ticket
392    #    if course:
393    #        if course.semester == 1:
394    #            if studylevel.total_credits_s1 + course.credits > 24:
395    #                return _('Maximum credits in 1st semester exceeded.')
396    #        if course.semester == 2:
397    #            if studylevel.total_credits_s2 + course.credits > 24:
398    #                return _('Maximum credits in 2nd semester exceeded.')
399    #    # registering course list
400    #    else:
401    #        if studylevel.total_credits_s1 > 24:
402    #            return _('Maximum credits in 1st semester exceeded.')
403    #        if studylevel.total_credits_s1 < 18:
404    #            return _('Minimum credits in 1st semester not reached.')
405    #        if studylevel.total_credits_s2 > 24:
406    #            return _('Maximum credits in 2nd semester exceeded.')
407    #        if studylevel.total_credits_s2 < 18:
408    #            return _('Minimum credits in 2nd semester not reached.')
409    #    return
410
411    def warnCreditsOOR(self, studylevel, course=None):
412        """Return message if credits are out of range.
413        """
414        # adding a course ticket
415        if course:
416            if studylevel.total_credits + course.credits > 52:
417                return _('Maximum credits exceeded.')
418        # registering course list
419        else:
420            if studylevel.total_credits > 52:
421                return _('Maximum credits exceeded.')
422            if studylevel.__parent__.previous_verdict == 'O':
423                return
424            if studylevel.total_credits_s1 < 18:
425                return _('Minimum credits in 1st semester not reached.')
426            if studylevel.total_credits_s2 < 18:
427                return _('Minimum credits in 2nd semester not reached.')
428        return
429
430    def getPDFCreator(self, context):
431        """Get a pdf creator suitable for `context`.
432
433        The default implementation always returns the default creator.
434        """
435        mode = getattr(context, 'current_mode', None)
436        if mode and mode.startswith('ug'):
437            return getUtility(IPDFCreator, name='ibadan_pdfcreator')
438        return getUtility(IPDFCreator)
439
440    def _admissionText(self, student, portal_language):
441        mode = getattr(student, 'current_mode', None)
442        if mode and mode.startswith('ug'):
443            text = trans(_(
444                'With reference to your application for admission into Bachelor Degree '
445                'Programme of the University of Ibadan, this is to inform you that you have '
446                'been provisionally admitted to pursue a full-time Bachelor of Arts in '
447                'Education Degree Programme as follows:'),
448                portal_language)
449        else:
450            inst_name = grok.getSite()['configuration'].name
451            text = trans(_(
452                'This is to inform you that you have been provisionally\n'
453                'admitted into ${a}\n'
454                'as follows:', mapping = {'a': inst_name}),
455                portal_language)
456        return text
457
458    def getBedCoordinates(self, bedticket):
459        """Return bed coordinates.
460
461        Bed coordinates are invisible in FCEOkene.
462        """
463        return _('(see payment slip)')
464
465    def _isPaymentDisabled(self, p_session, category, student):
466        academic_session = self._getSessionConfiguration(p_session)
467        if category == 'schoolfee':
468            if 'sf_all' in academic_session.payment_disabled:
469                return True
470            if 'sf_nce1' in academic_session.payment_disabled and \
471                student.current_level == 100 and student.state == CLEARED and \
472                student.current_mode == 'nce_ft':
473                return True
474        if category == 'clearance':
475            if 'cl_except_ug' in academic_session.payment_disabled and \
476                student.current_mode != 'ug_ft':
477                return True
478        return False
479
480    SEPARATORS_DICT = {
481        'form.fst_sit_fname': _(u'First Sitting Record'),
482        'form.scd_sit_fname': _(u'Second Sitting Record'),
483        #'form.alr_fname': _(u'Advanced Level Record'),
484        'form.hq_type': _(u'Advanced Level Record'),
485        'form.hq2_type': _(u'Second Higher Education Record'),
486        'form.nysc_year': _(u'NYSC Information'),
487        'form.employer': _(u'Employment History'),
488        'form.former_matric': _(u'Former Student'),
489        }
490
491    SKIP_UPLOAD_VIEWLETS = (
492        'higherqualificationresultupload',
493        'secondHigherqualificationresultupload',
494        'certificateupload',
495        'secondcertificateupload',
496        'thirdcertificateupload',
497        'resultstatementupload',
498        'secondrefereeletterupload',
499        'thirdrefereeletterupload',)
500
501    # FCEOkene prefix
502    STUDENT_ID_PREFIX = u'K'
Note: See TracBrowser for help on using the repository browser.