Release 2.2.3

Author: vvgrem@gmail.com

examples/onedrive/export_files.py

@@ -43,7 +43,7 @@ def download_files(remote_folder, local_path):
 client = GraphClient(get_token)
 
 # load drive properties
-target_user_name = settings.get('test_accounts')[1]
+target_user_name = settings.get('test_account_name')
 drive = client.users[target_user_name].drive
 # download files from OneDrive
 with tempfile.TemporaryDirectory() as path:

examples/onedrive/import_files.py

@@ -37,7 +37,7 @@ def upload_files(remote_drive, local_root_path):
 
 # get target drive
 client = GraphClient(get_token)
-user_name = settings.get('test_accounts')[1]
+user_name = settings.get('test_alt_account_name')
 target_drive = client.users[user_name].drive
 # import local files into OneDrive
 upload_files(target_drive, "../data")

examples/onedrive/upload_file.py

@@ -21,7 +21,7 @@ def acquire_token():
 
 
 client = GraphClient(acquire_token)
-user_name = settings.get('test_accounts')[1]
+user_name = settings.get('test_account_name')
 target_drive = client.users[user_name].drive
 
 local_path = "../../tests/data/SharePoint User Guide.docx"

examples/outlook/send_message.py

@@ -26,14 +26,14 @@ def get_token():
         "ToRecipients": [
             {
                 "EmailAddress": {
-                    "Address": settings.get('test_accounts')[1]
+                    "Address": settings.get('test_account_name')
                 }
             }
         ]
     },
     "SaveToSentItems": "false"
 }
 
-user_name = settings.get('test_accounts')[0]
+user_name = settings.get('test_account_name')
 client.users[user_name].send_mail(message_json)
 client.execute_query()

examples/sharepoint/files/download_file_large.py

@@ -4,33 +4,9 @@
 from settings import settings
 
 from office365.runtime.auth.client_credential import ClientCredential
-from office365.runtime.http.request_options import RequestOptions
 from office365.sharepoint.client_context import ClientContext
 
 
-def download_file(context, download_url, file_object, chunk_downloaded=None, chunk_size=1024 * 1024):
-    """
-
-    :type context: office365.sharepoint.client_context.ClientContext
-    :type download_url: str
-    :type file_object: typing.IO
-    :type chunk_downloaded: (int)->None or None
-    :type chunk_size: int
-    """
-
-    request = RequestOptions(
-        r"{0}web/getFileByServerRelativeUrl('{1}')/\$value".format(ctx.service_root_url(), download_url))
-    request.stream = True
-    response = context.execute_request_direct(request)
-    response.raise_for_status()
-    bytes_read = 0
-    for chunk in response.iter_content(chunk_size=chunk_size):
-        bytes_read += len(chunk)
-        if callable(chunk_downloaded):
-            chunk_downloaded(bytes_read)
-        file_object.write(chunk)
-
-
 def print_download_progress(offset):
     print("Downloaded '{0}' bytes...".format(offset))
 
@@ -41,7 +17,8 @@ def print_download_progress(offset):
 ctx = ClientContext(site_url).with_credentials(credentials)
 
 file_url = '/sites/team/Shared Documents/big_buck_bunny.mp4'
+source_file = ctx.web.get_file_by_server_relative_url(file_url)
 local_file_name = os.path.join(tempfile.mkdtemp(), os.path.basename(file_url))
 with open(local_file_name, "wb") as local_file:
-    download_file(ctx, file_url, local_file, print_download_progress)
+    source_file.download_session(local_file, print_download_progress).execute_query()
 print("[Ok] file has been downloaded: {0}".format(local_file_name))

examples/sharepoint/tenant/get_set_site_admin.py

@@ -2,13 +2,13 @@
 from office365.sharepoint.client_context import ClientContext
 from office365.sharepoint.tenant.administration.secondary_administrators_info import SecondaryAdministratorsInfo
 from office365.sharepoint.tenant.administration.tenant import Tenant
-from settings import settings
+from settings import settings, tenant_prefix
 
 credentials = UserCredential(settings['user_credentials']['username'],
                              settings['user_credentials']['password'])
 
 
-client = ClientContext(settings.get("team_site_url")).with_credentials(credentials)
+client = ClientContext(settings.get('url')).with_credentials(credentials)
 target_site = client.site.get().execute_query()
 
 admin_client = ClientContext(settings.get("admin_site_url")).with_credentials(credentials)
