NXDRIVE-2942: Improve folder selection on Direct Transfer screen

docs/changes/5.5.1.md

@@ -13,6 +13,7 @@ Release date: `2024-xx-xx`
 ### Direct Transfer
 
 - [NXDRIVE-2915](https://jira.nuxeo.com/browse/NXDRIVE-2915): Translate "Document type" and "container type" labels on Direct Transfer popup
+- [NXDRIVE-2942](https://jira.nuxeo.com/browse/NXDRIVE-2942): Improve folder selection on Direct Transfer screen
 
 ### Task Management
 - [NXDRIVE-2](https://jira.nuxeo.com/browse/NXDRIVE-2):

nxdrive/constants.py

@@ -70,6 +70,8 @@
     errno.ERANGE,  # Result too large
 }
 
+QUERY_ENDPOINT = "/api/v1/search/lang/NXQL/execute?query="
+
 # OSError indicating the incapacity to do anything because of too long file name or deep tree
 LONG_FILE_ERRORS = {errno.ENAMETOOLONG}
 if WINDOWS:

nxdrive/gui/folders_loader.py

@@ -43,10 +43,14 @@
                 return
             elif info.get_id() not in self.tree.cache:
                 self.tree.cache.append(info.get_id())
-
         try:
             if info:
-                children = list(self.tree.client.get_children(info))
+                if not info.is_expandable() and not info.get_path().startswith(
+                    "/default-domain/UserWorkspaces/"
+                ):
+                    children = []
+                else:
+                    children = list(self.tree.client.get_children(info))
             else:
                 children = list(self.tree.client.get_top_documents())
         except Exception:

nxdrive/gui/folders_model.py

@@ -1,5 +1,5 @@
 from logging import getLogger
-from typing import Iterator, List, Union
+from typing import Any, Iterator, List, Union
 
 from nuxeo.models import Document
 
@@ -81,45 +81,72 @@
 class Doc(FileInfo):
     """A folderish document. Used by the Direct Transfer feature."""
 
-    def __init__(self, doc: Document, /, *, parent: FileInfo = None) -> None:
+    def __init__(
+        self, doc: Document, expandable: bool = True, /, *, parent: FileInfo = None
+    ) -> None:
         super().__init__(parent=parent)
         self.doc = doc
+        self.expandable = expandable
 
     def __repr__(self) -> str:
         return (
             f"{type(self).__name__}<id={self.get_id()}, label={self.get_label()}, "
+            f"is_expandable={self.is_expandable()!r}, "
             f"parent={self.get_path()!r}, enable={self.enable()!r}, selectable={self.selectable()!r}>"
         )
 
+    def is_expandable(self) -> bool:
+        """Returns if the current user is an Admin"""
+        return self.expandable
+
     def folderish(self) -> bool:
         """Only folders are used, so it is always True."""
         return True
 
     def enable(self) -> bool:
         """Allow to select the folder only if the user can effectively create documents inside."""
-        return (
-            "HiddenInCreation" not in self.doc.facets
-            and self.doc.type not in Options.disallowed_types_for_dt
-            and "AddChildren" in self.doc.contextParameters["permissions"]
-        )
+        try:
+            return (
+                "HiddenInCreation" not in self.doc.facets
+                and self.doc.type not in Options.disallowed_types_for_dt
+                and "AddChildren" in self.doc.contextParameters["permissions"]
+            )
+        except Exception:
+            return (
+                "HiddenInCreation" not in self.doc["facets"]
+                and self.doc["type"] not in Options.disallowed_types_for_dt
+                and "AddChildren" in self.doc["contextParameters"]["permissions"]
+            )
 
     def get_id(self) -> str:
         """The document's UID."""
-        return self.doc.uid
+        try:
+            return self.doc.uid
+        except Exception:
+            return self.doc["uid"]
 
     def get_label(self) -> str:
         """The document's name as it is showed in the tree."""
-        return self.doc.title
+        try:
+            return self.doc.title
+        except Exception:
+            return self.doc["title"]
 
     def get_path(self) -> str:
         """Guess the document's path on the server."""
-        return self.doc.path
+        try:
+            return self.doc.path
+        except Exception:
+            return self.doc["path"]
 
     def selectable(self) -> bool:
         """Allow to fetch its children only if the user has at least the "Read" permission
         and if it contains at least one subfolder.
         """
-        return "Read" in self.doc.contextParameters["permissions"]
+        try:
+            return "Read" in self.doc.contextParameters["permissions"]
+        except Exception:
+            return "Read" in self.doc["contextParameters"]["permissions"]
 
 
 class FilteredDoc(FileInfo):
@@ -147,9 +174,14 @@
     def __repr__(self) -> str:
         return (
             f"{type(self).__name__}<state={self.state}, id={self.get_id()}, "
+            f"is_expandable={self.is_expandable()!r}, "
             f"label={self.get_label()}, folderish={self.folderish()!r}, parent={self.get_path()!r}>"
         )
 
+    def is_expandable(self) -> bool:
+        """Returns if the current user is an Admin"""
+        return True
+
     def get_label(self) -> str:
         """The document's name as it is showed in the tree."""
         return self.fs_info.name
@@ -247,6 +279,12 @@
                 )
             )
 
+    def get_roots(self) -> List[Any]:
+        from ..constants import QUERY_ENDPOINT
+
+        url = f"{QUERY_ENDPOINT}select * from Document WHERE ecm:mixinType = 'Folderish' and ecm:isTrashed = 0"
+        return self.remote.client.request("GET", url).json()["entries"]
+
     def _get_root_folders(self) -> List["Documents"]:
         """Get root folders.
         Use a try...except block to prevent loading error on the root,
@@ -256,9 +294,28 @@
             root = self.remote.documents.get(path="/")
             return [Doc(doc) for doc in self._get_children(root.uid)]
         except Exception:
-            log.warning("Error while retrieving documents on '/'", exc_info=True)
-            context = {"permissions": [], "hasFolderishChild": False}
-            return [Doc(Document(title="/", contextParameters=context))]
+            if Options.shared_folder_navigation:
+                roots = self.get_roots()
+                ret_list = []
+                for root in roots:
+                    if root["type"] == "Folder" and not root["path"].startswith(
+                        "/default-domain/UserWorkspaces/"
+                    ):
+                        doc = self.remote.fetch(
+                            root["uid"],
+                            enrichers=["permissions"],
+                        )
+                        if (
+                            "Write" in doc["contextParameters"]["permissions"]
+                            or "ReadWrite" in doc["contextParameters"]["permissions"]
+                            or "Everything" in doc["contextParameters"]["permissions"]
+                        ):
+                            ret_list.append(Doc(doc, False))
+                return ret_list
+            else:
+                log.warning("Error while retrieving documents on '/'", exc_info=True)
+                context = {"permissions": [], "hasFolderishChild": False}
+                return [Doc(Document(title="/", contextParameters=context))]
 
     def get_top_documents(self) -> Iterator["Documents"]:
         """Fetch all documents at the root."""

nxdrive/gui/folders_treeview.py

@@ -184,13 +184,13 @@
 
     def on_selection_changed(self, current: QModelIndex, _: QModelIndex, /) -> None:
         """Actions to do when a folder is selected."""
-        item = self.model().itemFromIndex(current).data(qt.UserRole)
-        self.parent.remote_folder.setText(item.get_path())
-        self.parent.remote_folder_ref = item.get_id()
-        self.parent.remote_folder_title = item.get_label()
-        self.current = current
-        self.parent.button_ok_state()
-        self.parent.update_file_group()
+        if item := self.model().itemFromIndex(current).data(qt.UserRole):
+            self.parent.remote_folder.setText(item.get_path())
+            self.parent.remote_folder_ref = item.get_id()
+            self.parent.remote_folder_title = item.get_label()
+            self.current = current
+            self.parent.button_ok_state()
+            self.parent.update_file_group()
 
     def refresh_selected(self) -> None:
         """Force reload the the current selected index."""

nxdrive/options.py

@@ -237,6 +237,7 @@ class MetaOptions(type):
         "debug_pydev": (False, "default"),
         "delay": (30, "default"),
         "deletion_behavior": ("unsync", "default"),
+        "shared_folder_navigation": (False, "default"),
         "disabled_file_integrity_check": (False, "default"),
         "disallowed_types_for_dt": (__doctypes_no_dt, "default"),
         "dt_hide_personal_space": (False, "default"),