SharePoint API enhancements: features, sharing and social namespaces

Author: vgrem

examples/sharepoint/features/activate_docid.py renamed to examples/sharepoint/features/activate_site.py

@@ -1,8 +1,8 @@
 from office365.sharepoint.client_context import ClientContext
 from office365.sharepoint.features.definitions.scope import FeatureDefinitionScope
+from office365.sharepoint.features.known_list import KnownFeaturesList
 from tests import test_team_site_url, test_client_credentials
 
 ctx = ClientContext(test_team_site_url).with_credentials(test_client_credentials)
-feature_id = "b50e3104-6812-424f-a011-cc90e6327318"
-f = ctx.site.features.add(feature_id, False, FeatureDefinitionScope.Farm).execute_query()
+f = ctx.site.features.add(KnownFeaturesList.DocId, False, FeatureDefinitionScope.Farm).execute_query()
 print("Feature {0} has been activated.", f.display_name)

examples/sharepoint/features/activate_ct_hub.py renamed to examples/sharepoint/features/ensure_activated.py

@@ -1,9 +1,8 @@
 from office365.sharepoint.client_context import ClientContext
 from office365.sharepoint.features.definitions.scope import FeatureDefinitionScope
+from office365.sharepoint.features.known_list import KnownFeaturesList
 from tests import test_client_credentials, test_site_url
 
-feature_id = "9a447926-5937-44cb-857a-d3829301c73b"
-
 ctx = ClientContext(test_site_url).with_credentials(test_client_credentials)
-f = ctx.site.features.add(feature_id, False, FeatureDefinitionScope.Farm).execute_query()
+f = ctx.site.features.add(KnownFeaturesList.ContentTypeHub, False, FeatureDefinitionScope.Farm, True).execute_query()
 print("Feature {0} has been activated.", f.display_name)

examples/sharepoint/files/download_file.py

@@ -6,9 +6,9 @@
 
 ctx = ClientContext(test_team_site_url).with_credentials(test_client_credentials)
 # file_url = '/sites/team/Shared Documents/big_buck_bunny.mp4'
-file_url = "/sites/team/Shared Documents/report #123.csv"
+file_url = "/sites/team/Shared Documents/!2022/Financial Sample.xlsx"
 download_path = os.path.join(tempfile.mkdtemp(), os.path.basename(file_url))
 with open(download_path, "wb") as local_file:
-    file = ctx.web.get_file_by_server_relative_path(file_url).download(local_file).execute_query()
+    file = ctx.web.get_file_by_server_relative_url(file_url).download(local_file).execute_query()
     #file = ctx.web.get_file_by_server_relative_url(file_url).download(local_file).execute_query()
 print("[Ok] file has been downloaded into: {0}".format(download_path))

examples/sharepoint/sharing/file_share_link.py renamed to examples/sharepoint/sharing/share_file.py

@@ -5,6 +5,6 @@
 
 admin_client = ClientContext(test_admin_site_url).with_credentials(test_client_credentials)
 tenant = Tenant(admin_client)
-result = tenant.get_site_properties_from_sharepoint_by_filters("", 0).execute_query()
-for siteProps in result:  # type: SiteProperties
-    print(siteProps.url)
+result = tenant.get_site_properties_from_sharepoint_by_filters("").execute_query()
+for i, siteProps in enumerate(result):  # type: SiteProperties
+    print("({0} of {1}) {2}".format(i, len(result), siteProps.url))

examples/sharepoint/tenant/get_all_sites.py

@@ -2,6 +2,5 @@
 from tests import test_client_credentials, test_team_site_url
 
 ctx = ClientContext(test_team_site_url).with_credentials(test_client_credentials)
-
-w = ctx.web.assign_document_id("MEDIADEVDOC").execute_query()
+ctx.web.assign_document_id("MEDIADEVDOC").execute_query()
 print("Document IDs has been assigned")

examples/sharepoint/lists/enable_doc_id.py renamed to examples/sharepoint/webs/enable_doc_id.py

@@ -7,6 +7,7 @@
 from office365.runtime.http.http_method import HttpMethod
 from office365.runtime.http.request_options import RequestOptions
 from office365.runtime.odata.v3.json_light_format import JsonLightFormat
