Context navigation

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

Last change on this file since 14349 was 14343, checked in by Henrik Bettermann, 8 years ago
Fix condition.
Property svn:keywords set to `Id`
File size: 17.7 KB

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

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

Download in other formats: