Context navigation

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

Last change on this file since 16541 was 16541, checked in by Henrik Bettermann, 3 years ago
See ticket #414.
Property svn:keywords set to `Id`
File size: 21.0 KB

Rev	Line
[7419]	1	## $Id: utils.py 16541 2021-07-12 10:44:44Z 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
[16479]	74	def _nce3PaymentMade(self, student, p_level):
[16008]	75	if len(student['payments']):
	76	for ticket in student['payments'].values():
[16463]	77	if ticket.p_state in ('paid', 'scholarship', 'waived') and \
[16479]	78	ticket.p_level == p_level and \
[16008]	79	ticket.p_category == 'schoolfee':
	80	return True
	81	return False
	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':
[8599]	107	amount = academic_session.booking_fee
[7151]	108	elif category == 'hostel_maintenance':
[9611]	109	current_session = student['studycourse'].current_session
	110	bedticket = student['accommodation'].get(str(current_session), None)
	111	if bedticket is not None and bedticket.bed is not None:
	112	p_item = bedticket.bed_coordinates
[13616]	113	if bedticket.bed.__parent__.maint_fee > 0:
	114	amount = bedticket.bed.__parent__.maint_fee
[9611]	115	else:
[13616]	116	return _(u'No bed space allocated.'), None
	117	if student.current_mode.endswith('_sw') \
	118	or student.current_mode == 'pd_ft':
	119	amount *= 0.625
[7151]	120	elif category == 'clearance':
[9143]	121	amount = academic_session.clearance_fee
[8599]	122	try:
	123	p_item = student['studycourse'].certificate.code
	124	except (AttributeError, TypeError):
	125	return _('Study course data are incomplete.'), None
[13800]	126	if student.state not in (ADMITTED, CLEARANCE, REQUESTED, CLEARED):
	127	return _(u'Acceptance Fee payments not allowed.'), None
[16011]	128	elif category == 'third_semester' and student.current_mode == 'nce_ft' \
[16480]	129	and p_level in (300, 310, 320, 400, 410, 420):
[16479]	130	if not self._nce3PaymentMade(student, p_level):
[16008]	131	return _(u'Make NCE 3 school fee payment first.'), None
[11919]	132	if student.depcode in ARTS:
[14931]	133	amount = 7688
[11919]	134	else:
[14931]	135	amount = 7938
[16461]	136	elif category.startswith('schoolfee'):
	137	if category == 'schoolfee_pde1':
[16462]	138	if not student.current_mode.startswith('pd'):
	139	return _('You are not a PDE student.'), None
[16461]	140	if student.state != CLEARED:
	141	return _('You are not a fresh student.'), None
[12602]	142	p_item = student.certcode
	143	if not p_item:
[8599]	144	return _('Study course data are incomplete.'), None
[10012]	145	if student.state not in (CLEARED, RETURNING):
	146	return _('Wrong state.'), None
[10661]	147	# PDE repeater
	148	if student.current_verdict == 'OPDE':
[11850]	149	amount = 23000
[13274]	150	# PDE new
	151	elif student.current_mode == 'pd_ft' and student.state == CLEARED:
[15523]	152	amount = 70000
[16461]	153	if category == 'schoolfee_pde1':
	154	amount = 40000
[10660]	155	# PDE
	156	elif student.current_mode == 'pd_ft':
[13275]	157	amount = 35300
[12602]	158
	159	#Short Duration ICT Programs
	160	elif p_item in ('CCO','DPMTS','DTPGD') and \
	161	student.state == CLEARED:
	162	amount = 15000
	163	elif p_item in ('ADTPGD','ADPMTS') and \
	164	student.state == CLEARED:
	165	amount = 16000
	166	elif p_item in ('ADPMTSI','ADTPGDI','DPMTSI','DTPGDI') and \
	167	student.state == CLEARED:
	168	amount = 25000
	169	elif p_item in ('ADPMTSA','ADTPGDA') and \
	170	student.state == CLEARED:
	171	amount = 35000
	172
[10012]	173	# UG
	174	elif student.current_mode == 'ug_ft':
[10876]	175	if student.state == CLEARED:
	176	amount = 65650
[13779]	177	# Introducing repeater fee for 'ug_ft' for 1st time
	178	# on 15/03/2016
	179	elif student.current_verdict == 'O':
	180	amount = 56150
[10876]	181	else:
[14379]	182	amount = 56150
[10012]	183	# NCE
[9143]	184	elif not student.current_mode.endswith('_sw'):
	185	# PRENCE
	186	if student.current_level == 10 and student.state == CLEARED:
	187	if student.depcode in ARTS:
