[18.0][MIG] document_page_portal

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 <https://github.com/OCA/knowledge/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 <https://github.com/OCA/knowledge/issues/new?body=module:%20document_page_portal%0Aversion:%2018.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**>`_.
+
+Do not contact contributors directly about support or help with technical issues.
+
+Credits
+=======
+
+Authors
+-------
+
+* Escodoo
+
+Contributors
+------------
+
+- `Escodoo <https://www.escodoo.com.br>`__:
+
+  - Marcel Savegnago <marcel.savegnago@escodoo.com.br>
+
+- `BPM Integrations Inc. <https://bpmint.com>`__:
+
+  - Ken Woychesko <kwoychesko@bpmint.com>
+
+Other credits
+-------------
+
+The development of this module has been financially supported by:
+
+- `Escodoo <https://www.escodoo.com.br>`__
+
+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 <https://odoo-community.org/page/maintainer-role>`__:
+
+|maintainer-marcelsavegnago| 
+
+This module is part of the `OCA/knowledge <https://github.com/OCA/knowledge/tree/18.0/document_page_portal>`_ project on GitHub.
+
+You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.

document_page_portal/__init__.py

@@ -0,0 +1,2 @@
+from . import controllers
+from . import models

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",
+        ],
+    },
+}

document_page_portal/controllers/__init__.py

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

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/<int: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 <span class="nolabel"> (in Content)</span>'),
+            },
+            "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/<int:document_page_id>",
+            "/knowledge/document/<int:document_page_id>/<token>",
+            "/my/knowledge/document/<int:document_page_id>",
+        ],
+        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)