Context navigation

source: main/waeup.fceokene/trunk/src/waeup/fceokene/students/utils.py @ 10807

Last change on this file since 10807 was 10665, checked in by Henrik Bettermann, 11 years ago
Correct fee.
Property svn:keywords set to `Id`
File size: 15.7 KB

Rev	Line
[7419]	1	## $Id: utils.py 10665 2013-10-10 06:38:39Z 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	##
[7151]	18	import grok
[9190]	19	import random
[8599]	20	from time import time
[9950]	21	from zope.component import createObject, getUtility
[8475]	22	from waeup.kofa.interfaces import CLEARED, RETURNING, PAID
[8834]	23	from kofacustom.nigeria.students.utils import NigeriaStudentsUtils
[8247]	24	from waeup.kofa.accesscodes import create_accesscode
[9143]	25	from waeup.kofa.interfaces import CLEARED, RETURNING
[8460]	26	from waeup.fceokene.interfaces import MessageFactory as _
[9950]	27	from waeup.kofa.browser.interfaces import IPDFCreator
[9982]	28	from waeup.kofa.students.utils import trans
[10388]	29	from waeup.fceokene.interswitch.browser import GATEWAY_AMT
[6902]	30
[8834]	31	class CustomStudentsUtils(NigeriaStudentsUtils):
[7151]	32	"""A collection of customized methods.
	33
	34	"""
	35
[10661]	36	VERDICTS_DICT = {
	37	'0': 'not yet',
	38	'A': 'Successful student',
	39	'B': 'Student with carryover courses',
	40	'C': 'Student on probation',
	41	'D': 'Withdrawn from the faculty',
	42	#'E': 'Student who were previously on probation',
	43	#'F': 'Medical case',
	44	'G': 'Absent from examination',
	45	#'H': 'Withheld results',
	46	'I': 'Expelled/rusticated/suspended student',
	47	'J': 'Temporary withdrawn from the university',
	48	#'K': 'Unregistered student',
	49	'L': 'Referred student',
	50	'M': 'Reinstatement',
	51	#'N': 'Student on transfer',
	52	'O': 'NCE-III repeater',
	53	#'Y': 'No previous verdict',
	54	#'X': 'New 300 level student (Uniben)',
	55	#'Z': 'Successful student (provisional)',
	56	'A1': 'First Class',
	57	'A2': 'Second Class Upper',
	58	'A3': 'Second Class Lower',
	59	'A4': 'Third Class',
	60	'A5': 'Pass',
	61	'A6': 'Distinction',
	62	'A7': 'Credit',
	63	'A8': 'Merit',
	64	'OPDE': 'PDE repeater',
	65	}
	66
[9190]	67	def selectBed(self, available_beds):
	68	"""Randomly select a bed from a list of available beds.
	69
	70	"""
	71	return random.choice(available_beds)
	72
[8270]	73	def getReturningData(self, student):
	74	""" This method defines what happens after school fee payment
[8319]	75	of returning students depending on the student's senate verdict.
[8270]	76	"""
[8319]	77	prev_level = student['studycourse'].current_level
	78	cur_verdict = student['studycourse'].current_verdict
	79	if cur_verdict in ('A','B','L','M','N','Z',):
	80	# Successful student
	81	new_level = divmod(int(prev_level),100)[0]*100 + 100
[9923]	82	elif cur_verdict in ('C','O'):
[8319]	83	# Student on probation
	84	new_level = int(prev_level) + 10
	85	else:
	86	# Student is somehow in an undefined state.
	87	# Level has to be set manually.
	88	new_level = prev_level
[9923]	89	if cur_verdict == 'O':
	90	new_session = student['studycourse'].current_session
	91	else:
	92	new_session = student['studycourse'].current_session + 1
[8270]	93	return new_session, new_level
	94
[9153]	95	def setPaymentDetails(self, category, student,
	96	previous_session=None, previous_level=None):
[8599]	97	"""Create Payment object and set the payment data of a student for
	98	the payment category specified.
	99
	100	"""
[8306]	101	details = {}
[8599]	102	p_item = u''
	103	amount = 0.0
	104	error = u''
[9153]	105	if previous_session:
	106	return _('Previous session payment not yet implemented.'), None
[8599]	107	p_session = student['studycourse'].current_session
	108	p_level = student['studycourse'].current_level
[9153]	109	p_current = True
[9525]	110	academic_session = self._getSessionConfiguration(p_session)
	111	if academic_session == None:
[8599]	112	return _(u'Session configuration object is not available.'), None
[9525]	113	# Determine fee.
[7151]	114	if category == 'transfer':
[8599]	115	amount = academic_session.transfer_fee
[7151]	116	elif category == 'gown':
[8599]	117	amount = academic_session.gown_fee
[7151]	118	elif category == 'bed_allocation':
[8599]	119	amount = academic_session.booking_fee
[7151]	120	elif category == 'hostel_maintenance':
[9611]	121	current_session = student['studycourse'].current_session
	122	bedticket = student['accommodation'].get(str(current_session), None)
	123	if bedticket is not None and bedticket.bed is not None:
	124	p_item = bedticket.bed_coordinates
	125	else:
	126	return _(u'You have not yet booked accommodation.'), None
	127	acc_details = self.getAccommodationDetails(student)
	128	if current_session != acc_details['booking_session']:
	129	return _(u'Current session does not match accommodation session.'), None
[9612]	130	if student.current_mode.endswith('_sw') or student.current_mode == 'pd_ft':
[10520]	131	amount = 2500.0 #removed interswitch fee
[9612]	132	else:
[10520]	133	amount = 4000.0 #removed interswitch fee
[7151]	134	elif category == 'clearance':
[9143]	135	amount = academic_session.clearance_fee
[8599]	136	try:
	137	p_item = student['studycourse'].certificate.code
	138	except (AttributeError, TypeError):
	139	return _('Study course data are incomplete.'), None
[7151]	140	elif category == 'schoolfee':
[8599]	141	try:
	142	certificate = student['studycourse'].certificate
	143	p_item = certificate.code
	144	except (AttributeError, TypeError):
	145	return _('Study course data are incomplete.'), None
[9143]	146
	147	# Very special school fee configuration, should be moved to
	148	# a seperate file.
	149
	150	ARTS = ('CRS','ISS','HIS','MUS','ECO','GEO','POL','SOS','CCA','ECU',
	151	'THA','GED','GSE','PES','SPC','ENG','FRE','ARB','HAU','IGB',
	152	'YOR','NCRS','NISS','NHIS','NMUS','NECO','NGEO','NPOL',
	153	'NCCA','NECU','NTHA','NGED','NGSE','NPES','NSPC','NENG',
	154	'NFRE','NARB','NHAU','NIGB','NYOR','NSOS')
	155
[10012]	156	if student.state not in (CLEARED, RETURNING):
	157	return _('Wrong state.'), None
	158
[10661]	159	# PDE repeater
	160	if student.current_verdict == 'OPDE':
[10660]	161	amount = 20150
	162	# PDE
	163	elif student.current_mode == 'pd_ft':
[9143]	164	amount = 35000
[10012]	165	# UG
	166	elif student.current_mode == 'ug_ft':
[10026]	167	amount = 65650
[10012]	168	# NCE
[9143]	169	elif not student.current_mode.endswith('_sw'):
	170	# PRENCE
	171	if student.current_level == 10 and student.state == CLEARED:
	172	if student.depcode in ARTS:
[10663]	173	amount = 15500
[9143]	174	else:
[10663]	175	amount = 16000
[10012]	176	# NCE I fresh
[9143]	177	elif student.current_level == 100 and student.state == CLEARED:
	178	if student.depcode in ARTS:
[10663]	179	amount = 12620
[9143]	180	else:
[10665]	181	amount = 13095
[10012]	182	# NCE II
[9143]	183	elif student.current_level in (100, 110, 120) and \
	184	student.state == RETURNING:
	185	if student.depcode in ARTS:
