%s
' % (help) return super(SaleOrder, self).get_empty_list_help(help) + def _get_default_access_token(self): + return str(uuid.uuid4()) + @api.model def _default_note(self): return self.env.user.company_id.sale_note @@ -110,6 +115,9 @@ class SaleOrder(models.Model): name = fields.Char(string='Order Reference', required=True, copy=False, readonly=True, states={'draft': [('readonly', False)]}, index=True, default=lambda self: _('New')) origin = fields.Char(string='Source Document', help="Reference of the document that generated this sales order request.") client_order_ref = fields.Char(string='Customer Reference', copy=False) + access_token = fields.Char( + 'Security Token', copy=False, + default=_get_default_access_token) state = fields.Selection([ ('draft', 'Quotation'), @@ -279,6 +287,20 @@ class SaleOrder(models.Model): default['order_line'] = [(0, 0, line.copy_data()[0]) for line in self.order_line.filtered(lambda l: not l.is_downpayment)] return super(SaleOrder, self).copy_data(default) + @api.model_cr_context + def _init_column(self, column_name): + """ Initialize the value of the given column for existing rows. + Overridden here because we skip generating unique access tokens + for potentially tons of existing sale orders, should they be needed, + they will be generated on the fly. + """ + if column_name != 'access_token': + super(SaleOrder, self)._init_column(column_name) + + def _generate_access_token(self): + for order in self: + order.access_token = self._get_default_access_token() + @api.multi def _prepare_invoice(self): """ diff --git a/addons/sale_payment/__init__.py b/addons/sale_payment/__init__.py new file mode 100644 index 00000000000..e9917144f69 --- /dev/null +++ b/addons/sale_payment/__init__.py @@ -0,0 +1,4 @@ +# -*- coding: utf-8 -*- +# Part of Odoo. See LICENSE file for full copyright and licensing details. + +from . import models \ No newline at end of file diff --git a/addons/sale_payment/__manifest__.py b/addons/sale_payment/__manifest__.py new file mode 100644 index 00000000000..6c1caaef606 --- /dev/null +++ b/addons/sale_payment/__manifest__.py @@ -0,0 +1,23 @@ +# -*- coding: utf-8 -*- + +{ + 'name': 'Payment - Sale', + 'category': 'Sales', + 'summary': 'Link Sales and Payment', + 'version': '1.0', + 'description': """Link Sales and Payment + +Provide tools for sale-related payment + + * specific management of transactions like sale order confirmation + * tools method to handle transactions when allowing to pay / sell + * JS code to handle a payment form (eCommerce + * add payment-related fields on SO +""", + 'depends': ['payment', 'sale'], + 'data': [ + 'views/payment_views.xml', + ], + 'installable': True, + 'auto_install': False, +} diff --git a/addons/sale_payment/models/__init__.py b/addons/sale_payment/models/__init__.py new file mode 100644 index 00000000000..51af63e66bb --- /dev/null +++ b/addons/sale_payment/models/__init__.py @@ -0,0 +1,5 @@ +# -*- coding: utf-8 -*- +# Part of Odoo. See LICENSE file for full copyright and licensing details. + +from . import payment +from . import sale_order \ No newline at end of file diff --git a/addons/sale_payment/models/payment.py b/addons/sale_payment/models/payment.py new file mode 100644 index 00000000000..8553672a71e --- /dev/null +++ b/addons/sale_payment/models/payment.py @@ -0,0 +1,185 @@ +# -*- coding: utf-8 -*- +# Part of Odoo. See LICENSE file for full copyright and licensing details. +import logging + +from odoo import api, fields, models, _ +from odoo.tools import float_compare + +_logger = logging.getLogger(__name__) + + +class PaymentTransaction(models.Model): + _inherit = 'payment.transaction' + + # link with the sales order + # YTI FIXME: The auto_join seems useless + sale_order_id = fields.Many2one('sale.order', string='Sales Order', auto_join=True) + + # -------------------------------------------------- + # Sale management + # -------------------------------------------------- + + @api.model + def form_feedback(self, data, acquirer_name): + """ Override to confirm the sales order, if defined, and if the transaction + is done. """ + tx = None + res = super(PaymentTransaction, self).form_feedback(data, acquirer_name) + + # fetch the tx + tx_find_method_name = '_%s_form_get_tx_from_data' % acquirer_name + if hasattr(self, tx_find_method_name): + tx = getattr(self, tx_find_method_name)(data) + _logger.info('<%s> transaction processed: tx ref:%s, tx amount: %s', acquirer_name, tx.reference if tx else 'n/a', tx.amount if tx else 'n/a') + + if tx: + # Auto-confirm SO if necessary + tx._confirm_so() + + return res + + def _confirm_so(self): + for tx in self: + # check tx state, confirm the potential SO + if not tx.sale_order_id or tx.sale_order_id.state not in ['draft', 'sent']: + # _logger.warning('<%s> transaction incorrect sale order %s (ID %s, state %s)', tx.acquirer_id.provider, tx.sale_order_id.name, tx.sale_order_id.id, tx.sale_order_id.state) + continue + if not float_compare(tx.amount, tx.sale_order_id.amount_total, 2) == 0: + _logger.warning('<%s> transaction MISMATCH for order %s (ID %s)', tx.acquirer_id.provider, tx.sale_order_id.name, tx.sale_order_id.id) + continue + try: + if tx.state == 'authorized' and tx.acquirer_id.capture_manually: + _logger.info('<%s> transaction authorized, auto-confirming order %s (ID %s)', tx.acquirer_id.provider, tx.sale_order_id.name, tx.sale_order_id.id) + tx.sale_order_id.with_context(send_email=True).action_confirm() + + if tx.state == 'done': + _logger.info('<%s> transaction completed, auto-confirming order %s (ID %s)', tx.acquirer_id.provider, tx.sale_order_id.name, tx.sale_order_id.id) + tx.sale_order_id.with_context(send_email=True).action_confirm() + tx._generate_and_pay_invoice() + elif tx.state not in ['cancel', 'error'] and tx.sale_order_id.state == 'draft': + _logger.info('<%s> transaction pending/to confirm manually, sending quote email for order %s (ID %s)', tx.acquirer_id.provider, tx.sale_order_id.name, tx.sale_order_id.id) + tx.sale_order_id.force_quotation_send() + else: + _logger.warning('<%s> transaction MISMATCH for order %s (ID %s)', tx.acquirer_id.provider, tx.sale_order_id.name, tx.sale_order_id.id) + except Exception: + _logger.exception('Fail to confirm the order or send the confirmation email%s', tx and ' for the transaction %s' % tx.reference or '') + + def _generate_and_pay_invoice(self): + self.sale_order_id._force_lines_to_invoice_policy_order() + + # force company to ensure journals/accounts etc. are correct + # company_id needed for default_get on account.journal + # force_company needed for company_dependent fields + ctx_company = {'company_id': self.sale_order_id.company_id.id, + 'force_company': self.sale_order_id.company_id.id} + created_invoice = self.sale_order_id.with_context(**ctx_company).action_invoice_create() + created_invoice = self.env['account.invoice'].browse(created_invoice).with_context(**ctx_company) + + if created_invoice: + _logger.info('<%s> transaction completed, auto-generated invoice %s (ID %s) for %s (ID %s)', + self.acquirer_id.provider, created_invoice.name, created_invoice.id, self.sale_order_id.name, self.sale_order_id.id) + + created_invoice.action_invoice_open() + if not self.acquirer_id.journal_id: + default_journal = self.env['account.journal'].search([('type', '=', 'bank')], limit=1) + if not default_journal: + _logger.warning('<%s> transaction completed, could not auto-generate payment for %s (ID %s) (no journal set on acquirer)', + self.acquirer_id.provider, self.sale_order_id.name, self.sale_order_id.id) + self.acquirer_id.journal_id = default_journal + created_invoice.pay_and_reconcile(self.acquirer_id.journal_id, pay_amount=created_invoice.amount_total) + if created_invoice.payment_ids: + created_invoice.payment_ids[0].payment_transaction_id = self + else: + _logger.warning('<%s> transaction completed, could not auto-generate invoice for %s (ID %s)', + self.acquirer_id.provider, self.sale_order_id.name, self.sale_order_id.id) + + # -------------------------------------------------- + # Tools for payment + # -------------------------------------------------- + + def confirm_sale_token(self): + """ Confirm a transaction token and call SO confirmation if it is a success. + + :return: True if success; error string otherwise """ + self.ensure_one() + if self.payment_token_id and self.partner_id == self.sale_order_id.partner_id: + try: + s2s_result = self.s2s_do_transaction() + except Exception as e: + _logger.warning(_("Payment transaction (%s) failed : <%s>") % (self.id, str(e))) + return _("Payment transaction failed (Contact Administrator)") + + valid_state = 'authorized' if self.acquirer_id.capture_manually else 'done' + if not s2s_result or self.state != valid_state: + return _("Payment transaction failed (%s)" % self.state_message) + try: + # Auto-confirm SO if necessary + self._confirm_so() + return True + except Exception as e: + _logger.warning(_("Payment transaction (%s) failed : <%s>") % (self.id, str(e))) + return _("Payment transaction / SO Confirmation failed (Contact Administrator)") + return _('Tx missmatch') + + def check_or_create_sale_tx(self, order, acquirer, payment_token=None, tx_type='form', add_tx_values=None, reset_draft=True): + tx = self + # incorrect state or unexisting tx + if not self or self.state in ['error', 'cancel']: + tx = False + # unmatching + if (self and acquirer and self.acquirer_id != acquirer) or (self and self.sale_order_id != order): + tx = False + # new or distinct token + if payment_token and tx.payment_token_id and payment_token != self.payment_token_id: + tx = False + + # still draft tx, no more info -> rewrite on tx or create a new one depending on parameter + if tx and tx.state == 'draft': + if reset_draft: + tx.write(dict( + self.on_change_partner_id(order.partner_id.id).get('value', {}), + amount=order.amount_total, + type=tx_type) + ) + else: + tx = False + + if not tx: + tx_values = { + 'acquirer_id': acquirer.id, + 'type': tx_type, + 'amount': order.amount_total, + 'currency_id': order.pricelist_id.currency_id.id, + 'partner_id': order.partner_id.id, + 'partner_country_id': order.partner_id.country_id.id, + 'reference': self.get_next_reference(order.name), + 'sale_order_id': order.id, + } + if add_tx_values: + tx_values.update(add_tx_values) + if payment_token and payment_token.sudo().partner_id == order.partner_id: + tx_values['payment_token_id'] = payment_token.id + + tx = self.create(tx_values) + + # update quotation + order.write({ + 'payment_tx_id': tx.id, + }) + + return tx + + def render_sale_button(self, order, return_url, submit_txt=None, render_values=None): + values = { + 'return_url': return_url, + 'partner_id': order.partner_shipping_id.id or order.partner_invoice_id.id, + 'billing_partner_id': order.partner_invoice_id.id, + } + if render_values: + values.update(render_values) + return self.acquirer_id.with_context(submit_class='btn btn-primary', submit_txt=submit_txt or _('Pay Now')).sudo().render( + self.reference, + order.amount_total, + order.pricelist_id.currency_id.id, + values=values, + ) diff --git a/addons/sale_payment/models/sale_order.py b/addons/sale_payment/models/sale_order.py new file mode 100644 index 00000000000..9c590529302 --- /dev/null +++ b/addons/sale_payment/models/sale_order.py @@ -0,0 +1,11 @@ +# -*- coding: utf-8 -*- +# Part of Odoo. See LICENSE file for full copyright and licensing details. + +from odoo import fields, models + + +class SaleOrder(models.Model): + _inherit = 'sale.order' + + payment_tx_id = fields.Many2one('payment.transaction', string='Last Transaction', copy=False) + payment_acquirer_id = fields.Many2one('payment.acquirer', string='Payment Acquirer', related='payment_tx_id.acquirer_id', store=True) diff --git a/addons/sale_payment/views/payment_views.xml b/addons/sale_payment/views/payment_views.xml new file mode 100644 index 00000000000..939089fbf74 --- /dev/null +++ b/addons/sale_payment/views/payment_views.xml @@ -0,0 +1,18 @@ + +There are currently no invoices and payments for your account.
+| Invoice # | +Invoice Date | +Due Date | ++ | + | Amount Due | +
|---|---|---|---|---|---|
|
+ |
+ + | + |
+ |
+ + Pay Now + | ++ |
There are currently no invoices and payments for your account.
-| Invoice # | -Invoice Date | -Due Date | -- | - | Amount Due | -
|---|---|---|---|---|---|
|
- |
- - | - |
- |
- - Pay Now - | -- |