Toufik Benjaa
6ed44181d0
This commit aims to improve the user experience when using payment acquirers. There currently are no error feedback with some acquirers, which leaves the user wondering what is going on and what is the real status of its payment. In some cases, the user is currently being redirected to the home page even though the payment has failed. We want to make it more obvious to the user that something unexpected has happened by redirecting to an intermediate page that will provide good feedback on payments status. Another goal of this commit is to order acquirers by sequence instead of by flow and to select the first acquirer by default. This feature was already implmented in commit fe294fd43e521bd2d339e962f43acf46c3d4cb97, some UI adaptations were needed though. Related to task #36680 Closes #26958
114 lines
4.9 KiB
Python
114 lines
4.9 KiB
Python
# -*- coding: utf-8 -*-
|
|
|
|
import json
|
|
import logging
|
|
import pprint
|
|
|
|
import requests
|
|
import werkzeug
|
|
from werkzeug import urls
|
|
|
|
from odoo import http
|
|
from odoo.addons.payment.models.payment_acquirer import ValidationError
|
|
from odoo.http import request
|
|
|
|
_logger = logging.getLogger(__name__)
|
|
|
|
|
|
class PaypalController(http.Controller):
|
|
_notify_url = '/payment/paypal/ipn/'
|
|
_return_url = '/payment/paypal/dpn/'
|
|
_cancel_url = '/payment/paypal/cancel/'
|
|
|
|
def _parse_pdt_response(self, response):
|
|
""" Parse a text response for a PDT verification.
|
|
|
|
:param str response: text response, structured in the following way:
|
|
STATUS\nkey1=value1\nkey2=value2...\n
|
|
or STATUS\nError message...\n
|
|
:rtype tuple(str, dict)
|
|
:return: tuple containing the STATUS str and the key/value pairs
|
|
parsed as a dict
|
|
"""
|
|
lines = [line for line in response.split('\n') if line]
|
|
status = lines.pop(0)
|
|
|
|
pdt_post = {}
|
|
for line in lines:
|
|
split = line.split('=', 1)
|
|
if len(split) == 2:
|
|
pdt_post[split[0]] = urls.url_unquote_plus(split[1])
|
|
else:
|
|
_logger.warning('Paypal: error processing pdt response: %s', line)
|
|
|
|
return status, pdt_post
|
|
|
|
def paypal_validate_data(self, **post):
|
|
""" Paypal IPN: three steps validation to ensure data correctness
|
|
|
|
- step 1: return an empty HTTP 200 response -> will be done at the end
|
|
by returning ''
|
|
- step 2: POST the complete, unaltered message back to Paypal (preceded
|
|
by cmd=_notify-validate or _notify-synch for PDT), with same encoding
|
|
- step 3: paypal send either VERIFIED or INVALID (single word) for IPN
|
|
or SUCCESS or FAIL (+ data) for PDT
|
|
|
|
Once data is validated, process it. """
|
|
res = False
|
|
post['cmd'] = '_notify-validate'
|
|
reference = post.get('item_number')
|
|
tx = None
|
|
if reference:
|
|
tx = request.env['payment.transaction'].search([('reference', '=', reference)])
|
|
paypal_urls = request.env['payment.acquirer']._get_paypal_urls(tx and tx.acquirer_id.environment or 'prod')
|
|
pdt_request = bool(post.get('amt')) # check for spefific pdt param
|
|
if pdt_request:
|
|
# this means we are in PDT instead of DPN like before
|
|
# fetch the PDT token
|
|
post['at'] = tx and tx.acquirer_id.paypal_pdt_token or ''
|
|
post['cmd'] = '_notify-synch' # command is different in PDT than IPN/DPN
|
|
validate_url = paypal_urls['paypal_form_url']
|
|
urequest = requests.post(validate_url, post)
|
|
urequest.raise_for_status()
|
|
resp = urequest.text
|
|
if pdt_request:
|
|
resp, post = self._parse_pdt_response(resp)
|
|
if resp in ['VERIFIED', 'SUCCESS']:
|
|
_logger.info('Paypal: validated data')
|
|
res = request.env['payment.transaction'].sudo().form_feedback(post, 'paypal')
|
|
if not res:
|
|
tx.sudo()._set_transaction_error('Validation error occured. Please contact your administrator.')
|
|
elif resp in ['INVALID', 'FAIL']:
|
|
_logger.warning('Paypal: answered INVALID/FAIL on data verification')
|
|
tx.sudo()._set_transaction_error('Invalid response from Paypal. Please contact your administrator.')
|
|
else:
|
|
_logger.warning('Paypal: unrecognized paypal answer, received %s instead of VERIFIED/SUCCESS or INVALID/FAIL (validation: %s)' % (resp, 'PDT' if pdt_request else 'IPN/DPN'))
|
|
tx.sudo()._set_transaction_error('Unrecognized error from Paypal. Please contact your administrator.')
|
|
return res
|
|
|
|
@http.route('/payment/paypal/ipn/', type='http', auth='none', methods=['POST'], csrf=False)
|
|
def paypal_ipn(self, **post):
|
|
""" Paypal IPN. """
|
|
_logger.info('Beginning Paypal IPN form_feedback with post data %s', pprint.pformat(post)) # debug
|
|
try:
|
|
self.paypal_validate_data(**post)
|
|
except ValidationError:
|
|
_logger.exception('Unable to validate the Paypal payment')
|
|
return ''
|
|
|
|
@http.route('/payment/paypal/dpn', type='http', auth="none", methods=['POST', 'GET'], csrf=False)
|
|
def paypal_dpn(self, **post):
|
|
""" Paypal DPN """
|
|
_logger.info('Beginning Paypal DPN form_feedback with post data %s', pprint.pformat(post)) # debug
|
|
try:
|
|
res = self.paypal_validate_data(**post)
|
|
except ValidationError:
|
|
_logger.exception('Unable to validate the Paypal payment')
|
|
return werkzeug.utils.redirect('/payment/process')
|
|
|
|
@http.route('/payment/paypal/cancel', type='http', auth="none", csrf=False)
|
|
def paypal_cancel(self, **post):
|
|
""" When the user cancels its Paypal payment: GET on this route """
|
|
_logger.info('Beginning Paypal cancel with post data %s', pprint.pformat(post)) # debug
|
|
return werkzeug.utils.redirect('/payment/process')
|