[14933]	188	amount = 24500
[9143]	189	else:
[14933]	190	amount = 25000
[10012]	191	# NCE I fresh
[9143]	192	elif student.current_level == 100 and student.state == CLEARED:
	193	if student.depcode in ARTS:
[15283]	194	amount = 28000
[9143]	195	else:
[15283]	196	amount = 28500
[14931]	197	# SIWES Fee
[16541]	198	if student.depcode in ('AGE', 'BED', 'FAA',
	199	'HEC', 'CSC', 'MUS'):
[14931]	200	amount += 3000
[16541]	201	if student.certcode in ('NCECHECSC', 'NCEBIOCSC',
	202	'NCEPHYCSC', 'NCEPHECSC',):
	203	amount += 3000
[10012]	204	# NCE II
[9143]	205	elif student.current_level in (100, 110, 120) and \
	206	student.state == RETURNING:
	207	if student.depcode in ARTS:
[15283]	208	amount = 24500
[9143]	209	else:
[15283]	210	amount = 25000
[10012]	211	# NCE III
[9143]	212	elif student.current_level in (200, 210, 220):
	213	if student.depcode in ARTS:
[14931]	214	amount = 15375
[9143]	215	else:
[14931]	216	amount = 15875
[10012]	217	# NCE III repeater
[9143]	218	elif student.current_level in (300, 310, 320) and \
	219	student.current_verdict == 'O':
	220	if student.depcode in ARTS:
[14931]	221	amount = 13475
[9143]	222	else:
[14931]	223	amount = 13975
[10012]	224	# NCE III spillover
[9143]	225	elif student.current_level in (300, 310, 320) and \
	226	student.current_verdict == 'B':
	227	if student.depcode in ARTS:
[14931]	228	amount = 13475
[9143]	229	else:
[14931]	230	amount = 13975
[10012]	231	# NCE III second spillover
[9143]	232	elif student.current_level in (400, 410, 420) and \
	233	student.current_verdict == 'B':
	234	if student.depcode in ARTS:
[14931]	235	amount = 13475
[9143]	236	else:
[14931]	237	amount = 13975
[9143]	238	else:
[14265]	239	# NCE I fresh sw
[9143]	240	if student.current_level == 100 and student.state == CLEARED:
	241	if student.depcode in ARTS:
[14193]	242	amount = 23100
[9143]	243	else:
[14193]	244	amount = 23600
[14265]	245	# NCE II fresh sw
	246	elif student.current_level == 200 and student.state == CLEARED:
	247	if student.depcode in ARTS:
	248	amount = 19000
	249	else:
	250	amount = 19500
[10012]	251	# NCE II sw
[9143]	252	elif student.current_level in (100, 110, 120) and \
	253	student.state == RETURNING:
	254	if student.depcode in ARTS:
[11850]	255	amount = 19000
[9143]	256	else:
[11882]	257	amount = 19500
[10012]	258	# NCE III sw
[9143]	259	elif student.current_level in (200, 210, 220):
	260	if student.depcode in ARTS:
[11850]	261	amount = 21000
[9143]	262	else:
[14193]	263	amount = 21500
[10012]	264	# NCE IV sw
[9143]	265	elif student.current_level in (300, 310, 320):
	266	if student.depcode in ARTS:
[11850]	267	amount = 19000
[9143]	268	else:
[11850]	269	amount = 19500
[10012]	270	# NCE V sw
[9143]	271	elif student.current_level in (400, 410, 420):
	272	if student.depcode in ARTS:
[11850]	273	amount = 19000
[9143]	274	else:
[11850]	275	amount = 19500
[10012]	276	# NCE V spillover sw
[9143]	277	elif student.current_level in (500, 510, 520) and \
	278	student.current_verdict == 'B':
	279	if student.depcode in ARTS:
[11850]	280	amount = 17500
[9143]	281	else:
[11850]	282	amount = 18000
[10012]	283	# NCE V second spillover sw
[9143]	284	elif student.current_level in (600, 610, 620) and \
	285	student.current_verdict == 'B':
	286	if student.depcode in ARTS:
[11850]	287	amount = 17500
[9143]	288	else:
[11850]	289	amount = 18000
[10009]	290	# NCE student payment can be disabled by
	291	# setting the base school fee to -1
	292	if academic_session.school_fee_base == -1 and \
	293	student.current_mode.startswith('nce'):
