Bug fixes (#306) and SharePoint API improvements (hubsite, utility namespaces)

Author: vvgrem@gmail.com

examples/sharepoint/connect_with_user_credential.py

@@ -1,7 +1,7 @@
 from settings import settings
 
-from office365.sharepoint.client_context import ClientContext
 
+from office365.sharepoint.client_context import ClientContext
 ctx = ClientContext(settings["url"]).with_user_credentials(settings.get('user_credentials').get('username'),
                                                            settings.get('user_credentials').get('password'))
 

examples/sharepoint/folders/create_docset.py

@@ -7,10 +7,6 @@
                                settings.get('client_credentials').get('client_secret'))
 
 
-def create_folder():
-    pass
-
-
 # ctx = ListDataService(site_url)
 # ctx = ClientContext(site_url).with_credentials(credentials)
 # ctx.execute_query()

examples/sharepoint/folders/create_folders.py

@@ -0,0 +1,17 @@
+from settings import settings
+
+from office365.runtime.auth.user_credential import UserCredential
+from office365.sharepoint.client_context import ClientContext
+
+credentials = UserCredential(settings['user_credentials']['username'],
+                             settings['user_credentials']['password'])
+ctx = ClientContext(settings['url']).with_credentials(credentials)
+
+target_folder = "/Shared Documents/Archive/2020/Sept"
+target_folder = ctx.web.ensure_folder_path(target_folder).execute_query()
+print(target_folder.serverRelativeUrl)
+
+
+
+
+

examples/sharepoint/folders/create_nested_folders.py

@@ -29,7 +29,7 @@ def xml_escape(s_val):
 
 
 def is_valid_auth_cookies(values):
-    return any(values) and values.get('FedAuth', None) is not None
+    return any(values) and (values.get('FedAuth', None) is not None or values.get('SPOIDCRL', None) is not None)
 
 
 class SamlTokenProvider(AuthenticationProvider, office365.logger.LoggerContext):

generator/metadata/SharePoint.xml

@@ -41,9 +41,9 @@ def get_by_path(self, decoded_url):
 
     def ensure_folder_path(self, path):
         """
-        Function to create a folder
-        :type path: string
-        :param path: relative server URL (path) to a folder
+        Creates a nested folder structure
+
+        :param str path: relative server URL (path) to a folder
         """
 
         url_component = os.path.normpath(path).split(os.path.sep)

office365/runtime/auth/providers/saml_token_provider.py

@@ -0,0 +1,9 @@
+from office365.runtime.client_value import ClientValue
+
+
+class WikiPageCreationInformation(ClientValue):
+
+    def __init__(self, server_relative_url, content):
+        super().__init__()
+        self.ServerRelativeUrl = server_relative_url
+        self.WikiHtmlContent = content

office365/sharepoint/folders/folder_collection.py

@@ -0,0 +1,16 @@
+from office365.runtime.queries.service_operation_query import ServiceOperationQuery
+from office365.runtime.resource_path import ResourcePath
+from office365.sharepoint.base_entity import BaseEntity
+from office365.sharepoint.tenant.administration.hub_site_collection import HubSiteCollection
+
+
+class SPHubSitesUtility(BaseEntity):
+
+    def __init__(self, context):
+        super().__init__(context, ResourcePath("Microsoft.SharePoint.Portal.SPHubSitesUtility"))
+
+    def get_hub_sites(self):
+        hub_sites = HubSiteCollection(self.context)
+        qry = ServiceOperationQuery(self, "GetHubSites", None, None, None, hub_sites)
+        self.context.add_query(qry)
+        return hub_sites

office365/sharepoint/pages/wiki_page_creation_information.py

@@ -135,6 +135,20 @@ def get_catalog(self, type_catalog):
         :type type_catalog: int"""
         return List(self.context, ResourcePathServiceOperation("getCatalog", [type_catalog], self.resource_path))
 
+    def register_hub_site(self, creationInformation):
+        """Registers an existing site as a hub site.
+
+        :type creationInformation: HubSiteCreationInformation
+        """
+        qry = ServiceOperationQuery(self, "RegisterHubSite", None, creationInformation, "creationInformation", None)
+        self.context.add_query(qry)
+        return self
+
+    def unregister_hub_site(self):
+        qry = ServiceOperationQuery(self, "UnRegisterHubSite", None, None, None, None)
+        self.context.add_query(qry)
+        return self
+
     @property
     def root_web(self):
         """Get root web"""
@@ -162,6 +176,13 @@ def id(self):
         """
         return self.properties.get("Id", None)
 
