source: main/kofacustom.unidel/trunk/src/kofacustom/unidel/students/utils.py @ 17167

Last change on this file since 17167 was 17167, checked in by Henrik Bettermann, 22 months ago

Fix typo.
  • Property svn:keywords set to Id
File size: 8.7 KB
Line 
1## $Id: utils.py 17167 2022-11-20 16:21:58Z 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, getUtility
21from waeup.kofa.interfaces import (IKofaUtils,
22    CLEARED, RETURNING, PAID, REGISTERED, VALIDATED)
23from kofacustom.nigeria.students.utils import NigeriaStudentsUtils
24from kofacustom.unidel.interfaces import MessageFactory as _
25
26def local(student):
27    lga = getattr(student, 'lga')
28    if lga and lga.startswith('delta'):
29        return True
30    return False
31
32class CustomStudentsUtils(NigeriaStudentsUtils):
33    """A collection of customized methods.
34
35    """
36
37    # refix
38    STUDENT_ID_PREFIX = u'D'
39
40    def _clearancePaymentMade(self, student):
41        if len(student['payments']):
42            for ticket in student['payments'].values():
43                if ticket.p_state == 'paid' and \
44                    ticket.p_category == 'clearance':
45                    return True
46        return False
47
48    def setPaymentDetails(self, category, student,
49            previous_session=None, previous_level=None, combi=[]):
50        """Create a payment ticket and set the payment data of a
51        student for the payment category specified.
52        """
53        p_item = u''
54        amount = 0.0
55        if previous_session:
56            if previous_session < student['studycourse'].entry_session:
57                return _('The previous session must not fall below '
58                         'your entry session.'), None
59            if category == 'schoolfee':
60                # School fee is always paid for the following session
61                if previous_session > student['studycourse'].current_session:
62                    return _('This is not a previous session.'), None
63            else:
64                if previous_session > student['studycourse'].current_session - 1:
65                    return _('This is not a previous session.'), None
66            p_session = previous_session
67            p_level = previous_level
68            p_current = False
69        else:
70            p_session = student['studycourse'].current_session
71            p_level = student['studycourse'].current_level
72            p_current = True
73        academic_session = self._getSessionConfiguration(p_session)
74        if academic_session == None:
75            return _(u'Session configuration object is not available.'), None
76        # Determine fee.
77        if category == 'schoolfee':
78            try:
79                certificate = student['studycourse'].certificate
80                p_item = certificate.code
81            except (AttributeError, TypeError):
82                return _('Study course data are incomplete.'), None
83            if previous_session:
84                # Students can pay for previous sessions in all
85                # workflow states.  Fresh students are excluded by the
86                # update method of the PreviousPaymentAddFormPage.
87                if previous_level == 100:
88                    amount = getattr(certificate, 'school_fee_1', 0.0)
89                else:
90                    amount = getattr(certificate, 'school_fee_2', 0.0)
91            else:
92                if student.is_jupeb:
93                    if not self._clearancePaymentMade(student):
94                        return _(u'Acceptance fee must be paid first.'), None
95                if student.state == CLEARED:
96                    amount = getattr(certificate, 'school_fee_1', 0.0)
97                elif student.state == RETURNING:
98                    # In case of returning school fee payment the
99                    # payment session and level contain the values of
100                    # the session the student has paid for. Payment
101                    # session is always next session.
102                    p_session, p_level = self.getReturningData(student)
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_2', 0.0)
109                elif student.is_postgrad and student.state == PAID:
110                    # Returning postgraduate students also pay for the
111                    # next session but their level always remains the
112                    # same.
113                    p_session += 1
114                    academic_session = self._getSessionConfiguration(p_session)
115                    if academic_session == None:
116                        return _(
117                            u'Session configuration object is not available.'
118                            ), None
119                    amount = getattr(certificate, 'school_fee_2', 0.0)
120            if amount and not local(student) and not student.is_jupeb:
121                amount += 40000
122        elif category == 'clearance':
123            try:
124                p_item = student['studycourse'].certificate.code
125            except (AttributeError, TypeError):
126                return _('Study course data are incomplete.'), None
127            amount = academic_session.clearance_fee
128            if amount and student.faccode != 'PRE' and not student.is_jupeb:
129                if local(student):
130                    amount *= 2.0
131                else:
132                    amount *= 2.4
133        elif category == 'bed_allocation':
134            p_item = self.getAccommodationDetails(student)['bt']
135            amount = 0.0
136        elif category == 'hostel_maintenance':
137            amount = 0.0
138            bedticket = student['accommodation'].get(
139                str(student.current_session), None)
140            if bedticket is not None and bedticket.bed is not None:
141                p_item = bedticket.bed_coordinates
142                if bedticket.bed.__parent__.maint_fee > 0:
143                    amount = bedticket.bed.__parent__.maint_fee
144                else:
145                    # fallback
146                    amount = academic_session.maint_fee
147            else:
148                return _(u'No bed allocated.'), None
149        elif category == 'combi' and combi:
150            categories = getUtility(IKofaUtils).COMBI_PAYMENT_CATEGORIES
151            for cat in combi:
152                fee_name = cat + '_fee'
153                cat_amount = getattr(academic_session, fee_name, 0.0)
154                if not cat_amount:
155                    return _('%s undefined.' % categories[cat]), None
156                amount += cat_amount
157                p_item += u'%s + ' % categories[cat]
158            p_item = p_item.strip(' + ')
159        else:
160            fee_name = category + '_fee'
161            amount = getattr(academic_session, fee_name, 0.0)
162        if category != 'bed_allocation' and amount in (0.0, None):
163            return _('Amount could not be determined.'), None
164        if self.samePaymentMade(student, category, p_item, p_session):
165            return _('This type of payment has already been made.'), None
166        if self._isPaymentDisabled(p_session, category, student):
167            return _('This category of payments has been disabled.'), None
168        payment = createObject(u'waeup.StudentOnlinePayment')
169        timestamp = ("%d" % int(time()*10000))[1:]
170        payment.p_id = "p%s" % timestamp
171        payment.p_category = category
172        payment.p_item = p_item
173        payment.p_session = p_session
174        payment.p_level = p_level
175        payment.p_current = p_current
176        payment.amount_auth = amount
177        payment.p_combi = combi
178        return None, payment
179
180    def getAccommodationDetails(self, student):
181        """Determine the accommodation data of a student.
182        """
183        d = {}
184        d['error'] = u''
185        hostels = grok.getSite()['hostels']
186        d['booking_session'] = hostels.accommodation_session
187        d['allowed_states'] = hostels.accommodation_states
188        d['startdate'] = hostels.startdate
189        d['enddate'] = hostels.enddate
190        d['expired'] = hostels.expired
191        # Determine bed type
192        bt = 'all'
193        if student.sex == 'f':
194            sex = 'female'
195        else:
196            sex = 'male'
197        special_handling = 'regular'
198        d['bt'] = u'%s_%s_%s' % (special_handling,sex,bt)
199        return d
Note: See TracBrowser for help on using the repository browser.