From f1118b5b64ac99db9d71da1800de0c298b60e0dd Mon Sep 17 00:00:00 2001
From: Yaroslav Chvanov <yaroslav.chvanov@gmail.com>
Date: Sun, 5 Mar 2023 13:28:11 +0300
Subject: [PATCH] ratbagd: add `IsDirty` property to profiles

---
 doc/dbus.rst              | 11 ++++++++++
 ratbagd/ratbagd-device.c  |  5 +++++
 ratbagd/ratbagd-profile.c | 46 +++++++++++++++++++++++++++++++++++++--
 ratbagd/ratbagd.h         |  3 +++
 4 files changed, 63 insertions(+), 2 deletions(-)

diff --git a/doc/dbus.rst b/doc/dbus.rst
index 434a103a..a9616262 100644
--- a/doc/dbus.rst
+++ b/doc/dbus.rst
@@ -237,6 +237,17 @@ org.freedesktop.ratbag1.Profile
         profile must be active at all times. This property is read-only, use the
         :func:`SetActive` method to activate a profile.
 
+.. attribute:: IsDirty
+
+        :type: b
+        :flags: read-only, mutable
+
+        True if this profile is dirty, false otherwise.
+
+        Dirty, that is, the device needs committing after being configured.
+        This property becomes `true` whenever any other property of the
+        profile is updated.
+
 .. attribute:: Resolutions
 
         :type: ao
diff --git a/ratbagd/ratbagd-device.c b/ratbagd/ratbagd-device.c
index d2e38626..e92adc17 100644
--- a/ratbagd/ratbagd-device.c
+++ b/ratbagd/ratbagd-device.c
@@ -198,6 +198,11 @@ static void ratbagd_device_commit_pending(void *data)
 		log_error("error committing device (%d)\n", r);
 	if (r < 0)
 		ratbagd_device_resync(device, device->ctx->bus);
+
+	ratbagd_for_each_profile_signal(device->ctx->bus,
+					device,
+					ratbagd_profile_notify_dirty);
+
 	ratbagd_device_unref(device);
 }
 
diff --git a/ratbagd/ratbagd-profile.c b/ratbagd/ratbagd-profile.c
index c468acf5..5d081ae3 100644
--- a/ratbagd/ratbagd-profile.c
+++ b/ratbagd/ratbagd-profile.c
@@ -198,6 +198,23 @@ static int ratbagd_profile_is_active(sd_bus *bus,
 	return 0;
 }
 
