diff --git a/document_print_control/README.rst b/document_print_control/README.rst new file mode 100644 index 00000000..ebfd6b47 --- /dev/null +++ b/document_print_control/README.rst @@ -0,0 +1,102 @@ +====================== +Document Print Control +====================== + +.. + !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! + !! This file is generated by oca-gen-addon-readme !! + !! changes will be overwritten. !! + !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! + !! source digest: sha256:c08c914a87dd77f1d5c07e7716f9f40c7341917cc62a95efe6c0035fce9a9eaf + !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! + +.. |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/16.0/document_print_control + :alt: OCA/knowledge +.. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png + :target: https://translation.odoo-community.org/projects/knowledge-16-0/knowledge-16-0-document_print_control + :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=16.0 + :alt: Try me on Runboat + +|badge1| |badge2| |badge3| |badge4| |badge5| + +This module adds print control functionality to document pages based on +tags. It allows users to control which document pages can be printed by +configuring tags with a "printable" attribute. When a document page has +tags marked as non-printable, the print button will be hidden and the +printing functionality will be disabled for that document. + +**Table of contents** + +.. contents:: + :local: + +Usage +===== + +If you want to control the printing of document pages using tags: + +1. Go to Document Management, then to Configuration, and open Tags. +2. Create or edit existing tags and use the "Is Printable" checkbox to + control printing permissions. +3. Uncheck "Is Printable" for tags that should prevent document + printing. +4. Assign these tags to document pages - if any tag on a document page + is marked as non-printable, the entire document becomes + non-printable. +5. The print button will automatically hide for non-printable documents, + and printing functionality will be disabled. +6. All tags are printable by default to maintain backward compatibility. + +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 +------- + +* Sygel + +Contributors +------------ + + - `Sygel `__: + + .. + + - Juan Alberto Raja Martinez + - Valentín Vinagre Urteaga + +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. + +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_print_control/__init__.py b/document_print_control/__init__.py new file mode 100644 index 00000000..f13e006e --- /dev/null +++ b/document_print_control/__init__.py @@ -0,0 +1,3 @@ +# Copyright 2025 Juan Alberto Raja +# License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl). +from . import models diff --git a/document_print_control/__manifest__.py b/document_print_control/__manifest__.py new file mode 100644 index 00000000..eaca7669 --- /dev/null +++ b/document_print_control/__manifest__.py @@ -0,0 +1,22 @@ +# Copyright 2025 Juan Alberto Raja +# License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl). +{ + "name": "Document Print Control", + "summary": "Restricts document page printing based on assigned tags", + "version": "16.0.1.0.0", + "license": "AGPL-3", + "author": "Sygel, Odoo Community Association (OCA)", + "website": "https://github.com/OCA/knowledge", + "category": "Knowledge", + "depends": [ + "document_page", + "document_page_tag", + ], + "data": [ + "views/document_page_tag.xml", + "views/document_page.xml", + ], + "installable": True, + "application": False, + "auto_install": False, +} diff --git a/document_print_control/i18n/ca_ES.po b/document_print_control/i18n/ca_ES.po new file mode 100644 index 00000000..c50dd5ac --- /dev/null +++ b/document_print_control/i18n/ca_ES.po @@ -0,0 +1,46 @@ +# Translation of Odoo Server. +# * document_print_control +# +msgid "" +msgstr "" +"Project-Id-Version: Odoo Server 16.0\n" +"Report-Msgid-Bugs-To: \n" +"POT-Creation-Date: \n" +"PO-Revision-Date: \n" +"Last-Translator: \n" +"Language-Team: \n" +"MIME-Version: 1.0\n" +"Content-Type: text/plain; charset=UTF-8\n" +"Content-Transfer-Encoding: \n" +"Language: ca\n" +"Plural-Forms: \n" + +#. module: document_print_control +#: model:ir.model.fields,field_description:document_print_control.field_document_page_tag__is_printable +msgid "Is Printable" +msgstr "És imprimible" + +#. module: document_print_control +#: model:ir.model.fields,help:document_print_control.field_document_page__is_printable +msgid "Indicates if the document can be printed based on its tags" +msgstr "Indica si el document es pot imprimir basant-se en les seves etiquetes" + +#. module: document_print_control +#: model:ir.model.fields,help:document_print_control.field_document_page_tag__is_printable +msgid "If unchecked, pages with this tag cannot be printed" +msgstr "Si està desmarcat, les pàgines amb aquesta etiqueta no es poden imprimir" + +#. module: document_print_control +#: model_terms:ir.ui.view,arch_db:document_print_control.view_document_page_form_inherit_print +msgid "Print" +msgstr "Imprimir" + +#. module: document_print_control +#: model_terms:ir.ui.view,arch_db:document_print_control.view_document_page_tag_search_extended +msgid "Printable Tags" +msgstr "Etiquetes imprimibles" + +#. module: document_print_control +#: model_terms:ir.ui.view,arch_db:document_print_control.view_document_page_tag_search_extended +msgid "Non-Printable Tags" +msgstr "Etiquetes no imprimibles" diff --git a/document_print_control/i18n/es.po b/document_print_control/i18n/es.po new file mode 100644 index 00000000..6eca9e7a --- /dev/null +++ b/document_print_control/i18n/es.po @@ -0,0 +1,46 @@ +# Translation of Odoo Server. +# * document_print_control +# +msgid "" +msgstr "" +"Project-Id-Version: Odoo Server 16.0\n" +"Report-Msgid-Bugs-To: \n" +"POT-Creation-Date: \n" +"PO-Revision-Date: \n" +"Last-Translator: \n" +"Language-Team: \n" +"MIME-Version: 1.0\n" +"Content-Type: text/plain; charset=UTF-8\n" +"Content-Transfer-Encoding: \n" +"Language: es\n" +"Plural-Forms: \n" + +#. module: document_print_control +#: model:ir.model.fields,field_description:document_print_control.field_document_page_tag__is_printable +msgid "Is Printable" +msgstr "Es imprimible" + +#. module: document_print_control +#: model:ir.model.fields,help:documents_print_control.field_document_page__is_printable +msgid "Indicates if the document can be printed based on its tags" +msgstr "Indica si el documento puede ser impreso basándose en sus etiquetas" + +#. module: document_print_control +#: model:ir.model.fields,help:documents_print_control.field_document_page_tag__is_printable +msgid "If unchecked, pages with this tag cannot be printed" +msgstr "Si está desmarcado, las páginas con esta etiqueta no se pueden imprimir" + +#. module: document_print_control +#: model_terms:ir.ui.view,arch_db:document_print_control.view_document_page_form_inherit_print +msgid "Print" +msgstr "Imprimir" + +#. module: document_print_control +#: model_terms:ir.ui.view,arch_db:document_print_control.view_document_page_tag_search_extended +msgid "Printable Tags" +msgstr "Etiquetas imprimibles" + +#. module: document_print_control +#: model_terms:ir.ui.view,arch_db:document_print_control.view_document_page_tag_search_extended +msgid "Non-Printable Tags" +msgstr "Etiquetas no imprimibles" diff --git a/document_print_control/models/__init__.py b/document_print_control/models/__init__.py new file mode 100644 index 00000000..e7907165 --- /dev/null +++ b/document_print_control/models/__init__.py @@ -0,0 +1,4 @@ +# Copyright 2025 Juan Alberto Raja +# License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl). +from . import document_page_tag +from . import document_page diff --git a/document_print_control/models/document_page.py b/document_print_control/models/document_page.py new file mode 100644 index 00000000..70eb67b6 --- /dev/null +++ b/document_print_control/models/document_page.py @@ -0,0 +1,25 @@ +from odoo import api, fields, models + + +class DocumentPage(models.Model): + _inherit = "document.page" + + is_printable = fields.Boolean( + compute="_compute_is_printable", + store=True, + help="Indicates if the document can be printed based on its tags", + ) + + @api.depends("tag_ids", "tag_ids.is_printable") + def _compute_is_printable(self): + for record in self: + if not record.tag_ids: + record.is_printable = True + else: + record.is_printable = all(tag.is_printable for tag in record.tag_ids) + + def action_print_document_page(self): + for record in self: + if not record.is_printable: + return None + return self.env.ref("document_page.report_document_page").report_action(self) diff --git a/document_print_control/models/document_page_tag.py b/document_print_control/models/document_page_tag.py new file mode 100644 index 00000000..37bba50d --- /dev/null +++ b/document_print_control/models/document_page_tag.py @@ -0,0 +1,18 @@ +# Copyright 2025 Juan Alberto Raja +# License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl). +from odoo import api, fields, models + + +class DocumentPageTag(models.Model): + _inherit = "document.page.tag" + + is_printable = fields.Boolean( + default=True, + help="If unchecked, pages with this tag cannot be printed", + ) + + @api.model + def create(self, vals): + if "is_printable" not in vals: + vals["is_printable"] = True + return super().create(vals) diff --git a/document_print_control/readme/CONTRIBUTORS.md b/document_print_control/readme/CONTRIBUTORS.md new file mode 100644 index 00000000..83fe6ca9 --- /dev/null +++ b/document_print_control/readme/CONTRIBUTORS.md @@ -0,0 +1,5 @@ + +> - [Sygel](https://www.sygel.es): +> +> > - Juan Alberto Raja Martinez\<\> +> > - Valentín Vinagre Urteaga\<\> diff --git a/document_print_control/readme/DESCRIPTION.md b/document_print_control/readme/DESCRIPTION.md new file mode 100644 index 00000000..ddb9954e --- /dev/null +++ b/document_print_control/readme/DESCRIPTION.md @@ -0,0 +1 @@ +This module adds print control functionality to document pages based on tags. It allows users to control which document pages can be printed by configuring tags with a "printable" attribute. When a document page has tags marked as non-printable, the print button will be hidden and the printing functionality will be disabled for that document. diff --git a/document_print_control/readme/USAGE.md b/document_print_control/readme/USAGE.md new file mode 100644 index 00000000..52130960 --- /dev/null +++ b/document_print_control/readme/USAGE.md @@ -0,0 +1,8 @@ +If you want to control the printing of document pages using tags: + +1. Go to Document Management, then to Configuration, and open Tags. +2. Create or edit existing tags and use the "Is Printable" checkbox to control printing permissions. +3. Uncheck "Is Printable" for tags that should prevent document printing. +4. Assign these tags to document pages - if any tag on a document page is marked as non-printable, the entire document becomes non-printable. +5. The print button will automatically hide for non-printable documents, and printing functionality will be disabled. +6. All tags are printable by default to maintain backward compatibility. diff --git a/document_print_control/static/description/icon.png b/document_print_control/static/description/icon.png new file mode 100644 index 00000000..3a0328b5 Binary files /dev/null and b/document_print_control/static/description/icon.png differ diff --git a/document_print_control/static/description/index.html b/document_print_control/static/description/index.html new file mode 100644 index 00000000..f4a641ad --- /dev/null +++ b/document_print_control/static/description/index.html @@ -0,0 +1,454 @@ + + + + + +Document Print Control + + + +
+

