UiActionFileInfo: added to_fs_node method. (#85)

```python3

def convert_video_to_gif(input_file: FsNode, nc: NextcloudApp):
    save_path = path.splitext(input_file.user_path)[0] + ".gif"
    pass

@APP.post("/video_to_gif")
async def video_to_gif(
    file: UiFileActionHandlerInfo,
    nc: Annotated[NextcloudApp, Depends(nc_app)],
    background_tasks: BackgroundTasks,
):
    background_tasks.add_task(convert_video_to_gif, file.actionFile.to_fs_node(), nc)
    return Response()
```

Allowing to create ``FsNode`` from ``UiFileActionHandlerInfo``.

Signed-off-by: Alexander Piskun <[email protected]>

Author: bigcat88

docs/reference/Files/Files.rst

@@ -14,3 +14,6 @@ All File APIs are designed to work relative to the current user.
 
 .. autoclass:: nc_py_api.files.FsNode
     :members:
+
+.. autoclass:: nc_py_api.files.FilePermissions
+    :members:

docs/reference/Files/Shares.rst

@@ -10,8 +10,5 @@ Refer to the `Sharing examples <https://github.com/cloud-py-api/nc_py_api/tree/m
 .. autoclass:: nc_py_api.files.sharing.Share
     :members:
 
-.. autoclass:: nc_py_api.files.sharing.SharePermissions
-    :members:
-
 .. autoclass:: nc_py_api.files.sharing.ShareType
     :members:

examples/as_app/skeleton/requirements.txt

@@ -1 +1 @@
-nc_py_api[app]>=0.0.30
+nc_py_api[app]>=0.0.31

examples/as_app/to_gif/Makefile

@@ -44,5 +44,5 @@ run27:
 .PHONY: manual_register
 manual_register:
 	docker exec master-nextcloud-1 sudo -u www-data php occ app_ecosystem_v2:app:register to_gif manual_install --json-info \
-  "{\"appid\":\"to_gif\",\"name\":\"to_gif\",\"daemon_config_name\":\"manual_install\",\"version\":\"1.0.0\",\"secret\":\"12345\",\"host\":\"host.docker.internal\",\"port\":9030,\"scopes\":{\"required\":[10],\"optional\":[32]},\"protocol\":\"http\",\"system_app\":0}" \
+  "{\"appid\":\"to_gif\",\"name\":\"to_gif\",\"daemon_config_name\":\"manual_install\",\"version\":\"1.0.0\",\"secret\":\"12345\",\"host\":\"host.docker.internal\",\"port\":9031,\"scopes\":{\"required\":[10],\"optional\":[32]},\"protocol\":\"http\",\"system_app\":0}" \
   -e --force-scopes

examples/as_app/to_gif/requirements.txt

@@ -1,4 +1,4 @@
-nc_py_api[app]>=0.0.30
+nc_py_api[app]>=0.0.31
 pygifsicle
 imageio
 opencv-python

examples/as_app/to_gif/src/main.py

@@ -11,10 +11,9 @@
 from pygifsicle import optimize
 from requests import Response
 
-from nc_py_api import NextcloudApp
+from nc_py_api import FsNode, NextcloudApp
 from nc_py_api.ex_app import (
     LogLvl,
-    UiActionFileInfo,
     UiFileActionHandlerInfo,
     nc_app,
     run_app,
@@ -24,13 +23,12 @@
 APP = FastAPI()
 
 
-def convert_video_to_gif(input_params: UiActionFileInfo, nc: NextcloudApp):
-    source_path = path.join(input_params.directory, input_params.name)
-    save_path = path.splitext(source_path)[0] + ".gif"
-    nc.log(LogLvl.WARNING, f"Processing:{source_path} -> {save_path}")
+def convert_video_to_gif(input_file: FsNode, nc: NextcloudApp):
+    save_path = path.splitext(input_file.user_path)[0] + ".gif"
+    nc.log(LogLvl.WARNING, f"Processing:{input_file.user_path} -> {save_path}")
     try:
         with tempfile.NamedTemporaryFile(mode="w+b") as tmp_in:
-            nc.files.download2stream(source_path, tmp_in)
+            nc.files.download2stream(input_file, tmp_in)
             nc.log(LogLvl.WARNING, "File downloaded")
             tmp_in.flush()
             cap = cv2.VideoCapture(tmp_in.name)
@@ -61,7 +59,7 @@ def convert_video_to_gif(input_params: UiActionFileInfo, nc: NextcloudApp):
                 nc.log(LogLvl.WARNING, "GIF is ready")
                 nc.files.upload_stream(save_path, tmp_out)
                 nc.log(LogLvl.WARNING, "Result uploaded")
-                nc.users.notifications.create(f"{input_params.name} finished!", f"{save_path} is waiting for you!")
+                nc.users.notifications.create(f"{input_file.name} finished!", f"{save_path} is waiting for you!")
     except Exception as e:
         nc.log(LogLvl.ERROR, str(e))
         nc.users.notifications.create("Error occurred", "Error information was written to log file")
@@ -73,7 +71,7 @@ async def video_to_gif(
     nc: Annotated[NextcloudApp, Depends(nc_app)],
     background_tasks: BackgroundTasks,
 ):
-    background_tasks.add_task(convert_video_to_gif, file.actionFile, nc)
+    background_tasks.add_task(convert_video_to_gif, file.actionFile.to_fs_node(), nc)
     return Response()
 
 

nc_py_api/__init__.py

@@ -3,6 +3,6 @@
 from . import ex_app, options
 from ._exceptions import NextcloudException, NextcloudExceptionNotFound
 from ._version import __version__
-from .files import FsNode
-from .files.sharing import SharePermissions, ShareType
+from .files import FilePermissions, FsNode
+from .files.sharing import ShareType
 from .nextcloud import Nextcloud, NextcloudApp

nc_py_api/ex_app/ui/files.py

@@ -1,9 +1,13 @@
 """Nextcloud API for working with drop-down file's menu."""
+import os
+from datetime import datetime, timezone
+
 from pydantic import BaseModel
 
 from ..._exceptions import NextcloudExceptionNotFound
 from ..._misc import require_capabilities
 from ..._session import NcSessionApp
+from ...files import FilePermissions, FsNode
 
 ENDPOINT_SUFFIX = "files/actions/menu"
 
@@ -16,8 +20,48 @@ class UiActionFileInfo(BaseModel):
     directory: str
     etag: str
     mime: str
+    fileType: str
+    size: int
     favorite: str
     permissions: int
+    mtime: int
+    userId: str
+    shared: str
+
+    def to_fs_node(self) -> FsNode:
+        """Returns created ``FsNode`` from the file info given.
+
+        .. note:: :py:class:FsNode.file_id in this case is ``without`` **instance_id**
+            and equal to :py:class:FsNode.info.fileid.
+        """
+        user_path = os.path.join(self.directory, self.name).rstrip("/")
+        is_dir = bool(self.fileType.lower() == "dir")
+        if is_dir:
+            user_path += "/"
+        full_path = os.path.join(f"files/{self.userId}", user_path.lstrip("/"))
+
+        permissions = "S" if self.shared.lower() == "true" else ""
+        if self.permissions & FilePermissions.PERMISSION_SHARE:
+            permissions += "R"
+        if self.permissions & FilePermissions.PERMISSION_READ:
+            permissions += "G"
+        if self.permissions & FilePermissions.PERMISSION_DELETE:
+            permissions += "D"
+        if self.permissions & FilePermissions.PERMISSION_UPDATE:
+            permissions += "NV" if is_dir else "NVW"
+        if is_dir and self.permissions & FilePermissions.PERMISSION_CREATE:
+            permissions += "CK"
+        return FsNode(
+            full_path,
+            etag=self.etag,
+            size=self.size,
+            content_length=0 if is_dir else self.size,
+            permissions=permissions,
+            favorite=bool(self.favorite.lower() == "true"),
+            file_id=self.fileId,
+            fileid=self.fileId,
+            last_modified=datetime.utcfromtimestamp(self.mtime).replace(tzinfo=timezone.utc),
+        )
 
 
 class UiFileActionHandlerInfo(BaseModel):

nc_py_api/files/__init__.py

@@ -3,6 +3,7 @@
 import dataclasses
 import datetime
 import email.utils
+import enum
 import typing
 
 
@@ -37,7 +38,7 @@ def __init__(self, **kwargs):
     def last_modified(self) -> datetime.datetime:
         """Time when the object was last modified.
 
-        .. note:: ETag if more preferable way to check if the object was changed.
+        .. note:: ETag is a more preferable way to check if the object was changed.
         """
         return self._last_modified
 
@@ -148,3 +149,18 @@ def is_creatable(self) -> bool:
         if not self.is_dir:
             return False
         return self.info.permissions.find("CK") != -1
+
+
+class FilePermissions(enum.IntFlag):
+    """List of available permissions for files/directories."""
+
+    PERMISSION_READ = 1
+    """Access to read"""
+    PERMISSION_UPDATE = 2
+    """Access to write"""
+    PERMISSION_CREATE = 4
+    """Access to create new objects in the directory"""
+    PERMISSION_DELETE = 8
+    """Access to remove object(s)"""
+    PERMISSION_SHARE = 16
+    """Access to re-share object(s)"""

nc_py_api/files/sharing.py

@@ -4,22 +4,7 @@
 import typing
 
 from .. import _misc, _session
-from . import FsNode
-
-
-class SharePermissions(enum.IntFlag):
-    """The share permissions to be set."""
-
-    PERMISSION_READ = 1
-    """Access to read"""
-    PERMISSION_UPDATE = 2
-    """Access to write"""
-    PERMISSION_CREATE = 4
-    """Access to create new objects in the share"""
-    PERMISSION_DELETE = 8
-    """Access to remove objects in the share"""
-    PERMISSION_SHARE = 16
-    """Access to re-share objects in the share"""
+from . import FilePermissions, FsNode
 
 
 class ShareType(enum.IntEnum):
@@ -71,9 +56,9 @@ def share_with(self) -> str:
         return self.raw_data["share_with"]
 
     @property
-    def permissions(self) -> SharePermissions:
+    def permissions(self) -> FilePermissions:
         """Recipient permissions."""
-        return SharePermissions(int(self.raw_data["permissions"]))
+        return FilePermissions(int(self.raw_data["permissions"]))
 
     @property
     def url(self) -> str:
@@ -186,15 +171,15 @@ def create(
         self,
         path: typing.Union[str, FsNode],
         share_type: ShareType,
-        permissions: typing.Optional[SharePermissions] = None,
+        permissions: typing.Optional[FilePermissions] = None,
         share_with: str = "",
         **kwargs,
     ) -> Share:
         """Creates a new share.
 
         :param path: The path of an existing file/directory.
         :param share_type: :py:class:`~nc_py_api.files.sharing.ShareType` value.
-        :param permissions: combination of the :py:class:`~nc_py_api.files.sharing.SharePermissions` object values.
+        :param permissions: combination of the :py:class:`~nc_py_api.files.FilePermissions` values.
         :param share_with: the recipient of the shared object.
         :param kwargs: See below.