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

Last change on this file since 17107 was 17107, checked in by Henrik Bettermann, 2 years ago

Rewrite setPaymentDetails for school fees.
  • Property svn:keywords set to Id
File size: 7.5 KB
Line 
1## $Id: utils.py 17107 2022-09-26 11:11:14Z 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                if student.state == CLEARED:
85                    amount = getattr(certificate, 'school_fee_1', 0.0)
86                elif student.state == RETURNING:   
87                    amount = getattr(certificate, 'school_fee_2', 0.0)       
88                    # In case of returning school fee payment the
89                    # payment session and level contain the values of
90                    # the session the student has paid for. Payment
91                    # session is always next session.
92                    p_session, p_level = self.getReturningData(student)
93                    academic_session = self._getSessionConfiguration(p_session)
94                    if academic_session == None:
95                        return _(
96                            u'Session configuration object is not available.'
97                            ), None
98                elif student.is_postgrad and student.state == PAID:
99                    amount = getattr(certificate, 'school_fee_2', 0.0)
100                    # Returning postgraduate students also pay for the
101                    # next session but their level always remains the
102                    # same.
103                    p_session += 1
104                    academic_session = self._getSessionConfiguration(p_session)
105                    if academic_session == None:
106                        return _(
107                            u'Session configuration object is not available.'
108                            ), None                   
109                   
110                if category == 'secondinstal':
111                    amount *= 0.34
112                elif category == 'schoolfee_1':
113                    amount *= 0.66
114        elif category == 'clearance':
115            try:
116                p_item = student['studycourse'].certificate.code
117            except (AttributeError, TypeError):
118                return _('Study course data are incomplete.'), None
119            amount = academic_session.clearance_fee
120        elif category == 'bed_allocation':
121            p_item = self.getAccommodationDetails(student)['bt']
122            amount = academic_session.booking_fee
123        elif category == 'hostel_maintenance':
124            amount = 0.0
125            bedticket = student['accommodation'].get(
126                str(student.current_session), None)
127            if bedticket is not None and bedticket.bed is not None:
128                p_item = bedticket.bed_coordinates
129                if bedticket.bed.__parent__.maint_fee > 0:
130                    amount = bedticket.bed.__parent__.maint_fee
131                else:
132                    # fallback
133                    amount = academic_session.maint_fee
134            else:
135                return _(u'No bed allocated.'), None
136        elif category == 'combi' and combi:
137            categories = getUtility(IKofaUtils).COMBI_PAYMENT_CATEGORIES
138            for cat in combi:
139                fee_name = cat + '_fee'
140                cat_amount = getattr(academic_session, fee_name, 0.0)
141                if not cat_amount:
142                    return _('%s undefined.' % categories[cat]), None
143                amount += cat_amount
144                p_item += u'%s + ' % categories[cat]
145            p_item = p_item.strip(' + ')
146        else:
147            fee_name = category + '_fee'
148            amount = getattr(academic_session, fee_name, 0.0)
149        if amount in (0.0, None):
150            return _('Amount could not be determined.'), None
151        if self.samePaymentMade(student, category, p_item, p_session):
152            return _('This type of payment has already been made.'), None
153        if self._isPaymentDisabled(p_session, category, student):
154            return _('This category of payments has been disabled.'), None
155        payment = createObject(u'waeup.StudentOnlinePayment')
156        timestamp = ("%d" % int(time()*10000))[1:]
157        payment.p_id = "p%s" % timestamp
158        payment.p_category = category
159        payment.p_item = p_item
160        payment.p_session = p_session
161        payment.p_level = p_level
162        payment.p_current = p_current
163        payment.amount_auth = amount
164        payment.p_combi = combi
165        return None, payment
Note: See TracBrowser for help on using the repository browser.