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

Last change on this file since 16161 was 16011, checked in by Henrik Bettermann, 5 years ago

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