1 | ## $Id: browser.py 10983 2014-01-24 16:24:06Z henrik $ |
---|
2 | ## |
---|
3 | ## Copyright (C) 2012 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 | from datetime import datetime |
---|
19 | import httplib |
---|
20 | import urllib |
---|
21 | import urllib2 |
---|
22 | from xml.dom.minidom import parseString |
---|
23 | import grok |
---|
24 | from zope.component import getUtility |
---|
25 | from zope.catalog.interfaces import ICatalog |
---|
26 | from waeup.kofa.interfaces import IUniversity |
---|
27 | from waeup.kofa.payments.interfaces import IPayer |
---|
28 | from waeup.kofa.webservices import PaymentDataWebservice |
---|
29 | from waeup.kofa.browser.layout import KofaPage, UtilityView |
---|
30 | from waeup.kofa.students.viewlets import ApprovePaymentActionButton as APABStudent |
---|
31 | from waeup.kofa.applicants.viewlets import ApprovePaymentActionButton as APABApplicant |
---|
32 | from waeup.aaue.interfaces import academic_sessions_vocab |
---|
33 | from kofacustom.nigeria.interswitch.browser import ( |
---|
34 | InterswitchActionButtonStudent, |
---|
35 | InterswitchRequestWebserviceActionButtonStudent, |
---|
36 | InterswitchActionButtonApplicant, |
---|
37 | InterswitchRequestWebserviceActionButtonApplicant) |
---|
38 | from waeup.aaue.interfaces import MessageFactory as _ |
---|
39 | from waeup.aaue.students.interfaces import ICustomStudentOnlinePayment |
---|
40 | from waeup.aaue.applicants.interfaces import ICustomApplicantOnlinePayment |
---|
41 | |
---|
42 | ERROR_PART1 = ( |
---|
43 | 'PayeeName=N/A~' |
---|
44 | + 'Faculty=N/A~' |
---|
45 | + 'Department=N/A~' |
---|
46 | + 'Level=N/A~' |
---|
47 | + 'ProgrammeType=N/A~' |
---|
48 | + 'StudyType=N/A~' |
---|
49 | + 'Session=N/A~' |
---|
50 | + 'PayeeID=N/A~' |
---|
51 | + 'Amount=N/A~' |
---|
52 | + 'FeeStatus=') |
---|
53 | ERROR_PART2 = ( |
---|
54 | '~Semester=N/A~' |
---|
55 | + 'PaymentType=N/A~' |
---|
56 | + 'MatricNumber=N/A~' |
---|
57 | + 'Email=N/A~' |
---|
58 | + 'PhoneNumber=N/A') |
---|
59 | |
---|
60 | class CustomPaymentDataWebservice(PaymentDataWebservice): |
---|
61 | """A simple webservice to publish payment and payer details on request from |
---|
62 | accepted IP addresses without authentication. |
---|
63 | |
---|
64 | Etranzact is asking for the PAYEE_ID which is indeed misleading. |
---|
65 | These are not the data of the payee but of the payer. And it's |
---|
66 | not the id of the payer but of the payment. |
---|
67 | """ |
---|
68 | grok.name('feerequest') |
---|
69 | |
---|
70 | #ACCEPTED_IP = ('195.219.3.181', '195.219.3.184') |
---|
71 | ACCEPTED_IP = None |
---|
72 | |
---|
73 | def update(self, PAYEE_ID=None, PAYMENT_TYPE=None): |
---|
74 | if PAYEE_ID == None: |
---|
75 | self.output = ERROR_PART1 + 'Missing PAYEE_ID' + ERROR_PART2 |
---|
76 | return |
---|
77 | real_ip = self.request.get('HTTP_X_FORWARDED_FOR', None) |
---|
78 | # We can forego the logging once eTranzact payments run smoothly |
---|
79 | # and the accepted IP addresses are used. |
---|
80 | if real_ip: |
---|
81 | self.context.logger.info('PaymentDataWebservice called: %s' % real_ip) |
---|
82 | if real_ip and self.ACCEPTED_IP: |
---|
83 | if real_ip not in self.ACCEPTED_IP: |
---|
84 | self.output = ERROR_PART1 + 'Wrong IP address' + ERROR_PART2 |
---|
85 | return |
---|
86 | if PAYMENT_TYPE not in ('SCHOOL-FEE', 'ACCEPTANCE-FEE', 'APPLICATION-FEE'): |
---|
87 | self.output = ERROR_PART1 + 'Invalid PAYMENT_TYPE' + ERROR_PART2 |
---|
88 | return |
---|
89 | |
---|
90 | # It seems eTranzact sends a POST request with an empty body but the URL |
---|
91 | # contains a query string. So it's actually a GET request pretended |
---|
92 | # to be a POST request. Although this does not comply with the |
---|
93 | # RFC 2616 HTTP guidelines we may try to fetch the id from the QUERY_STRING |
---|
94 | # value of the request. |
---|
95 | #if PAYEE_ID is None: |
---|
96 | # try: |
---|
97 | # PAYEE_ID = self.request['QUERY_STRING'].split('=')[1] |
---|
98 | # except: |
---|
99 | # self.output = '-4' |
---|
100 | # return |
---|
101 | |
---|
102 | cat = getUtility(ICatalog, name='payments_catalog') |
---|
103 | results = list(cat.searchResults(p_id=(PAYEE_ID, PAYEE_ID))) |
---|
104 | if len(results) != 1: |
---|
105 | self.output = ERROR_PART1 + 'Invalid PAYEE_ID' + ERROR_PART2 |
---|
106 | return |
---|
107 | if PAYMENT_TYPE == 'SCHOOL-FEE' \ |
---|
108 | and not results[0].p_category.startswith('schoolfee'): |
---|
109 | self.output = ERROR_PART1 + 'Wrong PAYMENT_TYPE' + ERROR_PART2 |
---|
110 | return |
---|
111 | if PAYMENT_TYPE == 'ACCEPTANCE-FEE' \ |
---|
112 | and not results[0].p_category == 'clearance': |
---|
113 | self.output = ERROR_PART1 + 'Wrong PAYMENT_TYPE' + ERROR_PART2 |
---|
114 | return |
---|
115 | if PAYMENT_TYPE == 'APPLICATION-FEE' \ |
---|
116 | and not results[0].p_category == 'application': |
---|
117 | self.output = ERROR_PART1 + 'Wrong PAYMENT_TYPE' + ERROR_PART2 |
---|
118 | return |
---|
119 | try: |
---|
120 | owner = IPayer(results[0]) |
---|
121 | full_name = owner.display_fullname |
---|
122 | matric_no = owner.id |
---|
123 | faculty = owner.faculty |
---|
124 | department = owner.department |
---|
125 | study_type = owner.current_mode |
---|
126 | email = owner.email |
---|
127 | phone = owner.phone |
---|
128 | level = owner.current_level |
---|
129 | except (TypeError, AttributeError): |
---|
130 | self.output = ERROR_PART1 + 'Unknown error' + ERROR_PART2 |
---|
131 | return |
---|
132 | amount = results[0].amount_auth |
---|
133 | payment_type = results[0].category |
---|
134 | programme_type = results[0].p_item |
---|
135 | |
---|
136 | academic_session = academic_sessions_vocab.getTerm( |
---|
137 | results[0].p_session).title |
---|
138 | status = results[0].p_state |
---|
139 | self.output = ( |
---|
140 | # Version 1 |
---|
141 | #'FULL_NAME=%s&' + |
---|
142 | #'FACULTY=%s&' + |
---|
143 | #'DEPARTMENT=%s&' + |
---|
144 | #'RETURN_TYPE=%s&' + |
---|
145 | #'PROGRAMME_TYPE=%s&' + |
---|
146 | #'PAYMENT_TYPE=%s&' + |
---|
147 | #'ACADEMIC_SESSION=%s&' + |
---|
148 | #'MATRIC_NO=%s&' + |
---|
149 | #'FEE_AMOUNT=%s&' + |
---|
150 | #'TRANSACTION_STATUS=%s' |
---|
151 | |
---|
152 | # Version 2 |
---|
153 | 'PayeeName=%s~' + |
---|
154 | 'Faculty=%s~' + |
---|
155 | 'Department=%s~' + |
---|
156 | 'Level=%s~' + |
---|
157 | 'ProgrammeType=%s~' + |
---|
158 | 'StudyType=%s~' + |
---|
159 | 'Session=%s~' + |
---|
160 | 'PayeeID=%s~' + |
---|
161 | 'Amount=%s~' + |
---|
162 | 'FeeStatus=%s~' + |
---|
163 | 'Semester=N/A~' + |
---|
164 | 'PaymentType=%s~' + |
---|
165 | 'MatricNumber=%s~' + |
---|
166 | 'Email=%s~' + |
---|
167 | 'PhoneNumber=%s' |
---|
168 | |
---|
169 | ) % (full_name, faculty, |
---|
170 | department, level, programme_type, study_type, |
---|
171 | academic_session, PAYEE_ID, amount, status, payment_type, |
---|
172 | matric_no, email, phone) |
---|
173 | return |
---|
174 | |
---|
175 | |
---|
176 | # Requerying eTranzact payments |
---|
177 | |
---|
178 | TERMINAL_ID = '0570000070' |
---|
179 | QUERY_URL = 'https://www.etranzact.net/WebConnectPlus/query.jsp' |
---|
180 | |
---|
181 | # Test environment |
---|
182 | #QUERY_URL = 'http://demo.etranzact.com:8080/WebConnect/queryPayoutletTransaction.jsp' |
---|
183 | #TERMINAL_ID = '5009892289' |
---|
184 | |
---|
185 | def query_etranzact(confirmation_number, payment): |
---|
186 | |
---|
187 | postdict = {} |
---|
188 | postdict['TERMINAL_ID'] = TERMINAL_ID |
---|
189 | #postdict['RESPONSE_URL'] = 'http://dummy' |
---|
190 | postdict['CONFIRMATION_NO'] = confirmation_number |
---|
191 | data = urllib.urlencode(postdict) |
---|
192 | payment.conf_number = confirmation_number |
---|
193 | try: |
---|
194 | # eTranzact only accepts HTTP 1.1 requests. Therefore |
---|
195 | # the urllib2 package is required here. |
---|
196 | f = urllib2.urlopen(url=QUERY_URL, data=data) |
---|
197 | success = f.read() |
---|
198 | success = success.replace('\r\n','') |
---|
199 | if 'CUSTOMER_ID' not in success: |
---|
200 | msg = _('Invalid or unsuccessful callback: ${a}', |
---|
201 | mapping = {'a': success}) |
---|
202 | log = 'invalid callback for payment %s: %s' % (payment.p_id, success) |
---|
203 | payment.p_state = 'failed' |
---|
204 | return False, msg, log |
---|
205 | success = success.replace('%20',' ').split('&') |
---|
206 | # We expect at least two parameters |
---|
207 | if len(success) < 2: |
---|
208 | msg = _('Invalid callback: ${a}', mapping = {'a': success}) |
---|
209 | log = 'invalid callback for payment %s: %s' % (payment.p_id, success) |
---|
210 | payment.p_state = 'failed' |
---|
211 | return False, msg, log |
---|
212 | try: |
---|
213 | success_dict = dict([tuple(i.split('=')) for i in success]) |
---|
214 | except ValueError: |
---|
215 | msg = _('Invalid callback: ${a}', mapping = {'a': success}) |
---|
216 | log = 'invalid callback for payment %s: %s' % (payment.p_id, success) |
---|
217 | payment.p_state = 'failed' |
---|
218 | return False, msg, log |
---|
219 | except IOError: |
---|
220 | msg = _('eTranzact IOError') |
---|
221 | log = 'eTranzact IOError' |
---|
222 | return False, msg, log |
---|
223 | payment.r_code = u'ET' |
---|
224 | payment.r_company = u'etranzact' |
---|
225 | payment.r_desc = u'%s' % success_dict.get('TRANS_DESCR') |
---|
226 | payment.r_amount_approved = float(success_dict.get('TRANS_AMOUNT',0.0)) |
---|
227 | payment.r_card_num = None |
---|
228 | payment.r_pay_reference = u'%s' % success_dict.get('RECEIPT_NO') |
---|
229 | if payment.r_amount_approved != payment.amount_auth: |
---|
230 | msg = _('Wrong amount') |
---|
231 | log = 'wrong callback for payment %s: %s' % (payment.p_id, success) |
---|
232 | payment.p_state = 'failed' |
---|
233 | return False, msg, log |
---|
234 | customer_id = success_dict.get('CUSTOMER_ID') |
---|
235 | if payment.p_id != customer_id: |
---|
236 | msg = _('Wrong payment id') |
---|
237 | log = 'wrong callback for payment %s: %s' % (payment.p_id, success) |
---|
238 | payment.p_state = 'failed' |
---|
239 | return False, msg, log |
---|
240 | log = 'valid callback for payment %s: %s' % (payment.p_id, success) |
---|
241 | msg = _('Successful callback received') |
---|
242 | payment.p_state = 'paid' |
---|
243 | payment.payment_date = datetime.utcnow() |
---|
244 | return True, msg, log |
---|
245 | |
---|
246 | class EtranzactEnterPinActionButtonApplicant(APABApplicant): |
---|
247 | grok.context(ICustomApplicantOnlinePayment) |
---|
248 | grok.require('waeup.payApplicant') |
---|
249 | grok.order(3) |
---|
250 | icon = 'actionicon_call.png' |
---|
251 | text = _('Query eTranzact History') |
---|
252 | target = 'enterpin' |
---|
253 | |
---|
254 | class EtranzactEnterPinActionButtonStudent(APABStudent): |
---|
255 | grok.context(ICustomStudentOnlinePayment) |
---|
256 | grok.require('waeup.payStudent') |
---|
257 | grok.order(3) |
---|
258 | icon = 'actionicon_call.png' |
---|
259 | text = _('Query eTranzact History') |
---|
260 | target = 'enterpin' |
---|
261 | |
---|
262 | class EtranzactEnterPinPageStudent(KofaPage): |
---|
263 | """ |
---|
264 | """ |
---|
265 | grok.context(ICustomStudentOnlinePayment) |
---|
266 | grok.name('enterpin') |
---|
267 | grok.template('enterpin') |
---|
268 | grok.require('waeup.payStudent') |
---|
269 | |
---|
270 | buttonname = _('Submit to eTranzact') |
---|
271 | label = _('Requery eTranzact History') |
---|
272 | action = 'query_history' |
---|
273 | |
---|
274 | class EtranzactEnterPinPageApplicant(EtranzactEnterPinPageStudent): |
---|
275 | """ |
---|
276 | """ |
---|
277 | grok.require('waeup.payApplicant') |
---|
278 | grok.context(ICustomApplicantOnlinePayment) |
---|
279 | |
---|
280 | class EtranzactQueryHistoryPageStudent(UtilityView, grok.View): |
---|
281 | """ Query history of eTranzact payments |
---|
282 | """ |
---|
283 | grok.context(ICustomStudentOnlinePayment) |
---|
284 | grok.name('query_history') |
---|
285 | grok.require('waeup.payStudent') |
---|
286 | |
---|
287 | def update(self, confirmation_number=None): |
---|
288 | if self.context.p_state == 'paid': |
---|
289 | self.flash(_('This ticket has already been paid.')) |
---|
290 | return |
---|
291 | student = self.context.student |
---|
292 | success, msg, log = query_etranzact(confirmation_number,self.context) |
---|
293 | student.writeLogMessage(self, log) |
---|
294 | if not success: |
---|
295 | self.flash(msg) |
---|
296 | return |
---|
297 | success, msg, log = self.context.doAfterStudentPayment() |
---|
298 | if log is not None: |
---|
299 | student.writeLogMessage(self, log) |
---|
300 | self.flash(msg) |
---|
301 | return |
---|
302 | |
---|
303 | def render(self): |
---|
304 | self.redirect(self.url(self.context, '@@index')) |
---|
305 | return |
---|
306 | |
---|
307 | class EtranzactQueryHistoryPageApplicant(UtilityView, grok.View): |
---|
308 | """ Query history of eTranzact payments |
---|
309 | """ |
---|
310 | grok.context(ICustomApplicantOnlinePayment) |
---|
311 | grok.name('query_history') |
---|
312 | grok.require('waeup.payApplicant') |
---|
313 | |
---|
314 | def update(self, confirmation_number=None): |
---|
315 | ob_class = self.__implemented__.__name__ |
---|
316 | if self.context.p_state == 'paid': |
---|
317 | self.flash(_('This ticket has already been paid.')) |
---|
318 | return |
---|
319 | applicant = self.context.__parent__ |
---|
320 | success, msg, log = query_etranzact(confirmation_number,self.context) |
---|
321 | applicant.writeLogMessage(self, log) |
---|
322 | if not success: |
---|
323 | self.flash(msg) |
---|
324 | return |
---|
325 | success, msg, log = self.context.doAfterApplicantPayment() |
---|
326 | if log is not None: |
---|
327 | applicant.writeLogMessage(self, log) |
---|
328 | self.flash(msg) |
---|
329 | return |
---|
330 | |
---|
331 | def render(self): |
---|
332 | self.redirect(self.url(self.context, '@@index')) |
---|
333 | return |
---|
334 | |
---|
335 | # Disable Interswitch viewlets. This could be avoided by defining the |
---|
336 | # action button viewlets of kofacustom.nigeria.interswitch.browser in the |
---|
337 | # context of INigeriaStudentOnlinePayment or INigeriaApplicantOnlinePayment |
---|
338 | # respectively. But then all interswitch.browser modules have to be extended. |
---|
339 | |
---|
340 | class InterswitchActionButtonStudent(InterswitchActionButtonStudent): |
---|
341 | |
---|
342 | @property |
---|
343 | def target_url(self): |
---|
344 | return '' |
---|
345 | |
---|
346 | class InterswitchRequestWebserviceActionButtonStudent( |
---|
347 | InterswitchRequestWebserviceActionButtonStudent): |
---|
348 | |
---|
349 | @property |
---|
350 | def target_url(self): |
---|
351 | return '' |
---|
352 | |
---|
353 | class InterswitchActionButtonApplicant(InterswitchActionButtonApplicant): |
---|
354 | |
---|
355 | @property |
---|
356 | def target_url(self): |
---|
357 | return '' |
---|
358 | |
---|
359 | class InterswitchRequestWebserviceActionButtonApplicant( |
---|
360 | InterswitchRequestWebserviceActionButtonApplicant): |
---|
361 | |
---|
362 | @property |
---|
363 | def target_url(self): |
---|
364 | return '' |
---|