diff --git a/report_context/README.rst b/report_context/README.rst new file mode 100644 index 00000000..455a536e --- /dev/null +++ b/report_context/README.rst @@ -0,0 +1,89 @@ +============== +Report Context +============== + +.. !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! + !! 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/11.0/report_context + :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-11-0/reporting-engine-11-0-report_context + :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/11.0 + :alt: Try me on Runbot + +|badge1| |badge2| |badge3| |badge4| |badge5| + +This module adds a context variable to reports. A possible use for this +context could be hiding some fields or many other configuration options. + +**Table of contents** + +.. contents:: + :local: + +Usage +===== + +To configure this module, you need to: + +* Enter Odoo in debug mode. +* To add a specific context to a report, you should go to Settings -> + Reporting -> Reporting and look for the report you want to edit on the + list. You will see that now they contain a new field called Context Value + , where you will be able to add all the desired context parameters. +* Go to Settings -> Parameters -> System Parameters. On the system + parameters list, look for report.default.context, which is a Python + dictionary variable where you can add a context that will be common for + all reports. + +Bug Tracker +=========== + +Bugs are tracked on `GitHub 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 `_. + +Do not contact contributors directly about support or help with technical issues. + +Credits +======= + +Authors +~~~~~~~ + +* Creu Blanca + +Contributors +~~~~~~~~~~~~ + +* Jaime Arroyo + +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 `_ project on GitHub. + +You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute. diff --git a/report_context/__init__.py b/report_context/__init__.py new file mode 100644 index 00000000..91c5580f --- /dev/null +++ b/report_context/__init__.py @@ -0,0 +1,2 @@ +from . import controllers +from . import models diff --git a/report_context/__manifest__.py b/report_context/__manifest__.py new file mode 100644 index 00000000..5c7fe703 --- /dev/null +++ b/report_context/__manifest__.py @@ -0,0 +1,21 @@ +# Copyright 2019 Creu Blanca +# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl). + +{ + 'name': 'Report Context', + 'summary': """ + Adding context to reports""", + 'version': '11.0.1.0.0', + 'license': 'AGPL-3', + 'author': 'Creu Blanca,Odoo Community Association (OCA)', + 'website': 'https://github.com/OCA/reporting-engine', + 'depends': [ + 'web', + ], + 'data': [ + 'views/ir_actions_report.xml', + 'data/config_parameter.xml', + ], + 'demo': [ + ], +} diff --git a/report_context/controllers/__init__.py b/report_context/controllers/__init__.py new file mode 100644 index 00000000..12a7e529 --- /dev/null +++ b/report_context/controllers/__init__.py @@ -0,0 +1 @@ +from . import main diff --git a/report_context/controllers/main.py b/report_context/controllers/main.py new file mode 100644 index 00000000..0536bc20 --- /dev/null +++ b/report_context/controllers/main.py @@ -0,0 +1,18 @@ +# Copyright 2019 Creu Blanca +# License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl.html). +from odoo.addons.web.controllers import main as report +from odoo.http import route, request +import json + + +class ReportController(report.ReportController): + @route() + def report_routes(self, reportname, docids=None, converter=None, **data): + report = request.env['ir.actions.report']._get_report_from_name( + reportname) + original_context = json.loads(data.get('context', '{}')) + data['context'] = json.dumps(report.with_context( + original_context + )._get_context()) + return super().report_routes( + reportname, docids=docids, converter=converter, **data) diff --git a/report_context/data/config_parameter.xml b/report_context/data/config_parameter.xml new file mode 100644 index 00000000..2f12ffb4 --- /dev/null +++ b/report_context/data/config_parameter.xml @@ -0,0 +1,10 @@ + + + + + report.default.context + {} + + + diff --git a/report_context/models/__init__.py b/report_context/models/__init__.py new file mode 100644 index 00000000..a248cf21 --- /dev/null +++ b/report_context/models/__init__.py @@ -0,0 +1 @@ +from . import ir_actions_report diff --git a/report_context/models/ir_actions_report.py b/report_context/models/ir_actions_report.py new file mode 100644 index 00000000..6cf259c2 --- /dev/null +++ b/report_context/models/ir_actions_report.py @@ -0,0 +1,36 @@ +# Copyright 2019 Creu Blanca +# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl). +from odoo.tools.safe_eval import safe_eval +from odoo import api, fields, models + + +class IrActionsReport(models.Model): + _inherit = 'ir.actions.report' + + context = fields.Char( + string='Context Value', default={}, + required=True, + help="Context dictionary as Python expression, empty by default " + "(Default: {})") + + def _get_context(self): + self.ensure_one() + context = self.env['ir.config_parameter'].sudo().get_param( + 'report.default.context', '{}') + # We must transform it to a dictionary + context = safe_eval(context or '{}') + report_context = safe_eval(self.context or '{}') + context.update(report_context) + context.update(self.env.context) + return context + + @api.multi + def render(self, res_ids, data=None): + return super(IrActionsReport, self.with_context( + self._get_context())).render(res_ids, data=data) + + @api.noguess + def report_action(self, docids, data=None, config=True): + return super(IrActionsReport, self.with_context( + self._get_context() + )).report_action(docids, data=data, config=config) diff --git a/report_context/readme/CONTRIBUTORS.rst b/report_context/readme/CONTRIBUTORS.rst new file mode 100644 index 00000000..e59d5104 --- /dev/null +++ b/report_context/readme/CONTRIBUTORS.rst @@ -0,0 +1 @@ +* Jaime Arroyo diff --git a/report_context/readme/DESCRIPTION.rst b/report_context/readme/DESCRIPTION.rst new file mode 100644 index 00000000..f3306e2d --- /dev/null +++ b/report_context/readme/DESCRIPTION.rst @@ -0,0 +1,2 @@ +This module adds a context variable to reports. A possible use for this +context could be hiding some fields or many other configuration options. diff --git a/report_context/readme/USAGE.rst b/report_context/readme/USAGE.rst new file mode 100644 index 00000000..aae1802d --- /dev/null +++ b/report_context/readme/USAGE.rst @@ -0,0 +1,18 @@ +To configure this module, you need to: + +* Enter Odoo in debug mode. +* To add a specific context to a report, you should go to Settings -> + Reporting -> Reporting and look for the report you want to edit on the + list. You will see that now they contain a new field called Context Value + , where you will be able to add all the desired context parameters. +* Go to Settings -> Parameters -> System Parameters. On the system + parameters list, look for report.default.context, which is a Python + dictionary variable where you can add a context that will be common for + all reports. + +It can also be added on the developer side using:: + + + YOUR CONTEXT HERE + + diff --git a/report_context/static/description/icon.png b/report_context/static/description/icon.png new file mode 100644 index 00000000..3a0328b5 Binary files /dev/null and b/report_context/static/description/icon.png differ diff --git a/report_context/static/description/index.html b/report_context/static/description/index.html new file mode 100644 index 00000000..9c66b909 --- /dev/null +++ b/report_context/static/description/index.html @@ -0,0 +1,436 @@ + + + + + + +Report Context + + + +
+

Report Context

+ + +

Beta License: AGPL-3 OCA/reporting-engine Translate me on Weblate Try me on Runbot

+

This module adds a context variable to reports. A possible use for this +context could be hiding some fields or many other configuration options.

+

Table of contents

+ +
+

Usage

+

To configure this module, you need to:

+
    +
  • Enter Odoo in debug mode.
    • +
  • To add a specific context to a report, you should go to Settings -> +Reporting -> Reporting and look for the report you want to edit on the +list. You will see that now they contain a new field called Context Value +, where you will be able to add all the desired context parameters.
    • +
  • Go to Settings -> Parameters -> System Parameters. On the system +parameters list, look for report.default.context, which is a Python +dictionary variable where you can add a context that will be common for +all reports.
    • +
+
+
+

Bug Tracker

+

Bugs are tracked on GitHub 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.

+

Do not contact contributors directly about support or help with technical issues.

+
+
+

Credits

+
+

Authors

+
    +
  • Creu Blanca
    • +
+
+ +
+

Maintainers

+

This module is maintained by the OCA.

+Odoo Community Association +

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 project on GitHub.

+

You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.

+
+
+
+ + diff --git a/report_context/tests/__init__.py b/report_context/tests/__init__.py new file mode 100644 index 00000000..c72cd7ab --- /dev/null +++ b/report_context/tests/__init__.py @@ -0,0 +1 @@ +from . import test_report_context diff --git a/report_context/tests/test_report_context.py b/report_context/tests/test_report_context.py new file mode 100644 index 00000000..0f5d43a4 --- /dev/null +++ b/report_context/tests/test_report_context.py @@ -0,0 +1,47 @@ +# Copyright 2019 Creu Blanca +# License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl.html). +from odoo.tests.common import TransactionCase + + +class TestReportContext(TransactionCase): + + def test_report_01(self): + company = self.browse_ref('base.main_company') + report = self.browse_ref('web.action_report_internalpreview') + self.env['ir.config_parameter'].sudo().set_param( + 'report.default.context', '{"test_parameter": 1}') + report.write({'context': '{"test_parameter": 2}'}) + action = report.with_context(test_parameter=3).report_action(company) + self.assertEqual(3, action['context']['test_parameter']) + + def test_report_02(self): + company = self.browse_ref('base.main_company') + report = self.browse_ref('web.action_report_internalpreview') + self.env['ir.config_parameter'].sudo().set_param( + 'report.default.context', '{"test_parameter": 1}') + report.write({'context': '{"test_parameter": 2}'}) + action = report.report_action(company) + self.assertEqual(2, action['context']['test_parameter']) + + def test_report_03(self): + company = self.browse_ref('base.main_company') + report = self.browse_ref('web.action_report_internalpreview') + self.env['ir.config_parameter'].sudo().set_param( + 'report.default.context', '{"test_parameter": 1}') + action = report.with_context(test_parameter=3).report_action(company) + self.assertEqual(3, action['context']['test_parameter']) + + def test_report_04(self): + company = self.browse_ref('base.main_company') + report = self.browse_ref('web.action_report_internalpreview') + report.write({'context': '{"test_parameter": 2}'}) + action = report.report_action(company) + self.assertEqual(2, action['context']['test_parameter']) + + def test_report_05(self): + company = self.browse_ref('base.main_company') + report = self.browse_ref('web.action_report_internalpreview') + self.env['ir.config_parameter'].sudo().set_param( + 'report.default.context', '{"test_parameter": 1}') + action = report.report_action(company) + self.assertEqual(1, action['context']['test_parameter']) diff --git a/report_context/views/ir_actions_report.xml b/report_context/views/ir_actions_report.xml new file mode 100644 index 00000000..03f41852 --- /dev/null +++ b/report_context/views/ir_actions_report.xml @@ -0,0 +1,18 @@ + + + + + + + ir.actions.report.context.form + ir.actions.report + + + + + + + + +