source: main/waeup.kofa/trunk/src/waeup/kofa/students/payments.py @ 10639

Last change on this file since 10639 was 10449, checked in by Henrik Bettermann, 11 years ago

Add new payment category.

  • Property svn:keywords set to Id
File size: 6.1 KB
Line 
1## $Id: payments.py 10449 2013-08-05 06:37:46Z 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##
18"""
19Student payment components.
20"""
21import grok
22from zope.component.interfaces import IFactory
23from zope.interface import implementedBy
24from waeup.kofa.interfaces import MessageFactory as _
25from waeup.kofa.students.interfaces import (
26    IStudentPaymentsContainer, IStudentNavigation, IStudentOnlinePayment)
27from waeup.kofa.payments import PaymentsContainer, OnlinePayment
28from waeup.kofa.payments.interfaces import IPayer
29from waeup.kofa.utils.helpers import attrs_to_fields
30from waeup.kofa.accesscodes import create_accesscode
31
32class StudentPaymentsContainer(PaymentsContainer):
33    """This is a container for student payments.
34    """
35    grok.implements(IStudentPaymentsContainer, IStudentNavigation)
36    grok.provides(IStudentPaymentsContainer)
37
38    def __init__(self):
39        super(StudentPaymentsContainer, self).__init__()
40        return
41
42    @property
43    def student(self):
44        return self.__parent__
45
46    def writeLogMessage(self, view, message):
47        return self.__parent__.writeLogMessage(view, message)
48
49StudentPaymentsContainer = attrs_to_fields(StudentPaymentsContainer)
50
51class StudentOnlinePayment(OnlinePayment):
52    """This is an online payment.
53    """
54    grok.implements(IStudentOnlinePayment, IStudentNavigation)
55    grok.provides(IStudentOnlinePayment)
56
57    def __init__(self):
58        super(StudentOnlinePayment, self).__init__()
59        return
60
61    @property
62    def student(self):
63        try:
64            return self.__parent__.__parent__
65        except AttributeError:
66            return None
67
68    def writeLogMessage(self, view, message):
69        return self.__parent__.__parent__.writeLogMessage(view, message)
70
71    def _createActivationCodes(self):
72        student = self.student
73        if self.p_category == 'clearance':
74            # Create CLR access code
75            pin, error = create_accesscode(
76                'CLR',0,self.amount_auth,student.student_id)
77            if error:
78                return error
79            self.ac = pin
80        elif self.p_category in ('schoolfee', 'schoolfee_1'):
81            # Create SFE access code
82            pin, error = create_accesscode(
83                'SFE',0,self.amount_auth,student.student_id)
84            if error:
85                return error
86            self.ac = pin
87        elif self.p_category == 'bed_allocation':
88            # Create HOS access code
89            pin, error = create_accesscode(
90                'HOS',0,self.amount_auth,student.student_id)
91            if error:
92                return error
93            self.ac = pin
94        elif self.p_category == 'transcript':
95            # Create TSC access code
96            pin, error = create_accesscode(
97                'TSC',0,self.amount_auth,student.student_id)
98            if error:
99                return error
100            self.ac = pin
101        return None
102
103    def doAfterStudentPayment(self):
104        """Process student after payment was made.
105        """
106        if self.p_current:
107            error = self._createActivationCodes()
108            if error is not None:
109                return False, error, error
110        log = 'successful %s payment: %s' % (self.p_category, self.p_id)
111        msg = _('Successful payment')
112        return True, msg, log
113
114    def doAfterStudentPaymentApproval(self):
115        """Process student after payment was approved.
116        """
117        if self.p_current:
118            error = self._createActivationCodes()
119            if error is not None:
120                return False, error, error
121        log = '%s payment approved: %s' % (self.p_category, self.p_id)
122        msg = _('Payment approved')
123        return True, msg, log
124
125    def approveStudentPayment(self):
126        """Approve payment and process student.
127        """
128        if self.p_state == 'paid':
129            return False, _('This ticket has already been paid.'), None
130        self.approve()
131        return self.doAfterStudentPaymentApproval()
132
133
134StudentOnlinePayment = attrs_to_fields(
135    StudentOnlinePayment, omit=['display_item'])
136
137class Payer(grok.Adapter):
138    """An adapter to publish student data through a simple webservice.
139    """
140    grok.context(IStudentOnlinePayment)
141    grok.implements(IPayer)
142
143    @property
144    def display_fullname(self):
145        "Name of  payer"
146        return self.context.student.display_fullname
147
148    @property
149    def id(self):
150        "Id of payer"
151        return self.context.student.student_id
152
153    @property
154    def matric_number(self):
155        "Matric number or reg number of payer"
156        return self.context.student.matric_number
157
158    @property
159    def reg_number(self):
160        "Reg number or reg number of payer"
161        return self.context.student.reg_number
162
163    @property
164    def faculty(self):
165        "Faculty of payer"
166        return self.context.student.faccode
167
168    @property
169    def department(self):
170        "Department of payer"
171        return self.context.student.depcode
172
173# Student online payments must be importable. So we might need a factory.
174class StudentOnlinePaymentFactory(grok.GlobalUtility):
175    """A factory for student online payments.
176    """
177    grok.implements(IFactory)
178    grok.name(u'waeup.StudentOnlinePayment')
179    title = u"Create a new online payment.",
180    description = u"This factory instantiates new online payment instances."
181
182    def __call__(self, *args, **kw):
183        return StudentOnlinePayment()
184
185    def getInterfaces(self):
186        return implementedBy(StudentOnlinePayment)
Note: See TracBrowser for help on using the repository browser.