Merge 2eb9253 into 7018a18

report_substitute/README.rst

@@ -0,0 +1,100 @@
+=================
+Report Substitute
+=================
+
+.. !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+   !! This file is generated by oca-gen-addon-readme !!
+   !! changes will be overwritten.                   !!
+   !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+
+.. |badge1| image:: https://img.shields.io/badge/maturity-Beta-yellow.png
+    :target: https://odoo-community.org/page/development-status
+    :alt: Beta
+.. |badge2| image:: https://img.shields.io/badge/licence-AGPL--3-blue.png
+    :target: http://www.gnu.org/licenses/agpl-3.0-standalone.html
+    :alt: License: AGPL-3
+.. |badge3| image:: https://img.shields.io/badge/github-OCA%2Freporting--engine-lightgray.png?logo=github
+    :target: https://github.com/OCA/reporting-engine/tree/12.0/report_substitute
+    :alt: OCA/reporting-engine
+.. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png
+    :target: https://translation.odoo-community.org/projects/reporting-engine-12-0/reporting-engine-12-0-report_substitute
+    :alt: Translate me on Weblate
+.. |badge5| image:: https://img.shields.io/badge/runbot-Try%20me-875A7B.png
+    :target: https://runbot.odoo-community.org/runbot/143/12.0
+    :alt: Try me on Runbot
+
+|badge1| |badge2| |badge3| |badge4| |badge5| 
+
+This module allows you to create substitution rules for report actions.
+A typical use case is to replace a standard report by alternative reports
+when some conditions are met. For instance, it allows to configure alternate
+reports for different companies.
+
+**Table of contents**
+
+.. contents::
+   :local:
+
+Usage
+=====
+
+To use this module, you need to:
+
+#. Go to 'Actions' / 'Reports'
+
+#. Select the desired report you want to 'Substitution Rules'
+
+#. In the substitutions page add a new line
+
+#. Select the substitution report action
+
+#. Set a domain to specify when this substitution should happen
+
+
+When a user calls a report action, the system tries to find the first
+substitution in with a domain that matches all records.
+
+Known issues / Roadmap
+======================
+
+- The document name result should take the name of the substitution report.
+
+Bug Tracker
+===========
+
+Bugs are tracked on `GitHub Issues <https://github.com/OCA/reporting-engine/issues>`_.
+In case of trouble, please check there if your issue has already been reported.
+If you spotted it first, help us smashing it by providing a detailed and welcomed
+`feedback <https://github.com/OCA/reporting-engine/issues/new?body=module:%20report_substitute%0Aversion:%2012.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**>`_.
+
+Do not contact contributors directly about support or help with technical issues.
+
+Credits
+=======
+
+Authors
+~~~~~~~
+
+* ACSONE SA/NV
+
+Contributors
+~~~~~~~~~~~~
+
+* Bejaoui Souheil <souheil.bejaoui@acsone.eu>
+
+Maintainers
+~~~~~~~~~~~
+
+This module is maintained by the OCA.
+
+.. image:: https://odoo-community.org/logo.png
+   :alt: Odoo Community Association
+   :target: https://odoo-community.org
+
+OCA, or the Odoo Community Association, is a nonprofit organization whose
+mission is to support the collaborative development of Odoo features and
+promote its widespread use.
+
+This module is part of the `OCA/reporting-engine <https://github.com/OCA/reporting-engine/tree/12.0/report_substitute>`_ project on GitHub.
+
+You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.

report_substitute/__init__.py

@@ -0,0 +1,3 @@
+from . import models
+from . import wizards
+from . import tests

report_substitute/__manifest__.py

@@ -0,0 +1,21 @@
+# Copyright 2019 ACSONE SA/NV
+# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl).
+
+{
+    'name': 'Report Substitute',
+    'summary': """
+        This module allows to create substitution rules for report actions.
+        """,
+    'version': '12.0.1.0.0',
+    'license': 'AGPL-3',
+    'author': 'ACSONE SA/NV,'
+              'Odoo Community Association (OCA)',
+    'website': 'https://github.com/OCA/reporting-engine',
+    'depends': ['base', 'mail'],
+    'data': [
+        'security/ir_actions_report_substitution_rule.xml',
+        'views/assets_backend.xml',
+        'views/ir_actions_report.xml',
+    ],
+    'demo': ['demo/action_report.xml'],
+}

