Context navigation

utils.py @ 17983

Last change on this file since 17983 was 17983, checked in by Henrik Bettermann, 24 hours ago
Update fees.
Property svn:keywords set to `Id`
File size: 23.9 KB

Rev	Line
[7419]	1	## $Id: utils.py 17983 2025-01-14 14:08:30Z 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
[13800]	22	from waeup.kofa.interfaces import (
	23	CLEARED, RETURNING, PAID, ADMITTED, CLEARANCE, REQUESTED)
[8834]	24	from kofacustom.nigeria.students.utils import NigeriaStudentsUtils
[8247]	25	from waeup.kofa.accesscodes import create_accesscode
[9143]	26	from waeup.kofa.interfaces import CLEARED, RETURNING
[8460]	27	from waeup.fceokene.interfaces import MessageFactory as _
[9950]	28	from waeup.kofa.browser.interfaces import IPDFCreator
[9982]	29	from waeup.kofa.students.utils import trans
[6902]	30
[11919]	31	# Very special school fee configuration, should be moved to
	32	# a seperate file.
	33
	34	ARTS = ('CRS','ISS','HIS','MUS','ECO','GEO','POL','SOS','CCA','ECU',
	35	'THA','GED','GSE','PES','SPC','ENG','FRE','ARB','HAU','IGB',
	36	'YOR','NCRS','NISS','NHIS','NMUS','NECO','NGEO','NPOL',
	37	'NCCA','NECU','NTHA','NGED','NGSE','NPES','NSPC','NENG',
	38	'NFRE','NARB','NHAU','NIGB','NYOR','NSOS')
	39
[15594]	40	GATEWAY_AMT = 0.0
[15283]	41
[8834]	42	class CustomStudentsUtils(NigeriaStudentsUtils):
[7151]	43	"""A collection of customized methods.
	44
	45	"""
	46
[15706]	47	def selectBed(self, available_beds):
[13459]	48	"""Randomly select a bed from the list of available beds.
[9190]	49	"""
	50	return random.choice(available_beds)
	51
[8270]	52	def getReturningData(self, student):
	53	""" This method defines what happens after school fee payment
[8319]	54	of returning students depending on the student's senate verdict.
[8270]	55	"""
[8319]	56	prev_level = student['studycourse'].current_level
	57	cur_verdict = student['studycourse'].current_verdict
	58	if cur_verdict in ('A','B','L','M','N','Z',):
	59	# Successful student
	60	new_level = divmod(int(prev_level),100)[0]*100 + 100
[9923]	61	elif cur_verdict in ('C','O'):
[8319]	62	# Student on probation
	63	new_level = int(prev_level) + 10
	64	else:
	65	# Student is somehow in an undefined state.
	66	# Level has to be set manually.
	67	new_level = prev_level
[9923]	68	if cur_verdict == 'O':
	69	new_session = student['studycourse'].current_session
	70	else:
	71	new_session = student['studycourse'].current_session + 1
[8270]	72	return new_session, new_level
	73
[16899]	74	#def _nce3PaymentMade(self, student, p_level):
	75	# if len(student['payments']):
	76	# for ticket in student['payments'].values():
	77	# if ticket.p_state in ('paid', 'scholarship', 'waived') and \
	78	# ticket.p_level == p_level and \
	79	# ticket.p_category == 'schoolfee':
	80	# return True
	81	# return False
[16008]	82
[9153]	83	def setPaymentDetails(self, category, student,
[15678]	84	previous_session=None, previous_level=None, combi=[]):
[8599]	85	"""Create Payment object and set the payment data of a student for
	86	the payment category specified.
	87
	88	"""
[8306]	89	details = {}
[8599]	90	p_item = u''
	91	amount = 0.0
	92	error = u''
[9153]	93	if previous_session:
	94	return _('Previous session payment not yet implemented.'), None
[8599]	95	p_session = student['studycourse'].current_session
	96	p_level = student['studycourse'].current_level
[9153]	97	p_current = True
[9525]	98	academic_session = self._getSessionConfiguration(p_session)
	99	if academic_session == None:
[8599]	100	return _(u'Session configuration object is not available.'), None
[9525]	101	# Determine fee.
[7151]	102	if category == 'transfer':
[8599]	103	amount = academic_session.transfer_fee
[7151]	104	elif category == 'gown':
[8599]	105	amount = academic_session.gown_fee
[7151]	106	elif category == 'bed_allocation':
[17183]	107	acco_details = self.getAccommodationDetails(student)
	108	p_session = acco_details['booking_session']
	109	p_item = acco_details['bt']
[8599]	110	amount = academic_session.booking_fee
[7151]	111	elif category == 'hostel_maintenance':
[17183]	112	amount = 0.0
	113	booking_session = grok.getSite()['hostels'].accommodation_session
	114	bedticket = student['accommodation'].get(str(booking_session), None)
[9611]	115	if bedticket is not None and bedticket.bed is not None:
[17183]	116	p_session = booking_session
[9611]	117	p_item = bedticket.bed_coordinates
[17629]	118	if bedticket.bed.__parent__.maint_fee > 0:
	119	amount = bedticket.bed.__parent__.maint_fee
	120	#if student['studycourse'].current_session < 2022:
	121	# amount = 6100.0
	122	#else:
	123	# amount = 10090.0
[9611]	124	else:
[13616]	125	return _(u'No bed space allocated.'), None
	126	if student.current_mode.endswith('_sw') \
	127	or student.current_mode == 'pd_ft':
	128	amount *= 0.625
[7151]	129	elif category == 'clearance':
[9143]	130	amount = academic_session.clearance_fee
[8599]	131	try:
	132	p_item = student['studycourse'].certificate.code
	133	except (AttributeError, TypeError):
	134	return _('Study course data are incomplete.'), None
[13800]	135	if student.state not in (ADMITTED, CLEARANCE, REQUESTED, CLEARED):
	136	return _(u'Acceptance Fee payments not allowed.'), None
[16899]	137	#elif category == 'third_semester' and student.current_mode == 'nce_ft' \
	138	# and p_level in (300, 310, 320, 400, 410, 420):
	139	# #if not self._nce3PaymentMade(student, p_level):
	140	# # return _(u'Make NCE 3 school fee payment first.'), None
	141	# no_additional_courses = 0
	142	# courses_level = student['studycourse'].get(str(p_level))
	143	# if courses_level and len(courses_level)> 6:
	144	# no_additional_courses = len(courses_level)-6
	145	# amount = 2000.0 * no_additional_courses
[16461]	146	elif category.startswith('schoolfee'):
[17493]	147	increment_2022 = 0
[16461]	148	if category == 'schoolfee_pde1':
[16462]	149	if not student.current_mode.startswith('pd'):
	150	return _('You are not a PDE student.'), None
[16461]	151	if student.state != CLEARED:
	152	return _('You are not a fresh student.'), None
[17734]	153	if category == 'schoolfee_ug_new':
	154	if not student.current_mode.startswith('ug'):
	155	return _('You are not a UG student.'), None
	156	if student.state != CLEARED:
	157	return _('You are not a fresh student.'), None
	158	if category == 'schoolfee_ug_ret':
	159	if not student.current_mode.startswith('ug'):
	160	return _('You are not a UG student.'), None
	161	if student.state != RETURNING:
	162	return _('You are not a returning student.'), None
[16899]	163	if category == 'schoolfee_third':
	164	if not student.current_mode == 'nce_ft' \
	165	or not p_level in (300, 310, 320, 400, 410, 420):
	166	return _('You are not an NCE 3 student.'), None
[12602]	167	p_item = student.certcode
	168	if not p_item:
[8599]	169	return _('Study course data are incomplete.'), None
[10012]	170	if student.state not in (CLEARED, RETURNING):
	171	return _('Wrong state.'), None
[10661]	172	# PDE repeater
	173	if student.current_verdict == 'OPDE':
[11850]	174	amount = 23000
[13274]	175	# PDE new
	176	elif student.current_mode == 'pd_ft' and student.state == CLEARED:
[15523]	177	amount = 70000
[16461]	178	if category == 'schoolfee_pde1':
	179	amount = 40000
