Saimon/core search and permalink (#287)

Author: saimonation

cterasdk/core/files/browser.py

@@ -1,7 +1,7 @@
 import logging
 
 import cterasdk.settings
-from ...exceptions import CTERAException
+from ...exceptions import CTERAException, ObjectNotFoundException
 from ..base_command import BaseCommand
 from . import io, common, shares, file_access
 
@@ -83,6 +83,18 @@ def copy(self, *paths, destination=None):
             raise ValueError('Copy destination was not specified.')
         return io.copy(self._core, *[self.get_object_path(path) for path in paths], destination=self.get_object_path(destination))
 
+    def permalink(self, path):
+        """
+        Get Permalink for Path.
+
+        :param str path: Path.
+        """
+        p = self.get_object_path(path)
+        contents = [e for e in io.listdir(self._core, p.parent(), 1, False, p.name(), 1)]  # pylint: disable=unnecessary-comprehension
+        if contents and contents[0].name == p.name():
+            return contents[0].permalink
+        raise ObjectNotFoundException('File not found.', path)
+
     def get_object_path(self, elements):
         return common.get_object_path(self.base, elements)
 

cterasdk/core/files/common.py

@@ -107,10 +107,18 @@ def depth(self, depth):
         self.param.depth = depth  # pylint: disable=attribute-defined-outside-init
         return self
 
+    def searchCriteria(self, criteria):
+        self.param.searchCriteria = criteria  # pylint: disable=attribute-defined-outside-init
+        return self
+
     def include_deleted(self):
         self.param.includeDeleted = True  # pylint: disable=attribute-defined-outside-init
         return self
 
+    def limit(self, limit):
+        self.param.limit = limit
+        return self
+
     def build(self):
         return self.param
 

cterasdk/core/files/io.py

@@ -2,11 +2,15 @@
 from . import common
 
 
-def listdir(core, path, depth=None, include_deleted=False):
+def listdir(core, path, depth=None, include_deleted=False, criteria=None, limit=None):
     depth = depth if depth is not None else 1
     builder = common.FetchResourcesParamBuilder().root(path.encoded_fullpath()).depth(depth)
     if include_deleted:
         builder.include_deleted()
+    if criteria:
+        builder.searchCriteria(criteria)
+    if limit:
+        builder.limit(limit)
     param = builder.build()
     if depth > 0:
         return common.objects_iterator(core, param)

cterasdk/objects/synchronous/drive.py

@@ -19,7 +19,7 @@ def __init__(self, drive, Portal):
             drive._Portal = Portal
             drive.default.close()
             drive._ctera_session.start_remote_session(Portal.session())
-            self.api = drive.default.clone(clients.API, EndpointBuilder.new(drive.base), authenticator=lambda *_: True)
+            self.api = Portal.default.clone(clients.API, EndpointBuilder.new(drive.base), authenticator=lambda *_: True)
         else:
             self.api = drive.default.clone(clients.API, EndpointBuilder.new(drive.base, '/admingui/api'))
 
@@ -49,3 +49,7 @@ def _session_id_key(self):
     @property
     def _login_object(self):
         raise NotImplementedError("Logins to the 'Drive App' are not enabled.")
+
+    @property
+    def _omit_fields(self):
+        return super()._omit_fields + ['backup', 'cli', 'logs', 'services', 'support', 'sync']

docs/source/UserGuides/Portal/Files.rst

@@ -147,6 +147,22 @@ Create Public Link
 
    user.files.public_link('My Files/Documents/Sample.docx', 'RW', 45)
 
+
+Create Permalink
+================
+
+.. automethod:: cterasdk.core.files.browser.FileBrowser.permalink
+   :noindex:
+
+.. code:: python
+
+   """Create permalink to a file"""
+   user.files.permalink('My Files/Documents/Sample.docx')
+
+   """Create permalink to a folder"""
+   user.files.permalink('My Files/Documents')
+
+
 Create Directories
 ==================
 

docs/source/index.rst

@@ -16,7 +16,7 @@ Key Features
     1. `Portal Management <UserGuides/Portal/Administration.html>`_
     2. `Edge Filer Management <UserGuides/Edge/Configuration.html>`_, including remote access.
 2. Managing `Data Discovery and Migration Jobs <UserGuides/Edge/Migration.html>`_
-3. File Data Management APIs for `CTERA Edge Filer <UserGuides/Edge/Index.html>`_ and `CTERA Portal <UserGuides/Portal/Index.html>`_.
+3. File Data Management APIs for `CTERA Edge Filer <UserGuides/Edge/Files.html>`_ and `CTERA Portal <UserGuides/Portal/Files.html>`_.
 4. Data Services Framework:
     1. `Subscribing to File System Notifications <UserGuides/DataServices/NotificationService.html>`_
     2. `CTERA Direct IO <UserGuides/DataServices/DirectIO.html>`_, enabling parallel high-performnace retrieval directly from object storage.