diff options
| author | Lucas Perais (lpe) <lpe@odoo.com> | 2020-01-31 13:33:02 +0000 |
|---|---|---|
| committer | Lucas Perais (lpe) <lpe@odoo.com> | 2020-03-02 13:22:09 +0000 |
| commit | 9ce6136be700ae426b8910efd2357d16e2f49d7d (patch) | |
| tree | 03a937506785ef775c306e857befcec77c2df108 /addons/web | |
| parent | 5c127860fc111577aa68207bdcec27b3bde6f39e (diff) | |
[FIX] web, base: make company-specific report assets static
Before this commit, the company specific colors and font were
implemented by systematically overwriting a "virtual" report SCSS
asset file before rendering each report.
This caused many issues, forced frequent asset bundles recomputations
(performance problem + cache invalidation causing random bugs).
And it could simply not work in a multi-company setup where multiple
styles are involved, as the asset management could be made not
thread-safe.
PR #44225 was a first attempt to mitigate the numerous problems by
making the asset bundle invalidation less frequent. But the problems
were still present and a more complete solution was necessary for
multi-company setups.
Besides, the design of the bundle forbade making company specific assets.
This commit uses a different approach: instead of having a
company-specific asset that needs to be constantly updated, a global
"multi-company" asset is maintained and included in the report assets.
It only needs to be generated when a company style changes, not for
every rendering operation.
Unfortunately this change cannot be fully performed without updating the
template declarations, so it will require an update of the `web` (or
`base`) module to be operational.
As this represents a rather invasive change in a stable branch, extensive
testing was conducted to minimize the effects and ensure proper
degradation of features for production deployments where the new code
would be deployed without forcing an update of the `web` module:
- The report SCSS files were left untouched, to prevent any bundle
invalidation, ensuring that old cached assets would remain valid. This
means that single-company setups should not see any visible difference
after pulling the code (with or without updating `web`).
SCSS cleanup will be done later.
- Existing Python methods were kept but emptied, to make sure that
old templates and code would not crash.
- For multi-companies, the last used colors will be applied for all
reports until the `web` module is updated. The old behavior was not
working correctly anyways, so the degradation is actually limited.
- For all setups, changing the colors after deploying this patch will
have no effect unless the `web` module is updated.
/UPDATED FOR master on top of #44393/:
- removed the `res_company.update_scss()` method entirely
- fixed the report SCSS styles, as the variable names referred to the old
behavior, e.g. "$o-company-primary-color" is nonsense.
Renamed to "$o-default-report-primary-color" etc.
--
Improves #44225
Forward of #44393
opw-2168623
opw-2171040
closes odoo/odoo#46647
X-original-commit: a5b1421aecf27b1de408434d3bb6d7ac81f57dc3
Signed-off-by: Olivier Dony (odo) <odo@openerp.com>
Diffstat (limited to 'addons/web')
| -rw-r--r-- | addons/web/data/report_layout.xml | 7 | ||||
| -rw-r--r-- | addons/web/models/models.py | 39 | ||||
| -rw-r--r-- | addons/web/static/src/scss/layout_background.scss | 16 | ||||
| -rw-r--r-- | addons/web/static/src/scss/layout_boxed.scss | 16 | ||||
| -rw-r--r-- | addons/web/static/src/scss/layout_clean.scss | 20 | ||||
| -rw-r--r-- | addons/web/static/src/scss/layout_standard.scss | 8 | ||||
| -rw-r--r-- | addons/web/static/src/scss/report.scss | 8 | ||||
| -rw-r--r-- | addons/web/views/report_templates.xml | 172 |
8 files changed, 235 insertions, 51 deletions
diff --git a/addons/web/data/report_layout.xml b/addons/web/data/report_layout.xml index fbfbfbc21ea..d2abe98c214 100644 --- a/addons/web/data/report_layout.xml +++ b/addons/web/data/report_layout.xml @@ -25,5 +25,12 @@ <field name="image">/web/static/img/preview_clean.png</field> <field name="pdf">/web/static/pdf/preview_clean.pdf</field> </record> + <record id="asset_styles_company_report" model="ir.attachment"> + <field name="datas" model="res.company" eval="obj()._get_asset_style_b64()"/> + <field name="mimetype">text/scss</field> + <field name="name">res.company.scss</field> + <field name="type">binary</field> + <field name="url">/web/static/src/scss/asset_styles_company_report.scss</field> + </record> </data> </odoo> diff --git a/addons/web/models/models.py b/addons/web/models/models.py index 3a70ab4f0c8..7f6e83554e3 100644 --- a/addons/web/models/models.py +++ b/addons/web/models/models.py @@ -2,6 +2,7 @@ import babel.dates import pytz from lxml import etree +import base64 from odoo import _, api, fields, models from odoo.osv.expression import AND @@ -360,3 +361,41 @@ class Base(models.AbstractModel): }) return filter_values + + +class ResCompany(models.Model): + _inherit = 'res.company' + + @api.model + def create(self, values): + res = super().create(values) + if 'primary_color' in values or 'secondary_color' in values or 'font' in values: + self._update_asset_style() + return res + + def write(self, values): + res = super().write(values) + if 'primary_color' in values or 'secondary_color' in values or 'font' in values: + self._update_asset_style() + return res + + def _get_asset_style_b64(self): + template_style = self.env.ref('web.styles_company_report', raise_if_not_found=False) + if not template_style: + return '' + # One bundle for everyone, so this method + # necessarily updates the style for every company at once + company_ids = self.sudo().search([]) + company_styles = template_style.render({ + 'company_ids': company_ids, + }) + return base64.b64encode((company_styles)) + + def _update_asset_style(self): + asset_attachment = self.env.ref('web.asset_styles_company_report', raise_if_not_found=False) + if not asset_attachment: + return + asset_attachment = asset_attachment.sudo() + b64_val = self._get_asset_style_b64() + if b64_val != asset_attachment.datas: + asset_attachment.write({'datas': b64_val}) diff --git a/addons/web/static/src/scss/layout_background.scss b/addons/web/static/src/scss/layout_background.scss index 12dc0f109dc..0fea6d0a764 100644 --- a/addons/web/static/src/scss/layout_background.scss +++ b/addons/web/static/src/scss/layout_background.scss @@ -11,7 +11,7 @@ margin-right: 16px; } h3 { - color: $o-company-primary-color; + color: $o-default-report-primary-color; font-weight: 700; font-size: 1.25rem; max-width: 300px; @@ -22,12 +22,12 @@ white-space: nowrap; } ul { - border-top: 1px solid $o-company-secondary-color; - border-bottom: 1px solid $o-company-secondary-color; + border-top: 1px solid $o-default-report-secondary-color; + border-bottom: 1px solid $o-default-report-secondary-color; padding: 4px 0; margin: 0 0 4px 0; li { - color: $o-company-secondary-color; + color: $o-default-report-secondary-color; } } } @@ -39,7 +39,7 @@ min-height: 620px; strong { - color: $o-company-secondary-color; + color: $o-default-report-secondary-color; } .table { border-top: 1px solid gray('300'); @@ -49,10 +49,10 @@ border-top: none; } h2 { - color: $o-company-primary-color; + color: $o-default-report-primary-color; } thead tr th { - color: $o-company-secondary-color + color: $o-default-report-secondary-color } tbody { color: gray('700'); @@ -84,7 +84,7 @@ border-top: 1px solid gray('400') !important; } strong { - color: $o-company-primary-color; + color: $o-default-report-primary-color; } } } diff --git a/addons/web/static/src/scss/layout_boxed.scss b/addons/web/static/src/scss/layout_boxed.scss index a32c09379cd..d9be91da7a5 100644 --- a/addons/web/static/src/scss/layout_boxed.scss +++ b/addons/web/static/src/scss/layout_boxed.scss @@ -16,23 +16,23 @@ .o_boxed_footer { margin-top: 200px; white-space: nowrap; - border-top: 3px solid $o-company-secondary-color; + border-top: 3px solid $o-default-report-secondary-color; ul { margin: 4px 0; } } .o_report_layout_boxed { #total strong { - color: $o-company-primary-color; + color: $o-default-report-primary-color; } #informations strong { - color: $o-company-secondary-color; + color: $o-default-report-secondary-color; } > h2 { text-transform: uppercase; } h2 span { - color: $o-company-primary-color; + color: $o-default-report-primary-color; } table { border: 1px solid gray('700'); @@ -41,7 +41,7 @@ tr th { text-transform: uppercase; border: 1px solid gray('700'); - color: $o-company-secondary-color; + color: $o-default-report-secondary-color; } } tbody { @@ -59,12 +59,12 @@ border-bottom: 1px solid gray('700'); } &.o_line_section td { - background-color: rgba($o-company-primary-color, 0.7); + background-color: rgba($o-default-report-primary-color, 0.7); color: #fff; } &.is-subtotal, td.o_price_total { - background-color: rgba($o-company-secondary-color, 0.1); + background-color: rgba($o-default-report-secondary-color, 0.1); } } } @@ -92,7 +92,7 @@ } &:last-child td, &.o_total td { - background-color: rgba($o-company-primary-color, 0.9); + background-color: rgba($o-default-report-primary-color, 0.9); color: #fff; &:first-child { diff --git a/addons/web/static/src/scss/layout_clean.scss b/addons/web/static/src/scss/layout_clean.scss index 0a62584ea88..5d559726281 100644 --- a/addons/web/static/src/scss/layout_clean.scss +++ b/addons/web/static/src/scss/layout_clean.scss @@ -8,14 +8,14 @@ .o_clean_footer { margin: 0 3px; margin-top: 200px; - border-top: 3px solid $o-company-secondary-color; + border-top: 3px solid $o-default-report-secondary-color; h4 { - color: $o-company-secondary-color; + color: $o-default-report-secondary-color; font-weight: bolder; } .pagenumber { - border: 3px solid $o-company-primary-color; - background-color: $o-company-secondary-color; + border: 3px solid $o-default-report-primary-color; + background-color: $o-default-report-secondary-color; color: white; padding: 4px 8px; text-align: center; @@ -23,11 +23,11 @@ } .o_report_layout_clean { h1, h2, h3 { - color: $o-company-primary-color; + color: $o-default-report-primary-color; font-weight: bolder; } strong { - color: $o-company-secondary-color; + color: $o-default-report-secondary-color; } table { &.o_main_table { @@ -35,9 +35,9 @@ } thead { - color: $o-company-secondary-color; + color: $o-default-report-secondary-color; tr th { - border-top: 3px solid $o-company-secondary-color !important; + border-top: 3px solid $o-default-report-secondary-color !important; text-transform: uppercase; } tr th:first-child { @@ -50,7 +50,7 @@ border-top: none; } tr:last-child td { - border-bottom: 3px solid $o-company-secondary-color; + border-bottom: 3px solid $o-default-report-secondary-color; } tr { td { @@ -63,7 +63,7 @@ } #total { strong { - color: $o-company-secondary-color; + color: $o-default-report-secondary-color; } } /*Total table*/ diff --git a/addons/web/static/src/scss/layout_standard.scss b/addons/web/static/src/scss/layout_standard.scss index 5cedf578c48..acd52b32bd4 100644 --- a/addons/web/static/src/scss/layout_standard.scss +++ b/addons/web/static/src/scss/layout_standard.scss @@ -7,19 +7,19 @@ .o_report_layout_standard { h2 { - color: $o-company-primary-color; + color: $o-default-report-primary-color; } #informations strong { - color: $o-company-secondary-color; + color: $o-default-report-secondary-color; } #total strong{ - color: $o-company-primary-color; + color: $o-default-report-primary-color; } table { thead { - color: $o-company-secondary-color; + color: $o-default-report-secondary-color; } } } diff --git a/addons/web/static/src/scss/report.scss b/addons/web/static/src/scss/report.scss index f6fcdeb9407..86c0f986006 100644 --- a/addons/web/static/src/scss/report.scss +++ b/addons/web/static/src/scss/report.scss @@ -1,6 +1,6 @@ -$o-company-font: 'Lato' !default; -$o-company-primary-color: rgb(0, 0, 0) !default; -$o-company-secondary-color: rgb(0, 0, 0) !default; +$o-default-report-font: 'Lato' !default; +$o-default-report-primary-color: rgb(0, 0, 0) !default; +$o-default-report-secondary-color: rgb(0, 0, 0) !default; html, body { height: 100%; @@ -10,7 +10,7 @@ html, body { body { color: #000 !important; word-wrap: break-word; - font-family: $o-company-font; + font-family: $o-default-report-font; } .border-black td, .border-black th { border-top: 1px solid black !important; diff --git a/addons/web/views/report_templates.xml b/addons/web/views/report_templates.xml index 631330238ae..4f6f6086c7a 100644 --- a/addons/web/views/report_templates.xml +++ b/addons/web/views/report_templates.xml @@ -19,13 +19,13 @@ <link href="/web/static/lib/fontawesome/css/font-awesome.css" rel="stylesheet" type="text/css"/> <link rel="stylesheet" type="text/scss" href="/web/static/src/scss/fonts.scss"/> - <link rel="stylesheet" type="text/scss" href="/web/static/src/scss/report_styles.scss"/> <link rel="stylesheet" type="text/scss" href="/web/static/src/scss/report.scss"/> <link rel="stylesheet" type="text/scss" href="/web/static/src/scss/layout_standard.scss"/> <link rel="stylesheet" type="text/scss" href="/web/static/src/scss/layout_background.scss"/> <link rel="stylesheet" type="text/scss" href="/web/static/src/scss/layout_boxed.scss"/> <link rel="stylesheet" type="text/scss" href="/web/static/src/scss/layout_clean.scss"/> + <link rel="stylesheet" type="text/scss" href="/web/static/src/scss/asset_styles_company_report.scss"/> <script type="text/javascript" src="/web/static/src/js/services/session.js"/> <script type="text/javascript" src="/web/static/src/js/public/public_root.js"/> @@ -142,7 +142,7 @@ </template> <template id="external_layout_background"> - <div class="header"> + <div t-attf-class="o_company_#{company.id}_layout header"> <div class="o_background_header"> <div class="float-right"> <h3 class="mt0 text-right" t-field="company.report_header"/> @@ -159,12 +159,12 @@ </div> </div> - <div class="article o_report_layout_background" t-att-data-oe-model="o and o._name" t-att-data-oe-id="o and o.id" t-att-data-oe-lang="o and o.env.context.get('lang')"> + <div t-attf-class="o_company_#{company.id}_layout article o_report_layout_background" t-att-data-oe-model="o and o._name" t-att-data-oe-id="o and o.id" t-att-data-oe-lang="o and o.env.context.get('lang')"> <t t-call="web.address_layout"/> <t t-raw="0"/> </div> - <div class="footer o_background_footer"> + <div t-attf-class="o_company_#{company.id}_layout footer o_background_footer"> <div class="text-center"> <ul class="list-inline"> <li t-if="company.phone" class="list-inline-item"><i class="fa fa-phone" role="img" aria-label="Phone" title="Phone"/> <span t-field="company.phone"/></li> @@ -184,7 +184,7 @@ </template> <template id="external_layout_boxed"> - <div class="header"> + <div t-attf-class="header o_company_#{company.id}_layout"> <div class="o_boxed_header"> <div class="row mb8"> <div class="col-6"> @@ -201,12 +201,12 @@ </div> </div> - <div class="article o_report_layout_boxed" t-att-data-oe-model="o and o._name" t-att-data-oe-id="o and o.id" t-att-data-oe-lang="o and o.env.context.get('lang')"> + <div t-attf-class="article o_report_layout_boxed o_company_#{company.id}_layout" t-att-data-oe-model="o and o._name" t-att-data-oe-id="o and o.id" t-att-data-oe-lang="o and o.env.context.get('lang')"> <t t-call="web.address_layout"/> <t t-raw="0"/> </div> - <div class="footer o_boxed_footer"> + <div t-attf-class="footer o_boxed_footer o_company_#{company.id}_layout"> <div class="text-center"> <ul class="list-inline"> <li t-if="company.phone" class="list-inline-item"><span t-field="company.phone"/></li> @@ -223,7 +223,7 @@ </template> <template id="external_layout_clean"> - <div class="header"> + <div t-attf-class="header o_company_#{company.id}_layout"> <div class="o_clean_header"> <div class="row"> <div class="col-6"> @@ -242,12 +242,12 @@ </div> </div> - <div class="article o_report_layout_clean" t-att-data-oe-model="o and o._name" t-att-data-oe-id="o and o.id" t-att-data-oe-lang="o and o.env.context.get('lang')"> + <div t-attf-class="article o_report_layout_clean o_company_#{company.id}_layout" t-att-data-oe-model="o and o._name" t-att-data-oe-id="o and o.id" t-att-data-oe-lang="o and o.env.context.get('lang')"> <t t-call="web.address_layout"/> <t t-raw="0"/> </div> - <div class="footer o_clean_footer"> + <div t-attf-class="footer o_clean_footer o_company_#{company.id}_layout"> <div class="row mt8"> <div class="col-3"> <span t-field="company.report_footer"/> @@ -269,7 +269,7 @@ </template> <template id="external_layout_standard"> - <div class="header"> + <div t-attf-class="header o_company_#{company.id}_layout"> <div class="row"> <div class="col-3 mb4"> <img t-if="company.logo" t-att-src="image_data_uri(company.logo)" style="max-height: 45px;" alt="Logo"/> @@ -290,12 +290,12 @@ </div> </div> - <div class="article o_report_layout_standard" t-att-data-oe-model="o and o._name" t-att-data-oe-id="o and o.id" t-att-data-oe-lang="o and o.env.context.get('lang')"> + <div t-attf-class="article o_report_layout_standard o_company_#{company.id}_layout" t-att-data-oe-model="o and o._name" t-att-data-oe-id="o and o.id" t-att-data-oe-lang="o and o.env.context.get('lang')"> <t t-call="web.address_layout"/> <t t-raw="0"/> </div> - <div class="footer o_standard_footer"> + <div t-attf-class="footer o_standard_footer o_company_#{company.id}_layout"> <div class="text-center" style="border-top: 1px solid black;"> <ul class="list-inline mb4"> <!-- using the list-inline-item class from bootstrap causes weird behaviours in pdf report @@ -335,8 +335,6 @@ </t> </t> - <t t-esc="company.update_scss()"/> - <t t-if="company.external_report_layout_id" t-call="{{company.external_report_layout_id.key}}"><t t-raw="0"/></t> <t t-else="else" t-call="web.external_layout_standard"><t t-raw="0"/></t> @@ -358,8 +356,6 @@ </t> </t> - <t t-esc="company.update_scss()"/> - <div class="header"> <div class="row"> <div class="col-3"> @@ -413,6 +409,148 @@ </t> </template> + <template id="styles_company_report"> + <t t-foreach="company_ids" t-as="company"> + <t t-set="font" t-value="company.font or 'Lato'" /> + <t t-set="primary" t-value="company.primary_color or 'black'" /> + <t t-set="secondary" t-value="company.secondary_color or 'black'" /> + <t t-set="layout" t-value="company.external_report_layout_id.key or 'web.external_layout_standard'" /> + .o_company_<t t-esc='company.id'/>_layout { + font-family: '<t t-esc="font" />'; + + <t t-if="layout == 'web.external_layout_background'"> + .o_background_header { + h3 { + color: <t t-esc='primary'/>; + } + } + &.o_background_footer { + ul { + li { + color: <t t-esc='secondary'/>; + } + } + } + &.o_report_layout_background { + strong { + color: <t t-esc='secondary'/>; + } + h2 { + color: <t t-esc='primary'/>; + } + thead tr th { + color: <t t-esc='secondary'/>; + } + } + .row > div > table, + div#total table { + &:first-child, + &:last-child, + &.o_subtotal, + &.o_total { + strong { + color: <t t-esc='primary'/>; + } + } + } + </t> + <t t-elif="layout == 'web.external_layout_boxed'"> + &.o_report_layout_boxed { + #total strong { + color: <t t-esc='primary'/>; + } + #informations strong { + color: <t t-esc='secondary'/>; + } + h2 span { + color: <t t-esc='primary'/>; + } + table { + thead { + tr th { + color: <t t-esc='secondary'/>; + } + } + tbody tr td { + &.o_line_section td { + background-color: rgba(<t t-esc='primary'/>, 0.7); + } + &.is-subtotal, + td.o_price_total { + background-color: rgba(<t t-esc='secondary'/>, 0.1); + } + } + } + } + .row > div > table, + div#total table { + tr { + &.o_total td { + background-color: rgba(<t t-esc='primary'/>, 0.9); + } + } + } + </t> + <t t-elif="layout == 'web.external_layout_clean'" > + &.o_clean_footer { + border-top: 3px solid <t t-esc='secondary'/>; + h4 { + color: <t t-esc='secondary'/>; + } + .pagenumber { + border: 3px solid <t t-esc='primary'/>; + background-color: <t t-esc='secondary'/>; + } + } + &.o_report_layout_clean { + h1, h2, h3 { + color: <t t-esc='primary'/>; + } + strong { + color: <t t-esc='secondary'/>; + } + table { + thead { + color: <t t-esc='secondary'/>; + tr th { + border-top: 3px solid <t t-esc='secondary'/> !important; + } + } + tbody { + tr:last-child td { + border-bottom: 3px solid <t t-esc='secondary'/>; + } + } + } + #total { + strong { + color: <t t-esc='secondary'/>; + } + } + } + </t> + <t t-elif="layout == 'web.external_layout_standard'"> + &.o_report_layout_standard { + h2 { + color: <t t-esc='primary'/>; + } + #informations strong { + color: <t t-esc='secondary'/>; + } + #total strong{ + color: <t t-esc='primary'/>; + } + table { + thead { + color: <t t-esc='secondary'/>; + } + } + } + </t> + } + </t> + </template> + <report id="action_report_internalpreview" model="res.company" name="web.preview_internalreport" |
