Context navigation

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

Last change on this file since 14330 was 14328, checked in by Henrik Bettermann, 9 years ago
Add M (reinstatement) to the verdicts that can book hostel accommodation.
Property svn:keywords set to `Id`
File size: 17.7 KB

Rev	Line
[7419]	1	## $Id: utils.py 14328 2016-12-08 07:10:10Z 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	##
[11773]	18	import grok
[8598]	19	from time import time
[9459]	20	from zope.component import createObject, getUtility
[9513]	21	from waeup.kofa.interfaces import (IKofaUtils,
	22	CLEARED, RETURNING, PAID, REGISTERED, VALIDATED)
[13251]	23	from waeup.kofa.utils.helpers import to_timezone
	24	from waeup.kofa.students.utils import trans
[8821]	25	from kofacustom.nigeria.students.utils import NigeriaStudentsUtils
[8020]	26	from waeup.uniben.interfaces import MessageFactory as _
[6902]	27
[8821]	28	class CustomStudentsUtils(NigeriaStudentsUtils):
[7151]	29	"""A collection of customized methods.
	30
	31	"""
	32
[8270]	33	def getReturningData(self, student):
	34	""" This method defines what happens after school fee payment
[8319]	35	of returning students depending on the student's senate verdict.
[8270]	36	"""
[8319]	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
[8270]	49	new_session = student['studycourse'].current_session + 1
	50	return new_session, new_level
	51
[13251]	52
[13248]	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.")
[13777]	67	if not student.is_postgrad and student.current_mode != 'ug_ft':
[13446]	68	return _("Only undergraduate full-time students are eligible to book accommodation.")
[13283]	69	bt = acc_details.get('bt')
	70	if not bt:
[13248]	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.')
[13283]	78	stage = bt.split('_')[2]
[13777]	79	if not student.is_postgrad and stage != 'fr' and not student[
[14328]	80	'studycourse'].previous_verdict in (
	81	'A', 'B', 'F', 'J', 'M' 'C', 'Z'):
[13283]	82	return _("Your are not eligible to book accommodation.")
[13510]	83	if str(acc_details[
	84	'booking_session']) in student['accommodation'].keys():
[13248]	85	return _('You already booked a bed space in '
	86	'current accommodation session.')
	87	return
[13244]	88
[13295]	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'
[13777]	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'
[13295]	130	d['bt'] = u'%s_%s_%s' % (special_handling,sex,bt)
	131	return d
	132
[9520]	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
[13566]	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
[13251]	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
[12566]	160
[9152]	161	def setPaymentDetails(self, category, student,
	162	previous_session, previous_level):
[8598]	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
[9152]	169	if previous_session:
[9520]	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
[9152]	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
[9520]	187	academic_session = self._getSessionConfiguration(p_session)
	188	if academic_session == None:
[8598]	189	return _(u'Session configuration object is not available.'), None
[8676]	190	# Determine fee.
[7151]	191	if category == 'transfer':
[8598]	192	amount = academic_session.transfer_fee
[10469]	193	elif category == 'transcript':
	194	amount = academic_session.transcript_fee
[7151]	195	elif category == 'gown':
[8598]	196	amount = academic_session.gown_fee
[13785]	197	elif category == 'jupeb':
	198	amount = academic_session.jupeb_fee
[13251]	199	elif category == 'bed_allocation':
	200	p_item = self.getAccommodationDetails(student)['bt']
	201	amount = academic_session.booking_fee
[13283]	202	# Add student union dues
[13777]	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 ('A', 'B', 'F', 'J', 'C', 'Z'):
	210	amount += 300.0
	211	else:
	212	amount = 0.0
[13251]	213	elif category == 'hostel_maintenance':
	214	amount = 0.0
	215	bedticket = student['accommodation'].get(
	216	str(student.current_session), None)
[13500]	217	if bedticket is not None and bedticket.bed is not None:
[13251]	218	p_item = bedticket.bed_coordinates
	219	if bedticket.bed.__parent__.maint_fee > 0:
	220	amount = bedticket.bed.__parent__.maint_fee
	221	else:
	222	# fallback
	223	amount = academic_session.maint_fee
	224	else:
