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

Last change on this file since 18122 was 18057, checked in by Henrik Bettermann, 3 months ago

Add reg2sandwich payment category.

  • Property svn:keywords set to Id
File size: 23.9 KB
RevLine 
[7419]1## $Id: utils.py 18057 2025-04-09 10:10:39Z 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##
[7151]18import grok
[9190]19import random
[8599]20from time import time
[9950]21from zope.component import createObject, getUtility
[13800]22from waeup.kofa.interfaces import (
23    CLEARED, RETURNING, PAID, ADMITTED, CLEARANCE, REQUESTED)
[8834]24from kofacustom.nigeria.students.utils import NigeriaStudentsUtils
[8247]25from waeup.kofa.accesscodes import create_accesscode
[9143]26from waeup.kofa.interfaces import CLEARED, RETURNING
[8460]27from waeup.fceokene.interfaces import MessageFactory as _
[9950]28from waeup.kofa.browser.interfaces import IPDFCreator
[9982]29from waeup.kofa.students.utils import trans
[6902]30
[11919]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
[15594]40GATEWAY_AMT = 0.0
[15283]41
[8834]42class CustomStudentsUtils(NigeriaStudentsUtils):
[7151]43    """A collection of customized methods.
44
45    """
46
[15706]47    def selectBed(self, available_beds):
[13459]48        """Randomly select a bed from the list of available beds.
[9190]49        """
50        return random.choice(available_beds)
51
[8270]52    def getReturningData(self, student):
53        """ This method defines what happens after school fee payment
[8319]54        of returning students depending on the student's senate verdict.
[8270]55        """
[8319]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
[9923]61        elif cur_verdict in ('C','O'):
[8319]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
[9923]68        if cur_verdict == 'O':
69            new_session = student['studycourse'].current_session
70        else:
71            new_session = student['studycourse'].current_session + 1
[8270]72        return new_session, new_level
73
[16899]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
[16008]82
[9153]83    def setPaymentDetails(self, category, student,
[15678]84            previous_session=None, previous_level=None, combi=[]):
[8599]85        """Create Payment object and set the payment data of a student for
86        the payment category specified.
87
88        """
[8306]89        details = {}
[8599]90        p_item = u''
91        amount = 0.0
92        error = u''
[9153]93        if previous_session:
94            return _('Previous session payment not yet implemented.'), None
[8599]95        p_session = student['studycourse'].current_session
96        p_level = student['studycourse'].current_level
[9153]97        p_current = True
[9525]98        academic_session = self._getSessionConfiguration(p_session)
99        if academic_session == None:
[8599]100            return _(u'Session configuration object is not available.'), None
[9525]101        # Determine fee.
[7151]102        if category == 'transfer':
[8599]103            amount = academic_session.transfer_fee
[7151]104        elif category == 'gown':
[8599]105            amount = academic_session.gown_fee
[7151]106        elif category == 'bed_allocation':
[17183]107            acco_details = self.getAccommodationDetails(student)
108            p_session = acco_details['booking_session']
109            p_item = acco_details['bt']
[8599]110            amount = academic_session.booking_fee
[7151]111        elif category == 'hostel_maintenance':
[17183]112            amount = 0.0
113            booking_session = grok.getSite()['hostels'].accommodation_session
114            bedticket = student['accommodation'].get(str(booking_session), None)
[9611]115            if bedticket is not None and bedticket.bed is not None:
[17183]116                p_session = booking_session
[9611]117                p_item = bedticket.bed_coordinates
[17629]118                if bedticket.bed.__parent__.maint_fee > 0:
119                    amount = bedticket.bed.__parent__.maint_fee
120                #if student['studycourse'].current_session < 2022:
121                #    amount = 6100.0
122                #else:
123                #    amount = 10090.0
[9611]124            else:
[13616]125                return _(u'No bed space allocated.'), None
126            if student.current_mode.endswith('_sw') \
127                or student.current_mode == 'pd_ft':
128                amount *= 0.625
[7151]129        elif category == 'clearance':
[9143]130            amount = academic_session.clearance_fee
[8599]131            try:
132                p_item = student['studycourse'].certificate.code
133            except (AttributeError, TypeError):
134                return _('Study course data are incomplete.'), None
[13800]135            if student.state not in (ADMITTED, CLEARANCE, REQUESTED, CLEARED):
136                return _(u'Acceptance Fee payments not allowed.'), None
[16899]137        #elif category == 'third_semester' and student.current_mode == 'nce_ft' \
138        #    and p_level in (300, 310, 320, 400, 410, 420):
139        #    #if not self._nce3PaymentMade(student, p_level):
140        #    #    return _(u'Make NCE 3 school fee payment first.'), None
141        #    no_additional_courses = 0
142        #    courses_level = student['studycourse'].get(str(p_level))
143        #    if courses_level and len(courses_level)> 6:
144        #        no_additional_courses = len(courses_level)-6
145        #        amount = 2000.0 * no_additional_courses
[18057]146        elif category == 'reg2sandwich':
147            amount = 40000.0
[16461]148        elif category.startswith('schoolfee'):
[17493]149            increment_2022 = 0
[16461]150            if category == 'schoolfee_pde1':
[16462]151                if not student.current_mode.startswith('pd'):
152                    return _('You are not a PDE student.'), None
[16461]153                if student.state != CLEARED:
154                        return _('You are not a fresh student.'), None
[17734]155            if category == 'schoolfee_ug_new':
156                if not student.current_mode.startswith('ug'):
157                    return _('You are not a UG student.'), None
158                if student.state != CLEARED:
159                        return _('You are not a fresh student.'), None
160            if category == 'schoolfee_ug_ret':
161                if not student.current_mode.startswith('ug'):
162                    return _('You are not a UG student.'), None
163                if student.state != RETURNING:
164                        return _('You are not a returning student.'), None
[16899]165            if category == 'schoolfee_third':
166                if not student.current_mode == 'nce_ft' \
167                    or not p_level in (300, 310, 320, 400, 410, 420):
168                    return _('You are not an NCE 3 student.'), None
[12602]169            p_item =  student.certcode
170            if not p_item:
[8599]171                return _('Study course data are incomplete.'), None
[10012]172            if student.state not in (CLEARED, RETURNING):
173                return _('Wrong state.'), None
[10661]174            # PDE repeater
175            if student.current_verdict == 'OPDE':
[18052]176                amount = 30000
[13274]177            # PDE new
178            elif student.current_mode == 'pd_ft' and student.state == CLEARED:
[18052]179                amount = 90000
[16461]180                if category == 'schoolfee_pde1':
181                    amount = 40000
[10660]182            # PDE
183            elif student.current_mode == 'pd_ft':
[13275]184                amount = 35300
[12602]185
186            #Short Duration ICT Programs
187            elif p_item in ('CCO','DPMTS','DTPGD') and \
188                 student.state == CLEARED:
189                amount = 15000
190            elif p_item in ('ADTPGD','ADPMTS') and \
191                 student.state == CLEARED:
192                amount = 16000
193            elif p_item in ('ADPMTSI','ADTPGDI','DPMTSI','DTPGDI') and \
194                 student.state == CLEARED:
195                amount = 25000
196            elif p_item in ('ADPMTSA','ADTPGDA') and \
197               student.state == CLEARED:
198                amount = 35000
199
[10012]200            # UG
201            elif student.current_mode == 'ug_ft':
[17734]202                if category == 'schoolfee_ug_new':
203                    # conditions checked above
[17983]204                    amount = 80000
[17734]205                elif category == 'schoolfee_ug_ret':
206                    # conditions checked above
[17983]207                    amount = 60000
[17734]208                elif student.state == CLEARED:
[17983]209                    amount = 140000
[13779]210                # Introducing repeater fee for 'ug_ft' for 1st time
211                # on 15/03/2016
[17734]212                #elif student.current_verdict == 'O':
213                #    amount = 96700
[10876]214                else:
[17983]215                    amount = 110000
216
[10012]217            # NCE
[9143]218            elif not student.current_mode.endswith('_sw'):
[17113]219                # in 2022 NCE school fees have encreased
220                increment_2022 = 11000
[9143]221                # PRENCE
222                if student.current_level == 10 and student.state == CLEARED:
223                    if student.depcode in ARTS:
[14933]224                        amount = 24500
[9143]225                    else:
[14933]226                        amount = 25000
[10012]227                # NCE I fresh
[9143]228                elif student.current_level == 100 and student.state == CLEARED:
229                    if student.depcode in ARTS:
[15283]230                        amount = 28000
[9143]231                    else:
[15283]232                        amount = 28500
[14931]233                    # SIWES Fee
[16542]234                    if student.depcode in ('AGE', 'BED', 'FAA', 'HEC', 'CSC', 'MUS') \
[17087]235                       or student.certcode in ('NCECHECSC',
236                                               'NCEBIOCSC',
237                                               'NCEPHYCSC',
238                                               'NCEPHECSC',
239                                               'NCETHAMUS',
240                                               'NCEANFMUS',
241                                               'NCEHISMUS',
242                                               'NCEIGBMUS',
243                                               'NCESPCCSC',
244                                               ):
[14931]245                        amount += 3000
[10012]246                # NCE II
[9143]247                elif student.current_level in (100, 110, 120) and \
248                    student.state == RETURNING:
249                    if student.depcode in ARTS:
[15283]250                        amount = 24500
[9143]251                    else:
[15283]252                        amount = 25000
[16899]253                # NCE III third semester
254                elif category == 'schoolfee_third':
[18052]255                    amount = 18000
[17706]256                    increment_2022 = 0
[10012]257                # NCE III
[9143]258                elif student.current_level in (200, 210, 220):
259                    if student.depcode in ARTS:
[14931]260                        amount = 15375
[9143]261                    else:
[14931]262                        amount = 15875
[17113]263                    increment_2022 = 20125
[10012]264                # NCE III repeater
[9143]265                elif student.current_level in (300, 310, 320) and \
266                    student.current_verdict == 'O':
267                    if student.depcode in ARTS:
[14931]268                        amount = 13475
[9143]269                    else:
[14931]270                        amount = 13975
[17499]271                    increment_2022 = 11000
[10012]272                # NCE III spillover
[9143]273                elif student.current_level in (300, 310, 320) and \
274                    student.current_verdict == 'B':
275                    if student.depcode in ARTS:
[14931]276                        amount = 13475
[9143]277                    else:
[14931]278                        amount = 13975
[17113]279                    increment_2022 = 20125
[10012]280                # NCE III second spillover
[9143]281                elif student.current_level in (400, 410, 420) and \
282                    student.current_verdict == 'B':
283                    if student.depcode in ARTS:
[14931]284                        amount = 13475
[9143]285                    else:
[14931]286                        amount = 13975
[17113]287                    increment_2022 = 20125
[9143]288            else:
[14265]289                # NCE I fresh sw
[9143]290                if student.current_level == 100 and student.state == CLEARED:
291                    if student.depcode in ARTS:
[14193]292                        amount = 23100
[9143]293                    else:
[14193]294                        amount = 23600
[14265]295                # NCE II fresh sw
296                elif student.current_level == 200 and student.state == CLEARED:
297                    if student.depcode in ARTS:
298                        amount = 19000
299                    else:
300                        amount = 19500
[10012]301                # NCE II sw
[9143]302                elif student.current_level in (100, 110, 120) and \
303                    student.state == RETURNING:
304                    if student.depcode in ARTS:
[11850]305                        amount = 19000
[9143]306                    else:
[11882]307                        amount = 19500
[10012]308                # NCE III sw
[9143]309                elif student.current_level in (200, 210, 220):
310                    if student.depcode in ARTS:
[11850]311                        amount = 21000
[9143]312                    else:
[14193]313                        amount = 21500
[10012]314                # NCE IV sw
[9143]315                elif student.current_level in (300, 310, 320):
316                    if student.depcode in ARTS:
[11850]317                        amount = 19000
[9143]318                    else:
[11850]319                        amount = 19500
[10012]320                # NCE V sw
[9143]321                elif student.current_level in (400, 410, 420):
322                    if student.depcode in ARTS:
[11850]323                        amount = 19000
[9143]324                    else:
[11850]325                        amount = 19500
[10012]326                # NCE V spillover sw
[9143]327                elif student.current_level in (500, 510, 520) and \
328                    student.current_verdict == 'B':
329                    if student.depcode in ARTS:
[11850]330                        amount = 17500
[9143]331                    else:
[11850]332                        amount = 18000
[10012]333                # NCE V second spillover sw
[9143]334                elif student.current_level in (600, 610, 620) and \
335                    student.current_verdict == 'B':
336                    if student.depcode in ARTS:
[16921]337                        amount = 17500
[9143]338                    else:
[16921]339                        amount = 18000
[10009]340            # NCE student payment can be disabled by
341            # setting the base school fee to -1
342            if academic_session.school_fee_base == -1 and \
343                student.current_mode.startswith('nce'):
[10010]344                return _(u'School fee payment is disabled.'), None
[9297]345            if student.state == RETURNING:
[9525]346                # Override p_session and p_level
[9297]347                p_session, p_level = self.getReturningData(student)
[9525]348                academic_session = self._getSessionConfiguration(p_session)
349                if academic_session == None:
350                    return _(u'Session configuration object is not available.'), None
[17501]351            if amount and p_session > 2021:
[17493]352                    amount += increment_2022
[17087]353        else:
354            fee_name = category + '_fee'
355            amount = getattr(academic_session, fee_name, 0.0)
356           
[8599]357        if amount in (0.0, None):
358            return _(u'Amount could not be determined.'), None
[14566]359
360        # Add session and level specific penalty fee.
[13881]361        if category == 'schoolfee' and student.current_mode in (
[14617]362            'ug_ft', 'de_ft') and student.state != CLEARED:
[13881]363            amount += academic_session.penalty_ug_ft
364        elif category == 'schoolfee' and student.current_mode in (
[14556]365            'nce_ft',) and student['studycourse'].previous_verdict != 'O':
[14566]366            # NCE I fresh
367            if student.current_level == 100 and student.state == CLEARED:
368                amount += academic_session.penalty_nce1_ft
369            # NCE II
370            elif student.current_level in (100, 110, 120) and \
371                student.state == RETURNING:
372                amount += academic_session.penalty_nce2_ft
373            # NCE III (except repeaters and spillovers)
374            elif student.current_level in (200, 210, 220):
375                amount += academic_session.penalty_nce3_ft
[14618]376        elif category == 'schoolfee' and student.current_mode in ('nce_sw',
377            'nce_pt') and student['studycourse'].previous_verdict != 'O':
[14566]378            # NCE I fresh
379            if student.current_level == 100 and student.state == CLEARED:
380                amount += academic_session.penalty_nce1_pt
381            # NCE II
382            elif student.current_level in (100, 110, 120) and \
383                student.state == RETURNING:
384                amount += academic_session.penalty_nce2_pt
385            # NCE III (except repeaters and spillovers)
386            elif student.current_level in (200, 210, 220):
387                amount += academic_session.penalty_nce3_pt
[13881]388        elif category == 'schoolfee' and student.current_mode in ('prence',):
389            amount += academic_session.penalty_prence
[11649]390        if self.samePaymentMade(student, category, p_item, p_session):
391            return _('This type of payment has already been made.'), None
[11457]392        if self._isPaymentDisabled(p_session, category, student):
[13800]393            return _('This category of payments has been disabled.'), None
[8713]394        payment = createObject(u'waeup.StudentOnlinePayment')
[8953]395        timestamp = ("%d" % int(time()*10000))[1:]
[8599]396        payment.p_id = "p%s" % timestamp
397        payment.p_category = category
398        payment.p_item = p_item
399        payment.p_session = p_session
400        payment.p_level = p_level
[9153]401        payment.p_current = p_current
[10388]402        payment.amount_auth = float(amount) + GATEWAY_AMT
[8599]403        return None, payment
[7621]404
[9207]405    def getAccommodationDetails(self, student):
406        """Determine the accommodation data of a student.
407        """
408        d = {}
409        d['error'] = u''
410        hostels = grok.getSite()['hostels']
411        d['booking_session'] = hostels.accommodation_session
412        d['allowed_states'] = hostels.accommodation_states
413        d['startdate'] = hostels.startdate
414        d['enddate'] = hostels.enddate
415        d['expired'] = hostels.expired
416        # Determine bed type
417        studycourse = student['studycourse']
418        certificate = getattr(studycourse,'certificate',None)
419        current_level = studycourse.current_level
420        if None in (current_level, certificate):
421            return d
422        end_level = certificate.end_level
423        if current_level == 10:
424            bt = 'pr'
425        elif current_level == 100:
426            bt = 'fr'
427        elif current_level >= 300:
428            bt = 'fi'
429        else:
430            bt = 're'
431        if student.sex == 'f':
432            sex = 'female'
433        else:
434            sex = 'male'
435        special_handling = 'regular'
[13614]436        if certificate.study_mode == 'ug_ft':
437            special_handling = 'ugft'
[9207]438        d['bt'] = u'%s_%s_%s' % (special_handling,sex,bt)
439        return d
440
[14617]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 course.semester == 1:
447    #            if studylevel.total_credits_s1 + course.credits > 24:
448    #                return _('Maximum credits in 1st semester exceeded.')
449    #        if course.semester == 2:
450    #            if studylevel.total_credits_s2 + course.credits > 24:
451    #                return _('Maximum credits in 2nd semester exceeded.')
452    #    # registering course list
453    #    else:
454    #        if studylevel.total_credits_s1 > 24:
455    #            return _('Maximum credits in 1st semester exceeded.')
456    #        if studylevel.total_credits_s1 < 18:
457    #            return _('Minimum credits in 1st semester not reached.')
458    #        if studylevel.total_credits_s2 > 24:
459    #            return _('Maximum credits in 2nd semester exceeded.')
460    #        if studylevel.total_credits_s2 < 18:
461    #            return _('Minimum credits in 2nd semester not reached.')
462    #    return
463
[14586]464    def warnCreditsOOR(self, studylevel, course=None):
[14591]465        """Return message if credits are out of range.
[9903]466        """
[14591]467        # adding a course ticket
468        if course:
[14617]469            if studylevel.total_credits + course.credits > 52:
470                return _('Maximum credits exceeded.')
[14591]471        # registering course list
472        else:
[14617]473            if studylevel.total_credits > 52:
474                return _('Maximum credits exceeded.')
[14618]475            if studylevel.__parent__.previous_verdict == 'O':
476                return
[14591]477            if studylevel.total_credits_s1 < 18:
478                return _('Minimum credits in 1st semester not reached.')
479            if studylevel.total_credits_s2 < 18:
480                return _('Minimum credits in 2nd semester not reached.')
[14586]481        return
[9903]482
[9950]483    def getPDFCreator(self, context):
484        """Get a pdf creator suitable for `context`.
485
486        The default implementation always returns the default creator.
487        """
488        mode = getattr(context, 'current_mode', None)
489        if mode and mode.startswith('ug'):
490            return getUtility(IPDFCreator, name='ibadan_pdfcreator')
491        return getUtility(IPDFCreator)
492
[9982]493    def _admissionText(self, student, portal_language):
494        mode = getattr(student, 'current_mode', None)
495        if mode and mode.startswith('ug'):
496            text = trans(_(
[17576]497                'With reference to your application for admission into '
498                'Bachelor Degree Programme of the University of Ibadan, '
499                'you have been provisionally admitted to a full-time '
500                'Bachelor of Arts in Education Degree Programme as follows: '),
[9982]501                portal_language)
502        else:
503            inst_name = grok.getSite()['configuration'].name
504            text = trans(_(
[17576]505                'You have been provisionally admitted into Federal College '
506                'of Education Okene as follows: '
[17577]507                ),
[9982]508                portal_language)
509        return text
510
[9989]511    def getBedCoordinates(self, bedticket):
512        """Return bed coordinates.
513
514        Bed coordinates are invisible in FCEOkene.
515        """
516        return _('(see payment slip)')
517
[13030]518    def _isPaymentDisabled(self, p_session, category, student):
519        academic_session = self._getSessionConfiguration(p_session)
520        if category == 'schoolfee':
521            if 'sf_all' in academic_session.payment_disabled:
522                return True
523            if 'sf_nce1' in academic_session.payment_disabled and \
524                student.current_level == 100 and student.state == CLEARED and \
525                student.current_mode == 'nce_ft':
526                return True
[16554]527        if category == 'clearance':
528            if 'cl_except_ug' in academic_session.payment_disabled and \
529                student.current_mode != 'ug_ft':
530                return True
[13030]531        return False
532
[10019]533    SEPARATORS_DICT = {
534        'form.fst_sit_fname': _(u'First Sitting Record'),
535        'form.scd_sit_fname': _(u'Second Sitting Record'),
536        #'form.alr_fname': _(u'Advanced Level Record'),
537        'form.hq_type': _(u'Advanced Level Record'),
538        'form.hq2_type': _(u'Second Higher Education Record'),
539        'form.nysc_year': _(u'NYSC Information'),
540        'form.employer': _(u'Employment History'),
541        'form.former_matric': _(u'Former Student'),
542        }
543
[10023]544    SKIP_UPLOAD_VIEWLETS = (
545        'higherqualificationresultupload',
546        'secondHigherqualificationresultupload',
547        'certificateupload',
548        'secondcertificateupload',
549        'thirdcertificateupload',
550        'resultstatementupload',
551        'secondrefereeletterupload',
552        'thirdrefereeletterupload',)
553
[17178]554    ACCOMMODATION_SPAN = 1
555
[8460]556    # FCEOkene prefix
[10520]557    STUDENT_ID_PREFIX = u'K'
Note: See TracBrowser for help on using the repository browser.