Context navigation

source: main/waeup.uniben/trunk/src/waeup/uniben/students/utils.py @ 13892

Last change on this file since 13892 was 13869, checked in by Henrik Bettermann, 8 years ago
All ASABA and AKOKA students pay the same clearance fee.
Property svn:keywords set to `Id`
File size: 17.2 KB

Line
1	## $Id: utils.py 13869 2016-05-29 11:53:01Z 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	from time import time
20	from zope.component import createObject, getUtility
21	from waeup.kofa.interfaces import (IKofaUtils,
22	CLEARED, RETURNING, PAID, REGISTERED, VALIDATED)
23	from waeup.kofa.utils.helpers import to_timezone
24	from waeup.kofa.students.utils import trans
25	from kofacustom.nigeria.students.utils import NigeriaStudentsUtils
26	from waeup.uniben.interfaces import MessageFactory as _
27
28	class CustomStudentsUtils(NigeriaStudentsUtils):
29	"""A collection of customized methods.
30
31	"""
32
33	def getReturningData(self, student):
34	""" This method defines what happens after school fee payment
35	of returning students depending on the student's senate verdict.
36	"""
37	prev_level = student['studycourse'].current_level
38	cur_verdict = student['studycourse'].current_verdict
39	if cur_verdict in ('A','B','L','M','N','Z',):
40	# Successful student
41	new_level = divmod(int(prev_level),100)[0]*100 + 100
42	elif cur_verdict == 'C':
43	# Student on probation
44	new_level = int(prev_level) + 10
45	else:
46	# Student is somehow in an undefined state.
47	# Level has to be set manually.
48	new_level = prev_level
49	new_session = student['studycourse'].current_session + 1
50	return new_session, new_level
51
52
53	def checkAccommodationRequirements(self, student, acc_details):
54	if acc_details.get('expired', False):
55	startdate = acc_details.get('startdate')
56	enddate = acc_details.get('enddate')
57	if startdate and enddate:
58	tz = getUtility(IKofaUtils).tzinfo
59	startdate = to_timezone(
60	startdate, tz).strftime("%d/%m/%Y %H:%M:%S")
61	enddate = to_timezone(
62	enddate, tz).strftime("%d/%m/%Y %H:%M:%S")
63	return _("Outside booking period: ${a} - ${b}",
64	mapping = {'a': startdate, 'b': enddate})
65	else:
66	return _("Outside booking period.")
67	if not student.is_postgrad and student.current_mode != 'ug_ft':
68	return _("Only undergraduate full-time students are eligible to book accommodation.")
69	bt = acc_details.get('bt')
70	if not bt:
71	return _("Your data are incomplete.")
72	if not student.state in acc_details['allowed_states']:
73	return _("You are in the wrong registration state.")
74	if student['studycourse'].current_session != acc_details[
75	'booking_session']:
76	return _('Your current session does not '
77	'match accommodation session.')
78	stage = bt.split('_')[2]
79	if not student.is_postgrad and stage != 'fr' and not student[
80	'studycourse'].previous_verdict in ('A', 'B', 'F', 'J', 'C', 'Z'):
81	return _("Your are not eligible to book accommodation.")
82	if str(acc_details[
83	'booking_session']) in student['accommodation'].keys():
84	return _('You already booked a bed space in '
85	'current accommodation session.')
86	return
87
88	def getAccommodationDetails(self, student):
89	"""Determine the accommodation data of a student.
90	"""
91	d = {}
92	d['error'] = u''
93	hostels = grok.getSite()['hostels']
94	d['booking_session'] = hostels.accommodation_session
95	d['allowed_states'] = hostels.accommodation_states
96	d['startdate'] = hostels.startdate
97	d['enddate'] = hostels.enddate
98	d['expired'] = hostels.expired
99	# Determine bed type
100	studycourse = student['studycourse']
101	certificate = getattr(studycourse,'certificate',None)
102	entry_session = studycourse.entry_session
103	current_level = studycourse.current_level
104	if None in (entry_session, current_level, certificate):
105	return d
106	if student.sex == 'f':
107	sex = 'female'
108	else:
109	sex = 'male'
110	if student.is_postgrad:
111	bt = 'all'
112	special_handling = 'pg'
113	else:
114	end_level = certificate.end_level
115	if current_level == 10:
116	bt = 'pr'
117	elif entry_session == grok.getSite()['hostels'].accommodation_session:
118	bt = 'fr'
119	elif current_level >= end_level:
120	bt = 'fi'
121	else:
122	bt = 're'
123	special_handling = 'regular'
124	if student.faccode in ('MED', 'DEN'):
125	special_handling = 'clinical'
126	elif student.certcode in ('BARTMAS', 'BARTTHR', 'BARTFAA',
127	'BAEDFAA', 'BSCEDECHED'):
128	special_handling = 'ekenwan'
129	d['bt'] = u'%s_%s_%s' % (special_handling,sex,bt)
130	return d
131
132	def _paymentMade(self, student, session):
133	if len(student['payments']):
134	for ticket in student['payments'].values():
135	if ticket.p_state == 'paid' and \
136	ticket.p_category == 'schoolfee' and \
137	ticket.p_session == session:
138	return True
139	return False
140
141	def _isPaymentDisabled(self, p_session, category, student):
142	academic_session = self._getSessionConfiguration(p_session)
143	if category == 'schoolfee' and \
144	'sf_all' in academic_session.payment_disabled:
145	return True
146	if category == 'hostel_maintenance' and \
147	'maint_all' in academic_session.payment_disabled:
148	return True
149	return False
150
151	#def _hostelApplicationPaymentMade(self, student, session):
152	# if len(student['payments']):
153	# for ticket in student['payments'].values():
154	# if ticket.p_state == 'paid' and \
155	# ticket.p_category == 'hostel_application' and \
156	# ticket.p_session == session:
157	# return True
158	# return False
159
160	def setPaymentDetails(self, category, student,
161	previous_session, previous_level):
162	"""Create Payment object and set the payment data of a student for
163	the payment category specified.
164
165	"""
166	p_item = u''
167	amount = 0.0
168	if previous_session:
169	if previous_session < student['studycourse'].entry_session:
170	return _('The previous session must not fall below '
171	'your entry session.'), None
172	if category == 'schoolfee':
173	# School fee is always paid for the following session
174	if previous_session > student['studycourse'].current_session:
175	return _('This is not a previous session.'), None
176	else:
177	if previous_session > student['studycourse'].current_session - 1:
178	return _('This is not a previous session.'), None
179	p_session = previous_session
180	p_level = previous_level
181	p_current = False
182	else:
183	p_session = student['studycourse'].current_session
184	p_level = student['studycourse'].current_level
185	p_current = True
186	academic_session = self._getSessionConfiguration(p_session)
187	if academic_session == None:
188	return _(u'Session configuration object is not available.'), None
189	# Determine fee.
190	if category == 'transfer':
191	amount = academic_session.transfer_fee
192	elif category == 'transcript':
193	amount = academic_session.transcript_fee
194	elif category == 'gown':
195	amount = academic_session.gown_fee
196	elif category == 'jupeb':
197	amount = academic_session.jupeb_fee
198	elif category == 'bed_allocation':
199	p_item = self.getAccommodationDetails(student)['bt']
200	amount = academic_session.booking_fee
201	# Add student union dues
202	if not student.is_postgrad:
203	stage = self.getAccommodationDetails(student)['bt']
204	stage = stage.split('_')[2]
205	if stage == 'fr':
206	amount += 500.0
207	elif stage in ('fi', 're') and student[
208	'studycourse'].previous_verdict in ('A', 'B', 'F', 'J', 'C', 'Z'):
209	amount += 300.0
210	else:
211	amount = 0.0
212	elif category == 'hostel_maintenance':
213	amount = 0.0
214	bedticket = student['accommodation'].get(
215	str(student.current_session), None)
216	if bedticket is not None and bedticket.bed is not None:
217	p_item = bedticket.bed_coordinates
218	if bedticket.bed.__parent__.maint_fee > 0:
219	amount = bedticket.bed.__parent__.maint_fee
220	else:
221	# fallback
222	amount = academic_session.maint_fee
223	else:
224	return _(u'No bed allocated.'), None
225	#elif category == 'hostel_application':
226	# amount = 1000.0
227	#elif category.startswith('tempmaint'):
228	# if not self._hostelApplicationPaymentMade(
229	# student, student.current_session):
230	# return _(
231	# 'You have not yet paid the hostel application fee.'), None
232	# if category == 'tempmaint_1':
233	# amount = 8150.0
234	# elif category == 'tempmaint_2':
235	# amount = 12650.0
236	# elif category == 'tempmaint_3':
237	# amount = 9650.0
238	elif category == 'clearance':
239	p_item = student.certcode
240	if p_item is None:
241	return _('Study course data are incomplete.'), None
242	if student.faccode == 'JUPEB':
243	return _('No payment required.'), None
244	if student.faccode.startswith('FCETA'):
245	# ASABA and AKOKA
246	amount = 30000.0
247	elif p_item in ('BSCANA', 'BSCMBC', 'BMLS', 'BSCNUR', 'BSCPHS', 'BDS',
248	'MBBSMED', 'MBBSNDU'):
249	amount = 65000.0
250	else:
251	amount = 45000.0
252	elif category == 'schoolfee':
253	try:
254	certificate = student['studycourse'].certificate
255	p_item = certificate.code
256	except (AttributeError, TypeError):
257	return _('Study course data are incomplete.'), None
258
259	#####################################################
260	#if student.faccode == 'JUPEB':
261	# return _('Payment temporarily disabled.'), None
262	#####################################################
263
264
265	if previous_session:
266	# Students can pay for previous sessions in all workflow states.
267	# Fresh students are excluded by the update method of the
268	# PreviousPaymentAddFormPage.
269	if previous_session == student['studycourse'].entry_session:
270	if student.is_foreigner:
271	amount = getattr(certificate, 'school_fee_3', 0.0)
272	else:
273	amount = getattr(certificate, 'school_fee_1', 0.0)
274	else:
275	if student.is_foreigner:
276	amount = getattr(certificate, 'school_fee_4', 0.0)
277	else:
278	amount = getattr(certificate, 'school_fee_2', 0.0)
279	else:
280	if student.state == CLEARED:
281	if student.is_foreigner:
282	amount = getattr(certificate, 'school_fee_3', 0.0)
283	else:
284	amount = getattr(certificate, 'school_fee_1', 0.0)
285	elif student.state in (PAID, REGISTERED, VALIDATED):
286	p_session += 1
287	# We don't know which level the student is paying for.
288	p_level = None
289	academic_session = self._getSessionConfiguration(p_session)
290	if academic_session == None:
291	return _(u'Session configuration object is not available.'), None
292
293	# Students are only allowed to pay for the next session
294	# if current session payment
295	# has really been made, i.e. payment object exists.
296	#if not self._paymentMade(
297	# student, student.current_session):
298	# return _('You have not yet paid your current/active' +
299	# ' session. Please use the previous session' +
300	# ' payment form first.'), None
301
302	if student.is_foreigner:
303	amount = getattr(certificate, 'school_fee_4', 0.0)
304	else:
305	amount = getattr(certificate, 'school_fee_2', 0.0)
306	elif student.state == RETURNING:
307	# In case of returning school fee payment the payment session
308	# and level contain the values of the session the student
309	# has paid for.
310	p_session, p_level = self.getReturningData(student)
311	academic_session = self._getSessionConfiguration(p_session)
312	if academic_session == None:
313	return _(u'Session configuration object is not available.'), None
314
315	# Students are only allowed to pay for the next session
316	# if current session payment has really been made,
317	# i.e. payment object exists and is paid.
318	#if not self._paymentMade(
319	# student, student.current_session):
320	# return _('You have not yet paid your current/active' +
321	# ' session. Please use the previous session' +
322	# ' payment form first.'), None
323
324	if student.is_foreigner:
325	amount = getattr(certificate, 'school_fee_4', 0.0)
326	else:
327	amount = getattr(certificate, 'school_fee_2', 0.0)
328	# Give 50% school fee discount to staff members.
329	if student.is_staff:
330	amount /= 2
331	if amount in (0.0, None):
332	return _('Amount could not be determined.'), None
333	# Add session specific penalty fee.
334	if category == 'schoolfee' and student.is_postgrad:
335	amount += academic_session.penalty_pg
336	elif category == 'schoolfee' and student.current_mode == ('ug_ft'):
337	amount += academic_session.penalty_ug_ft
338	elif category == 'schoolfee' and student.current_mode == ('ug_pt'):
339	amount += academic_session.penalty_ug_pt
340	if category.startswith('tempmaint'):
341	p_item = getUtility(IKofaUtils).PAYMENT_CATEGORIES[category]
342	p_item = unicode(p_item)
343	# Now we change the category because tempmaint payments
344	# will be obsolete when Uniben returns to Kofa bed allocation.
345	category = 'hostel_maintenance'
346	# Create ticket.
347	if self.samePaymentMade(student, category, p_item, p_session):
348	return _('This type of payment has already been made.'), None
349	if self._isPaymentDisabled(p_session, category, student):
350	return _('This category of payments has been disabled.'), None
351	payment = createObject(u'waeup.StudentOnlinePayment')
352	timestamp = ("%d" % int(time()*10000))[1:]
353	payment.p_id = "p%s" % timestamp
354	payment.p_category = category
355	payment.p_item = p_item
356	payment.p_session = p_session
357	payment.p_level = p_level
358	payment.p_current = p_current
359	payment.amount_auth = amount
360	return None, payment
361
362	def maxCredits(self, studylevel):
363	"""Return maximum credits.
364
365	"""
366	studycourse = studylevel.__parent__
367	certificate = getattr(studycourse,'certificate', None)
368	current_level = studycourse.current_level
369	if None in (current_level, certificate):
370	return 0
371	end_level = certificate.end_level
372	if current_level >= end_level:
373	return 51
374	return 50
375
376	def clearance_disabled_message(self, student):
377	if student.is_postgrad:
378	return None
379	try:
380	session_config = grok.getSite()[
381	'configuration'][str(student.current_session)]
382	except KeyError:
383	return _('Session configuration object is not available.')
384	if not session_config.clearance_enabled:
385	return _('Clearance is disabled for this session.')
386	return None
387
388	# Uniben prefix
389	STUDENT_ID_PREFIX = u'B'

Note: See TracBrowser for help on using the repository browser.

Download in other formats: