# Part of Odoo. See LICENSE file for full copyright and licensing details. # Original Copyright 2015 Eezee-It, modified and maintained by Odoo. import json import logging from werkzeug import urls from odoo import _, api, models from odoo.exceptions import ValidationError from odoo.addons.payment import utils as payment_utils from odoo.addons.payment_sips.const import RESPONSE_CODES_MAPPING, SUPPORTED_CURRENCIES from odoo.addons.payment_sips.controllers.main import SipsController _logger = logging.getLogger(__name__) class PaymentTransaction(models.Model): _inherit = 'payment.transaction' @api.model def _compute_reference(self, provider_code, prefix=None, separator='-', **kwargs): """ Override of payment to ensure that Sips requirements for references are satisfied. Sips requirements for transaction are as follows: - References can only be made of alphanumeric characters. This is satisfied by forcing the custom separator to 'x' to ensure that no '-' character will be used to append a suffix. Additionally, the prefix is sanitized if it was provided, and generated with 'tx' as default otherwise. This prevents the prefix to be generated based on document names that may contain non-alphanum characters (eg: INV/2020/...). - References must be unique at provider level for a given merchant account. This is satisfied by singularizing the prefix with the current datetime. If two transactions are created simultaneously, `_compute_reference` ensures the uniqueness of references by suffixing a sequence number. :param str provider_code: The code of the provider handling the transaction :param str prefix: The custom prefix used to compute the full reference :param str separator: The custom separator used to separate the prefix from the suffix :return: The unique reference for the transaction :rtype: str """ if provider_code == 'sips': # We use an empty separator for cosmetic reasons: As the default prefix is 'tx', we want # the singularized prefix to look like 'tx2020...' and not 'txx2020...'. prefix = payment_utils.singularize_reference_prefix(separator='') separator = 'x' # Still, we need a dedicated separator between the prefix and the seq. return super()._compute_reference(provider_code, prefix=prefix, separator=separator, **kwargs) def _get_specific_rendering_values(self, processing_values): """ Override of payment to return Sips-specific rendering values. Note: self.ensure_one() from `_get_processing_values` :param dict processing_values: The generic and specific processing values of the transaction :return: The dict of provider-specific processing values :rtype: dict """ res = super()._get_specific_rendering_values(processing_values) if self.provider_code != 'sips': return res base_url = self.get_base_url() data = { 'amount': payment_utils.to_minor_currency_units(self.amount, self.currency_id), 'currencyCode': SUPPORTED_CURRENCIES[self.currency_id.name], # The ISO 4217 code 'merchantId': self.provider_id.sips_merchant_id, 'normalReturnUrl': urls.url_join(base_url, SipsController._return_url), 'automaticResponseUrl': urls.url_join(base_url, SipsController._webhook_url), 'transactionReference': self.reference, 'statementReference': self.reference, 'keyVersion': self.provider_id.sips_key_version, 'returnContext': json.dumps(dict(reference=self.reference)), } api_url = self.provider_id.sips_prod_url if self.provider_id.state == 'enabled' \ else self.provider_id.sips_test_url data = '|'.join([f'{k}={v}' for k, v in data.items()]) return { 'api_url': api_url, 'Data': data, 'InterfaceVersion': self.provider_id.sips_version, 'Seal': self.provider_id._sips_generate_shasign(data), } def _get_tx_from_notification_data(self, provider_code, notification_data): """ Override of payment to find the transaction based on Sips data. :param str provider_code: The code of the provider that handled the transaction :param dict notification_data: The notification data sent by the provider :return: The transaction if found :rtype: recordset of `payment.transaction` :raise: ValidationError if the data match no transaction """ tx = super()._get_tx_from_notification_data(provider_code, notification_data) if provider_code != 'sips' or len(tx) == 1: return tx data = self._sips_notification_data_to_object(notification_data['Data']) reference = data.get('transactionReference') if not reference: return_context = json.loads(data.get('returnContext', '{}')) reference = return_context.get('reference') tx = self.search([('reference', '=', reference), ('provider_code', '=', 'sips')]) if not tx: raise ValidationError( "Sips: " + _("No transaction found matching reference %s.", reference) ) return tx def _process_notification_data(self, notification_data): """ Override of payment to process the transaction based on Sips data. Note: self.ensure_one() :param dict notification_data: The notification data sent by the provider :return: None """ super()._process_notification_data(notification_data) if self.provider_code != 'sips': return data = self._sips_notification_data_to_object(notification_data.get('Data')) # Update the provider reference. self.provider_reference = data.get('transactionReference') # Update the payment method. payment_method_type = notification_data.get('paymentMeanBrand', '').lower() payment_method = self.env['payment.method']._get_from_code(payment_method_type) self.payment_method_id = payment_method or self.payment_method_id # Update the payment state. response_code = data.get('responseCode') if response_code in RESPONSE_CODES_MAPPING['pending']: status = "pending" self._set_pending() elif response_code in RESPONSE_CODES_MAPPING['done']: status = "done" self._set_done() elif response_code in RESPONSE_CODES_MAPPING['cancel']: status = "cancel" self._set_canceled() else: status = "error" self._set_error(_("Unrecognized response received from the payment provider.")) _logger.info( "received data with response %(response)s for transaction with reference %(ref)s, set " "status as '%(status)s'", { 'response': response_code, 'ref': self.reference, 'status': status, }, ) def _sips_notification_data_to_object(self, data): res = {} for element in data.split('|'): key, value = element.split('=', 1) res[key] = value return res