[10663]	186	amount = 11670
[9143]	187	else:
[10663]	188	amount = 12145
[10012]	189	# NCE III
[9143]	190	elif student.current_level in (200, 210, 220):
	191	if student.depcode in ARTS:
[10663]	192	amount = 11670
[9143]	193	else:
[10663]	194	amount = 12145
[10012]	195	# NCE III repeater
[9143]	196	elif student.current_level in (300, 310, 320) and \
	197	student.current_verdict == 'O':
	198	if student.depcode in ARTS:
[10663]	199	amount = 9770
[9143]	200	else:
[10663]	201	amount = 10245
[10012]	202	# NCE III spillover
[9143]	203	elif student.current_level in (300, 310, 320) and \
	204	student.current_verdict == 'B':
	205	if student.depcode in ARTS:
	206	amount = 9170
	207	else:
	208	amount = 9645
[10012]	209	# NCE III second spillover
[9143]	210	elif student.current_level in (400, 410, 420) and \
	211	student.current_verdict == 'B':
	212	if student.depcode in ARTS:
	213	amount = 9170
	214	else:
	215	amount = 9645
	216	else:
	217	if student.current_level == 100 and student.state == CLEARED:
	218	if student.depcode in ARTS:
	219	amount = 21900
	220	else:
	221	amount = 22400
[10012]	222	# NCE II sw
[9143]	223	elif student.current_level in (100, 110, 120) and \
	224	student.state == RETURNING:
	225	if student.depcode in ARTS:
	226	amount = 18400
	227	else:
	228	amount = 18900
[10012]	229	# NCE III sw
[9143]	230	elif student.current_level in (200, 210, 220):
	231	if student.depcode in ARTS:
	232	amount = 20400
	233	else:
	234	amount = 20900
[10012]	235	# NCE IV sw
[9143]	236	elif student.current_level in (300, 310, 320):
	237	if student.depcode in ARTS:
	238	amount = 18400
	239	else:
	240	amount = 18900
[10012]	241	# NCE V sw
[9143]	242	elif student.current_level in (400, 410, 420):
	243	if student.depcode in ARTS:
	244	amount = 18400
	245	else:
	246	amount = 18900
[10012]	247	# NCE V spillover sw
[9143]	248	elif student.current_level in (500, 510, 520) and \
	249	student.current_verdict == 'B':
	250	if student.depcode in ARTS:
	251	amount = 16900
	252	else:
	253	amount = 17400
[10012]	254	# NCE V second spillover sw
[9143]	255	elif student.current_level in (600, 610, 620) and \
	256	student.current_verdict == 'B':
	257	if student.depcode in ARTS:
	258	amount = 16900
	259	else:
	260	amount = 17400
[10009]	261	# NCE student payment can be disabled by
	262	# setting the base school fee to -1
	263	if academic_session.school_fee_base == -1 and \
	264	student.current_mode.startswith('nce'):
[10010]	265	return _(u'School fee payment is disabled.'), None
[9297]	266	if student.state == RETURNING:
[9525]	267	# Override p_session and p_level
[9297]	268	p_session, p_level = self.getReturningData(student)
[9525]	269	academic_session = self._getSessionConfiguration(p_session)
	270	if academic_session == None:
	271	return _(u'Session configuration object is not available.'), None
[9143]	272
[8599]	273	if amount in (0.0, None):
	274	return _(u'Amount could not be determined.'), None
	275	for key in student['payments'].keys():
	276	ticket = student['payments'][key]
	277	if ticket.p_state == 'paid' and\
	278	ticket.p_category == category and \
	279	ticket.p_item == p_item and \
	280	ticket.p_session == p_session:
	281	return _('This type of payment has already been made.'), None
[8713]	282	payment = createObject(u'waeup.StudentOnlinePayment')
[8953]	283	timestamp = ("%d" % int(time()*10000))[1:]
[8599]	284	payment.p_id = "p%s" % timestamp
	285	payment.p_category = category
	286	payment.p_item = p_item
	287	payment.p_session = p_session
	288	payment.p_level = p_level