+    @property
+    def is_hub_site(self):
+        """
+        :rtype: bool
+        """
+        return self.properties.get("IsHubSite", None)
+
     @property
     def recycle_bin(self):
         """Get recycle bin"""

office365/sharepoint/portal/hub_sites_utility.py

@@ -0,0 +1,5 @@
+from office365.sharepoint.base_entity import BaseEntity
+
+
+class HubSite(BaseEntity):
+    pass

office365/sharepoint/sites/site.py

@@ -0,0 +1,9 @@
+from office365.runtime.client_object_collection import ClientObjectCollection
+from office365.sharepoint.tenant.administration.hub_site import HubSite
+
+
+class HubSiteCollection(ClientObjectCollection):
+    """Represents a collection of HubSite resources."""
+
+    def __init__(self, context, resource_path=None):
+        super(HubSiteCollection, self).__init__(context, HubSite, resource_path)

office365/sharepoint/tenant/administration/hub_site.py

@@ -0,0 +1,5 @@
+from office365.runtime.client_value import ClientValue
+
+
+class HubSitePermission(ClientValue):
+    pass

office365/sharepoint/tenant/administration/hub_site_collection.py

@@ -4,7 +4,7 @@
 from office365.runtime.resource_path import ResourcePath
 from office365.sharepoint.base_entity import BaseEntity
 from office365.sharepoint.publishing.portal_health_status import PortalHealthStatus
-from office365.sharepoint.tenant.administration.hubSiteProperties import HubSiteProperties
+from office365.sharepoint.tenant.administration.hubsite_properties import HubSiteProperties
 from office365.sharepoint.tenant.administration.secondary_administrators_fields_data import \
     SecondaryAdministratorsFieldsData
 from office365.sharepoint.tenant.administration.secondary_administrators_info import SecondaryAdministratorsInfo
@@ -20,6 +20,12 @@ def __init__(self, context):
         super().__init__(context, ResourcePath("Microsoft.Online.SharePoint.TenantAdministration.Tenant"),
                          "Microsoft.Online.SharePoint.TenantAdministration")
 
+    def hubsites(self, siteUrl):
+        pass
+
+    def connect_site_to_hubsite_by_id(self, siteUrl, hubSiteId):
+        pass
+
     def check_tenant_licenses(self, licenses):
         """
         Checks whether a tenant has the specified licenses.

office365/sharepoint/tenant/administration/hubsite_permission.py

@@ -0,0 +1,29 @@
+from office365.runtime.client_value import ClientValue
+from office365.runtime.client_value_collection import ClientValueCollection
+
+
+class EmailProperties(ClientValue):
+
+    def __init__(self, body, subject, to, from_address=None, cc=None, bcc=None, additional_headers=None):
+        """
+
+        :param str body:
+        :param str subject:
+        :param list[str] to:
+        :param str or None from_address:
+        :param list[str] or None cc:
+        :param list[str] or None bcc:
+        :param dict or None additional_headers:
+        """
+        super().__init__()
+        self.Body = body
+        self.Subject = subject
+        self.From = from_address
+        self.To = ClientValueCollection(str, to)
+        self.CC = ClientValueCollection(str, cc)
+        self.BCC = ClientValueCollection(str, bcc)
+        self.AdditionalHeaders = additional_headers
+
+    @property
+    def entity_type_name(self):
+        return "SP.Utilities.EmailProperties"

office365/sharepoint/tenant/administration/hubSiteProperties.py renamed to office365/sharepoint/tenant/administration/hubsite_properties.py

@@ -0,0 +1,75 @@
+from office365.runtime.client_result import ClientResult
+from office365.runtime.client_value_collection import ClientValueCollection
+from office365.runtime.queries.service_operation_query import ServiceOperationQuery
+from office365.runtime.resource_path import ResourcePath
+from office365.sharepoint.base_entity import BaseEntity
+
+
+class Utility(BaseEntity):
+
+    def __init__(self, context):
+        super().__init__(context, ResourcePath("SP.Utilities.Utility"))
+
+    @staticmethod
+    def get_current_user_email_addresses(context):
+        """
+
+        :type context: office365.sharepoint.client_context.ClientContext
+        """
+        result = ClientResult(str)
+        utility = Utility(context)
+        qry = ServiceOperationQuery(utility, "GetCurrentUserEmailAddresses", None, None, None, result)
+        qry.static = True
+        context.add_query(qry)
+        return result
+
+    @staticmethod
+    def get_user_permission_levels(context):
+        """
+        :type context: office365.sharepoint.client_context.ClientContext
+        """
+        result = ClientResult(ClientValueCollection(str))
+        utility = Utility(context)
+        qry = ServiceOperationQuery(utility, "GetUserPermissionLevels", None, None, None, result)
+        qry.static = True
+        context.add_query(qry)
+        return result
+
+    @staticmethod
+    def search_principals_using_context_web(context, s_input, sources, scopes, maxCount, groupName=None):
+        """
+        :type s_input: str
+        :type sources: int
+        :type scopes: int
+        :type maxCount: int
+        :type groupName: str or None
+        :type context: office365.sharepoint.client_context.ClientContext
+        """
+        result = ClientResult(ClientValueCollection(str))
+        utility = Utility(context)
+        params = {
+            "input": s_input,
+            "sources": sources,
+            "scopes": scopes,
+            "maxCount": maxCount,
+            "groupName": groupName
+        }
+        qry = ServiceOperationQuery(utility, "SearchPrincipalsUsingContextWeb", params, None, None, result)
+        qry.static = True
+        context.add_query(qry)
+        return result
+
+    @staticmethod
+    def send_email(context, properties):
+        """
+        :type context: office365.sharepoint.client_context.ClientContext
+        :type properties: office365.sharepoint.utilities.email_properties.EmailProperties
+        """
+        utility = Utility(context)
+        qry = ServiceOperationQuery(utility, "SendEmail", None, properties, "properties")
+        qry.static = True
+        context.add_query(qry)
+
+    @property
+    def entity_type_name(self):
+        return "SP.Utilities.Utility"

office365/sharepoint/tenant/administration/tenant.py

@@ -232,9 +232,9 @@ def get_folder_by_server_relative_url(self, url):
 
     def ensure_folder_path(self, path):
         """
