source: main/waeup.uniben/trunk/src/waeup/uniben/interswitch/browser.py @ 9443

Last change on this file since 9443 was 9443, checked in by Henrik Bettermann, 12 years ago

Log always payment_category.
  • Property svn:keywords set to Id
File size: 19.8 KB
Line 
1## $Id: browser.py 9443 2012-10-27 06:38:23Z 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##
18from datetime import datetime
19import httplib
20import urllib
21from xml.dom.minidom import parseString
22import grok
23from zope.component import getUtility
24from waeup.kofa.browser.layout import KofaPage, UtilityView
25from waeup.kofa.accesscodes import create_accesscode
26from waeup.kofa.interfaces import RETURNING, IKofaUtils
27from waeup.kofa.utils.helpers import to_timezone
28from waeup.kofa.students.viewlets import ApprovePaymentActionButton as APABStudent
29from waeup.kofa.applicants.viewlets import ApprovePaymentActionButton as APABApplicant
30from waeup.uniben.students.interfaces import ICustomStudentOnlinePayment
31from waeup.uniben.applicants.interfaces import ICustomApplicantOnlinePayment
32from waeup.uniben.interfaces import MessageFactory as _
33
34PRODUCT_ID = '57'
35SITE_NAME = 'uniben-kofa.waeup.org'
36PROVIDER_ACCT = '1010764827'
37PROVIDER_BANK_ID = '117'
38PROVIDER_ITEM_NAME = 'BT Education'
39INSTITUTION_NAME = 'Uniben'
40CURRENCY = '566'
41#QUERY_URL = 'https://webpay.interswitchng.com/paydirect/services/TransactionQueryURL.aspx'
42#QUERY_URL = 'https://testwebpay.interswitchng.com/test_paydirect/services/TransactionQueryURL.aspx'
43POST_ACTION = 'https://webpay.interswitchng.com/paydirect/webpay/pay.aspx'
44#POST_ACTION = 'https://testwebpay.interswitchng.com/test_paydirect/webpay/pay.aspx'
45
46HOST = 'webpay.interswitchng.com'
47#HOST = 'testwebpay.interswitchng.com'
48URL = '/paydirect/services/TransactionQueryWs.asmx'
49#URL = '/test_paydirect/services/TransactionQueryWs.asmx'
50httplib.HTTPConnection.debuglevel = 0
51
52
53def SOAP_post(soap_action,xml):
54    """Handles making the SOAP request.
55
56    Further reading:
57    http://testwebpay.interswitchng.com/test_paydirect/services/TransactionQueryWs.asmx?op=getTransactionData
58    """
59    h = httplib.HTTPConnection(HOST)
60    headers={
61        'Host':HOST,
62        'Content-Type':'text/xml; charset=utf-8',
63        'Content-Length':len(xml),
64        'SOAPAction':'"%s"' % soap_action,
65    }
66    h.request('POST', URL, body=xml,headers=headers)
67    r = h.getresponse()
68    d = r.read()
69    if r.status!=200:
70        raise ValueError('Error connecting: %s, %s' % (r.status, r.reason))
71    return d
72
73def get_SOAP_response(product_id, transref):
74    xml="""\
75<?xml version="1.0" encoding="utf-8"?>
76<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
77  <soap:Body>
78    <getTransactionData xmlns="http://tempuri.org/">
79      <product_id>%s</product_id>
80      <trans_ref>%s</trans_ref>
81    </getTransactionData>
82  </soap:Body>
83</soap:Envelope>""" % (product_id, transref)
84    result_xml=SOAP_post("http://tempuri.org/getTransactionData",xml)
85    doc=parseString(result_xml)
86    response=doc.getElementsByTagName('getTransactionDataResult')[0].firstChild.data
87    return response
88
89def query_interswitch(payment):
90    sr = get_SOAP_response(PRODUCT_ID, payment.p_id)
91    wlist = sr.split(':')
92    if len(wlist) != 7:
93        msg = _('Invalid callback: ${a}', mapping = {'a': sr})
94        log = 'invalid callback for payment %s: %s' % (payment.p_id, sr)
95        return False, msg, log
96    payment.r_code = wlist[0]
97    payment.r_desc = wlist[1]
98    payment.r_amount_approved = float(wlist[2]) / 100
99    payment.r_card_num = wlist[3]
100    payment.r_pay_reference = wlist[5]
101    payment.r_company = u'interswitch'
102    if payment.r_code != '00':
103        msg = _('Unsuccessful callback: ${a}', mapping = {'a': sr})
104        log = 'unsuccessful callback for %s payment %s: %s' % (
105            payment.p_category, payment.p_id, sr)
106        payment.p_state = 'failed'
107        return False, msg, log
108    if payment.r_amount_approved != payment.amount_auth:
109        msg = _('Callback amount does not match.')
110        log = 'wrong callback for %s payment %s: %s' % (
111            payment.p_category, payment.p_id, sr)
112        payment.p_state = 'failed'
113        return False, msg, log
114    if wlist[4] != payment.p_id:
115        msg = _('Callback transaction id does not match.')
116        log = 'wrong callback for %s payment %s: %s' % (
117            payment.p_category, payment.p_id, sr)
118        payment.p_state = 'failed'
119        return False, msg, log
120    payment.p_state = 'paid'
121    payment.payment_date = datetime.utcnow()
122    msg = _('Successful callback received')
123    log = 'valid callback for %s payment %s: %s' % (
124        payment.p_category, payment.p_id, sr)
125    return True, msg, log
126
127class InterswitchActionButtonStudent(APABStudent):
128    grok.order(1)
129    grok.context(ICustomStudentOnlinePayment)
130    grok.require('waeup.payStudent')
131    icon = 'actionicon_pay.png'
132    text = _('CollegePAY')
133    target = 'goto_interswitch'
134
135    @property
136    def target_url(self):
137        if self.context.p_state != 'unpaid':
138            return ''
139        return self.view.url(self.view.context, self.target)
140
141class InterswitchActionButtonApplicant(APABApplicant):
142    grok.order(1)
143    grok.context(ICustomApplicantOnlinePayment)
144    grok.require('waeup.payApplicant')
145    icon = 'actionicon_pay.png'
146    text = _('CollegePAY')
147    target = 'goto_interswitch'
148
149    @property
150    def target_url(self):
151        if self.context.p_state != 'unpaid':
152            return ''
153        return self.view.url(self.view.context, self.target)
154
155# Deprecated
156#class InterswitchRequestCallbackActionButtonStudent(RCABStudent):
157#    grok.order(3)
158#    grok.context(ICustomStudentOnlinePayment)
159#    icon = 'actionicon_call.png'
160#    text = _('Request CollegePAY callback')
161
162#    def target_url(self):
163#        if self.context.p_state == 'paid':
164#            return ''
165#        site_redirect_url = self.view.url(self.view.context, 'isw_callback')
166#        args = {
167#            'transRef':self.context.p_id,
168#            'prodID':PRODUCT_ID,
169#            'redirectURL':site_redirect_url}
170#        return QUERY_URL + '?%s' % urllib.urlencode(args)
171
172# Alternative preferred solution
173class InterswitchRequestWebserviceActionButtonStudent(APABStudent):
174    grok.order(2)
175    grok.context(ICustomStudentOnlinePayment)
176    grok.require('waeup.payStudent')
177    icon = 'actionicon_call.png'
178    text = _('Requery CollegePAY')
179    target = 'request_webservice'
180
181class InterswitchRequestWebserviceActionButtonApplicant(APABApplicant):
182    grok.order(2)
183    grok.context(ICustomApplicantOnlinePayment)
184    grok.require('waeup.payApplicant')
185    icon = 'actionicon_call.png'
186    text = _('Requery CollegePAY')
187    target = 'request_webservice'
188
189
190class InterswitchPageStudent(KofaPage):
191    """ View which sends a POST request to the Interswitch
192    CollegePAY payment gateway.
193    """
194    grok.context(ICustomStudentOnlinePayment)
195    grok.name('goto_interswitch')
196    grok.template('student_goto_interswitch')
197    grok.require('waeup.payStudent')
198    label = _('Submit data to CollegePAY (Interswitch Payment Gateway)')
199    submit_button = _('Submit')
200    action = POST_ACTION
201    site_name = SITE_NAME
202    currency = CURRENCY
203    product_id = PRODUCT_ID
204
205    def update(self):
206        #if self.context.p_state != 'unpaid':
207        if self.context.p_state == 'paid':
208            self.flash(_("Payment ticket can't be re-send to CollegePAY."))
209            self.redirect(self.url(self.context, '@@index'))
210            return
211
212        student = self.student = self.context.student
213        certificate = getattr(student['studycourse'],'certificate',None)
214        self.amount_auth = 100 * self.context.amount_auth
215        xmldict = {}
216        if certificate is not None:
217            xmldict['department'] = certificate.__parent__.__parent__.code
218            xmldict['faculty'] = certificate.__parent__.__parent__.__parent__.code
219        else:
220            xmldict['department'] = None
221            xmldict['faculty'] = None
222        self.category = getUtility(IKofaUtils).PAYMENT_CATEGORIES[self.context.p_category]
223        tz = getUtility(IKofaUtils).tzinfo
224        self.local_date_time = to_timezone(
225            self.context.creation_date, tz).strftime("%Y-%m-%d %H:%M:%S %Z")
226        self.site_redirect_url = self.url(self.context, 'request_webservice')
227        # Provider data
228        xmldict['detail_ref'] = self.context.p_id
229        xmldict['provider_acct'] = PROVIDER_ACCT
230        xmldict['provider_bank_id'] = PROVIDER_BANK_ID
231        xmldict['provider_item_name'] = PROVIDER_ITEM_NAME
232        # Institution data
233        xmldict['institution_acct'] = '000000000000'
234        xmldict['institution_bank_id'] = '00'
235        xmldict['institution_amt'] = '0.0'
236        if self.context.p_category == 'schoolfee':
237            if student.current_mode.endswith('_ft') \
238                and student.state == RETURNING:
239                provider_amt = 600
240            else:
241                provider_amt = 1500
242            #studycourse = student['studycourse']
243            if student.current_mode.endswith('_ft'):
244                self.pay_item_id = '5700'
245                #post-grad full-time students of all faculties
246                if student.is_postgrad:
247                    xmldict['institution_acct'] = '1012842833'
248                    xmldict['institution_bank_id'] = '117'
249                #all other part-time students depending on faculty
250                elif student.faccode in ('SSC','LAW','MED'):
251                    xmldict['institution_acct'] = '0005986938'
252                    xmldict['institution_bank_id'] = '31'
253                elif student.faccode in ('ENG','PSC','PHA'):
254                    xmldict['institution_acct'] = '0014413973'
255                    xmldict['institution_bank_id'] = '129'
256                elif student.faccode in ('LSC','DEN','AGR'):
257                    xmldict['institution_acct'] = '1012801319'
258                    xmldict['institution_bank_id'] = '117'
259                elif student.faccode in ('ART','EDU','MGS','BMS'):
260                    xmldict['institution_acct'] = '6220027556'
261                    xmldict['institution_bank_id'] = '51'
262            elif student.current_mode.endswith('_pt'):
263                self.pay_item_id = '5701'
264                #post-grad part-time students of all faculties
265                if student.is_postgrad:
266                    xmldict['institution_acct'] = '0023708207'
267                    xmldict['institution_bank_id'] = '72'
268                #all other part-time students depending on faculty
269                elif student.faccode in ('ENG','LAW','MGS'):
270                    xmldict['institution_acct'] = '2019006824'
271                    xmldict['institution_bank_id'] = '8'
272                elif student.faccode in ('IPA','PHA','SSC','AGR','EDU'):
273                    xmldict['institution_acct'] = '0122012109'
274                    xmldict['institution_bank_id'] = '16'
275        elif self.context.p_category == 'clearance':
276            self.pay_item_id = '5702'
277            provider_amt = 1500
278            xmldict['institution_bank_id'] = '7'
279            xmldict['institution_acct'] = '1003475516'
280
281        xmldict['provider_amt'] = 100 * provider_amt
282        xmldict['institution_item_name'] = self.category
283        xmldict['institution_name'] = INSTITUTION_NAME
284        xmldict['institution_amt'] = 100 * (
285            self.context.amount_auth - provider_amt - 150)
286        # Interswitch amount is not part of the xml data
287        xmltext = """<payment_item_detail>
288<item_details detail_ref="%(detail_ref)s" college="%(institution_name)s" department="%(department)s" faculty="%(faculty)s">
289<item_detail item_id="1" item_name="%(institution_item_name)s" item_amt="%(institution_amt)d" bank_id="%(institution_bank_id)s" acct_num="%(institution_acct)s" />
290<item_detail item_id="2" item_name="%(provider_item_name)s" item_amt="%(provider_amt)d" bank_id="%(provider_bank_id)s" acct_num="%(provider_acct)s" />
291</item_details>
292</payment_item_detail>""" % xmldict
293        self.xml_data = """<input type="hidden" name="xml_data" value='%s'  />""" % xmltext
294        return
295
296class InterswitchPageApplicant(KofaPage):
297    """ View which sends a POST request to the Interswitch
298    CollegePAY payment gateway.
299    """
300    grok.context(ICustomApplicantOnlinePayment)
301    grok.require('waeup.payApplicant')
302    grok.template('applicant_goto_interswitch')
303    grok.name('goto_interswitch')
304    label = _('Submit data to CollegePAY (Interswitch Payment Gateway)')
305    submit_button = _('Submit')
306    action = POST_ACTION
307    site_name = SITE_NAME
308    currency = CURRENCY
309    pay_item_id = '5703'
310    product_id = PRODUCT_ID
311
312    def update(self):
313        if self.context.p_state != 'unpaid':
314            self.flash(_("Payment ticket can't be re-send to CollegePAY."))
315            self.redirect(self.url(self.context, '@@index'))
316            return
317        if self.context.__parent__.__parent__.expired \
318            and self.context.__parent__.__parent__.strict_deadline:
319            self.flash(_("Payment ticket can't be send to CollegePAY. "
320                         "Application period has expired."))
321            self.redirect(self.url(self.context, '@@index'))
322            return
323        self.applicant = self.context.__parent__
324        self.amount_auth = 100 * self.context.amount_auth
325        xmldict = {}
326        self.category = getUtility(IKofaUtils).PAYMENT_CATEGORIES[self.context.p_category]
327        tz = getUtility(IKofaUtils).tzinfo
328        self.local_date_time = to_timezone(
329            self.context.creation_date, tz).strftime("%Y-%m-%d %H:%M:%S %Z")
330        self.site_redirect_url = self.url(self.context, 'request_webservice')
331        if self.applicant.applicant_id.startswith('pg'):
332            provider_amt = 400
333            xmldict['institution_acct'] = '0031716030'
334            xmldict['institution_bank_id'] = '10'
335        else:
336            provider_amt = 250
337            xmldict['institution_acct'] = '6220032503'
338            xmldict['institution_bank_id'] = '51'
339        xmldict['detail_ref'] = self.context.p_id
340        xmldict['provider_amt'] = 100 * provider_amt
341        xmldict['provider_acct'] = PROVIDER_ACCT
342        xmldict['provider_bank_id'] = PROVIDER_BANK_ID
343        xmldict['provider_item_name'] = PROVIDER_ITEM_NAME
344        xmldict['institution_amt'] = 100 * (self.context.amount_auth - provider_amt - 150)
345        xmldict['institution_item_name'] = self.context.p_category
346        xmldict['institution_name'] = INSTITUTION_NAME
347        # Interswitch amount is not part of the xml data
348        xmltext = """<payment_item_detail>
349<item_details detail_ref="%(detail_ref)s" college="%(institution_name)s">
350<item_detail item_id="1" item_name="%(institution_item_name)s" item_amt="%(institution_amt)d" bank_id="%(institution_bank_id)s" acct_num="%(institution_acct)s" />
351<item_detail item_id="2" item_name="%(provider_item_name)s" item_amt="%(provider_amt)d" bank_id="%(provider_bank_id)s" acct_num="%(provider_acct)s" />
352</item_details>
353</payment_item_detail>""" % xmldict
354        self.xml_data = """<input type="hidden" name="xml_data" value='%s'  />""" % xmltext
355        return
356
357# Deprecated
358#class InterswitchPaymentCallbackPageStudent(UtilityView, grok.View):
359#    """ Callback view for the CollegePAY gateway
360#    """
361#    grok.context(ICustomStudentOnlinePayment)
362#    grok.name('isw_callback')
363#    grok.require('waeup.payStudent')
364
365    # This view is not yet working for offline querying transactions
366    # since the query string differs from the query string sent after
367    # posting transactions. This Interswitch bug must be removed first.
368    # Alternatively, we could use the webservice only and replace
369    # the RequestCallbackActionButton by a RequestWebserviceActionButton
370
371#    def update(self):
372#        if self.context.p_state == 'paid':
373#            self.flash(_('This ticket has already been paid.'))
374#            return
375#        student = self.context.student
376#        query = self.request.form
377#        write_log_message(self,'callback received: %s' % query)
378#        self.context.r_card_num = query.get('cardNum', None)
379#        self.context.r_code = query.get('resp', None)
380#        self.context.r_pay_reference  = query.get('payRef', None)
381#        self.context.r_amount_approved = float(query.get('apprAmt', '0.0')) / 100
382#        self.context.r_desc = query.get('desc', None)
383#        if self.context.r_code != '00':
384#            self.flash(_('Unsuccessful callback: ${a}',
385#                mapping = {'a': query.get('desc', _('Incomplete query string.'))}))
386#            write_log_message(self,'unsuccessful callback: %s' % self.context.p_id)
387#            self.context.p_state = 'failed'
388#            return
389#        if self.context.r_amount_approved != payment.amount_auth:
390#            self.flash(_('Wrong amount'))
391#            write_log_message(
392#                self,'successful but wrong amount: %s' % self.context.p_id)
393#            self.context.p_state = 'failed'
394#            return
395#        try:
396#            validation_list = get_SOAP_response(
397#                PRODUCT_ID, self.context.p_id).split(':')
398            # Validation does not make sense yet since the query string
399            # formats are conflicting. We are only printing the validation
400            # string, nothing else.
401#            print 'WARNING: Webservice validation is not yet implemented'
402#            print 'validation list: %s' % validation_list
403#        except:
404#            print 'Connection to webservice failed.'
405        # Add webservice validation here
406#        write_log_message(self,'valid callback: %s' % self.context.p_id)
407#        self.context.p_state = 'paid'
408#        self.context.payment_date = datetime.utcnow()
409#        actions_after_student_payment(student, self.context, self)
410#        return
411
412#    def render(self):
413#        self.redirect(self.url(self.context, '@@index'))
414#        return
415
416# Alternative solution, replaces InterswitchPaymentCallbackPage
417class InterswitchPaymentRequestWebservicePageStudent(UtilityView, grok.View):
418    """ Request webservice view for the CollegePAY gateway
419    """
420    grok.context(ICustomStudentOnlinePayment)
421    grok.name('request_webservice')
422    grok.require('waeup.payStudent')
423
424    def update(self):
425        ob_class = self.__implemented__.__name__
426        if self.context.p_state == 'paid':
427            self.flash(_('This ticket has already been paid.'))
428            return
429        student = self.context.student
430        success, msg, log = query_interswitch(self.context)
431        student.writeLogMessage(self, log)
432        if not success:
433            self.flash(msg)
434            return
435        success, msg, log = self.context.doAfterStudentPayment()
436        if log is not None:
437            student.writeLogMessage(self, log)
438        self.flash(msg)
439        return
440
441    def render(self):
442        self.redirect(self.url(self.context, '@@index'))
443        return
444
445class InterswitchPaymentRequestWebservicePageApplicant(UtilityView, grok.View):
446    """ Request webservice view for the CollegePAY gateway
447    """
448    grok.context(ICustomApplicantOnlinePayment)
449    grok.name('request_webservice')
450    grok.require('waeup.payApplicant')
451
452    def update(self):
453        if self.context.p_state == 'paid':
454            self.flash(_('This ticket has already been paid.'))
455            return
456        applicant = self.context.__parent__
457        success, msg, log = query_interswitch(self.context)
458        applicant.writeLogMessage(self, log)
459        if not success:
460            self.flash(msg)
461            return
462        success, msg, log = self.context.doAfterApplicantPayment()
463        if log is not None:
464            applicant.writeLogMessage(self, log)
465        self.flash(msg)
466        return
467
468    def render(self):
469        self.redirect(self.url(self.context, '@@index'))
470        return
Note: See TracBrowser for help on using the repository browser.