+from office365.runtime.paths.service_operation import ServiceOperationPath
 from office365.runtime.queries.create_entity import CreateEntityQuery
 from office365.runtime.queries.delete_entity import DeleteEntityQuery
 from office365.runtime.queries.service_operation import ServiceOperationQuery
@@ -61,15 +62,18 @@ def process_response(self, response, query):
             if isinstance(return_type, ClientResult):
                 return_type.set_property("__value", response.content)
         else:
-            if isinstance(query, ServiceOperationQuery) and isinstance(json_format, JsonLightFormat):
-                json_format.function = query.method_name
+            if isinstance(json_format, JsonLightFormat):
+                if isinstance(query, ServiceOperationQuery):
+                    json_format.function = query.method_name
+                elif isinstance(return_type.resource_path, ServiceOperationPath):
+                    json_format.function = return_type.resource_path.name
 
             self.map_json(response.json(), return_type, json_format)
 
     def map_json(self, json, return_type, json_format=None):
         """
         :type json: any
-        :type return_type: ClientValue or ClientResult  or ClientObject
+        :type return_type: ClientValue or ClientResult or ClientObject
         :type json_format: office365.runtime.odata.json_format.ODataJsonFormat
         """
         if json_format is None:
@@ -81,16 +85,14 @@ def map_json(self, json, return_type, json_format=None):
 
     def _next_property(self, json, json_format):
         """
-        :type json: any
+        :type json: Any
         :type json_format: office365.runtime.odata.json_format.ODataJsonFormat
         """
         if isinstance(json_format, JsonLightFormat):
             json = json.get(json_format.security, json)
             json = json.get(json_format.function, json)
 
-        if not isinstance(json, dict):
-            yield "__value", json
-        else:
+        if isinstance(json, dict):
             next_link_url = json.get(json_format.collection_next, None)
             json = json.get(json_format.collection, json)
             if next_link_url:
@@ -114,13 +116,16 @@ def _next_property(self, json, json_format):
                         yield name, value
             else:
                 yield "__value", json
+        elif json is not None:
+            yield "__value", json
 
     def _build_payload(self, query):
         """
         Normalizes OData request payload
 
         :type query: office365.runtime.queries.client_query.ClientQuery
         """
+
         def _normalize_payload(payload):
             if isinstance(payload, ClientObject) or isinstance(payload, ClientValue):
                 return payload.to_json(self._default_json_format)

generator/metadata/SharePoint.xml

@@ -1,8 +1,42 @@
+from office365.runtime.client_result import ClientResult
+from office365.runtime.client_value_collection import ClientValueCollection
+from office365.runtime.queries.service_operation import ServiceOperationQuery
+from office365.runtime.types.collections import StringCollection
 from office365.sharepoint.base_entity import BaseEntity
+from office365.sharepoint.compliance.tag import ComplianceTag
 
 
 class SPPolicyStoreProxy(BaseEntity):
 
+    @staticmethod
+    def get_available_tags_for_site(context, site_url, return_type=None):
+        """
+        :param office365.sharepoint.client_context.ClientContext context: SharePoint client context
+        :param str site_url:
+        :param ClientResult return_type:
+        """
+        if return_type is None:
+            return_type = ClientResult(context, ClientValueCollection(ComplianceTag))
+        payload = {
+            "siteUrl": site_url
+        }
+        qry = ServiceOperationQuery(SPPolicyStoreProxy(context), "GetAvailableTagsForSite", None, payload,
+                                    None, return_type, True)
+        context.add_query(qry)
+        return return_type
+
+    def get_dynamic_scope_binding_by_site_id(self, site_id):
+        """
+        :param str site_id:
+        """
+        return_type = ClientResult(self.context, StringCollection())
+        payload = {
+            "siteId": site_id
+        }
+        qry = ServiceOperationQuery(self, "GetDynamicScopeBindingBySiteId", None, payload, None, return_type)
+        self.context.add_query(qry)
+        return return_type
+
     @property
     def entity_type_name(self):
         return "SP.CompliancePolicy.SPPolicyStoreProxy"

office365/runtime/odata/request.py