[10010]	294	return _(u'School fee payment is disabled.'), None
[9297]	295	if student.state == RETURNING:
[9525]	296	# Override p_session and p_level
[9297]	297	p_session, p_level = self.getReturningData(student)
[9525]	298	academic_session = self._getSessionConfiguration(p_session)
	299	if academic_session == None:
	300	return _(u'Session configuration object is not available.'), None
[9143]	301
[8599]	302	if amount in (0.0, None):
	303	return _(u'Amount could not be determined.'), None
[14566]	304
	305	# Add session and level specific penalty fee.
[13881]	306	if category == 'schoolfee' and student.current_mode in (
[14617]	307	'ug_ft', 'de_ft') and student.state != CLEARED:
[13881]	308	amount += academic_session.penalty_ug_ft
	309	elif category == 'schoolfee' and student.current_mode in (
[14556]	310	'nce_ft',) and student['studycourse'].previous_verdict != 'O':
[14566]	311	# NCE I fresh
	312	if student.current_level == 100 and student.state == CLEARED:
	313	amount += academic_session.penalty_nce1_ft
	314	# NCE II
	315	elif student.current_level in (100, 110, 120) and \
	316	student.state == RETURNING:
	317	amount += academic_session.penalty_nce2_ft
	318	# NCE III (except repeaters and spillovers)
	319	elif student.current_level in (200, 210, 220):
	320	amount += academic_session.penalty_nce3_ft
[14618]	321	elif category == 'schoolfee' and student.current_mode in ('nce_sw',
	322	'nce_pt') and student['studycourse'].previous_verdict != 'O':
[14566]	323	# NCE I fresh
	324	if student.current_level == 100 and student.state == CLEARED:
	325	amount += academic_session.penalty_nce1_pt
	326	# NCE II
	327	elif student.current_level in (100, 110, 120) and \
	328	student.state == RETURNING:
	329	amount += academic_session.penalty_nce2_pt
	330	# NCE III (except repeaters and spillovers)
	331	elif student.current_level in (200, 210, 220):
	332	amount += academic_session.penalty_nce3_pt
[13881]	333	elif category == 'schoolfee' and student.current_mode in ('prence',):
	334	amount += academic_session.penalty_prence
[11649]	335	if self.samePaymentMade(student, category, p_item, p_session):
	336	return _('This type of payment has already been made.'), None
[11457]	337	if self._isPaymentDisabled(p_session, category, student):
[13800]	338	return _('This category of payments has been disabled.'), None
[8713]	339	payment = createObject(u'waeup.StudentOnlinePayment')
[8953]	340	timestamp = ("%d" % int(time()*10000))[1:]
[8599]	341	payment.p_id = "p%s" % timestamp
	342	payment.p_category = category
	343	payment.p_item = p_item
	344	payment.p_session = p_session
	345	payment.p_level = p_level
[9153]	346	payment.p_current = p_current
[10388]	347	payment.amount_auth = float(amount) + GATEWAY_AMT
[8599]	348	return None, payment
[7621]	349
[9207]	350	def getAccommodationDetails(self, student):
	351	"""Determine the accommodation data of a student.
	352	"""
	353	d = {}
	354	d['error'] = u''
	355	hostels = grok.getSite()['hostels']
	356	d['booking_session'] = hostels.accommodation_session
	357	d['allowed_states'] = hostels.accommodation_states
	358	d['startdate'] = hostels.startdate
	359	d['enddate'] = hostels.enddate
	360	d['expired'] = hostels.expired
	361	# Determine bed type
	362	studycourse = student['studycourse']
	363	certificate = getattr(studycourse,'certificate',None)
	364	current_level = studycourse.current_level
	365	if None in (current_level, certificate):
	366	return d
	367	end_level = certificate.end_level
	368	if current_level == 10:
	369	bt = 'pr'
	370	elif current_level == 100:
	371	bt = 'fr'
	372	elif current_level >= 300:
	373	bt = 'fi'
	374	else:
	375	bt = 're'
	376	if student.sex == 'f':
	377	sex = 'female'
	378	else:
	379	sex = 'male'
	380	special_handling = 'regular'
[13614]	381	if certificate.study_mode == 'ug_ft':
	382	special_handling = 'ugft'
[9207]	383	d['bt'] = u'%s_%s_%s' % (special_handling,sex,bt)
	384	return d
	385
