[MIG] report_substitute: Migration to 15.0

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 <[email protected]>
+
+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,25 @@
+# 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": "15.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/ir_actions_report.xml",
+    ],
+    "demo": ["demo/action_report.xml"],
+    "assets": {
+        "web.assets_backend": [
+            "report_substitute/static/src/js/action_manager.esm.js",
+        ],
+    },
+    "maintainers": ["sbejaoui"],
+}

report_substitute/demo/action_report.xml

@@ -0,0 +1,32 @@
+<?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/i18n/report_substitute.pot

@@ -0,0 +1,123 @@
+# Translation of Odoo Server.
+# This file contains the translation of the following modules:
+#	* report_substitute
+#
+msgid ""
+msgstr ""
+"Project-Id-Version: Odoo Server 12.0\n"
+"Report-Msgid-Bugs-To: \n"
+"Last-Translator: <>\n"
+"Language-Team: \n"
+"MIME-Version: 1.0\n"
+"Content-Type: text/plain; charset=UTF-8\n"
+"Content-Transfer-Encoding: \n"
+"Plural-Forms: \n"
+
+#. module: report_substitute
+#: model:ir.model,name:report_substitute.model_ir_actions_report_substitution_rule
+msgid "Action Report Substitution Rule"
+msgstr ""
+
+#. module: report_substitute
+#: model:ir.model.fields,field_description:report_substitute.field_ir_actions_report_substitution_rule__create_uid
+msgid "Created by"
+msgstr ""
+
+#. module: report_substitute
+#: model:ir.model.fields,field_description:report_substitute.field_ir_actions_report_substitution_rule__create_date
+msgid "Created on"
+msgstr ""
+
+#. module: report_substitute
+#: model:ir.model.fields,field_description:report_substitute.field_ir_actions_report_substitution_rule__display_name
+msgid "Display Name"
+msgstr ""
+
+#. module: report_substitute
+#: model:ir.model.fields,field_description:report_substitute.field_ir_actions_report_substitution_rule__domain
+msgid "Domain"
+msgstr ""
+
+#. module: report_substitute
+#: model:ir.model,name:report_substitute.model_mail_thread
+msgid "Email Thread"
+msgstr ""
+
+#. module: report_substitute
+#: model:ir.model,name:report_substitute.model_mail_compose_message
+msgid "Email composition wizard"
+msgstr ""
+
+#. module: report_substitute
+#: model:ir.model.fields,field_description:report_substitute.field_ir_actions_report_substitution_rule__id
+msgid "ID"
+msgstr ""
+
+#. module: report_substitute
+#: model:ir.model.fields,field_description:report_substitute.field_ir_actions_report_substitution_rule____last_update
+msgid "Last Modified on"
+msgstr ""
+
+#. module: report_substitute
+#: model:ir.model.fields,field_description:report_substitute.field_ir_actions_report_substitution_rule__write_uid
+msgid "Last Updated by"
+msgstr ""
+
+#. module: report_substitute
+#: model:ir.model.fields,field_description:report_substitute.field_ir_actions_report_substitution_rule__write_date
+msgid "Last Updated on"
+msgstr ""
+
+#. module: report_substitute
+#: model:ir.model.fields,field_description:report_substitute.field_ir_actions_report_substitution_rule__model
+msgid "Model Name"
+msgstr ""
+
+#. module: report_substitute
+#: model:ir.model,name:report_substitute.model_ir_actions_report
+#: model:ir.model.fields,field_description:report_substitute.field_ir_actions_report_substitution_rule__action_report_id
+msgid "Report Action"
+msgstr ""
+
+#. module: report_substitute
+#: model:ir.model.fields,field_description:report_substitute.field_ir_actions_report_substitution_rule__sequence
+msgid "Sequence"
+msgstr ""
+
+#. module: report_substitute
+#: model:ir.actions.report,name:report_substitute.substitution_report_print_2
+msgid "Substitution 2 For Technical guide"
+msgstr ""
+
+#. module: report_substitute
+#: model:ir.actions.report,name:report_substitute.substitution_report_print
+msgid "Substitution For Technical guide"
+msgstr ""
+
+#. module: report_substitute
+#: model_terms:ir.ui.view,arch_db:report_substitute.substitution_report
+msgid "Substitution Report"
+msgstr ""
+
+#. module: report_substitute
+#: model_terms:ir.ui.view,arch_db:report_substitute.substitution_report_2
+msgid "Substitution Report 2"
+msgstr ""
+
+#. module: report_substitute
+#: model:ir.model.fields,field_description:report_substitute.field_ir_actions_report_substitution_rule__substitution_action_report_id
+msgid "Substitution Report Action"
+msgstr ""
+
+#. module: report_substitute
+#: model:ir.model.fields,field_description:report_substitute.field_ir_actions_report__action_report_substitution_rule_ids
+#: model_terms:ir.ui.view,arch_db:report_substitute.ir_actions_report_form_view
+msgid "Substitution Rules"
+msgstr ""
+
+#. module: report_substitute
+#: code:addons/report_substitute/models/ir_actions_report_substitution_rule.py:35
+#, python-format
+msgid "Substitution infinite loop detected"
+msgstr ""
+

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,72 @@
+# 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(
+        "ir.actions.report.substitution.rule",
+        "action_report_id",
+        string="Substitution Rules",
+    )
+
+    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
+
+    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
+
+    def _render(self, res_ids, data=None):
+        substitution_report = self.get_substitution_report(res_ids)
+        return super(IrActionReport, substitution_report)._render(res_ids, data)
+
+    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)
+
+    def get_action_report_substitution_rule_ids(self):
+        return self.action_report_substitution_rule_ids.ids