Skip to content

Commit

Permalink
Merge PR #304 into 12.0
Browse files Browse the repository at this point in the history
Signed-off-by pedrobaeza
  • Loading branch information
OCA-git-bot committed Aug 2, 2019
2 parents 37d1f10 + 20f8c45 commit 10ceb95
Show file tree
Hide file tree
Showing 21 changed files with 751 additions and 1 deletion.
96 changes: 96 additions & 0 deletions report_context/README.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,96 @@
==============
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/12.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-12-0/reporting-engine-12-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/12.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.

It can also be added on the developer side using::

<record id="model_name.report_id" model="ir.actions.report">
<field name="context">YOUR CONTEXT HERE</field>
</record>


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_context%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
~~~~~~~

* Creu Blanca

Contributors
~~~~~~~~~~~~

* Jaime Arroyo <jaime.arroyo@creublanca.es>

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

You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.
2 changes: 2 additions & 0 deletions report_context/__init__.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
from . import controllers
from . import models
19 changes: 19 additions & 0 deletions report_context/__manifest__.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
# 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': '12.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',
],
}
1 change: 1 addition & 0 deletions report_context/controllers/__init__.py
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
from . import main
18 changes: 18 additions & 0 deletions report_context/controllers/main.py
Original file line number Diff line number Diff line change
@@ -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)
10 changes: 10 additions & 0 deletions report_context/data/config_parameter.xml
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
<?xml version="1.0" encoding="utf-8"?>
<odoo>
<data noupdate="1">
<record id="report_default_context"
model="ir.config_parameter" forcecreate="True">
<field name="key">report.default.context</field>
<field name="value">{}</field>
</record>
</data>
</odoo>
30 changes: 30 additions & 0 deletions report_context/i18n/report_context.pot
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
# Translation of Odoo Server.
# This file contains the translation of the following modules:
# * report_context
#
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_context
#: model:ir.model.fields,field_description:report_context.field_ir_actions_report__context
msgid "Context Value"
msgstr ""

#. module: report_context
#: model:ir.model.fields,help:report_context.field_ir_actions_report__context
msgid "Context dictionary as Python expression, empty by default (Default: {})"
msgstr ""

#. module: report_context
#: model:ir.model,name:report_context.model_ir_actions_report
msgid "Report Action"
msgstr ""

1 change: 1 addition & 0 deletions report_context/models/__init__.py
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
from . import ir_actions_report
36 changes: 36 additions & 0 deletions report_context/models/ir_actions_report.py
Original file line number Diff line number Diff line change
@@ -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)
1 change: 1 addition & 0 deletions report_context/readme/CONTRIBUTORS.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
* Jaime Arroyo <jaime.arroyo@creublanca.es>
2 changes: 2 additions & 0 deletions report_context/readme/DESCRIPTION.rst
Original file line number Diff line number Diff line change
@@ -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.
18 changes: 18 additions & 0 deletions report_context/readme/USAGE.rst
Original file line number Diff line number Diff line change
@@ -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::

<record id="model_name.report_id" model="ir.actions.report">
<field name="context">YOUR CONTEXT HERE</field>
</record>

Binary file added report_context/static/description/icon.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading

0 comments on commit 10ceb95

Please sign in to comment.