report_substitute/demo/action_report.xml

@@ -0,0 +1,29 @@
+<?xml version="1.0" encoding="utf-8"?>
+<odoo>
+    <template id="substitution_report">
+        <div class="page">Substitution Report</div>
+    </template>
+
+    <report id="substitution_report_print"
+            string="Substitution For Technical guide"
+            model="ir.module.module"
+            report_type="qweb-pdf"
+            file="report_substitute.substitution_report"
+            name="report_substitute.substitution_report"/>
+
+    <record id="substitution_rule_demo_1" model="ir.actions.report.substitution.rule">
+        <field name="action_report_id" ref="base.ir_module_reference_print"/>
+        <field name="substitution_action_report_id" ref="report_substitute.substitution_report_print"/>
+    </record>
+
+    <template id="substitution_report_2">
+        <div class="page">Substitution Report 2</div>
+    </template>
+
+    <report id="substitution_report_print_2"
+            string="Substitution 2 For Technical guide"
+            model="ir.module.module"
+            report_type="qweb-pdf"
+            file="report_substitute.substitution_report_2"
+            name="report_substitute.substitution_report_2"/>
+</odoo>

report_substitute/models/__init__.py

@@ -0,0 +1,3 @@
+from . import ir_actions_report
+from . import ir_actions_report_substitution_rule
+from . import mail_thread

report_substitute/models/ir_actions_report.py

@@ -0,0 +1,74 @@
+# Copyright 2019 ACSONE SA/NV
+# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl).
+
+from odoo import api, fields, models
+from odoo.tools.safe_eval import safe_eval
+
+
+class IrActionReport(models.Model):
+
+    _inherit = 'ir.actions.report'
+
+    action_report_substitution_rule_ids = fields.One2many(
+        comodel_name="ir.actions.report.substitution.rule",
+        inverse_name="action_report_id",
+        string="Substitution Rules",
+    )
+
+    @api.multi
+    def _get_substitution_report(self, model, active_ids):
+        self.ensure_one()
+        model = self.env[model]
+        for (
+            substitution_report_rule
+        ) in self.action_report_substitution_rule_ids:
+            domain = safe_eval(substitution_report_rule.domain)
+            domain.append(('id', 'in', active_ids))
+            if set(model.search(domain).ids) == set(active_ids):
+                return substitution_report_rule.substitution_action_report_id
+        return False
+
+    @api.multi
+    def get_substitution_report(self, active_ids):
+        self.ensure_one()
+        action_report = self
+        substitution_report = action_report
+        while substitution_report:
+            action_report = substitution_report
+            substitution_report = action_report._get_substitution_report(
+                action_report.model, active_ids
+            )
+        return action_report
+
+    @api.model
+    def get_substitution_report_action(self, action, active_ids):
+        if action.get('id'):
+            action_report = self.browse(action['id'])
+            substitution_report = action_report
+            while substitution_report:
+                action_report = substitution_report
+                substitution_report = action_report._get_substitution_report(
+                    action_report.model, active_ids
+                )
+            action.update(action_report.read()[0])
+        return action
+
+    @api.multi
+    def render(self, res_ids, data=None):
+        substitution_report = self.get_substitution_report(res_ids)
+        return super(IrActionReport, substitution_report).render(res_ids, data)
+
+    @api.noguess
+    def report_action(self, docids, data=None, config=True):
+        if docids:
+            if isinstance(docids, models.Model):
+                active_ids = docids.ids
+            elif isinstance(docids, int):
+                active_ids = [docids]
+            elif isinstance(docids, list):
+                active_ids = docids
+            substitution_report = self.get_substitution_report(active_ids)
+            return super(IrActionReport, substitution_report).report_action(
+                docids, data, config
+            )
+        return super().report_action(docids, data, config)

report_substitute/models/ir_actions_report_substitution_rule.py