[9153]	289	payment.p_current = p_current
[10388]	290	# On June 26, 2013 FCEOkene realized that the Interswitch fee
	291	# is deducted from their amount. Therefore, we add this fee here.
	292	payment.amount_auth = float(amount) + GATEWAY_AMT
[8599]	293	return None, payment
[7621]	294
[9207]	295	def getAccommodationDetails(self, student):
	296	"""Determine the accommodation data of a student.
	297	"""
	298	d = {}
	299	d['error'] = u''
	300	hostels = grok.getSite()['hostels']
	301	d['booking_session'] = hostels.accommodation_session
	302	d['allowed_states'] = hostels.accommodation_states
	303	d['startdate'] = hostels.startdate
	304	d['enddate'] = hostels.enddate
	305	d['expired'] = hostels.expired
	306	# Determine bed type
	307	studycourse = student['studycourse']
	308	certificate = getattr(studycourse,'certificate',None)
	309	current_level = studycourse.current_level
	310	if None in (current_level, certificate):
	311	return d
	312	end_level = certificate.end_level
	313	if current_level == 10:
	314	bt = 'pr'
	315	elif current_level == 100:
	316	bt = 'fr'
	317	elif current_level >= 300:
	318	bt = 'fi'
	319	else:
	320	bt = 're'
	321	if student.sex == 'f':
	322	sex = 'female'
	323	else:
	324	sex = 'male'
	325	special_handling = 'regular'
	326	d['bt'] = u'%s_%s_%s' % (special_handling,sex,bt)
	327	return d
	328
[9903]	329	def maxCredits(self, studylevel):
	330	"""Return maximum credits.
	331
	332	"""
	333	return 58
	334
[9950]	335	def getPDFCreator(self, context):
	336	"""Get a pdf creator suitable for `context`.
	337
	338	The default implementation always returns the default creator.
	339	"""
	340	mode = getattr(context, 'current_mode', None)
	341	if mode and mode.startswith('ug'):
	342	return getUtility(IPDFCreator, name='ibadan_pdfcreator')
	343	return getUtility(IPDFCreator)
	344
[9982]	345	def _admissionText(self, student, portal_language):
	346	mode = getattr(student, 'current_mode', None)
	347	if mode and mode.startswith('ug'):
	348	text = trans(_(
	349	'With reference to your application for admission into Bachelor Degree '
	350	'Programme of the University of Ibadan, this is to inform you that you have '
	351	'been provisionally admitted to pursue a full-time Bachelor of Arts in '
	352	'Education Degree Programme as follows:'),
	353	portal_language)
	354	else:
	355	inst_name = grok.getSite()['configuration'].name
	356	text = trans(_(
	357	'This is to inform you that you have been provisionally'
	358	' admitted into ${a} as follows:', mapping = {'a': inst_name}),
	359	portal_language)
	360	return text
	361
[9989]	362	def getBedCoordinates(self, bedticket):
	363	"""Return bed coordinates.
	364
	365	Bed coordinates are invisible in FCEOkene.
	366	"""
	367	return _('(see payment slip)')
	368
[10019]	369	SEPARATORS_DICT = {
	370	'form.fst_sit_fname': _(u'First Sitting Record'),
	371	'form.scd_sit_fname': _(u'Second Sitting Record'),
	372	#'form.alr_fname': _(u'Advanced Level Record'),
	373	'form.hq_type': _(u'Advanced Level Record'),
	374	'form.hq2_type': _(u'Second Higher Education Record'),
	375	'form.nysc_year': _(u'NYSC Information'),
	376	'form.employer': _(u'Employment History'),
	377	'form.former_matric': _(u'Former Student'),
	378	}
	379
[10023]	380	SKIP_UPLOAD_VIEWLETS = (
	381	'higherqualificationresultupload',
	382	'secondHigherqualificationresultupload',
	383	'certificateupload',
	384	'secondcertificateupload',
	385	'thirdcertificateupload',
	386	'resultstatementupload',
	387	'secondrefereeletterupload',
	388	'thirdrefereeletterupload',)
	389
[8460]	390	# FCEOkene prefix
[10520]	391	STUDENT_ID_PREFIX = u'K'

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

Download in other formats: