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

Last change on this file since 17183 was 17183, checked in by Henrik Bettermann, 22 months ago

Adjust to changes in base package.
  • Property svn:keywords set to Id
File size: 22.9 KB
Line 
1## $Id: utils.py 17183 2022-11-30 14:35:10Z 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            acco_details = self.getAccommodationDetails(student)
108            p_session = acco_details['booking_session']
109            p_item = acco_details['bt']
110            amount = academic_session.booking_fee
111        elif category == 'hostel_maintenance':
112            amount = 0.0
113            booking_session = grok.getSite()['hostels'].accommodation_session
114            bedticket = student['accommodation'].get(str(booking_session), None)
115            if bedticket is not None and bedticket.bed is not None:
116                p_session = booking_session
117                p_item = bedticket.bed_coordinates
118                if bedticket.bed.__parent__.maint_fee > 0:
119                    amount = bedticket.bed.__parent__.maint_fee
120            else:
121                return _(u'No bed space allocated.'), None
122            if student.current_mode.endswith('_sw') \
123                or student.current_mode == 'pd_ft':
124                amount *= 0.625
125        elif category == 'clearance':
126            amount = academic_session.clearance_fee
127            try:
128                p_item = student['studycourse'].certificate.code
129            except (AttributeError, TypeError):
130                return _('Study course data are incomplete.'), None
131            if student.state not in (ADMITTED, CLEARANCE, REQUESTED, CLEARED):
132                return _(u'Acceptance Fee payments not allowed.'), None
133        #elif category == 'third_semester' and student.current_mode == 'nce_ft' \
134        #    and p_level in (300, 310, 320, 400, 410, 420):
135        #    #if not self._nce3PaymentMade(student, p_level):
136        #    #    return _(u'Make NCE 3 school fee payment first.'), None
137        #    no_additional_courses = 0
138        #    courses_level = student['studycourse'].get(str(p_level))
139        #    if courses_level and len(courses_level)> 6:
140        #        no_additional_courses = len(courses_level)-6
141        #        amount = 2000.0 * no_additional_courses
142        elif category.startswith('schoolfee'):
143            if category == 'schoolfee_pde1':
144                if not student.current_mode.startswith('pd'):
145                    return _('You are not a PDE student.'), None
146                if student.state != CLEARED:
147                        return _('You are not a fresh student.'), None
148            if category == 'schoolfee_third':
149                if not student.current_mode == 'nce_ft' \
150                    or not p_level in (300, 310, 320, 400, 410, 420):
151                    return _('You are not an NCE 3 student.'), None
152            p_item =  student.certcode
153            if not p_item:
154                return _('Study course data are incomplete.'), None
155            if student.state not in (CLEARED, RETURNING):
156                return _('Wrong state.'), None
157            # PDE repeater
158            if student.current_verdict == 'OPDE':
159                amount = 23000
160            # PDE new
161            elif student.current_mode == 'pd_ft' and student.state == CLEARED:
162                amount = 70000
163                if category == 'schoolfee_pde1':
164                    amount = 40000
165            # PDE
166            elif student.current_mode == 'pd_ft':
167                amount = 35300
168
169            #Short Duration ICT Programs
170            elif p_item in ('CCO','DPMTS','DTPGD') and \
171                 student.state == CLEARED:
172                amount = 15000
173            elif p_item in ('ADTPGD','ADPMTS') and \
174                 student.state == CLEARED:
175                amount = 16000
176            elif p_item in ('ADPMTSI','ADTPGDI','DPMTSI','DTPGDI') and \
177                 student.state == CLEARED:
178                amount = 25000
179            elif p_item in ('ADPMTSA','ADTPGDA') and \
180               student.state == CLEARED:
181                amount = 35000
182
183            # UG
184            elif student.current_mode == 'ug_ft':
185                if student.state == CLEARED:
186                    amount = 87200
187                # Introducing repeater fee for 'ug_ft' for 1st time
188                # on 15/03/2016
189                elif student.current_verdict == 'O':
190                    amount = 70700
191                else:
192                    amount = 70700
193            # NCE
194            elif not student.current_mode.endswith('_sw'):
195                # in 2022 NCE school fees have encreased
196                increment_2022 = 11000
197                # PRENCE
198                if student.current_level == 10 and student.state == CLEARED:
199                    if student.depcode in ARTS:
200                        amount = 24500
201                    else:
202                        amount = 25000
203                # NCE I fresh
204                elif student.current_level == 100 and student.state == CLEARED:
205                    if student.depcode in ARTS:
206                        amount = 28000
207                    else:
208                        amount = 28500
209                    # SIWES Fee
210                    if student.depcode in ('AGE', 'BED', 'FAA', 'HEC', 'CSC', 'MUS') \
211                       or student.certcode in ('NCECHECSC',
212                                               'NCEBIOCSC',
213                                               'NCEPHYCSC',
214                                               'NCEPHECSC',
215                                               'NCETHAMUS',
216                                               'NCEANFMUS',
217                                               'NCEHISMUS',
218                                               'NCEIGBMUS',
219                                               'NCESPCCSC',
220                                               ):
221                        amount += 3000
222                # NCE II
223                elif student.current_level in (100, 110, 120) and \
224                    student.state == RETURNING:
225                    if student.depcode in ARTS:
226                        amount = 24500
227                    else:
228                        amount = 25000
229                # NCE III third semester
230                elif category == 'schoolfee_third':
231                    amount = 7000
232                    increment_2022 = 20125
233                # NCE III
234                elif student.current_level in (200, 210, 220):
235                    if student.depcode in ARTS:
236                        amount = 15375
237                    else:
238                        amount = 15875
239                    increment_2022 = 20125
240                # NCE III repeater
241                elif student.current_level in (300, 310, 320) and \
242                    student.current_verdict == 'O':
243                    if student.depcode in ARTS:
244                        amount = 13475
245                    else:
246                        amount = 13975
247                    increment_2022 = 20125
248                # NCE III spillover
249                elif student.current_level in (300, 310, 320) and \
250                    student.current_verdict == 'B':
251                    if student.depcode in ARTS:
252                        amount = 13475
253                    else:
254                        amount = 13975
255                    increment_2022 = 20125
256                # NCE III second spillover
257                elif student.current_level in (400, 410, 420) and \
258                    student.current_verdict == 'B':
259                    if student.depcode in ARTS:
260                        amount = 13475
261                    else:
262                        amount = 13975
263                    increment_2022 = 20125
264               
265                if student.entry_session > 2021:
266                    amount += increment_2022
267            else:
268                # NCE I fresh sw
269                if student.current_level == 100 and student.state == CLEARED:
270                    if student.depcode in ARTS:
271                        amount = 23100
272                    else:
273                        amount = 23600
274                # NCE II fresh sw
275                elif student.current_level == 200 and student.state == CLEARED:
276                    if student.depcode in ARTS:
277                        amount = 19000
278                    else:
279                        amount = 19500
280                # NCE II sw
281                elif student.current_level in (100, 110, 120) and \
282                    student.state == RETURNING:
283                    if student.depcode in ARTS:
284                        amount = 19000
285                    else:
286                        amount = 19500
287                # NCE III sw
288                elif student.current_level in (200, 210, 220):
289                    if student.depcode in ARTS:
290                        amount = 21000
291                    else:
292                        amount = 21500
293                # NCE IV sw
294                elif student.current_level in (300, 310, 320):
295                    if student.depcode in ARTS:
296                        amount = 19000
297                    else:
298                        amount = 19500
299                # NCE V sw
300                elif student.current_level in (400, 410, 420):
301                    if student.depcode in ARTS:
302                        amount = 19000
303                    else:
304                        amount = 19500
305                # NCE V spillover sw
306                elif student.current_level in (500, 510, 520) and \
307                    student.current_verdict == 'B':
308                    if student.depcode in ARTS:
309                        amount = 17500
310                    else:
311                        amount = 18000
312                # NCE V second spillover sw
313                elif student.current_level in (600, 610, 620) and \
314                    student.current_verdict == 'B':
315                    if student.depcode in ARTS:
316                        amount = 17500
317                    else:
318                        amount = 18000
319            # NCE student payment can be disabled by
320            # setting the base school fee to -1
321            if academic_session.school_fee_base == -1 and \
322                student.current_mode.startswith('nce'):
323                return _(u'School fee payment is disabled.'), None
324            if student.state == RETURNING:
325                # Override p_session and p_level
326                p_session, p_level = self.getReturningData(student)
327                academic_session = self._getSessionConfiguration(p_session)
328                if academic_session == None:
329                    return _(u'Session configuration object is not available.'), None
330        else:
331            fee_name = category + '_fee'
332            amount = getattr(academic_session, fee_name, 0.0)
333           
334        if amount in (0.0, None):
335            return _(u'Amount could not be determined.'), None
336
337        # Add session and level specific penalty fee.
338        if category == 'schoolfee' and student.current_mode in (
339            'ug_ft', 'de_ft') and student.state != CLEARED:
340            amount += academic_session.penalty_ug_ft
341        elif category == 'schoolfee' and student.current_mode in (
342            'nce_ft',) and student['studycourse'].previous_verdict != 'O':
343            # NCE I fresh
344            if student.current_level == 100 and student.state == CLEARED:
345                amount += academic_session.penalty_nce1_ft
346            # NCE II
347            elif student.current_level in (100, 110, 120) and \
348                student.state == RETURNING:
349                amount += academic_session.penalty_nce2_ft
350            # NCE III (except repeaters and spillovers)
351            elif student.current_level in (200, 210, 220):
352                amount += academic_session.penalty_nce3_ft
353        elif category == 'schoolfee' and student.current_mode in ('nce_sw',
354            'nce_pt') and student['studycourse'].previous_verdict != 'O':
355            # NCE I fresh
356            if student.current_level == 100 and student.state == CLEARED:
357                amount += academic_session.penalty_nce1_pt
358            # NCE II
359            elif student.current_level in (100, 110, 120) and \
360                student.state == RETURNING:
361                amount += academic_session.penalty_nce2_pt
362            # NCE III (except repeaters and spillovers)
363            elif student.current_level in (200, 210, 220):
364                amount += academic_session.penalty_nce3_pt
365        elif category == 'schoolfee' and student.current_mode in ('prence',):
366            amount += academic_session.penalty_prence
367        if self.samePaymentMade(student, category, p_item, p_session):
368            return _('This type of payment has already been made.'), None
369        if self._isPaymentDisabled(p_session, category, student):
370            return _('This category of payments has been disabled.'), None
371        payment = createObject(u'waeup.StudentOnlinePayment')
372        timestamp = ("%d" % int(time()*10000))[1:]
373        payment.p_id = "p%s" % timestamp
374        payment.p_category = category
375        payment.p_item = p_item
376        payment.p_session = p_session
377        payment.p_level = p_level
378        payment.p_current = p_current
379        payment.amount_auth = float(amount) + GATEWAY_AMT
380        return None, payment
381
382    def getAccommodationDetails(self, student):
383        """Determine the accommodation data of a student.
384        """
385        d = {}
386        d['error'] = u''
387        hostels = grok.getSite()['hostels']
388        d['booking_session'] = hostels.accommodation_session
389        d['allowed_states'] = hostels.accommodation_states
390        d['startdate'] = hostels.startdate
391        d['enddate'] = hostels.enddate
392        d['expired'] = hostels.expired
393        # Determine bed type
394        studycourse = student['studycourse']
395        certificate = getattr(studycourse,'certificate',None)
396        current_level = studycourse.current_level
397        if None in (current_level, certificate):
398            return d
399        end_level = certificate.end_level
400        if current_level == 10:
401            bt = 'pr'
402        elif current_level == 100:
403            bt = 'fr'
404        elif current_level >= 300:
405            bt = 'fi'
406        else:
407            bt = 're'
408        if student.sex == 'f':
409            sex = 'female'
410        else:
411            sex = 'male'
412        special_handling = 'regular'
413        if certificate.study_mode == 'ug_ft':
414            special_handling = 'ugft'
415        d['bt'] = u'%s_%s_%s' % (special_handling,sex,bt)
416        return d
417
418    #def warnCreditsOOR(self, studylevel, course=None):
419    #    """Return message if credits are out of range.
420    #    """
421    #    # adding a course ticket
422    #    if course:
423    #        if course.semester == 1:
424    #            if studylevel.total_credits_s1 + course.credits > 24:
425    #                return _('Maximum credits in 1st semester exceeded.')
426    #        if course.semester == 2:
427    #            if studylevel.total_credits_s2 + course.credits > 24:
428    #                return _('Maximum credits in 2nd semester exceeded.')
429    #    # registering course list
430    #    else:
431    #        if studylevel.total_credits_s1 > 24:
432    #            return _('Maximum credits in 1st semester exceeded.')
433    #        if studylevel.total_credits_s1 < 18:
434    #            return _('Minimum credits in 1st semester not reached.')
435    #        if studylevel.total_credits_s2 > 24:
436    #            return _('Maximum credits in 2nd semester exceeded.')
437    #        if studylevel.total_credits_s2 < 18:
438    #            return _('Minimum credits in 2nd semester not reached.')
439    #    return
440
441    def warnCreditsOOR(self, studylevel, course=None):
442        """Return message if credits are out of range.
443        """
444        # adding a course ticket
445        if course:
446            if studylevel.total_credits + course.credits > 52:
447                return _('Maximum credits exceeded.')
448        # registering course list
449        else:
450            if studylevel.total_credits > 52:
451                return _('Maximum credits exceeded.')
452            if studylevel.__parent__.previous_verdict == 'O':
453                return
454            if studylevel.total_credits_s1 < 18:
455                return _('Minimum credits in 1st semester not reached.')
456            if studylevel.total_credits_s2 < 18:
457                return _('Minimum credits in 2nd semester not reached.')
458        return
459
460    def getPDFCreator(self, context):
461        """Get a pdf creator suitable for `context`.
462
463        The default implementation always returns the default creator.
464        """
465        mode = getattr(context, 'current_mode', None)
466        if mode and mode.startswith('ug'):
467            return getUtility(IPDFCreator, name='ibadan_pdfcreator')
468        return getUtility(IPDFCreator)
469
470    def _admissionText(self, student, portal_language):
471        mode = getattr(student, 'current_mode', None)
472        if mode and mode.startswith('ug'):
473            text = trans(_(
474                'With reference to your application for admission into Bachelor Degree '
475                'Programme of the University of Ibadan, this is to inform you that you have '
476                'been provisionally admitted to pursue a full-time Bachelor of Arts in '
477                'Education Degree Programme as follows:'),
478                portal_language)
479        else:
480            inst_name = grok.getSite()['configuration'].name
481            text = trans(_(
482                'This is to inform you that you have been provisionally\n'
483                'admitted into ${a}\n'
484                'as follows:', mapping = {'a': inst_name}),
485                portal_language)
486        return text
487
488    def getBedCoordinates(self, bedticket):
489        """Return bed coordinates.
490
491        Bed coordinates are invisible in FCEOkene.
492        """
493        return _('(see payment slip)')
494
495    def _isPaymentDisabled(self, p_session, category, student):
496        academic_session = self._getSessionConfiguration(p_session)
497        if category == 'schoolfee':
498            if 'sf_all' in academic_session.payment_disabled:
499                return True
500            if 'sf_nce1' in academic_session.payment_disabled and \
501                student.current_level == 100 and student.state == CLEARED and \
502                student.current_mode == 'nce_ft':
503                return True
504        if category == 'clearance':
505            if 'cl_except_ug' in academic_session.payment_disabled and \
506                student.current_mode != 'ug_ft':
507                return True
508        return False
509
510    SEPARATORS_DICT = {
511        'form.fst_sit_fname': _(u'First Sitting Record'),
512        'form.scd_sit_fname': _(u'Second Sitting Record'),
513        #'form.alr_fname': _(u'Advanced Level Record'),
514        'form.hq_type': _(u'Advanced Level Record'),
515        'form.hq2_type': _(u'Second Higher Education Record'),
516        'form.nysc_year': _(u'NYSC Information'),
517        'form.employer': _(u'Employment History'),
518        'form.former_matric': _(u'Former Student'),
519        }
520
521    SKIP_UPLOAD_VIEWLETS = (
522        'higherqualificationresultupload',
523        'secondHigherqualificationresultupload',
524        'certificateupload',
525        'secondcertificateupload',
526        'thirdcertificateupload',
527        'resultstatementupload',
528        'secondrefereeletterupload',
529        'thirdrefereeletterupload',)
530
531    ACCOMMODATION_SPAN = 1
532
533    # FCEOkene prefix
534    STUDENT_ID_PREFIX = u'K'
Note: See TracBrowser for help on using the repository browser.