Merge PR #568 into 14.0

Signed-off-by HviorForgeFlow
pull/612/head
OCA-git-bot 2022-04-13 15:06:38 +00:00
commit f0aaa4ae15
24 changed files with 741 additions and 0 deletions

View File

@ -1 +1,2 @@
server-tools
queue

View File

@ -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

View File

@ -0,0 +1,24 @@
# 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",
"data/mail_template.xml",
"data/queue_job_function_data.xml",
"views/report_async.xml",
"wizard/print_report_wizard.xml",
],
"demo": ["demo/report_async_demo.xml"],
"installable": True,
"maintainers": ["kittiu"],
"development_status": "Beta",
}

View File

@ -0,0 +1,72 @@
<?xml version="1.0" encoding="utf-8" ?>
<odoo>
<data noupdate="1">
<record id="async_report_delivery" model="mail.template">
<field name="name">Report Async: New Report Available</field>
<field name="model_id" ref="base.model_ir_attachment" />
<field name="subject">Your report is available, ${object.name}</field>
<field
name="email_from"
>${object.company_id.partner_id.email_formatted|safe}</field>
<field name="partner_to">${user.partner_id.id}</field>
<field name="body_html" type="html">
<table
border="0"
cellpadding="0"
cellspacing="0"
style="background-color: #F1F1F1; font-family:Verdana, Arial,sans-serif; color: #454748; width: 100%; border-collapse:separate;"
>
<tr>
<td align="center">
<table
border="0"
cellpadding="0"
cellspacing="0"
width="590"
style="padding: 16px; background-color: white; color: #454748; border-collapse:separate;"
>
<tbody>
<tr>
<td align="center" style="min-width: 590px;">
<table
border="0"
cellpadding="0"
cellspacing="0"
width="590"
style="min-width: 590px; background-color: white; padding: 0px 8px 0px 8px; border-collapse:separate;"
>
<tr>
<td
valign="top"
style="font-size: 13px;"
>
% set base_url = 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, )
<div>
Dear ${object.create_uid.partner_id.name or ''},
<br /><br />
Your requested report, ${object.name}, is available for <b
>
<a
href='${download_url}'
>download</a>
</b>.
<br /><br />
Have a nice day!<br />
--<br />${object.company_id.name}
</div>
</td>
</tr>
</table>
</td>
</tr>
</tbody>
</table>
</td>
</tr>
</table>
</field>
<field name="auto_delete" eval="True" />
</record>
</data>
</odoo>

View File

@ -0,0 +1,6 @@
<odoo noupdate="1">
<record id="job_function_report_async_run_report" model="queue.job.function">
<field name="model_id" ref="report_async.model_report_async" />
<field name="method">run_report</field>
</record>
</odoo>

View File

@ -0,0 +1,7 @@
<?xml version="1.0" encoding="UTF-8" ?>
<odoo>
<record id="report_async_print_document" model="report.async">
<field name="action_id" eval="ref('report_async.action_print_report_wizard')" />
<field name="allow_async" eval="0" />
</record>
</odoo>

View File

@ -0,0 +1,6 @@
# 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

View File

@ -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)

View File

@ -0,0 +1,23 @@
# 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
# Define all supported report_type
REPORT_TYPES = ["qweb-pdf", "qweb-text", "qweb-xml", "csv", "excel", "xlsx"]
class Report(models.Model):
_inherit = "ir.actions.report"
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

View File

@ -0,0 +1,175 @@
# Copyright 2019 Ecosoft Co., Ltd (http://ecosoft.co.th/)
# License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl.html)
import base64
from odoo import _, api, fields, models
from odoo.exceptions import UserError
from odoo.tools.safe_eval import safe_eval
# 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 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)
out_file = base64.b64encode(out_file)
out_name = "{}.{}".format(report.name, file_ext)
# 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 self.email_notify:
self._send_email(attachment)
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
)

View File

@ -0,0 +1,5 @@
* `Ecosoft <http://ecosoft.co.th>`__:
* Kitti U. <kittiu@ecosoft.co.th>
* Saran Lim. <saranl@ecosoft.co.th>
* Tharathip Chaweewongphan <tharathipc@ecosoft.co.th>

View File

@ -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.

View File

@ -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.

View File