Document Print Control

+ + +

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

+

This module adds print control functionality to document pages based on +tags. It allows users to control which document pages can be printed by +configuring tags with a “printable” attribute. When a document page has +tags marked as non-printable, the print button will be hidden and the +printing functionality will be disabled for that document.

+

Table of contents

+ +
+

Usage

+

If you want to control the printing of document pages using tags:

+
    +
  1. Go to Document Management, then to Configuration, and open Tags.
    2. +
  2. Create or edit existing tags and use the “Is Printable” checkbox to +control printing permissions.
    3. +
  3. Uncheck “Is Printable” for tags that should prevent document +printing.
    4. +
  4. Assign these tags to document pages - if any tag on a document page +is marked as non-printable, the entire document becomes +non-printable.
    5. +
  5. The print button will automatically hide for non-printable documents, +and printing functionality will be disabled.
    6. +
  6. All tags are printable by default to maintain backward compatibility.
    7. +
+
+
+

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

+
    +
  • Sygel
    • +
+
+
+

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.

+

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_print_control/tests/__init__.py b/document_print_control/tests/__init__.py new file mode 100644 index 00000000..93f652c3 --- /dev/null +++ b/document_print_control/tests/__init__.py @@ -0,0 +1,3 @@ +# Copyright 2025 Juan Alberto Raja +# License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl). +from . import test_document_print_control diff --git a/document_print_control/tests/test_document_print_control.py b/document_print_control/tests/test_document_print_control.py new file mode 100644 index 00000000..3ef1ddf8 --- /dev/null +++ b/document_print_control/tests/test_document_print_control.py @@ -0,0 +1,90 @@ +from odoo.tests import tagged +from odoo.tests.common import TransactionCase + + +@tagged("post_install", "-at_install") +class TestDocumentPrintControl(TransactionCase): + @classmethod + def setUpClass(cls): + super().setUpClass() + + cls.printable_tag = cls.env["document.page.tag"].create( + { + "name": "Printable Tag", + "is_printable": True, + } + ) + + cls.non_printable_tag = cls.env["document.page.tag"].create( + { + "name": "Non-Printable Tag", + "is_printable": False, + } + ) + + cls.doc_without_tags = cls.env["document.page"].create( + { + "name": "Document without tags", + "content": "Test content without tags", + } + ) + + cls.doc_with_printable_tag = cls.env["document.page"].create( + { + "name": "Document with printable tag", + "content": "Test content with printable tag", + "tag_ids": [(4, cls.printable_tag.id)], + } + ) + + cls.doc_with_non_printable_tag = cls.env["document.page"].create( + { + "name": "Document with non-printable tag", + "content": "Test content with non-printable tag", + "tag_ids": [(4, cls.non_printable_tag.id)], + } + ) + + cls.doc_with_mixed_tags = cls.env["document.page"].create( + { + "name": "Document with mixed tags", + "content": "Test content with mixed tags", + "tag_ids": [(4, cls.printable_tag.id), (4, cls.non_printable_tag.id)], + } + ) + + def test_printable_without_tags(self): + """Documents without tags should be printable by default""" + self.assertTrue(self.doc_without_tags.is_printable) + + def test_printable_with_allowed_tags(self): + """Documents with only printable tags should be printable""" + self.assertTrue(self.doc_with_printable_tag.is_printable) + + def test_not_printable_with_restricted_tags(self): + """Documents with non-printable tags should not be printable""" + self.assertFalse(self.doc_with_non_printable_tag.is_printable) + + def test_not_printable_with_mixed_tags(self): + """Documents with mixed tags should not be printable""" + self.assertFalse(self.doc_with_mixed_tags.is_printable) + + def test_print_action_allowed_documents(self): + """Print action should return report for printable documents""" + result = self.doc_with_printable_tag.action_print_document_page() + self.assertIsNotNone(result) + self.assertIn("context", result) + self.assertIn("report_action", result["context"]) + self.assertIn("report_name", result["context"]["report_action"]) + + def test_print_action_restricted_documents(self): + """Print action should return None for non-printable documents""" + result = self.doc_with_non_printable_tag.action_print_document_page() + self.assertIsNone(result) + + def test_tag_default_is_printable(self): + """Tags created without is_printable should default to True""" + tag = self.env["document.page.tag"].create( + {"name": "Test Tag Without is_printable"} + ) + self.assertTrue(tag.is_printable) diff --git a/document_print_control/views/document_page.xml b/document_print_control/views/document_page.xml new file mode 100644 index 00000000..8f880ba7 --- /dev/null +++ b/document_print_control/views/document_page.xml @@ -0,0 +1,33 @@ + + + + + action + + + + + document.page.form.inherit.print + document.page + + + + + + + +
+
+ + + + diff --git a/document_print_control/views/document_page_tag.xml b/document_print_control/views/document_page_tag.xml new file mode 100644 index 00000000..e6a46c9c --- /dev/null +++ b/document_print_control/views/document_page_tag.xml @@ -0,0 +1,53 @@ + + + + + document.page.tag.form.extended + document.page.tag + + + + + + + + + + document.page.tag.tree.extended + document.page.tag + + + + + + + + + + document.page.tag.search.extended + document.page.tag + + + + + + + + + + + + + diff --git a/setup/document_print_control/odoo/addons/document_print_control b/setup/document_print_control/odoo/addons/document_print_control new file mode 120000 index 00000000..7f34bcd9 --- /dev/null +++ b/setup/document_print_control/odoo/addons/document_print_control @@ -0,0 +1 @@ +../../../../document_print_control \ No newline at end of file diff --git a/setup/document_print_control/setup.py b/setup/document_print_control/setup.py new file mode 100644 index 00000000..28c57bb6 --- /dev/null +++ b/setup/document_print_control/setup.py @@ -0,0 +1,6 @@ +import setuptools + +setuptools.setup( + setup_requires=['setuptools-odoo'], + odoo_addon=True, +)