Techsystech
/
OCA_Reporting_engine_17.0
3
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

[MIG] report_qweb_encrypt: Migration to 16.0

pull/779/head
payen000 2023-08-03 09:00:52 -07:00
parent 484b258f1f
commit 065973ebd0
7 changed files with 55 additions and 44 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
report_qweb_encrypt/__manifest__.py
View File

@ -5,7 +5,7 @@
{
"name": "Report Qweb Encrypt",
"summary": "Allow to encrypt qweb pdfs",
"version": "15.0.1.0.0",
"version": "16.0.1.0.0",
"license": "AGPL-3",
"author": "Creu Blanca,Ecosoft,Odoo Community Association (OCA)",
"website": "https://github.com/OCA/reporting-engine",
@ -17,12 +17,10 @@
],
"assets": {
"web.assets_backend": [
"report_qweb_encrypt/static/src/js/report/action_manager_report.esm.js",
"report_qweb_encrypt/static/src/report/action_manager_report.esm.js",
"report_qweb_encrypt/static/src/report/encrypt_dialog.xml",
],
},
"external_dependencies": {
"python": ["PyPDF2"] # Python third party libraries required for module
},
"installable": True,
"maintainers": ["kittiu"],
}

6
report_qweb_encrypt/controllers/main.py
View File

@ -7,13 +7,13 @@ from werkzeug.urls import url_decode
from odoo.http import request, route
from odoo.addons.web.controllers import main as report
from odoo.addons.web.controllers.report import ReportController
class ReportController(report.ReportController):
class ReportControllerEncrypt(ReportController):
@route()
def report_download(self, data, context=None):
result = super(ReportController, self).report_download(data, context=context)
result = super().report_download(data, context=context)
# When report is downloaded from print action, this function is called,
# but this function cannot pass context (manually entered password) to
# report.render_qweb_pdf(), encrypton for manual password is done here.

18
report_qweb_encrypt/models/ir_actions_report.py
View File

@ -25,12 +25,16 @@ class IrActionsReport(models.Model):
help="Python code syntax to gnerate password.",
)
def _render_qweb_pdf(self, res_ids=None, data=None):
document, ttype = super(IrActionsReport, self)._render_qweb_pdf(
res_ids=res_ids, data=data
def _render_qweb_pdf(self, reportname, res_ids=None, data=None):
document, ttype = super()._render_qweb_pdf(
reportname, res_ids=res_ids, data=data
)
if res_ids:
password = self._get_pdf_password(res_ids[:1])
encrypt_password = self._context.get("encrypt_password")
report = self._get_report_from_name(reportname).with_context(
encrypt_password=encrypt_password
)
password = report._get_pdf_password(res_ids[:1])
document = self._encrypt_pdf(document, password)
return document, ttype
@ -55,8 +59,10 @@ class IrActionsReport(models.Model):
)
except Exception as e:
raise ValidationError(
_("Python code used for encryption password is invalid.\n%s")
% self.encrypt_password
_(
"Python code used for encryption password is invalid.\n%s",
self.encrypt_password,
)
) from e
return encrypt_password

13
report_qweb_encrypt/static/src/js/report/encrypt_dialog.xml
View File

@ -1,13 +0,0 @@
<?xml version="1.0" encoding="UTF-8" ?>
<templates xml:space="preserve">
<t t-name="report_qweb_encrypt.EncryptDialogFooter" owl="1">
<button class="btn btn-primary" t-on-click="onClick">Ok</button>
<button class="btn" t-on-click="close">Cancel</button>
</t>
<t t-name="report_qweb_encrypt.EncryptDialogBody" owl="1">
<div><input class="o_password" type="password" /></div>
</t>
</templates>

24
report_qweb_encrypt/static/src/js/report/action_manager_report.esm.js → report_qweb_encrypt/static/src/report/action_manager_report.esm.js
View File