@ -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
1 id name model_id:id group_id:id perm_read perm_write perm_create perm_unlink
2 access_report_async report.async.user model_report_async base.group_user 1 0 0 0
3 access_report_async_sudo report.async.sudo model_report_async base.group_no_one 1 1 1 1
4 access_print_report_wizard print.report.wizard model_print_report_wizard base.group_user 1 1 1 1

View File

@ -0,0 +1,25 @@
<?xml version="1.0" encoding="utf-8" ?>
<odoo>
<record id="rule_report_async_access_by_group" model="ir.rule">
<field name="name">Report Async by Groups</field>
<field name="model_id" ref="model_report_async" />
<field name="groups" eval="[(4, ref('base.group_user'))]" />
<field name="perm_read" eval="True" />
<field name="perm_create" eval="False" />
<field name="perm_write" eval="False" />
<field name="perm_unlink" eval="False" />
<field
name="domain_force"
>['|', ('group_ids', '=', False), ('group_ids', 'in', [g.id for g in user.groups_id])]</field>
</record>
<record id="rule_report_async_access_all" model="ir.rule">
<field name="name">Report Async by Groups</field>
<field name="model_id" ref="model_report_async" />
<field name="groups" eval="[(4, ref('base.group_no_one'))]" />
<field name="perm_read" eval="True" />
<field name="perm_create" eval="True" />
<field name="perm_write" eval="True" />
<field name="perm_unlink" eval="True" />
<field name="domain_force">[(1,'=', 1)]</field>
</record>
</odoo>

Binary file not shown.

After

Width:  |  Height:  |  Size: 9.2 KiB

View File

@ -0,0 +1 @@
from . import test_report_async

View File

@ -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()

View File

@ -0,0 +1,178 @@
<?xml version="1.0" encoding="utf-8" ?>
<odoo>
<record id="view_report_async_tree" model="ir.ui.view">
<field name="name">report.async.tree</field>
<field name="model">report.async</field>
<field name="arch" type="xml">
<tree string="Report Center">
<field name="action_id" context="{'access_sudo': True}" />
<button type="object" name="run_now" string="Run Now" icon="fa-bolt" />
<button
type="object"
name="run_async"
string="Run Background"
icon="fa-cogs"
attrs="{'invisible': [('allow_async', '=', False)]}"
/>
<button
type="object"
name="view_files"
string="Files"
icon="fa-copy"
attrs="{'invisible': [('allow_async', '=', False)]}"
/>
<field name="allow_async" invisible="1" />
<field
name="job_status"
attrs="{'invisible': [('allow_async', '=', False)]}"
/>
<field name="email_notify" />
</tree>
</field>
</record>
<record id="view_report_async_form" model="ir.ui.view">
<field name="name">report.async.form</field>
<field name="model">report.async</field>
<field name="arch" type="xml">
<form>
<div
class="alert alert-warning"
role="alert"
attrs="{'invisible': ['|', ('job_status', 'in', ['done', 'failed', False]),
('allow_async', '=', False)]}"
style="margin-bottom:0px;"
>
<p>
The report will be running by <i class="fa fa-cogs" />
<b>job</b>, and will be available at
<i class="fa fa-copy" /><b> Files</b>
</p>
</div>
<div
class="alert alert-danger"
role="alert"
attrs="{'invisible': ['|', ('job_status', '!=', 'failed'),
('allow_async', '=', False)]}"
style="margin-bottom:0px;"
>
<p>
The last <i class="fa fa-cogs" /> <b>running job</b> was failed.
Please contact your system administrator.
</p>
</div>
<div
class="alert alert-success"
role="alert"
attrs="{'invisible': ['|', ('job_status', '!=', 'done'),
('allow_async', '=', False)]}"
style="margin-bottom:0px;"
>
<p>
The last <i class="fa fa-cogs" /> <b
>running job</b> was succeed.
You can check the result in <i class="fa fa-copy" /><b
> Files</b>
</p>
</div>
<sheet>
<div class="oe_read_only oe_right oe_button_box" name="buttons">
<button
type="object"
name="run_now"
string="Run Now"
icon="fa-bolt"
/>
<button
type="object"
name="run_async"
string="Run Background"
icon="fa-cogs"
attrs="{'invisible': [('allow_async', '=', False)]}"
/>
<button
type="object"
name="view_files"
string="Files"
icon="fa-copy"
attrs="{'invisible': [('allow_async', '=', False)]}"
/>
<button
type="object"
name="view_jobs"
string="Jobs"
icon="fa-align-justify"
groups="queue_job.group_queue_job_manager"
attrs="{'invisible': [('allow_async', '=', False)]}"
/>
</div>
<group>
<group>
<field
name="action_id"
options="{'no_open': True, 'no_create_edit': True}"
context="{'access_sudo': True}"
/>
<field name="allow_async" />
<field
name="email_notify"
attrs="{'invisible': [('allow_async', '=', False)]}"
/>
</group>
<group>
<field
name="job_status"
attrs="{'invisible': [('allow_async', '=', False)]}"
/>
<field name="group_ids" widget="many2many_tags" />
</group>
<group
name="job_info"
string="Last Run Job Error"
colspan="2"
attrs="{'invisible': ['|', ('job_info', '=', False), ('allow_async', '=', False)]}"
>
<field nolabel="1" name="job_info" />
</group>
</group>
</sheet>
</form>
</field>
</record>
<record id="view_report_async_search" model="ir.ui.view">
<field name="name">report.async.search</field>
<field name="model">report.async</field>
<field name="arch" type="xml">
<search string="Report Center">
<field name="action_id" />
</search>
</field>
</record>
<record id="action_report_async" model="ir.actions.act_window">
<field name="name">Report Center</field>
<field name="type">ir.actions.act_window</field>
<field name="res_model">report.async</field>
<field name="help">Run reports asyncronously</field>
</record>
<menuitem
id="menu_report_async"
parent="base.menu_board_root"
action="action_report_async"
sequence="10"
/>
<record id="action_view_files" model="ir.actions.act_window">
<field name="name">Report Files</field>
<field name="type">ir.actions.act_window</field>
<field name="res_model">ir.attachment</field>
<field name="view_id" eval="False" />
<field name="search_view_id" ref="base.view_attachment_search" />
<field name="view_mode">kanban,tree,form</field>
<field
name="domain"
>[('res_model', '=', 'report.async'), ('create_uid', '=', uid)]</field>
<field name="help" type="html">
<p class="o_view_nocontent_smiling_face">
No files found
</p>
</field>
</record>
</odoo>

