diff --git a/report_csv/README.rst b/report_csv/README.rst index bec910f9e..8cb864764 100644 --- a/report_csv/README.rst +++ b/report_csv/README.rst @@ -1,13 +1,36 @@ -.. 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 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_csv + :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_csv + :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 provides a basic report class to generate csv report. +**Table of contents** + +.. contents:: + :local: Usage ===== @@ -41,7 +64,7 @@ A python class :: 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. +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 ------------- +~~~~~~~~~~~~ * Enric Tobella -Maintainer ----------- +Maintainers +~~~~~~~~~~~ + +This module is maintained by the OCA. .. 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. -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. -To contribute to this module, please visit https://odoo-community.org. +You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute. diff --git a/report_csv/__manifest__.py b/report_csv/__manifest__.py index b41c7e238..0aec029a4 100644 --- a/report_csv/__manifest__.py +++ b/report_csv/__manifest__.py @@ -8,7 +8,7 @@ 'Odoo Community Association (OCA)', 'website': "https://github.com/oca/reporting-engine", 'category': 'Reporting', - 'version': '11.0.1.0.0', + 'version': '12.0.1.0.0', 'license': 'AGPL-3', 'external_dependencies': { 'python': [ diff --git a/report_csv/readme/CONTRIBUTORS.rst b/report_csv/readme/CONTRIBUTORS.rst new file mode 100644 index 000000000..94e7b0a40 --- /dev/null +++ b/report_csv/readme/CONTRIBUTORS.rst @@ -0,0 +1,2 @@ +* Enric Tobella +* Jaime Arroyo diff --git a/report_csv/readme/DESCRIPTION.rst b/report_csv/readme/DESCRIPTION.rst new file mode 100644 index 000000000..636b3884f --- /dev/null +++ b/report_csv/readme/DESCRIPTION.rst @@ -0,0 +1 @@ +This module provides a basic report class to generate csv report. diff --git a/report_csv/readme/USAGE.rst b/report_csv/readme/USAGE.rst new file mode 100644 index 000000000..e5d9964cb --- /dev/null +++ b/report_csv/readme/USAGE.rst @@ -0,0 +1,38 @@ +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 :: + + diff --git a/report_csv/report/report_csv.py b/report_csv/report/report_csv.py index fde1ccbca..51d87d195 100644 --- a/report_csv/report/report_csv.py +++ b/report_csv/report/report_csv.py @@ -16,6 +16,7 @@ except ImportError: class ReportCSVAbstract(models.AbstractModel): _name = 'report.report_csv.abstract' + _description = 'Abstract Model for CSV reports' def _get_objs_for_report(self, docids, data): """ diff --git a/report_csv/static/src/js/report/qwebactionmanager.js b/report_csv/static/src/js/report/qwebactionmanager.js index 2f3c294ee..796f188cb 100644 --- a/report_csv/static/src/js/report/qwebactionmanager.js +++ b/report_csv/static/src/js/report/qwebactionmanager.js @@ -1,47 +1,88 @@ // © 2019 Creu Blanca // License AGPL-3.0 or later (https://www.gnuorg/licenses/agpl.html). -odoo.define('report_csv.report', function(require){ -'use strict'; +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 core = require("web.core"); + var ActionManager = require("web.ActionManager"); + var crash_manager = require("web.crash_manager"); + var framework = require("web.framework"); + var session = require("web.session"); + var _t = core._t; -ActionManager.include({ - ir_actions_report: function (action, options){ - var self = this; - var cloned_action = _.clone(action); - if (cloned_action.report_type === 'csv') { + ActionManager.include({ + + _downloadReportCSV: function (url, actions) { framework.blockUI(); - var report_csv_url = 'report/csv/' + cloned_action.report_name; + var def = $.Deferred(); + var type = "csv"; + var cloned_action = _.clone(actions); + if (_.isUndefined(cloned_action.data) || _.isNull(cloned_action.data) || (_.isObject(cloned_action.data) && _.isEmpty(cloned_action.data))) { - if(cloned_action.context.active_ids) { - report_csv_url += '/' + cloned_action.context.active_ids.join(','); + if (cloned_action.context.active_ids) { + url += "/" + cloned_action.context.active_ids.join(','); } } else { - report_csv_url += '?options=' + encodeURIComponent(JSON.stringify(cloned_action.data)); - report_csv_url += '&context=' + encodeURIComponent(JSON.stringify(cloned_action.context)); + url += "?options=" + encodeURIComponent(JSON.stringify(cloned_action.data)); + url += "&context=" + encodeURIComponent(JSON.stringify(cloned_action.context)); } - self.getSession().get_file({ - url: report_csv_url, - data: {data: JSON.stringify([ - report_csv_url, - cloned_action.report_type - ])}, - error: crash_manager.rpc_error.bind(crash_manager), - success: function (){ - if(cloned_action && options && !cloned_action.dialog){ - options.on_close(); - } - } + + var blocked = !session.get_file({ + url: url, + data: { + data: JSON.stringify([url, type]), + }, + success: def.resolve.bind(def), + error: function () { + crash_manager.rpc_error.apply(crash_manager, arguments); + def.reject(); + }, + complete: framework.unblockUI, }); - framework.unblockUI(); - return; + if (blocked) { + // AAB: this check should be done in get_file service directly, + // should not be the concern of the caller (and that way, get_file + // could return a deferred) + var message = _t('A popup window with your report was blocked. You ' + + 'may need to change your browser settings to allow ' + + 'popup windows for this page.'); + this.do_warn(_t('Warning'), message, true); + } + return def; + }, + + _triggerDownload: function (action, options, type) { + var self = this; + var reportUrls = this._makeReportUrls(action); + if (type === "csv") { + return this._downloadReportCSV(reportUrls[type], action).then(function () { + if (action.close_on_report_download) { + var closeAction = {type: 'ir.actions.act_window_close'}; + return self.doAction(closeAction, _.pick(options, 'on_close')); + } else { + return options.on_close(); + } + }); + } + return this._super.apply(this, arguments); + }, + + _makeReportUrls: function (action) { + var reportUrls = this._super.apply(this, arguments); + reportUrls.csv = '/report/csv/' + action.report_name; + return reportUrls; + }, + + _executeReportAction: function (action, options) { + var self = this; + if (action.report_type === 'csv') { + return self._triggerDownload(action, options, 'csv'); + } + return this._super.apply(this, arguments); } - return self._super(action, options); - } -}); + }); + });