nc-py-api 0.11.0__py3-none-any.whl → 0.18.1__py3-none-any.whl

nc_py_api/files/__init__.py

@@ -4,10 +4,19 @@ import dataclasses
 import datetime
 import email.utils
 import enum
+import os
+import re
 import warnings
 
+from pydantic import BaseModel
+
 from .. import _misc
 
+user_regex = re.compile(r"(?:files|trashbin|versions)/([^/]+)/")
+"""Regex for evaluating user from full path string; instantiated once on import."""
+user_path_regex = re.compile(r".*?(files|trashbin|versions)/([^/]+)/")
+"""Regex for evaluating user path from full path string; instantiated once on import."""
+
 
 class LockType(enum.IntEnum):
     """Nextcloud File Locks types."""
@@ -200,9 +209,7 @@ class FsNode:
         )
 
     def __eq__(self, other):
-        if self.file_id and self.file_id == other.file_id:
-            return True
-        return False
+        return bool(self.file_id and self.file_id == other.file_id)
 
     @property
     def has_extra(self) -> bool:
@@ -217,12 +224,12 @@ class FsNode:
     @property
     def user(self) -> str:
         """Returns user ID extracted from the `full_path`."""
-        return self.full_path.lstrip("/").split("/", maxsplit=2)[1]
+        return user_regex.findall(self.full_path)[0]
 
     @property
     def user_path(self) -> str:
         """Returns path relative to the user's root directory."""
-        return self.full_path.lstrip("/").split("/", maxsplit=2)[-1]
+        return user_path_regex.sub("", self.full_path, count=1)
 
     @property
     def is_shared(self) -> bool:
@@ -279,12 +286,13 @@ class FilePermissions(enum.IntFlag):
     """Access to re-share object(s)"""
 
 
-def permissions_to_str(permissions: int, is_dir: bool = False) -> str:
+def permissions_to_str(permissions: int | str, is_dir: bool = False) -> str:
     """Converts integer permissions to string permissions.
 
     :param permissions: concatenation of ``FilePermissions`` integer flags.
     :param is_dir: Flag indicating is permissions related to the directory object or not.
     """
+    permissions = int(permissions) if not isinstance(permissions, int) else permissions
     r = ""
     if permissions & FilePermissions.PERMISSION_SHARE:
         r += "R"
@@ -461,3 +469,65 @@ class Share:
             f"{self.share_type.name}: `{self.path}` with id={self.share_id}"
             f" from {self.share_owner} to {self.share_with}"
         )
+
+
+class ActionFileInfo(BaseModel):
+    """Information Nextcloud sends to the External Application about File Nodes affected in action."""
+
+    fileId: int
+    """FileID without Nextcloud instance ID"""
+    name: str
+    """Name of the file/directory"""
+    directory: str
+    """Directory relative to the user's home directory"""
+    etag: str
+    mime: str
+    fileType: str
+    """**file** or **dir**"""
+    size: int
+    """size of file/directory"""
+    favorite: str
+    """**true** or **false**"""
+    permissions: int
+    """Combination of :py:class:`~nc_py_api.files.FilePermissions` values"""
+    mtime: int
+    """Last modified time"""
+    userId: str
+    """The ID of the user performing the action."""
+    shareOwner: str | None = None
+    """If the object is shared, this is a display name of the share owner."""
+    shareOwnerId: str | None = None
+    """If the object is shared, this is the owner ID of the share."""
+    instanceId: str | None = None
+    """Nextcloud instance ID."""
+
+    def to_fs_node(self) -> FsNode:
+        """Returns usual :py:class:`~nc_py_api.files.FsNode` created from this class."""
+        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("/"))
+        file_id = str(self.fileId).rjust(8, "0")
+
+        permissions = "S" if self.shareOwnerId else ""
+        permissions += permissions_to_str(self.permissions, is_dir)
+        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=file_id + self.instanceId if self.instanceId else file_id,
+            fileid=self.fileId,
+            last_modified=datetime.datetime.utcfromtimestamp(self.mtime).replace(tzinfo=datetime.timezone.utc),
+            mimetype=self.mime,
+        )
+
+
+class ActionFileInfoEx(BaseModel):
+    """New ``register_ex`` uses new data format which allowing receiving multiple NC Nodes in one request."""
+
+    files: list[ActionFileInfo]
+    """Always list of ``ActionFileInfo`` with one element minimum."""

nc_py_api/files/_files.py

@@ -168,6 +168,18 @@ def build_list_tags_response(response: Response) -> list[SystemTag]:
     return result
 
 
+def build_tags_ids_for_object(url_to_fetch: str, response: Response) -> list[int]:
+    result = []
+    records = _webdav_response_to_records(response, "list_tags_ids")
+    for record in records:
+        prop_stat = record["d:propstat"]
+        if str(prop_stat.get("d:status", "")).find("200 OK") != -1:
+            href_suffix = str(record["d:href"]).removeprefix(url_to_fetch).strip("/")
+            if href_suffix:
+                result.append(int(href_suffix))
+    return result
+
+
 def build_update_tag_req(
     name: str | None, user_visible: bool | None, user_assignable: bool | None
 ) -> ElementTree.Element: