SharePoint API: navigation, web namespace methods & types

vvgrem@gmail.com · vvgrem@gmail.com · commit 3f096c9d87f5 · 2020-11-17T16:48:58.000+02:00
diff --git a/generator/metadata/SharePoint.xml b/generator/metadata/SharePoint.xml
diff --git a/office365/runtime/client_object.py b/office365/runtime/client_object.py
@@ -75,6 +75,7 @@ def get_property(self, name):
 
     def set_property(self, name, value, persist_changes=True):
         """Sets Property value
+
         :param str name: Property name
         :param any value: Property value
         :param bool persist_changes: Persist changes
@@ -95,6 +96,7 @@ def set_property(self, name, value, persist_changes=True):
                 self._properties[name] = value
         else:
             self._properties[name] = value
+        return self
 
     def to_json(self):
         return dict((k, v) for k, v in self.properties.items() if k in self._changed_properties)
@@ -106,9 +108,7 @@ def ensure_property(self, name, action):
         :type action: () -> None
         :type name: str
         """
-        names_to_include = [name]
-        self.ensure_properties(names_to_include, action)
-        return self
+        return self.ensure_properties([name], action)
 
     def ensure_properties(self, names, action):
         """
@@ -127,6 +127,7 @@ def _process_query(current_query):
                 self.context.after_execute_query(_process_query)
         else:
             action()
+        return self
 
     def clone_object(self):
         result = copy.deepcopy(self)
diff --git a/office365/sharepoint/microservice/micro_service_manager.py b/office365/sharepoint/microservice/micro_service_manager.py
@@ -0,0 +1,5 @@
+from office365.sharepoint.base_entity import BaseEntity
+
+
+class MicroServiceManager(BaseEntity):
+    pass
diff --git a/office365/sharepoint/navigation/__init__.py b/office365/sharepoint/navigation/__init__.py
diff --git a/office365/sharepoint/navigation/menuState.py b/office365/sharepoint/navigation/menuState.py
@@ -0,0 +1,5 @@
+from office365.runtime.client_value import ClientValue
+
+
+class MenuState(ClientValue):
+    pass
diff --git a/office365/sharepoint/navigation/navigationService.py b/office365/sharepoint/navigation/navigationService.py
@@ -0,0 +1,39 @@
+from office365.runtime.client_result import ClientResult
+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.navigation.menuState import MenuState
+
+
+class NavigationService(BaseEntity):
+
+    def __init__(self, context):
+        """The entry point for REST-based navigation service operations."""
+        super().__init__(context, ResourcePath("Microsoft.SharePoint.Navigation.REST.NavigationServiceRest"))
+
+    def get_publishing_navigation_provider_type(self, mapProviderName="SPNavigationProvider"):
+        """
+        Gets a publishing navigation provider type when publishing feature is turned on for the site (2).
+        If navigation provider is not found on the site MUST return InvalidSiteMapProvider type.
+
+        :param str mapProviderName: The server will use "SPNavigationProvider" as provider name
+            if mapProviderName is not specified.
+        :return:
+        """
+        result = ClientResult(None)
+        params = {"mapProviderName": mapProviderName}
+        qry = ServiceOperationQuery(self, "GetPublishingNavigationProviderType", params, None, None, result)
+        self.context.add_query(qry)
+        return result
+
+    def global_nav(self):
+        return_type = MenuState()
+        qry = ServiceOperationQuery(self, "GlobalNav", None, None, None, return_type)
+        self.context.add_query(qry)
+        return return_type
+
+    def menu_node_key(self, currentUrl):
+        pass
+
+    def save_menu_state(self):
+        pass
diff --git a/office365/sharepoint/navigation/publishingNavigationProviderType.py b/office365/sharepoint/navigation/publishingNavigationProviderType.py
@@ -0,0 +1,7 @@
+class PublishingNavigationProviderType:
+    def __init__(self):
+        pass
+
+    InvalidSiteMapProvider = 0
+    PortalSiteMapProvider = 1
+    TaxonomySiteMapProvider = 2
diff --git a/office365/sharepoint/portal/SPSiteManager.py b/office365/sharepoint/portal/SPSiteManager.py
@@ -27,7 +27,10 @@ def delete(self, site_id):
         return self
 
     def get_status(self, site_url):
-        """Get the status of a SharePoint site"""
+        """Get the status of a SharePoint site
+
+        :type site_url: str
+        """
         response = SPSiteCreationResponse()
         qry = ServiceOperationQuery(self, "Status", None, {'url': site_url}, None, response)
         self.context.add_query(qry)
diff --git a/office365/sharepoint/principal/group_collection.py b/office365/sharepoint/principal/group_collection.py
@@ -25,9 +25,12 @@ def get_by_id(self, group_id):
         return group
 
     def get_by_name(self, group_name):
-        """Returns a cross-site group from the collection based on the name of the group."""
+        """Returns a cross-site group from the collection based on the name of the group.
+
+        :type group_name: str
+        """
         return Group(self.context,
-                     ResourcePathServiceOperation("getbyname", [group_name], self.resource_path))
+                     ResourcePathServiceOperation("getByName", [group_name], self.resource_path))
 
     def remove_by_id(self, group_id):
         """Removes the group with the specified member ID from the collection."""
diff --git a/office365/sharepoint/sites/site.py b/office365/sharepoint/sites/site.py
@@ -7,7 +7,9 @@
 from office365.sharepoint.lists.list import List
 from office365.sharepoint.principal.user import User
 from office365.sharepoint.recyclebin.recycleBinItemCollection import RecycleBinItemCollection
+from office365.sharepoint.sites.sph_site import SPHSite
 from office365.sharepoint.webs.web import Web
+from office365.sharepoint.webs.web_template_collection import WebTemplateCollection
 
 
 class Site(ClientObject):
@@ -16,6 +18,22 @@ class Site(ClientObject):
     def __init__(self, context):
         super(Site, self).__init__(context, ResourcePath("Site", None))
 
+    def is_valid_home_site(self):
+        result = ClientResult(None)
+
+        def _site_loaded():
+            SPHSite.is_valid_home_site(self.context, self.url, result)
+        self.ensure_property("Url", _site_loaded)
+        return result
+
+    def set_as_home_site(self):
+        result = ClientResult(None)
+
+        def _site_loaded():
+            self.result = SPHSite.set_as_home_site(self.context, self.url, result)
+        self.ensure_property("Url", _site_loaded)
+        return result
+
     def get_changes(self, query):
         """Returns the collection of all changes from the change log that have occurred within the scope of the site,
         based on the specified query.
