SharePoint API enhancement: ensure if security validation expires (#243)

Author: vgrem

examples/sharepoint/simulate_long_running_task.py

@@ -1,18 +1,25 @@
 import time
 from office365.sharepoint.client_context import ClientContext
+from office365.sharepoint.server_settings import ServerSettings
 from tests import test_site_url, test_client_credentials
 
 
-def process_site(context):
-    target_web = context.web
-    target_web.set_property("Description", "DEV site").update().get().execute_query()
-    print(target_web.url)
+def print_server_settings(context):
+    """
+    :type context: ClientContext
+    """
+    is_online = ServerSettings.is_sharepoint_online(context)
+    installed_languages = ServerSettings.get_global_installed_languages(context, 15)
+    context.execute_batch()
+    print("Is SharePoint Online? : {0}".format(is_online.value))
+    print("Installed languages amount : {0}".format(len(installed_languages.items)))
 
 
 ctx = ClientContext(test_site_url).with_credentials(test_client_credentials)
 
 if __name__ == '__main__':
-    while 1:
-        print(f"{time.ctime()}: Processing site")
-        process_site(ctx)
-        time.sleep(10)
+    start_time = time.time()
+    while True:
+        print(f" %s : Processing site..." % int(time.time() - start_time))
+        print_server_settings(ctx)
+        time.sleep(30)

office365/sharepoint/client_context.py

@@ -41,7 +41,7 @@ def __init__(self, base_url, auth_context=None):
         self.__web = None
         self.__site = None
         self._base_url = base_url
-        self._ctx_web_info = None
+        self._ctx_web_info = ContextWebInformation()
         self._pendingRequest = ODataRequest(self, JsonLightFormat(ODataMetadataLevel.Verbose))
         self._pendingRequest.beforeExecute += self._build_modification_query
 
@@ -63,6 +63,7 @@ def _init_context_for_web(resp):
             """
             resp.raise_for_status()
             ctx._base_url = result.value
+
         ctx.after_execute(_init_context_for_web)
         return ctx
 
@@ -118,6 +119,7 @@ def execute_batch(self, items_per_batch=100):
 
         def _prepare_batch_request(request):
             self.ensure_form_digest(request)
+
         batch_request.beforeExecute += _prepare_batch_request
 
         all_queries = [qry for qry in self.pending_request().next_query()]
@@ -145,7 +147,7 @@ def ensure_form_digest(self, request_options):
         """
         :type request_options: RequestOptions
         """
-        if self._ctx_web_info is None:
+        if not self._ctx_web_info.is_valid:
             self._ctx_web_info = self.get_context_web_information()
         request_options.set_header('X-RequestDigest', self._ctx_web_info.FormDigestValue)
 

office365/sharepoint/webs/context_web_information.py

@@ -1,14 +1,30 @@
+import math
+import time
+
 from office365.runtime.client_value import ClientValue
 
 
 class ContextWebInformation(ClientValue):
-    """The context information for a site."""
+    """Specifies metadata about a site (2)."""
 
-    def __init__(self):
+    def __init__(self, form_digest_value=None, form_digest_timeout_secs=None):
+        """
+        :param str form_digest_value: Specifies a valid form digest for the site
+        :param int form_digest_timeout_secs: Specifies the amount of time in seconds before security validation expires.
+        """
         super(ContextWebInformation, self).__init__()
-        self.FormDigestValue = None
-        self.FormDigestTimeoutSeconds = None
+        self.FormDigestValue = form_digest_value
+        self.FormDigestTimeoutSeconds = form_digest_timeout_secs
         self.LibraryVersion = None
         self.SiteFullUrl = None
         self.SupportedSchemaVersions = None
         self.WebFullUrl = None
+        self._valid_from = time.time()
+
+    @property
+    def is_valid(self):
+        if self.FormDigestTimeoutSeconds is None:
+            return False
+        else:
+            expires_in_sec = math.ceil(time.time() - self._valid_from)
+            return expires_in_sec < self.FormDigestTimeoutSeconds