[10660]	180	# PDE
	181	elif student.current_mode == 'pd_ft':
[13275]	182	amount = 35300
[12602]	183
	184	#Short Duration ICT Programs
	185	elif p_item in ('CCO','DPMTS','DTPGD') and \
	186	student.state == CLEARED:
	187	amount = 15000
	188	elif p_item in ('ADTPGD','ADPMTS') and \
	189	student.state == CLEARED:
	190	amount = 16000
	191	elif p_item in ('ADPMTSI','ADTPGDI','DPMTSI','DTPGDI') and \
	192	student.state == CLEARED:
	193	amount = 25000
	194	elif p_item in ('ADPMTSA','ADTPGDA') and \
	195	student.state == CLEARED:
	196	amount = 35000
	197
[10012]	198	# UG
	199	elif student.current_mode == 'ug_ft':
[17734]	200	if category == 'schoolfee_ug_new':
	201	# conditions checked above
[17983]	202	amount = 80000
[17734]	203	elif category == 'schoolfee_ug_ret':
	204	# conditions checked above
[17983]	205	amount = 60000
[17734]	206	elif student.state == CLEARED:
[17983]	207	amount = 140000
[13779]	208	# Introducing repeater fee for 'ug_ft' for 1st time
	209	# on 15/03/2016
[17734]	210	#elif student.current_verdict == 'O':
	211	# amount = 96700
[10876]	212	else:
[17983]	213	amount = 110000
	214
[10012]	215	# NCE
[9143]	216	elif not student.current_mode.endswith('_sw'):
[17113]	217	# in 2022 NCE school fees have encreased
	218	increment_2022 = 11000
[9143]	219	# PRENCE
	220	if student.current_level == 10 and student.state == CLEARED:
	221	if student.depcode in ARTS:
[14933]	222	amount = 24500
[9143]	223	else:
[14933]	224	amount = 25000
[10012]	225	# NCE I fresh
[9143]	226	elif student.current_level == 100 and student.state == CLEARED:
	227	if student.depcode in ARTS:
[15283]	228	amount = 28000
[9143]	229	else:
[15283]	230	amount = 28500
[14931]	231	# SIWES Fee
[16542]	232	if student.depcode in ('AGE', 'BED', 'FAA', 'HEC', 'CSC', 'MUS') \
[17087]	233	or student.certcode in ('NCECHECSC',
	234	'NCEBIOCSC',
	235	'NCEPHYCSC',
	236	'NCEPHECSC',
	237	'NCETHAMUS',
	238	'NCEANFMUS',
	239	'NCEHISMUS',
	240	'NCEIGBMUS',
	241	'NCESPCCSC',
	242	):
[14931]	243	amount += 3000
[10012]	244	# NCE II
[9143]	245	elif student.current_level in (100, 110, 120) and \
	246	student.state == RETURNING:
	247	if student.depcode in ARTS:
[15283]	248	amount = 24500
[9143]	249	else:
[15283]	250	amount = 25000
[16899]	251	# NCE III third semester
	252	elif category == 'schoolfee_third':
	253	amount = 7000
[17706]	254	increment_2022 = 0
[10012]	255	# NCE III
[9143]	256	elif student.current_level in (200, 210, 220):
	257	if student.depcode in ARTS:
[14931]	258	amount = 15375
[9143]	259	else:
[14931]	260	amount = 15875
[17113]	261	increment_2022 = 20125
[10012]	262	# NCE III repeater
[9143]	263	elif student.current_level in (300, 310, 320) and \
	264	student.current_verdict == 'O':
	265	if student.depcode in ARTS:
[14931]	266	amount = 13475
[9143]	267	else:
[14931]	268	amount = 13975
[17499]	269	increment_2022 = 11000
[10012]	270	# NCE III spillover
[9143]	271	elif student.current_level in (300, 310, 320) and \
	272	student.current_verdict == 'B':
	273	if student.depcode in ARTS:
[14931]	274	amount = 13475
[9143]	275	else:
[14931]	276	amount = 13975
[17113]	277	increment_2022 = 20125
[10012]	278	# NCE III second spillover
[9143]	279	elif student.current_level in (400, 410, 420) and \
	280	student.current_verdict == 'B':
	281	if student.depcode in ARTS:
