diff --git a/document_page_reference/README.rst b/document_page_reference/README.rst new file mode 100644 index 00000000..2eaacbb8 --- /dev/null +++ b/document_page_reference/README.rst @@ -0,0 +1,92 @@ +======================= +Document Page Reference +======================= + +.. + !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! + !! This file is generated by oca-gen-addon-readme !! + !! changes will be overwritten. !! + !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! + !! source digest: sha256:ead414b479ae1108c68fadb93a675584c882eb76c59617f82296e9f3570df6ab + !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! + +.. |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%2Fknowledge-lightgray.png?logo=github + :target: https://github.com/OCA/knowledge/tree/18.0/document_page_reference + :alt: OCA/knowledge +.. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png + :target: https://translation.odoo-community.org/projects/knowledge-18-0/knowledge-18-0-document_page_reference + :alt: Translate me on Weblate +.. |badge5| image:: https://img.shields.io/badge/runboat-Try%20me-875A7B.png + :target: https://runboat.odoo-community.org/builds?repo=OCA/knowledge&target_branch=18.0 + :alt: Try me on Runboat + +|badge1| |badge2| |badge3| |badge4| |badge5| + +This module allows to add a reference name on documents and simplifies +the link between document pages. + +**Table of contents** + +.. contents:: + :local: + +Usage +===== + +When editing a document page add elements like ${XXX} where XXX is the +reference of another page. Now, when viewing the document, it will link +directly to the page. Also, the name will be parsed as the display name. + +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 to smash 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 + +Maintainers +----------- + +This module is maintained by the OCA. + +.. image:: https://odoo-community.org/logo.png + :alt: Odoo Community Association + :target: https://odoo-community.org + +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. + +.. |maintainer-etobella| image:: https://github.com/etobella.png?size=40px + :target: https://github.com/etobella + :alt: etobella + +Current `maintainer `__: + +|maintainer-etobella| + +This module is part of the `OCA/knowledge `_ project on GitHub. + +You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute. diff --git a/document_page_reference/__init__.py b/document_page_reference/__init__.py new file mode 100644 index 00000000..0650744f --- /dev/null +++ b/document_page_reference/__init__.py @@ -0,0 +1 @@ +from . import models diff --git a/document_page_reference/__manifest__.py b/document_page_reference/__manifest__.py new file mode 100644 index 00000000..988fc223 --- /dev/null +++ b/document_page_reference/__manifest__.py @@ -0,0 +1,23 @@ +# Copyright 2019 Creu Blanca +# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl). + +{ + "name": "Document Page Reference", + "summary": """ + Include references on document pages""", + "version": "18.0.1.0.0", + "license": "AGPL-3", + "author": "Creu Blanca,Odoo Community Association (OCA)", + "website": "https://github.com/OCA/knowledge", + "depends": ["document_page"], + "data": [ + "views/document_page.xml", + "views/report_document_page.xml", + ], + "assets": { + "web.assets_backend": [ + "document_page_reference/static/src/js/editor.esm.js", + ], + }, + "maintainers": ["etobella"], +} diff --git a/document_page_reference/i18n/document_page_reference.pot b/document_page_reference/i18n/document_page_reference.pot new file mode 100644 index 00000000..5c67b64f --- /dev/null +++ b/document_page_reference/i18n/document_page_reference.pot @@ -0,0 +1,53 @@ +# Translation of Odoo Server. +# This file contains the translation of the following modules: +# * document_page_reference +# +msgid "" +msgstr "" +"Project-Id-Version: Odoo Server 16.0\n" +"Report-Msgid-Bugs-To: \n" +"Last-Translator: \n" +"Language-Team: \n" +"MIME-Version: 1.0\n" +"Content-Type: text/plain; charset=UTF-8\n" +"Content-Transfer-Encoding: \n" +"Plural-Forms: \n" + +#. module: document_page_reference +#: model:ir.model.fields,field_description:document_page_reference.field_document_page__content_parsed +msgid "Content Parsed" +msgstr "" + +#. module: document_page_reference +#: model:ir.model,name:document_page_reference.model_document_page +msgid "Document Page" +msgstr "" + +#. module: document_page_reference +#: model:ir.model.fields,field_description:document_page_reference.field_document_page__reference +msgid "Reference" +msgstr "" + +#. module: document_page_reference +#. odoo-python +#: code:addons/document_page_reference/models/document_page.py:0 +#, python-format +msgid "Reference is not valid" +msgstr "" + +#. module: document_page_reference +#. odoo-python +#: code:addons/document_page_reference/models/document_page.py:0 +#, python-format +msgid "Reference must be unique" +msgstr "" + +#. module: document_page_reference +#: model:ir.model.fields,help:document_page_reference.field_document_page__reference +msgid "Used to find the document, it can contain letters, numbers and _" +msgstr "" + +#. module: document_page_reference +#: model_terms:ir.ui.view,arch_db:document_page_reference.document_page_form_view +msgid "internal_reference (autofilled if not value is provided)" +msgstr "" diff --git a/document_page_reference/i18n/es.po b/document_page_reference/i18n/es.po new file mode 100644 index 00000000..a28e13ee --- /dev/null +++ b/document_page_reference/i18n/es.po @@ -0,0 +1,57 @@ +# Translation of Odoo Server. +# This file contains the translation of the following modules: +# * document_page_reference +# +msgid "" +msgstr "" +"Project-Id-Version: Odoo Server 16.0\n" +"Report-Msgid-Bugs-To: \n" +"PO-Revision-Date: 2023-09-05 22:41+0000\n" +"Last-Translator: Ivorra78 \n" +"Language-Team: none\n" +"Language: es\n" +"MIME-Version: 1.0\n" +"Content-Type: text/plain; charset=UTF-8\n" +"Content-Transfer-Encoding: \n" +"Plural-Forms: nplurals=2; plural=n != 1;\n" +"X-Generator: Weblate 4.17\n" + +#. module: document_page_reference +#: model:ir.model.fields,field_description:document_page_reference.field_document_page__content_parsed +msgid "Content Parsed" +msgstr "Contenido procesado" + +#. module: document_page_reference +#: model:ir.model,name:document_page_reference.model_document_page +msgid "Document Page" +msgstr "Página de Documento" + +#. module: document_page_reference +#: model:ir.model.fields,field_description:document_page_reference.field_document_page__reference +msgid "Reference" +msgstr "Referencia" + +#. module: document_page_reference +#. odoo-python +#: code:addons/document_page_reference/models/document_page.py:0 +#, python-format +msgid "Reference is not valid" +msgstr "La referencia no es válida" + +#. module: document_page_reference +#. odoo-python +#: code:addons/document_page_reference/models/document_page.py:0 +#, python-format +msgid "Reference must be unique" +msgstr "La referencia debe ser única" + +#. module: document_page_reference +#: model:ir.model.fields,help:document_page_reference.field_document_page__reference +msgid "Used to find the document, it can contain letters, numbers and _" +msgstr "" +"Se utiliza para encontrar el documento, puede contener letras, números y _" + +#. module: document_page_reference +#: model_terms:ir.ui.view,arch_db:document_page_reference.document_page_form_view +msgid "internal_reference (autofilled if not value is provided)" +msgstr "internal_reference (autocompletado si no se proporciona ningún valor)" diff --git a/document_page_reference/i18n/it.po b/document_page_reference/i18n/it.po new file mode 100644 index 00000000..f49d8126 --- /dev/null +++ b/document_page_reference/i18n/it.po @@ -0,0 +1,56 @@ +# Translation of Odoo Server. +# This file contains the translation of the following modules: +# * document_page_reference +# +msgid "" +msgstr "" +"Project-Id-Version: Odoo Server 15.0\n" +"Report-Msgid-Bugs-To: \n" +"PO-Revision-Date: 2023-06-23 10:10+0000\n" +"Last-Translator: mymage \n" +"Language-Team: none\n" +"Language: it\n" +"MIME-Version: 1.0\n" +"Content-Type: text/plain; charset=UTF-8\n" +"Content-Transfer-Encoding: \n" +"Plural-Forms: nplurals=2; plural=n != 1;\n" +"X-Generator: Weblate 4.17\n" + +#. module: document_page_reference +#: model:ir.model.fields,field_description:document_page_reference.field_document_page__content_parsed +msgid "Content Parsed" +msgstr "Contenuto analizzato" + +#. module: document_page_reference +#: model:ir.model,name:document_page_reference.model_document_page +msgid "Document Page" +msgstr "Pagina documento" + +#. module: document_page_reference +#: model:ir.model.fields,field_description:document_page_reference.field_document_page__reference +msgid "Reference" +msgstr "Riferimento" + +#. module: document_page_reference +#. odoo-python +#: code:addons/document_page_reference/models/document_page.py:0 +#, python-format +msgid "Reference is not valid" +msgstr "Il riferimento non è valido" + +#. module: document_page_reference +#. odoo-python +#: code:addons/document_page_reference/models/document_page.py:0 +#, python-format +msgid "Reference must be unique" +msgstr "Il riferimento deve essere unico" + +#. module: document_page_reference +#: model:ir.model.fields,help:document_page_reference.field_document_page__reference +msgid "Used to find the document, it can contain letters, numbers and _" +msgstr "Utilizzato per trovare il documento, può contenere lettere, numeri e _" + +#. module: document_page_reference +#: model_terms:ir.ui.view,arch_db:document_page_reference.document_page_form_view +msgid "internal_reference (autofilled if not value is provided)" +msgstr "internal_reference (auto compilato se non viene fornito un valore)" diff --git a/document_page_reference/i18n/pt.po b/document_page_reference/i18n/pt.po new file mode 100644 index 00000000..39eacaca --- /dev/null +++ b/document_page_reference/i18n/pt.po @@ -0,0 +1,57 @@ +# Translation of Odoo Server. +# This file contains the translation of the following modules: +# * document_page_reference +# +msgid "" +msgstr "" +"Project-Id-Version: Odoo Server 16.0\n" +"Report-Msgid-Bugs-To: \n" +"PO-Revision-Date: 2024-02-28 21:33+0000\n" +"Last-Translator: Peter Romão \n" +"Language-Team: none\n" +"Language: pt\n" +"MIME-Version: 1.0\n" +"Content-Type: text/plain; charset=UTF-8\n" +"Content-Transfer-Encoding: \n" +"Plural-Forms: nplurals=2; plural=n > 1;\n" +"X-Generator: Weblate 4.17\n" + +#. module: document_page_reference +#: model:ir.model.fields,field_description:document_page_reference.field_document_page__content_parsed +msgid "Content Parsed" +msgstr "Conteúdo Analisado" + +#. module: document_page_reference +#: model:ir.model,name:document_page_reference.model_document_page +msgid "Document Page" +msgstr "Página do documento" + +#. module: document_page_reference +#: model:ir.model.fields,field_description:document_page_reference.field_document_page__reference +msgid "Reference" +msgstr "Referência" + +#. module: document_page_reference +#. odoo-python +#: code:addons/document_page_reference/models/document_page.py:0 +#, python-format +msgid "Reference is not valid" +msgstr "A referência não é válida" + +#. module: document_page_reference +#. odoo-python +#: code:addons/document_page_reference/models/document_page.py:0 +#, python-format +msgid "Reference must be unique" +msgstr "A referência deve ser única" + +#. module: document_page_reference +#: model:ir.model.fields,help:document_page_reference.field_document_page__reference +msgid "Used to find the document, it can contain letters, numbers and _" +msgstr "Usado para encontrar o documento, pode conter letras, números e _" + +#. module: document_page_reference +#: model_terms:ir.ui.view,arch_db:document_page_reference.document_page_form_view +msgid "internal_reference (autofilled if not value is provided)" +msgstr "" +"internal_reference (preenchimento automático se o valor não for fornecido)" diff --git a/document_page_reference/models/__init__.py b/document_page_reference/models/__init__.py new file mode 100644 index 00000000..427be24e --- /dev/null +++ b/document_page_reference/models/__init__.py @@ -0,0 +1 @@ +from . import document_page diff --git a/document_page_reference/models/document_page.py b/document_page_reference/models/document_page.py new file mode 100644 index 00000000..f745ee41 --- /dev/null +++ b/document_page_reference/models/document_page.py @@ -0,0 +1,102 @@ +# Copyright 2019 Creu Blanca +# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl). + +import logging +import re + +from jinja2.sandbox import SandboxedEnvironment +from markupsafe import Markup + +from odoo import _, api, fields, models +from odoo.exceptions import ValidationError +from odoo.tools import html_escape + +_logger = logging.getLogger(__name__) +env = SandboxedEnvironment(autoescape=False) + + +class DocumentPage(models.Model): + _inherit = "document.page" + _description = "Document Page" + + reference = fields.Char( + help="Used to find the document, it can contain letters, numbers and _" + ) + content_parsed = fields.Html( + "Parsed Content", compute="_compute_content_parsed", sanitize=False, store=True + ) + + def get_formview_action(self, access_uid=None): + res = super().get_formview_action(access_uid) + view_id = self.env.ref("document_page.view_wiki_form").id + res["views"] = [(view_id, "form")] + return res + + @api.depends("content") + def _compute_content_parsed(self): + for record in self: + try: + raw = record.content or "" + converted = re.sub(r"\$\{([\w_]+)\}", r"{{ resolve('\1') }}", raw) + template = env.from_string(converted) + rendered = template.render(resolve=record._resolve_reference) + record.content_parsed = rendered + except Exception as e: + _logger.info("Render failed for %s: %s", record.id, e) + record.content_parsed = record.content or "" + + @api.constrains("reference") + def _check_reference_validity(self): + for rec in self: + if not rec.reference: + continue + regex = r"^[a-zA-Z_][a-zA-Z0-9_]*$" + if not re.match(regex, rec.reference): + raise ValidationError(_("Reference is not valid")) + domain = [("reference", "=", rec.reference), ("id", "!=", rec.id)] + if self.search(domain): + raise ValidationError(_("Reference must be unique")) + + def _get_document(self, code): + return self.search([("reference", "=", code)], limit=1) + + def get_content(self): + for record in self: + try: + raw = record.content or "" + converted = re.sub(r"\$\{([\w_]+)\}", r"{{ resolve('\1') }}", raw) + template = env.from_string(converted) + return template.render(resolve=record._resolve_reference) + except Exception: + _logger.error( + "Template from page with id = %s cannot be processed", record.id + ) + return record.content + + def _resolve_reference(self, code): + doc = self._get_document(code) + if self.env.context.get("raw_reference", False): + return html_escape(doc.display_name if doc else code) + sanitized_code = html_escape(code) + if not doc: + return ( + f"{sanitized_code}" + ) + return ( + f"" + f"{html_escape(doc.display_name)}" + ) + + def get_raw_content(self): + return Markup(self.with_context(raw_reference=True).get_content()) + + @api.model_create_multi + def create(self, vals_list): + for vals in vals_list: + if not vals.get("reference") and vals.get("name"): + reference = self.env["ir.http"]._slugify(vals["name"]).replace("-", "_") + vals["reference"] = reference + return super().create(vals_list) diff --git a/document_page_reference/pyproject.toml b/document_page_reference/pyproject.toml new file mode 100644 index 00000000..4231d0cc --- /dev/null +++ b/document_page_reference/pyproject.toml @@ -0,0 +1,3 @@ +[build-system] +requires = ["whool"] +build-backend = "whool.buildapi" diff --git a/document_page_reference/readme/CONTRIBUTORS.md b/document_page_reference/readme/CONTRIBUTORS.md new file mode 100644 index 00000000..145b8f6b --- /dev/null +++ b/document_page_reference/readme/CONTRIBUTORS.md @@ -0,0 +1 @@ +- Enric Tobella \ diff --git a/document_page_reference/readme/DESCRIPTION.md b/document_page_reference/readme/DESCRIPTION.md new file mode 100644 index 00000000..b4d3c86e --- /dev/null +++ b/document_page_reference/readme/DESCRIPTION.md @@ -0,0 +1,2 @@ +This module allows to add a reference name on documents and simplifies +the link between document pages. diff --git a/document_page_reference/readme/USAGE.md b/document_page_reference/readme/USAGE.md new file mode 100644 index 00000000..6fa5061f --- /dev/null +++ b/document_page_reference/readme/USAGE.md @@ -0,0 +1,3 @@ +When editing a document page add elements like \${XXX} where XXX is the +reference of another page. Now, when viewing the document, it will link +directly to the page. Also, the name will be parsed as the display name. diff --git a/document_page_reference/static/description/icon.png b/document_page_reference/static/description/icon.png new file mode 100644 index 00000000..3a0328b5 Binary files /dev/null and b/document_page_reference/static/description/icon.png differ diff --git a/document_page_reference/static/description/index.html b/document_page_reference/static/description/index.html new file mode 100644 index 00000000..49d98ad5 --- /dev/null +++ b/document_page_reference/static/description/index.html @@ -0,0 +1,433 @@ + + + + + +Document Page Reference + + + +
+

