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

Last change on this file since 17087 was 17087, checked in by Henrik Bettermann, 2 years ago

Change SIWES surcharge certificate list.

Calculate other fees.
  • Property svn:keywords set to Id
File size: 22.2 KB
Line 
1## $Id: utils.py 17087 2022-09-07 12:40:00Z 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        #    no_additional_courses = 0
133        #    courses_level = student['studycourse'].get(str(p_level))
134        #    if courses_level and len(courses_level)> 6:
135        #        no_additional_courses = len(courses_level)-6
136        #        amount = 2000.0 * no_additional_courses
137        elif category.startswith('schoolfee'):
138            if category == 'schoolfee_pde1':
139                if not student.current_mode.startswith('pd'):
140                    return _('You are not a PDE student.'), None
141                if student.state != CLEARED:
142                        return _('You are not a fresh student.'), None
143            if category == 'schoolfee_third':
144                if not student.current_mode == 'nce_ft' \
145                    or not p_level in (300, 310, 320, 400, 410, 420):
146                    return _('You are not an NCE 3 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 = 87200
182                # Introducing repeater fee for 'ug_ft' for 1st time
183                # on 15/03/2016
184                elif student.current_verdict == 'O':
185                    amount = 70700
186                else:
187                    amount = 70700
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',
205                                               'NCEBIOCSC',
206                                               'NCEPHYCSC',
207                                               'NCEPHECSC',
208                                               'NCETHAMUS',
209                                               'NCEANFMUS',
210                                               'NCEHISMUS',
211                                               'NCEIGBMUS',
212                                               'NCESPCCSC',
213                                               ):
214                        amount += 3000
215                # NCE II
216                elif student.current_level in (100, 110, 120) and \
217                    student.state == RETURNING:
218                    if student.depcode in ARTS:
219                        amount = 24500
220                    else:
221                        amount = 25000
222                # NCE III third semester
223                elif category == 'schoolfee_third':
224                    amount = 7000
225                # NCE III
226                elif student.current_level in (200, 210, 220):
227                    if student.depcode in ARTS:
228                        amount = 15375
229                    else:
230                        amount = 15875
231                # NCE III repeater
232                elif student.current_level in (300, 310, 320) and \
233                    student.current_verdict == 'O':
234                    if student.depcode in ARTS:
235                        amount = 13475
236                    else:
237                        amount = 13975
238                # NCE III spillover
239                elif student.current_level in (300, 310, 320) and \
240                    student.current_verdict == 'B':
241                    if student.depcode in ARTS:
242                        amount = 13475
243                    else:
244                        amount = 13975
245                # NCE III second spillover
246                elif student.current_level in (400, 410, 420) and \
247                    student.current_verdict == 'B':
248                    if student.depcode in ARTS:
249                        amount = 13475
250                    else:
251                        amount = 13975
252            else:
253                # NCE I fresh sw
254                if student.current_level == 100 and student.state == CLEARED:
255                    if student.depcode in ARTS:
256                        amount = 23100
257                    else:
258                        amount = 23600
259                # NCE II fresh sw
260                elif student.current_level == 200 and student.state == CLEARED:
261                    if student.depcode in ARTS:
262                        amount = 19000
263                    else:
264                        amount = 19500
265                # NCE II sw
266                elif student.current_level in (100, 110, 120) and \
267                    student.state == RETURNING:
268                    if student.depcode in ARTS:
269                        amount = 19000
270                    else:
271                        amount = 19500
272                # NCE III sw
273                elif student.current_level in (200, 210, 220):
274                    if student.depcode in ARTS:
275                        amount = 21000
276                    else:
277                        amount = 21500
278                # NCE IV sw
279                elif student.current_level in (300, 310, 320):
280                    if student.depcode in ARTS:
281                        amount = 19000
282                    else:
283                        amount = 19500
284                # NCE V sw
285                elif student.current_level in (400, 410, 420):
286                    if student.depcode in ARTS:
287                        amount = 19000
288                    else:
289                        amount = 19500
290                # NCE V spillover sw
291                elif student.current_level in (500, 510, 520) and \
292                    student.current_verdict == 'B':
293                    if student.depcode in ARTS:
294                        amount = 17500
295                    else:
296                        amount = 18000
297                # NCE V second spillover sw
298                elif student.current_level in (600, 610, 620) and \
299                    student.current_verdict == 'B':
300                    if student.depcode in ARTS:
301                        amount = 17500
302                    else:
303                        amount = 18000
304            # NCE student payment can be disabled by
305            # setting the base school fee to -1
306            if academic_session.school_fee_base == -1 and \
307                student.current_mode.startswith('nce'):
308                return _(u'School fee payment is disabled.'), None
309            if student.state == RETURNING:
310                # Override p_session and p_level
311                p_session, p_level = self.getReturningData(student)
312                academic_session = self._getSessionConfiguration(p_session)
313                if academic_session == None:
314                    return _(u'Session configuration object is not available.'), None
315        else:
316            fee_name = category + '_fee'
317            amount = getattr(academic_session, fee_name, 0.0)
318           
319        if amount in (0.0, None):
320            return _(u'Amount could not be determined.'), None
321
322        # Add session and level specific penalty fee.
323        if category == 'schoolfee' and student.current_mode in (
324            'ug_ft', 'de_ft') and student.state != CLEARED:
325            amount += academic_session.penalty_ug_ft
326        elif category == 'schoolfee' and student.current_mode in (
327            'nce_ft',) and student['studycourse'].previous_verdict != 'O':
328            # NCE I fresh
329            if student.current_level == 100 and student.state == CLEARED:
330                amount += academic_session.penalty_nce1_ft
331            # NCE II
332            elif student.current_level in (100, 110, 120) and \
333                student.state == RETURNING:
334                amount += academic_session.penalty_nce2_ft
335            # NCE III (except repeaters and spillovers)
336            elif student.current_level in (200, 210, 220):
337                amount += academic_session.penalty_nce3_ft
338        elif category == 'schoolfee' and student.current_mode in ('nce_sw',
339            'nce_pt') and student['studycourse'].previous_verdict != 'O':
340            # NCE I fresh
341            if student.current_level == 100 and student.state == CLEARED:
342                amount += academic_session.penalty_nce1_pt
343            # NCE II
344            elif student.current_level in (100, 110, 120) and \
345                student.state == RETURNING:
346                amount += academic_session.penalty_nce2_pt
347            # NCE III (except repeaters and spillovers)
348            elif student.current_level in (200, 210, 220):
349                amount += academic_session.penalty_nce3_pt
350        elif category == 'schoolfee' and student.current_mode in ('prence',):
351            amount += academic_session.penalty_prence
352        if self.samePaymentMade(student, category, p_item, p_session):
353            return _('This type of payment has already been made.'), None
354        if self._isPaymentDisabled(p_session, category, student):
355            return _('This category of payments has been disabled.'), None
356        payment = createObject(u'waeup.StudentOnlinePayment')
357        timestamp = ("%d" % int(time()*10000))[1:]
358        payment.p_id = "p%s" % timestamp
359        payment.p_category = category
360        payment.p_item = p_item
361        payment.p_session = p_session
362        payment.p_level = p_level
363        payment.p_current = p_current
364        payment.amount_auth = float(amount) + GATEWAY_AMT
365        return None, payment
366
367    def getAccommodationDetails(self, student):
368        """Determine the accommodation data of a student.
369        """
370        d = {}
371        d['error'] = u''
372        hostels = grok.getSite()['hostels']
373        d['booking_session'] = hostels.accommodation_session
374        d['allowed_states'] = hostels.accommodation_states
375        d['startdate'] = hostels.startdate
376        d['enddate'] = hostels.enddate
377        d['expired'] = hostels.expired
378        # Determine bed type
379        studycourse = student['studycourse']
380        certificate = getattr(studycourse,'certificate',None)
381        current_level = studycourse.current_level
382        if None in (current_level, certificate):
383            return d
384        end_level = certificate.end_level
385        if current_level == 10:
386            bt = 'pr'
387        elif current_level == 100:
388            bt = 'fr'
389        elif current_level >= 300:
390            bt = 'fi'
391        else:
392            bt = 're'
393        if student.sex == 'f':
394            sex = 'female'
395        else:
396            sex = 'male'
397        special_handling = 'regular'
398        if certificate.study_mode == 'ug_ft':
399            special_handling = 'ugft'
400        d['bt'] = u'%s_%s_%s' % (special_handling,sex,bt)
401        return d
402
403    #def warnCreditsOOR(self, studylevel, course=None):
404    #    """Return message if credits are out of range.
405    #    """
406    #    # adding a course ticket
407    #    if course:
408    #        if course.semester == 1:
409    #            if studylevel.total_credits_s1 + course.credits > 24:
410    #                return _('Maximum credits in 1st semester exceeded.')
411    #        if course.semester == 2:
412    #            if studylevel.total_credits_s2 + course.credits > 24:
413    #                return _('Maximum credits in 2nd semester exceeded.')
414    #    # registering course list
415    #    else:
416    #        if studylevel.total_credits_s1 > 24:
417    #            return _('Maximum credits in 1st semester exceeded.')
418    #        if studylevel.total_credits_s1 < 18:
419    #            return _('Minimum credits in 1st semester not reached.')
420    #        if studylevel.total_credits_s2 > 24:
421    #            return _('Maximum credits in 2nd semester exceeded.')
422    #        if studylevel.total_credits_s2 < 18:
423    #            return _('Minimum credits in 2nd semester not reached.')
424    #    return
425
426    def warnCreditsOOR(self, studylevel, course=None):
427        """Return message if credits are out of range.
428        """
429        # adding a course ticket
430        if course:
431            if studylevel.total_credits + course.credits > 52:
432                return _('Maximum credits exceeded.')
433        # registering course list
434        else:
435            if studylevel.total_credits > 52:
436                return _('Maximum credits exceeded.')
437            if studylevel.__parent__.previous_verdict == 'O':
438                return
439            if studylevel.total_credits_s1 < 18:
440                return _('Minimum credits in 1st semester not reached.')
441            if studylevel.total_credits_s2 < 18:
442                return _('Minimum credits in 2nd semester not reached.')
443        return
444
445    def getPDFCreator(self, context):
446        """Get a pdf creator suitable for `context`.
447
448        The default implementation always returns the default creator.
449        """
450        mode = getattr(context, 'current_mode', None)
451        if mode and mode.startswith('ug'):
452            return getUtility(IPDFCreator, name='ibadan_pdfcreator')
453        return getUtility(IPDFCreator)
454
455    def _admissionText(self, student, portal_language):
456        mode = getattr(student, 'current_mode', None)
457        if mode and mode.startswith('ug'):
458            text = trans(_(
459                'With reference to your application for admission into Bachelor Degree '
460                'Programme of the University of Ibadan, this is to inform you that you have '
461                'been provisionally admitted to pursue a full-time Bachelor of Arts in '
462                'Education Degree Programme as follows:'),
463                portal_language)
464        else:
465            inst_name = grok.getSite()['configuration'].name
466            text = trans(_(
467                'This is to inform you that you have been provisionally\n'
468                'admitted into ${a}\n'
469                'as follows:', mapping = {'a': inst_name}),
470                portal_language)
471        return text
472
473    def getBedCoordinates(self, bedticket):
474        """Return bed coordinates.
475
476        Bed coordinates are invisible in FCEOkene.
477        """
478        return _('(see payment slip)')
479
480    def _isPaymentDisabled(self, p_session, category, student):
481        academic_session = self._getSessionConfiguration(p_session)
482        if category == 'schoolfee':
483            if 'sf_all' in academic_session.payment_disabled:
484                return True
485            if 'sf_nce1' in academic_session.payment_disabled and \
486                student.current_level == 100 and student.state == CLEARED and \
487                student.current_mode == 'nce_ft':
488                return True
489        if category == 'clearance':
490            if 'cl_except_ug' in academic_session.payment_disabled and \
491                student.current_mode != 'ug_ft':
492                return True
493        return False
494
495    SEPARATORS_DICT = {
496        'form.fst_sit_fname': _(u'First Sitting Record'),
497        'form.scd_sit_fname': _(u'Second Sitting Record'),
498        #'form.alr_fname': _(u'Advanced Level Record'),
499        'form.hq_type': _(u'Advanced Level Record'),
500        'form.hq2_type': _(u'Second Higher Education Record'),
501        'form.nysc_year': _(u'NYSC Information'),
502        'form.employer': _(u'Employment History'),
503        'form.former_matric': _(u'Former Student'),
504        }
505
506    SKIP_UPLOAD_VIEWLETS = (
507        'higherqualificationresultupload',
508        'secondHigherqualificationresultupload',
509        'certificateupload',
510        'secondcertificateupload',
511        'thirdcertificateupload',
512        'resultstatementupload',
513        'secondrefereeletterupload',
514        'thirdrefereeletterupload',)
515
516    # FCEOkene prefix
517    STUDENT_ID_PREFIX = u'K'
Note: See TracBrowser for help on using the repository browser.