diff --git a/document_page_portal/README.rst b/document_page_portal/README.rst new file mode 100644 index 00000000000..704d4dda689 --- /dev/null +++ b/document_page_portal/README.rst @@ -0,0 +1,127 @@ +==================== +Document Page Portal +==================== + +.. + !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! + !! This file is generated by oca-gen-addon-readme !! + !! changes will be overwritten. !! + !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! + !! source digest: sha256:f53ae4e919211a3a8bcca7038cfc061055fc9ae094980c1bbe5d73184c46679d + !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! + +.. |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_portal + :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_portal + :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 publishes Knowledge document pages (``document.page`` +records of type *Content*) to the website portal, so that logged-in +portal users can read them from their *My Account* area. + +A *Knowledge Documents* entry is added to the portal home, listing the +pages each user is allowed to see, with search and category badges. + +Visibility is controlled per page: a page can be shared with **all +portal users** (the *Public* flag) or restricted to the page's +**followers**. Note that *Public* here means "any logged-in portal +user"; it does **not** expose pages to anonymous website visitors. + +**Table of contents** + +.. contents:: + :local: + +Configuration +============= + +No configuration required. + +Usage +===== + +To make a document page available on the portal: + +1. Open a document page in the backend (under *Knowledge*). Only pages + of type *Content* appear on the portal. +2. Choose who can see it: either tick **Public** to share it with every + portal user, or add the relevant portal user(s) as **followers** of + the page. + +Portal users then find their documents under **My Account > Knowledge +Documents** (``/my/knowledge/documents``), where they can browse, +search, and open each page. + +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 +------- + +* Escodoo + +Contributors +------------ + +- `Escodoo `__: + + - Marcel Savegnago + +- `BPM Integrations Inc. `__: + + - Ken Woychesko + +Other credits +------------- + +The development of this module has been financially supported by: + +- `Escodoo `__ + +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-marcelsavegnago| image:: https://github.com/marcelsavegnago.png?size=40px + :target: https://github.com/marcelsavegnago + :alt: marcelsavegnago + +Current `maintainer `__: + +|maintainer-marcelsavegnago| + +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_portal/__init__.py b/document_page_portal/__init__.py new file mode 100644 index 00000000000..91c5580fed3 --- /dev/null +++ b/document_page_portal/__init__.py @@ -0,0 +1,2 @@ +from . import controllers +from . import models diff --git a/document_page_portal/__manifest__.py b/document_page_portal/__manifest__.py new file mode 100644 index 00000000000..bd70de66b4a --- /dev/null +++ b/document_page_portal/__manifest__.py @@ -0,0 +1,28 @@ +# Copyright (C) 2020 - TODAY, Marcel Savegnago - Escodoo). +# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl). + + +{ + "name": "Document Page Portal", + "summary": """ + This module enables document page portal""", + "version": "18.0.1.0.0", + "category": "Knowledge Management", + "author": "Escodoo, Odoo Community Association (OCA)", + "maintainers": ["marcelsavegnago"], + "images": ["static/description/banner.png"], + "website": "https://github.com/OCA/knowledge", + "license": "AGPL-3", + "depends": ["base", "portal", "document_page"], + "data": [ + "views/document_page.xml", + "security/document_page_portal_security.xml", + "security/ir.model.access.csv", + "views/document_page_portal_templates.xml", + ], + "assets": { + "web.assets_tests": [ + "document_page_portal/static/tests/tours/document_page_portal_tour.esm.js", + ], + }, +} diff --git a/document_page_portal/controllers/__init__.py b/document_page_portal/controllers/__init__.py new file mode 100644 index 00000000000..8c3feb6f562 --- /dev/null +++ b/document_page_portal/controllers/__init__.py @@ -0,0 +1 @@ +from . import portal diff --git a/document_page_portal/controllers/portal.py b/document_page_portal/controllers/portal.py new file mode 100644 index 00000000000..2d887c9dd89 --- /dev/null +++ b/document_page_portal/controllers/portal.py @@ -0,0 +1,151 @@ +# Copyright (C) 2020 - TODAY, Marcel Savegnago - Escodoo). +# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl). + + +from odoo import http +from odoo.exceptions import AccessError, MissingError +from odoo.http import request +from odoo.osv.expression import OR +from odoo.tools.translate import _ + +from odoo.addons.portal.controllers.portal import CustomerPortal +from odoo.addons.portal.controllers.portal import pager as portal_pager + + +class CustomerPortal(CustomerPortal): + def _prepare_home_portal_values(self, counters): + values = super()._prepare_home_portal_values(counters) + if "document_page_count" in counters: + values["document_page_count"] = ( + request.env["document.page"].search_count([("type", "=", "content")]) + if request.env["document.page"].has_access("read") + else 0 + ) + return values + + def _document_page_get_page_view_values( + self, document_page, access_token, **kwargs + ): + values = { + "page_name": "document_page", + "document_page": document_page, + } + return self._get_page_view_values( + document_page, + access_token, + values, + "my_document_pages_history", + False, + **kwargs, + ) + + @http.route( + ["/my/knowledge/documents/", "/my/knowledge/documents/page/"], + type="http", + auth="user", + website=True, + ) + def portal_my_knowledge_document_pages( + self, + page=1, + date_begin=None, + date_end=None, + sortby=None, + search=None, + search_in="content", + **kw, + ): + values = self._prepare_portal_layout_values() + domain = [("type", "=", "content")] + + searchbar_sortings = { + "date": {"label": _("Newest"), "order": "create_date desc"}, + "name": {"label": _("Name"), "order": "name"}, + "parent": {"label": _("Category"), "order": "parent_id"}, + } + searchbar_inputs = { + "content": { + "input": "content", + "label": _('Search (in Content)'), + }, + "all": {"input": "all", "label": _("Search in All")}, + } + + # default sort by value + if not sortby: + sortby = "date" + order = searchbar_sortings[sortby]["order"] + + if date_begin and date_end: + domain += [ + ("create_date", ">", date_begin), + ("create_date", "<=", date_end), + ] + + # search + if search and search_in: + search_domain = [] + if search_in in ("content", "all"): + search_domain = OR( + [ + search_domain, + ["|", ("name", "ilike", search), ("content", "ilike", search)], + ] + ) + domain += search_domain + + # pager + document_pages_count = request.env["document.page"].search_count(domain) + pager = portal_pager( + url="/my/knowledge/documents", + url_args={"date_begin": date_begin, "date_end": date_end, "sortby": sortby}, + total=document_pages_count, + page=page, + step=self._items_per_page, + ) + + document_pages = request.env["document.page"].search( + domain, order=order, limit=self._items_per_page, offset=pager["offset"] + ) + request.session["my_document_pages_history"] = document_pages.ids[:100] + + values.update( + { + "date": date_begin, + "document_pages": document_pages, + "page_name": "document_page", + "default_url": "/my/knowledge/s", + "pager": pager, + "searchbar_sortings": searchbar_sortings, + "searchbar_inputs": searchbar_inputs, + "sortby": sortby, + "search_in": search_in, + "search": search, + } + ) + return request.render( + "document_page_portal.portal_my_knowledge_document_pages", values + ) + + @http.route( + [ + "/knowledge/document/", + "/knowledge/document//", + "/my/knowledge/document/", + ], + type="http", + auth="public", + website=True, + ) + def document_pages_followup(self, document_page_id=None, access_token=None, **kw): + try: + document_page_sudo = self._document_check_access( + "document.page", document_page_id, access_token + ) + except (AccessError, MissingError): + return request.redirect("/my") + + values = self._document_page_get_page_view_values( + document_page_sudo, access_token, **kw + ) + return request.render("document_page_portal.document_pages_followup", values) diff --git a/document_page_portal/i18n/document_page_portal.pot b/document_page_portal/i18n/document_page_portal.pot new file mode 100644 index 00000000000..0095220f684 --- /dev/null +++ b/document_page_portal/i18n/document_page_portal.pot @@ -0,0 +1,109 @@ +# Translation of Odoo Server. +# This file contains the translation of the following modules: +# * document_page_portal +# +msgid "" +msgstr "" +"Project-Id-Version: Odoo Server 14.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_portal +#: model_terms:ir.ui.view,arch_db:document_page_portal.document_pages_followup +msgid "No content" +msgstr "" + +#. module: document_page_portal +#: model_terms:ir.ui.view,arch_db:document_page_portal.document_pages_followup +msgid "Category:" +msgstr "" + +#. module: document_page_portal +#: code:addons/document_page_portal/controllers/portal.py:0 +#: model_terms:ir.ui.view,arch_db:document_page_portal.portal_my_knowledge_document_pages +#, python-format +msgid "Category" +msgstr "" + +#. module: document_page_portal +#: model_terms:ir.ui.view,arch_db:document_page_portal.document_pages_followup +msgid "Current Category of this document" +msgstr "" + +#. module: document_page_portal +#: model:ir.model.fields,field_description:document_page_portal.field_document_page__display_name +msgid "Display Name" +msgstr "" + +#. module: document_page_portal +#: model:ir.model,name:document_page_portal.model_document_page +msgid "Document Page" +msgstr "" + +#. module: document_page_portal +#: model:ir.model.fields,field_description:document_page_portal.field_document_page__id +msgid "ID" +msgstr "" + +#. module: document_page_portal +#: model:ir.model.fields,help:document_page_portal.field_document_page__is_public +msgid "" +"If true it allows any user of the portal to have access to this document." +msgstr "" + +#. module: document_page_portal +#: model_terms:ir.ui.view,arch_db:document_page_portal.portal_my_home_Knowledge_document_page +#: model_terms:ir.ui.view,arch_db:document_page_portal.portal_my_home_menu_Knowledge +#: model_terms:ir.ui.view,arch_db:document_page_portal.portal_my_knowledge_document_pages +msgid "Knowledge Documents" +msgstr "" + +#. module: document_page_portal +#: model:ir.model.fields,field_description:document_page_portal.field_document_page____last_update +msgid "Last Modified on" +msgstr "" + +#. module: document_page_portal +#: code:addons/document_page_portal/controllers/portal.py:0 +#: model_terms:ir.ui.view,arch_db:document_page_portal.portal_my_knowledge_document_pages +#, python-format +msgid "Name" +msgstr "" + +#. module: document_page_portal +#: code:addons/document_page_portal/controllers/portal.py:0 +#, python-format +msgid "Newest" +msgstr "" + +#. module: document_page_portal +#: model:ir.model.fields,field_description:document_page_portal.field_document_page__is_public +msgid "Public Page" +msgstr "" + +#. module: document_page_portal +#: model_terms:ir.ui.view,arch_db:document_page_portal.portal_my_knowledge_document_pages +msgid "Ref" +msgstr "" + +#. module: document_page_portal +#: code:addons/document_page_portal/controllers/portal.py:0 +#, python-format +msgid "Search (in Content)" +msgstr "" + +#. module: document_page_portal +#: code:addons/document_page_portal/controllers/portal.py:0 +#, python-format +msgid "Search in All" +msgstr "" + +#. module: document_page_portal +#: model_terms:ir.ui.view,arch_db:document_page_portal.portal_my_knowledge_document_pages +msgid "There are currently no Knowledge Document for your account." +msgstr "" diff --git a/document_page_portal/i18n/it.po b/document_page_portal/i18n/it.po new file mode 100644 index 00000000000..8ba47f7881c --- /dev/null +++ b/document_page_portal/i18n/it.po @@ -0,0 +1,98 @@ +# Translation of Odoo Server. +# This file contains the translation of the following modules: +# * document_page_portal +# +msgid "" +msgstr "" +"Project-Id-Version: Odoo Server 13.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_portal +#: model_terms:ir.ui.view,arch_db:document_page_portal.document_pages_followup +msgid "No content" +msgstr "Nessun contenuto" + +#. module: document_page_portal +#: model_terms:ir.ui.view,arch_db:document_page_portal.document_pages_followup +msgid "Category:" +msgstr "Categoria:" + +#. module: document_page_portal +#: code:addons/document_page_portal/controllers/portal.py:0 +#: model_terms:ir.ui.view,arch_db:document_page_portal.portal_my_knowledge_document_pages +#, python-format +msgid "Category" +msgstr "Categoria" + +#. module: document_page_portal +#: model_terms:ir.ui.view,arch_db:document_page_portal.document_pages_followup +msgid "Current Category of this document" +msgstr "Categoria attuale di questo documento" + +#. module: document_page_portal +#: model:ir.model,name:document_page_portal.model_document_page +msgid "Document Page" +msgstr "Pagina documento" + +#. module: document_page_portal +#: model:ir.model.fields,help:document_page_portal.field_document_page__is_public +msgid "" +"If true it allows any user of the portal to have access to this document." +msgstr "" +"Se vera consente ad ogni utente del portale di accedere a questo documento." + +#. module: document_page_portal +#: model_terms:ir.ui.view,arch_db:document_page_portal.portal_my_home_Knowledge_document_page +#: model_terms:ir.ui.view,arch_db:document_page_portal.portal_my_home_menu_Knowledge +#: model_terms:ir.ui.view,arch_db:document_page_portal.portal_my_knowledge_document_pages +msgid "Knowledge Documents" +msgstr "Documenti knowledge" + +#. module: document_page_portal +#: code:addons/document_page_portal/controllers/portal.py:0 +#: model_terms:ir.ui.view,arch_db:document_page_portal.portal_my_knowledge_document_pages +#, python-format +msgid "Name" +msgstr "Nome" + +#. module: document_page_portal +#: code:addons/document_page_portal/controllers/portal.py:0 +#, python-format +msgid "Newest" +msgstr "Il più recente" + +#. module: document_page_portal +#: model:ir.model.fields,field_description:document_page_portal.field_document_page__is_public +msgid "Public Page" +msgstr "Pagina pubblica" + +#. module: document_page_portal +#: model_terms:ir.ui.view,arch_db:document_page_portal.portal_my_knowledge_document_pages +msgid "Ref" +msgstr "Rif." + +#. module: document_page_portal +#: code:addons/document_page_portal/controllers/portal.py:0 +#, python-format +msgid "Search (in Content)" +msgstr "Cerca (nel contenuto)" + +#. module: document_page_portal +#: code:addons/document_page_portal/controllers/portal.py:0 +#, python-format +msgid "Search in All" +msgstr "Cercare fra tutti" + +#. module: document_page_portal +#: model_terms:ir.ui.view,arch_db:document_page_portal.portal_my_knowledge_document_pages +msgid "There are currently no Knowledge Document for your account." +msgstr "Al momento non ci sono documenti knowledge per il tuo account." diff --git a/document_page_portal/i18n/pt_BR.po b/document_page_portal/i18n/pt_BR.po new file mode 100644 index 00000000000..f88df8b7716 --- /dev/null +++ b/document_page_portal/i18n/pt_BR.po @@ -0,0 +1,121 @@ +# Translation of Odoo Server. +# This file contains the translation of the following modules: +# * document_page_portal +# +msgid "" +msgstr "" +"Project-Id-Version: Odoo Server 13.0\n" +"Report-Msgid-Bugs-To: \n" +"POT-Creation-Date: 2019-11-27 14:08+0000\n" +"PO-Revision-Date: 2019-11-27 11:11-0300\n" +"Last-Translator: \n" +"Language-Team: \n" +"Language: pt_BR\n" +"MIME-Version: 1.0\n" +"Content-Type: text/plain; charset=UTF-8\n" +"Content-Transfer-Encoding: 8bit\n" +"Plural-Forms: nplurals=2; plural=(n > 1);\n" +"X-Generator: Poedit 2.2.4\n" + +#. module: document_page_portal +#: model_terms:ir.ui.view,arch_db:document_page_portal.document_pages_followup +msgid "No content" +msgstr "" + +#. module: document_page_portal +#: model_terms:ir.ui.view,arch_db:document_page_portal.document_pages_followup +msgid "Category:" +msgstr "" + +#. module: document_page_portal +#: code:addons/document_page_portal/controllers/portal.py:0 +#: model_terms:ir.ui.view,arch_db:document_page_portal.portal_my_knowledge_document_pages +#, python-format +msgid "Category" +msgstr "Categoria" + +#. module: document_page_portal +#: model_terms:ir.ui.view,arch_db:document_page_portal.document_pages_followup +msgid "Current Category of this document" +msgstr "" + +#. module: document_page_portal +#: model:ir.model,name:document_page_portal.model_document_page +msgid "Document Page" +msgstr "" + +#. module: document_page_portal +#: model:ir.model.fields,help:document_page_portal.field_document_page__is_public +msgid "" +"If true it allows any user of the portal to have access to this document." +msgstr "" + +#. module: document_page_portal +#: model_terms:ir.ui.view,arch_db:document_page_portal.portal_my_home_Knowledge_document_page +#: model_terms:ir.ui.view,arch_db:document_page_portal.portal_my_home_menu_Knowledge +#: model_terms:ir.ui.view,arch_db:document_page_portal.portal_my_knowledge_document_pages +msgid "Knowledge Documents" +msgstr "" + +#. module: document_page_portal +#: code:addons/document_page_portal/controllers/portal.py:0 +#: model_terms:ir.ui.view,arch_db:document_page_portal.portal_my_knowledge_document_pages +#, python-format +msgid "Name" +msgstr "Nome" + +#. module: document_page_portal +#: code:addons/document_page_portal/controllers/portal.py:0 +#, python-format +msgid "Newest" +msgstr "Mais Recentes" + +#. module: document_page_portal +#: model:ir.model.fields,field_description:document_page_portal.field_document_page__is_public +msgid "Public Page" +msgstr "" + +#. module: document_page_portal +#: model_terms:ir.ui.view,arch_db:document_page_portal.portal_my_knowledge_document_pages +msgid "Ref" +msgstr "" + +#. module: document_page_portal +#: code:addons/document_page_portal/controllers/portal.py:0 +#, python-format +msgid "Search (in Content)" +msgstr "" + +#. module: document_page_portal +#: code:addons/document_page_portal/controllers/portal.py:0 +#, python-format +msgid "Search in All" +msgstr "" + +#. module: document_page_portal +#: model_terms:ir.ui.view,arch_db:document_page_portal.portal_my_knowledge_document_pages +msgid "There are currently no Knowledge Document for your account." +msgstr "" + +#~ msgid "" +#~ "
\n" +#~ " Category:" +#~ msgstr "" +#~ "
\n" +#~ " Categoria:" + +#~ msgid "" +#~ "
\n" +#~ " Date:" +#~ msgstr "" +#~ "
\n" +#~ " Data:" + +#~ msgid "All" +#~ msgstr "Todos" + +#~ msgid "Documents" +#~ msgstr "Documentos" + +#~ msgid "There are no documents in your account." +#~ msgstr "Não há documentos em sua conta." diff --git a/document_page_portal/models/__init__.py b/document_page_portal/models/__init__.py new file mode 100644 index 00000000000..427be24e72a --- /dev/null +++ b/document_page_portal/models/__init__.py @@ -0,0 +1 @@ +from . import document_page diff --git a/document_page_portal/models/document_page.py b/document_page_portal/models/document_page.py new file mode 100644 index 00000000000..f779fc00815 --- /dev/null +++ b/document_page_portal/models/document_page.py @@ -0,0 +1,14 @@ +# Copyright 2020 - TODAY, Marcel Savegnago - Escodoo +# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl). + +from odoo import fields, models + + +class DocumentPage(models.Model): + _inherit = "document.page" + + is_public = fields.Boolean( + "Public Page", + help="If true it allows any user of the portal to have " + "access to this document.", + ) diff --git a/document_page_portal/pyproject.toml b/document_page_portal/pyproject.toml new file mode 100644 index 00000000000..4231d0cccb3 --- /dev/null +++ b/document_page_portal/pyproject.toml @@ -0,0 +1,3 @@ +[build-system] +requires = ["whool"] +build-backend = "whool.buildapi" diff --git a/document_page_portal/readme/CONFIGURE.md b/document_page_portal/readme/CONFIGURE.md new file mode 100644 index 00000000000..e7dc235973a --- /dev/null +++ b/document_page_portal/readme/CONFIGURE.md @@ -0,0 +1 @@ +No configuration required. diff --git a/document_page_portal/readme/CONTRIBUTORS.md b/document_page_portal/readme/CONTRIBUTORS.md new file mode 100644 index 00000000000..7c8bee76596 --- /dev/null +++ b/document_page_portal/readme/CONTRIBUTORS.md @@ -0,0 +1,4 @@ +- [Escodoo](https://www.escodoo.com.br): + - Marcel Savegnago \ +- [BPM Integrations Inc.](https://bpmint.com): + - Ken Woychesko \ diff --git a/document_page_portal/readme/CREDITS.md b/document_page_portal/readme/CREDITS.md new file mode 100644 index 00000000000..bc2e384225c --- /dev/null +++ b/document_page_portal/readme/CREDITS.md @@ -0,0 +1,3 @@ +The development of this module has been financially supported by: + +- [Escodoo](https://www.escodoo.com.br) diff --git a/document_page_portal/readme/DESCRIPTION.md b/document_page_portal/readme/DESCRIPTION.md new file mode 100644 index 00000000000..df3ee06c8ef --- /dev/null +++ b/document_page_portal/readme/DESCRIPTION.md @@ -0,0 +1,11 @@ +This module publishes Knowledge document pages (`document.page` records of +type _Content_) to the website portal, so that logged-in portal users can +read them from their _My Account_ area. + +A _Knowledge Documents_ entry is added to the portal home, listing the pages +each user is allowed to see, with search and category badges. + +Visibility is controlled per page: a page can be shared with **all portal +users** (the _Public_ flag) or restricted to the page's **followers**. Note +that _Public_ here means "any logged-in portal user"; it does **not** expose +pages to anonymous website visitors. diff --git a/document_page_portal/readme/USAGE.md b/document_page_portal/readme/USAGE.md new file mode 100644 index 00000000000..761f85cf891 --- /dev/null +++ b/document_page_portal/readme/USAGE.md @@ -0,0 +1,11 @@ +To make a document page available on the portal: + +1. Open a document page in the backend (under _Knowledge_). Only pages of + type _Content_ appear on the portal. +2. Choose who can see it: either tick **Public** to share it with every + portal user, or add the relevant portal user(s) as **followers** of the + page. + +Portal users then find their documents under **My Account > Knowledge +Documents** (`/my/knowledge/documents`), where they can browse, search, and +open each page. diff --git a/document_page_portal/security/document_page_portal_security.xml b/document_page_portal/security/document_page_portal_security.xml new file mode 100644 index 00000000000..8ec1a983b54 --- /dev/null +++ b/document_page_portal/security/document_page_portal_security.xml @@ -0,0 +1,26 @@ + + + + Documents: knowledge user: see all + + [(1, '=', 1)] + + + + Documents: portal users: portal or following + + + [ + '|', '|', ('type', '!=', 'content'), ('is_public', '=', True), + ('message_partner_ids', 'child_of', [user.partner_id.commercial_partner_id.id]) + ] + + + + diff --git a/document_page_portal/security/ir.model.access.csv b/document_page_portal/security/ir.model.access.csv new file mode 100644 index 00000000000..660b8280169 --- /dev/null +++ b/document_page_portal/security/ir.model.access.csv @@ -0,0 +1,3 @@ +id,name,model_id:id,group_id:id,perm_read,perm_write,perm_create,perm_unlink +document_page_portal,document.page portal,document_page.model_document_page,base.group_portal,1,0,0,0 +document_page_portal_user,document.page portal user,document_page.model_document_page,base.group_user,1,0,0,0 diff --git a/document_page_portal/static/description/banner.png b/document_page_portal/static/description/banner.png new file mode 100644 index 00000000000..da4f6de2a24 Binary files /dev/null and b/document_page_portal/static/description/banner.png differ diff --git a/document_page_portal/static/description/icon.png b/document_page_portal/static/description/icon.png new file mode 100644 index 00000000000..3a0328b516c Binary files /dev/null and b/document_page_portal/static/description/icon.png differ diff --git a/document_page_portal/static/description/index.html b/document_page_portal/static/description/index.html new file mode 100644 index 00000000000..b9fc69dec49 --- /dev/null +++ b/document_page_portal/static/description/index.html @@ -0,0 +1,468 @@ + + + + + +Document Page Portal + + + +
+

