source: main/kofacustom.dspg/trunk/src/kofacustom/dspg/students/utils.py @ 16738

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

Change acceptance fee computation algorithm.
  • Property svn:keywords set to Id
File size: 18.0 KB
Line 
1## $Id: utils.py 16738 2021-12-10 13:54:16Z 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
19from time import time
20from zope.component import createObject, getUtility
21from waeup.kofa.interfaces import (IKofaUtils,
22    ADMITTED, CLEARED, RETURNING, PAID, REGISTERED, VALIDATED)
23from kofacustom.nigeria.students.utils import NigeriaStudentsUtils
24from kofacustom.dspg.interfaces import MessageFactory as _
25
26MICROSOFT_FEE = 0.0
27
28def local(student):
29    lga = getattr(student, 'lga')
30    if lga and lga.startswith('delta'):
31        return True
32    return False
33
34class CustomStudentsUtils(NigeriaStudentsUtils):
35    """A collection of customized methods.
36    """
37
38    # prefix
39    STUDENT_ID_PREFIX = u'P'
40
41    def _dep_sug_gns_paymentMade(self, student, session):
42        if student.state == RETURNING:
43            session += 1
44        dep_sug = False
45        gns = False
46        if len(student['payments']):
47            for ticket in student['payments'].values():
48                if ticket.p_state == 'paid' and \
49                    ticket.p_category == 'dep_sug' and \
50                    ticket.p_session == session:
51                    dep_sug = True
52                if ticket.p_state == 'paid' and \
53                    ticket.p_category.startswith('gns') and \
54                    ticket.p_session == session:
55                    gns = True
56                if dep_sug and gns:
57                    return True
58        return False
59
60    def _lsfp_penalty_paymentMade(self, student, session):
61        if student.current_mode not in ('hnd_ft', 'nd_ft'):
62            return True
63        if len(student['payments']):
64            for ticket in student['payments'].values():
65                if ticket.p_state == 'paid' and \
66                    ticket.p_category == 'lsfp_penalty' and \
67                    ticket.p_session == session:
68                    return True
69        return False
70
71    def getAccommodationDetails(self, student):
72        """Determine the accommodation data of a student.
73        """
74        d = {}
75        d['error'] = u''
76        hostels = grok.getSite()['hostels']
77        d['booking_session'] = hostels.accommodation_session
78        d['allowed_states'] = hostels.accommodation_states
79        d['startdate'] = hostels.startdate
80        d['enddate'] = hostels.enddate
81        d['expired'] = hostels.expired
82        # Determine bed type
83        bt = 'all'
84        if student.sex == 'f':
85            sex = 'female'
86        else:
87            sex = 'male'
88        special_handling = 'regular'
89        d['bt'] = u'%s_%s_%s' % (special_handling,sex,bt)
90        return d
91
92    def getBedCoordinates(self, bedticket):
93        """Translated coordinates:
94
95        Hall Name, Block Letter, Room Number, Bed Letter =
96        Hall Name, M/F + Room Number-100, Bed Letter
97
98        Requirements: Gender must be part of bed_coordinates and all hostels
99        have only one block with only one floor
100        """
101        ### ToDo
102        return bedticket.bed_coordinates
103
104    def getReturningData(self, student):
105        """ This method defines what happens after school fee payment
106        of returning students depending on the student's senate verdict.
107        """
108        prev_level = student['studycourse'].current_level
109        cur_verdict = student['studycourse'].current_verdict
110        if cur_verdict in ('A','B','L','M','N','Z',):
111            # Successful student
112            new_level = divmod(int(prev_level),100)[0]*100 + 100
113        elif cur_verdict == 'C':
114            # Student on probation
115            new_level = int(prev_level) + 10
116        else:
117            # Student is somehow in an undefined state.
118            # Level has to be set manually.
119            new_level = prev_level
120        new_session = student['studycourse'].current_session + 1
121        return new_session, new_level
122
123    def setPaymentDetails(self, category, student,
124            previous_session=None, previous_level=None, combi=[]):
125        """Create a payment ticket and set the payment data of a
126        student for the payment category specified.
127        """
128        p_item = u''
129        amount = 0.0
130        if previous_session:
131            if previous_session < student['studycourse'].entry_session:
132                return _('The previous session must not fall below '
133                         'your entry session.'), None
134            if category == 'schoolfee':
135                # School fee is always paid for the following session
136                if previous_session > student['studycourse'].current_session:
137                    return _('This is not a previous session.'), None
138            else:
139                if previous_session > student['studycourse'].current_session - 1:
140                    return _('This is not a previous session.'), None
141            p_session = previous_session
142            p_level = previous_level
143            p_current = False
144        else:
145            p_session = student['studycourse'].current_session
146            p_level = student['studycourse'].current_level
147            p_current = True
148        academic_session = self._getSessionConfiguration(p_session)
149        if academic_session == None:
150            return _(u'Session configuration object is not available.'), None
151        # Determine fee.
152        if category == 'schoolfee':
153            try:
154                certificate = student['studycourse'].certificate
155                p_item = certificate.code
156            except (AttributeError, TypeError):
157                return _('Study course data are incomplete.'), None
158            if previous_session:
159                # Students can pay for previous sessions in all
160                # workflow states.  Fresh students are excluded by the
161                # update method of the PreviousPaymentAddFormPage.
162                if previous_level == 100:
163                    if local(student):
164                        amount = getattr(certificate, 'school_fee_1', 0.0)
165                    else:
166                        amount = getattr(certificate, 'school_fee_3', 0.0)
167                else:
168                    if local(student):
169                        amount = getattr(certificate, 'school_fee_2', 0.0)
170                    else:
171                        amount = getattr(certificate, 'school_fee_4', 0.0)
172            else:
173                # Students are only allowed to pay school fee
174                # if current session dep_sug_gns payment has been made.
175                if not self._dep_sug_gns_paymentMade(student, student.current_session):
176                    return _('You have to pay NADESU/SA/SUG and GNS Dues first.'), None
177                penalty = getattr(academic_session, 'lsfp_penalty_fee')
178                if  penalty and not self._lsfp_penalty_paymentMade(
179                    student, student.current_session):
180                    return _('You have to pay late school fee payment penalty first.'), None
181                if student.state == CLEARED:
182                    if local(student):
183                        amount = getattr(certificate, 'school_fee_1', 0.0)
184                    else:
185                        amount = getattr(certificate, 'school_fee_3', 0.0)
186                elif student.state == RETURNING:
187                    # In case of returning school fee payment the
188                    # payment session and level contain the values of
189                    # the session the student has paid for. Payment
190                    # session is always next session.
191                    p_session, p_level = self.getReturningData(student)
192                    academic_session = self._getSessionConfiguration(p_session)
193                    if academic_session == None:
194                        return _(
195                            u'Session configuration object is not available.'
196                            ), None
197                    if p_level in (100, 110, 120, 130) or (
198                        p_level in (300, 310, 320, 330) and
199                        student.current_mode == 'hnd_ft'):
200                        # First-year probating ND students or third year
201                        # probating hnd students are treated like
202                        # fresh students.
203                        if local(student):
204                            amount = getattr(certificate, 'school_fee_1', 0.0)
205                        else:
206                            amount = getattr(certificate, 'school_fee_3', 0.0)
207                    else:
208                        if local(student):
209                            amount = getattr(certificate, 'school_fee_2', 0.0)
210                        else:
211                            amount = getattr(certificate, 'school_fee_4', 0.0)
212                    if student.current_mode.endswith('_we') and p_level in (
213                        300, 310, 320, 330, 600, 610, 620, 630):
214                        amount -= 7000
215                    amount += MICROSOFT_FEE
216                elif student.is_postgrad and student.state == PAID:
217                    # Returning postgraduate students also pay for the
218                    # next session but their level always remains the
219                    # same.
220                    p_session += 1
221                    academic_session = self._getSessionConfiguration(p_session)
222                    if academic_session == None:
223                        return _(
224                            u'Session configuration object is not available.'
225                            ), None
226                    if local(student):
227                        amount = getattr(certificate, 'school_fee_2', 0.0)
228                    else:
229                        amount = getattr(certificate, 'school_fee_4', 0.0)
230        elif category == 'clearance':
231            try:
232                p_item = student['studycourse'].certificate.code
233            except (AttributeError, TypeError):
234                return _('Study course data are incomplete.'), None
235            if student.current_mode == 'hnd_ft':
236                if local(student):
237                    amount = academic_session.hndlocal_clearance_fee
238                else:
239                    amount = academic_session.hnd_clearance_fee
240            elif student.current_mode == 'nd_ft':
241                if local(student):
242                    amount = academic_session.ndlocal_clearance_fee
243                else:
244                    amount = academic_session.nd_clearance_fee
245            else:
246                    amount = academic_session.clearance_fee
247        elif category == 'bed_allocation':
248            p_item = self.getAccommodationDetails(student)['bt']
249            amount = academic_session.booking_fee
250        elif category == 'hostel_maintenance':
251            amount = 0.0
252            bedticket = student['accommodation'].get(
253                str(student.current_session), None)
254            if bedticket is not None and bedticket.bed is not None:
255                p_item = bedticket.bed_coordinates
256                if bedticket.bed.__parent__.maint_fee > 0:
257                    amount = bedticket.bed.__parent__.maint_fee
258                else:
259                    # fallback
260                    amount = academic_session.maint_fee
261            else:
262                return _(u'No bed allocated.'), None
263        elif category == 'dep_sug':
264            amount = 3150.0 # includes GATEWAY_AMT
265            #if student.faccode == 'SPAT':
266            #    amount = 1650.0 # includes GATEWAY_AMT
267            #    amount = 0.0
268            if student.state == RETURNING and not previous_session:
269                p_session, p_level = self.getReturningData(student)
270        elif category.startswith('gns'):
271            if student.state == RETURNING and not previous_session:
272                p_session, p_level = self.getReturningData(student)
273                fee_name = category + '_fee'
274                academic_session = self._getSessionConfiguration(p_session)
275                amount = getattr(academic_session, fee_name, 0.0)
276            else:
277                fee_name = category + '_fee'
278                amount = getattr(academic_session, fee_name, 0.0)
279        else:
280            fee_name = category + '_fee'
281            amount = getattr(academic_session, fee_name, 0.0)
282        if amount in (0.0, None):
283            return _('Amount could not be determined.'), None
284        if self.samePaymentMade(student, category, p_item, p_session):
285            return _('This type of payment has already been made.'), None
286        if self._isPaymentDisabled(p_session, category, student):
287            return _('This category of payments has been disabled.'), None
288        payment = createObject(u'waeup.StudentOnlinePayment')
289        timestamp = ("%d" % int(time()*10000))[1:]
290        payment.p_id = "p%s" % timestamp
291        payment.p_category = category
292        payment.p_item = p_item
293        payment.p_session = p_session
294        payment.p_level = p_level
295        payment.p_current = p_current
296        payment.amount_auth = amount
297        return None, payment
298
299    def warnCreditsOOR(self, studylevel, course=None):
300        """DSPG requires total credits on semester
301        basis.
302        """
303        total = [0, 0, 0]
304        for ticket in studylevel.values():
305            if ticket.outstanding:
306                continue
307            if not ticket.semester in (1, 2):
308                total[ticket.semester] += ticket.credits
309            else:
310                total[0] += ticket.credits
311        if course:
312            if course.semester == 1 and total[1] + course.credits > 40:
313                return _('Maximum credits (40) in 1st semester exceeded.')
314            if course.semester == 2 and total[2] + course.credits > 40:
315                return _('Maximum credits (40) in 2nd semester exceeded.')
316        else:
317            if total[1] > 40:
318                return _('Maximum credits (40) in 1st semester exceeded.')
319            if total[2] > 40:
320                return _('Maximum credits (40) in 2nd semester exceeded.')
321        return
322
323    #: A tuple containing names of file upload viewlets which are not shown
324    #: on the `StudentClearanceManageFormPage`. Nothing is being skipped
325    #: in the base package. This attribute makes only sense, if intermediate
326    #: custom packages are being used, like we do for all Nigerian portals.
327    SKIP_UPLOAD_VIEWLETS = ('acceptanceletterupload',
328                            'higherqualificationresultupload',
329                            'advancedlevelresultupload',
330                            'evidencenameupload',
331                            'refereeletterupload',
332                            'statutorydeclarationupload',
333                            'firstsittingresultupload',
334                            'secondsittingresultupload',
335                            'certificateupload',
336                            'resultstatementupload',
337                            )
338
339    #: A tuple containing the names of registration states in which changing of
340    #: passport pictures is allowed.
341    PORTRAIT_CHANGE_STATES = (ADMITTED, RETURNING,)
342
343    def constructMatricNumber(self, student):
344        #faccode = student.faccode
345        depcode = student.depcode
346        #certcode = student.certcode
347        year = unicode(student.entry_session)[2:]
348        if not student.state in (PAID, ) or not student.is_fresh:
349            return _('Matriculation number cannot be set.'), None
350
351        # ACC/ND/17/00001
352        if student.current_mode == 'nd_ft':
353            next_integer = grok.getSite()['configuration'].next_matric_integer
354            if next_integer == 0:
355                return _('Matriculation number cannot be set.'), None
356            return None, "%s/ND/%s/%05d" % (depcode, year, next_integer)
357
358        # ACC/HND/17/00001
359        if student.current_mode == 'hnd_ft':
360            next_integer = grok.getSite()['configuration'].next_matric_integer_2
361            if next_integer == 0:
362                return _('Matriculation number cannot be set.'), None
363            return None, "%s/HND/%s/%05d" % (depcode, year, next_integer)
364
365        # PT students get the same prefixes but their counter should start
366        # with 10001. This is inconsistent because after 9999 ft students
367        # the ft and pt number ranges will overlap. Issoufou pointed this
368        # out but the director said:
369        # "when the counter gets to 9999 for ft, it can start counting
370        # along where pt is, at that moment."
371
372        # ACC/ND/17/10001
373        if student.current_mode in ('nd_pt, nd_we'):
374            next_integer = grok.getSite()['configuration'].next_matric_integer_3
375            if next_integer == 0:
376                return _('Matriculation number cannot be set.'), None
377            return None, "%s/ND/%s/%05d" % (depcode, year, next_integer)
378        # ACC/HND/17/10001
379        if student.current_mode in ('hnd_pt, hnd_we'):
380            next_integer = grok.getSite()['configuration'].next_matric_integer_4
381            if next_integer == 0:
382                return _('Matriculation number cannot be set.'), None
383            return None, "%s/HND/%s/%05d" % (depcode, year, next_integer)
384
385        return _('Matriculation number cannot be set.'), None
386
387    def increaseMatricInteger(self, student):
388        """Increase counter for matric numbers.
389        """
390        if student.current_mode == 'nd_ft':
391            grok.getSite()['configuration'].next_matric_integer += 1
392            return
393        elif student.current_mode == 'hnd_ft':
394            grok.getSite()['configuration'].next_matric_integer_2 += 1
395            return
396        elif student.current_mode in ('nd_pt, nd_we'):
397            grok.getSite()['configuration'].next_matric_integer_3 += 1
398            return
399        elif student.current_mode in ('hnd_pt, hnd_we'):
400            grok.getSite()['configuration'].next_matric_integer_4 += 1
401            return
402        return
Note: See TracBrowser for help on using the repository browser.