@ -3,11 +3,15 @@
import {Dialog} from "@web/core/dialog/dialog";
import {download} from "@web/core/network/download";
import {registry} from "@web/core/registry";
const {Component} = owl;
async function download_function(action, options, env) {
const type = action.report_type;
const type = action.report_type === "qweb-pdf" ? "pdf" : action.report_type;
let url = `/report/${type}/${action.report_name}`;
const actionContext = action.context || {};
const userContext = Object.assign(env.services.user.context, {
encrypt_password: action.context.encrypt_password,
});
if (action.data && JSON.stringify(action.data) !== "{}") {
// Build a query string with `action.data` (it's the place where reports
// using a wizard to customize the output traditionally put their options)
@ -19,9 +23,7 @@ async function download_function(action, options, env) {
url += `/${actionContext.active_ids.join(",")}`;
}
if (type === "html") {
const context = encodeURIComponent(
JSON.stringify(env.services.user.context)
);
const context = encodeURIComponent(JSON.stringify(userContext));
url += `?context=${context}`;
}
}
@ -31,7 +33,7 @@ async function download_function(action, options, env) {
url: "/report/download",
data: {
data: JSON.stringify([url, action.report_type]),
context: JSON.stringify(env.services.user.context),
context: JSON.stringify(userContext),
},
});
} finally {
@ -49,19 +51,19 @@ async function download_function(action, options, env) {
return Promise.resolve(true);
}
class EncryptDialog extends Dialog {
class EncryptDialog extends Component {
onClick() {
const action = this.props.action;
action.context = _.extend({}, action.context, {
encrypt_password: this.el.find(".o_password").val() || false,
encrypt_password:
$("#qweb_encrypt_pdf_password > .o_password").val() || false,
});
return download_function(action, this.props.options, this.props.env);
}
}
EncryptDialog.size = "small";
EncryptDialog.title = "Encrypt";
EncryptDialog.bodyTemplate = "report_qweb_encrypt.EncryptDialogBody";
EncryptDialog.footerTemplate = "report_qweb_encrypt.EncryptDialogFooter";
EncryptDialog.components = {Dialog};
EncryptDialog.template = "report_qweb_encrypt.EncryptDialogBody";
registry
.category("ir.actions.report handlers")

16
report_qweb_encrypt/static/src/report/encrypt_dialog.xml 100644
View File

@ -0,0 +1,16 @@
<?xml version="1.0" encoding="UTF-8" ?>
<templates xml:space="preserve">
<t t-name="report_qweb_encrypt.EncryptDialogBody" owl="1">
<Dialog size="'sm'" title="'Encrypt'">
<div id="qweb_encrypt_pdf_password">
<input class="o_password" type="password" />
</div>
<t t-set-slot="footer">
<button class="btn btn-primary" t-on-click="onClick">Ok</button>
<button class="btn" t-on-click="this.props.close">Cancel</button>
</t>
</Dialog>
</t>
</templates>

14
report_qweb_encrypt/tests/test_report_qweb_encrypt.py
View File

@ -9,7 +9,7 @@ class TestReportQwebEncrypt(HttpCase):
ctx = {"force_report_rendering": True}
report = self.env.ref("web.action_report_internalpreview")
report.encrypt = False
pdf, _ = report.with_context(**ctx)._render_qweb_pdf([1])
pdf, _ = report.with_context(**ctx)._render_qweb_pdf(report.report_name, [1])
self.assertFalse(pdf.count(b"/Encrypt"))
def test_report_qweb_auto_encrypt(self):
@ -19,17 +19,19 @@ class TestReportQwebEncrypt(HttpCase):
report.encrypt_password = False
# If no encrypt_password, still not encrypted
pdf, _ = report.with_context(**ctx)._render_qweb_pdf([1])
pdf, _ = report.with_context(**ctx)._render_qweb_pdf(report.report_name, [1])
self.assertFalse(pdf.count(b"/Encrypt"))
# If invalid encrypt_password, show error
report.encrypt_password = "invalid python syntax"
with self.assertRaises(ValidationError):
pdf, _ = report.with_context(**ctx)._render_qweb_pdf([1])
pdf, _ = report.with_context(**ctx)._render_qweb_pdf(
report.report_name, [1]
)
# Valid python string for password
report.encrypt_password = "'secretcode'"
pdf, _ = report.with_context(**ctx)._render_qweb_pdf([1])
pdf, _ = report.with_context(**ctx)._render_qweb_pdf(report.report_name, [1])
self.assertTrue(pdf.count(b"/Encrypt"))
def test_report_qweb_manual_encrypt(self):
@ -38,12 +40,12 @@ class TestReportQwebEncrypt(HttpCase):
report.encrypt = "manual"
# If no encrypt_password, still not encrypted
pdf, _ = report.with_context(**ctx)._render_qweb_pdf([1])
pdf, _ = report.with_context(**ctx)._render_qweb_pdf(report.report_name, [1])
self.assertFalse(pdf.count(b"/Encrypt"))
# Valid python string for password
ctx.update({"encrypt_password": "secretcode"})
pdf, _ = report.with_context(**ctx)._render_qweb_pdf([1])
pdf, _ = report.with_context(**ctx)._render_qweb_pdf(report.report_name, [1])
self.assertTrue(pdf.count(b"/Encrypt"))
# TODO: test_report_qweb_manual_encrypt, require JS test?