@@ -17,8 +17,11 @@
 admins = tenant.get_site_secondary_administrators(site_id=target_site.id)
 admin_client.execute_query()
 
-emails = settings.get("test_accounts")
-tenant.set_site_secondary_administrators(site_id=target_site.id, emails=emails).execute_query()
+existing_admin_names = [admin.get_property('loginName') for admin in admins]
+
+target_user = target_site.rootWeb.ensure_user(f"mdoe@{tenant_prefix}.onmicrosoft.com").execute_query()
+names = existing_admin_names + [target_user.login_name]
+tenant.set_site_secondary_administrators(site_id=target_site.id, names=names).execute_query()
 
 for admin in admins:  # type: SecondaryAdministratorsInfo
     print(admin.get_property('loginName'))

office365/runtime/auth/providers/saml_token_provider.py

@@ -2,9 +2,6 @@
 import uuid
 from xml.etree import ElementTree
 import xml.dom.minidom as minidom
-from urllib.parse import urlparse
-
-from datetime import datetime, timezone, timedelta
 
 
 import requests
@@ -112,18 +109,14 @@ def get_last_error(self):
     def acquire_service_token_from_adfs(self, adfs_url, username, password):
         logger = self.logger(self.acquire_service_token_from_adfs.__name__)
 
-        now = datetime.now(tz=timezone.utc)
-        created = now.astimezone(timezone.utc).isoformat('T')[:-9]+'Z'
-        expires = (now + timedelta(minutes=10)).astimezone(timezone.utc).isoformat('T')[:-9]+'Z'
-
         payload = self._prepare_request_from_template('FederatedSAML.xml', {
             'auth_url': adfs_url,
             'message_id': str(uuid.uuid4()),
             'username': username,
             'password': password,
-            'created': created,
-            'expires': expires,
-            'issuer': self.__sts_profile.federationTokenIssuer
+            'created': self.__sts_profile.created,
+            'expires': self.__sts_profile.expires,
+            'issuer': self.__sts_profile.tokenIssuer
         })
 
         response = requests.post(adfs_url, data=payload,
@@ -132,15 +125,13 @@ def acquire_service_token_from_adfs(self, adfs_url, username, password):
         assertion_node = dom.getElementsByTagNameNS("urn:oasis:names:tc:SAML:1.0:assertion", 'Assertion')[0].toxml()
 
         try:
-            self.tenant = urlparse(self.__sts_profile.authorityUrl).netloc
-
             payload = self._prepare_request_from_template('RST2.xml', {
-                'auth_url': self.tenant,
+                'auth_url': self.__sts_profile.tenant,
                 'serviceTokenUrl': self.__sts_profile.security_token_service_url,
                 'assertion_node': assertion_node
             })
 
-            # 3. get token
+            # 3. get security token
             response = requests.post(self.__sts_profile.security_token_service_url, data=payload,
                                      headers={'Content-Type': 'application/soap+xml'})
             token = self._process_service_token_response(response)
@@ -154,14 +145,15 @@ def acquire_service_token_from_adfs(self, adfs_url, username, password):
     def _acquire_service_token(self, username, password, service_target=None, service_policy=None):
         """Retrieve service token"""
         logger = self.logger(self._acquire_service_token.__name__)
+
         payload = self._prepare_request_from_template('SAML.xml', {
             'auth_url': self.__sts_profile.authorityUrl,
             'username': username,
             'password': password,
             'message_id': str(uuid.uuid4()),
             'created': self.__sts_profile.created,
             'expires': self.__sts_profile.expires,
-            'issuer': self.__sts_profile.federationTokenIssuer
+            'issuer': self.__sts_profile.tokenIssuer
         })
         logger.debug_secrets('options: %s', payload)
         response = requests.post(self.__sts_profile.security_token_service_url, data=payload,
@@ -217,14 +209,11 @@ def _acquire_authentication_cookie(self, security_token, federated=False):
         logger.debug_secrets("session: %s\nsession.post(%s, data=%s)", session, self.__sts_profile.signin_page_url,
                              security_token)
         if not federated:
-            self._auth_cookies['FedAuth'] = None
-            self._auth_cookies['rtFa'] = None
             session.post(self.__sts_profile.signin_page_url, data=security_token,
                          headers={'Content-Type': 'application/x-www-form-urlencoded'})
         else:
-            self._auth_cookies['SPOIDCRL'] = None
-            idcrlEndpoint = "https://{}/_vti_bin/idcrl.svc/".format(self.tenant)
-            session.get(idcrlEndpoint,
+            idcrl_endpoint = "https://{}/_vti_bin/idcrl.svc/".format(self.__sts_profile.tenant)
+            session.get(idcrl_endpoint,
                         headers={
                             'User-Agent': 'Office365 Python Client',
                             'X-IDCRL_ACCEPTED': 't',
@@ -238,8 +227,7 @@ def _acquire_authentication_cookie(self, security_token, federated=False):
                 self.__sts_profile.signin_page_url)
             logger.error(self.error)
             return False
-        for name in self._auth_cookies.keys():
-            self._auth_cookies[name] = cookies[name]
+        self._auth_cookies = cookies
         return True
 
     @staticmethod

office365/runtime/auth/sts_profile.py

@@ -1,4 +1,6 @@
 import datetime
+from datetime import datetime, timezone, timedelta
+from urllib.parse import urlparse
 
 
 class STSProfile(object):
@@ -12,11 +14,16 @@ def __init__(self, authority_url):
         self.serviceUrl = 'https://login.microsoftonline.com'
         self.securityTokenServicePath = 'extSTS.srf'
         self.userRealmServicePath = 'GetUserRealm.srf'
-        self.federationTokenIssuer = 'urn:federation:MicrosoftOnline'
-        self.created = datetime.datetime.now()
-        self.expires = self.created + datetime.timedelta(minutes=10)
+        self.tokenIssuer = 'urn:federation:MicrosoftOnline'
+        now = datetime.now(tz=timezone.utc)
+        self.created = now.astimezone(timezone.utc).isoformat('T')[:-9] + 'Z'
+        self.expires = (now + timedelta(minutes=10)).astimezone(timezone.utc).isoformat('T')[:-9] + 'Z'
         self.signInPage = '_forms/default.aspx?wa=wsignin1.0'
 
+    @property
+    def tenant(self):
+        return urlparse(self.authorityUrl).netloc
+
     @property
     def security_token_service_url(self):
         return "/".join([self.serviceUrl, self.securityTokenServicePath])

office365/sharepoint/files/file.py

@@ -286,6 +286,31 @@ def download(self, file_object):
         def _download_inner():
             qry = DownloadFileQuery(self.context.web, self.serverRelativeUrl, file_object)
             self.context.add_query(qry)
+
+        self.ensure_property("ServerRelativeUrl", _download_inner)
+        return self
+
+    def download_session(self, file_object, chunk_downloaded=None, chunk_size=1024 * 1024):
+        """
+        :type file_object: typing.IO
+        :type chunk_downloaded: (int)->None or None
+        :type chunk_size: int
+        """
+
+        def _download_inner():
+            request = RequestOptions(
+                r"{0}web/getFileByServerRelativeUrl('{1}')/\$value".format(self.context.service_root_url(),
+                                                                           self.serverRelativeUrl))
+            request.stream = True
+            response = self.context.execute_request_direct(request)
+            response.raise_for_status()
+            bytes_read = 0
+            for chunk in response.iter_content(chunk_size=chunk_size):
+                bytes_read += len(chunk)
+                if callable(chunk_downloaded):
+                    chunk_downloaded(bytes_read)
+                file_object.write(chunk)
+
         self.ensure_property("ServerRelativeUrl", _download_inner)
         return self
 

office365/sharepoint/tenant/administration/secondary_administrators_fields_data.py

@@ -13,13 +13,5 @@ def __init__(self, site_id, emails=None, names=None):
         """
         super().__init__()
         self.secondaryAdministratorEmails = ClientValueCollection(str, emails)
-        self.secondaryAdministratorLoginNames = names
+        self.secondaryAdministratorLoginNames = ClientValueCollection(str, names)
         self.siteId = site_id
-
-    #@property
-    #def entity_type_name(self):
-    #    return "Microsoft.Online.SharePoint.TenantAdministration.SecondaryAdministratorsFieldsData"
-
-
-
-