odoo-addon-dms 16.0.1.8.0.3__py3-none-any.whl → 17.0.1.0.0.2__py3-none-any.whl

odoo/addons/dms/controllers/portal.py

@@ -1,5 +1,8 @@
 # Copyright 2020-2021 Tecnativa - Víctor Martínez
+# Copyright 2024 Subteno - Timothée VANNIER (https://www.subteno.com).
+# License LGPL-3.0 or later (https://www.gnu.org/licenses/lgpl).
 import base64
+from typing import Optional  # noqa # pylint: disable=unused-import
 
 from odoo import _, http
 from odoo.http import content_disposition, request
@@ -11,6 +14,15 @@ from odoo.addons.web.controllers.utils import ensure_db
 
 class CustomerPortal(CustomerPortal):
     def _dms_check_access(self, model, res_id, access_token=None):
+        """
+        Check access to the record.
+
+        :param str model: model
+        :param int res_id: res_id
+        :param Optional[str] access_token: access_token
+
+        :return: item
+        """
         item = request.env[model].browse(res_id)
         if access_token:
             item = item.sudo()
@@ -32,34 +44,34 @@ class CustomerPortal(CustomerPortal):
     def portal_my_dms(
         self, sortby=None, filterby=None, search=None, search_in="name", **kw
     ):
+        """
+        Display the main page for the DMS module.
+
+        :param Optional[str] sortby: The field to sort by
+        :param Optional[str] filterby: The field to filter by
+        :param Optional[str] search: The search term
+        :param Optional[str] search_in: The field to search in
+
+        :return: response
+        :rtype: odoo.http.Response
+        """
         values = self._prepare_portal_layout_values()
-        searchbar_sortings = {"name": {"label": _("Name"), "order": "name asc"}}
-        # default sortby br
-        if not sortby:
-            sortby = "name"
-        sort_br = searchbar_sortings[sortby]["order"]
-        # search
-        searchbar_inputs = {
-            "name": {"input": "name", "label": _("Name")},
-        }
-        if not filterby:
-            filterby = "name"
+        (
+            filterby,
+            searchbar_inputs,
+            searchbar_sortings,
+            sort_order,
+            sortby,
+        ) = self._searchbar_data(filterby, sortby)
         # domain
         domain = [
-            (
-                "id",
-                "in",
-                request.env["dms.directory"]._get_own_root_directories(),
-            )
+            ("id", "in", request.env["dms.directory"]._get_own_root_directories()),
         ]
         # search
-        if search and search_in:
-            search_domain = []
-            if search_in == "name":
-                search_domain = OR([search_domain, [("name", "ilike", search)]])
-            domain += search_domain
+        if search and search_in == "name":
+            domain += OR([[], [("name", "ilike", search)]])
         # content according to pager and archive selected
-        items = request.env["dms.directory"].search(domain, order=sort_br)
+        items = request.env["dms.directory"].search(domain, order=sort_order)
         request.session["my_dms_folder_history"] = items.ids
         # values
         values.update(
@@ -91,65 +103,42 @@ class CustomerPortal(CustomerPortal):
         search=None,
         search_in="name",
         access_token=None,
-        **kw
+        **kw,
     ):
+        """
+        Display the content of a directory.
+
+        :param Optional[int] dms_directory_id: dms_directory_id
+        :param Optional[str] sortby: sortby
+        :param Optional[str] filterby: filterby
+        :param Optional[str] search: search
+        :param Optional[str] search_in: search_in
+        :param Optional[str] access_token: access_token
+
+        :return: response
+        :rtype: odoo.http.Response
+        """
         ensure_db()
         # operations
