Camille Spiritus
e720cfe901
The only option to print a QR Invoice was to go on the invoice page and to click on the Print QR Button. This PR allows for a user to print multiple QR codes, selected from the Invoices view. The download occurs normally if all invoices are valid and QR-printable. A wizard opens when the whole invoice selection isn't valid. It allows to download the invoices as a single pdf or to see a list of the ones that could not be printed in the QR format. The wizard's text depends on the number of QR-valid, ISR-valid and classic (non QR, non ISR) invoices that the user tried to print. All invoices for which a print is asked will be printed with a QR bill if it is possible. If not, this will check if printing in the ISR format is possible. Lastly, if none is possible, the classic invoice will be printed. The behaviour allowed for the removal of the QR PRINT and ISR PRINT buttons on the single invoice view, for a behaviour closer to the original guidelines. Bills can't be QR printed. Corrected QR-Bill CSS. task-2726507 closes odoo/odoo#82341 Signed-off-by: Laurent Smet <las@odoo.com>
171 lines
9.0 KiB
Python
171 lines
9.0 KiB
Python
# -*- coding: utf-8 -*-
|
|
import base64
|
|
|
|
from odoo import api, models, fields, _
|
|
from odoo.exceptions import UserError
|
|
from odoo.tools.image import image_data_uri
|
|
|
|
import werkzeug
|
|
import werkzeug.exceptions
|
|
|
|
class ResPartnerBank(models.Model):
|
|
_inherit = 'res.partner.bank'
|
|
|
|
def _build_qr_code_vals(self, amount, free_communication, structured_communication, currency, debtor_partner, qr_method=None, silent_errors=True):
|
|
""" Returns the QR-code vals needed to generate the QR-code report link to pay this account with the given parameters,
|
|
or None if no QR-code could be generated.
|
|
|
|
:param amount: The amount to be paid
|
|
:param free_communication: Free communication to add to the payment when generating one with the QR-code
|
|
:param structured_communication: Structured communication to add to the payment when generating one with the QR-code
|
|
:param currency: The currency in which amount is expressed
|
|
:param debtor_partner: The partner to which this QR-code is aimed (so the one who will have to pay)
|
|
:param qr_method: The QR generation method to be used to make the QR-code. If None, the first one giving a result will be used.
|
|
:param silent_errors: If true, forbids errors to be raised if some tested QR-code format can't be generated because of incorrect data.
|
|
"""
|
|
if not self:
|
|
return None
|
|
|
|
self.ensure_one()
|
|
|
|
if not currency:
|
|
raise UserError(_("Currency must always be provided in order to generate a QR-code"))
|
|
|
|
available_qr_methods = self.get_available_qr_methods_in_sequence()
|
|
candidate_methods = qr_method and [(qr_method, dict(available_qr_methods)[qr_method])] or available_qr_methods
|
|
for candidate_method, candidate_name in candidate_methods:
|
|
if self._eligible_for_qr_code(candidate_method, debtor_partner, currency):
|
|
error_message = self._check_for_qr_code_errors(candidate_method, amount, currency, debtor_partner, free_communication, structured_communication)
|
|
|
|
if not error_message:
|
|
return {
|
|
'qr_method': candidate_method,
|
|
'amount': amount,
|
|
'currency': currency,
|
|
'debtor_partner': debtor_partner,
|
|
'free_communication': free_communication,
|
|
'structured_communication': structured_communication,
|
|
}
|
|
|
|
elif not silent_errors:
|
|
error_header = _("The following error prevented '%s' QR-code to be generated though it was detected as eligible: ", candidate_name)
|
|
raise UserError( error_header + error_message)
|
|
|
|
return None
|
|
|
|
def build_qr_code_url(self, amount, free_communication, structured_communication, currency, debtor_partner, qr_method=None, silent_errors=True):
|
|
vals = self._build_qr_code_vals(amount, free_communication, structured_communication, currency, debtor_partner, qr_method, silent_errors)
|
|
if vals:
|
|
return self._get_qr_code_url(
|
|
vals['qr_method'],
|
|
vals['amount'],
|
|
vals['currency'],
|
|
vals['debtor_partner'],
|
|
vals['free_communication'],
|
|
vals['structured_communication'],
|
|
)
|
|
return None
|
|
|
|
def build_qr_code_base64(self, amount, free_communication, structured_communication, currency, debtor_partner, qr_method=None, silent_errors=True):
|
|
vals = self._build_qr_code_vals(amount, free_communication, structured_communication, currency, debtor_partner, qr_method, silent_errors)
|
|
if vals:
|
|
return self._get_qr_code_base64(
|
|
vals['qr_method'],
|
|
vals['amount'],
|
|
vals['currency'],
|
|
vals['debtor_partner'],
|
|
vals['free_communication'],
|
|
vals['structured_communication']
|
|
)
|
|
return None
|
|
|
|
def _get_qr_vals(self, qr_method, amount, currency, debtor_partner, free_communication, structured_communication):
|
|
return None
|
|
|
|
def _get_qr_code_generation_params(self, qr_method, amount, currency, debtor_partner, free_communication, structured_communication):
|
|
return None
|
|
|
|
def _get_qr_code_url(self, qr_method, amount, currency, debtor_partner, free_communication, structured_communication):
|
|
""" Hook for extension, to support the different QR generation methods.
|
|
This function uses the provided qr_method to try generation a QR-code for
|
|
the given data. It it succeeds, it returns the report URL to make this
|
|
QR-code; else None.
|
|
|
|
:param qr_method: The QR generation method to be used to make the QR-code.
|
|
:param amount: The amount to be paid
|
|
:param currency: The currency in which amount is expressed
|
|
:param debtor_partner: The partner to which this QR-code is aimed (so the one who will have to pay)
|
|
:param free_communication: Free communication to add to the payment when generating one with the QR-code
|
|
:param structured_communication: Structured communication to add to the payment when generating one with the QR-code
|
|
"""
|
|
# pylint: disable=E1137
|
|
# (PyLint doesn't get that we are not assigning to None here)
|
|
params = self._get_qr_code_generation_params(qr_method, amount, currency, debtor_partner, free_communication, structured_communication)
|
|
if params:
|
|
params['type'] = params.pop('barcode_type')
|
|
return '/report/barcode/?' + werkzeug.urls.url_encode(params)
|
|
return None
|
|
|
|
def _get_qr_code_base64(self, qr_method, amount, currency, debtor_partner, free_communication, structured_communication):
|
|
""" Hook for extension, to support the different QR generation methods.
|
|
This function uses the provided qr_method to try generation a QR-code for
|
|
the given data. It it succeeds, it returns QR code in base64 url; else None.
|
|
|
|
:param qr_method: The QR generation method to be used to make the QR-code.
|
|
:param amount: The amount to be paid
|
|
:param currency: The currency in which amount is expressed
|
|
:param debtor_partner: The partner to which this QR-code is aimed (so the one who will have to pay)
|
|
:param free_communication: Free communication to add to the payment when generating one with the QR-code
|
|
:param structured_communication: Structured communication to add to the payment when generating one with the QR-code
|
|
"""
|
|
# pylint: disable=E1137
|
|
# pylint: disable=E1134
|
|
# (PyLint doesn't get that we are not assigning to None here)
|
|
params = self._get_qr_code_generation_params(qr_method, amount, currency, debtor_partner, free_communication, structured_communication)
|
|
if params:
|
|
try:
|
|
barcode = self.env['ir.actions.report'].barcode(**params)
|
|
except (ValueError, AttributeError):
|
|
raise werkzeug.exceptions.HTTPException(description='Cannot convert into barcode.')
|
|
return image_data_uri(base64.b64encode(barcode))
|
|
return None
|
|
|
|
@api.model
|
|
def _get_available_qr_methods(self):
|
|
""" Returns the QR-code generation methods that are available on this db,
|
|
in the form of a list of (code, name, sequence) elements, where
|
|
'code' is a unique string identifier, 'name' the name to display
|
|
to the user to designate the method, and 'sequence' is a positive integer
|
|
indicating the order in which those mehtods need to be checked, to avoid
|
|
shadowing between them (lower sequence means more prioritary).
|
|
"""
|
|
return []
|
|
|
|
@api.model
|
|
def get_available_qr_methods_in_sequence(self):
|
|
""" Same as _get_available_qr_methods but without returning the sequence,
|
|
and using it directly to order the returned list.
|
|
"""
|
|
all_available = self._get_available_qr_methods()
|
|
all_available.sort(key=lambda x: x[2])
|
|
return [(code, name) for (code, name, sequence) in all_available]
|
|
|
|
|
|
def _eligible_for_qr_code(self, qr_method, debtor_partner, currency, raises_error=True):
|
|
""" Tells whether or not the criteria to apply QR-generation
|
|
method qr_method are met for a payment on this account, in the
|
|
given currency, by debtor_partner. This does not impeach generation errors,
|
|
it only checks that this type of QR-code *should be* possible to generate.
|
|
Consistency of the required field needs then to be checked by _check_for_qr_code_errors().
|
|
"""
|
|
return False
|
|
|
|
def _check_for_qr_code_errors(self, qr_method, amount, currency, debtor_partner, free_communication, structured_communication):
|
|
""" Checks the data before generating a QR-code for the specified qr_method
|
|
(this method must have been checked for eligbility by _eligible_for_qr_code() first).
|
|
|
|
Returns None if no error was found, or a string describing the first error encountered
|
|
so that it can be reported to the user.
|
|
"""
|
|
return None
|