source: main/waeup.aaue/trunk/src/waeup/aaue/students/utils.py @ 13018

Last change on this file since 13018 was 12975, checked in by Henrik Bettermann, 10 years ago

To guarantee that cleared students pay both acceptance fees and
school fees, a school fee payment POST request to the Interswitch
CollegePAY payment gateway can only be sent if
acceptance/clearance fee has been successfully queried/paid
beforehand. This requirement applies to students in state 'cleared'
and entry_session greater than 2013 only, see ticket #119.
  • Property svn:keywords set to Id
File size: 9.5 KB
Line 
1## $Id: utils.py 12975 2015-05-21 17:05:42Z 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##
18import grok
19from time import time
20from zope.component import createObject
21from waeup.kofa.interfaces import (
22    CLEARED, RETURNING, PAID, academic_sessions_vocab)
23from kofacustom.nigeria.students.utils import NigeriaStudentsUtils
24from waeup.kofa.accesscodes import create_accesscode
25from waeup.kofa.students.utils import trans
26from waeup.aaue.interfaces import MessageFactory as _
27
28class CustomStudentsUtils(NigeriaStudentsUtils):
29    """A collection of customized methods.
30
31    """
32
33    VERDICTS_DICT = {
34        '0': 'not yet',
35        'A': 'Successful student',
36        'B': 'Student with carryover courses',
37        'C': 'Student on probation',
38        #'D': 'Withdrawn from the faculty',
39        #'E': 'Student who were previously on probation',
40        #'F': 'Medical case',
41        #'G': 'Absent from examination',
42        #'H': 'Withheld results',
43        #'I': 'Expelled/rusticated/suspended student',
44        #'J': 'Temporary withdrawn from the university',
45        #'K': 'Unregistered student',
46        #'L': 'Referred student',
47        #'M': 'Reinstatement',
48        #'N': 'Student on transfer',
49        #'O': 'NCE-III repeater',
50        #'Y': 'No previous verdict',
51        #'X': 'New 300 level student',
52        'Z': 'Successful student (provisional)',
53        #'A1': 'First Class',
54        #'A2': 'Second Class Upper',
55        #'A3': 'Second Class Lower',
56        #'A4': 'Third Class',
57        #'A5': 'Pass',
58        #'A6': 'Distinction',
59        #'A7': 'Credit',
60        #'A8': 'Merit',
61        'NEOR': 'No evidence of registration',
62        'NEOV': 'No evidence of verification',
63        'FRNS': 'Faculty requirements not satisfied',
64        }
65
66    gpa_boundaries = ((1, 'FRNS'),
67                      (1.5, 'Pass'),
68                      (2.4, '3rd Class Honours'),
69                      (3.5, '2nd Class Honours Lower Division'),
70                      (4.5, '2nd Class Honours Upper Division'),
71                      (5, '1st Class Honours'))
72
73    def constructMatricNumber(self, student):
74        next_integer = grok.getSite()['configuration'].next_matric_integer
75        if next_integer == 0:
76            return None
77        faccode = student.faccode
78        depcode = student.depcode
79        year = unicode(student.entry_session)[2:]
80        if student.current_mode in ('ug_pt', 'de_pt') \
81            and student.state in (PAID, ) \
82            and student.is_fresh:
83            return None, "PTP/%s/%s/%s/%05d" % (
84                faccode, depcode, year, next_integer)
85
86        #if student.current_mode in ('pg_ft', 'pg_pt'):
87        #    return None, "SPS/%s/%s/%s/%05d" % (
88        #    faccode, depcode, year, next_integer)
89        #if student.current_mode in ('dp_ft', 'dp_pt'):
90        #    return None, "DIP/%s/%s/%s/%05d" % (
91        #    faccode, depcode, year, next_integer)
92        #if student.current_mode == 'found':
93        #    return _(
94        #    'Foundation programme students don\'t have matric number.'), None
95        #return None, "%s/%s/%s/%05d" % (faccode, depcode, year, next_integer)
96
97        return _('Matriculation number cannot be set.'), None
98
99    def getReturningData(self, student):
100        """ This method defines what happens after school fee payment
101        of returning students depending on the student's senate verdict.
102        """
103        prev_level = student['studycourse'].current_level
104        cur_verdict = student['studycourse'].current_verdict
105        if cur_verdict in ('A','B','L','M','N','Z',):
106            # Successful student
107            new_level = divmod(int(prev_level),100)[0]*100 + 100
108        elif cur_verdict == 'C':
109            # Student on probation
110            new_level = int(prev_level) + 10
111        else:
112            # Student is somehow in an undefined state.
113            # Level has to be set manually.
114            new_level = prev_level
115        new_session = student['studycourse'].current_session + 1
116        return new_session, new_level
117
118    def setPaymentDetails(self, category, student,
119            previous_session=None, previous_level=None):
120        """Create Payment object and set the payment data of a student for
121        the payment category specified.
122
123        """
124        details = {}
125        p_item = u''
126        amount = 0.0
127        error = u''
128        if previous_session:
129            return _('Previous session payment not yet implemented.'), None
130        p_session = student['studycourse'].current_session
131        p_level = student['studycourse'].current_level
132        p_current = True
133        academic_session = self._getSessionConfiguration(p_session)
134        if academic_session == None:
135            return _(u'Session configuration object is not available.'), None
136        # Determine fee.
137        if category == 'transfer':
138            amount = academic_session.transfer_fee
139        elif category == 'transcript':
140            amount = academic_session.transcript_fee
141        elif category == 'gown':
142            amount = academic_session.gown_fee
143        elif category == 'bed_allocation':
144            amount = academic_session.booking_fee
145        elif category == 'hostel_maintenance':
146            amount = academic_session.maint_fee
147        elif category == 'clearance':
148            if student.faccode == 'FP':
149                amount = academic_session.clearance_fee_fp
150            else:
151                amount = academic_session.clearance_fee
152            p_item = student['studycourse'].certificate.code
153        elif category == 'late_registration':
154            amount = academic_session.late_fee
155        elif category == 'schoolfee':
156            try:
157                certificate = student['studycourse'].certificate
158                p_item = certificate.code
159            except (AttributeError, TypeError):
160                return _('Study course data are incomplete.'), None
161            if student.state == CLEARED:
162                if student.faccode == 'FP':
163                    amount = academic_session.school_fee_3
164                else:
165                    amount = academic_session.school_fee_1
166            elif student.state == RETURNING or\
167                (student.is_postgrad and student.state == PAID):
168                academic_session = self._getSessionConfiguration(p_session)
169                if academic_session == None:
170                    return _(u'Session configuration object is not available.'), None
171                if student.state == RETURNING:
172                    p_session, p_level = self.getReturningData(student)
173                else:
174                    # Returning postgraduate students also pay for the
175                    # next session but their level always remains the same.
176                    p_session += 1
177                try:
178                    academic_session = grok.getSite()[
179                        'configuration'][str(p_session)]
180                except KeyError:
181                    return _(u'Session configuration object is not available.'), None
182                amount = academic_session.school_fee_2
183            else:
184                return _('Wrong state.'), None
185        if amount in (0.0, None):
186            return _(u'Amount could not be determined.'), None
187        # Add session specific penalty fee.
188        if category == 'schoolfee' and student.is_postgrad:
189            amount += academic_session.penalty_pg
190        elif category == 'schoolfee':
191            amount += academic_session.penalty_ug
192        # Create ticket.
193        for key in student['payments'].keys():
194            ticket = student['payments'][key]
195            if ticket.p_state == 'paid' and\
196               ticket.p_category == category and \
197               ticket.p_item == p_item and \
198               ticket.p_session == p_session:
199                  return _('This type of payment has already been made.'), None
200        if self._isPaymentDisabled(p_session, category, student):
201            return _('Payment temporarily disabled.'), None
202        payment = createObject(u'waeup.StudentOnlinePayment')
203        timestamp = ("%d" % int(time()*10000))[1:]
204        payment.p_id = "p%s" % timestamp
205        payment.p_category = category
206        payment.p_item = p_item
207        payment.p_session = p_session
208        payment.p_level = p_level
209        payment.p_current = p_current
210        payment.amount_auth = amount
211        return None, payment
212
213    def _admissionText(self, student, portal_language):
214        inst_name = grok.getSite()['configuration'].name
215        entry_session = student['studycourse'].entry_session
216        entry_session = academic_sessions_vocab.getTerm(entry_session).title
217        text = trans(_(
218            'This is to inform you that you have been offered provisional'
219            ' admission into ${a} for the ${b} academic session as follows:',
220            mapping = {'a': inst_name, 'b': entry_session}),
221            portal_language)
222        return text
223
224    def maxCredits(self, studylevel):
225        """Return maximum credits.
226
227        """
228        return 48
229
230    # AAUE prefix
231    STUDENT_ID_PREFIX = u'E'
Note: See TracBrowser for help on using the repository browser.