@@ -0,0 +1,8 @@
+from office365.runtime.client_value import ClientValue
+
+
+class MachineLearningSampleMeta(ClientValue):
+
+    @property
+    def entity_type_name(self):
+        return "SP.MachineLearningSampleMeta"

office365/sharepoint/compliance/store_proxy.py

@@ -10,23 +10,39 @@ class FeatureCollection(BaseEntityCollection):
     def __init__(self, context, resource_path=None, parent=None):
         super(FeatureCollection, self).__init__(context, Feature, resource_path, parent)
 
-    def add(self, feature_id, force, featdef_scope):
+    def add(self, feature_id, force, featdef_scope, verify_if_activated=False):
         """
         Adds the feature to the collection of activated features and returns the added feature.
 
         :param str feature_id: The feature identifier of the feature to be added.
         :param bool force: Specifies whether to continue with the operation even if there are errors.
         :param int featdef_scope: The feature scope for this feature.
+        :param bool verify_if_activated: Verify if activated first to avoid System.Data.DuplicateNameException exception
         """
         return_type = Feature(self.context)
-        payload = {
-            "featureId": feature_id,
-            "force": force,
-            "featdefScope": featdef_scope
-        }
         self.add_child(return_type)
-        qry = ServiceOperationQuery(self, "Add", None, payload, None, return_type)
-        self.context.add_query(qry)
+
+        def _create_query():
+            payload = {
+                "featureId": feature_id,
+                "force": force,
+                "featdefScope": featdef_scope
+            }
+            return ServiceOperationQuery(self, "Add", None, payload, None, return_type)
+
+        def _create_if_not_activated(f):
+            """
+            :type f: Feature
+            """
+            if not f.properties:
+                self.context.add_query(_create_query())
+
+        if verify_if_activated:
+            feature = self.get_by_id(feature_id)
+            self.context.load(feature, after_loaded=_create_if_not_activated)
+        else:
+            self.context.add_query(_create_query())
+
         return return_type
 
     def get_by_id(self, feature_id):

office365/sharepoint/contentcenter/machinelearning/sample_meta.py

@@ -0,0 +1,7 @@
+class KnownFeaturesList:
+
+    PushNotifications = "41e1d4bf-b1a2-47f7-ab80-d5d6cbba3092"
+
+    ContentTypeHub = "9a447926-5937-44cb-857a-d3829301c73b"
+
+    DocId = "b50e3104-6812-424f-a011-cc90e6327318"

office365/sharepoint/features/collection.py

@@ -0,0 +1,14 @@
+from office365.runtime.client_value import ClientValue
+
+
+class ListCollectionPosition(ClientValue):
+
+    def __init__(self, paging_info=None):
+        """
+        :param str paging_info:
+        """
+        self.PagingInfo = paging_info
+
+    @property
+    def entity_type_name(self):
+        return "SP.ListCollectionPosition"

office365/sharepoint/features/known_list.py

@@ -0,0 +1,16 @@
+from office365.runtime.client_value import ClientValue
+from office365.sharepoint.lists.collection_position import ListCollectionPosition
+
+
+class GetListsParameters(ClientValue):
+
+    def __init__(self, position=ListCollectionPosition(), row_limit=100):
+        """
+        :param ListCollectionPosition position:
+        """
+        self.ListCollectionPosition = position
+        self.RowLimit = row_limit
+
+    @property
+    def entity_type_name(self):
+        return "SP.GetListsParameters"

office365/sharepoint/lists/collection_position.py

@@ -0,0 +1,8 @@
+from office365.sharepoint.base_entity import BaseEntity
+
+
+class MetadataNavigationSettings(BaseEntity):
+
+    @property
+    def entity_type_name(self):
+        return "SP.MetadataNavigation.MetadataNavigationSettings"

office365/sharepoint/lists/get_parameters.py

@@ -0,0 +1,17 @@
+from office365.runtime.paths.service_operation import ServiceOperationPath
+from office365.sharepoint.base_entity_collection import BaseEntityCollection
+from office365.sharepoint.pushnotifications.subscriber import PushNotificationSubscriber
+
+
+class PushNotificationSubscriberCollection(BaseEntityCollection):
+
+    def __init__(self, context, resource_path=None):
+        super(PushNotificationSubscriberCollection, self).__init__(context, PushNotificationSubscriber, resource_path)
+
+    def get_by_store_id(self, _id):
+        """
+        Returns the push notification subscriber from the specified store identifier.
+
+        :param str _id: Store identifier for the notification subscriber.
+        """
+        return PushNotificationSubscriber(self.context, ServiceOperationPath("GetByStoreId", [_id], self.resource_path))

