1 | ## $Id: utils.py 14617 2017-03-09 16:33:34Z 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 | ## |
---|
18 | import grok |
---|
19 | import random |
---|
20 | from time import time |
---|
21 | from zope.component import createObject, getUtility |
---|
22 | from waeup.kofa.interfaces import ( |
---|
23 | CLEARED, RETURNING, PAID, ADMITTED, CLEARANCE, REQUESTED) |
---|
24 | from kofacustom.nigeria.students.utils import NigeriaStudentsUtils |
---|
25 | from waeup.kofa.accesscodes import create_accesscode |
---|
26 | from waeup.kofa.interfaces import CLEARED, RETURNING |
---|
27 | from waeup.fceokene.interfaces import MessageFactory as _ |
---|
28 | from waeup.kofa.browser.interfaces import IPDFCreator |
---|
29 | from waeup.kofa.students.utils import trans |
---|
30 | from waeup.fceokene.interswitch.browser import GATEWAY_AMT |
---|
31 | |
---|
32 | # Very special school fee configuration, should be moved to |
---|
33 | # a seperate file. |
---|
34 | |
---|
35 | ARTS = ('CRS','ISS','HIS','MUS','ECO','GEO','POL','SOS','CCA','ECU', |
---|
36 | 'THA','GED','GSE','PES','SPC','ENG','FRE','ARB','HAU','IGB', |
---|
37 | 'YOR','NCRS','NISS','NHIS','NMUS','NECO','NGEO','NPOL', |
---|
38 | 'NCCA','NECU','NTHA','NGED','NGSE','NPES','NSPC','NENG', |
---|
39 | 'NFRE','NARB','NHAU','NIGB','NYOR','NSOS') |
---|
40 | |
---|
41 | class CustomStudentsUtils(NigeriaStudentsUtils): |
---|
42 | """A collection of customized methods. |
---|
43 | |
---|
44 | """ |
---|
45 | |
---|
46 | def selectBed(self, available_beds, desired_hostel): |
---|
47 | """Randomly select a bed from the list of available beds. |
---|
48 | """ |
---|
49 | return random.choice(available_beds) |
---|
50 | |
---|
51 | def getReturningData(self, student): |
---|
52 | """ This method defines what happens after school fee payment |
---|
53 | of returning students depending on the student's senate verdict. |
---|
54 | """ |
---|
55 | prev_level = student['studycourse'].current_level |
---|
56 | cur_verdict = student['studycourse'].current_verdict |
---|
57 | if cur_verdict in ('A','B','L','M','N','Z',): |
---|
58 | # Successful student |
---|
59 | new_level = divmod(int(prev_level),100)[0]*100 + 100 |
---|
60 | elif cur_verdict in ('C','O'): |
---|
61 | # Student on probation |
---|
62 | new_level = int(prev_level) + 10 |
---|
63 | else: |
---|
64 | # Student is somehow in an undefined state. |
---|
65 | # Level has to be set manually. |
---|
66 | new_level = prev_level |
---|
67 | if cur_verdict == 'O': |
---|
68 | new_session = student['studycourse'].current_session |
---|
69 | else: |
---|
70 | new_session = student['studycourse'].current_session + 1 |
---|
71 | return new_session, new_level |
---|
72 | |
---|
73 | def setPaymentDetails(self, category, student, |
---|
74 | previous_session=None, previous_level=None): |
---|
75 | """Create Payment object and set the payment data of a student for |
---|
76 | the payment category specified. |
---|
77 | |
---|
78 | """ |
---|
79 | details = {} |
---|
80 | p_item = u'' |
---|
81 | amount = 0.0 |
---|
82 | error = u'' |
---|
83 | if previous_session: |
---|
84 | return _('Previous session payment not yet implemented.'), None |
---|
85 | p_session = student['studycourse'].current_session |
---|
86 | p_level = student['studycourse'].current_level |
---|
87 | p_current = True |
---|
88 | academic_session = self._getSessionConfiguration(p_session) |
---|
89 | if academic_session == None: |
---|
90 | return _(u'Session configuration object is not available.'), None |
---|
91 | # Determine fee. |
---|
92 | if category == 'transfer': |
---|
93 | amount = academic_session.transfer_fee |
---|
94 | elif category == 'gown': |
---|
95 | amount = academic_session.gown_fee |
---|
96 | elif category == 'bed_allocation': |
---|
97 | amount = academic_session.booking_fee |
---|
98 | elif category == 'hostel_maintenance': |
---|
99 | current_session = student['studycourse'].current_session |
---|
100 | bedticket = student['accommodation'].get(str(current_session), None) |
---|
101 | if bedticket is not None and bedticket.bed is not None: |
---|
102 | p_item = bedticket.bed_coordinates |
---|
103 | if bedticket.bed.__parent__.maint_fee > 0: |
---|
104 | amount = bedticket.bed.__parent__.maint_fee |
---|
105 | else: |
---|
106 | return _(u'No bed space allocated.'), None |
---|
107 | if student.current_mode.endswith('_sw') \ |
---|
108 | or student.current_mode == 'pd_ft': |
---|
109 | amount *= 0.625 |
---|
110 | elif category == 'clearance': |
---|
111 | amount = academic_session.clearance_fee |
---|
112 | try: |
---|
113 | p_item = student['studycourse'].certificate.code |
---|
114 | except (AttributeError, TypeError): |
---|
115 | return _('Study course data are incomplete.'), None |
---|
116 | if student.state not in (ADMITTED, CLEARANCE, REQUESTED, CLEARED): |
---|
117 | return _(u'Acceptance Fee payments not allowed.'), None |
---|
118 | elif category == 'third_semester' and student.current_mode == 'nce_ft': |
---|
119 | if student.depcode in ARTS: |
---|
120 | amount = 6688 |
---|
121 | else: |
---|
122 | amount = 6938 |
---|
123 | elif category == 'schoolfee': |
---|
124 | p_item = student.certcode |
---|
125 | if not p_item: |
---|
126 | return _('Study course data are incomplete.'), None |
---|
127 | |
---|
128 | if student.state not in (CLEARED, RETURNING): |
---|
129 | return _('Wrong state.'), None |
---|
130 | |
---|
131 | # PDE repeater |
---|
132 | if student.current_verdict == 'OPDE': |
---|
133 | amount = 23000 |
---|
134 | # PDE new |
---|
135 | elif student.current_mode == 'pd_ft' and student.state == CLEARED: |
---|
136 | amount = 70300 |
---|
137 | # PDE |
---|
138 | elif student.current_mode == 'pd_ft': |
---|
139 | amount = 35300 |
---|
140 | |
---|
141 | #Short Duration ICT Programs |
---|
142 | elif p_item in ('CCO','DPMTS','DTPGD') and \ |
---|
143 | student.state == CLEARED: |
---|
144 | amount = 15000 |
---|
145 | elif p_item in ('ADTPGD','ADPMTS') and \ |
---|
146 | student.state == CLEARED: |
---|
147 | amount = 16000 |
---|
148 | elif p_item in ('ADPMTSI','ADTPGDI','DPMTSI','DTPGDI') and \ |
---|
149 | student.state == CLEARED: |
---|
150 | amount = 25000 |
---|
151 | elif p_item in ('ADPMTSA','ADTPGDA') and \ |
---|
152 | student.state == CLEARED: |
---|
153 | amount = 35000 |
---|
154 | |
---|
155 | # UG |
---|
156 | elif student.current_mode == 'ug_ft': |
---|
157 | if student.state == CLEARED: |
---|
158 | amount = 65650 |
---|
159 | # Introducing repeater fee for 'ug_ft' for 1st time |
---|
160 | # on 15/03/2016 |
---|
161 | elif student.current_verdict == 'O': |
---|
162 | amount = 56150 |
---|
163 | else: |
---|
164 | amount = 56150 |
---|
165 | # NCE |
---|
166 | elif not student.current_mode.endswith('_sw'): |
---|
167 | # PRENCE |
---|
168 | if student.current_level == 10 and student.state == CLEARED: |
---|
169 | if student.depcode in ARTS: |
---|
170 | amount = 17500 |
---|
171 | else: |
---|
172 | amount = 18000 |
---|
173 | # NCE I fresh |
---|
174 | elif student.current_level == 100 and student.state == CLEARED: |
---|
175 | if student.depcode in ARTS: |
---|
176 | amount = 14325 |
---|
177 | else: |
---|
178 | amount = 14825 |
---|
179 | # NCE II |
---|
180 | elif student.current_level in (100, 110, 120) and \ |
---|
181 | student.state == RETURNING: |
---|
182 | if student.depcode in ARTS: |
---|
183 | amount = 13375 |
---|
184 | else: |
---|
185 | amount = 13875 |
---|
186 | # NCE III |
---|
187 | elif student.current_level in (200, 210, 220): |
---|
188 | if student.depcode in ARTS: |
---|
189 | amount = 13375 |
---|
190 | else: |
---|
191 | amount = 13875 |
---|
192 | # NCE III repeater |
---|
193 | elif student.current_level in (300, 310, 320) and \ |
---|
194 | student.current_verdict == 'O': |
---|
195 | if student.depcode in ARTS: |
---|
196 | amount = 11475 |
---|
197 | else: |
---|
198 | amount = 11975 |
---|
199 | # NCE III spillover |
---|
200 | elif student.current_level in (300, 310, 320) and \ |
---|
201 | student.current_verdict == 'B': |
---|
202 | if student.depcode in ARTS: |
---|
203 | amount = 11975 |
---|
204 | else: |
---|
205 | amount = 11975 |
---|
206 | # NCE III second spillover |
---|
207 | elif student.current_level in (400, 410, 420) and \ |
---|
208 | student.current_verdict == 'B': |
---|
209 | if student.depcode in ARTS: |
---|
210 | amount = 11975 |
---|
211 | else: |
---|
212 | amount = 11975 |
---|
213 | else: |
---|
214 | # NCE I fresh sw |
---|
215 | if student.current_level == 100 and student.state == CLEARED: |
---|
216 | if student.depcode in ARTS: |
---|
217 | amount = 23100 |
---|
218 | else: |
---|
219 | amount = 23600 |
---|
220 | # NCE II fresh sw |
---|
221 | elif student.current_level == 200 and student.state == CLEARED: |
---|
222 | if student.depcode in ARTS: |
---|
223 | amount = 19000 |
---|
224 | else: |
---|
225 | amount = 19500 |
---|
226 | # NCE II sw |
---|
227 | elif student.current_level in (100, 110, 120) and \ |
---|
228 | student.state == RETURNING: |
---|
229 | if student.depcode in ARTS: |
---|
230 | amount = 19000 |
---|
231 | else: |
---|
232 | amount = 19500 |
---|
233 | # NCE III sw |
---|
234 | elif student.current_level in (200, 210, 220): |
---|
235 | if student.depcode in ARTS: |
---|
236 | amount = 21000 |
---|
237 | else: |
---|
238 | amount = 21500 |
---|
239 | # NCE IV sw |
---|
240 | elif student.current_level in (300, 310, 320): |
---|
241 | if student.depcode in ARTS: |
---|
242 | amount = 19000 |
---|
243 | else: |
---|
244 | amount = 19500 |
---|
245 | # NCE V sw |
---|
246 | elif student.current_level in (400, 410, 420): |
---|
247 | if student.depcode in ARTS: |
---|
248 | amount = 19000 |
---|
249 | else: |
---|
250 | amount = 19500 |
---|
251 | # NCE V spillover sw |
---|
252 | elif student.current_level in (500, 510, 520) and \ |
---|
253 | student.current_verdict == 'B': |
---|
254 | if student.depcode in ARTS: |
---|
255 | amount = 17500 |
---|
256 | else: |
---|
257 | amount = 18000 |
---|
258 | # NCE V second spillover sw |
---|
259 | elif student.current_level in (600, 610, 620) and \ |
---|
260 | student.current_verdict == 'B': |
---|
261 | if student.depcode in ARTS: |
---|
262 | amount = 17500 |
---|
263 | else: |
---|
264 | amount = 18000 |
---|
265 | # NCE student payment can be disabled by |
---|
266 | # setting the base school fee to -1 |
---|
267 | if academic_session.school_fee_base == -1 and \ |
---|
268 | student.current_mode.startswith('nce'): |
---|
269 | return _(u'School fee payment is disabled.'), None |
---|
270 | if student.state == RETURNING: |
---|
271 | # Override p_session and p_level |
---|
272 | p_session, p_level = self.getReturningData(student) |
---|
273 | academic_session = self._getSessionConfiguration(p_session) |
---|
274 | if academic_session == None: |
---|
275 | return _(u'Session configuration object is not available.'), None |
---|
276 | |
---|
277 | if amount in (0.0, None): |
---|
278 | return _(u'Amount could not be determined.'), None |
---|
279 | |
---|
280 | # Add session and level specific penalty fee. |
---|
281 | if category == 'schoolfee' and student.current_mode in ( |
---|
282 | 'ug_ft', 'de_ft') and student.state != CLEARED: |
---|
283 | amount += academic_session.penalty_ug_ft |
---|
284 | elif category == 'schoolfee' and student.current_mode in ( |
---|
285 | 'nce_ft',) and student['studycourse'].previous_verdict != 'O': |
---|
286 | # NCE I fresh |
---|
287 | if student.current_level == 100 and student.state == CLEARED: |
---|
288 | amount += academic_session.penalty_nce1_ft |
---|
289 | # NCE II |
---|
290 | elif student.current_level in (100, 110, 120) and \ |
---|
291 | student.state == RETURNING: |
---|
292 | amount += academic_session.penalty_nce2_ft |
---|
293 | # NCE III (except repeaters and spillovers) |
---|
294 | elif student.current_level in (200, 210, 220): |
---|
295 | amount += academic_session.penalty_nce3_ft |
---|
296 | elif category == 'schoolfee' and student.current_mode in ( |
---|
297 | 'nce_sw', 'nce_pt'): |
---|
298 | # NCE I fresh |
---|
299 | if student.current_level == 100 and student.state == CLEARED: |
---|
300 | amount += academic_session.penalty_nce1_pt |
---|
301 | # NCE II |
---|
302 | elif student.current_level in (100, 110, 120) and \ |
---|
303 | student.state == RETURNING: |
---|
304 | amount += academic_session.penalty_nce2_pt |
---|
305 | # NCE III (except repeaters and spillovers) |
---|
306 | elif student.current_level in (200, 210, 220): |
---|
307 | amount += academic_session.penalty_nce3_pt |
---|
308 | elif category == 'schoolfee' and student.current_mode in ('prence',): |
---|
309 | amount += academic_session.penalty_prence |
---|
310 | if self.samePaymentMade(student, category, p_item, p_session): |
---|
311 | return _('This type of payment has already been made.'), None |
---|
312 | if self._isPaymentDisabled(p_session, category, student): |
---|
313 | return _('This category of payments has been disabled.'), None |
---|
314 | payment = createObject(u'waeup.StudentOnlinePayment') |
---|
315 | timestamp = ("%d" % int(time()*10000))[1:] |
---|
316 | payment.p_id = "p%s" % timestamp |
---|
317 | payment.p_category = category |
---|
318 | payment.p_item = p_item |
---|
319 | payment.p_session = p_session |
---|
320 | payment.p_level = p_level |
---|
321 | payment.p_current = p_current |
---|
322 | # On June 26, 2013 FCEOkene realized that the Interswitch fee |
---|
323 | # is deducted from their amount. Therefore, we add this fee here. |
---|
324 | payment.amount_auth = float(amount) + GATEWAY_AMT |
---|
325 | return None, payment |
---|
326 | |
---|
327 | def getAccommodationDetails(self, student): |
---|
328 | """Determine the accommodation data of a student. |
---|
329 | """ |
---|
330 | d = {} |
---|
331 | d['error'] = u'' |
---|
332 | hostels = grok.getSite()['hostels'] |
---|
333 | d['booking_session'] = hostels.accommodation_session |
---|
334 | d['allowed_states'] = hostels.accommodation_states |
---|
335 | d['startdate'] = hostels.startdate |
---|
336 | d['enddate'] = hostels.enddate |
---|
337 | d['expired'] = hostels.expired |
---|
338 | # Determine bed type |
---|
339 | studycourse = student['studycourse'] |
---|
340 | certificate = getattr(studycourse,'certificate',None) |
---|
341 | current_level = studycourse.current_level |
---|
342 | if None in (current_level, certificate): |
---|
343 | return d |
---|
344 | end_level = certificate.end_level |
---|
345 | if current_level == 10: |
---|
346 | bt = 'pr' |
---|
347 | elif current_level == 100: |
---|
348 | bt = 'fr' |
---|
349 | elif current_level >= 300: |
---|
350 | bt = 'fi' |
---|
351 | else: |
---|
352 | bt = 're' |
---|
353 | if student.sex == 'f': |
---|
354 | sex = 'female' |
---|
355 | else: |
---|
356 | sex = 'male' |
---|
357 | special_handling = 'regular' |
---|
358 | if certificate.study_mode == 'ug_ft': |
---|
359 | special_handling = 'ugft' |
---|
360 | d['bt'] = u'%s_%s_%s' % (special_handling,sex,bt) |
---|
361 | return d |
---|
362 | |
---|
363 | #def warnCreditsOOR(self, studylevel, course=None): |
---|
364 | # """Return message if credits are out of range. |
---|
365 | # """ |
---|
366 | # # adding a course ticket |
---|
367 | # if course: |
---|
368 | # if course.semester == 1: |
---|
369 | # if studylevel.total_credits_s1 + course.credits > 24: |
---|
370 | # return _('Maximum credits in 1st semester exceeded.') |
---|
371 | # if course.semester == 2: |
---|
372 | # if studylevel.total_credits_s2 + course.credits > 24: |
---|
373 | # return _('Maximum credits in 2nd semester exceeded.') |
---|
374 | # # registering course list |
---|
375 | # else: |
---|
376 | # if studylevel.total_credits_s1 > 24: |
---|
377 | # return _('Maximum credits in 1st semester exceeded.') |
---|
378 | # if studylevel.total_credits_s1 < 18: |
---|
379 | # return _('Minimum credits in 1st semester not reached.') |
---|
380 | # if studylevel.total_credits_s2 > 24: |
---|
381 | # return _('Maximum credits in 2nd semester exceeded.') |
---|
382 | # if studylevel.total_credits_s2 < 18: |
---|
383 | # return _('Minimum credits in 2nd semester not reached.') |
---|
384 | # return |
---|
385 | |
---|
386 | def warnCreditsOOR(self, studylevel, course=None): |
---|
387 | """Return message if credits are out of range. |
---|
388 | """ |
---|
389 | # adding a course ticket |
---|
390 | if course: |
---|
391 | if studylevel.total_credits + course.credits > 52: |
---|
392 | return _('Maximum credits exceeded.') |
---|
393 | # registering course list |
---|
394 | else: |
---|
395 | if studylevel.total_credits > 52: |
---|
396 | return _('Maximum credits exceeded.') |
---|
397 | if studylevel.total_credits_s1 < 18: |
---|
398 | return _('Minimum credits in 1st semester not reached.') |
---|
399 | if studylevel.total_credits_s2 < 18: |
---|
400 | return _('Minimum credits in 2nd semester not reached.') |
---|
401 | return |
---|
402 | |
---|
403 | def getPDFCreator(self, context): |
---|
404 | """Get a pdf creator suitable for `context`. |
---|
405 | |
---|
406 | The default implementation always returns the default creator. |
---|
407 | """ |
---|
408 | mode = getattr(context, 'current_mode', None) |
---|
409 | if mode and mode.startswith('ug'): |
---|
410 | return getUtility(IPDFCreator, name='ibadan_pdfcreator') |
---|
411 | return getUtility(IPDFCreator) |
---|
412 | |
---|
413 | def _admissionText(self, student, portal_language): |
---|
414 | mode = getattr(student, 'current_mode', None) |
---|
415 | if mode and mode.startswith('ug'): |
---|
416 | text = trans(_( |
---|
417 | 'With reference to your application for admission into Bachelor Degree ' |
---|
418 | 'Programme of the University of Ibadan, this is to inform you that you have ' |
---|
419 | 'been provisionally admitted to pursue a full-time Bachelor of Arts in ' |
---|
420 | 'Education Degree Programme as follows:'), |
---|
421 | portal_language) |
---|
422 | else: |
---|
423 | inst_name = grok.getSite()['configuration'].name |
---|
424 | text = trans(_( |
---|
425 | 'This is to inform you that you have been provisionally' |
---|
426 | ' admitted into ${a} as follows:', mapping = {'a': inst_name}), |
---|
427 | portal_language) |
---|
428 | return text |
---|
429 | |
---|
430 | def getBedCoordinates(self, bedticket): |
---|
431 | """Return bed coordinates. |
---|
432 | |
---|
433 | Bed coordinates are invisible in FCEOkene. |
---|
434 | """ |
---|
435 | return _('(see payment slip)') |
---|
436 | |
---|
437 | def _isPaymentDisabled(self, p_session, category, student): |
---|
438 | academic_session = self._getSessionConfiguration(p_session) |
---|
439 | if category == 'schoolfee': |
---|
440 | if 'sf_all' in academic_session.payment_disabled: |
---|
441 | return True |
---|
442 | if 'sf_nce1' in academic_session.payment_disabled and \ |
---|
443 | student.current_level == 100 and student.state == CLEARED and \ |
---|
444 | student.current_mode == 'nce_ft': |
---|
445 | return True |
---|
446 | return False |
---|
447 | |
---|
448 | SEPARATORS_DICT = { |
---|
449 | 'form.fst_sit_fname': _(u'First Sitting Record'), |
---|
450 | 'form.scd_sit_fname': _(u'Second Sitting Record'), |
---|
451 | #'form.alr_fname': _(u'Advanced Level Record'), |
---|
452 | 'form.hq_type': _(u'Advanced Level Record'), |
---|
453 | 'form.hq2_type': _(u'Second Higher Education Record'), |
---|
454 | 'form.nysc_year': _(u'NYSC Information'), |
---|
455 | 'form.employer': _(u'Employment History'), |
---|
456 | 'form.former_matric': _(u'Former Student'), |
---|
457 | } |
---|
458 | |
---|
459 | SKIP_UPLOAD_VIEWLETS = ( |
---|
460 | 'higherqualificationresultupload', |
---|
461 | 'secondHigherqualificationresultupload', |
---|
462 | 'certificateupload', |
---|
463 | 'secondcertificateupload', |
---|
464 | 'thirdcertificateupload', |
---|
465 | 'resultstatementupload', |
---|
466 | 'secondrefereeletterupload', |
---|
467 | 'thirdrefereeletterupload',) |
---|
468 | |
---|
469 | # FCEOkene prefix |
---|
470 | STUDENT_ID_PREFIX = u'K' |
---|