+static int ratbagd_profile_is_dirty(sd_bus *bus,
+				    const char *path,
+				    const char *interface,
+				    const char *property,
+				    sd_bus_message *reply,
+				    void *userdata,
+				    sd_bus_error *error)
+{
+	const struct ratbagd_profile *profile = userdata;
+
+	const int is_dirty = ratbag_profile_is_dirty(profile->lib_profile);
+
+	CHECK_CALL(sd_bus_message_append(reply, "b", is_dirty));
+
+	return 0;
+}
+
 static int ratbagd_profile_find_button(sd_bus *bus,
 				       const char *path,
 				       const char *interface,
@@ -278,6 +295,7 @@ static int ratbagd_profile_set_active(sd_bus_message *m,
 				      void *userdata,
 				      sd_bus_error *error)
 {
+	sd_bus *bus = sd_bus_message_get_bus(m);
 	struct ratbagd_profile *profile = userdata;
 	int r;
 
@@ -285,16 +303,17 @@ static int ratbagd_profile_set_active(sd_bus_message *m,
 
 	r = ratbag_profile_set_active(profile->lib_profile);
 	if (r < 0) {
-		sd_bus *bus = sd_bus_message_get_bus(m);
 		r = ratbagd_device_resync(profile->device, bus);
 		if (r < 0)
 			return r;
 	}
 
-	ratbagd_for_each_profile_signal(sd_bus_message_get_bus(m),
+	ratbagd_for_each_profile_signal(bus,
 					profile->device,
 					ratbagd_profile_active_signal_cb);
 
+	ratbagd_profile_notify_dirty(bus, profile);
+
 	CHECK_CALL(sd_bus_reply_method_return(m, "u", 0));
 
 	return 0;
@@ -322,6 +341,8 @@ ratbagd_profile_set_disabled(sd_bus *bus,
 					       RATBAGD_NAME_ROOT ".Profile",
 					       "Disabled",
 					       NULL);
+
+		ratbagd_profile_notify_dirty(bus, profile);
 	}
 
 	return 0;
@@ -367,6 +388,8 @@ ratbagd_profile_set_name(sd_bus *bus,
 					       RATBAGD_NAME_ROOT ".Profile",
 					       "Name",
 					       NULL);
+
+		ratbagd_profile_notify_dirty(bus, profile);
 	}
 
 	return 0;
@@ -581,6 +604,8 @@ ratbagd_profile_set_report_rate(sd_bus *bus,
 					       RATBAGD_NAME_ROOT ".Profile",
 					       "ReportRate",
 					       NULL);
+
+		ratbagd_profile_notify_dirty(bus, profile);
 	}
 
 	return 0;
@@ -611,6 +636,8 @@ ratbagd_profile_set_angle_snapping(sd_bus *bus,
 					       RATBAGD_NAME_ROOT ".Profile",
 					       "AngleSnapping",
 					       NULL);
+
+		ratbagd_profile_notify_dirty(bus, profile);
 	}
 
 	return 0;
@@ -641,6 +668,8 @@ ratbagd_profile_set_debounce(sd_bus *bus,
 					       RATBAGD_NAME_ROOT ".Profile",
 					       "Debounce",
 					       NULL);
+
+		ratbagd_profile_notify_dirty(bus, profile);
 	}
 
 	return 0;
@@ -662,6 +691,7 @@ const sd_bus_vtable ratbagd_profile_vtable[] = {
 	SD_BUS_PROPERTY("Buttons", "ao", ratbagd_profile_get_buttons, 0, 0),
 	SD_BUS_PROPERTY("Leds", "ao", ratbagd_profile_get_leds, 0, 0),
 	SD_BUS_PROPERTY("IsActive", "b", ratbagd_profile_is_active, 0, SD_BUS_VTABLE_PROPERTY_EMITS_CHANGE),
+	SD_BUS_PROPERTY("IsDirty", "b", ratbagd_profile_is_dirty, 0, SD_BUS_VTABLE_PROPERTY_EMITS_CHANGE),
 	SD_BUS_WRITABLE_PROPERTY("ReportRate", "u",
 				 ratbagd_profile_get_report_rate,
 				 ratbagd_profile_set_report_rate, 0,
@@ -1073,3 +1103,15 @@ int ratbagd_profile_resync(sd_bus *bus,
 					      "IsActive",
 					      NULL);
 }
+
+int ratbagd_profile_notify_dirty(sd_bus *bus,
+				 struct ratbagd_profile *profile)
+{
+	(void)sd_bus_emit_properties_changed(bus,
+					     profile->path,
+					     RATBAGD_NAME_ROOT ".Profile",
+					     "IsDirty",
+					     NULL);
+
+	return 0;
+}
diff --git a/ratbagd/ratbagd.h b/ratbagd/ratbagd.h
index 17bfa5cb..559af912 100644
--- a/ratbagd/ratbagd.h
+++ b/ratbagd/ratbagd.h
@@ -238,3 +238,6 @@ typedef void (*ratbagd_callback_t)(void *userdata);
 void ratbagd_schedule_task(struct ratbagd *ctx,
 			   ratbagd_callback_t callback,
 			   void *userdata);
+
+int ratbagd_profile_notify_dirty(sd_bus *bus,
+				 struct ratbagd_profile *profile);