office365/sharepoint/navigation/metadata_settings.py

@@ -0,0 +1,12 @@
+from office365.runtime.client_value import ClientValue
+
+
+class SharingAbilities(ClientValue):
+    """
+    Represents the matrix of possible sharing abilities for direct sharing and tokenized sharing links along
+    with the state of each capability for the current user.
+    """
+
+    @property
+    def entity_type_name(self):
+        return "SP.Sharing.SharingAbilities"

office365/sharepoint/pushnotifications/collection.py

@@ -1,5 +1,6 @@
 from office365.runtime.paths.resource_path import ResourcePath
 from office365.sharepoint.base_entity import BaseEntity
+from office365.sharepoint.sharing.abilities import SharingAbilities
 from office365.sharepoint.sharing.access_request_settings import AccessRequestSettings
 from office365.sharepoint.sharing.links.default_templates_collection import SharingLinkDefaultTemplatesCollection
 from office365.sharepoint.sharing.picker_settings import PickerSettings
@@ -24,6 +25,13 @@ def picker_settings(self):
         return self.properties.get('pickerSettings',
                                    PickerSettings(self.context, ResourcePath("pickerSettings", self.resource_path)))
 
+    @property
+    def sharing_abilities(self):
+        """
+        Matrix of possible sharing abilities per sharing type and the state of each capability for the current user
+        on the list item."""
+        return self.properties.get("sharingAbilities", SharingAbilities())
+
     @property
     def sharing_link_templates(self):
         """"""
@@ -34,7 +42,12 @@ def get_property(self, name, default_value=None):
             property_mapping = {
                 "accessRequestSettings": self.access_request_settings,
                 "pickerSettings": self.picker_settings,
+                "sharingAbilities": self.sharing_abilities,
                 "sharingLinkTemplates": self.sharing_link_templates
             }
             default_value = property_mapping.get(name, None)
         return super(SharingInformation, self).get_property(name, default_value)
+
+    @property
+    def entity_type_name(self):
+        return "SP.Sharing.SharingInformation"

office365/sharepoint/sharing/abilities.py

@@ -1,3 +1,5 @@
+import typing
+
 from office365.runtime.paths.resource_path import ResourcePath
 from office365.sharepoint.base_entity import BaseEntity
 from office365.sharepoint.principal.principal import Principal
@@ -7,6 +9,22 @@
 class ObjectSharingInformationUser(BaseEntity):
     """Contains information about a principal with whom a securable object is shared. It can be a user or a group."""
 
+    @property
+    def email(self):
+        """
+        Specifies the email address for the user.
+
+        :rtype: str or None
+        """
+        return self.properties.get("Email", None)
+
+    @property
+    def login_name(self):
+        """
+        Specifies the login name for the principal.
+        """
+        return self.properties.get("LoginName", None)
+
     def principal(self):
         """
         The principal with whom a securable object is shared. It is either a user or a group.

office365/sharepoint/sharing/information.py

@@ -0,0 +1,25 @@
+from office365.runtime.queries.service_operation import ServiceOperationQuery
+from office365.sharepoint.base_entity import BaseEntity
+from office365.sharepoint.sharing.information import SharingInformation
+from office365.sharepoint.sharing.information_request import SharingInformationRequest
+
+
+class SecurableObjectExtensions(BaseEntity):
+
+    @staticmethod
+    def get_sharing_information(context):
+        """
+        Gets the sharing information for a list item.
+
+        :param office365.sharepoint.client_context.ClientContext context: Client context
+        """
+        return_type = SharingInformation(context)
+        request = SharingInformationRequest()
+        binding_type = SecurableObjectExtensions(context)
+        qry = ServiceOperationQuery(binding_type, "GetSharingInformation", None, request, None, return_type, True)
+        context.add_query(qry)
+        return return_type
+
+    @property
+    def entity_type_name(self):
+        return "SP.Sharing.SecurableObjectExtensions"