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

Last change on this file since 9756 was 9527, checked in by Henrik Bettermann, 12 years ago

Adjust to changes made in base package.
  • Property svn:keywords set to Id
File size: 7.7 KB
Line 
1## $Id: utils.py 9527 2012-11-04 20:12:59Z 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 CLEARED, RETURNING, PAID
22from kofacustom.nigeria.students.utils import NigeriaStudentsUtils
23from waeup.kofa.accesscodes import create_accesscode
24from waeup.aaue.interfaces import MessageFactory as _
25
26class CustomStudentsUtils(NigeriaStudentsUtils):
27    """A collection of customized methods.
28
29    """
30
31    def getReturningData(self, student):
32        """ This method defines what happens after school fee payment
33        of returning students depending on the student's senate verdict.
34        """
35        prev_level = student['studycourse'].current_level
36        cur_verdict = student['studycourse'].current_verdict
37        if cur_verdict in ('A','B','L','M','N','Z',):
38            # Successful student
39            new_level = divmod(int(prev_level),100)[0]*100 + 100
40        elif cur_verdict == 'C':
41            # Student on probation
42            new_level = int(prev_level) + 10
43        else:
44            # Student is somehow in an undefined state.
45            # Level has to be set manually.
46            new_level = prev_level
47        new_session = student['studycourse'].current_session + 1
48        return new_session, new_level
49
50    def setPaymentDetails(self, category, student,
51            previous_session=None, previous_level=None):
52        """Create Payment object and set the payment data of a student for
53        the payment category specified.
54
55        """
56        details = {}
57        p_item = u''
58        amount = 0.0
59        error = u''
60        if previous_session:
61            return _('Previous session payment not yet implemented.'), None
62        p_session = student['studycourse'].current_session
63        p_level = student['studycourse'].current_level
64        p_current = True
65        academic_session = self._getSessionConfiguration(p_session)
66        if academic_session == None:
67            return _(u'Session configuration object is not available.'), None
68        # Determine fee.
69        if category == 'schoolfee':
70            return _('School fee has to be paid by two instalments.'), None
71        if category == 'transfer':
72            amount = academic_session.transfer_fee
73        elif category == 'gown':
74            amount = academic_session.gown_fee
75        elif category == 'bed_allocation':
76            amount = academic_session.booking_fee
77        elif category == 'hostel_maintenance':
78            amount = academic_session.maint_fee
79        elif category == 'clearance':
80            amount = academic_session.clearance_fee
81            p_item = student['studycourse'].certificate.code
82        elif category == 'schoolfee_1':
83            try:
84                certificate = student['studycourse'].certificate
85                p_item = certificate.code
86            except (AttributeError, TypeError):
87                return _('Study course data are incomplete.'), None
88            payment_allowed = False
89            if student.state == CLEARED:
90                payment_allowed = True
91                amount = academic_session.school_fee_base
92            elif student.state == RETURNING or\
93                (student.is_postgrad and student.state == PAID):
94                academic_session = self._getSessionConfiguration(p_session)
95                if academic_session == None:
96                    return _(u'Session configuration object is not available.'), None
97                if student.state == RETURNING:
98                    p_session, p_level = self.getReturningData(student)
99                else:
100                    # Returning postgraduate students also pay for the
101                    # next session but their level always remains the same.
102                    p_session += 1
103                initial_instalment_made = False
104                for key in student['payments'].keys():
105                    ticket = student['payments'][key]
106                    if ticket.p_category == 'schoolfee_1' and \
107                        ticket.p_state == 'paid':
108                        initial_instalment_made = True
109                    if ticket.p_state == 'paid' and\
110                        ticket.p_category == 'schoolfee_2' and \
111                        ticket.p_item == p_item and \
112                        ticket.p_session == p_session-1: #  = current session
113                        payment_allowed = True
114                if not initial_instalment_made:
115                    payment_allowed = True
116                try:
117                    academic_session = grok.getSite()[
118                        'configuration'][str(p_session)]
119                except KeyError:
120                    return _(u'Session configuration object is not available.'), None
121                amount = academic_session.school_fee_base
122            else:
123                return _('Wrong state.'), None
124            if not payment_allowed:
125                return _('The previous 2nd school fee instalment '
126                         'has not yet been paid.'), None
127        elif category == 'schoolfee_2':
128            try:
129                certificate = student['studycourse'].certificate
130                p_item = certificate.code
131            except (AttributeError, TypeError):
132                return _('Study course data are incomplete.'), None
133            payment_allowed = False
134            for key in student['payments'].keys():
135                ticket = student['payments'][key]
136                if ticket.p_state == 'paid' and\
137                   ticket.p_category == 'schoolfee_1' and \
138                   ticket.p_item == p_item and \
139                   ticket.p_session == p_session:
140                   payment_allowed = True
141            if not payment_allowed:
142                return _('The 1st school fee instalment '
143                         'has not yet been paid or session has '
144                         'not yet been started.'), None
145            amount = academic_session.school_fee_base
146        if amount in (0.0, None):
147            return _(u'Amount could not be determined.'), None
148        # Add session specific penalty fee.
149        if category == 'schoolfee_1' and student.is_postgrad:
150            amount += academic_session.penalty_pg
151        elif category == 'schoolfee_1':
152            amount += academic_session.penalty_ug
153        # Create ticket.
154        for key in student['payments'].keys():
155            ticket = student['payments'][key]
156            if ticket.p_state == 'paid' and\
157               ticket.p_category == category and \
158               ticket.p_item == p_item and \
159               ticket.p_session == p_session:
160                  return _('This type of payment has already been made.'), None
161        payment = createObject(u'waeup.StudentOnlinePayment')
162        timestamp = ("%d" % int(time()*10000))[1:]
163        payment.p_id = "p%s" % timestamp
164        payment.p_category = category
165        payment.p_item = p_item
166        payment.p_session = p_session
167        payment.p_level = p_level
168        payment.p_current = p_current
169        payment.amount_auth = amount
170        return None, payment
171
172    # AAUE prefix
173    STUDENT_ID_PREFIX = u'E'
Note: See TracBrowser for help on using the repository browser.