Document Page Portal

+ + +

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

+

This module publishes Knowledge document pages (document.page +records of type Content) to the website portal, so that logged-in +portal users can read them from their My Account area.

+

A Knowledge Documents entry is added to the portal home, listing the +pages each user is allowed to see, with search and category badges.

+

Visibility is controlled per page: a page can be shared with all +portal users (the Public flag) or restricted to the page’s +followers. Note that Public here means “any logged-in portal +user”; it does not expose pages to anonymous website visitors.

+

Table of contents

+ +
+

Configuration

+

No configuration required.

+
+
+

Usage

+

To make a document page available on the portal:

+
    +
  1. Open a document page in the backend (under Knowledge). Only pages +of type Content appear on the portal.
    2. +
  2. Choose who can see it: either tick Public to share it with every +portal user, or add the relevant portal user(s) as followers of +the page.
    3. +
+

Portal users then find their documents under My Account > Knowledge +Documents (/my/knowledge/documents), where they can browse, +search, and open each page.

+
+
+

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

+
    +
  • Escodoo
    • +
+
+ +
+

Other credits

+

The development of this module has been financially supported by:

+ +
+
+

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:

+

marcelsavegnago

+

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_portal/static/tests/tours/document_page_portal_tour.esm.js b/document_page_portal/static/tests/tours/document_page_portal_tour.esm.js new file mode 100644 index 00000000000..903f3840b9c --- /dev/null +++ b/document_page_portal/static/tests/tours/document_page_portal_tour.esm.js @@ -0,0 +1,47 @@ +/** @odoo-module **/ +/* Copyright 2020 - TODAY, Marcel Savegnago - Escodoo + License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl). */ + +import {registry} from "@web/core/registry"; + +registry.category("web_tour.tours").add("document_page_portal_tour", { + url: "/my", + steps: () => [ + { + content: "Check document_page_portal is loaded", + trigger: + 'a[href*="/my/knowledge/documents"]:contains("Knowledge Documents"):first', + run: "click", + }, + { + content: "Check public document_page is loaded", + trigger: + 'a[href*="/knowledge/document/"]:contains("Test Public Page 1"):first', + run: "click", + }, + { + content: "Verify the document page rendered", + trigger: 'h1:contains("Test Public Page 1")', + }, + ], +}); + +registry.category("web_tour.tours").add("document_page_portal_search_tour", { + url: "/my/knowledge/documents", + steps: () => [ + { + content: "Search", + trigger: "input[name='search']", + run: "edit Test", + }, + { + content: "Click Search.", + trigger: ".o_portal_navbar button[type='submit']", + run: "click", + }, + { + content: "Verify the matching document is in the search results", + trigger: 'a[href*="/knowledge/document/"]:contains("Test Public Page 1")', + }, + ], +}); diff --git a/document_page_portal/tests/__init__.py b/document_page_portal/tests/__init__.py new file mode 100644 index 00000000000..7e42ded9a53 --- /dev/null +++ b/document_page_portal/tests/__init__.py @@ -0,0 +1 @@ +from . import test_document_page_portal diff --git a/document_page_portal/tests/test_document_page_portal.py b/document_page_portal/tests/test_document_page_portal.py new file mode 100644 index 00000000000..53e686bd593 --- /dev/null +++ b/document_page_portal/tests/test_document_page_portal.py @@ -0,0 +1,33 @@ +# Copyright 2020 - TODAY, Marcel Savegnago - Escodoo +# License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl). + +import odoo.tests + + +@odoo.tests.tagged("post_install", "-at_install") +class TestPortalDocumentPage(odoo.tests.HttpCase): + def test_01_document_page_portal_tour(self): + # Create a public document + self.env["document.page"].create( + { + "name": "Test Public Page 1", + "content": "Test content", + "is_public": True, + } + ) + self.start_tour("/my", "document_page_portal_tour", login="portal") + + def test_02_document_page_portal_search_tour(self): + # Create a public document + self.env["document.page"].create( + { + "name": "Test Public Page 1", + "content": "Test content", + "is_public": True, + } + ) + self.start_tour( + "/my/knowledge/documents", + "document_page_portal_search_tour", + login="portal", + ) diff --git a/document_page_portal/views/document_page.xml b/document_page_portal/views/document_page.xml new file mode 100644 index 00000000000..898231ac317 --- /dev/null +++ b/document_page_portal/views/document_page.xml @@ -0,0 +1,15 @@ + + + + + document.page.form (in document_page_portal) + document.page + + + + + + + + diff --git a/document_page_portal/views/document_page_portal_templates.xml b/document_page_portal/views/document_page_portal_templates.xml new file mode 100644 index 00000000000..33be162e9a1 --- /dev/null +++ b/document_page_portal/views/document_page_portal_templates.xml @@ -0,0 +1,147 @@ + + + + + + + + + +