[14931]	282	amount = 13475
[9143]	283	else:
[14931]	284	amount = 13975
[17113]	285	increment_2022 = 20125
[9143]	286	else:
[14265]	287	# NCE I fresh sw
[9143]	288	if student.current_level == 100 and student.state == CLEARED:
	289	if student.depcode in ARTS:
[14193]	290	amount = 23100
[9143]	291	else:
[14193]	292	amount = 23600
[14265]	293	# NCE II fresh sw
	294	elif student.current_level == 200 and student.state == CLEARED:
	295	if student.depcode in ARTS:
	296	amount = 19000
	297	else:
	298	amount = 19500
[10012]	299	# NCE II sw
[9143]	300	elif student.current_level in (100, 110, 120) and \
	301	student.state == RETURNING:
	302	if student.depcode in ARTS:
[11850]	303	amount = 19000
[9143]	304	else:
[11882]	305	amount = 19500
[10012]	306	# NCE III sw
[9143]	307	elif student.current_level in (200, 210, 220):
	308	if student.depcode in ARTS:
[11850]	309	amount = 21000
[9143]	310	else:
[14193]	311	amount = 21500
[10012]	312	# NCE IV sw
[9143]	313	elif student.current_level in (300, 310, 320):
	314	if student.depcode in ARTS:
[11850]	315	amount = 19000
[9143]	316	else:
[11850]	317	amount = 19500
[10012]	318	# NCE V sw
[9143]	319	elif student.current_level in (400, 410, 420):
	320	if student.depcode in ARTS:
[11850]	321	amount = 19000
[9143]	322	else:
[11850]	323	amount = 19500
[10012]	324	# NCE V spillover sw
[9143]	325	elif student.current_level in (500, 510, 520) and \
	326	student.current_verdict == 'B':
	327	if student.depcode in ARTS:
[11850]	328	amount = 17500
[9143]	329	else:
[11850]	330	amount = 18000
[10012]	331	# NCE V second spillover sw
[9143]	332	elif student.current_level in (600, 610, 620) and \
	333	student.current_verdict == 'B':
	334	if student.depcode in ARTS:
[16921]	335	amount = 17500
[9143]	336	else:
[16921]	337	amount = 18000
[10009]	338	# NCE student payment can be disabled by
	339	# setting the base school fee to -1
	340	if academic_session.school_fee_base == -1 and \
	341	student.current_mode.startswith('nce'):
[10010]	342	return _(u'School fee payment is disabled.'), None
[9297]	343	if student.state == RETURNING:
[9525]	344	# Override p_session and p_level
[9297]	345	p_session, p_level = self.getReturningData(student)
[9525]	346	academic_session = self._getSessionConfiguration(p_session)
	347	if academic_session == None:
	348	return _(u'Session configuration object is not available.'), None
[17501]	349	if amount and p_session > 2021:
[17493]	350	amount += increment_2022
[17087]	351	else:
	352	fee_name = category + '_fee'
	353	amount = getattr(academic_session, fee_name, 0.0)
	354
[8599]	355	if amount in (0.0, None):
	356	return _(u'Amount could not be determined.'), None
[14566]	357
	358	# Add session and level specific penalty fee.
[13881]	359	if category == 'schoolfee' and student.current_mode in (
[14617]	360	'ug_ft', 'de_ft') and student.state != CLEARED:
[13881]	361	amount += academic_session.penalty_ug_ft
	362	elif category == 'schoolfee' and student.current_mode in (
[14556]	363	'nce_ft',) and student['studycourse'].previous_verdict != 'O':
[14566]	364	# NCE I fresh
	365	if student.current_level == 100 and student.state == CLEARED:
	366	amount += academic_session.penalty_nce1_ft
	367	# NCE II
	368	elif student.current_level in (100, 110, 120) and \
	369	student.state == RETURNING:
	370	amount += academic_session.penalty_nce2_ft
	371	# NCE III (except repeaters and spillovers)
	372	elif student.current_level in (200, 210, 220):
	373	amount += academic_session.penalty_nce3_ft
