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

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

The payment_categories vocab does no longer exist. We have a dict in KofaUtils? instead.
  • Property svn:keywords set to Id
File size: 19.7 KB
Line 
1## $Id: browser.py 9407 2012-10-24 21:59:21Z 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 payment %s: %s' % (payment.p_id, sr)
105        payment.p_state = 'failed'
106        return False, msg, log
107    if payment.r_amount_approved != payment.amount_auth:
108        msg = _('Callback amount does not match.')
109        log = 'wrong callback for payment %s: %s' % (payment.p_id, sr)
110        payment.p_state = 'failed'
111        return False, msg, log
112    if wlist[4] != payment.p_id:
113        msg = _('Callback transaction id does not match.')
114        log = 'wrong callback for payment %s: %s' % (payment.p_id, sr)
115        payment.p_state = 'failed'
116        return False, msg, log
117    payment.p_state = 'paid'
118    payment.payment_date = datetime.utcnow()
119    msg = _('Successful callback received')
120    log = 'valid callback for payment %s: %s' % (payment.p_id, sr)
121    return True, msg, log
122
123class InterswitchActionButtonStudent(APABStudent):
124    grok.order(1)
125    grok.context(ICustomStudentOnlinePayment)
126    grok.require('waeup.payStudent')
127    icon = 'actionicon_pay.png'
128    text = _('CollegePAY')
129    target = 'goto_interswitch'
130
131    @property
132    def target_url(self):
133        if self.context.p_state != 'unpaid':
134            return ''
135        return self.view.url(self.view.context, self.target)
136
137class InterswitchActionButtonApplicant(APABApplicant):
138    grok.order(1)
139    grok.context(ICustomApplicantOnlinePayment)
140    grok.require('waeup.payApplicant')
141    icon = 'actionicon_pay.png'
142    text = _('CollegePAY')
143    target = 'goto_interswitch'
144
145    @property
146    def target_url(self):
147        if self.context.p_state != 'unpaid':
148            return ''
149        return self.view.url(self.view.context, self.target)
150
151# Deprecated
152#class InterswitchRequestCallbackActionButtonStudent(RCABStudent):
153#    grok.order(3)
154#    grok.context(ICustomStudentOnlinePayment)
155#    icon = 'actionicon_call.png'
156#    text = _('Request CollegePAY callback')
157
158#    def target_url(self):
159#        if self.context.p_state == 'paid':
160#            return ''
161#        site_redirect_url = self.view.url(self.view.context, 'isw_callback')
162#        args = {
163#            'transRef':self.context.p_id,
164#            'prodID':PRODUCT_ID,
165#            'redirectURL':site_redirect_url}
166#        return QUERY_URL + '?%s' % urllib.urlencode(args)
167
168# Alternative preferred solution
169class InterswitchRequestWebserviceActionButtonStudent(APABStudent):
170    grok.order(2)
171    grok.context(ICustomStudentOnlinePayment)
172    grok.require('waeup.payStudent')
173    icon = 'actionicon_call.png'
174    text = _('Requery CollegePAY')
175    target = 'request_webservice'
176
177class InterswitchRequestWebserviceActionButtonApplicant(APABApplicant):
178    grok.order(2)
179    grok.context(ICustomApplicantOnlinePayment)
180    grok.require('waeup.payApplicant')
181    icon = 'actionicon_call.png'
182    text = _('Requery CollegePAY')
183    target = 'request_webservice'
184
185
186class InterswitchPageStudent(KofaPage):
187    """ View which sends a POST request to the Interswitch
188    CollegePAY payment gateway.
189    """
190    grok.context(ICustomStudentOnlinePayment)
191    grok.name('goto_interswitch')
192    grok.template('student_goto_interswitch')
193    grok.require('waeup.payStudent')
194    label = _('Submit data to CollegePAY (Interswitch Payment Gateway)')
195    submit_button = _('Submit')
196    action = POST_ACTION
197    site_name = SITE_NAME
198    currency = CURRENCY
199    product_id = PRODUCT_ID
200
201    def update(self):
202        #if self.context.p_state != 'unpaid':
203        if self.context.p_state == 'paid':
204            self.flash(_("Payment ticket can't be re-send to CollegePAY."))
205            self.redirect(self.url(self.context, '@@index'))
206            return
207
208        student = self.student = self.context.student
209        certificate = getattr(student['studycourse'],'certificate',None)
210        self.amount_auth = 100 * self.context.amount_auth
211        xmldict = {}
212        if certificate is not None:
213            xmldict['department'] = certificate.__parent__.__parent__.code
214            xmldict['faculty'] = certificate.__parent__.__parent__.__parent__.code
215        else:
216            xmldict['department'] = None
217            xmldict['faculty'] = None
218        self.category = getUtility(IKofaUtils).PAYMENT_CATEGORIES[self.context.p_category]
219        tz = getUtility(IKofaUtils).tzinfo
220        self.local_date_time = to_timezone(
221            self.context.creation_date, tz).strftime("%Y-%m-%d %H:%M:%S %Z")
222        self.site_redirect_url = self.url(self.context, 'request_webservice')
223        # Provider data
224        xmldict['detail_ref'] = self.context.p_id
225        xmldict['provider_acct'] = PROVIDER_ACCT
226        xmldict['provider_bank_id'] = PROVIDER_BANK_ID
227        xmldict['provider_item_name'] = PROVIDER_ITEM_NAME
228        # Institution data
229        xmldict['institution_acct'] = '000000000000'
230        xmldict['institution_bank_id'] = '00'
231        xmldict['institution_amt'] = '0.0'
232        if self.context.p_category == 'schoolfee':
233            if student.current_mode.endswith('_ft') \
234                and student.state == RETURNING:
235                provider_amt = 600
236            else:
237                provider_amt = 1500
238            #studycourse = student['studycourse']
239            if student.current_mode.endswith('_ft'):
240                self.pay_item_id = '5700'
241                #post-grad full-time students of all faculties
242                if student.is_postgrad:
243                    xmldict['institution_acct'] = '1012842833'
244                    xmldict['institution_bank_id'] = '117'
245                #all other part-time students depending on faculty
246                elif student.faccode in ('SSC','LAW','MED'):
247                    xmldict['institution_acct'] = '0005986938'
248                    xmldict['institution_bank_id'] = '31'
249                elif student.faccode in ('ENG','PSC','PHA'):
250                    xmldict['institution_acct'] = '0014413973'
251                    xmldict['institution_bank_id'] = '129'
252                elif student.faccode in ('LSC','DEN','AGR'):
253                    xmldict['institution_acct'] = '1012801319'
254                    xmldict['institution_bank_id'] = '117'
255                elif student.faccode in ('ART','EDU','MGS','BMS'):
256                    xmldict['institution_acct'] = '6220027556'
257                    xmldict['institution_bank_id'] = '51'
258            elif student.current_mode.endswith('_pt'):
259                self.pay_item_id = '5701'
260                #post-grad part-time students of all faculties
261                if student.is_postgrad:
262                    xmldict['institution_acct'] = '0023708207'
263                    xmldict['institution_bank_id'] = '72'
264                #all other part-time students depending on faculty
265                elif student.faccode in ('ENG','LAW','MGS'):
266                    xmldict['institution_acct'] = '2019006824'
267                    xmldict['institution_bank_id'] = '8'
268                elif student.faccode in ('IPA','PHA','SSC','AGR','EDU'):
269                    xmldict['institution_acct'] = '0122012109'
270                    xmldict['institution_bank_id'] = '16'
271        elif self.context.p_category == 'clearance':
272            self.pay_item_id = '5702'
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 = getUtility(IKofaUtils).PAYMENT_CATEGORIES[self.context.p_category]
323        tz = getUtility(IKofaUtils).tzinfo
324        self.local_date_time = to_timezone(
325            self.context.creation_date, tz).strftime("%Y-%m-%d %H:%M:%S %Z")
326        self.site_redirect_url = self.url(self.context, 'request_webservice')
327        if self.applicant.applicant_id.startswith('pg'):
328            provider_amt = 400
329            xmldict['institution_acct'] = '0031716030'
330            xmldict['institution_bank_id'] = '10'
331        else:
332            provider_amt = 250
333            xmldict['institution_acct'] = '6220032503'
334            xmldict['institution_bank_id'] = '51'
335        xmldict['detail_ref'] = self.context.p_id
336        xmldict['provider_amt'] = 100 * provider_amt
337        xmldict['provider_acct'] = PROVIDER_ACCT
338        xmldict['provider_bank_id'] = PROVIDER_BANK_ID
339        xmldict['provider_item_name'] = PROVIDER_ITEM_NAME
340        xmldict['institution_amt'] = 100 * (self.context.amount_auth - provider_amt - 150)
341        xmldict['institution_item_name'] = self.context.p_category
342        xmldict['institution_name'] = INSTITUTION_NAME
343        # Interswitch amount is not part of the xml data
344        xmltext = """<payment_item_detail>
345<item_details detail_ref="%(detail_ref)s" college="%(institution_name)s">
346<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" />
347<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" />
348</item_details>
349</payment_item_detail>""" % xmldict
350        self.xml_data = """<input type="hidden" name="xml_data" value='%s'  />""" % xmltext
351        return
352
353# Deprecated
354#class InterswitchPaymentCallbackPageStudent(UtilityView, grok.View):
355#    """ Callback view for the CollegePAY gateway
356#    """
357#    grok.context(ICustomStudentOnlinePayment)
358#    grok.name('isw_callback')
359#    grok.require('waeup.payStudent')
360
361    # This view is not yet working for offline querying transactions
362    # since the query string differs from the query string sent after
363    # posting transactions. This Interswitch bug must be removed first.
364    # Alternatively, we could use the webservice only and replace
365    # the RequestCallbackActionButton by a RequestWebserviceActionButton
366
367#    def update(self):
368#        if self.context.p_state == 'paid':
369#            self.flash(_('This ticket has already been paid.'))
370#            return
371#        student = self.context.student
372#        query = self.request.form
373#        write_log_message(self,'callback received: %s' % query)
374#        self.context.r_card_num = query.get('cardNum', None)
375#        self.context.r_code = query.get('resp', None)
376#        self.context.r_pay_reference  = query.get('payRef', None)
377#        self.context.r_amount_approved = float(query.get('apprAmt', '0.0')) / 100
378#        self.context.r_desc = query.get('desc', None)
379#        if self.context.r_code != '00':
380#            self.flash(_('Unsuccessful callback: ${a}',
381#                mapping = {'a': query.get('desc', _('Incomplete query string.'))}))
382#            write_log_message(self,'unsuccessful callback: %s' % self.context.p_id)
383#            self.context.p_state = 'failed'
384#            return
385#        if self.context.r_amount_approved != payment.amount_auth:
386#            self.flash(_('Wrong amount'))
387#            write_log_message(
388#                self,'successful but wrong amount: %s' % self.context.p_id)
389#            self.context.p_state = 'failed'
390#            return
391#        try:
392#            validation_list = get_SOAP_response(
393#                PRODUCT_ID, self.context.p_id).split(':')
394            # Validation does not make sense yet since the query string
395            # formats are conflicting. We are only printing the validation
396            # string, nothing else.
397#            print 'WARNING: Webservice validation is not yet implemented'
398#            print 'validation list: %s' % validation_list
399#        except:
400#            print 'Connection to webservice failed.'
401        # Add webservice validation here
402#        write_log_message(self,'valid callback: %s' % self.context.p_id)
403#        self.context.p_state = 'paid'
404#        self.context.payment_date = datetime.utcnow()
405#        actions_after_student_payment(student, self.context, self)
406#        return
407
408#    def render(self):
409#        self.redirect(self.url(self.context, '@@index'))
410#        return
411
412# Alternative solution, replaces InterswitchPaymentCallbackPage
413class InterswitchPaymentRequestWebservicePageStudent(UtilityView, grok.View):
414    """ Request webservice view for the CollegePAY gateway
415    """
416    grok.context(ICustomStudentOnlinePayment)
417    grok.name('request_webservice')
418    grok.require('waeup.payStudent')
419
420    def update(self):
421        ob_class = self.__implemented__.__name__
422        if self.context.p_state == 'paid':
423            self.flash(_('This ticket has already been paid.'))
424            return
425        student = self.context.student
426        success, msg, log = query_interswitch(self.context)
427        student.writeLogMessage(self, log)
428        if not success:
429            self.flash(msg)
430            return
431        success, msg, log = self.context.doAfterStudentPayment()
432        if log is not None:
433            student.writeLogMessage(self, log)
434        self.flash(msg)
435        return
436
437    def render(self):
438        self.redirect(self.url(self.context, '@@index'))
439        return
440
441class InterswitchPaymentRequestWebservicePageApplicant(UtilityView, grok.View):
442    """ Request webservice view for the CollegePAY gateway
443    """
444    grok.context(ICustomApplicantOnlinePayment)
445    grok.name('request_webservice')
446    grok.require('waeup.payApplicant')
447
448    def update(self):
449        if self.context.p_state == 'paid':
450            self.flash(_('This ticket has already been paid.'))
451            return
452        applicant = self.context.__parent__
453        success, msg, log = query_interswitch(self.context)
454        applicant.writeLogMessage(self, log)
455        if not success:
456            self.flash(msg)
457            return
458        success, msg, log = self.context.doAfterApplicantPayment()
459        if log is not None:
460            applicant.writeLogMessage(self, log)
461        self.flash(msg)
462        return
463
464    def render(self):
465        self.redirect(self.url(self.context, '@@index'))
466        return
Note: See TracBrowser for help on using the repository browser.