View File

@ -0,0 +1,4 @@
# Copyright 2019 Ecosoft Co., Ltd (http://ecosoft.co.th/)
# License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl.html)
from . import print_report_wizard

View File

@ -0,0 +1,45 @@
# 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, fields, models
class PrintReportWizard(models.TransientModel):
_name = "print.report.wizard"
_description = "Print Report Wizard"
reference = fields.Reference(
string="Document",
selection="_reference_models",
required=True,
)
action_report_id = fields.Many2one(
comodel_name="ir.actions.report",
string="Report Template",
required=True,
)
@api.model
def _reference_models(self):
excludes = ["res.company"]
models = self.env["ir.model"].search(
[
("state", "!=", "manual"),
("transient", "=", False),
("model", "not in", excludes),
]
)
return [(model.model, model.name) for model in models]
@api.onchange("reference")
def _onchange_reference(self):
self.ensure_one()
domain = [("id", "in", [])]
self.action_report_id = False
if self.reference:
domain = [("model", "=", self.reference._name)]
return {"domain": {"action_report_id": domain}}
def print_report(self):
self.ensure_one()
return self.action_report_id.report_action(self.reference, config=False)

View File

@ -0,0 +1,37 @@
<?xml version="1.0" encoding="UTF-8" ?>
<odoo>
<record id="print_report_wizard" model="ir.ui.view">
<field name="name">print.report.wizard</field>
<field name="model">print.report.wizard</field>
<field name="arch" type="xml">
<form>
<group>
<group>
<field name="reference" />
</group>
<group>
<field
name="action_report_id"
options="{'no_open': True, 'no_create_edit': True}"
/>
</group>
</group>
<footer>
<button
name="print_report"
type="object"
string="Execute"
class="oe_highlight"
/>
<button special="cancel" string="Cancel" />
</footer>
</form>
</field>
</record>
<record id="action_print_report_wizard" model="ir.actions.act_window">
<field name="name">Print Document</field>
<field name="res_model">print.report.wizard</field>
<field name="view_mode">form</field>
<field name="target">new</field>
</record>
</odoo>

View File

@ -0,0 +1 @@
../../../../report_async

View File

@ -0,0 +1,6 @@
import setuptools
setuptools.setup(
setup_requires=['setuptools-odoo'],
odoo_addon=True,
)