@@ -0,0 +1,47 @@
+# Copyright 2019 ACSONE SA/NV
+# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl).
+
+from odoo import fields, models, api, _
+from odoo.exceptions import ValidationError
+
+
+class ActionsReportSubstitutionRule(models.Model):
+
+    _name = 'ir.actions.report.substitution.rule'
+    _description = 'Action Report Substitution Rule'
+    _order = 'sequence ASC'
+
+    sequence = fields.Integer(default=10)
+    action_report_id = fields.Many2one(
+        comodel_name="ir.actions.report",
+        string="Report Action",
+        required=True,
+        ondelete="cascade",
+    )
+    model = fields.Char(related="action_report_id.model", store=True)
+    domain = fields.Char(string="Domain", required=True, default="[]")
+    substitution_action_report_id = fields.Many2one(
+        comodel_name="ir.actions.report",
+        string="Substitution Report Action",
+        required=True,
+        ondelete="cascade",
+        domain="[('model', '=', model)]",
+    )
+
+    @api.constrains('substitution_action_report_id', 'action_report_id')
+    def _check_substitution_infinite_loop(self):
+        def _check_infinite_loop(original_report, substitution_report):
+            if original_report == substitution_report:
+                raise ValidationError(_("Substitution infinite loop detected"))
+            for (
+                substitution_rule
+            ) in substitution_report.action_report_substitution_rule_ids:
+                _check_infinite_loop(
+                    original_report,
+                    substitution_rule.substitution_action_report_id,
+                )
+
+        for rec in self:
+            _check_infinite_loop(
+                rec.action_report_id, rec.substitution_action_report_id
+            )

report_substitute/models/mail_thread.py

@@ -0,0 +1,24 @@
+# Copyright 2019 ACSONE SA/NV
+# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl).
+
+from odoo import api, models
+
+
+class MailThread(models.AbstractModel):
+
+    _inherit = 'mail.thread'
+
+    @api.multi
+    def message_post_with_template(self, template_id, **kwargs):
+        template = self.env['mail.template'].browse(template_id)
+        old_report = False
+        if template and template.report_template and self.ids:
+            active_ids = self.ids
+            old_report = template.report_template
+            template.report_template = old_report.get_substitution_report(
+                active_ids
+            )
+        res = super().message_post_with_template(template_id, **kwargs)
+        if old_report:
+            template.report_template = old_report
+        return res

report_substitute/readme/CONTRIBUTORS.rst

@@ -0,0 +1 @@
+* Bejaoui Souheil <souheil.bejaoui@acsone.eu>

report_substitute/readme/DESCRIPTION.rst

@@ -0,0 +1,4 @@
+This module allows you to create substitution rules for report actions.
+A typical use case is to replace a standard report by alternative reports
+when some conditions are met. For instance, it allows to configure alternate
+reports for different companies.

report_substitute/readme/ROADMAP.rst

@@ -0,0 +1 @@
+- The document name result should take the name of the substitution report.

report_substitute/readme/USAGE.rst

@@ -0,0 +1,15 @@
+To use this module, you need to:
+
+#. Go to 'Actions' / 'Reports'
+
+#. Select the desired report you want to 'Substitution Rules'
+
+#. In the substitutions page add a new line
+
+#. Select the substitution report action
+
+#. Set a domain to specify when this substitution should happen
+
+
+When a user calls a report action, the system tries to find the first
+substitution in with a domain that matches all records.

report_substitute/security/ir_actions_report_substitution_rule.xml

@@ -0,0 +1,25 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!-- Copyright 2019 ACSONE SA/NV
+     License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl). -->
+
+<odoo>
+
+    <record model="ir.model.access" id="action_report_substitution_rule_user_access">
+        <field name="name">action.report.substitution.rule user access</field>
+        <field name="model_id" ref="model_ir_actions_report_substitution_rule"/>
+        <field name="perm_read" eval="1"/>
+        <field name="perm_create" eval="0"/>
+        <field name="perm_write" eval="0"/>
+        <field name="perm_unlink" eval="0"/>
+    </record>
+
+    <record model="ir.model.access" id="action_report_substitution_rule_manager_access">
+        <field name="name">action.report.substitution.rule manager access</field>
+        <field name="model_id" ref="model_ir_actions_report_substitution_rule"/>
+        <field name="group_id" ref="base.group_system"/>
+        <field name="perm_read" eval="1"/>
+        <field name="perm_create" eval="1"/>
+        <field name="perm_write" eval="1"/>
+        <field name="perm_unlink" eval="1"/>
+    </record>
+</odoo>