source: main/kofacustom.wdu/trunk/src/kofacustom/wdu/students/utils.py @ 17429

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

Adjust to base package.
  • Property svn:keywords set to Id
File size: 6.7 KB
Line 
1## $Id: utils.py 15816 2019-11-17 16:04:38Z 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.wdu.interfaces import MessageFactory as _
24
25class CustomStudentsUtils(NigeriaStudentsUtils):
26    """A collection of customized methods.
27
28    """
29
30    # refix
31    STUDENT_ID_PREFIX = u'D'
32
33    def setPaymentDetails(self, category, student,
34            previous_session, previous_level, p_combi=[]):
35        """Create Payment object and set the payment data of a student for
36        the payment category specified.
37
38        """
39        p_item = u''
40        amount = 0.0
41        if previous_session:
42            if previous_session < student['studycourse'].entry_session:
43                return _('The previous session must not fall below '
44                         'your entry session.'), None
45            if category == 'schoolfee':
46                # School fee is always paid for the following session
47                if previous_session > student['studycourse'].current_session:
48                    return _('This is not a previous session.'), None
49            else:
50                if previous_session > student['studycourse'].current_session - 1:
51                    return _('This is not a previous session.'), None
52            p_session = previous_session
53            p_level = previous_level
54            p_current = False
55        else:
56            p_session = student['studycourse'].current_session
57            p_level = student['studycourse'].current_level
58            p_current = True
59        academic_session = self._getSessionConfiguration(p_session)
60        if academic_session == None:
61            return _(u'Session configuration object is not available.'), None
62        # Determine fee.
63        if category == 'schoolfee':
64            try:
65                certificate = student['studycourse'].certificate
66                p_item = certificate.code
67            except (AttributeError, TypeError):
68                return _('Study course data are incomplete.'), None
69            if previous_session:
70                # Students can pay for previous sessions in all
71                # workflow states.  Fresh students are excluded by the
72                # update method of the PreviousPaymentAddFormPage.
73                if previous_level == 100:
74                    amount = getattr(
75                        academic_session, 'school_fee_fresh', 0.0)
76                else:
77                    amount = getattr(
78                        academic_session, 'school_fee_returning', 0.0)
79            else:
80                if student.state == CLEARED:
81                    amount = getattr(
82                        academic_session, 'school_fee_fresh', 0.0)
83                elif student.state == RETURNING:
84                    # In case of returning school fee payment the
85                    # payment session and level contain the values of
86                    # the session the student has paid for. Payment
87                    # session is always next session.
88                    p_session, p_level = self.getReturningData(student)
89                    academic_session = self._getSessionConfiguration(p_session)
90                    if academic_session == None:
91                        return _(
92                            u'Session configuration object is not available.'
93                            ), None
94                    amount = getattr(
95                        academic_session, 'school_fee_returning', 0.0)
96                elif student.is_postgrad and student.state == PAID:
97                    # Returning postgraduate students also pay for the
98                    # next session but their level always remains the
99                    # same.
100                    p_session += 1
101                    academic_session = self._getSessionConfiguration(p_session)
102                    if academic_session == None:
103                        return _(
104                            u'Session configuration object is not available.'
105                            ), None
106                    amount = 0.0 # not yet configured
107        elif category == 'clearance':
108            try:
109                p_item = student['studycourse'].certificate.code
110            except (AttributeError, TypeError):
111                return _('Study course data are incomplete.'), None
112            amount = academic_session.clearance_fee
113        elif category == 'bed_allocation':
114            p_item = self.getAccommodationDetails(student)['bt']
115            amount = academic_session.booking_fee
116        elif category == 'hostel_maintenance':
117            amount = 0.0
118            bedticket = student['accommodation'].get(
119                str(student.current_session), None)
120            if bedticket is not None and bedticket.bed is not None:
121                p_item = bedticket.bed_coordinates
122                if bedticket.bed.__parent__.maint_fee > 0:
123                    amount = bedticket.bed.__parent__.maint_fee
124                else:
125                    # fallback
126                    amount = academic_session.maint_fee
127            else:
128                return _(u'No bed allocated.'), None
129        elif category == 'transcript':
130            amount = academic_session.transcript_fee
131        if amount in (0.0, None):
132            return _('Amount could not be determined.'), None
133        if self.samePaymentMade(student, category, p_item, p_session):
134            return _('This type of payment has already been made.'), None
135        if self._isPaymentDisabled(p_session, category, student):
136            return _('This category of payments has been disabled.'), None
137        payment = createObject(u'waeup.StudentOnlinePayment')
138        timestamp = ("%d" % int(time()*10000))[1:]
139        payment.p_id = "p%s" % timestamp
140        payment.p_category = category
141        payment.p_item = p_item
142        payment.p_session = p_session
143        payment.p_level = p_level
144        payment.p_current = p_current
145        payment.amount_auth = amount
146        return None, payment
Note: See TracBrowser for help on using the repository browser.