SharePoint API: ListItem.system_update for document fix

Author: vgrem

examples/sharepoint/listitems/get_deleted.py

@@ -6,9 +6,8 @@
 from tests import test_client_credentials, test_team_site_url
 
 ctx = ClientContext(test_team_site_url).with_credentials(test_client_credentials)
-# result = ctx.web.default_document_library().get_changes(ChangeQuery(list_=False, item=True)).execute_query()
 result = (
     ctx.web.recycle_bin.get().execute_query()
-)  # filter("ItemType eq 1").execute_query()
+)
 for item in result:
     print(item.properties)

examples/sharepoint/listitems/system_update2.py renamed to examples/sharepoint/listitems/system_update_alt.py

@@ -6,9 +6,10 @@
 ctx = ClientContext(test_site_url).with_credentials(test_client_credentials)
 
 target_list = ctx.web.lists.get_by_title("Documents")
-items = target_list.items.get().top(1).execute_query()
+items = target_list.items.get().filter("FSObjType eq 0").top(1).execute_query()
 if len(items) == 0:
     sys.exit("No items were found")
 
 item = items[0]
+item.set_property("Title", "Some title goes here 123..")
 item.system_update().execute_query()

office365/directory/applications/application.py

@@ -231,7 +231,7 @@ def spa(self):
     @property
     def key_credentials(self):
         """The collection of key credentials associated with the application. Not nullable."""
-        self._ser_property_names.append("keyCredentials")
+        self._properties_to_persist.append("keyCredentials")
         return self.properties.setdefault(
             "keyCredentials", ClientValueCollection(KeyCredential)
         )

office365/runtime/client_object.py

@@ -30,7 +30,7 @@ def __init__(self, context, resource_path=None, parent_collection=None):
         # type: (ClientRuntimeContext, Optional[ResourcePath], Optional[ClientObjectCollection]) -> None
         """Base client object which define named properties and relationships of an entity."""
         self._properties = {}
-        self._ser_property_names = []
+        self._properties_to_persist = []
         self._query_options = QueryOptions()
         self._parent_collection = parent_collection
         self._context = context
@@ -43,9 +43,9 @@ def clear_state(self):
         self._properties = {
             k: v
             for k, v in self._properties.items()
-            if k not in self._ser_property_names
+            if k not in self._properties_to_persist
         }
-        self._ser_property_names = []
+        self._properties_to_persist = []
         self._query_options = QueryOptions()
         return self
 
@@ -139,8 +139,8 @@ def _persist_changes(self, name):
         Marks a property as a serializable
         :param str name: A property name
         """
-        if name not in self._ser_property_names:
-            self._ser_property_names.append(name)
+        if name not in self._properties_to_persist:
+            self._properties_to_persist.append(name)
         return self
 
     def get_property(self, name, default_value=None):
@@ -155,7 +155,7 @@ def set_property(self, name, value, persist_changes=True):
         # type: (str|int, P_T, bool) -> Self
         """Sets property value"""
         if persist_changes:
-            self._ser_property_names.append(name)
+            self._properties_to_persist.append(name)
 
         typed_value = self.get_property(name)
         if isinstance(typed_value, (ClientObject, ClientValue)):
@@ -242,6 +242,14 @@ def query_options(self):
     def properties(self):
         return self._properties
 
+    @property
+    def persistable_properties(self):
+        return {
+            k: self.get_property(k)
+            for k in self._properties_to_persist
+            if k in self._properties
+        }
+
     @property
     def parent_collection(self):
         """Parent collection"""
@@ -254,7 +262,7 @@ def to_json(self, json_format=None):
             ser_prop_names = [n for n in self._properties.keys()]
             include_control_info = False
         else:
-            ser_prop_names = [n for n in self._ser_property_names]
+            ser_prop_names = [n for n in self._properties_to_persist]
             include_control_info = (
                 self.entity_type_name is not None
                 and json_format.include_control_information

office365/sharepoint/listitems/listitem.py

@@ -276,7 +276,7 @@ def validate_update_list_item(
         """Validates and sets the values of the specified collection of fields for the list item.
 
         :param dict form_values: Specifies a collection of field internal names and values for the given field
-        :param dict new_document_update: Specifies whether the list item is a document being updated after upload.
+        :param bool new_document_update: Specifies whether the list item is a document being updated after upload.
         :param str checkin_comment: Check-in comment, if any. This parameter is only applicable when the list item
              is checked out.
         :param bool or None dates_in_utc:
@@ -313,8 +313,46 @@ def update(self):
 
     def system_update(self):
         """Update the list item."""
-        qry = ServiceOperationQuery(self, "SystemUpdate")
-        self.context.add_query(qry)
+
+        sys_metadata = ["EditorId", "Modified"]
+
+        def _after_system_update(result):
+            # type: (ClientResult[ClientValueCollection[ListItemFormUpdateValue]]) -> None
+            has_any_error = any([item.HasException for item in result.value])
+            if has_any_error:
+                raise ValueError(
+                    "Update ListItem failed"
+                )
+
+        def _system_update():
+            from office365.sharepoint.fields.user_value import FieldUserValue
+
+            form_values = self.persistable_properties
+            for n in sys_metadata:
+                if n == "Id":
+                    pass
+                elif n.endswith("Id"):
+                    user = self.context.web.site_users.get_by_id(self.get_property(n))
+                    form_values[n[:-2]] = FieldUserValue.from_user(user)
+                else:
+                   form_values[n] = self.get_property(n)
+
+            self.validate_update_list_item(
+                form_values=form_values,
+                dates_in_utc=True,
+                new_document_update=True,
+            ).after_execute(_after_system_update)
+
+
+        def _list_loaded():
+            if self.parent_list.base_template == 101:
+               self.ensure_properties(sys_metadata, _system_update)
+            else:
+                next_qry = ServiceOperationQuery(self, "SystemUpdate")
+                self.context.add_query(next_qry)
+
+        self.parent_list.ensure_properties(["BaseTemplate"], _list_loaded)
+        #self.ensure_properties(sys_metadata, _system_update)
         return self
 
     def update_overwrite_version(self):
@@ -378,7 +416,7 @@ def parent_list(self):
         """Get parent List"""
         from office365.sharepoint.lists.list import List
 
-        return self.properties.get(
+        return self.properties.setdefault(
             "ParentList",
             List(self.context, ResourcePath("ParentList", self.resource_path)),
         )

office365/sharepoint/tenant/administration/insights/summary_response.py

@@ -0,0 +1,8 @@
+from office365.runtime.client_value import ClientValue
+
+
+class InsightsSummaryResponse(ClientValue):
+
+    @property
+    def entity_type_name(self):
+        return "Microsoft.SharePoint.Administration.TenantAdmin.InsightsSummaryResponse"

office365/sharepoint/tenant/administration/tenant.py

@@ -375,6 +375,17 @@ def get_ransomware_activities(self):
         self.context.add_query(qry)
         return return_type
 
+    def get_ransomware_events_overview(self):
+        # type: () -> ClientResult[AnyStr]
+        """ """
+        return_type = ClientResult(self.context)
+        qry = ServiceOperationQuery(
+            self, "GetRansomwareEventsOverview", None, None, None, return_type
+        )
+        self.context.add_query(qry)
+        return return_type
+
+
     def get_sp_list_item_count(self, list_name):
         # type: (str) -> ClientResult[int]
         """ """

tests/sharepoint/test_tenant.py

@@ -209,3 +209,8 @@ def test_29_get_app_service_principal(self):
     def test_30_get_cdn_urls(self):
         result = self.tenant.cdn_api.get_cdn_urls([test_team_site_url]).execute_query()
         self.assertIsNotNone(result.value)
+
+    # You need a SharePoint Advanced Management license to perform this action
+    #def test_31_get_ransomware_events_overview(self):
+    #    result = self.tenant.get_ransomware_events_overview().execute_query()
+    #    self.assertIsNotNone(result.value)

tests/sharepoint/test_web.py

@@ -183,7 +183,11 @@ def test_25_parse_datetime(self):
         self.assertIsNotNone(result.value)
 
     # def test_26_list_acs_service_principals(self):
-    #    result = self.client.web.get_acs_service_principals().execute_query()
+    #    from office365.sharepoint.client_context import ClientContext
+    #    admin_client = ClientContext(test_team_site_url).with_credentials(
+    #        test_admin_credentials
+    #    )
+    #    result = admin_client.web.get_acs_service_principals().execute_query()
     #    self.assertIsNotNone(result.value)
 
     def test_27_ensure_tenant_app_catalog(self):