[13508]	225	return _(u'No bed allocated.'), None
[13251]	226	#elif category == 'hostel_application':
	227	# amount = 1000.0
	228	#elif category.startswith('tempmaint'):
	229	# if not self._hostelApplicationPaymentMade(
	230	# student, student.current_session):
	231	# return _(
	232	# 'You have not yet paid the hostel application fee.'), None
	233	# if category == 'tempmaint_1':
	234	# amount = 8150.0
	235	# elif category == 'tempmaint_2':
	236	# amount = 12650.0
	237	# elif category == 'tempmaint_3':
	238	# amount = 9650.0
[7151]	239	elif category == 'clearance':
[9796]	240	p_item = student.certcode
	241	if p_item is None:
[8598]	242	return _('Study course data are incomplete.'), None
[13310]	243	if student.faccode == 'JUPEB':
	244	return _('No payment required.'), None
[13869]	245	if student.faccode.startswith('FCETA'):
	246	# ASABA and AKOKA
[13631]	247	amount = 30000.0
[11479]	248	elif p_item in ('BSCANA', 'BSCMBC', 'BMLS', 'BSCNUR', 'BSCPHS', 'BDS',
[14289]	249	'MBBSMED', 'MBBSNDU', 'BSCPTY'):
[14237]	250	amount = 65000.0
[11479]	251	else:
[14237]	252	amount = 45000.0
	253	# Clearance fee and provider amount have been increased
	254	# for new students.
	255	if student.entry_session >= 2016:
	256	amount += 5000.0
[7151]	257	elif category == 'schoolfee':
[8598]	258	try:
	259	certificate = student['studycourse'].certificate
	260	p_item = certificate.code
	261	except (AttributeError, TypeError):
	262	return _('Study course data are incomplete.'), None
[13332]	263
	264	#####################################################
[13340]	265	#if student.faccode == 'JUPEB':
	266	# return _('Payment temporarily disabled.'), None
[13332]	267	#####################################################
	268
	269
[9152]	270	if previous_session:
[9520]	271	# Students can pay for previous sessions in all workflow states.
	272	# Fresh students are excluded by the update method of the
	273	# PreviousPaymentAddFormPage.
[9157]	274	if previous_session == student['studycourse'].entry_session:
[9152]	275	if student.is_foreigner:
	276	amount = getattr(certificate, 'school_fee_3', 0.0)
	277	else:
	278	amount = getattr(certificate, 'school_fee_1', 0.0)
[9006]	279	else:
[9152]	280	if student.is_foreigner:
	281	amount = getattr(certificate, 'school_fee_4', 0.0)
	282	else:
	283	amount = getattr(certificate, 'school_fee_2', 0.0)
	284	else:
	285	if student.state == CLEARED:
	286	if student.is_foreigner:
	287	amount = getattr(certificate, 'school_fee_3', 0.0)
	288	else:
	289	amount = getattr(certificate, 'school_fee_1', 0.0)
[9513]	290	elif student.state in (PAID, REGISTERED, VALIDATED):
	291	p_session += 1
	292	# We don't know which level the student is paying for.
	293	p_level = None
[9520]	294	academic_session = self._getSessionConfiguration(p_session)
	295	if academic_session == None:
[9513]	296	return _(u'Session configuration object is not available.'), None
[9570]	297
[9520]	298	# Students are only allowed to pay for the next session
	299	# if current session payment
	300	# has really been made, i.e. payment object exists.
[9570]	301	#if not self._paymentMade(
	302	# student, student.current_session):
	303	# return _('You have not yet paid your current/active' +
	304	# ' session. Please use the previous session' +
	305	# ' payment form first.'), None
	306
[9513]	307	if student.is_foreigner:
	308	amount = getattr(certificate, 'school_fee_4', 0.0)
	309	else:
	310	amount = getattr(certificate, 'school_fee_2', 0.0)
