#276_ improvements and fixes to support addressing drive items by root and children tokens

Author: [email protected]

examples/onedrive/print_folders_and_files.py

@@ -1,12 +1,16 @@
 from office365.graph_client import GraphClient
+from office365.onedrive.driveItem import DriveItem
 from tests.graph_case import acquire_token_by_username_password
 
 
 def enum_folders_and_files(root_folder):
+    """
+    :type root_folder: office365.onedrive.driveItem.DriveItem
+    """
     drive_items = root_folder.children.get().execute_query()
-    for drive_item in drive_items:
-        print("Name: {0}".format(drive_item.name))
-        if not drive_item.is_property_available("folder"):  # is folder facet?
+    for drive_item in drive_items:  # type: DriveItem
+        print("Name: {0}".format(drive_item.resource_url))
+        if drive_item.is_folder:  # is folder facet?
             enum_folders_and_files(drive_item)
 
 

office365/base_item.py

@@ -44,7 +44,7 @@ def name(self, value):
     @property
     def description(self):
         """Provides a user-visible description of the item."""
-        return self.properties.get('description',None)
+        return self.properties.get('description', None)
 
     @description.setter
     def description(self, value):
@@ -63,3 +63,7 @@ def parentReference(self):
     @parentReference.setter
     def parentReference(self, value):
         self.properties['parentReference'] = value
+
+    def set_property(self, name, value, persist_changes=True):
+        super(BaseItem, self).set_property(name, value, persist_changes)
+        return self

office365/onedrive/actions/__init__.py

@@ -0,0 +1,8 @@
+from office365.runtime.resource_path import ResourcePath
+
+
+class ChildrenResourcePath(ResourcePath):
+    """Resource path for OneDrive children addressing"""
+
+    def __init__(self, parent):
+        super(ChildrenResourcePath, self).__init__("children", parent)

office365/onedrive/children_resource_path.py

@@ -2,6 +2,7 @@
 from office365.onedrive.driveItem import DriveItem
 from office365.onedrive.driveItemCollection import DriveItemCollection
 from office365.onedrive.list import List
+from office365.onedrive.root_resource_path import RootResourcePath
 from office365.runtime.resource_path import ResourcePath
 
 
@@ -18,7 +19,7 @@ def sharedWithMe(self):
     @property
     def root(self):
         """The root folder of the drive."""
-        return self.properties.get('root', DriveItem(self.context, ResourcePath("root", self.resource_path)))
+        return self.properties.get('root', DriveItem(self.context, RootResourcePath(self.resource_path)))
 
     @property
     def list(self):

office365/onedrive/drive.py

@@ -3,6 +3,7 @@
 from office365.directory.permission import Permission
 from office365.directory.permission_collection import PermissionCollection
 from office365.entity_collection import EntityCollection
+from office365.onedrive.children_resource_path import ChildrenResourcePath
 from office365.onedrive.conflictBehavior import ConflictBehavior
 from office365.onedrive.driveItemVersion import DriveItemVersion
 from office365.onedrive.file import File
@@ -11,6 +12,7 @@
 from office365.onedrive.folder import Folder
 from office365.onedrive.listItem import ListItem
 from office365.onedrive.publicationFacet import PublicationFacet
+from office365.onedrive.root_resource_path import RootResourcePath
 from office365.onedrive.uploadSession import UploadSession
 from office365.excel.workbook import Workbook
 from office365.runtime.client_result import ClientResult
@@ -165,6 +167,7 @@ def download(self, file_object):
 
         def _content_downloaded(resp):
             file_object.write(result.value)
+
         self.context.after_execute(_content_downloaded)
         return self
 
@@ -298,13 +301,21 @@ def file(self):
         """File metadata, if the item is a file."""
         return self.properties.get('file', File())
 
+    @property
+    def is_folder(self):
+        return self.is_property_available("folder")
+
+    @property
+    def is_folder(self):
+        return self.is_property_available("folder")
+
     @property
     def children(self):
         """Collection containing Item objects for the immediate children of Item. Only items representing folders
         have children."""
         from office365.onedrive.driveItemCollection import DriveItemCollection
         return self.properties.get('children',
-                                   DriveItemCollection(self.context, ResourcePath("children", self.resource_path)))
+                                   DriveItemCollection(self.context, ChildrenResourcePath(self.resource_path)))
 
     @property
     def listItem(self):
@@ -337,10 +348,16 @@ def versions(self):
                                                     ResourcePath("versions", self.resource_path)))
 
     def set_property(self, name, value, persist_changes=True):