-            Function to create folder tree
-            :type path: string
-            :param path: relative server URL (path) to a folder
+        Creates a nested folder structure
+
+        :param str path: relative server URL (path) to a folder
         """
         return self.root_folder.folders.ensure_folder_path(path)
 

office365/sharepoint/utilities/__init__.py

@@ -0,0 +1,24 @@
+from office365.sharepoint.portal.hub_sites_utility import SPHubSitesUtility
+from tests.sharepoint.sharepoint_case import SPTestCase
+
+
+class TestHubSite(SPTestCase):
+
+    @classmethod
+    def setUpClass(cls):
+        super(TestHubSite, cls).setUpClass()
+        cls.target_site = cls.client.site.get().execute_query()
+
+    def test1_register_hub_site(self):
+        if not self.target_site.is_hub_site:
+            site = self.target_site.register_hub_site(None).get().execute_query()
+            self.assertTrue(site.is_hub_site)
+
+    def test2_get_hub_sites(self):
+        hub_sites = SPHubSitesUtility(self.client).get_hub_sites().execute_query()
+        self.assertGreater(len(hub_sites), 0)
+
+    def test3_unregister_hub_site(self):
+        site = self.target_site.unregister_hub_site().get().execute_query()
+        self.assertFalse(site.is_hub_site)
+

office365/sharepoint/utilities/email_properties.py

@@ -0,0 +1,27 @@
+from office365.sharepoint.utilities.email_properties import EmailProperties
+from office365.sharepoint.utilities.utility import Utility
+from settings import settings
+from tests.sharepoint.sharepoint_case import SPTestCase
+
+
+class TestUtility(SPTestCase):
+
+    @classmethod
+    def setUpClass(cls):
+        super(TestUtility, cls).setUpClass()
+
+    def test1_get_current_user_email_addresses(self):
+        result = Utility.get_current_user_email_addresses(self.client)
+        self.client.execute_query()
+        self.assertIsNotNone(result.value)
+
+    def test2_get_user_permission_levels(self):
+        result = Utility.get_user_permission_levels(self.client)
+        self.client.execute_query()
+        self.assertIsNotNone(result.value)
+
+    def test3_send_email(self):
+        email_props = EmailProperties("The new cafeteria is open.", "Meet for lunch?",
+                                      [settings.get('first_account_name')])
+        Utility.send_email(self.client, email_props)
+        self.client.execute_query()