[9152]	311	elif student.state == RETURNING:
	312	# In case of returning school fee payment the payment session
	313	# and level contain the values of the session the student
	314	# has paid for.
	315	p_session, p_level = self.getReturningData(student)
[9520]	316	academic_session = self._getSessionConfiguration(p_session)
	317	if academic_session == None:
[9152]	318	return _(u'Session configuration object is not available.'), None
[9570]	319
[9520]	320	# Students are only allowed to pay for the next session
	321	# if current session payment has really been made,
	322	# i.e. payment object exists and is paid.
[9570]	323	#if not self._paymentMade(
	324	# student, student.current_session):
	325	# return _('You have not yet paid your current/active' +
	326	# ' session. Please use the previous session' +
	327	# ' payment form first.'), None
	328
[9152]	329	if student.is_foreigner:
	330	amount = getattr(certificate, 'school_fee_4', 0.0)
	331	else:
	332	amount = getattr(certificate, 'school_fee_2', 0.0)
[9006]	333	# Give 50% school fee discount to staff members.
	334	if student.is_staff:
	335	amount /= 2
[8598]	336	if amount in (0.0, None):
[9520]	337	return _('Amount could not be determined.'), None
[8676]	338	# Add session specific penalty fee.
	339	if category == 'schoolfee' and student.is_postgrad:
	340	amount += academic_session.penalty_pg
[13757]	341	elif category == 'schoolfee' and student.current_mode == ('ug_ft'):
[13756]	342	amount += academic_session.penalty_ug_ft
[13757]	343	elif category == 'schoolfee' and student.current_mode == ('ug_pt'):
[13756]	344	amount += academic_session.penalty_ug_pt
[13998]	345	elif category == 'schoolfee' and student.current_mode == ('ug_sw'):
	346	amount += academic_session.penalty_sw
[9727]	347	if category.startswith('tempmaint'):
	348	p_item = getUtility(IKofaUtils).PAYMENT_CATEGORIES[category]
	349	p_item = unicode(p_item)
	350	# Now we change the category because tempmaint payments
[12566]	351	# will be obsolete when Uniben returns to Kofa bed allocation.
[9727]	352	category = 'hostel_maintenance'
[8676]	353	# Create ticket.
[11644]	354	if self.samePaymentMade(student, category, p_item, p_session):
	355	return _('This type of payment has already been made.'), None
[11459]	356	if self._isPaymentDisabled(p_session, category, student):
[13814]	357	return _('This category of payments has been disabled.'), None
[8715]	358	payment = createObject(u'waeup.StudentOnlinePayment')
[8950]	359	timestamp = ("%d" % int(time()*10000))[1:]
[8598]	360	payment.p_id = "p%s" % timestamp
	361	payment.p_category = category
	362	payment.p_item = p_item
	363	payment.p_session = p_session
	364	payment.p_level = p_level
[9152]	365	payment.p_current = p_current
[8598]	366	payment.amount_auth = amount
	367	return None, payment
[7621]	368
[9831]	369	def maxCredits(self, studylevel):
	370	"""Return maximum credits.
	371
	372	"""
	373	studycourse = studylevel.__parent__
	374	certificate = getattr(studycourse,'certificate', None)
	375	current_level = studycourse.current_level
	376	if None in (current_level, certificate):
	377	return 0
	378	end_level = certificate.end_level
	379	if current_level >= end_level:
	380	return 51
	381	return 50
	382
[11773]	383	def clearance_disabled_message(self, student):
	384	if student.is_postgrad:
	385	return None
	386	try:
	387	session_config = grok.getSite()[
	388	'configuration'][str(student.current_session)]
	389	except KeyError:
	390	return _('Session configuration object is not available.')
	391	if not session_config.clearance_enabled:
	392	return _('Clearance is disabled for this session.')
	393	return None
	394
[14038]	395	#: A tuple containing the names of registration states in which changing of
	396	#: passport pictures is allowed.
	397	PORTRAIT_CHANGE_STATES = ()
	398
[8441]	399	# Uniben prefix
[8413]	400	STUDENT_ID_PREFIX = u'B'

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

Download in other formats: