diff --git a/report_csv/README.rst b/report_csv/README.rst new file mode 100644 index 000000000..50e0916c6 --- /dev/null +++ b/report_csv/README.rst @@ -0,0 +1,86 @@ +.. image:: https://img.shields.io/badge/licence-AGPL--3-blue.svg + :target: https://www.gnu.org/licenses/agpl-3.0-standalone.html + :alt: License: AGPL-3 + +=============== +Base report csv +=============== + +This module provides a basic report class to generate csv report. + + +Usage +===== + +An example of CSV report for partners on a module called `module_name`: + +A python class :: + + from odoo import models + + class PartnerCSV(models.AbstractModel): + _name = 'report.report_csv.partner_csv' + _inherit = 'report.report_csv.abstract' + + def generate_csv_report(self, writer, data, partners): + writer.writeheader() + for obj in partners: + writer.writerow({ + 'name': obj.name, + 'email': obj.email, + }) + + def csv_report_options(self): + res = super().csv_report_options() + res['fieldnames'].append('name') + res['fieldnames'].append('email') + res['delimiter'] = ';' + res['quoting'] = csv.QUOTE_ALL + return res + + +A report XML record :: + + + +.. image:: https://odoo-community.org/website/image/ir.attachment/5784_f2813bd/datas + :alt: Try me on Runbot + :target: https://runbot.odoo-community.org/runbot/143/11.0 + +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. + +Credits +======= + +Contributors +------------ + +* Enric Tobella +* Laurent Mignon + +Maintainer +---------- + +.. image:: https://odoo-community.org/logo.png + :alt: Odoo Community Association + :target: https://odoo-community.org + +This module is maintained by the OCA. + +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. + +To contribute to this module, please visit https://odoo-community.org. diff --git a/report_csv/__init__.py b/report_csv/__init__.py new file mode 100644 index 000000000..9b6fa04ee --- /dev/null +++ b/report_csv/__init__.py @@ -0,0 +1,3 @@ +from . import controllers +from . import models +from . import report diff --git a/report_csv/__manifest__.py b/report_csv/__manifest__.py new file mode 100644 index 000000000..4758cecc0 --- /dev/null +++ b/report_csv/__manifest__.py @@ -0,0 +1,28 @@ +# -*- coding: utf-8 -*- +# Copyright 2019 Creu Blanca +# License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl.html). +{ + 'name': "Base report csv", + + 'summary': "Base module to create csv report", + 'author': 'Creu Blanca,' + 'ACSONE SA/NV,' + 'Odoo Community Association (OCA)', + 'website': "https://github.com/oca/reporting-engine", + 'category': 'Reporting', + 'version': '10.0.1.0.0', + 'license': 'AGPL-3', + 'depends': [ + 'report', + ], + 'external_dependencies': { + 'python': ['unicodecsv'] + }, + 'data': [ + 'views/webclient_templates.xml', + ], + 'demo': [ + 'demo/report.xml', + ], + 'installable': True, +} diff --git a/report_csv/controllers/__init__.py b/report_csv/controllers/__init__.py new file mode 100644 index 000000000..12a7e529b --- /dev/null +++ b/report_csv/controllers/__init__.py @@ -0,0 +1 @@ +from . import main diff --git a/report_csv/controllers/main.py b/report_csv/controllers/main.py new file mode 100644 index 000000000..eab0b9914 --- /dev/null +++ b/report_csv/controllers/main.py @@ -0,0 +1,109 @@ +# -*- coding: utf-8 -*- +# Copyright (C) 2019 Creu Blanca +# License AGPL-3.0 or later (https://www.gnuorg/licenses/agpl.html). +import json +import time + +from werkzeug import url_decode + +from odoo.addons.report.controllers import main as report +from odoo.http import route, request +from odoo.tools.safe_eval import safe_eval +from odoo.addons.web.controllers.main import ( + _serialize_exception, + content_disposition +) +from odoo.tools import html_escape + + +class ReportController(report.ReportController): + @route() + def report_routes(self, reportname, docids=None, converter=None, **data): + if converter == 'csv': + report = request.env['report']._get_report_from_name( + reportname) + context = dict(request.env.context) + + if docids: + docids = [int(i) for i in docids.split(',')] + if data.get('options'): + data.update(json.loads(data.pop('options'))) + if data.get('context'): + # Ignore 'lang' here, because the context in data is the one + # from the webclient *but* if the user explicitely wants to + # change the lang, this mechanism overwrites it. + data['context'] = json.loads(data['context']) + if data['context'].get('lang'): + del data['context']['lang'] + context.update(data['context']) + + csv = request.env["report"].with_context(context).get_csv( + docids, reportname, data=data + )[0] + filename = "%s.%s" % (report.name, "csv") + if docids: + obj = request.env[report.model].browse(docids) + if report.print_report_name and not len(obj) > 1: + report_name = safe_eval( + report.print_report_name, + {'object': obj, 'time': time, 'multi': False}) + filename = "%s.%s" % (report_name, "csv") + # When we print multiple records we still allow a custom + # filename. + elif report.print_report_name and len(obj) > 1: + report_name = safe_eval( + report.print_report_name, + {'objects': obj, 'time': time, 'multi': True}) + filename = "%s.%s" % (report_name, "csv") + csvhttpheaders = [ + ('Content-Type', 'text/csv'), + ('Content-Length', len(csv)), + ( + 'Content-Disposition', + content_disposition(filename) + ) + ] + return request.make_response(csv, headers=csvhttpheaders) + return super(ReportController, self).report_routes( + reportname, docids, converter, **data + ) + + @route() + def report_download(self, data, token): + """This function is used by 'qwebactionmanager.js' in order to trigger + the download of a csv/controller report. + + :param data: a javascript array JSON.stringified containg report + internal url ([0]) and type [1] + :returns: Response with a filetoken cookie and an attachment header + """ + requestcontent = json.loads(data) + url, type = requestcontent[0], requestcontent[1] + if type != 'csv': + return super(ReportController, self).report_download(data, token) + try: + reportname = url.split('/report/csv/')[1].split('?')[0] + docids = None + if '/' in reportname: + reportname, docids = reportname.split('/') + + if docids: + # Generic report: + response = self.report_routes( + reportname, docids=docids, converter='csv') + else: + # Particular report: + # decoding the args represented in JSON + data = url_decode(url.split('?')[1]).items() + response = self.report_routes( + reportname, converter='csv', **dict(data)) + response.set_cookie('fileToken', token) + return response + except Exception, e: + se = _serialize_exception(e) + error = { + 'code': 200, + 'message': "Odoo Server Error", + 'data': se + } + return request.make_response(html_escape(json.dumps(error))) diff --git a/report_csv/demo/report.xml b/report_csv/demo/report.xml new file mode 100644 index 000000000..72c741dec --- /dev/null +++ b/report_csv/demo/report.xml @@ -0,0 +1,16 @@ + + + + + diff --git a/report_csv/i18n/report_csv.pot b/report_csv/i18n/report_csv.pot new file mode 100644 index 000000000..d2b2b7eb6 --- /dev/null +++ b/report_csv/i18n/report_csv.pot @@ -0,0 +1,59 @@ +# Translation of Odoo Server. +# This file contains the translation of the following modules: +# * report_csv +# +msgid "" +msgstr "" +"Project-Id-Version: Odoo Server 11.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_csv +#: code:addons/report_csv/models/ir_report.py:18 +#, python-format +msgid "%s model was not found" +msgstr "" + +#. module: report_csv +#: model:ir.model.fields,field_description:report_csv.field_report_report_csv_abstract_display_name +#: model:ir.model.fields,field_description:report_csv.field_report_report_csv_partner_csv_display_name +msgid "Display Name" +msgstr "" + +#. module: report_csv +#: model:ir.model.fields,field_description:report_csv.field_report_report_csv_abstract_id +#: model:ir.model.fields,field_description:report_csv.field_report_report_csv_partner_csv_id +msgid "ID" +msgstr "" + +#. module: report_csv +#: model:ir.model.fields,field_description:report_csv.field_report_report_csv_abstract___last_update +#: model:ir.model.fields,field_description:report_csv.field_report_report_csv_partner_csv___last_update +msgid "Last Modified on" +msgstr "" + +#. module: report_csv +#: model:ir.actions.report,name:report_csv.partner_csv +msgid "Print to CSV" +msgstr "" + +#. module: report_csv +#: model:ir.model,name:report_csv.model_ir_actions_report +msgid "ir.actions.report" +msgstr "" + +#. module: report_csv +#: model:ir.model,name:report_csv.model_report_report_csv_abstract +msgid "report.report_csv.abstract" +msgstr "" + +#. module: report_csv +#: model:ir.model,name:report_csv.model_report_report_csv_partner_csv +msgid "report.report_csv.partner_csv" +msgstr "" + diff --git a/report_csv/models/__init__.py b/report_csv/models/__init__.py new file mode 100644 index 000000000..55ad3dff4 --- /dev/null +++ b/report_csv/models/__init__.py @@ -0,0 +1,2 @@ +from . import report +from . import ir_actions_report_xml diff --git a/report_csv/models/ir_actions_report_xml.py b/report_csv/models/ir_actions_report_xml.py new file mode 100644 index 000000000..9c989f351 --- /dev/null +++ b/report_csv/models/ir_actions_report_xml.py @@ -0,0 +1,22 @@ +# -*- coding: utf-8 -*- +# Copyright 2019 Creu Blanca +# License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl.html). + +from odoo import api, fields, models, _ +from odoo.exceptions import UserError + + +class IrActionsReportXml(models.Model): + _inherit = 'ir.actions.report.xml' + + report_type = fields.Selection(selection_add=[("csv", "csv")]) + + @api.model + def render_csv(self, docids, data): + report_model_name = 'report.%s' % self.report_name + report_model = self.env.get(report_model_name) + if report_model is None: + raise UserError(_('%s model was not found' % report_model_name)) + return report_model.with_context({ + 'active_model': self.model + }).create_csv_report(docids, data) diff --git a/report_csv/models/report.py b/report_csv/models/report.py new file mode 100644 index 000000000..7c4bb20a0 --- /dev/null +++ b/report_csv/models/report.py @@ -0,0 +1,64 @@ +# -*- coding: utf-8 -*- +# Copyright 2017 Akretion (http://www.akretion.com/) +# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl). + +import base64 +import logging + +from odoo import api, models +from odoo.exceptions import AccessError + +_logger = logging.getLogger(__name__) + + +class Report(models.Model): + + _inherit = 'report' + + @api.model + def _get_report_from_name(self, report_name): + """Get the first record of ir.actions.report.xml having the + ``report_name`` as value for the field report_name. + """ + res = super(Report, self)._get_report_from_name(report_name) + if res: + return res + report_obj = self.env['ir.actions.report.xml'] + qwebtypes = ['csv'] + conditions = [('report_type', 'in', qwebtypes), + ('report_name', '=', report_name)] + context = self.env['res.users'].context_get() + return report_obj.with_context(context).search(conditions, limit=1) + + @api.model + def get_csv(self, docids, report_name, data=None): + # Get the ir.actions.report.xml record we are working on. + report = self._get_report_from_name(report_name) + # Check if we have to save the report or if we have to get one from the db. + save_in_attachment = self._check_attachment_use(docids, report) + res_id = len(docids) == 1 and docids[0] + if res_id: + loaded_doc = save_in_attachment['loaded_documents'].get(res_id) + if loaded_doc: + return loaded_doc, 'csv' + + data, ext = report.render_csv(docids, data) + + if res_id and data and save_in_attachment.get(res_id): + attachment = { + 'name': save_in_attachment.get(res_id), + 'datas': base64.encodestring(data), + 'datas_fname': save_in_attachment.get(res_id), + 'res_model': save_in_attachment.get('model'), + 'res_id': res_id, + } + try: + self.env['ir.attachment'].create(attachment) + except AccessError: + _logger.info("Cannot save csv report %r as attachment", + attachment['name']) + else: + _logger.info( + 'The csv document %s is now saved in the database', + attachment['name']) + return data, ext diff --git a/report_csv/report/__init__.py b/report_csv/report/__init__.py new file mode 100644 index 000000000..941755038 --- /dev/null +++ b/report_csv/report/__init__.py @@ -0,0 +1,2 @@ +from . import report_csv +from . import report_partner_csv diff --git a/report_csv/report/report_csv.py b/report_csv/report/report_csv.py new file mode 100644 index 000000000..c2d3ba738 --- /dev/null +++ b/report_csv/report/report_csv.py @@ -0,0 +1,61 @@ +# -*- coding: utf-8 -*- +# Copyright 2019 Creu Blanca +# License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl.html). + +import logging +from StringIO import StringIO + +from odoo import models + +logger = logging.getLogger(__name__) + +try: + import unicodecsv as csv +except ImportError: + logger.debug('Cannot import unicodecsv') + + +class ReportCSVAbstract(models.AbstractModel): + _name = 'report.report_csv.abstract' + + def _get_objs_for_report(self, docids, data): + """ + Returns objects for csv report. From WebUI these + are either as docids taken from context.active_ids or + in the case of wizard are in data. Manual calls may rely + on regular context, setting docids, or setting data. + + :param docids: list of integers, typically provided by + qwebactionmanager for regular Models. + :param data: dictionary of data, if present typically provided + by qwebactionmanager for TransientModels. + :param ids: list of integers, provided by overrides. + :return: recordset of active model for ids. + """ + if docids: + ids = docids + elif data and 'context' in data: + ids = data["context"].get('active_ids', []) + else: + ids = self.env.context.get('active_ids', []) + return self.env[self.env.context.get('active_model')].browse(ids) + + def create_csv_report(self, docids, data): + objs = self._get_objs_for_report(docids, data) + file_data = StringIO() + file = csv.DictWriter(file_data, **self.csv_report_options()) + self.generate_csv_report(file, data, objs) + file_data.seek(0) + return file_data.read(), 'csv' + + def csv_report_options(self): + """ + :return: dictionary of parameters. At least return 'fieldnames', but + you can optionally return parameters that define the export format. + Valid parameters include 'delimiter', 'quotechar', 'escapechar', + 'doublequote', 'skipinitialspace', 'lineterminator', 'quoting'. + """ + return {'fieldnames': []} + + def generate_csv_report(self, file, data, objs): + raise NotImplementedError() diff --git a/report_csv/report/report_partner_csv.py b/report_csv/report/report_partner_csv.py new file mode 100644 index 000000000..4d27b1212 --- /dev/null +++ b/report_csv/report/report_partner_csv.py @@ -0,0 +1,26 @@ +# -*- coding: utf-8 -*- +# Copyright 2019 Creu Blanca +# License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl.html). +import csv +from odoo import models + + +class PartnerCSV(models.AbstractModel): + _name = 'report.report_csv.partner_csv' + _inherit = 'report.report_csv.abstract' + + def generate_csv_report(self, writer, data, partners): + writer.writeheader() + for obj in partners: + writer.writerow({ + 'name': obj.name, + 'email': obj.email, + }) + + def csv_report_options(self): + res = super(PartnerCSV, self).csv_report_options() + res['fieldnames'].append('name') + res['fieldnames'].append('email') + res['delimiter'] = ';' + res['quoting'] = csv.QUOTE_ALL + return res diff --git a/report_csv/static/description/icon.png b/report_csv/static/description/icon.png new file mode 100644 index 000000000..3a0328b51 Binary files /dev/null and b/report_csv/static/description/icon.png differ diff --git a/report_csv/static/src/js/report/qwebactionmanager.js b/report_csv/static/src/js/report/qwebactionmanager.js new file mode 100644 index 000000000..02e1d734f --- /dev/null +++ b/report_csv/static/src/js/report/qwebactionmanager.js @@ -0,0 +1,54 @@ +// © 2019 Creu Blanca +// License AGPL-3.0 or later (https://www.gnuorg/licenses/agpl.html). +odoo.define('report_csv.report', function(require){ +'use strict'; + +var ActionManager= require('web.ActionManager'); +var crash_manager = require('web.crash_manager'); +var framework = require('web.framework'); + +var trigger_download = function(session, response, c, action, options) { + session.get_file({ + url: '/report/download', + data: {data: JSON.stringify(response)}, + complete: framework.unblockUI, + error: c.rpc_error.bind(c), + success: function(){ + if (action && options && !action.dialog) { + options.on_close(); + } + }, + }); +}; + +ActionManager.include({ + ir_actions_report_xml: function(action, options) { + var self = this; + + // Py3o reports + if ('report_type' in action && action.report_type == 'csv' ) { + framework.blockUI(); + action = _.clone(action); + var report_url = '/report/csv/' + action.report_name;; + // generic report: no query string + // particular: query string of action.data.form and context + if (!('data' in action) || !(action.data)) { + if ('active_ids' in action.context) { + report_url += "/" + action.context.active_ids.join(','); + } + } else { + report_url += "&options=" + encodeURIComponent(JSON.stringify(action.data)); + report_url += "&context=" + encodeURIComponent(JSON.stringify(action.context)); + } + + var response = new Array(); + response[0] = report_url; + response[1] = action.report_type; + var c = crash_manager; + return trigger_download(self.session, response, c, action, options); + } else { + return self._super(action, options); + } + } +}); +}); diff --git a/report_csv/tests/__init__.py b/report_csv/tests/__init__.py new file mode 100644 index 000000000..32ae3c2c3 --- /dev/null +++ b/report_csv/tests/__init__.py @@ -0,0 +1 @@ +from . import test_report diff --git a/report_csv/tests/test_report.py b/report_csv/tests/test_report.py new file mode 100644 index 000000000..fe16eec85 --- /dev/null +++ b/report_csv/tests/test_report.py @@ -0,0 +1,70 @@ +# -*- coding: utf-8 -*- +# Copyright 2019 Creu Blanca +# License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl.html). +import csv +from StringIO import StringIO +from odoo.tests import common + + +class TestReport(common.TransactionCase): + def setUp(self): + super(TestReport, self,).setUp() + self.Report = self.env['report'] + self.IrAttachment = self.env["ir.attachment"] + self.csv_report = ( + self.env['report.report_csv.abstract'] + .with_context(active_model='res.partner') + ) + self.report_name = 'report_csv.partner_csv' + self.report = self.Report._get_report_from_name(self.report_name) + self.docs = self.env['res.company'].search([], limit=1).partner_id + + def _get_doc_attachments(self, docs): + return self.IrAttachment.search( + [("res_id", "in", docs.ids), + ("res_model", "=", docs._name)] + ) + + def test_report(self): + report = self.report + self.assertEqual(report.report_type, 'csv') + rep = self.Report.get_csv(self.docs.ids, self.report_name, {}) + str_io = StringIO(rep[0]) + dict_report = list(csv.DictReader(str_io, delimiter=';', + quoting=csv.QUOTE_ALL)) + self.assertEqual(self.docs.name, dict(dict_report[0])['name']) + + def test_report_save_in_attachment(self): + attachment = self._get_doc_attachments(self.docs) + self.report.attachment = "'test.csv'" + self.report.attachment_use = True + rep = self.Report.get_csv(self.docs.ids, self.report_name, {}) + attachment = self._get_doc_attachments(self.docs) - attachment + self.assertTrue(attachment) + self.assertEqual(attachment.datas.decode("base64"), rep[0]) + attachment.datas = "test".encode("base64") + rep = self.Report.get_csv(self.docs.ids, self.report_name, {}) + self.assertEqual(rep[0], "test") + + def test_id_retrieval(self): + + # Typical call from WebUI with wizard + objs = self.csv_report._get_objs_for_report( + False, {"context": {"active_ids": self.docs.ids}}) + self.assertEquals(objs, self.docs) + + # Typical call from within code not to report_action + objs = self.csv_report.with_context( + active_ids=self.docs.ids)._get_objs_for_report(False, False) + self.assertEquals(objs, self.docs) + + # Typical call from WebUI + objs = self.csv_report._get_objs_for_report( + self.docs.ids, + {"data": [self.report_name, self.report.report_type]} + ) + self.assertEquals(objs, self.docs) + + # Typical call from render + objs = self.csv_report._get_objs_for_report(self.docs.ids, {}) + self.assertEquals(objs, self.docs) diff --git a/report_csv/views/webclient_templates.xml b/report_csv/views/webclient_templates.xml new file mode 100644 index 000000000..c694cfa3d --- /dev/null +++ b/report_csv/views/webclient_templates.xml @@ -0,0 +1,13 @@ + + + +