Introduced support for SharePoint 2010 list data service, added methods/properties for Field/List resources

vgrem · vgrem · commit ae30fe8eacf6 · 2019-09-29T01:20:05.000+03:00
diff --git a/.travis.yml b/.travis.yml
@@ -9,7 +9,7 @@ python:
 # optionally set up exclusions and allowed failures in the matrix
 matrix:
   allow_failures:
-      - python: "3.3"
+    - python: "3.3"
 
 # command to run tests
 script: python setup.py test
diff --git a/examples/sharepoint/AppPermissionRequests.xml b/examples/sharepoint/AppPermissionRequests.xml
@@ -0,0 +1,3 @@
+<AppPermissionRequests AllowAppOnlyPolicy="true">
+     <AppPermissionRequest Scope="http://sharepoint/content/sitecollection/web" Right="Read"/>
+</AppPermissionRequests>
diff --git a/examples/sharepoint/file_operations.py b/examples/sharepoint/file_operations.py
@@ -2,8 +2,10 @@
 import os
 
 from office365.runtime.client_request import ClientRequest
+from office365.runtime.utilities.http_method import HttpMethod
 from office365.runtime.utilities.request_options import RequestOptions
 from office365.sharepoint.caml_query import CamlQuery
+from office365.sharepoint.list_data_service import ListDataService
 from settings import settings
 from office365.runtime.auth.authentication_context import AuthenticationContext
 from office365.sharepoint.client_context import ClientContext
@@ -43,27 +45,27 @@ def read_folder_and_files(context, list_title):
         print("Folder name: {0}".format(folder.properties["Name"]))
 
 
-def upload_file_into_library(target_library, name, content):
-    context = target_library.context
+def upload_file_alt(target_folder, name, content):
+    context = target_folder.context
     info = FileCreationInformation()
     info.content = content
     info.url = name
     info.overwrite = True
-    target_file = target_library.root_folder.files.add(info)
+    target_file = target_folder.files.add(info)
     context.execute_query()
     return target_file
 
 
 def upload_file(context):
-    upload_into_library = False
+    upload_into_library = True
     path = "../tests/data/SharePoint User Guide.docx"
     with open(path, 'rb') as content_file:
         file_content = content_file.read()
 
     if upload_into_library:
         list_title = "Documents"
-        library = context.web.lists.get_by_title(list_title)
-        file = upload_file_into_library(library, os.path.basename(path), file_content)
+        target_folder = context.web.lists.get_by_title(list_title).root_folder
+        file = upload_file_alt(target_folder, os.path.basename(path), file_content)
         print("File url: {0}".format(file.properties["ServerRelativeUrl"]))
     else:
         target_url = "/Shared Documents/{0}".format(os.path.basename(path))
@@ -77,7 +79,7 @@ def download_file(context):
 
 
 if __name__ == '__main__':