@@ -37,6 +55,28 @@ def get_recycle_bin_items(self, pagingInfo=None, rowLimit=100, isAscending=True,
         self.context.add_query(qry)
         return result
 
+    def get_web_templates(self, lcid=1033, override_compat_level=0):
+        """
+        Returns the collection of site definitions that are available for creating
+            Web sites within the site collection.<99>
+
+        :param int lcid: A 32-bit unsigned integer that specifies the language of the site definitions that are
+            returned from the site collection.
+        :param int override_compat_level: Specifies the compatibility level of the site (2)
+            to return from the site collection. If this value is 0, the compatibility level of the site (2) is used.
+        :return:
+        """
+        params = {
+            "LCID": lcid,
+            "overrideCompatLevel": override_compat_level
+        }
+        return_type = WebTemplateCollection(self.context,
+                                            ResourcePathServiceOperation("GetWebTemplates", params, self.resource_path))
+
+        qry = ServiceOperationQuery(self, "GetWebTemplates", params, None, None, return_type)
+        self.context.add_query(qry)
+        return return_type
+
     @staticmethod
     def get_url_by_id(context, site_id, stop_redirect=False):
         """Gets Site Url By Id
@@ -54,6 +94,10 @@ def get_url_by_id(context, site_id, stop_redirect=False):
         context.add_query(qry)
         return result
 
+    @staticmethod
+    def get_url_by_id_for_web(context):
+        pass
+
     @staticmethod
     def exists(context, url):
         """Determine whether site exists
@@ -91,6 +135,10 @@ def owner(self):
         else:
             return User(self.context, ResourcePath("owner", self.resource_path))
 
+    @property
+    def url(self):
+        return self.properties.get('Url', None)
+
     @property
     def recycleBin(self):
         """Get recycle bin"""
diff --git a/office365/sharepoint/sites/sph_site.py b/office365/sharepoint/sites/sph_site.py
@@ -0,0 +1,47 @@
+from office365.runtime.client_result import ClientResult
+from office365.runtime.queries.service_operation_query import ServiceOperationQuery
+from office365.runtime.resource_path import ResourcePath
+from office365.sharepoint.base_entity import BaseEntity
+
+
+class SPHSite(BaseEntity):
+
+    def __init__(self, context):
+        super().__init__(context, ResourcePath("SP.SPHSite"))
+
+    @staticmethod
+    def is_valid_home_site(context, site_url, return_value=None):
+        """
+
+        :param ClientResult return_value:
+        :param office365.sharepoint.client_context.ClientContext context:
+        :param str site_url:
+        :return:
+        """
+
+        if return_value is None:
+            return_value = ClientResult(None)
+        sph = SPHSite(context)
+        params = {"siteUrl": site_url}
+        qry = ServiceOperationQuery(sph, "IsValidHomeSite", params, None, None, return_value)
+        qry.static = True
+        context.add_query(qry)
+        return return_value
+
+    @staticmethod
+    def set_as_home_site(context, site_url, return_value=None):
+        """
+
+        :param ClientResult return_value:
+        :param office365.sharepoint.client_context.ClientContext context:
+        :param str site_url:
+        """
+
+        if return_value is None:
+            return_value = ClientResult(None)
+        sph = SPHSite(context)
+        params = {"siteUrl": site_url}
+        qry = ServiceOperationQuery(sph, "SetSPHSite", params, None, None, return_value)
+        qry.static = True
+        context.add_query(qry)
+        return return_value
diff --git a/office365/sharepoint/webs/remote_web.py b/office365/sharepoint/webs/remote_web.py
diff --git a/office365/sharepoint/webs/web_template_collection.py b/office365/sharepoint/webs/web_template_collection.py
@@ -0,0 +1,19 @@
+from office365.sharepoint.base_entity_collection import BaseEntityCollection
+from office365.runtime.resource_path_service_operation import ResourcePathServiceOperation
+from office365.sharepoint.webs.web_template import WebTemplate
+
+
+class WebTemplateCollection(BaseEntityCollection):
+    """Specifies a collection of site templates."""
+
+    def __init__(self, context, resource_path=None, parent=None):
+        super(WebTemplateCollection, self).__init__(context, WebTemplate, resource_path, parent)
+
+    def get_by_name(self, name):
+        """Returns the SP.WebTemplate (section 3.2.5.151) specified by its name.<162>
+
+        :param str name: The name of the SP.WebTemplate that is returned.
+
+        """
+        return WebTemplate(self.context,
+                           ResourcePathServiceOperation("getByName", [f"{name}"], self.resource_path))
diff --git a/tests/sharepoint/test_comminication_site.py b/tests/sharepoint/test_comminication_site.py
@@ -1,9 +1,8 @@
 import uuid
 from unittest import TestCase
 
+from office365.runtime.auth.user_credential import UserCredential
 from settings import settings
-
-from office365.runtime.auth.authentication_context import AuthenticationContext
 from office365.sharepoint.client_context import ClientContext
 from office365.sharepoint.portal.SiteStatus import SiteStatus
 from office365.sharepoint.portal.SPSiteCreationRequest import SPSiteCreationRequest
@@ -16,16 +15,16 @@ class TestCommunicationSite(TestCase):
     @classmethod
     def setUpClass(cls):
         super(TestCommunicationSite, cls).setUpClass()
-        ctx_auth = AuthenticationContext(url=settings['url'])
-        ctx_auth.acquire_token_for_user(username=settings['user_credentials']['username'],
-                                        password=settings['user_credentials']['password'])
-        cls.client = ClientContext(settings['url'], ctx_auth)
+        cls.user_credentials = UserCredential(settings['user_credentials']['username'],
+                                              settings['user_credentials']['password'])
+
+        cls.client = ClientContext(settings['url']).with_credentials(cls.user_credentials)
         cls.site_manager = SPSiteManager(cls.client)
 
     def test1_create_site(self):
         current_user = self.client.web.currentUser.get().execute_query()
         site_url = "{0}sites/{1}".format(settings["url"], uuid.uuid4().hex)
-        request = SPSiteCreationRequest("CommSite123", site_url, current_user.properties['UserPrincipalName'])
+        request = SPSiteCreationRequest("CommSite123", site_url, current_user.user_principal_name)
         response = self.site_manager.create(request)
         self.client.execute_query()
         self.assertIsNotNone(response.SiteStatus)
@@ -37,5 +36,5 @@ def test2_get_site_status(self):
         self.assertIsNotNone(response.SiteStatus)
         self.assertTrue(response.SiteStatus != SiteStatus.Error)
 
-    def test3_delete_site(self):
+    def test4_delete_site(self):
         self.site_manager.delete(self.__class__.site_response.SiteId).execute_query()
diff --git a/tests/sharepoint/test_navigation.py b/tests/sharepoint/test_navigation.py
@@ -0,0 +1,29 @@
+from office365.sharepoint.navigation.navigationService import NavigationService
+from tests.sharepoint.sharepoint_case import SPTestCase
+
+
+class TestNavigation(SPTestCase):
+
+    @classmethod
+    def setUpClass(cls):
+        super(TestNavigation, cls).setUpClass()
+        cls.nav_svc = NavigationService(cls.client)
+
+    #def test1_ensure_home_site(self):
+    #    result = self.client.site.is_valid_home_site()
+    #    self.client.execute_query()
+    #    self.assertIsInstance(result.value, bool)
+    #    if result.value is False:
+    #        result = self.client.site.set_as_home_site()
+    #        self.client.execute_query()
+    #        self.assertIsNotNone(result.value)
+
+    #def test2_get_publishing_navigation_provider_type(self):
+    #    result = self.nav_svc.get_publishing_navigation_provider_type()
+    #    self.client.execute_query()
+    #    self.assertIsInstance(result.value, int)
+
+    #def test3_global_nav(self):
+    #    result = self.nav_svc.global_nav()
+    #    self.client.execute_query()
+    #    self.assertIsNotNone(result)
diff --git a/tests/sharepoint/test_site.py b/tests/sharepoint/test_site.py
@@ -15,7 +15,7 @@ def test1_if_site_loaded(self):
         self.__class__.target_site = site
 
     def test2_if_site_exists(self):
-        site_url = self.__class__.target_site.properties['Url']
+        site_url = self.__class__.target_site.url
         result = Site.exists(self.client, site_url)
         self.client.execute_query()
         self.assertIsNotNone(result.value)
@@ -29,3 +29,12 @@ def test3_get_site_by_id(self):
     def test4_get_site_catalog(self):
         catalog = self.client.site.get_catalog(ListTemplateType.AppDataCatalog).get().execute_query()
         self.assertIsNotNone(catalog.title)
+
+    def test5_get_web_templates(self):
+        web_templates = self.client.site.get_web_templates().execute_query()
+        self.assertIsNotNone(web_templates)
+
+    def test6_get_web_template_by_name(self):
+        template_name = "GLOBAL#0"
+        web_template = self.client.site.get_web_templates().get_by_name(template_name).get().execute_query()
+        self.assertIsNotNone(web_template)

-Original file line number
+Diff line change
@@ @@ -0,0 +1,5 @@ @@
 +from office365.sharepoint.base_entity import BaseEntity
++
++
 +class MicroServiceManager(BaseEntity):
 +    pass