[14618]	374	elif category == 'schoolfee' and student.current_mode in ('nce_sw',
	375	'nce_pt') and student['studycourse'].previous_verdict != 'O':
[14566]	376	# NCE I fresh
	377	if student.current_level == 100 and student.state == CLEARED:
	378	amount += academic_session.penalty_nce1_pt
	379	# NCE II
	380	elif student.current_level in (100, 110, 120) and \
	381	student.state == RETURNING:
	382	amount += academic_session.penalty_nce2_pt
	383	# NCE III (except repeaters and spillovers)
	384	elif student.current_level in (200, 210, 220):
	385	amount += academic_session.penalty_nce3_pt
[13881]	386	elif category == 'schoolfee' and student.current_mode in ('prence',):
	387	amount += academic_session.penalty_prence
[11649]	388	if self.samePaymentMade(student, category, p_item, p_session):
	389	return _('This type of payment has already been made.'), None
[11457]	390	if self._isPaymentDisabled(p_session, category, student):
[13800]	391	return _('This category of payments has been disabled.'), None
[8713]	392	payment = createObject(u'waeup.StudentOnlinePayment')
[8953]	393	timestamp = ("%d" % int(time()*10000))[1:]
[8599]	394	payment.p_id = "p%s" % timestamp
	395	payment.p_category = category
	396	payment.p_item = p_item
	397	payment.p_session = p_session
	398	payment.p_level = p_level
[9153]	399	payment.p_current = p_current
[10388]	400	payment.amount_auth = float(amount) + GATEWAY_AMT
[8599]	401	return None, payment
[7621]	402
[9207]	403	def getAccommodationDetails(self, student):
	404	"""Determine the accommodation data of a student.
	405	"""
	406	d = {}
	407	d['error'] = u''
	408	hostels = grok.getSite()['hostels']
	409	d['booking_session'] = hostels.accommodation_session
	410	d['allowed_states'] = hostels.accommodation_states
	411	d['startdate'] = hostels.startdate
	412	d['enddate'] = hostels.enddate
	413	d['expired'] = hostels.expired
	414	# Determine bed type
	415	studycourse = student['studycourse']
	416	certificate = getattr(studycourse,'certificate',None)
	417	current_level = studycourse.current_level
	418	if None in (current_level, certificate):
	419	return d
	420	end_level = certificate.end_level
	421	if current_level == 10:
	422	bt = 'pr'
	423	elif current_level == 100:
	424	bt = 'fr'
	425	elif current_level >= 300:
	426	bt = 'fi'
	427	else:
	428	bt = 're'
	429	if student.sex == 'f':
	430	sex = 'female'
	431	else:
	432	sex = 'male'
	433	special_handling = 'regular'
[13614]	434	if certificate.study_mode == 'ug_ft':
	435	special_handling = 'ugft'
[9207]	436	d['bt'] = u'%s_%s_%s' % (special_handling,sex,bt)
	437	return d
	438
[14617]	439	#def warnCreditsOOR(self, studylevel, course=None):
	440	# """Return message if credits are out of range.
	441	# """
	442	# # adding a course ticket
	443	# if course:
	444	# if course.semester == 1:
	445	# if studylevel.total_credits_s1 + course.credits > 24:
	446	# return _('Maximum credits in 1st semester exceeded.')
	447	# if course.semester == 2:
	448	# if studylevel.total_credits_s2 + course.credits > 24:
	449	# return _('Maximum credits in 2nd semester exceeded.')
	450	# # registering course list
	451	# else:
	452	# if studylevel.total_credits_s1 > 24:
	453	# return _('Maximum credits in 1st semester exceeded.')
	454	# if studylevel.total_credits_s1 < 18:
	455	# return _('Minimum credits in 1st semester not reached.')
	456	# if studylevel.total_credits_s2 > 24:
	457	# return _('Maximum credits in 2nd semester exceeded.')
	458	# if studylevel.total_credits_s2 < 18:
	459	# return _('Minimum credits in 2nd semester not reached.')
	460	# return
	461