Document Page Reference

+ + +

Beta License: AGPL-3 OCA/knowledge Translate me on Weblate Try me on Runboat

+

This module allows to add a reference name on documents and simplifies +the link between document pages.

+

Table of contents

+ +
+

Usage

+

When editing a document page add elements like ${XXX} where XXX is the +reference of another page. Now, when viewing the document, it will link +directly to the page. Also, the name will be parsed as the display name.

+
+
+

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 to smash 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

+ +
+
+

Maintainers

+

This module is maintained by the OCA.

+ +Odoo Community Association + +

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.

+

Current maintainer:

+

etobella

+

This module is part of the OCA/knowledge project on GitHub.

+

You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.

+
+
+
+ + diff --git a/document_page_reference/static/src/js/editor.esm.js b/document_page_reference/static/src/js/editor.esm.js new file mode 100644 index 00000000..416bfb85 --- /dev/null +++ b/document_page_reference/static/src/js/editor.esm.js @@ -0,0 +1,32 @@ +import {HtmlField, htmlField} from "@web/views/fields/html/html_field"; +import {onMounted} from "@odoo/owl"; +import {registry} from "@web/core/registry"; +import {useService} from "@web/core/utils/hooks"; + +class DocumentPageReferenceField extends HtmlField { + setup() { + super.setup(); + this.orm = useService("orm"); + this.action = useService("action"); + onMounted(() => { + // eslint-disable-next-line no-undef + const links = document.querySelectorAll(".oe_direct_line"); + links.forEach((link) => { + link.addEventListener("click", (event) => + this._onClickDirectLink(event) + ); + }); + }); + } + _onClickDirectLink(event) { + const {oeModel: model, oeId} = event.target.dataset; + const id = parseInt(oeId, 10); + this.orm.call(model, "get_formview_action", [[id]], {}).then((action) => { + this.action.doAction(action); + }); + } +} +registry.category("fields").add("document_page_reference", { + ...htmlField, + component: DocumentPageReferenceField, +}); diff --git a/document_page_reference/tests/__init__.py b/document_page_reference/tests/__init__.py new file mode 100644 index 00000000..ca802a6b --- /dev/null +++ b/document_page_reference/tests/__init__.py @@ -0,0 +1 @@ +from . import test_document_reference diff --git a/document_page_reference/tests/test_document_reference.py b/document_page_reference/tests/test_document_reference.py new file mode 100644 index 00000000..73581b8b --- /dev/null +++ b/document_page_reference/tests/test_document_reference.py @@ -0,0 +1,65 @@ +# Copyright 2019 Creu Blanca +# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl). + +from odoo.exceptions import ValidationError +from odoo.tests.common import TransactionCase + + +class TestDocumentReference(TransactionCase): + @classmethod + def setUpClass(cls): + super().setUpClass() + cls.page_obj = cls.env["document.page"] + cls.history_obj = cls.env["document.page.history"] + cls.page1 = cls.page_obj.create( + {"name": "Test Page 1", "content": "${r2}", "reference": "R1"} + ) + cls.page2 = cls.page_obj.create( + {"name": "Test Page 1", "content": "${r1}", "reference": "r2"} + ) + + def test_constraints_duplicate_reference(self): + """Should raise if reference is not unique (same as another).""" + with self.assertRaises(ValidationError): + self.page2.write({"reference": self.page1.reference}) + + def test_constraints_invalid_reference(self): + """Should raise if reference does not match the required pattern.""" + with self.assertRaises(ValidationError): + self.page2.write({"reference": self.page2.reference + "-02"}) + + def test_auto_reference(self): + """Test if reference is proposed when saving a page without one.""" + self.assertEqual(self.page1.reference, "R1") + new_page = self.page_obj.create( + {"name": "Test Page with no reference", "content": "some content"} + ) + self.assertEqual(new_page.reference, "test_page_with_no_reference") + with self.assertRaises(ValidationError): + new_page_duplicated_name = self.page_obj.create( + { + "name": "test page with no reference", + "content": "this should have an empty reference " + "because reference must be unique", + } + ) + self.assertFalse(new_page_duplicated_name.reference) + + def test_get_formview_action(self): + res = self.page1.get_formview_action() + view_id = self.env.ref("document_page.view_wiki_form").id + expected_keys = { + "type": "ir.actions.act_window", + "res_model": "document.page", + "res_id": self.page1.id, + "context": {}, + "target": "current", + "views": [(view_id, "form")], + } + for key, expected_value in expected_keys.items(): + self.assertEqual(res.get(key), expected_value, f"Mismatch in key: {key}") + + def test_compute_content_parsed(self): + self.page1.content = "

" + self.page1._compute_content_parsed() + self.assertEqual(str(self.page1.content_parsed), "

") diff --git a/document_page_reference/views/document_page.xml b/document_page_reference/views/document_page.xml new file mode 100644 index 00000000..9f4c7ce6 --- /dev/null +++ b/document_page_reference/views/document_page.xml @@ -0,0 +1,70 @@ + + + + + document.page.form (in knowledge_reference) + document.page + + + +

+ +

+ + + oe_edit_only + + + + + + + + + document.page.menu.form + document.page + + + + oe_edit_only + + + + + + + + + document.page.search (in knowledge_reference) + document.page + + + + + + + + + + document.page.tree (in knowledge_reference) + document.page + + + + + + + + diff --git a/document_page_reference/views/report_document_page.xml b/document_page_reference/views/report_document_page.xml new file mode 100644 index 00000000..47ff1298 --- /dev/null +++ b/document_page_reference/views/report_document_page.xml @@ -0,0 +1,14 @@ + + + +