source: main/waeup.futminna/trunk/src/waeup/futminna/interswitch/browser.py @ 8957

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

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