-    site_url = 'https://mediadev8.sharepoint.com/sites/Team123'
+    site_url = 'https://mediadev8.sharepoint.com/'
 
     ctx_auth = AuthenticationContext(url=site_url)
     if ctx_auth.acquire_token_for_user(username=settings['user_credentials']['username'],
@@ -89,5 +91,54 @@ def download_file(context):
         # read_folder_and_files_alt(ctx, "Documents")
         # upload_file(ctx)
         # download_file(ctx)
+
+        file = ctx.web.get_file_by_server_relative_url("/Shared Documents/SharePoint User Guide.docx")
+        ctx.load(file)
+        ctx.execute_query()
+
+        path = "../data/SharePoint User Guide.docx"
+        # with open(path, 'rb') as content_file:
+        #    file_content = content_file.read()
+        # list_title = "Documents"
+        # target_list = ctx.web.lists.get_by_title(list_title)
+        # file = upload_file_alt(target_list.root_folder, os.path.basename(path), file_content)
+
+        # find out user id
+        user = ctx.web.site_users.get_by_email("vgrem@mediadev8.onmicrosoft.com")
+        ctx.load(user)
+        ctx.execute_query()
+        user_id = user.properties['Id']
+        user_field_value = json.dumps([{'Key': user.properties['LoginName']}])
+
+        # set file metadata
+        list_item = file.listitem_allfields  # get associated listItem
+
+        field_editor = list_item.parent_list.fields.get_by_internal_name_or_title("Modified By")
+        ctx.load(field_editor)
+        ctx.execute_query()
+
+        if field_editor.properties['ReadOnlyField']:
+            field_editor.set_property('ReadOnlyField', False)
+            field_editor.update()
+            ctx.execute_query()
+
+        list_item.set_property("EditorId", user_id)  # update ModifiedBy field value
+        # list_item.set_property("ModifiedById", user_id)  # update ModifiedBy field value
+        # list_item.set_property("Comment", 'some comment goes here212aaa..')
+
+        # field_values = [
+        #    {"FieldName": 'Editor', "FieldValue": user_field_value},
+        # ]
+        # list_item.system_update(field_values, True)
+
+        list_svc = ListDataService(site_url, ctx_auth)
+        #field_values = {"Comment": "Some comment goes here"}
+        field_values = {"ModifiedById": 11}
+
+        # list_item = list_svc.get_list_item("Documents", 4)
+        # list_svc.load(list_item)
+        list_svc.update_list_item("Documents", 4, field_values)
+        list_svc.execute_query()
+        print("Ok")
     else:
         print(ctx_auth.get_last_error())
diff --git a/examples/sharepoint/listitem_operations.py b/examples/sharepoint/listitem_operations.py
@@ -19,7 +19,8 @@ def read_list_items():
 def filter_list_items():
     print("OData query against list items example...")
     list_object = ctx.web.lists.get_by_title(listTitle)
-    items = list_object.get_items().top(1).select("Id,Title")
+    # items = list_object.get_items().top(1).select("Id,Title")
+    items = list_object.get_items().select("Id,Title").filter("AssignedTo ne null")
     ctx.load(items)
     ctx.execute_query()
 
@@ -38,11 +39,11 @@ def create_list_item():
 
 if __name__ == '__main__':
     ctxAuth = AuthenticationContext(url=settings['url'])
-    if ctxAuth.acquire_token_for_user(username=settings['username'], password=settings['password']):
+    if ctxAuth.acquire_token_for_user(username=settings['user_credentials']['username'], password=settings['user_credentials']['password']):
         ctx = ClientContext(settings['url'], ctxAuth)
 
-        read_list_items()
-        create_list_item()
+        # read_list_items()
+        # create_list_item()
         filter_list_items()
 
     else:
diff --git a/examples/sharepoint/sharepoint_app_token_auth.py b/examples/sharepoint/sharepoint_app_token_auth.py
@@ -0,0 +1,20 @@
+from office365.runtime.auth.authentication_context import AuthenticationContext
+from office365.sharepoint.client_context import ClientContext
+from settings import settings
+
+url = 'https://mediadev8.sharepoint.com/NewsArchive'
+settings['client_credentials']['client_id'] = '82e32e70-f031-4978-9fcd-1233db95990f'
+settings['client_credentials']['client_secret'] = '6rpUpc7O3M8loDFKE5H4auunS2geYL4Vs/pXUdjDSU0='
+
+if __name__ == '__main__':
+    context_auth = AuthenticationContext(url=url)
+    if context_auth.acquire_token_for_app(client_id=settings['client_credentials']['client_id'],
+                                          client_secret=settings['client_credentials']['client_secret']):
+        ctx = ClientContext(url, context_auth)
+        web = ctx.web
+        ctx.load(web)
+        ctx.execute_query()
+        print("Web title: {0}".format(web.properties['Title']))
+
+    else:
+        print(context_auth.get_last_error())
diff --git a/examples/sharepoint/sharepoint_client_flow_auth.py b/examples/sharepoint/sharepoint_client_flow_auth.py
diff --git a/office365/sharepoint/field.py b/office365/sharepoint/field.py
@@ -1,5 +1,17 @@
 from office365.runtime.client_object import ClientObject
+from office365.runtime.client_query import ClientQuery
 
 
 class Field(ClientObject):
     """Represents a field in a SharePoint Web site"""
+
+    def update(self):
+        """Update the field."""
+        qry = ClientQuery.update_entry_query(self)
+        self.context.add_query(qry)
+
+    def delete_object(self):
+        """Deletes the field."""
+        qry = ClientQuery.delete_entry_query(self)
+        self.context.add_query(qry)
+        self.remove_from_parent_collection()
diff --git a/office365/sharepoint/field_collection.py b/office365/sharepoint/field_collection.py
@@ -0,0 +1,35 @@
+from office365.runtime.client_object_collection import ClientObjectCollection
+from office365.runtime.client_query import ClientQuery
+from office365.runtime.resource_path_service_operation import ResourcePathServiceOperation
+from office365.sharepoint.field import Field
+
+
+class FieldCollection(ClientObjectCollection):
+    """Represents a collection of Field resource."""
+
+    def __init__(self, context, resource_path=None):
+        super(FieldCollection, self).__init__(context, Field, resource_path)
+
+    def add(self, field_creation_information):
+        """Adds a field to the field collection."""
+        field = Field(self.context)
+        qry = ClientQuery.create_entry_query(self, field_creation_information)
+        self.context.add_query(qry, field)
+        self.add_child(field)
+        return field
+
+    def get_by_id(self, _id):
+        """Gets the field with the specified ID."""
+        return Field(self.context, ResourcePathServiceOperation(self.context, self.resource_path, "getById", [_id]))
+
+    def get_by_internal_name_or_title(self, name_title):
+        """Returns the first Field object with the specified internal name or title from the collection."""
+        return Field(self.context,
+                     ResourcePathServiceOperation(self.context,
+                                                  self.resource_path,
+                                                  "getByInternalNameOrTitle", [name_title]))
+
+    def get_by_title(self, title):
+        """Returns the first field object in the collection based on the title of the specified field."""
+        return Field(self.context,
+                     ResourcePathServiceOperation(self.context, self.resource_path, "getByTitle", [title]))
diff --git a/office365/sharepoint/field_creation_information.py b/office365/sharepoint/field_creation_information.py
@@ -0,0 +1,5 @@
+from office365.runtime.client_value_object import ClientValueObject
+
+
+class FieldCreationInformation(ClientValueObject):
+    """Represents metadata about field creation."""
diff --git a/office365/sharepoint/list.py b/office365/sharepoint/list.py
@@ -3,6 +3,7 @@
 from office365.runtime.resource_path_entity import ResourcePathEntity
 from office365.runtime.resource_path_service_operation import ResourcePathServiceOperation
 from office365.sharepoint.content_type_collection import ContentTypeCollection
+from office365.sharepoint.field_collection import FieldCollection
 from office365.sharepoint.folder import Folder
 from office365.sharepoint.listitem import ListItem
 from office365.sharepoint.listItem_collection import ListItemCollection
@@ -63,6 +64,14 @@ def root_folder(self):
         else:
             return Folder(self.context, ResourcePathEntity(self.context, self.resource_path, "RootFolder"))
 
+    @property
+    def fields(self):
+        """Gets a value that specifies the collection of all fields in the list."""
+        if self.is_property_available('Fields'):
+            return self.properties['Fields']
+        else:
+            return FieldCollection(self.context, ResourcePathEntity(self.context, self.resource_path, "Fields"))
+
     @property
     def views(self):
         """Gets a value that specifies the collection of all public views on the list and personal views
diff --git a/office365/sharepoint/list_data_service.py b/office365/sharepoint/list_data_service.py
@@ -0,0 +1,36 @@
+from office365.runtime.action_type import ActionType
+from office365.runtime.client_query import ClientQuery
+from office365.runtime.client_runtime_context import ClientRuntimeContext
+from office365.runtime.odata.json_light_format import JsonLightFormat
+from office365.runtime.odata.odata_metadata_level import ODataMetadataLevel
+from office365.runtime.resource_path_service_operation import ResourcePathServiceOperation
+from office365.sharepoint.listitem import ListItem
+
+
+class ListDataService(ClientRuntimeContext):
+    """SharePoint 2010 list data service"""
+
+    def __init__(self, base_url, auth_context):
+        if base_url.endswith("/"):
+            base_url = base_url[:len(base_url) - 1]
+        super(ListDataService, self).__init__(base_url + "/_vti_bin/listdata.svc/", auth_context)
+        self.json_format = JsonLightFormat(ODataMetadataLevel.Verbose)
+
+    def get_list_item(self, list_name, item_id):
+        return ListItem(self,
+                        ResourcePathServiceOperation(self, None, list_name, [item_id]))
+
+    def delete_list_item(self, list_name, item_id):
+        resource_url = self.service_root_url + list_name + "(" + str(item_id) + ")"
+        qry = ClientQuery(resource_url, ActionType.DeleteEntity)
+        self.add_query(qry)
+
+    def update_list_item(self, list_name, item_id, field_values):
+        resource_url = self.service_root_url + list_name + "(" + str(item_id) + ")"
+        qry = ClientQuery(resource_url, ActionType.UpdateEntity, field_values)
+        self.add_query(qry)
+
+
+
+
+
diff --git a/office365/sharepoint/listitem.py b/office365/sharepoint/listitem.py
@@ -1,22 +1,58 @@
+from office365.runtime.action_type import ActionType
 from office365.runtime.client_query import ClientQuery
 from office365.runtime.odata.odata_path_parser import ODataPathParser
 from office365.runtime.resource_path_entity import ResourcePathEntity
 from office365.sharepoint.securable_object import SecurableObject
 
 
 class ListItem(SecurableObject):
-    """ListItem client object resource"""
+    """ListItem resource"""
 
     def update(self):
-        """Update the list."""
+        """Update the list item."""
         qry = ClientQuery.update_entry_query(self)
         self.context.add_query(qry)
 
+    def validate_update_listItem(self, form_values, new_document_update):
+        """Validates and sets the values of the specified collection of fields for the list item."""
+        qry = ClientQuery.service_operation_query(self,
+                                                  ActionType.PostMethod,
+                                                  "validateUpdateListItem",
+                                                  None,
+                                                  {
+                                                      "formValues": form_values,
+                                                      "bNewDocumentUpdate": new_document_update,
+                                                  })
+        self.context.add_query(qry)
+
+    def system_update(self):
+        """Update the list item."""
+        qry = ClientQuery.service_operation_query(self,
+                                                  ActionType.PostMethod,
+                                                  "systemUpdate")
+        self.context.add_query(qry)
+
+    def update_overwrite_version(self):
+        """Update the list item."""
+        qry = ClientQuery.service_operation_query(self,
+                                                  ActionType.PostMethod,
+                                                  "updateOverwriteVersion")
+        self.context.add_query(qry)
+
     def delete_object(self):
         """Deletes the list."""
         qry = ClientQuery.delete_entry_query(self)
         self.context.add_query(qry)
 
+    @property
+    def parent_list(self):
+        """Get parent List"""
+        if self.is_property_available("ParentList"):
+            return self.properties["ParentList"]
+        else:
+            from office365.sharepoint.list import List
+            return List(self.context, ResourcePathEntity(self.context, self.resource_path, "ParentList"))
+
     @property
     def file(self):
         """Get file"""
diff --git a/office365/sharepoint/publishing/client_side_page.py b/office365/sharepoint/publishing/client_side_page.py
@@ -0,0 +1,11 @@
+from office365.runtime.client_object import ClientObject
+
+
+class ClientSidePage(ClientObject):
+    """Represents the data and methods associated with client side "modern" pages"""
+
+    @staticmethod
+    def from_file(file):
+        return None
+
+
diff --git a/setup.py b/setup.py

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+<AppPermissionRequests AllowAppOnlyPolicy="true">`
	`2`	`+ <AppPermissionRequest Scope="http://sharepoint/content/sitecollection/web" Right="Read"/>`
	`3`	`+</AppPermissionRequests>`