Gorash
880954ebfc
There were inconsistencies in the calls to `_render`. * the view context could contain information that misled developers. Indeed, the context and value of the view are not supposed to be found in the rendering. Thus by calling `ir.qweb` with the name of the template, we ensure that there is no unwanted information and in addition the cache key is that of the name of the template which saves a query. * the context used for rendering was modified by a method on `ir.ui.view`, except this is not information used by this model. There is now a `_prepare_environment` method residing on `ir.qweb`. This method allows to modify the value dictionary as well as the context in which the rendering will be done. This preparation of the data as well as my security check is done only once per rendering. This also saves some queries * Freeze options for rendering were inconsistent. It could be that options on which rendering depends were not part of the cache key. Thus, depending on the user who generated the generation of the rendering function, there was or was not information in the template. For example for automatic branding. This is no longer possible, because it is the context that is used. The options serving as a cache key are only recorded for information (for the profiling system for example). A simplification of the `ir.qweb.field` models could be made. The report rendering and call `ir.qweb` instead of `ir.ui.view`. Part-of: odoo/odoo#85110
296 lines
13 KiB
Python
296 lines
13 KiB
Python
# -*- coding: utf-8 -*-
|
|
import markupsafe
|
|
from PIL import Image
|
|
from markupsafe import Markup
|
|
|
|
from odoo import api, fields, models, tools
|
|
|
|
from odoo.addons.base.models.ir_qweb_fields import nl2br
|
|
from odoo.modules import get_resource_path
|
|
|
|
try:
|
|
import sass as libsass
|
|
except ImportError:
|
|
# If the `sass` python library isn't found, we fallback on the
|
|
# `sassc` executable in the path.
|
|
libsass = None
|
|
|
|
DEFAULT_PRIMARY = '#000000'
|
|
DEFAULT_SECONDARY = '#000000'
|
|
|
|
|
|
class BaseDocumentLayout(models.TransientModel):
|
|
"""
|
|
Customise the company document layout and display a live preview
|
|
"""
|
|
|
|
_name = 'base.document.layout'
|
|
_description = 'Company Document Layout'
|
|
|
|
@api.model
|
|
def _default_report_footer(self):
|
|
company = self.env.company
|
|
footer_fields = [field for field in [company.phone, company.email, company.website, company.vat] if isinstance(field, str) and len(field) > 0]
|
|
return Markup(' ').join(footer_fields)
|
|
|
|
@api.model
|
|
def _default_company_details(self):
|
|
company = self.env.company
|
|
address_format, company_data = company.partner_id._prepare_display_address()
|
|
# company_name may *still* be missing from prepared address in case commercial_company_name is falsy
|
|
if 'company_name' not in address_format:
|
|
address_format = '%(company_name)s\n' + address_format
|
|
company_data['company_name'] = company_data['company_name'] or company.name
|
|
return Markup(nl2br(address_format)) % company_data
|
|
|
|
company_id = fields.Many2one(
|
|
'res.company', default=lambda self: self.env.company, required=True)
|
|
|
|
logo = fields.Binary(related='company_id.logo', readonly=False)
|
|
preview_logo = fields.Binary(related='logo', string="Preview logo")
|
|
report_header = fields.Html(related='company_id.report_header', readonly=False)
|
|
report_footer = fields.Html(related='company_id.report_footer', readonly=False, default=_default_report_footer)
|
|
company_details = fields.Html(related='company_id.company_details', readonly=False, default=_default_company_details)
|
|
|
|
# The paper format changes won't be reflected in the preview.
|
|
paperformat_id = fields.Many2one(related='company_id.paperformat_id', readonly=False)
|
|
|
|
external_report_layout_id = fields.Many2one(related='company_id.external_report_layout_id', readonly=False)
|
|
|
|
font = fields.Selection(related='company_id.font', readonly=False)
|
|
primary_color = fields.Char(related='company_id.primary_color', readonly=False)
|
|
secondary_color = fields.Char(related='company_id.secondary_color', readonly=False)
|
|
|
|
custom_colors = fields.Boolean(compute="_compute_custom_colors", readonly=False)
|
|
logo_primary_color = fields.Char(compute="_compute_logo_colors")
|
|
logo_secondary_color = fields.Char(compute="_compute_logo_colors")
|
|
|
|
layout_background = fields.Selection(related='company_id.layout_background', readonly=False)
|
|
layout_background_image = fields.Binary(related='company_id.layout_background_image', readonly=False)
|
|
|
|
report_layout_id = fields.Many2one('report.layout')
|
|
|
|
# All the sanitization get disabled as we want true raw html to be passed to an iframe.
|
|
preview = fields.Html(compute='_compute_preview', sanitize=False)
|
|
|
|
# Those following fields are required as a company to create invoice report
|
|
partner_id = fields.Many2one(related='company_id.partner_id', readonly=True)
|
|
phone = fields.Char(related='company_id.phone', readonly=True)
|
|
email = fields.Char(related='company_id.email', readonly=True)
|
|
website = fields.Char(related='company_id.website', readonly=True)
|
|
vat = fields.Char(related='company_id.vat', readonly=True)
|
|
name = fields.Char(related='company_id.name', readonly=True)
|
|
country_id = fields.Many2one(related="company_id.country_id", readonly=True)
|
|
|
|
@api.depends('logo_primary_color', 'logo_secondary_color', 'primary_color', 'secondary_color',)
|
|
def _compute_custom_colors(self):
|
|
for wizard in self:
|
|
logo_primary = wizard.logo_primary_color or ''
|
|
logo_secondary = wizard.logo_secondary_color or ''
|
|
# Force lower case on color to ensure that FF01AA == ff01aa
|
|
wizard.custom_colors = (
|
|
wizard.logo and wizard.primary_color and wizard.secondary_color
|
|
and not(
|
|
wizard.primary_color.lower() == logo_primary.lower()
|
|
and wizard.secondary_color.lower() == logo_secondary.lower()
|
|
)
|
|
)
|
|
|
|
@api.depends('logo')
|
|
def _compute_logo_colors(self):
|
|
for wizard in self:
|
|
if wizard._context.get('bin_size'):
|
|
wizard_for_image = wizard.with_context(bin_size=False)
|
|
else:
|
|
wizard_for_image = wizard
|
|
wizard.logo_primary_color, wizard.logo_secondary_color = wizard.extract_image_primary_secondary_colors(wizard_for_image.logo)
|
|
|
|
@api.depends('report_layout_id', 'logo', 'font', 'primary_color', 'secondary_color', 'report_header', 'report_footer', 'layout_background', 'layout_background_image', 'company_details')
|
|
def _compute_preview(self):
|
|
""" compute a qweb based preview to display on the wizard """
|
|
styles = self._get_asset_style()
|
|
|
|
for wizard in self:
|
|
if wizard.report_layout_id:
|
|
# guarantees that bin_size is always set to False,
|
|
# so the logo always contains the bin data instead of the binary size
|
|
if wizard.env.context.get('bin_size'):
|
|
wizard_with_logo = wizard.with_context(bin_size=False)
|
|
else:
|
|
wizard_with_logo = wizard
|
|
preview_css = markupsafe.Markup(self._get_css_for_preview(styles, wizard_with_logo.id))
|
|
ir_ui_view = wizard_with_logo.env['ir.ui.view']
|
|
wizard.preview = ir_ui_view._render_template('web.report_invoice_wizard_preview', {'company': wizard_with_logo, 'preview_css': preview_css})
|
|
else:
|
|
wizard.preview = False
|
|
|
|
@api.onchange('company_id')
|
|
def _onchange_company_id(self):
|
|
for wizard in self:
|
|
wizard.logo = wizard.company_id.logo
|
|
wizard.report_header = wizard.company_id.report_header
|
|
# company_details and report_footer can store empty strings (set by the user) or false (meaning the user didn't set a value). Since both are falsy values, we use isinstance of string to differentiate them
|
|
wizard.report_footer = wizard.company_id.report_footer if isinstance(wizard.company_id.report_footer, str) else wizard.report_footer
|
|
wizard.company_details = wizard.company_id.company_details if isinstance(wizard.company_id.company_details, str) else wizard.company_details
|
|
wizard.paperformat_id = wizard.company_id.paperformat_id
|
|
wizard.external_report_layout_id = wizard.company_id.external_report_layout_id
|
|
wizard.font = wizard.company_id.font
|
|
wizard.primary_color = wizard.company_id.primary_color
|
|
wizard.secondary_color = wizard.company_id.secondary_color
|
|
wizard_layout = wizard.env["report.layout"].search([
|
|
('view_id.key', '=', wizard.company_id.external_report_layout_id.key)
|
|
])
|
|
wizard.report_layout_id = wizard_layout or wizard_layout.search([], limit=1)
|
|
|
|
if not wizard.primary_color:
|
|
wizard.primary_color = wizard.logo_primary_color or DEFAULT_PRIMARY
|
|
if not wizard.secondary_color:
|
|
wizard.secondary_color = wizard.logo_secondary_color or DEFAULT_SECONDARY
|
|
|
|
@api.onchange('custom_colors')
|
|
def _onchange_custom_colors(self):
|
|
for wizard in self:
|
|
if wizard.logo and not wizard.custom_colors:
|
|
wizard.primary_color = wizard.logo_primary_color or DEFAULT_PRIMARY
|
|
wizard.secondary_color = wizard.logo_secondary_color or DEFAULT_SECONDARY
|
|
|
|
@api.onchange('report_layout_id')
|
|
def _onchange_report_layout_id(self):
|
|
for wizard in self:
|
|
wizard.external_report_layout_id = wizard.report_layout_id.view_id
|
|
|
|
@api.onchange('logo')
|
|
def _onchange_logo(self):
|
|
for wizard in self:
|
|
# It is admitted that if the user puts the original image back, it won't change colors
|
|
company = wizard.company_id
|
|
# at that point wizard.logo has been assigned the value present in DB
|
|
if wizard.logo == company.logo and company.primary_color and company.secondary_color:
|
|
continue
|
|
|
|
if wizard.logo_primary_color:
|
|
wizard.primary_color = wizard.logo_primary_color
|
|
if wizard.logo_secondary_color:
|
|
wizard.secondary_color = wizard.logo_secondary_color
|
|
|
|
@api.model
|
|
def extract_image_primary_secondary_colors(self, logo, white_threshold=225, mitigate=175):
|
|
"""
|
|
Identifies dominant colors
|
|
|
|
First resizes the original image to improve performance, then discards
|
|
transparent colors and white-ish colors, then calls the averaging
|
|
method twice to evaluate both primary and secondary colors.
|
|
|
|
:param logo: logo to process
|
|
:param white_threshold: arbitrary value defining the maximum value a color can reach
|
|
:param mitigate: arbitrary value defining the maximum value a band can reach
|
|
|
|
:return colors: hex values of primary and secondary colors
|
|
"""
|
|
if not logo:
|
|
return False, False
|
|
# The "===" gives different base64 encoding a correct padding
|
|
logo += b'===' if type(logo) == bytes else '==='
|
|
try:
|
|
# Catches exceptions caused by logo not being an image
|
|
image = tools.image_fix_orientation(tools.base64_to_image(logo))
|
|
except Exception:
|
|
return False, False
|
|
|
|
base_w, base_h = image.size
|
|
w = int(50 * base_w / base_h)
|
|
h = 50
|
|
|
|
# Converts to RGBA (if already RGBA, this is a noop)
|
|
image_converted = image.convert('RGBA')
|
|
image_resized = image_converted.resize((w, h), resample=Image.NEAREST)
|
|
|
|
colors = []
|
|
for color in image_resized.getcolors(w * h):
|
|
if not(color[1][0] > white_threshold and
|
|
color[1][1] > white_threshold and
|
|
color[1][2] > white_threshold) and color[1][3] > 0:
|
|
colors.append(color)
|
|
|
|
if not colors: # May happen when the whole image is white
|
|
return False, False
|
|
primary, remaining = tools.average_dominant_color(colors, mitigate=mitigate)
|
|
secondary = tools.average_dominant_color(remaining, mitigate=mitigate)[0] if remaining else primary
|
|
|
|
# Lightness and saturation are calculated here.
|
|
# - If both colors have a similar lightness, the most colorful becomes primary
|
|
# - When the difference in lightness is too great, the brightest color becomes primary
|
|
l_primary = tools.get_lightness(primary)
|
|
l_secondary = tools.get_lightness(secondary)
|
|
if (l_primary < 0.2 and l_secondary < 0.2) or (l_primary >= 0.2 and l_secondary >= 0.2):
|
|
s_primary = tools.get_saturation(primary)
|
|
s_secondary = tools.get_saturation(secondary)
|
|
if s_primary < s_secondary:
|
|
primary, secondary = secondary, primary
|
|
elif l_secondary > l_primary:
|
|
primary, secondary = secondary, primary
|
|
|
|
return tools.rgb_to_hex(primary), tools.rgb_to_hex(secondary)
|
|
|
|
@api.model
|
|
def action_open_base_document_layout(self, action_ref=None):
|
|
if not action_ref:
|
|
action_ref = 'web.action_base_document_layout_configurator'
|
|
res = self.env["ir.actions.actions"]._for_xml_id(action_ref)
|
|
self.env[res["res_model"]].check_access_rights('write')
|
|
return res
|
|
|
|
def document_layout_save(self):
|
|
# meant to be overridden
|
|
return self.env.context.get('report_action') or {'type': 'ir.actions.act_window_close'}
|
|
|
|
def _get_asset_style(self):
|
|
"""
|
|
Compile the style template. It is a qweb template expecting company ids to generate all the code in one batch.
|
|
We give a useless company_ids arg, but provide the PREVIEW_ID arg that will prepare the template for
|
|
'_get_css_for_preview' processing later.
|
|
:return:
|
|
"""
|
|
company_styles = self.env['ir.qweb']._render('web.styles_company_report', {
|
|
'company_ids': self,
|
|
}, raise_if_not_found=False)
|
|
|
|
return company_styles
|
|
|
|
@api.model
|
|
def _get_css_for_preview(self, scss, new_id):
|
|
"""
|
|
Compile the scss into css.
|
|
"""
|
|
css_code = self._compile_scss(scss)
|
|
return css_code
|
|
|
|
@api.model
|
|
def _compile_scss(self, scss_source):
|
|
"""
|
|
This code will compile valid scss into css.
|
|
Parameters are the same from odoo/addons/base/models/assetsbundle.py
|
|
Simply copied and adapted slightly
|
|
"""
|
|
|
|
# No scss ? still valid, returns empty css
|
|
if not scss_source.strip():
|
|
return ""
|
|
|
|
precision = 8
|
|
output_style = 'expanded'
|
|
bootstrap_path = get_resource_path('web', 'static', 'lib', 'bootstrap', 'scss')
|
|
|
|
try:
|
|
return libsass.compile(
|
|
string=scss_source,
|
|
include_paths=[
|
|
bootstrap_path,
|
|
],
|
|
output_style=output_style,
|
|
precision=precision,
|
|
)
|
|
except libsass.CompileError as e:
|
|
raise libsass.CompileError(e.args[0])
|