source: main/waeup.aaue/trunk/src/waeup/aaue/etranzact/browser.py @ 11627

Last change on this file since 11627 was 11627, checked in by Henrik Bettermann, 11 years ago

To guarantee that cleared students pay both acceptance fee and school fees,
the eTranzact History can only be queried for school fee payments if
acceptance/clearance fee has been successfully queried/paid beforehand.
  • Property svn:keywords set to Id
File size: 14.0 KB
Line 
1## $Id: browser.py 11627 2014-05-07 18:21:58Z 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
21import urllib2
22from xml.dom.minidom import parseString
23import grok
24from zope.component import getUtility
25from zope.catalog.interfaces import ICatalog
26from waeup.kofa.interfaces import IUniversity
27from waeup.kofa.payments.interfaces import IPayer
28from waeup.kofa.webservices import PaymentDataWebservice
29from waeup.kofa.browser.layout import KofaPage, UtilityView
30from waeup.kofa.students.viewlets import ApprovePaymentActionButton as APABStudent
31from waeup.kofa.applicants.viewlets import ApprovePaymentActionButton as APABApplicant
32from waeup.aaue.interfaces import academic_sessions_vocab
33from kofacustom.nigeria.interswitch.browser import (
34    InterswitchActionButtonStudent,
35    InterswitchRequestWebserviceActionButtonStudent,
36    InterswitchActionButtonApplicant,
37    InterswitchRequestWebserviceActionButtonApplicant)
38from waeup.aaue.interfaces import MessageFactory as _
39from waeup.aaue.students.interfaces import ICustomStudentOnlinePayment
40from waeup.aaue.applicants.interfaces import ICustomApplicantOnlinePayment
41
42ERROR_PART1 = (
43        'PayeeName=N/A~'
44        + 'Faculty=N/A~'
45        + 'Department=N/A~'
46        + 'Level=N/A~'
47        + 'ProgrammeType=N/A~'
48        + 'StudyType=N/A~'
49        + 'Session=N/A~'
50        + 'PayeeID=N/A~'
51        + 'Amount=N/A~'
52        + 'FeeStatus=')
53ERROR_PART2 = (
54        '~Semester=N/A~'
55        + 'PaymentType=N/A~'
56        + 'MatricNumber=N/A~'
57        + 'Email=N/A~'
58        + 'PhoneNumber=N/A')
59
60class CustomPaymentDataWebservice(PaymentDataWebservice):
61    """A simple webservice to publish payment and payer details on request from
62    accepted IP addresses without authentication.
63
64    Etranzact is asking for the PAYEE_ID which is indeed misleading.
65    These are not the data of the payee but of the payer. And it's
66    not the id of the payer but of the payment.
67    """
68    grok.name('feerequest')
69
70    #ACCEPTED_IP = ('195.219.3.181', '195.219.3.184')
71    ACCEPTED_IP = None
72
73    def update(self, PAYEE_ID=None, PAYMENT_TYPE=None):
74        if PAYEE_ID == None:
75            self.output = ERROR_PART1 + 'Missing PAYEE_ID' + ERROR_PART2
76            return
77        real_ip = self.request.get('HTTP_X_FORWARDED_FOR', None)
78        # We can forego the logging once eTranzact payments run smoothly
79        # and the accepted IP addresses are used.
80        if real_ip:
81            self.context.logger.info('PaymentDataWebservice called: %s' % real_ip)
82        if real_ip  and self.ACCEPTED_IP:
83            if real_ip not in  self.ACCEPTED_IP:
84                self.output = ERROR_PART1 + 'Wrong IP address' + ERROR_PART2
85                return
86        if PAYMENT_TYPE not in ('SCHOOL-FEE', 'ACCEPTANCE-FEE', 'APPLICATION-FEE'):
87            self.output = ERROR_PART1 + 'Invalid PAYMENT_TYPE' + ERROR_PART2
88            return
89
90        # It seems eTranzact sends a POST request with an empty body but the URL
91        # contains a query string. So it's actually a GET request pretended
92        # to be a POST request. Although this does not comply with the
93        # RFC 2616 HTTP guidelines we may try to fetch the id from the QUERY_STRING
94        # value of the request.
95        #if PAYEE_ID is None:
96        #    try:
97        #        PAYEE_ID = self.request['QUERY_STRING'].split('=')[1]
98        #    except:
99        #        self.output = '-4'
100        #        return
101
102        cat = getUtility(ICatalog, name='payments_catalog')
103        results = list(cat.searchResults(p_id=(PAYEE_ID, PAYEE_ID)))
104        if len(results) != 1:
105            self.output = ERROR_PART1 + 'Invalid PAYEE_ID' + ERROR_PART2
106            return
107        amount = results[0].amount_auth
108        payment_type = results[0].category
109        programme_type = results[0].p_item
110        academic_session = academic_sessions_vocab.getTerm(
111            results[0].p_session).title
112        status = results[0].p_state
113        if status == 'paid':
114            self.output = ERROR_PART1 + 'PAYEE_ID already used' + ERROR_PART2
115            return
116        if PAYMENT_TYPE == 'SCHOOL-FEE' \
117            and not results[0].p_category.startswith('schoolfee'):
118            self.output = ERROR_PART1 + 'Wrong PAYMENT_TYPE' + ERROR_PART2
119            return
120        if PAYMENT_TYPE == 'ACCEPTANCE-FEE' \
121            and not results[0].p_category == 'clearance':
122            self.output = ERROR_PART1 + 'Wrong PAYMENT_TYPE' + ERROR_PART2
123            return
124        if PAYMENT_TYPE == 'APPLICATION-FEE' \
125            and not results[0].p_category == 'application':
126            self.output = ERROR_PART1 + 'Wrong PAYMENT_TYPE' + ERROR_PART2
127            return
128        try:
129            owner = IPayer(results[0])
130            full_name = owner.display_fullname
131            matric_no = owner.id
132            faculty = owner.faculty
133            department = owner.department
134            study_type = owner.current_mode
135            email = owner.email
136            phone = owner.phone
137            level = owner.current_level
138        except (TypeError, AttributeError):
139            self.output = ERROR_PART1 +  'Unknown error' + ERROR_PART2
140            return
141        self.output = (
142            # Version 1
143            #'FULL_NAME=%s&' +
144            #'FACULTY=%s&' +
145            #'DEPARTMENT=%s&' +
146            #'RETURN_TYPE=%s&' +
147            #'PROGRAMME_TYPE=%s&' +
148            #'PAYMENT_TYPE=%s&' +
149            #'ACADEMIC_SESSION=%s&' +
150            #'MATRIC_NO=%s&' +
151            #'FEE_AMOUNT=%s&' +
152            #'TRANSACTION_STATUS=%s'
153
154            # Version 2
155            'PayeeName=%s~' +
156            'Faculty=%s~' +
157            'Department=%s~' +
158            'Level=%s~' +
159            'ProgrammeType=%s~' +
160            'StudyType=%s~' +
161            'Session=%s~' +
162            'PayeeID=%s~' +
163            'Amount=%s~' +
164            'FeeStatus=%s~' +
165            'Semester=N/A~' +
166            'PaymentType=%s~' +
167            'MatricNumber=%s~' +
168            'Email=%s~' +
169            'PhoneNumber=%s'
170
171            ) % (full_name, faculty,
172            department, level, programme_type, study_type,
173            academic_session, PAYEE_ID, amount, status, payment_type,
174            matric_no, email, phone)
175        return
176
177
178# Requerying eTranzact payments
179
180TERMINAL_ID = '0570000070'
181QUERY_URL =   'https://www.etranzact.net/WebConnectPlus/query.jsp'
182
183# Test environment
184#QUERY_URL =   'http://demo.etranzact.com:8080/WebConnect/queryPayoutletTransaction.jsp'
185#TERMINAL_ID = '5009892289'
186
187def query_etranzact(confirmation_number, payment):
188   
189    postdict = {}
190    postdict['TERMINAL_ID'] = TERMINAL_ID
191    #postdict['RESPONSE_URL'] = 'http://dummy'
192    postdict['CONFIRMATION_NO'] = confirmation_number
193    data = urllib.urlencode(postdict)
194    payment.conf_number = confirmation_number
195    try:
196        # eTranzact only accepts HTTP 1.1 requests. Therefore
197        # the urllib2 package is required here.
198        f = urllib2.urlopen(url=QUERY_URL, data=data)
199        success = f.read()
200        success = success.replace('\r\n','')
201        if 'CUSTOMER_ID' not in success:
202            msg = _('Invalid or unsuccessful callback: ${a}',
203                mapping = {'a': success})
204            log = 'invalid callback for payment %s: %s' % (payment.p_id, success)
205            payment.p_state = 'failed'
206            return False, msg, log
207        success = success.replace('%20',' ').split('&')
208        # We expect at least two parameters
209        if len(success) < 2:
210            msg = _('Invalid callback: ${a}', mapping = {'a': success})
211            log = 'invalid callback for payment %s: %s' % (payment.p_id, success)
212            payment.p_state = 'failed'
213            return False, msg, log
214        try:
215            success_dict = dict([tuple(i.split('=')) for i in success])
216        except ValueError:
217            msg = _('Invalid callback: ${a}', mapping = {'a': success})
218            log = 'invalid callback for payment %s: %s' % (payment.p_id, success)
219            payment.p_state = 'failed'
220            return False, msg, log
221    except IOError:
222        msg = _('eTranzact IOError')
223        log = 'eTranzact IOError'
224        return False, msg, log
225    payment.r_code = u'ET'
226    payment.r_company = u'etranzact'
227    payment.r_desc = u'%s' % success_dict.get('TRANS_DESCR')
228    payment.r_amount_approved = float(success_dict.get('TRANS_AMOUNT',0.0))
229    payment.r_card_num = None
230    payment.r_pay_reference = u'%s' % success_dict.get('RECEIPT_NO')
231    if payment.r_amount_approved != payment.amount_auth:
232        msg = _('Wrong amount')
233        log = 'wrong callback for payment %s: %s' % (payment.p_id, success)
234        payment.p_state = 'failed'
235        return False, msg, log
236    customer_id = success_dict.get('CUSTOMER_ID')
237    if payment.p_id != customer_id:
238        msg = _('Wrong payment id')
239        log = 'wrong callback for payment %s: %s' % (payment.p_id, success)
240        payment.p_state = 'failed'
241        return False, msg, log
242    log = 'valid callback for payment %s: %s' % (payment.p_id, success)
243    msg = _('Successful callback received')
244    payment.p_state = 'paid'
245    payment.payment_date = datetime.utcnow()
246    return True, msg, log
247
248class EtranzactEnterPinActionButtonApplicant(APABApplicant):
249    grok.context(ICustomApplicantOnlinePayment)
250    grok.require('waeup.payApplicant')
251    grok.order(3)
252    icon = 'actionicon_call.png'
253    text = _('Query eTranzact History')
254    target = 'enterpin'
255
256class EtranzactEnterPinActionButtonStudent(APABStudent):
257    grok.context(ICustomStudentOnlinePayment)
258    grok.require('waeup.payStudent')
259    grok.order(3)
260    icon = 'actionicon_call.png'
261    text = _('Query eTranzact History')
262    target = 'enterpin'
263
264class EtranzactEnterPinPageStudent(KofaPage):
265    """
266    """
267    grok.context(ICustomStudentOnlinePayment)
268    grok.name('enterpin')
269    grok.template('enterpin')
270    grok.require('waeup.payStudent')
271
272    buttonname = _('Submit to eTranzact')
273    label = _('Requery eTranzact History')
274    action = 'query_history'
275    placeholder = _('Confirmation Number (PIN)')
276
277    def update(self):
278        super(EtranzactEnterPinPageStudent, self).update()
279        if self.context.p_category != 'schoolfee':
280            return
281        student = self.context.student
282        for ticket in student['payments'].values():
283            if ticket.p_state == 'paid' and \
284                ticket.p_category == 'clearance':
285                return
286        self.flash(_('Please pay acceptance fee first.'), type="danger")
287        self.redirect(self.url(self.context, '@@index'))
288        return
289
290class EtranzactEnterPinPageApplicant(EtranzactEnterPinPageStudent):
291    """
292    """
293    grok.require('waeup.payApplicant')
294    grok.context(ICustomApplicantOnlinePayment)
295
296class EtranzactQueryHistoryPageStudent(UtilityView, grok.View):
297    """ Query history of eTranzact payments
298    """
299    grok.context(ICustomStudentOnlinePayment)
300    grok.name('query_history')
301    grok.require('waeup.payStudent')
302
303    def update(self, confirmation_number=None):
304        if self.context.p_state == 'paid':
305            self.flash(_('This ticket has already been paid.'))
306            return
307        student = self.context.student
308        success, msg, log = query_etranzact(confirmation_number,self.context)
309        student.writeLogMessage(self, log)
310        if not success:
311            self.flash(msg)
312            return
313        flashtype, msg, log = self.context.doAfterStudentPayment()
314        if log is not None:
315            student.writeLogMessage(self, log)
316        self.flash(msg, type=flashtype)
317        return
318
319    def render(self):
320        self.redirect(self.url(self.context, '@@index'))
321        return
322
323class EtranzactQueryHistoryPageApplicant(UtilityView, grok.View):
324    """ Query history of eTranzact payments
325    """
326    grok.context(ICustomApplicantOnlinePayment)
327    grok.name('query_history')
328    grok.require('waeup.payApplicant')
329
330    def update(self, confirmation_number=None):
331        ob_class = self.__implemented__.__name__
332        if self.context.p_state == 'paid':
333            self.flash(_('This ticket has already been paid.'))
334            return
335        applicant = self.context.__parent__
336        success, msg, log = query_etranzact(confirmation_number,self.context)
337        applicant.writeLogMessage(self, log)
338        if not success:
339            self.flash(msg)
340            return
341        flashtype, msg, log = self.context.doAfterApplicantPayment()
342        if log is not None:
343            applicant.writeLogMessage(self, log)
344        self.flash(msg, type=flashtype)
345        return
346
347    def render(self):
348        self.redirect(self.url(self.context, '@@index'))
349        return
350
351# Disable Interswitch viewlets. This could be avoided by defining the
352# action button viewlets of kofacustom.nigeria.interswitch.browser in the
353# context of INigeriaStudentOnlinePayment or INigeriaApplicantOnlinePayment
354# respectively. But then all interswitch.browser modules have to be extended.
355
356class InterswitchActionButtonStudent(InterswitchActionButtonStudent):
357
358    @property
359    def target_url(self):
360        return ''
361
362class InterswitchRequestWebserviceActionButtonStudent(
363    InterswitchRequestWebserviceActionButtonStudent):
364
365    @property
366    def target_url(self):
367        return ''
368
369class InterswitchActionButtonApplicant(InterswitchActionButtonApplicant):
370
371    @property
372    def target_url(self):
373        return ''
374
375class InterswitchRequestWebserviceActionButtonApplicant(
376    InterswitchRequestWebserviceActionButtonApplicant):
377
378    @property
379    def target_url(self):
380        return ''
Note: See TracBrowser for help on using the repository browser.