-        searchbar_sortings = {"name": {"label": _("Name"), "order": "name asc"}}
-        # default sortby br
-        if not sortby:
-            sortby = "name"
-        sort_br = searchbar_sortings[sortby]["order"]
-        # search
-        searchbar_inputs = {
-            "name": {"input": "name", "label": _("Name")},
-        }
-        if not filterby:
-            filterby = "name"
-        # domain
-        domain = [("is_hidden", "=", False), ("parent_id", "=", dms_directory_id)]
-        # search
-        if search and search_in:
-            search_domain = []
-            if search_in == "name":
-                search_domain = OR([search_domain, [("name", "ilike", search)]])
-            domain += search_domain
-        # content according to pager and archive selected
-        if access_token:
-            dms_directory_items = (
-                request.env["dms.directory"].sudo().search(domain, order=sort_br)
-            )
-        else:
-            dms_directory_items = request.env["dms.directory"].search(
-                domain, order=sort_br
-            )
-        request.session["my_dms_folder_history"] = dms_directory_items.ids
-        res = self._dms_check_access("dms.directory", dms_directory_id, access_token)
+        (
+            filterby,
+            searchbar_inputs,
+            searchbar_sortings,
+            sort_order,
+            sortby,
+        ) = self._searchbar_data(filterby, sortby)
+        dms_directory_items, res = self._get_directories(
+            access_token, dms_directory_id, search, search_in, sort_order
+        )
         if not res:
-            if access_token:
-                return request.redirect("/")
-            else:
-                return request.redirect("/my")
+            return request.redirect("/" if access_token else "/my")
+
         dms_directory_sudo = res
         # dms_files_count
-        domain = [
-            ("is_hidden", "=", False),
-            ("directory_id", "=", dms_directory_id),
-        ]
-        # search
-        if search and search_in:
-            search_domain = []
-            if search_in == "name":
-                search_domain = OR([search_domain, [("name", "ilike", search)]])
-            domain += search_domain
-        # items
-        if access_token:
-            dms_file_items = (
-                request.env["dms.file"].sudo().search(domain, order=sort_br)
-            )
-        else:
-            dms_file_items = request.env["dms.file"].search(domain, order=sort_br)
-        request.session["my_dms_file_history"] = dms_file_items.ids
+        dms_file_items = self._get_files(
+            access_token, dms_directory_id, search, search_in, sort_order
+        )
+
         dms_parent_categories = dms_directory_sudo.sudo()._get_parent_categories(
             access_token
         )
@@ -170,6 +159,101 @@ class CustomerPortal(CustomerPortal):
         }
         return request.render("dms.portal_my_dms", values)
 
+    def _get_files(self, access_token, dms_directory_id, search, search_in, sort_br):
+        """
+        Get files from dms_directory_id
+
+        :param Optional[str] access_token: access_token
+        :param int dms_directory_id: dms_directory_id
+        :param Optional[str] search: search
+        :param Optional[str] search_in: search_in
+        :param str sort_br: sort_br
+
+        :return: dms_file_items
+        :rtype: odoo.model.dms_file
+        """
+        if not dms_directory_id:
+            return request.env["dms.file"]
+        file_domain = [
+            ("is_hidden", "=", False),
+            ("directory_id", "=", dms_directory_id),
+        ]
+        # search
+        if search and search_in == "name":
+            file_domain.append(("name", "ilike", search))
+
+        # items
+        file_model = request.env["dms.file"]
+        is_access_token_valid = file_model.check_access_token(access_token)
+        file_model = file_model.sudo() if is_access_token_valid else file_model
+        dms_file_items = file_model.search(file_domain, order=sort_br)
+        request.session["my_dms_file_history"] = dms_file_items.ids
+        return dms_file_items
+
+    def _get_directories(
+        self, access_token, dms_directory_id, search, search_in, sort_order
+    ):
+        """
+        Get directories from dms_directory_id
+
+        :param Optional[str] access_token: access_token
+        :param int dms_directory_id: dms_directory_id
+        :param Optional[str] search: search
+        :param Optional[str] search_in: search_in
+        :param str sort_order: sort_br
+
+        :return: dms_directory_items, res
+        :rtype: tuple[odoo.model.dms_directory, bool|odoo.model.dms_directory]
+        """
+        # domain
+        domain = [("is_hidden", "=", False), ("parent_id", "=", dms_directory_id)]
+        # search
+        if search and search_in:
+            domain.append(("name", "ilike", search))
+
+        # content according to pager and archive selected
+        directory_model = request.env["dms.directory"]
+        directory_to_check = directory_model.browse(dms_directory_id)
+        is_access_token_valid = directory_to_check.check_access_token(access_token)
+        directory_model = (
+            directory_model.sudo() if is_access_token_valid else directory_model
+        )
+        dms_directory_items = directory_model.search(domain, order=sort_order)
+
+        request.session["my_dms_folder_history"] = dms_directory_items.ids
+        res = self._dms_check_access("dms.directory", dms_directory_id, access_token)
+        return dms_directory_items, res
+
+    def _searchbar_data(self, filterby, sortby):
+        """
+        Prepare searchbar data for portal.
+
+        :param str filterby: filterby
+        :param str sortby: sortby
+
+        :return: filterby, searchbar_inputs, searchbar_sortings, sort_order,
+        sortby
+        :rtype: tuple[str, dict, dict, str, str]
+        """
+        searchbar_sortings = {"name": {"label": _("Name"), "order": "name asc"}}
+        # default sortby
+        if not sortby:
+            sortby = "name"
+        sort_order = searchbar_sortings[sortby]["order"]
+        # search
+        searchbar_inputs = {
+            "name": {"input": "name", "label": _("Name")},
+        }
+        if not filterby:
+            filterby = "name"
+        return (
+            filterby,
+            searchbar_inputs,
+            searchbar_sortings,
+            sort_order,
+            sortby,
+        )
+
     @http.route(
         ["/my/dms/file/<int:dms_file_id>/download"],
         type="http",
@@ -177,26 +261,28 @@ class CustomerPortal(CustomerPortal):
         website=True,
     )
     def portal_my_dms_file_download(self, dms_file_id, access_token=None, **kw):
-        """Process user's consent acceptance or rejection."""
+        """
+        Download a file.
+
+        :param int dms_file_id: dms_file_id
+        :param Optional[str] access_token: access_token
+
+        :return: response
+        :rtype: odoo.http.Response
+        """
         ensure_db()
-        # operations
         res = self._dms_check_access("dms.file", dms_file_id, access_token)
         if not res:
             if access_token:
                 return request.redirect("/")
-            else:
-                return request.redirect("/my")
-
-        dms_file_sudo = res
-        # It's necessary to prevent AccessError in ir_attachment .check() function
-        if dms_file_sudo.attachment_id and request.env.user.has_group(
-            "base.group_portal"
-        ):
-            dms_file_sudo = dms_file_sudo.sudo()
-        filecontent = base64.b64decode(dms_file_sudo.content)
-        content_type = ["Content-Type", "application/octet-stream"]
-        disposition_content = [
+            return request.redirect("/my")
+
+        if res.attachment_id and request.env.user.has_group("base.group_portal"):
+            res = res.sudo()
+        file_content = base64.b64decode(res.content)
+        content_type = ("Content-Type", "application/octet-stream")
+        disposition_content = (
             "Content-Disposition",
-            content_disposition(dms_file_sudo.name),
-        ]
-        return request.make_response(filecontent, [content_type, disposition_content])
+            content_disposition(res.name),
+        )
+        return request.make_response(file_content, [content_type, disposition_content])

odoo/addons/dms/data/onboarding_data.xml

@@ -0,0 +1,77 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+<!--
+    Copyright 2024 Subteno - Timothée Vannier (https://www.subteno.com).
+    License LGPL-3.0 or later (http://www.gnu.org/licenses/lgpl).
+-->
+<odoo noupdate="1">
+
+    <!--  Steps (has to be fist so that onboarding panel can access it) -->
+    <record id="onboarding_step_document_storage" model="onboarding.onboarding.step">
+        <field name="title">Storage</field>
+        <field name="description">Create a new Document Storage.</field>
+        <field name="button_text">Create Storage</field>
+        <field name="done_text">Document Storage Created!</field>
+        <field
+            name="panel_step_open_action_name"
+        >action_open_documents_onboarding_storage</field>
+        <field
+            name="step_image"
+            type="base64"
+            file="base/static/img/onboarding_default.png"
+        />
+        <field name="step_image_filename">onboarding_default.png</field>
+        <field name="step_image_alt">Onboarding Storage</field>
+        <field name="sequence">1</field>
+    </record>
+
+    <record id="onboarding_step_create_directory" model="onboarding.onboarding.step">
+        <field name="title">Directory</field>
+        <field name="description">Create a new Root Directory.</field>
+        <field name="button_text">Create Directory</field>
+        <field name="done_text">Root Directory Created!</field>
+        <field
+            name="panel_step_open_action_name"
+        >action_open_documents_onboarding_directory</field>
+        <field
+            name="step_image"
+            type="base64"
+            file="base/static/img/onboarding_default.png"
+        />
+        <field name="step_image_filename">onboarding_default.png</field>
+        <field name="step_image_alt">Onboarding Directory</field>
+        <field name="sequence">2</field>
+    </record>
+
+    <record id="onboarding_step_upload_file" model="onboarding.onboarding.step">
+        <field name="title">File</field>
+        <field name="description">Upload your first File.</field>
+        <field name="button_text">Upload File</field>
+        <field name="done_text">First File Uploaded!</field>
+        <field
+            name="panel_step_open_action_name"
+        >action_open_documents_onboarding_file</field>
+        <field
+            name="step_image"
+            type="base64"
+            file="base/static/img/onboarding_default.png"
+        />
+        <field name="step_image_filename">onboarding_default.png</field>
+        <field name="step_image_alt">Onboarding File</field>
+        <field name="sequence">3</field>
+    </record>
+
+    <!--  File Onboarding Panel -->
+    <record id="onboarding_onboarding_dms_file" model="onboarding.onboarding">
+        <field name="name">File Onboarding</field>
+        <field
+            name="step_ids"
+            eval="[
+            Command.link(ref('dms.onboarding_step_document_storage')),
+            Command.link(ref('dms.onboarding_step_create_directory')),
+            Command.link(ref('dms.onboarding_step_upload_file'))
+        ]"
+        />
+        <field name="route_name">document_onboarding_file</field>
+        <field name="panel_close_action_name">action_close_panel_dms_file</field>
+    </record>
+</odoo>

odoo/addons/dms/demo/access_group.xml

@@ -5,20 +5,14 @@
         <field name="perm_create">True</field>
         <field name="perm_write">True</field>
         <field name="perm_unlink">True</field>
-        <field
-            name="explicit_user_ids"
-            eval="[(6, 0, [ref('base.user_admin'), ref('base.user_demo')])]"
-        />
+        <field name="explicit_user_ids" eval="[(6, 0, [ref('base.user_admin')])]" />
     </record>
     <record id="access_group_02_demo" model="dms.access.group">
         <field name="name">Portal</field>
         <field name="group_ids" eval="[(6, 0, [ref('base.group_portal')])]" />
     </record>
     <record id="access_group_03_demo" model="dms.access.group">
-        <field name="name">Only admin user</field>
-        <field name="perm_create">True</field>
-        <field name="perm_write">True</field>
-        <field name="perm_unlink">True</field>
-        <field name="explicit_user_ids" eval="[(6, 0, [ref('base.user_admin')])]" />
+        <field name="name">User</field>
+        <field name="explicit_user_ids" eval="[(6, 0, [ref('base.user_demo')])]" />
     </record>
 </odoo>