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

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

Remove some upload fields.
  • Property svn:keywords set to Id
File size: 7.5 KB
Line 
1## $Id: utils.py 17075 2022-08-22 10:35:20Z 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    SKIP_UPLOAD_VIEWLETS = (
34        'acceptanceletterupload',
35        'certificateupload',
36        'evidencenameupload',
37        'refereeletterupload'
38        )
39
40    def setPaymentDetails(self, category, student,
41            previous_session=None, previous_level=None, combi=[]):
42        """Create a payment ticket and set the payment data of a
43        student for the payment category specified.
44        """
45        p_item = u''
46        amount = 0.0
47        if previous_session:
48            if previous_session < student['studycourse'].entry_session:
49                return _('The previous session must not fall below '
50                         'your entry session.'), None
51            if category == 'schoolfee':
52                # School fee is always paid for the following session
53                if previous_session > student['studycourse'].current_session:
54                    return _('This is not a previous session.'), None
55            else:
56                if previous_session > student['studycourse'].current_session - 1:
57                    return _('This is not a previous session.'), None
58            p_session = previous_session
59            p_level = previous_level
60            p_current = False
61        else:
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 in ('schoolfee', 'schoolfee_1', 'secondinstal'):
70            try:
71                certificate = student['studycourse'].certificate
72                p_item = certificate.code
73            except (AttributeError, TypeError):
74                return _('Study course data are incomplete.'), None
75            if previous_session:
76                # Students can pay for previous sessions in all
77                # workflow states.  Fresh students are excluded by the
78                # update method of the PreviousPaymentAddFormPage.
79                amount = getattr(certificate, 'school_fee_1', 0.0)
80            else:
81                if category == 'secondinstal':
82                    amount = 0.34 * getattr(certificate, 'school_fee_1', 0.0)
83                else:
84                    if student.state == CLEARED:
85                        amount = getattr(certificate, 'school_fee_1', 0.0)
86                    elif student.state == RETURNING:
87                        # In case of returning school fee payment the
88                        # payment session and level contain the values of
89                        # the session the student has paid for. Payment
90                        # session is always next session.
91                        p_session, p_level = self.getReturningData(student)
92                        academic_session = self._getSessionConfiguration(p_session)
93                        if academic_session == None:
94                            return _(
95                                u'Session configuration object is not available.'
96                                ), None
97                        amount = getattr(certificate, 'school_fee_1', 0.0)
98                    elif student.is_postgrad and student.state == PAID:
99                        # Returning postgraduate students also pay for the
100                        # next session but their level always remains the
101                        # same.
102                        p_session += 1
103                        academic_session = self._getSessionConfiguration(p_session)
104                        if academic_session == None:
105                            return _(
106                                u'Session configuration object is not available.'
107                                ), None
108                        amount = getattr(certificate, 'school_fee_1', 0.0)
109                    if category == 'schoolfee_1':
110                        amount *= 0.66
111        elif category == 'clearance':
112            try:
113                p_item = student['studycourse'].certificate.code
114            except (AttributeError, TypeError):
115                return _('Study course data are incomplete.'), None
116            amount = academic_session.clearance_fee
117        elif category == 'bed_allocation':
118            p_item = self.getAccommodationDetails(student)['bt']
119            amount = academic_session.booking_fee
120        elif category == 'hostel_maintenance':
121            amount = 0.0
122            bedticket = student['accommodation'].get(
123                str(student.current_session), None)
124            if bedticket is not None and bedticket.bed is not None:
125                p_item = bedticket.bed_coordinates
126                if bedticket.bed.__parent__.maint_fee > 0:
127                    amount = bedticket.bed.__parent__.maint_fee
128                else:
129                    # fallback
130                    amount = academic_session.maint_fee
131            else:
132                return _(u'No bed allocated.'), None
133        elif category == 'combi' and combi:
134            categories = getUtility(IKofaUtils).COMBI_PAYMENT_CATEGORIES
135            for cat in combi:
136                fee_name = cat + '_fee'
137                cat_amount = getattr(academic_session, fee_name, 0.0)
138                if not cat_amount:
139                    return _('%s undefined.' % categories[cat]), None
140                amount += cat_amount
141                p_item += u'%s + ' % categories[cat]
142            p_item = p_item.strip(' + ')
143        else:
144            fee_name = category + '_fee'
145            amount = getattr(academic_session, fee_name, 0.0)
146        if amount in (0.0, None):
147            return _('Amount could not be determined.'), None
148        if self.samePaymentMade(student, category, p_item, p_session):
149            return _('This type of payment has already been made.'), None
150        if self._isPaymentDisabled(p_session, category, student):
151            return _('This category of payments has been disabled.'), None
152        payment = createObject(u'waeup.StudentOnlinePayment')
153        timestamp = ("%d" % int(time()*10000))[1:]
154        payment.p_id = "p%s" % timestamp
155        payment.p_category = category
156        payment.p_item = p_item
157        payment.p_session = p_session
158        payment.p_level = p_level
159        payment.p_current = p_current
160        payment.amount_auth = amount
161        payment.p_combi = combi
162        return None, payment
Note: See TracBrowser for help on using the repository browser.