[14586]	462	def warnCreditsOOR(self, studylevel, course=None):
[14591]	463	"""Return message if credits are out of range.
[9903]	464	"""
[14591]	465	# adding a course ticket
	466	if course:
[14617]	467	if studylevel.total_credits + course.credits > 52:
	468	return _('Maximum credits exceeded.')
[14591]	469	# registering course list
	470	else:
[14617]	471	if studylevel.total_credits > 52:
	472	return _('Maximum credits exceeded.')
[14618]	473	if studylevel.__parent__.previous_verdict == 'O':
	474	return
[14591]	475	if studylevel.total_credits_s1 < 18:
	476	return _('Minimum credits in 1st semester not reached.')
	477	if studylevel.total_credits_s2 < 18:
	478	return _('Minimum credits in 2nd semester not reached.')
[14586]	479	return
[9903]	480
[9950]	481	def getPDFCreator(self, context):
	482	"""Get a pdf creator suitable for `context`.
	483
	484	The default implementation always returns the default creator.
	485	"""
	486	mode = getattr(context, 'current_mode', None)
	487	if mode and mode.startswith('ug'):
	488	return getUtility(IPDFCreator, name='ibadan_pdfcreator')
	489	return getUtility(IPDFCreator)
	490
[9982]	491	def _admissionText(self, student, portal_language):
	492	mode = getattr(student, 'current_mode', None)
	493	if mode and mode.startswith('ug'):
	494	text = trans(_(
[17576]	495	'With reference to your application for admission into '
	496	'Bachelor Degree Programme of the University of Ibadan, '
	497	'you have been provisionally admitted to a full-time '
	498	'Bachelor of Arts in Education Degree Programme as follows: '),
[9982]	499	portal_language)
	500	else:
	501	inst_name = grok.getSite()['configuration'].name
	502	text = trans(_(
[17576]	503	'You have been provisionally admitted into Federal College '
	504	'of Education Okene as follows: '
[17577]	505	),
[9982]	506	portal_language)
	507	return text
	508
[9989]	509	def getBedCoordinates(self, bedticket):
	510	"""Return bed coordinates.
	511
	512	Bed coordinates are invisible in FCEOkene.
	513	"""
	514	return _('(see payment slip)')
	515
[13030]	516	def _isPaymentDisabled(self, p_session, category, student):
	517	academic_session = self._getSessionConfiguration(p_session)
	518	if category == 'schoolfee':
	519	if 'sf_all' in academic_session.payment_disabled:
	520	return True
	521	if 'sf_nce1' in academic_session.payment_disabled and \
	522	student.current_level == 100 and student.state == CLEARED and \
	523	student.current_mode == 'nce_ft':
	524	return True
[16554]	525	if category == 'clearance':
	526	if 'cl_except_ug' in academic_session.payment_disabled and \
	527	student.current_mode != 'ug_ft':
	528	return True
[13030]	529	return False
	530
[10019]	531	SEPARATORS_DICT = {
	532	'form.fst_sit_fname': _(u'First Sitting Record'),
	533	'form.scd_sit_fname': _(u'Second Sitting Record'),
	534	#'form.alr_fname': _(u'Advanced Level Record'),
	535	'form.hq_type': _(u'Advanced Level Record'),
	536	'form.hq2_type': _(u'Second Higher Education Record'),
	537	'form.nysc_year': _(u'NYSC Information'),
	538	'form.employer': _(u'Employment History'),
	539	'form.former_matric': _(u'Former Student'),
	540	}
	541
[10023]	542	SKIP_UPLOAD_VIEWLETS = (
	543	'higherqualificationresultupload',
	544	'secondHigherqualificationresultupload',
	545	'certificateupload',
	546	'secondcertificateupload',
	547	'thirdcertificateupload',
	548	'resultstatementupload',
	549	'secondrefereeletterupload',
	550	'thirdrefereeletterupload',)
	551
[17178]	552	ACCOMMODATION_SPAN = 1
	553
[8460]	554	# FCEOkene prefix
[10520]	555	STUDENT_ID_PREFIX = u'K'

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

Context navigation

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

Download in other formats: