nc-py-api 0.10.0__tar.gz → 0.11.0__tar.gz

{nc_py_api-0.10.0 → nc_py_api-0.11.0}/CHANGELOG.md

@@ -2,6 +2,16 @@
 
 All notable changes to this project will be documented in this file.
 
+## [0.11.0 - 2024-02-17]
+
+### Added
+
+- Files: `lock` and `unlock` methods, lock file information to `FsNode`. #227
+
+### Fixed
+
+- NextcloudApp: `MachineTranslation` provider registration - added optional `actionDetectLang` param. #229
+
 ## [0.10.0 - 2024-02-14]
 
 ### Added

{nc_py_api-0.10.0 → nc_py_api-0.11.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: nc-py-api
-Version: 0.10.0
+Version: 0.11.0
 Summary: Nextcloud Python Framework
 Project-URL: Changelog, https://github.com/cloud-py-api/nc_py_api/blob/main/CHANGELOG.md
 Project-URL: Documentation, https://cloud-py-api.github.io/nc_py_api/
@@ -10,7 +10,7 @@ License-Expression: BSD-3-Clause
 License-File: AUTHORS
 License-File: LICENSE.txt
 Keywords: api,client,framework,library,nextcloud
-Classifier: Development Status :: 3 - Alpha
+Classifier: Development Status :: 4 - Beta
 Classifier: Intended Audience :: Developers
 Classifier: License :: OSI Approved :: BSD License
 Classifier: Operating System :: MacOS :: MacOS X

{nc_py_api-0.10.0 → nc_py_api-0.11.0}/nc_py_api/__init__.py

@@ -7,6 +7,6 @@ from ._exceptions import (
     NextcloudMissingCapabilities,
 )
 from ._version import __version__
-from .files import FilePermissions, FsNode
+from .files import FilePermissions, FsNode, LockType
 from .files.sharing import ShareType
 from .nextcloud import AsyncNextcloud, AsyncNextcloudApp, Nextcloud, NextcloudApp

{nc_py_api-0.10.0 → nc_py_api-0.11.0}/nc_py_api/_version.py

@@ -1,3 +1,3 @@
 """Version of nc_py_api."""
 
-__version__ = "0.10.0"
+__version__ = "0.11.0"

{nc_py_api-0.10.0 → nc_py_api-0.11.0}/nc_py_api/ex_app/providers/translations.py

@@ -42,6 +42,11 @@ class TranslationsProvider:
         """Relative ExApp url which will be called by Nextcloud."""
         return self._raw_data["action_handler"]
 
+    @property
+    def action_handler_detect_lang(self) -> str:
+        """Relative ExApp url which will be called by Nextcloud to detect language."""
+        return self._raw_data.get("action_detect_lang", "")
+
     def __repr__(self):
         return f"<{self.__class__.__name__} name={self.name}, handler={self.action_handler}>"
 
@@ -59,6 +64,7 @@ class _TranslationsProviderAPI:
         callback_url: str,
         from_languages: dict[str, str],
         to_languages: dict[str, str],
+        detect_lang_callback_url: str = "",
     ) -> None:
         """Registers or edit the Translations provider."""
         require_capabilities("app_api", self._session.capabilities)
@@ -68,6 +74,7 @@ class _TranslationsProviderAPI:
             "fromLanguages": from_languages,
             "toLanguages": to_languages,
             "actionHandler": callback_url,
+            "actionDetectLang": detect_lang_callback_url,
         }
         self._session.ocs("POST", f"{self._session.ae_url}/{_EP_SUFFIX}", json=params)
 
@@ -114,6 +121,7 @@ class _AsyncTranslationsProviderAPI:
         callback_url: str,
         from_languages: dict[str, str],
         to_languages: dict[str, str],
+        detect_lang_callback_url: str = "",
     ) -> None:
         """Registers or edit the Translations provider."""
         require_capabilities("app_api", await self._session.capabilities)
@@ -123,6 +131,7 @@ class _AsyncTranslationsProviderAPI:
             "fromLanguages": from_languages,
             "toLanguages": to_languages,
             "actionHandler": callback_url,
+            "actionDetectLang": detect_lang_callback_url,
         }
         await self._session.ocs("POST", f"{self._session.ae_url}/{_EP_SUFFIX}", json=params)
 

{nc_py_api-0.10.0 → nc_py_api-0.11.0}/nc_py_api/files/__init__.py

@@ -9,6 +9,63 @@ import warnings
 from .. import _misc
 
 
+class LockType(enum.IntEnum):
+    """Nextcloud File Locks types."""
+
+    MANUAL_LOCK = 0
+    COLLABORATIVE_LOCK = 1
+    WEBDAV_TOKEN = 2
+
+
+@dataclasses.dataclass
+class FsNodeLockInfo:
+    """File Lock information if Nextcloud `files_lock` is enabled."""
+
+    def __init__(self, **kwargs):
+        self._is_locked = bool(int(kwargs.get("is_locked", False)))
+        self._lock_owner_type = LockType(int(kwargs.get("lock_owner_type", 0)))
+        self._lock_owner = kwargs.get("lock_owner", "")
+        self._owner_display_name = kwargs.get("owner_display_name", "")
+        self._owner_editor = kwargs.get("lock_owner_editor", "")
+        self._lock_time = int(kwargs.get("lock_time", 0))
+        self._lock_ttl = int(kwargs.get("_lock_ttl", 0))
+
+    @property
+    def is_locked(self) -> bool:
+        """Returns ``True`` if the file is locked, ``False`` otherwise."""
+        return self._is_locked
+
+    @property
+    def type(self) -> LockType:
+        """Type of the lock."""
+        return LockType(self._lock_owner_type)
+
+    @property
+    def owner(self) -> str:
+        """User id of the lock owner."""
+        return self._lock_owner
+
+    @property
+    def owner_display_name(self) -> str:
+        """Display name of the lock owner."""
+        return self._owner_display_name
+
+    @property
+    def owner_editor(self) -> str:
+        """App id of an app owned lock to allow clients to suggest joining the collaborative editing session."""
+        return self._owner_editor
+
+    @property
+    def lock_creation_time(self) -> datetime.datetime:
+        """Lock creation time."""
+        return datetime.datetime.utcfromtimestamp(self._lock_time).replace(tzinfo=datetime.timezone.utc)
+
+    @property
+    def lock_ttl(self) -> int:
+        """TTL of the lock in seconds staring from the creation time. A value of 0 means the timeout is infinite."""
+        return self._lock_ttl
+
+
 @dataclasses.dataclass
 class FsNodeInfo:
     """Extra FS object attributes from Nextcloud."""
@@ -116,11 +173,15 @@ class FsNode:
     info: FsNodeInfo
     """Additional extra information for the object"""
 
+    lock_info: FsNodeLockInfo
+    """Class describing `lock` information if any."""
+
     def __init__(self, full_path: str, **kwargs):
         self.full_path = full_path
         self.file_id = kwargs.get("file_id", "")
         self.etag = kwargs.get("etag", "")
         self.info = FsNodeInfo(**kwargs)
+        self.lock_info = FsNodeLockInfo(**kwargs)
 
     @property
     def is_dir(self) -> bool:

{nc_py_api-0.10.0 → nc_py_api-0.11.0}/nc_py_api/files/_files.py

@@ -10,7 +10,7 @@ import xmltodict
 from httpx import Response
 
 from .._exceptions import NextcloudException, check_error
-from .._misc import clear_from_params_empty
+from .._misc import check_capabilities, clear_from_params_empty
 from . import FsNode, SystemTag
 
 PROPFIND_PROPERTIES = [
@@ -29,13 +29,16 @@ PROPFIND_PROPERTIES = [
     "oc:share-types",
     "oc:favorite",
     "nc:is-encrypted",
+]
+
+PROPFIND_LOCKING_PROPERTIES = [
     "nc:lock",
     "nc:lock-owner-displayname",
     "nc:lock-owner",
     "nc:lock-owner-type",
-    "nc:lock-owner-editor",
-    "nc:lock-time",
-    "nc:lock-timeout",
+    "nc:lock-owner-editor",  # App id of an app owned lock
+    "nc:lock-time",  # Timestamp of the log creation time
+    "nc:lock-timeout",  # TTL of the lock in seconds staring from the creation time
 ]
 
 SEARCH_PROPERTIES_MAP = {
@@ -57,7 +60,14 @@ class PropFindType(enum.IntEnum):
     VERSIONS_FILE_ID = 3
 
 
-def build_find_request(req: list, path: str | FsNode, user: str) -> ElementTree.Element:
+def get_propfind_properties(capabilities: dict) -> list:
+    r = PROPFIND_PROPERTIES
+    if not check_capabilities("files.locking", capabilities):
+        r += PROPFIND_LOCKING_PROPERTIES
+    return r
+
+
+def build_find_request(req: list, path: str | FsNode, user: str, capabilities: dict) -> ElementTree.Element:
     path = path.user_path if isinstance(path, FsNode) else path
     root = ElementTree.Element(
         "d:searchrequest",
@@ -65,7 +75,7 @@ def build_find_request(req: list, path: str | FsNode, user: str) -> ElementTree.
     )
     xml_search = ElementTree.SubElement(root, "d:basicsearch")
     xml_select_prop = ElementTree.SubElement(ElementTree.SubElement(xml_search, "d:select"), "d:prop")
-    for i in PROPFIND_PROPERTIES:
+    for i in get_propfind_properties(capabilities):
         ElementTree.SubElement(xml_select_prop, i)
     xml_from_scope = ElementTree.SubElement(ElementTree.SubElement(xml_search, "d:from"), "d:scope")
     href = f"/files/{user}/{path.removeprefix('/')}"
@@ -76,7 +86,9 @@ def build_find_request(req: list, path: str | FsNode, user: str) -> ElementTree.
     return root
 
 
-def build_list_by_criteria_req(properties: list[str] | None, tags: list[int | SystemTag] | None) -> ElementTree.Element:
+def build_list_by_criteria_req(
+    properties: list[str] | None, tags: list[int | SystemTag] | None, capabilities: dict
+) -> ElementTree.Element:
     if not properties and not tags:
         raise ValueError("Either specify 'properties' or 'tags' to filter results.")
     root = ElementTree.Element(
@@ -84,7 +96,7 @@ def build_list_by_criteria_req(properties: list[str] | None, tags: list[int | Sy
         attrib={"xmlns:d": "DAV:", "xmlns:oc": "http://owncloud.org/ns", "xmlns:nc": "http://nextcloud.org/ns"},
     )
     prop = ElementTree.SubElement(root, "d:prop")
-    for i in PROPFIND_PROPERTIES:
+    for i in get_propfind_properties(capabilities):
         ElementTree.SubElement(prop, i)
     xml_filter_rules = ElementTree.SubElement(root, "oc:filter-rules")
     if properties and "favorite" in properties:
@@ -243,7 +255,7 @@ def etag_fileid_from_response(response: Response) -> dict:
     return {"etag": response.headers.get("OC-Etag", ""), "file_id": response.headers["OC-FileId"]}
 
 
-def _parse_record(full_path: str, prop_stats: list[dict]) -> FsNode:
+def _parse_record(full_path: str, prop_stats: list[dict]) -> FsNode:  # noqa pylint: disable = too-many-branches
     fs_node_args = {}
     for prop_stat in prop_stats:
         if str(prop_stat.get("d:status", "")).find("200 OK") == -1:
@@ -274,7 +286,17 @@ def _parse_record(full_path: str, prop_stats: list[dict]) -> FsNode:
             fs_node_args["trashbin_original_location"] = prop["nc:trashbin-original-location"]
         if "nc:trashbin-deletion-time" in prop_keys:
             fs_node_args["trashbin_deletion_time"] = prop["nc:trashbin-deletion-time"]
-        # xz = prop.get("oc:dDC", "")
+        for k, v in {
+            "nc:lock": "is_locked",
+            "nc:lock-owner-type": "lock_owner_type",
+            "nc:lock-owner": "lock_owner",
+            "nc:lock-owner-displayname": "lock_owner_displayname",
+            "nc:lock-owner-editor": "lock_owner_editor",
+            "nc:lock-time": "lock_time",
+            "nc:lock-timeout": "lock_ttl",
+        }.items():
+            if k in prop_keys and prop[k] is not None:
+                fs_node_args[v] = prop[k]
     return FsNode(full_path, **fs_node_args)
 
 

{nc_py_api-0.10.0 → nc_py_api-0.11.0}/nc_py_api/files/files.py

@@ -10,7 +10,7 @@ from httpx import Headers
 from .._exceptions import NextcloudException, NextcloudExceptionNotFound, check_error
 from .._misc import random_string, require_capabilities
 from .._session import AsyncNcSessionBasic, NcSessionBasic
-from . import FsNode, SystemTag
+from . import FsNode, LockType, SystemTag
 from ._files import (
     PROPFIND_PROPERTIES,
     PropFindType,
@@ -25,6 +25,7 @@ from ._files import (
     dav_get_obj_path,
     element_tree_as_str,
     etag_fileid_from_response,
+    get_propfind_properties,
     lf_parse_webdav_response,
 )
 from .sharing import _AsyncFilesSharingAPI, _FilesSharingAPI
@@ -50,7 +51,7 @@ class FilesAPI:
         """
         if exclude_self and not depth:
             raise ValueError("Wrong input parameters, query will return nothing.")
-        properties = PROPFIND_PROPERTIES
+        properties = get_propfind_properties(self._session.capabilities)
         path = path.user_path if isinstance(path, FsNode) else path
         return self._listdir(self._session.user, path, properties=properties, depth=depth, exclude_self=exclude_self)
 
@@ -76,7 +77,7 @@ class FilesAPI:
         :param path: path where to search from. Default = **""**.
         """
         # `req` possible keys: "name", "mime", "last_modified", "size", "favorite", "fileid"
-        root = build_find_request(req, path, self._session.user)
+        root = build_find_request(req, path, self._session.user, self._session.capabilities)
         webdav_response = self._session.adapter_dav.request(
             "SEARCH", "", content=element_tree_as_str(root), headers={"Content-Type": "text/xml"}
         )
@@ -248,7 +249,7 @@ class FilesAPI:
             Supported values: **favorite**
         :param tags: List of ``tags ids`` or ``SystemTag`` that should have been set for the file.
         """
-        root = build_list_by_criteria_req(properties, tags)
+        root = build_list_by_criteria_req(properties, tags, self._session.capabilities)
         webdav_response = self._session.adapter_dav.request(
             "REPORT", dav_get_obj_path(self._session.user), content=element_tree_as_str(root)
         )
@@ -396,6 +397,34 @@ class FilesAPI:
         """Removes Tag from a file/directory."""
         self._file_change_tag_state(file_id, tag_id, False)
 
+    def lock(self, path: FsNode | str, lock_type: LockType = LockType.MANUAL_LOCK) -> None:
+        """Locks the file.
+
+        .. note:: Exception codes: 423 - existing lock present.
+        """
+        require_capabilities("files.locking", self._session.capabilities)
+        full_path = dav_get_obj_path(self._session.user, path.user_path if isinstance(path, FsNode) else path)
+        response = self._session.adapter_dav.request(
+            "LOCK",
+            quote(full_path),
+            headers={"X-User-Lock": "1", "X-User-Lock-Type": str(lock_type.value)},
+        )
+        check_error(response, f"lock: user={self._session.user}, path={full_path}")
+
+    def unlock(self, path: FsNode | str) -> None:
+        """Unlocks the file.
+
+        .. note:: Exception codes: 412 - the file is not locked, 423 - the lock is owned by another user.
+        """
+        require_capabilities("files.locking", self._session.capabilities)
+        full_path = dav_get_obj_path(self._session.user, path.user_path if isinstance(path, FsNode) else path)
+        response = self._session.adapter_dav.request(
+            "UNLOCK",
+            quote(full_path),
+            headers={"X-User-Lock": "1"},
+        )
+        check_error(response, f"unlock: user={self._session.user}, path={full_path}")
+
     def _file_change_tag_state(self, file_id: FsNode | int, tag_id: SystemTag | int, tag_state: bool) -> None:
         fs_object = file_id.info.fileid if isinstance(file_id, FsNode) else file_id
         tag = tag_id.tag_id if isinstance(tag_id, SystemTag) else tag_id
@@ -493,7 +522,7 @@ class AsyncFilesAPI:
         """
         if exclude_self and not depth:
             raise ValueError("Wrong input parameters, query will return nothing.")
-        properties = PROPFIND_PROPERTIES
+        properties = get_propfind_properties(await self._session.capabilities)
         path = path.user_path if isinstance(path, FsNode) else path
         return await self._listdir(
             await self._session.user, path, properties=properties, depth=depth, exclude_self=exclude_self
@@ -521,7 +550,7 @@ class AsyncFilesAPI:
         :param path: path where to search from. Default = **""**.
         """
         # `req` possible keys: "name", "mime", "last_modified", "size", "favorite", "fileid"
-        root = build_find_request(req, path, await self._session.user)
+        root = build_find_request(req, path, await self._session.user, await self._session.capabilities)
         webdav_response = await self._session.adapter_dav.request(
             "SEARCH", "", content=element_tree_as_str(root), headers={"Content-Type": "text/xml"}
         )
@@ -695,7 +724,7 @@ class AsyncFilesAPI:
             Supported values: **favorite**
         :param tags: List of ``tags ids`` or ``SystemTag`` that should have been set for the file.
         """
-        root = build_list_by_criteria_req(properties, tags)
+        root = build_list_by_criteria_req(properties, tags, await self._session.capabilities)
         webdav_response = await self._session.adapter_dav.request(
             "REPORT", dav_get_obj_path(await self._session.user), content=element_tree_as_str(root)
         )
@@ -848,6 +877,34 @@ class AsyncFilesAPI:
         """Removes Tag from a file/directory."""
         await self._file_change_tag_state(file_id, tag_id, False)
 
+    async def lock(self, path: FsNode | str, lock_type: LockType = LockType.MANUAL_LOCK) -> None:
+        """Locks the file.
+
+        .. note:: Exception codes: 423 - existing lock present.
+        """
+        require_capabilities("files.locking", await self._session.capabilities)
+        full_path = dav_get_obj_path(await self._session.user, path.user_path if isinstance(path, FsNode) else path)
+        response = await self._session.adapter_dav.request(
+            "LOCK",
+            quote(full_path),
+            headers={"X-User-Lock": "1", "X-User-Lock-Type": str(lock_type.value)},
+        )
+        check_error(response, f"lock: user={self._session.user}, path={full_path}")
+
+    async def unlock(self, path: FsNode | str) -> None:
+        """Unlocks the file.
+
+        .. note:: Exception codes: 412 - the file is not locked, 423 - the lock is owned by another user.
+        """
+        require_capabilities("files.locking", await self._session.capabilities)
+        full_path = dav_get_obj_path(await self._session.user, path.user_path if isinstance(path, FsNode) else path)
+        response = await self._session.adapter_dav.request(
+            "UNLOCK",
+            quote(full_path),
+            headers={"X-User-Lock": "1"},
+        )
+        check_error(response, f"unlock: user={self._session.user}, path={full_path}")
+
     async def _file_change_tag_state(self, file_id: FsNode | int, tag_id: SystemTag | int, tag_state: bool) -> None:
         fs_object = file_id.info.fileid if isinstance(file_id, FsNode) else file_id
         tag = tag_id.tag_id if isinstance(tag_id, SystemTag) else tag_id

{nc_py_api-0.10.0 → nc_py_api-0.11.0}/pyproject.toml

@@ -21,7 +21,7 @@ authors = [
 ]
 requires-python = ">=3.10"
 classifiers = [
-  "Development Status :: 3 - Alpha",
+  "Development Status :: 4 - Beta",
   "Intended Audience :: Developers",
   "License :: OSI Approved :: BSD License",
   "Operating System :: MacOS :: MacOS X",