diff --git a/report_async/__init__.py b/report_async/__init__.py new file mode 100644 index 0000000000..d5a964721a --- /dev/null +++ b/report_async/__init__.py @@ -0,0 +1,5 @@ +# Copyright 2019 Ecosoft Co., Ltd (http://ecosoft.co.th/) +# License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl.html) + +from . import models +from . import wizard diff --git a/report_async/__manifest__.py b/report_async/__manifest__.py new file mode 100644 index 0000000000..631ccd620f --- /dev/null +++ b/report_async/__manifest__.py @@ -0,0 +1,27 @@ +# 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": "14.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", + "views/assets.xml", + "data/mail_template.xml", + "data/queue_job_function_data.xml", + "views/report_async.xml", + "wizard/print_report_wizard.xml", + "views/ir_actions_report.xml" + ], + 'qweb': ['static/src/xml/report_async.xml'], + "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 new file mode 100644 index 0000000000..01ea4b9d52 --- /dev/null +++ b/report_async/data/mail_template.xml @@ -0,0 +1,73 @@ + + + + + Report Async: New Report Available + + Your report is available, ${object.name} + ${object.company_id.partner_id.email_formatted|safe} + ${user.partner_id.id} + + + + + +
+ + + + + + +
+ + + + +
+ % 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 ''}, +

+ Your requested report, ${object.name}, is available for + download + . +

+ Have a nice day!
+ --
${object.company_id.name} +
+
+
+
+ + + + + diff --git a/report_async/data/queue_job_function_data.xml b/report_async/data/queue_job_function_data.xml new file mode 100644 index 0000000000..e5b2a23fac --- /dev/null +++ b/report_async/data/queue_job_function_data.xml @@ -0,0 +1,6 @@ + + + + run_report + + diff --git a/report_async/demo/report_async_demo.xml b/report_async/demo/report_async_demo.xml new file mode 100644 index 0000000000..1a60a3874f --- /dev/null +++ b/report_async/demo/report_async_demo.xml @@ -0,0 +1,7 @@ + + + + + + + diff --git a/report_async/models/__init__.py b/report_async/models/__init__.py new file mode 100644 index 0000000000..5c58434bb3 --- /dev/null +++ b/report_async/models/__init__.py @@ -0,0 +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_report +from . import ir_actions +from . import queue_job diff --git a/report_async/models/ir_actions.py b/report_async/models/ir_actions.py new file mode 100644 index 0000000000..cbab3aa318 --- /dev/null +++ b/report_async/models/ir_actions.py @@ -0,0 +1,26 @@ +# Copyright 2019 Ecosoft Co., Ltd (http://ecosoft.co.th/) +# License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl.html) + +from odoo import api, models + + +class IrActionsActWindow(models.Model): + _inherit = "ir.actions.act_window" + + @api.model + def name_search(self, name, args=None, operator="ilike", limit=100): + if self._context.get("access_sudo", False): + self = self.sudo() + return super().name_search(name, args, operator, limit) + + @api.model + def search(self, args, offset=0, limit=None, order=None, count=False): + if self._context.get("access_sudo", False): + self = self.sudo() + return super().search(args, offset, limit, order, count) + + def _read(self, fields): + """ Add permission to read analytic account for do something. """ + if self._context.get("access_sudo", False): + self = self.sudo() + return super()._read(fields) diff --git a/report_async/models/ir_report.py b/report_async/models/ir_report.py new file mode 100644 index 0000000000..c3fd9cd630 --- /dev/null +++ b/report_async/models/ir_report.py @@ -0,0 +1,35 @@ +# Copyright 2019 Ecosoft Co., Ltd (http://ecosoft.co.th/) +# License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl.html) + +from odoo import models, fields + +# Define all supported report_type +REPORT_TYPES = ["qweb-pdf", "qweb-text", "qweb-xml", "csv", "excel", "xlsx"] + + +class Report(models.Model): + _inherit = "ir.actions.report" + + 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+" + ) + async_mail_recipient = fields.Char( + string="Mail Recipient", + help="The email that will receive the async report", + default=lambda self: self.env.user.email + ) + + 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: + report_async.with_delay().run_report( + 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..c584d58727 --- /dev/null +++ b/report_async/models/queue_job.py @@ -0,0 +1,28 @@ +# Copyright 2022 Sunflower IT (https://sunflowerweb.nl/) +# License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl.html) + +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 new file mode 100644 index 0000000000..aa5bba2e09 --- /dev/null +++ b/report_async/models/report_async.py @@ -0,0 +1,211 @@ +# Copyright 2019 Ecosoft Co., Ltd (http://ecosoft.co.th/) +# 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.exceptions import UserError +from odoo.tools.safe_eval import safe_eval + +_logger = logging.getLogger(__name__) + +# 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", +} + + +class ReportAsync(models.Model): + _name = "report.async" + _description = "Report Async" + + action_id = fields.Many2one( + comodel_name="ir.actions.act_window", + string="Reports", + required=True, + ) + allow_async = fields.Boolean( + 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", + ) + email_notify = fields.Boolean( + string="Email Notification", + help="Send email with link to report, when it is ready", + ) + group_ids = fields.Many2many( + 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", + 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", + help="Latest Job Status", + ) + job_info = fields.Text( + compute="_compute_job", + help="Latest Job Error Message", + ) + file_ids = fields.Many2many( + comodel_name="ir.attachment", + compute="_compute_file", + help="List all files created by this report background process", + ) + + 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 + + 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", + ) + for rec in self: + rec.file_ids = files.filtered(lambda l: l.res_id == rec.id) + + def run_now(self): + self.ensure_one() + action = self.env.ref(self.action_id.xml_id) + result = action.sudo().read()[0] + ctx = safe_eval(result.get("context", {})) + ctx.update({"async_process": False}) + result["context"] = ctx + return result + + def run_async(self): + self.ensure_one() + if not self.allow_async: + raise UserError(_("Background process not allowed.")) + action = self.env.ref(self.action_id.xml_id) + result = action.sudo().read()[0] + ctx = safe_eval(result.get("context", {})) + ctx.update({"async_process": True}) + result["context"] = ctx + return result + + def view_files(self): + self.ensure_one() + action = self.env.ref("report_async.action_view_files") + result = action.sudo().read()[0] + result["domain"] = [("id", "in", self.file_ids.ids)] + return result + + def view_jobs(self): + self.ensure_one() + action = self.env.ref("queue_job.action_queue_job") + result = action.sudo().read()[0] + 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['ir.actions.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 + 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"].browse(report_id) + func = REPORT_TYPES_FUNC[report.report_type] + if user_id: + report = report.with_user(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, file_ext = getattr(report, func)(docids, data) + else: + out_file, file_ext = getattr(report, func)(docids, data) + # Run report + out_file = base64.b64encode(out_file) + out_name = "{}.{}".format(report.name, file_ext) + _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, + "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), + ) + # Send email + if email_notify or self.email_notify: + self._send_email(attachment, to_email=to_email) + + 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, + notif_layout="mail.mail_notification_light", + force_send=False, + email_values=email_values + ) diff --git a/report_async/readme/CONTRIBUTORS.rst b/report_async/readme/CONTRIBUTORS.rst new file mode 100644 index 0000000000..d391cb73d0 --- /dev/null +++ b/report_async/readme/CONTRIBUTORS.rst @@ -0,0 +1,5 @@ +* `Ecosoft `__: + + * Kitti U. + * Saran Lim. + * Tharathip Chaweewongphan diff --git a/report_async/readme/DESCRIPTION.rst b/report_async/readme/DESCRIPTION.rst new file mode 100644 index 0000000000..b0c0f140a4 --- /dev/null +++ b/report_async/readme/DESCRIPTION.rst @@ -0,0 +1,16 @@ +The new menu "Report Center" is the central place to host your reports in one place. +From here, there are 2 ways to launch the report, + +1. Run Now - run report immediately as per normal. +2. Run Background - put the report execution to queue job. + +By using the queue job, option 2 is great for long running report. +The report file will be saved for later use, with the option to send report +by email as soon as it is ready. + +Notes: + +* Only user with Technical Feature rights can manage the report. +* Every internal user will have right to execute the report allowed for his/her groups. +* The files created are owned and viewable only by the person who run the report. +* Job queue manager can also see all jobs for each reports. diff --git a/report_async/readme/USAGE.rst b/report_async/readme/USAGE.rst new file mode 100644 index 0000000000..9668d579d2 --- /dev/null +++ b/report_async/readme/USAGE.rst @@ -0,0 +1,19 @@ +Menu: Dashboard > Report Center + +As Technical Feature users, you can manage reports for Report Center. + +- **Report:** choose the report (a window action). Although the option show all window actions + it only make sense for window actions that launch reports. +- **Allow Async:** check this, if you want the report to run in background too, suitable for + report that return file as result, i.e., pdf/xlsx/csv/txt. +- **Email Notification:** if checked, once the background process is completed, email with link to download + report will be sent. +- **Groups:** select user groups allowed to use this report. If left blank, all user can use. + +As normal user, you can run your reports from Report Center + +- **Run Now button:** to run report immediately as per normal. +- **Run Background button:** to run report asynchronously. Fall back to run now, if not report that produce file. +- **Job Status:** show status of the latest run job. If job fail, exception error will also shown +- **Files:** show all files being produced by the job as run by the user. +- **Jobs:** show all jobs triggered by this report as run by the user. Only job queue manager have access to this button. diff --git a/report_async/security/ir.model.access.csv b/report_async/security/ir.model.access.csv new file mode 100644 index 0000000000..6e84086764 --- /dev/null +++ b/report_async/security/ir.model.access.csv @@ -0,0 +1,4 @@ +"id","name","model_id:id","group_id:id","perm_read","perm_write","perm_create","perm_unlink" +access_report_async,report.async.user,model_report_async,base.group_user,1,0,0,0 +access_report_async_sudo,report.async.sudo,model_report_async,base.group_no_one,1,1,1,1 +access_print_report_wizard,print.report.wizard,model_print_report_wizard,base.group_user,1,1,1,1 diff --git a/report_async/security/ir_rule.xml b/report_async/security/ir_rule.xml new file mode 100644 index 0000000000..b551c92cba --- /dev/null +++ b/report_async/security/ir_rule.xml @@ -0,0 +1,25 @@ + + + + Report Async by Groups + + + + + + + ['|', ('group_ids', '=', False), ('group_ids', 'in', [g.id for g in user.groups_id])] + + + Report Async by Groups + + + + + + + [(1,'=', 1)] + + diff --git a/report_async/static/description/icon.png b/report_async/static/description/icon.png new file mode 100644 index 0000000000..3a0328b516 Binary files /dev/null and b/report_async/static/description/icon.png differ diff --git a/report_async/static/src/js/components/action_menus.js b/report_async/static/src/js/components/action_menus.js new file mode 100644 index 0000000000..d6198e5283 --- /dev/null +++ b/report_async/static/src/js/components/action_menus.js @@ -0,0 +1,107 @@ + +odoo.define('report_async.ActionMenus', function (require) { + "use strict"; + + const {patch} = require('web.utils'); + const ActionMenus = require('web.ActionMenus'); + const Dialog = require('web.Dialog'); + const Core = require('web.core'); + const Framework = require('web.framework'); + + const _t = Core._t; + const QWeb = Core.qweb; + + function validate_email(email) { + let 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 false; + } + return true; + } + + // Patch _executeAction to use Dialog + patch(ActionMenus, 'async _super report_async.ActionMenus', { + async _executeAction(action) { + let self = this; + let _super = this._super; + let args = arguments; // dict action + let records = this.props.activeIds; + var $content = $(QWeb.render("ReportAsyncConfiguration", {})); + + if (action.async_report && records.length >= action.async_no_records) { + let 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 () { + let is_report_async = this.$('#async_report_checker') + .prop('checked'); + let user_email = this.$('#async-user-email').val(); + if (user_email !== '' && is_report_async) { + // Try basic email validation + if (validate_email(user_email)) { + if ('report_type' in action && + action.report_type === 'qweb-pdf') { + Framework.unblockUI(); + // Generate report async + self.rpc({ + model: 'report.async', + method: 'print_document_async', + args: [records, action.report_name], + kwargs: { + to_email: user_email, + data: action.data || {}, + context: action.context || {} + } + }).then(()=> { + let msg = _t('Job started to generate report. Upon ' + + 'completion, mail sent to:') + + user_email; + Dialog.alert(self, msg, { + title: _t("Report"), + }); + }).catch(()=> { + let error = _t('Failed, error on job creation.'); + let title = _t('Report'); + Dialog.alert(self, + error, {title: title}); + }); + } + else { + // default to normal approach to generate report + return _super.apply(self, args); + } + } + else { + let msg = _t("Please check your email syntax and try again") + let title = _t("Email Validation Error"); + Dialog.alert(self, msg, {title: title}); + } + } + else { + // default to normal approach to generate report + return _super.apply(self, args); + } + }}, + { + text: _t("Discard"), + close: true + }], + $content: $content, + }); + // default current user mail + asyncDialog.open().opened(function () { + asyncDialog.$el.find("#async-user-email").val( + action.async_mail_recipient); + }); + } + else { + // default to normal approach to generate report + return _super.apply(this, arguments); + } + }, + }); +}) 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/__init__.py b/report_async/tests/__init__.py new file mode 100644 index 0000000000..86bbfd13b2 --- /dev/null +++ b/report_async/tests/__init__.py @@ -0,0 +1 @@ +from . import test_report_async diff --git a/report_async/tests/test_report_async.py b/report_async/tests/test_report_async.py new file mode 100644 index 0000000000..545a363606 --- /dev/null +++ b/report_async/tests/test_report_async.py @@ -0,0 +1,55 @@ +# Copyright 2019 Ecosoft Co., Ltd (http://ecosoft.co.th/) +# License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl.html) +from odoo.exceptions import UserError +from odoo.tests import common +from odoo.tests.common import Form + + +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") + + 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 = "{},{}".format(self.test_rec._name, self.test_rec.id) + form.action_report_id = self.test_rpt + print_wizard = form.save() + 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") + + 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}) + 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 + # Test produce file (as queue will not run in test mode) + docids = [print_wizard.reference.id] + data = None + report_id = self.test_rpt.id + user_id = self.env.user.id + self.print_doc.run_report(docids, data, report_id, user_id) + # Check name of the newly producted file + # Note: on env with test-enable, always fall back to render_qweb_html + self.assertIn(self.test_rpt.name, self.print_doc.file_ids[0].name) + # View fileds/jobs + self.print_doc.view_files() + self.print_doc.view_jobs() diff --git a/report_async/views/assets.xml b/report_async/views/assets.xml new file mode 100644 index 0000000000..f5f71ce127 --- /dev/null +++ b/report_async/views/assets.xml @@ -0,0 +1,10 @@ + + + + diff --git a/report_async/views/ir_actions_report.xml b/report_async/views/ir_actions_report.xml new file mode 100644 index 0000000000..119ad6f4e9 --- /dev/null +++ b/report_async/views/ir_actions_report.xml @@ -0,0 +1,17 @@ + + + + async_report_view + ir.actions.report + + + + + + + + + + + + diff --git a/report_async/views/report_async.xml b/report_async/views/report_async.xml new file mode 100644 index 0000000000..4068565431 --- /dev/null +++ b/report_async/views/report_async.xml @@ -0,0 +1,178 @@ + + + + report.async.tree + report.async + + + +