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

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

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