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

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

Use dummy account number and bank id instead of empty string.
  • Property svn:keywords set to Id
File size: 19.7 KB
Line 
1## $Id: browser.py 9385 2012-10-22 12:12:37Z 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.uniben.students.interfaces import ICustomStudentOnlinePayment
32from waeup.uniben.applicants.interfaces import ICustomApplicantOnlinePayment
33from waeup.uniben.interfaces import MessageFactory as _
34
35PRODUCT_ID = '57'
36SITE_NAME = 'uniben-kofa.waeup.org'
37PROVIDER_ACCT = '1010764827'
38PROVIDER_BANK_ID = '117'
39PROVIDER_ITEM_NAME = 'BT Education'
40INSTITUTION_NAME = 'Uniben'
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        # Institution data
232        xmldict['institution_acct'] = '000000000000'
233        xmldict['institution_bank_id'] = '00'
234        xmldict['institution_amt'] = '0.0'
235        if self.context.p_category == 'schoolfee':
236            if student.current_mode.endswith('_ft') \
237                and student.state == RETURNING:
238                provider_amt = 600
239            else:
240                provider_amt = 1500
241            #studycourse = student['studycourse']
242            if student.current_mode.endswith('_ft'):
243                #post-grad full-time students of all faculties
244                if student.is_postgrad:
245                    xmldict['institution_acct'] = '1012842833'
246                    xmldict['institution_bank_id'] = '117'
247                #all other part-time students depending on faculty
248                elif student.faccode in ('SSC','LAW','MED'):
249                    xmldict['institution_acct'] = '0005986938'
250                    xmldict['institution_bank_id'] = '31'
251                elif student.faccode in ('ENG','PSC','PHA'):
252                    xmldict['institution_acct'] = '0014413973'
253                    xmldict['institution_bank_id'] = '129'
254                elif student.faccode in ('LSC','DEN','AGR'):
255                    xmldict['institution_acct'] = '1012801319'
256                    xmldict['institution_bank_id'] = '117'
257                elif student.faccode in ('ART','EDU','MGS','BMS'):
258                    xmldict['institution_acct'] = '6220027556'
259                    xmldict['institution_bank_id'] = '51'
260            elif student.current_mode.endswith('_pt'):
261                #post-grad part-time students of all faculties
262                if student.is_postgrad:
263                    xmldict['institution_acct'] = '0023708207'
264                    xmldict['institution_bank_id'] = '72'
265                #all other part-time students depending on faculty
266                elif student.faccode in ('ENG','LAW','MGS'):
267                    xmldict['institution_acct'] = '2019006824'
268                    xmldict['institution_bank_id'] = '8'
269                elif student.faccode in ('IPA','PHA','SSC','AGR','EDU'):
270                    xmldict['institution_acct'] = '0122012109'
271                    xmldict['institution_bank_id'] = '16'
272        elif self.context.p_category == 'clearance':
273            provider_amt = 1500
274            xmldict['institution_bank_id'] = '7'
275            xmldict['institution_acct'] = '1003475516'
276
277        xmldict['provider_amt'] = 100 * provider_amt
278        xmldict['institution_item_name'] = self.category
279        xmldict['institution_name'] = INSTITUTION_NAME
280        xmldict['institution_amt'] = 100 * (
281            self.context.amount_auth - provider_amt - 150)
282        # Interswitch amount is not part of the xml data
283        xmltext = """<payment_item_detail>
284<item_details detail_ref="%(detail_ref)s" college="%(institution_name)s" department="%(department)s" faculty="%(faculty)s">
285<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" />
286<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" />
287</item_details>
288</payment_item_detail>""" % xmldict
289        self.xml_data = """<input type="hidden" name="xml_data" value='%s'  />""" % xmltext
290        return
291
292class InterswitchPageApplicant(KofaPage):
293    """ View which sends a POST request to the Interswitch
294    CollegePAY payment gateway.
295    """
296    grok.context(ICustomApplicantOnlinePayment)
297    grok.require('waeup.payApplicant')
298    grok.template('applicant_goto_interswitch')
299    grok.name('goto_interswitch')
300    label = _('Submit data to CollegePAY (Interswitch Payment Gateway)')
301    submit_button = _('Submit')
302    action = POST_ACTION
303    site_name = SITE_NAME
304    currency = CURRENCY
305    pay_item_id = '5703'
306    product_id = PRODUCT_ID
307
308    def update(self):
309        if self.context.p_state != 'unpaid':
310            self.flash(_("Payment ticket can't be re-send to CollegePAY."))
311            self.redirect(self.url(self.context, '@@index'))
312            return
313        if self.context.__parent__.__parent__.expired \
314            and self.context.__parent__.__parent__.strict_deadline:
315            self.flash(_("Payment ticket can't be send to CollegePAY. "
316                         "Application period has expired."))
317            self.redirect(self.url(self.context, '@@index'))
318            return
319        self.applicant = self.context.__parent__
320        self.amount_auth = 100 * self.context.amount_auth
321        xmldict = {}
322        self.category = payment_categories.getTermByToken(
323            self.context.p_category).title
324        tz = getUtility(IKofaUtils).tzinfo
325        self.local_date_time = to_timezone(
326            self.context.creation_date, tz).strftime("%Y-%m-%d %H:%M:%S %Z")
327        self.site_redirect_url = self.url(self.context, 'request_webservice')
328        if self.applicant.applicant_id.startswith('pg'):
329            provider_amt = 400
330            xmldict['institution_acct'] = '0031716030'
331            xmldict['institution_bank_id'] = '10'
332        else:
333            provider_amt = 250
334            xmldict['institution_acct'] = '6220032503'
335            xmldict['institution_bank_id'] = '51'
336        xmldict['detail_ref'] = self.context.p_id
337        xmldict['provider_amt'] = 100 * provider_amt
338        xmldict['provider_acct'] = PROVIDER_ACCT
339        xmldict['provider_bank_id'] = PROVIDER_BANK_ID
340        xmldict['provider_item_name'] = PROVIDER_ITEM_NAME
341        xmldict['institution_amt'] = 100 * (self.context.amount_auth - provider_amt - 150)
342        xmldict['institution_item_name'] = self.context.p_category
343        xmldict['institution_name'] = INSTITUTION_NAME
344        # Interswitch amount is not part of the xml data
345        xmltext = """<payment_item_detail>
346<item_details detail_ref="%(detail_ref)s" college="%(institution_name)s">
347<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" />
348<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" />
349</item_details>
350</payment_item_detail>""" % xmldict
351        self.xml_data = """<input type="hidden" name="xml_data" value='%s'  />""" % xmltext
352        return
353
354# Deprecated
355#class InterswitchPaymentCallbackPageStudent(UtilityView, grok.View):
356#    """ Callback view for the CollegePAY gateway
357#    """
358#    grok.context(ICustomStudentOnlinePayment)
359#    grok.name('isw_callback')
360#    grok.require('waeup.payStudent')
361
362    # This view is not yet working for offline querying transactions
363    # since the query string differs from the query string sent after
364    # posting transactions. This Interswitch bug must be removed first.
365    # Alternatively, we could use the webservice only and replace
366    # the RequestCallbackActionButton by a RequestWebserviceActionButton
367
368#    def update(self):
369#        if self.context.p_state == 'paid':
370#            self.flash(_('This ticket has already been paid.'))
371#            return
372#        student = self.context.student
373#        query = self.request.form
374#        write_log_message(self,'callback received: %s' % query)
375#        self.context.r_card_num = query.get('cardNum', None)
376#        self.context.r_code = query.get('resp', None)
377#        self.context.r_pay_reference  = query.get('payRef', None)
378#        self.context.r_amount_approved = float(query.get('apprAmt', '0.0')) / 100
379#        self.context.r_desc = query.get('desc', None)
380#        if self.context.r_code != '00':
381#            self.flash(_('Unsuccessful callback: ${a}',
382#                mapping = {'a': query.get('desc', _('Incomplete query string.'))}))
383#            write_log_message(self,'unsuccessful callback: %s' % self.context.p_id)
384#            self.context.p_state = 'failed'
385#            return
386#        if self.context.r_amount_approved != payment.amount_auth:
387#            self.flash(_('Wrong amount'))
388#            write_log_message(
389#                self,'successful but wrong amount: %s' % self.context.p_id)
390#            self.context.p_state = 'failed'
391#            return
392#        try:
393#            validation_list = get_SOAP_response(
394#                PRODUCT_ID, self.context.p_id).split(':')
395            # Validation does not make sense yet since the query string
396            # formats are conflicting. We are only printing the validation
397            # string, nothing else.
398#            print 'WARNING: Webservice validation is not yet implemented'
399#            print 'validation list: %s' % validation_list
400#        except:
401#            print 'Connection to webservice failed.'
402        # Add webservice validation here
403#        write_log_message(self,'valid callback: %s' % self.context.p_id)
404#        self.context.p_state = 'paid'
405#        self.context.payment_date = datetime.utcnow()
406#        actions_after_student_payment(student, self.context, self)
407#        return
408
409#    def render(self):
410#        self.redirect(self.url(self.context, '@@index'))
411#        return
412
413# Alternative solution, replaces InterswitchPaymentCallbackPage
414class InterswitchPaymentRequestWebservicePageStudent(UtilityView, grok.View):
415    """ Request webservice view for the CollegePAY gateway
416    """
417    grok.context(ICustomStudentOnlinePayment)
418    grok.name('request_webservice')
419    grok.require('waeup.payStudent')
420
421    def update(self):
422        ob_class = self.__implemented__.__name__
423        if self.context.p_state == 'paid':
424            self.flash(_('This ticket has already been paid.'))
425            return
426        student = self.context.student
427        success, msg, log = query_interswitch(self.context)
428        student.writeLogMessage(self, log)
429        if not success:
430            self.flash(msg)
431            return
432        success, msg, log = self.context.doAfterStudentPayment()
433        if log is not None:
434            student.writeLogMessage(self, log)
435        self.flash(msg)
436        return
437
438    def render(self):
439        self.redirect(self.url(self.context, '@@index'))
440        return
441
442class InterswitchPaymentRequestWebservicePageApplicant(UtilityView, grok.View):
443    """ Request webservice view for the CollegePAY gateway
444    """
445    grok.context(ICustomApplicantOnlinePayment)
446    grok.name('request_webservice')
447    grok.require('waeup.payApplicant')
448
449    def update(self):
450        if self.context.p_state == 'paid':
451            self.flash(_('This ticket has already been paid.'))
452            return
453        applicant = self.context.__parent__
454        success, msg, log = query_interswitch(self.context)
455        applicant.writeLogMessage(self, log)
456        if not success:
457            self.flash(msg)
458            return
459        success, msg, log = self.context.doAfterApplicantPayment()
460        if log is not None:
461            applicant.writeLogMessage(self, log)
462        self.flash(msg)
463        return
464
465    def render(self):
466        self.redirect(self.url(self.context, '@@index'))
467        return
Note: See TracBrowser for help on using the repository browser.