[14617]	386	#def warnCreditsOOR(self, studylevel, course=None):
	387	# """Return message if credits are out of range.
	388	# """
	389	# # adding a course ticket
	390	# if course:
	391	# if course.semester == 1:
	392	# if studylevel.total_credits_s1 + course.credits > 24:
	393	# return _('Maximum credits in 1st semester exceeded.')
	394	# if course.semester == 2:
	395	# if studylevel.total_credits_s2 + course.credits > 24:
	396	# return _('Maximum credits in 2nd semester exceeded.')
	397	# # registering course list
	398	# else:
	399	# if studylevel.total_credits_s1 > 24:
	400	# return _('Maximum credits in 1st semester exceeded.')
	401	# if studylevel.total_credits_s1 < 18:
	402	# return _('Minimum credits in 1st semester not reached.')
	403	# if studylevel.total_credits_s2 > 24:
	404	# return _('Maximum credits in 2nd semester exceeded.')
	405	# if studylevel.total_credits_s2 < 18:
	406	# return _('Minimum credits in 2nd semester not reached.')
	407	# return
	408
[14586]	409	def warnCreditsOOR(self, studylevel, course=None):
[14591]	410	"""Return message if credits are out of range.
[9903]	411	"""
[14591]	412	# adding a course ticket
	413	if course:
[14617]	414	if studylevel.total_credits + course.credits > 52:
	415	return _('Maximum credits exceeded.')
[14591]	416	# registering course list
	417	else:
[14617]	418	if studylevel.total_credits > 52:
	419	return _('Maximum credits exceeded.')
[14618]	420	if studylevel.__parent__.previous_verdict == 'O':
	421	return
[14591]	422	if studylevel.total_credits_s1 < 18:
	423	return _('Minimum credits in 1st semester not reached.')
	424	if studylevel.total_credits_s2 < 18:
	425	return _('Minimum credits in 2nd semester not reached.')
[14586]	426	return
[9903]	427
[9950]	428	def getPDFCreator(self, context):
	429	"""Get a pdf creator suitable for `context`.
	430
	431	The default implementation always returns the default creator.
	432	"""
	433	mode = getattr(context, 'current_mode', None)
	434	if mode and mode.startswith('ug'):
	435	return getUtility(IPDFCreator, name='ibadan_pdfcreator')
	436	return getUtility(IPDFCreator)
	437
[9982]	438	def _admissionText(self, student, portal_language):
	439	mode = getattr(student, 'current_mode', None)
	440	if mode and mode.startswith('ug'):
	441	text = trans(_(
	442	'With reference to your application for admission into Bachelor Degree '
	443	'Programme of the University of Ibadan, this is to inform you that you have '
	444	'been provisionally admitted to pursue a full-time Bachelor of Arts in '
	445	'Education Degree Programme as follows:'),
	446	portal_language)
	447	else:
	448	inst_name = grok.getSite()['configuration'].name
	449	text = trans(_(
[15890]	450	'This is to inform you that you have been provisionally\n'
[15891]	451	'admitted into ${a}\n'
	452	'as follows:', mapping = {'a': inst_name}),
[9982]	453	portal_language)
	454	return text
	455
[9989]	456	def getBedCoordinates(self, bedticket):
	457	"""Return bed coordinates.
	458
	459	Bed coordinates are invisible in FCEOkene.
	460	"""
	461	return _('(see payment slip)')
	462
[13030]	463	def _isPaymentDisabled(self, p_session, category, student):
	464	academic_session = self._getSessionConfiguration(p_session)
	465	if category == 'schoolfee':
	466	if 'sf_all' in academic_session.payment_disabled:
	467	return True
	468	if 'sf_nce1' in academic_session.payment_disabled and \
	469	student.current_level == 100 and student.state == CLEARED and \
	470	student.current_mode == 'nce_ft':
	471	return True
	472	return False
	473
[10019]	474	SEPARATORS_DICT = {
	475	'form.fst_sit_fname': _(u'First Sitting Record'),
	476	'form.scd_sit_fname': _(u'Second Sitting Record'),
	477	#'form.alr_fname': _(u'Advanced Level Record'),
	478	'form.hq_type': _(u'Advanced Level Record'),
	479	'form.hq2_type': _(u'Second Higher Education Record'),
	480	'form.nysc_year': _(u'NYSC Information'),
	481	'form.employer': _(u'Employment History'),
	482	'form.former_matric': _(u'Former Student'),
	483	}
	484
[10023]	485	SKIP_UPLOAD_VIEWLETS = (
	486	'higherqualificationresultupload',
	487	'secondHigherqualificationresultupload',
	488	'certificateupload',
	489	'secondcertificateupload',
	490	'thirdcertificateupload',
	491	'resultstatementupload',
	492	'secondrefereeletterupload',
	493	'thirdrefereeletterupload',)
	494
[8460]	495	# FCEOkene prefix
[10520]	496	STUDENT_ID_PREFIX = u'K'

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

Download in other formats: