source: main/kofacustom.iuokada/trunk/src/kofacustom/iuokada/students/utils.py @ 15736

Last change on this file since 15736 was 15732, checked in by Henrik Bettermann, 5 years ago

Disable Combi Payments.
  • Property svn:keywords set to Id
File size: 8.2 KB
Line 
1## $Id: utils.py 15732 2019-11-01 11:04:53Z 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    ADMITTED, CLEARANCE, CLEARED, RETURNING, PAID, REGISTERED, VALIDATED)
22from kofacustom.nigeria.students.utils import NigeriaStudentsUtils
23from kofacustom.iuokada.interswitch.browser import GATEWAY_AMT
24from kofacustom.iuokada.interfaces import MessageFactory as _
25
26class CustomStudentsUtils(NigeriaStudentsUtils):
27    """A collection of customized methods.
28
29    """
30
31    # refix
32    STUDENT_ID_PREFIX = u'I'
33
34    SKIP_UPLOAD_VIEWLETS = (
35        'acceptanceletterupload', 'certificateupload'
36        )
37    # Maximum size of upload files in kB
38    MAX_KB = 500
39
40    #: A tuple containing the names of registration states in which changing of
41    #: passport pictures is allowed.
42    PORTRAIT_CHANGE_STATES = (ADMITTED, CLEARANCE,)
43
44    def warnCreditsOOR(self, studylevel, course=None):
45        """Return message if credits are out of range. In the base
46        package only maximum credits is set.
47        """
48        if course and studylevel.total_credits + course.credits > 54:
49            return _('Maximum credits exceeded.')
50        elif studylevel.total_credits > 54:
51            return _('Maximum credits exceeded.')
52        return
53
54    def setPaymentDetails(self, category, student,
55            previous_session, previous_level, combi=[]):
56        """Create a payment ticket and set the payment data of a
57        student for the payment category specified.
58        """
59        p_item = u''
60        amount = 0.0
61        if previous_session:
62            if previous_session < student['studycourse'].entry_session:
63                return _('The previous session must not fall below '
64                         'your entry session.'), None
65            if category == 'schoolfee':
66                # School fee is always paid for the following session
67                if previous_session > student['studycourse'].current_session:
68                    return _('This is not a previous session.'), None
69            else:
70                if previous_session > student['studycourse'].current_session - 1:
71                    return _('This is not a previous session.'), None
72            p_session = previous_session
73            p_level = previous_level
74            p_current = False
75        else:
76            p_session = student['studycourse'].current_session
77            p_level = student['studycourse'].current_level
78            p_current = True
79        academic_session = self._getSessionConfiguration(p_session)
80        if academic_session == None:
81            return _(u'Session configuration object is not available.'), None
82        # Determine fee.
83        if category in ('schoolfee', 'schoolfee40',
84                        'secondinstal'):
85            try:
86                certificate = student['studycourse'].certificate
87                p_item = certificate.code
88            except (AttributeError, TypeError):
89                return _('Study course data are incomplete.'), None
90            if previous_session:
91                # Students can pay for previous sessions in all
92                # workflow states.  Fresh students are excluded by the
93                # update method of the PreviousPaymentAddFormPage.
94                if previous_level == 100:
95                    amount = getattr(certificate, 'school_fee_1', 0.0)
96                else:
97                    amount = getattr(certificate, 'school_fee_2', 0.0)
98            else:
99                if student.state == CLEARED:
100                    amount = getattr(certificate, 'school_fee_1', 0.0)
101                elif student.state == RETURNING:
102                    # In case of returning school fee payment the
103                    # payment session and level contain the values of
104                    # the session the student has paid for. Payment
105                    # session is always next session.
106                    p_session, p_level = self.getReturningData(student)
107                    academic_session = self._getSessionConfiguration(p_session)
108                    if academic_session == None:
109                        return _(
110                            u'Session configuration object is not available.'
111                            ), None
112                    amount = getattr(certificate, 'school_fee_2', 0.0)
113                elif student.is_postgrad and student.state == PAID:
114                    # Returning postgraduate students also pay for the
115                    # next session but their level always remains the
116                    # same.
117                    p_session += 1
118                    academic_session = self._getSessionConfiguration(p_session)
119                    if academic_session == None:
120                        return _(
121                            u'Session configuration object is not available.'
122                            ), None
123                    amount = getattr(certificate, 'school_fee_2', 0.0)
124            if category == 'schoolfee40':
125                amount = 0.4*amount + 0.6*GATEWAY_AMT
126            elif category == 'secondinstal':
127                amount = 0.6*amount + 0.4*GATEWAY_AMT
128        elif category == 'clearance':
129            try:
130                p_item = student['studycourse'].certificate.code
131            except (AttributeError, TypeError):
132                return _('Study course data are incomplete.'), None
133            amount = academic_session.clearance_fee
134        #elif category == 'bed_allocation':
135        #    p_item = self.getAccommodationDetails(student)['bt']
136        #    amount = academic_session.booking_fee
137        #elif category == 'hostel_maintenance':
138        #    amount = 0.0
139        #    bedticket = student['accommodation'].get(
140        #        str(student.current_session), None)
141        #    if bedticket is not None and bedticket.bed is not None:
142        #        p_item = bedticket.bed_coordinates
143        #        if bedticket.bed.__parent__.maint_fee > 0:
144        #            amount = bedticket.bed.__parent__.maint_fee
145        #        else:
146        #            # fallback
147        #            amount = academic_session.maint_fee
148        #    else:
149        #        return _(u'No bed allocated.'), None
150        elif category == 'combi' and combi:
151            categories = getUtility(IKofaUtils).COMBI_PAYMENT_CATEGORIES
152            for cat in combi:
153                fee_name = cat + '_fee'
154                cat_amount = getattr(academic_session, fee_name, 0.0)
155                if not cat_amount:
156                    return _('%s undefined.' % categories[cat]), None
157                amount += cat_amount
158                p_item += u'%s + ' % categories[cat]
159            p_item = p_item.strip(' + ')
160        else:
161            fee_name = category + '_fee'
162            amount = getattr(academic_session, fee_name, 0.0)
163        if amount in (0.0, None):
164            return _('Amount could not be determined.'), None
165        if self.samePaymentMade(student, category, p_item, p_session):
166            return _('This type of payment has already been made.'), None
167        if self._isPaymentDisabled(p_session, category, student):
168            return _('This category of payments has been disabled.'), None
169        payment = createObject(u'waeup.StudentOnlinePayment')
170        timestamp = ("%d" % int(time()*10000))[1:]
171        payment.p_id = "p%s" % timestamp
172        payment.p_category = category
173        payment.p_item = p_item
174        payment.p_session = p_session
175        payment.p_level = p_level
176        payment.p_current = p_current
177        payment.amount_auth = amount
178        payment.p_combi = combi
179        return None, payment
Note: See TracBrowser for help on using the repository browser.