diff --git a/report_async/__manifest__.py b/report_async/__manifest__.py index 74a9be855a..c6ee18e345 100644 --- a/report_async/__manifest__.py +++ b/report_async/__manifest__.py @@ -1,27 +1,28 @@ # Copyright 2019 Ecosoft Co., Ltd (http://ecosoft.co.th/) # License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl.html) { - 'name': 'Report Async', - 'summary': 'Central place to run reports live or async', - 'version': '12.0.1.0.1', - 'author': 'Ecosoft, Odoo Community Association (OCA)', - 'license': 'AGPL-3', - 'website': 'https://github.com/OCA/reporting-engine', - 'category': 'Generic Modules', - 'depends': [ - 'queue_job', + "name": "Report Async", + "summary": "Central place to run reports live or async", + "version": "10.0.1.0.0", + "author": "Ecosoft, Odoo Community Association (OCA)", + "license": "AGPL-3", + "website": "https://github.com/OCA/reporting-engine", + "category": "Generic Modules", + "depends": ["queue_job"], + "data": [ + "security/ir.model.access.csv", + "security/ir_rule.xml", + "data/mail_template.xml", + "views/assets.xml", + "views/ir_actions_report_xml.xml", + "views/report_async.xml", + "wizard/print_report_wizard.xml" ], - 'data': [ - 'security/ir.model.access.csv', - 'security/ir_rule.xml', - 'data/mail_template.xml', - 'views/report_async.xml', - 'wizard/print_report_wizard.xml', + 'qweb': [ + 'static/src/xml/report_async.xml' ], - 'demo': [ - 'demo/report_async_demo.xml', - ], - 'installable': True, - 'maintainers': ['kittiu'], - 'development_status': 'Beta', + "demo": ["demo/report_async_demo.xml"], + "installable": True, + "maintainers": ["kittiu"], + "development_status": "Beta", } diff --git a/report_async/data/mail_template.xml b/report_async/data/mail_template.xml index 409677e054..d9cf37e1d1 100644 --- a/report_async/data/mail_template.xml +++ b/report_async/data/mail_template.xml @@ -5,7 +5,7 @@ Report Async: New Report Available Your report is available, ${object.name} - ${object.company_id.partner_id.email_formatted|safe} + ${object.sudo().company_id.partner_id.email_formatted|safe} ${user.partner_id.id} @@ -18,7 +18,8 @@
diff --git a/report_async/models/__init__.py b/report_async/models/__init__.py index 2e6988867b..f0c017416a 100644 --- a/report_async/models/__init__.py +++ b/report_async/models/__init__.py @@ -1,5 +1,7 @@ # Copyright 2019 Ecosoft Co., Ltd (http://ecosoft.co.th/) # License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl.html) -from . import report_async +from . import ir_actions_report_xml from . import ir_report +from . import report_async +from . import queue_job diff --git a/report_async/models/ir_actions_report_xml.py b/report_async/models/ir_actions_report_xml.py new file mode 100644 index 0000000000..9f04d1f6df --- /dev/null +++ b/report_async/models/ir_actions_report_xml.py @@ -0,0 +1,36 @@ +# -*- coding: utf-8 -*- +# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl). + +from odoo import models, fields, api + + +class IrActionsReportXml(models.Model): + """ + Reports + """ + + _inherit = 'ir.actions.report.xml' + + async_report = fields.Boolean(default=False) + async_no_records = fields.Integer( + string="Min of Records", + default=100, + help="Min no of records to use async report functionality; e.g 100+" + ) + + @api.model + def is_report_async(self, report_name): + """ Returns True if the report is an async report + + Called from js + """ + report_obj = self.env['report'] + report = report_obj._get_report_from_name(report_name) + result = {'is_report_async': False} + if not report: + return result + return { + 'is_report_async': report.async_report, + 'no_of_records': report.async_no_records, + 'mail_recipient': self.env.user.email + } diff --git a/report_async/models/ir_report.py b/report_async/models/ir_report.py index e70988bdd8..5d0fb5f132 100644 --- a/report_async/models/ir_report.py +++ b/report_async/models/ir_report.py @@ -5,24 +5,21 @@ # Define all supported report_type -REPORT_TYPES = ['qweb-pdf', 'qweb-text', - 'qweb-xml', 'csv', - 'excel', 'xlsx'] +REPORT_TYPES = ["qweb-pdf", "qweb-html"] class Report(models.Model): - _inherit = 'ir.actions.report' + _inherit = "report" @api.noguess - def report_action(self, docids, data=None, config=True): - res = super(Report, self).report_action(docids, data=data, - config=config) - if res['context'].get('async_process', False): - rpt_async_id = res['context']['active_id'] - report_async = self.env['report.async'].browse(rpt_async_id) - if res['report_type'] in REPORT_TYPES: + def get_action(self, docids, report_name, data=None): + res = super(Report, self).get_action(docids, report_name, data=data) + if res["context"].get("async_process", False): + rpt_async_id = res["context"]["active_id"] + report_async = self.env["report.async"].browse(rpt_async_id) + if res["report_type"] in REPORT_TYPES: report_async.with_delay().run_report( - res['context'].get('active_ids', []), data, - self.id, self._uid) + res["context"].get("active_ids", []), data, self.id, self._uid + ) return {} return res diff --git a/report_async/models/queue_job.py b/report_async/models/queue_job.py new file mode 100644 index 0000000000..c66b3a11f4 --- /dev/null +++ b/report_async/models/queue_job.py @@ -0,0 +1,29 @@ +# -*- coding: utf-8 -*- +# Copyright 2016 Cédric Pigeon +# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl). + +from odoo import api, models + + +class QueueJob(models.Model): + _inherit = 'queue.job' + + @api.model + def create(self, values): + res = super(QueueJob, self).create(values) + if 'model_name' in values and values['model_name'] == 'report.async' \ + and 'kwargs' in values and 'to_email' in values['kwargs']: + followers = self._find_partner(res, values['kwargs']['to_email']) + if followers: + res.message_subscribe(partner_ids=followers) + return res + + def _find_partner(self, record, email): + partner = self.env['res.partner'].search([ + ('email', '=', email) + ], limit=1) + followers = record.message_follower_ids.mapped('partner_id') + ids = [x for x in partner.ids if x not in followers.ids] + if partner and ids: + return ids + return None diff --git a/report_async/models/report_async.py b/report_async/models/report_async.py index 376acc71c2..9a7cc5aa7d 100644 --- a/report_async/models/report_async.py +++ b/report_async/models/report_async.py @@ -2,93 +2,91 @@ # License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl.html) import base64 +import logging +import mock from odoo import api, fields, models, _ +from odoo.http import request from odoo.tools.safe_eval import safe_eval from odoo.exceptions import UserError from odoo.addons.queue_job.job import job - -# Define all supported report_type -REPORT_TYPES_FUNC = {'qweb-pdf': 'render_qweb_pdf', - 'qweb-text': 'render_qweb_text', - 'qweb-xml': 'render_qweb_xml', - 'csv': 'render_csv', - 'excel': 'render_excel', - 'xlsx': 'render_xlsx', } +_logger = logging.getLogger(__name__) class ReportAsync(models.Model): - _name = 'report.async' - _description = 'Report Async' + _name = "report.async" + _description = "Report Async" action_id = fields.Many2one( - comodel_name='ir.actions.act_window', - string='Reports', - required=True, + comodel_name="ir.actions.act_window", string="Reports", required=True ) allow_async = fields.Boolean( - string='Allow Async', + string="Allow Async", default=False, help="This is not automatic field, please check if you want to allow " "this report in background process", ) - name = fields.Char( - string='Name', - related='action_id.display_name', - ) + name = fields.Char(string="Name", related="action_id.display_name") email_notify = fields.Boolean( - string='Email Notification', + string="Email Notification", help="Send email with link to report, when it is ready", ) group_ids = fields.Many2many( - string='Groups', - comodel_name='res.groups', + string="Groups", + comodel_name="res.groups", help="Only user in selected groups can use this report." "If left blank, everyone can use", ) job_ids = fields.Many2many( - comodel_name='queue.job', - compute='_compute_job', + comodel_name="queue.job", + compute="_compute_job", help="List all jobs related to this running report", ) job_status = fields.Selection( - selection=[('pending', 'Pending'), - ('enqueued', 'Enqueued'), - ('started', 'Started'), - ('done', 'Done'), - ('failed', 'Failed')], - compute='_compute_job', + selection=[ + ("pending", "Pending"), + ("enqueued", "Enqueued"), + ("started", "Started"), + ("done", "Done"), + ("failed", "Failed"), + ], + compute="_compute_job", help="Latest Job Status", ) - job_info = fields.Text( - compute='_compute_job', - help="Latest Job Error Message", - ) + job_info = fields.Text(compute="_compute_job", help="Latest Job Error Message") file_ids = fields.Many2many( - comodel_name='ir.attachment', - compute='_compute_file', + comodel_name="ir.attachment", + compute="_compute_file", help="List all files created by this report background process", ) @api.multi def _compute_job(self): for rec in self: - rec.job_ids = self.sudo().env['queue.job'].search( - [('func_string', 'like', 'report.async(%s,)' % rec.id), - ('user_id', '=', self._uid)], - order='id desc') - rec.job_status = (rec.job_ids[0].sudo().state - if rec.job_ids else False) - rec.job_info = (rec.job_ids[0].sudo().exc_info - if rec.job_ids else False) + rec.job_ids = ( + self.sudo() + .env["queue.job"] + .search( + [ + ("func_string", "like", "report.async(%s,)" % rec.id), + ("user_id", "=", self._uid), + ], + order="id desc", + ) + ) + rec.job_status = rec.job_ids[0].sudo().state if rec.job_ids else False + rec.job_info = rec.job_ids[0].sudo().exc_info if rec.job_ids else False @api.multi def _compute_file(self): - files = self.env['ir.attachment'].search( - [('res_model', '=', 'report.async'), - ('res_id', 'in', self.ids), - ('create_uid', '=', self._uid)], - order='id desc') + files = self.env["ir.attachment"].search( + [ + ("res_model", "=", "report.async"), + ("res_id", "in", self.ids), + ("create_uid", "=", self._uid), + ], + order="id desc", + ) for rec in self: rec.file_ids = files.filtered(lambda l: l.res_id == rec.id) @@ -96,67 +94,100 @@ def run_now(self): self.ensure_one() action = self.env.ref(self.action_id.xml_id) result = action.read()[0] - ctx = safe_eval(result.get('context', {})) - ctx.update({'async_process': False}) - result['context'] = ctx + ctx = safe_eval(result.get("context", {})) + ctx.update({"async_process": False}) + result["context"] = ctx return result @api.multi def run_async(self): self.ensure_one() if not self.allow_async: - raise UserError(_('Background process not allowed.')) + raise UserError(_("Background process not allowed.")) action = self.env.ref(self.action_id.xml_id) result = action.read()[0] - ctx = safe_eval(result.get('context', {})) - ctx.update({'async_process': True}) - result['context'] = ctx + ctx = safe_eval(result.get("context", {})) + ctx.update({"async_process": True}) + result["context"] = ctx return result @api.multi def view_files(self): self.ensure_one() - action = self.env.ref('report_async.action_view_files') + action = self.env.ref("report_async.action_view_files") result = action.read()[0] - result['domain'] = [('id', 'in', self.file_ids.ids)] + result["domain"] = [("id", "in", self.file_ids.ids)] return result @api.multi def view_jobs(self): self.ensure_one() - action = self.env.ref('queue_job.action_queue_job') + action = self.env.ref("queue_job.action_queue_job") result = action.read()[0] - result['domain'] = [('id', 'in', self.job_ids.ids)] - result['context'] = {} + result["domain"] = [("id", "in", self.job_ids.ids)] + result["context"] = {} return result + @api.model + def print_document_async(self, record_ids, report_name, html=None, + data=None, to_email=''): + """ Generate a document async, do not return the document file """ + user_email = to_email or self.env.user.email + report = self.env['report']._get_report_from_name(report_name) + self.with_delay().run_report( + record_ids, data or {}, report.id, self._uid, email_notify=True, + to_email=user_email, session_id=request.session.sid + ) + @api.model @job - def run_report(self, docids, data, report_id, user_id): - report = self.env['ir.actions.report'].browse(report_id) - func = REPORT_TYPES_FUNC[report.report_type] - # Run report - out_file, file_ext = getattr(report, func)(docids, data) + def run_report(self, docids, data, report_id, user_id, email_notify=False, to_email=None, session_id=None): + report = self.env["ir.actions.report.xml"].browse(report_id) + # Render report + report_obj = self.env["report"] + if user_id: + report_obj = report_obj.sudo(user_id) + if session_id: + # necessary for correct CSS headers + with mock.patch('odoo.http.request.session') as session: + session.sid = session_id + out_file = report_obj.get_pdf(docids, report.report_name, data=data) + else: + out_file = report_obj.get_pdf(docids, report.report_name, data=data) out_file = base64.b64encode(out_file) - out_name = '%s.%s' % (report.name, file_ext) + out_name = "%s-%s-%s.pdf" % (report.name, str(min(docids)), str(max(docids))) + _logger.info("ASYNC GENERATION OF REPORT %s", (out_name,)) # Save report to attachment - attachment = self.env['ir.attachment'].sudo().create({ - 'name': out_name, - 'datas': out_file, - 'datas_fname': out_name, - 'type': 'binary', - 'res_model': 'report.async', - 'res_id': self.id, - }) - self._cr.execute(""" + attachment = ( + self.env["ir.attachment"] + .sudo() + .create( + { + "name": out_name, + "datas": out_file, + "datas_fname": out_name, + "type": "binary", + "res_model": "report.async", + "res_id": self.id, + } + ) + ) + self._cr.execute( + """ UPDATE ir_attachment SET create_uid = %s, write_uid = %s - WHERE id = %s""", (self._uid, self._uid, attachment.id)) + WHERE id = %s""", + (self._uid, self._uid, attachment.id), + ) # Send email - if self.email_notify: - self._send_email(attachment) + if email_notify or self.email_notify: + self._send_email(attachment, to_email=to_email) - def _send_email(self, attachment): - template = self.env.ref('report_async.async_report_delivery') - template.send_mail(attachment.id, - notif_layout='mail.mail_notification_light', - force_send=False) + def _send_email(self, attachment, to_email=None): + template = self.env.ref("report_async.async_report_delivery") + email_values = {} + if to_email: + email_values = { + 'recipient_ids': [], + 'email_to': to_email, + } + template.send_mail(attachment.id, force_send=False, email_values=email_values) diff --git a/report_async/static/src/js/qweb_action_manager.js b/report_async/static/src/js/qweb_action_manager.js new file mode 100644 index 0000000000..a4e4ce26f8 --- /dev/null +++ b/report_async/static/src/js/qweb_action_manager.js @@ -0,0 +1,95 @@ +odoo.define('report_async.print', function(require) { + 'use strict'; + + var ActionManager = require('web.ActionManager'); + var core = require('web.core'); + var framework = require('web.framework'); + var Model = require('web.Model'); + var Dialog = require('web.Dialog'); + + var _t = core._t; + var QWeb = core.qweb; + + ActionManager.include({ + ir_actions_report_xml: function(action, options) { + var self = this; + var _super = this._super; + var _action = _.clone(action); + var $content = $(QWeb.render("ReportAsyncConfiguration", {})); + + new Model('ir.actions.report.xml') + .call('is_report_async', [_action.report_name]) + .then(function(result){ + var records = _action.context.active_ids; + if (result.is_report_async && records.length >= result.no_of_records) { + // Popup for async Configuration + var asyncDialog = new Dialog(self, { + title: _t("Async Report Configuration ") + '(' + action['display_name'] + ')', + size : "medium", + buttons: [{ + text: _t("Print"), + classes: 'btn-primary', + close: true, + click: function () { + var is_report_async = this.$('#async_report_checker') + .prop('checked'); + var user_email = this.$('#async-user-email').val(); + if (user_email !== '' && is_report_async) { + // Try basic email validation + if (self._validate_email(user_email)) { + if ('report_type' in _action && _action.report_type === 'qweb-pdf') { + framework.unblockUI(); + // Generate report async + new Model('report.async').call('print_document_async', + [_action.context.active_ids, _action.report_name], + { + to_email: user_email, + data: _action.data || {}, + context: _action.context || {}, + }).then(function() { + self.do_notify(_t('Report'), + _t('Job started to generate report. Upon ' + + 'completion, mail sent to:') + + user_email, true); + }).fail(function() { + self.do_notify(_t('Report'), + _t('Failed, error on job creation.'), true); + }); + } + else { + // default to normal approach to generate report + return _super.apply(self, [action, options]); + } + } + } + else { + // default to normal approach to generate report + return _super.apply(self, [action, options]); + } + }}, + { + text: _t("Discard"), + close: true + }], + $content: $content, + }).open(); + asyncDialog.$el.find("#async-user-email").val( + result.mail_recipient); + } + else { + // default to normal approach to generate report + return _super.apply(self, [action, options]); + } + }); + }, + _validate_email: function (email) { + var res = email.match(/^(([^<>()[\]\\.,;:\s@\"]+(\.[^<>()[\]\\.,;:\s@\"]+)*)|(\".+\"))@((\[[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}\])|(([a-zA-Z\-0-9]+\.)+[a-zA-Z]{2,}))$/ + ); + if (!res) { + return this.do_notify(_("Email Validation Error"), + _("Please check your email syntax and try again"), true); + } + return true; + } + }); +}); diff --git a/report_async/static/src/xml/report_async.xml b/report_async/static/src/xml/report_async.xml new file mode 100644 index 0000000000..e46f91a98e --- /dev/null +++ b/report_async/static/src/xml/report_async.xml @@ -0,0 +1,34 @@ + + + +
+ +
+
+ + +
+ + Checker enables async report to be created on the background + via queue job and sent to a below email address. + +
+ +
+ + + + Email will be used to send the async report after queue job + is done on the background + +
+
+ + diff --git a/report_async/tests/test_report_async.py b/report_async/tests/test_report_async.py index b921534a27..9e0289abf9 100644 --- a/report_async/tests/test_report_async.py +++ b/report_async/tests/test_report_async.py @@ -1,47 +1,48 @@ # Copyright 2019 Ecosoft Co., Ltd (http://ecosoft.co.th/) # License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl.html) from odoo.tests import common -from odoo.tests.common import Form from odoo.exceptions import UserError class TestJobChannel(common.TransactionCase): - def setUp(self): super(TestJobChannel, self).setUp() - self.print_doc = self.env.ref('report_async.' - 'report_async_print_document') - self.test_rec = self.env.ref('base.module_mail') - self.test_rpt = self.env.ref('base.ir_module_reference_print') + self.print_doc = self.env.ref("report_async." "report_async_print_document") + self.test_rec = self.env.ref("base.module_mail") + self.test_rpt = self.env.ref("base.ir_module_reference_print") def _print_wizard(self, res): - obj = self.env[res['res_model']] - ctx = {'active_model': self.print_doc._name, - 'active_id': self.print_doc.id, } - ctx.update(res['context']) - with Form(obj.with_context(ctx)) as form: - form.reference = '%s,%s' % (self.test_rec._name, self.test_rec.id) - form.action_report_id = self.test_rpt - print_wizard = form.save() + obj = self.env[res["res_model"]] + ctx = {"active_model": self.print_doc._name, "active_id": self.print_doc.id} + ctx.update(res["context"]) + print_wizard = ( + self.env["print.report.wizard"] + .with_context(ctx) + .create( + { + "reference": "%s,%s" % (self.test_rec._name, self.test_rec.id), + "action_report_id": self.test_rpt.id, + } + ) + ) return print_wizard def test_1_run_now(self): """Run now will return report action as normal""" res = self.print_doc.run_now() report_action = self._print_wizard(res).print_report() - self.assertEquals(report_action['type'], 'ir.actions.report') + self.assertEquals(report_action["type"], "ir.actions.report.xml") def test_2_run_async(self): """Run background will return nothing, job started""" with self.assertRaises(UserError): self.print_doc.run_async() - self.print_doc.write({'allow_async': True, - 'email_notify': True}) + self.print_doc.write({"allow_async": True, "email_notify": True}) res = self.print_doc.run_async() print_wizard = self._print_wizard(res) report_action = print_wizard.print_report() self.assertEquals(report_action, {}) # Do not run report yet - self.assertEquals(self.print_doc.job_status, 'pending') # Job started + self.assertEquals(self.print_doc.job_status, "pending") # Job started # Test produce file (as queue will not run in test mode) docids = [print_wizard.reference.id] data = None diff --git a/report_async/views/assets.xml b/report_async/views/assets.xml new file mode 100644 index 0000000000..aa0da7aa2a --- /dev/null +++ b/report_async/views/assets.xml @@ -0,0 +1,9 @@ + + +
- % set base_url = object.env['ir.config_parameter'].sudo().get_param('web.base.url') + % set base_url_async = object.env['ir.config_parameter'].sudo().get_param('web.base.url.async_reports') + % set base_url = base_url_async or object.env['ir.config_parameter'].sudo().get_param('web.base.url') % set download_url = '%s/web/content/ir.attachment/%s/datas/%s?download=true' % (base_url, object.id, object.name, )
Dear ${object.create_uid.partner_id.name or ''}, @@ -26,7 +27,7 @@ Your requested report, ${object.name}, is available for download.

Have a nice day!
- --
${object.company_id.name} + --
${object.sudo().company_id.name}