source: main/kofacustom.edocons/trunk/src/kofacustom/edocons/students/utils.py @ 17380

Last change on this file since 17380 was 17380, checked in by Henrik Bettermann, 19 months ago

New instalment ratio
  • Property svn:keywords set to Id
File size: 7.9 KB
Line 
1## $Id: utils.py 17380 2023-04-17 07:12: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##
18from time import time
19from zope.component import createObject, getUtility
20from waeup.kofa.interfaces import (IKofaUtils,
21    CLEARED, RETURNING, PAID, REGISTERED, VALIDATED)
22from kofacustom.nigeria.students.utils import NigeriaStudentsUtils
23from kofacustom.edocons.interfaces import MessageFactory as _
24
25class CustomStudentsUtils(NigeriaStudentsUtils):
26    """A collection of customized methods.
27
28    """
29
30    # prefix
31    STUDENT_ID_PREFIX = u'N'
32
33    # Maximum size of upload files in kB
34    MAX_KB = 500
35   
36    SKIP_UPLOAD_VIEWLETS = (
37        'acceptanceletterupload',
38        'certificateupload',
39        'evidencenameupload',
40        'refereeletterupload'
41        )
42
43    def setPaymentDetails(self, category, student,
44            previous_session=None, previous_level=None, combi=[]):
45        """Create a payment ticket and set the payment data of a
46        student for the payment category specified.
47        """
48        p_item = u''
49        amount = 0.0
50        if previous_session:
51            if previous_session < student['studycourse'].entry_session:
52                return _('The previous session must not fall below '
53                         'your entry session.'), None
54            if category == 'schoolfee':
55                # School fee is always paid for the following session
56                if previous_session > student['studycourse'].current_session:
57                    return _('This is not a previous session.'), None
58            else:
59                if previous_session > student['studycourse'].current_session - 1:
60                    return _('This is not a previous session.'), None
61            p_session = previous_session
62            p_level = previous_level
63            p_current = False
64        else:
65            p_session = student['studycourse'].current_session
66            p_level = student['studycourse'].current_level
67            p_current = True
68        academic_session = self._getSessionConfiguration(p_session)
69        if academic_session == None:
70            return _(u'Session configuration object is not available.'), None
71        # Determine fee.
72        if category in ('schoolfee', 'schoolfee_1', 'secondinstal'):
73            try:
74                certificate = student['studycourse'].certificate
75                p_item = certificate.code
76            except (AttributeError, TypeError):
77                return _('Study course data are incomplete.'), None
78            if previous_session:
79                # Students can pay for previous sessions in all
80                # workflow states.  Fresh students are excluded by the
81                # update method of the PreviousPaymentAddFormPage.
82                amount = getattr(certificate, 'school_fee_2', 0.0)
83            else:
84                # Second instalment can be paid in all states.
85                if category == 'secondinstal':
86                    if student.is_fresh:
87                        amount = 0.305 * getattr(certificate, 'school_fee_1', 0.0)
88                    else:
89                        amount = 0.305 * getattr(certificate, 'school_fee_2', 0.0)
90                if student.state == CLEARED:
91                    amount = getattr(certificate, 'school_fee_1', 0.0)
92                elif student.state == RETURNING:   
93                    amount = getattr(certificate, 'school_fee_2', 0.0)       
94                    # In case of returning school fee payment the
95                    # payment session and level contain the values of
96                    # the session the student has paid for. Payment
97                    # session is always next session.
98                    p_session, p_level = self.getReturningData(student)
99                    academic_session = self._getSessionConfiguration(p_session)
100                    if academic_session == None:
101                        return _(
102                            u'Session configuration object is not available.'
103                            ), None
104                elif student.is_postgrad and student.state == PAID:
105                    amount = getattr(certificate, 'school_fee_2', 0.0)
106                    # Returning postgraduate students also pay for the
107                    # next session but their level always remains the
108                    # same.
109                    p_session += 1
110                    academic_session = self._getSessionConfiguration(p_session)
111                    if academic_session == None:
112                        return _(
113                            u'Session configuration object is not available.'
114                            ), None                   
115                if category == 'schoolfee_1':
116                    amount *= 0.695
117        elif category == 'clearance':
118            try:
119                p_item = student['studycourse'].certificate.code
120            except (AttributeError, TypeError):
121                return _('Study course data are incomplete.'), None
122            amount = academic_session.clearance_fee
123        elif category == 'bed_allocation':
124            acco_details = self.getAccommodationDetails(student)
125            p_session = acco_details['booking_session']
126            p_item = acco_details['bt']
127            amount = academic_session.booking_fee
128        elif category == 'hostel_maintenance':
129            amount = 0.0
130            booking_session = grok.getSite()['hostels'].accommodation_session
131            bedticket = student['accommodation'].get(str(booking_session), None)
132            if bedticket is not None and bedticket.bed is not None:
133                p_session = booking_session
134                p_item = bedticket.bed_coordinates
135                if bedticket.bed.__parent__.maint_fee > 0:
136                    amount = bedticket.bed.__parent__.maint_fee
137                else:
138                    # fallback
139                    amount = academic_session.maint_fee
140            else:
141                return _(u'No bed allocated.'), None
142        elif category == 'combi' and combi:
143            categories = getUtility(IKofaUtils).COMBI_PAYMENT_CATEGORIES
144            for cat in combi:
145                fee_name = cat + '_fee'
146                cat_amount = getattr(academic_session, fee_name, 0.0)
147                if not cat_amount:
148                    return _('%s undefined.' % categories[cat]), None
149                amount += cat_amount
150                p_item += u'%s + ' % categories[cat]
151            p_item = p_item.strip(' + ')
152        else:
153            fee_name = category + '_fee'
154            amount = getattr(academic_session, fee_name, 0.0)
155        if amount in (0.0, None):
156            return _('Amount could not be determined.'), None
157        if self.samePaymentMade(student, category, p_item, p_session):
158            return _('This type of payment has already been made.'), None
159        if self._isPaymentDisabled(p_session, category, student):
160            return _('This category of payments has been disabled.'), 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        payment.p_combi = combi
171        return None, payment
Note: See TracBrowser for help on using the repository browser.