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

Last change on this file since 9047 was 8961, checked in by Henrik Bettermann, 13 years ago

Returning students and pg students get penalty fee data from next academic_session.

Add pg workflow shortcut.
  • Property svn:keywords set to Id
File size: 7.3 KB
Line 
1## $Id: utils.py 8961 2012-07-09 14:41:08Z 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        """Create Payment object and set the payment data of a student for
52        the payment category specified.
53
54        """
55        details = {}
56        p_item = u''
57        amount = 0.0
58        error = u''
59        p_session = student['studycourse'].current_session
60        p_level = student['studycourse'].current_level
61        session = str(p_session)
62        try:
63            academic_session = grok.getSite()['configuration'][session]
64        except KeyError:
65            return _(u'Session configuration object is not available.'), None
66        # Determine fee.
67        if category == 'schoolfee':
68            return _('School fee has to be paid by two instalments.'), None
69        if category == 'transfer':
70            amount = academic_session.transfer_fee
71        elif category == 'gown':
72            amount = academic_session.gown_fee
73        elif category == 'bed_allocation':
74            amount = academic_session.booking_fee
75        elif category == 'hostel_maintenance':
76            amount = academic_session.maint_fee
77        elif category == 'clearance':
78            amount = academic_session.clearance_fee
79            p_item = student['studycourse'].certificate.code
80        elif category == 'schoolfee_1':
81            try:
82                certificate = student['studycourse'].certificate
83                p_item = certificate.code
84            except (AttributeError, TypeError):
85                return _('Study course data are incomplete.'), None
86            payment_allowed = False
87            if student.state == CLEARED:
88                payment_allowed = True
89                amount = academic_session.school_fee_base
90            elif student.state == RETURNING or\
91                (student.is_postgrad and student.state == PAID):
92                if student.state == RETURNING:
93                    p_session, p_level = self.getReturningData(student)
94                else:
95                    # Returning postgraduate students also pay for the
96                    # next session but their level always remains the same.
97                    p_session += 1
98                initial_instalment_made = False
99                for key in student['payments'].keys():
100                    ticket = student['payments'][key]
101                    if ticket.p_category == 'schoolfee_1' and \
102                        ticket.p_state == 'paid':
103                        initial_instalment_made = True
104                    if ticket.p_state == 'paid' and\
105                        ticket.p_category == 'schoolfee_2' and \
106                        ticket.p_item == p_item and \
107                        ticket.p_session == p_session-1: #  = current session
108                        payment_allowed = True
109                if not initial_instalment_made:
110                    payment_allowed = True
111                try:
112                    academic_session = grok.getSite()[
113                        'configuration'][str(p_session)]
114                except KeyError:
115                    return _(u'Session configuration object is not available.'), None
116                amount = academic_session.school_fee_base
117            else:
118                return _('Wrong state.'), None
119            if not payment_allowed:
120                return _('The previous 2nd school fee instalment '
121                         'has not yet been paid.'), None
122        elif category == 'schoolfee_2':
123            try:
124                certificate = student['studycourse'].certificate
125                p_item = certificate.code
126            except (AttributeError, TypeError):
127                return _('Study course data are incomplete.'), None
128            payment_allowed = False
129            for key in student['payments'].keys():
130                ticket = student['payments'][key]
131                if ticket.p_state == 'paid' and\
132                   ticket.p_category == 'schoolfee_1' and \
133                   ticket.p_item == p_item and \
134                   ticket.p_session == p_session:
135                   payment_allowed = True
136            if not payment_allowed:
137                return _('The 1st school fee instalment '
138                         'has not yet been paid or session has '
139                         'not yet been started.'), None
140            amount = academic_session.school_fee_base
141        if amount in (0.0, None):
142            return _(u'Amount could not be determined.'), None
143        # Add session specific penalty fee.
144        if category == 'schoolfee_1' and student.is_postgrad:
145            amount += academic_session.penalty_pg
146        elif category == 'schoolfee_1':
147            amount += academic_session.penalty_ug
148        # Create ticket.
149        for key in student['payments'].keys():
150            ticket = student['payments'][key]
151            if ticket.p_state == 'paid' and\
152               ticket.p_category == category and \
153               ticket.p_item == p_item and \
154               ticket.p_session == p_session:
155                  return _('This type of payment has already been made.'), None
156        payment = createObject(u'waeup.StudentOnlinePayment')
157        timestamp = ("%d" % int(time()*10000))[1:]
158        payment.p_id = "p%s" % timestamp
159        payment.p_category = category
160        payment.p_item = p_item
161        payment.p_session = p_session
162        payment.p_level = p_level
163        payment.amount_auth = amount
164        return None, payment
165
166    # AAUE prefix
167    STUDENT_ID_PREFIX = u'E'
Note: See TracBrowser for help on using the repository browser.