+        if self._resource_path is None and name == "id":
+            col_path = self.parent_collection.resource_path
+            if isinstance(col_path, ChildrenResourcePath):
+                parent_path = col_path.parent
+                if parent_path.segment == "root":
+                    self._resource_path = ResourcePath(value, ResourcePath("items", parent_path.parent))
+                elif parent_path.parent and parent_path.parent.segment == "items":
+                    self._resource_path = ResourcePath(value, parent_path.parent)
+
+            elif isinstance(col_path, RootResourcePath):
+                self._resource_path = ResourcePath(value, ResourcePath("items", col_path.parent))
         super(DriveItem, self).set_property(name, value, persist_changes)
-        if name == "id" and self._resource_path.parent.segment == "children":
-            self._resource_path = ResourcePath(
-                value, ResourcePath("items", self._parent_collection.resource_path.parent.parent))
-        elif name == "id" and self._resource_path.parent.segment == "root":
-            self._resource_path = ResourcePath(value, ResourcePath("items", self._resource_path.parent.parent))
         return self

office365/onedrive/driveItem.py

@@ -0,0 +1,10 @@
+from office365.runtime.resource_path import ResourcePath
+
+
+class RootResourcePath(ResourcePath):
+    """Resource path for OneDrive path-based addressing"""
+
+    def __init__(self, parent):
+        super(RootResourcePath, self).__init__("root", parent)
+
+

office365/onedrive/root_resource_path.py

@@ -1,6 +1,6 @@
 from office365.entity_collection import EntityCollection
+from office365.onedrive.root_resource_path import RootResourcePath
 from office365.onedrive.site import Site
-from office365.runtime.resource_path import ResourcePath
 
 
 class SiteCollection(EntityCollection):
@@ -13,7 +13,7 @@ def __init__(self, context, resource_path=None):
     def root(self):
         """If present, indicates that this is a root site collection in SharePoint."""
         root_site = self.properties.get('root',
-                                        Site(self.context, ResourcePath("root", self.resource_path)))
+                                        Site(self.context, RootResourcePath(self.resource_path)))
 
         root_site.ensure_property("id")
         return root_site

office365/onedrive/siteCollection.py

@@ -1,6 +1,14 @@
+from office365.runtime.client_result import ClientResult
+from office365.runtime.client_value import ClientValue
+from office365.runtime.client_value_collection import ClientValueCollection
 from office365.runtime.queries.service_operation_query import ServiceOperationQuery
 from office365.sharepoint.base_entity import BaseEntity
 from office365.sharepoint.permissions.role_definition import RoleDefinition
+from office365.sharepoint.sharing.userSharingResult import UserSharingResult
+
+
+class SharedWithMeViewItemRemovalResult(ClientValue):
+    pass
 
 
 class DocumentSharingManager(BaseEntity):
@@ -18,6 +26,46 @@ def get_role_definition(self, role):
         self.context.add_query(qry)
         return role_def
 
+    def remove_items_from_shared_with_me_view(self, item_urls):
+        """
+        :type item_urls: list[str]
+        """
+        result = ClientResult(self.context, ClientValueCollection(SharedWithMeViewItemRemovalResult))
+        qry = ServiceOperationQuery(self, "RemoveItemsFromSharedWithMeView", [item_urls], None, None, result)
+        qry.static = True
+        self.context.add_query(qry)
+        return result
+
+    def update_document_sharing_info(self, resourceAddress, userRoleAssignments, validateExistingPermissions,
+                                     additiveMode, sendServerManagedNotification, customMessage,
+                                     includeAnonymousLinksInNotification, propagateAcl):
+        """
+
+        :param str resourceAddress:
+        :param ClientValueCollection userRoleAssignments:
+        :param bool validateExistingPermissions:
+        :param bool additiveMode:
+        :param bool sendServerManagedNotification:
+        :param str customMessage:
+        :param bool includeAnonymousLinksInNotification:
+        :param bool propagateAcl:
+        """
+        result = ClientResult(self.context, ClientValueCollection(UserSharingResult))
+        payload = {
+            "resourceAddress": resourceAddress,
+            "userRoleAssignments": userRoleAssignments,
+            "validateExistingPermissions": validateExistingPermissions,
+            "additiveMode": additiveMode,
+            "sendServerManagedNotification": sendServerManagedNotification,
+            "customMessage": customMessage,
+            "includeAnonymousLinksInNotification": includeAnonymousLinksInNotification,
+            "propagateAcl": propagateAcl
+        }
+        qry = ServiceOperationQuery(self, "UpdateDocumentSharingInfo", None, payload, None, result)
+        qry.static = True
+        self.context.add_query(qry)
+        return result
+
     @property
     def entity_type_name(self):
         return "SP.Sharing.DocumentSharingManager"