From 99f99e0bc020f5dde7ee4f2c98a98fc9e83d8343 Mon Sep 17 00:00:00 2001
From: Andrew Zaborowski <andrew.zaborowski@intel.com>
Date: Fri, 10 Jun 2016 11:49:34 +0200
Subject: [PATCH] agent: Add reason parameter to Cancel

Add a parameter the UI can use to show user an explanation of why a
password prompt is disappearing.
---
 src/agent.c   | 40 +++++++++++++++++++++++++++++++++++-----
 src/agent.h   |  2 +-
 src/network.c |  8 ++++----
 src/network.h |  2 +-
 src/wiphy.c   |  6 +++---
 5 files changed, 44 insertions(+), 14 deletions(-)

diff --git a/src/agent.c b/src/agent.c
index 023fe711..d83859db 100644
--- a/src/agent.c
+++ b/src/agent.c
@@ -83,11 +83,41 @@ static void send_request(struct agent *agent, const char *request)
 	l_dbus_send(dbus_get_bus(), message);
 }
 
-static void send_cancel_request(void *user_data)
+static void send_cancel_request(void *user_data, int reason)
 {
 	struct agent *agent = user_data;
+	struct l_dbus_message *message;
+	const char *reasonstr;
 
-	send_request(agent, "Cancel");
+	switch (reason) {
+	case -ECANCELED:
+		reasonstr = "user-canceled";
+		break;
+	case -ETIMEDOUT:
+		reasonstr = "timed-out";
+		break;
+	case -ERANGE:
+		reasonstr = "out-of-range";
+		break;
+	case -ESHUTDOWN:
+		reasonstr = "shutdown";
+		break;
+	default:
+		reasonstr = "unknown";
+	}
+
+	l_debug("send a Cancel(%s) to %s %s", reasonstr,
+			agent->owner, agent->path);
+
+	message = l_dbus_message_new_method_call(dbus_get_bus(),
+						agent->owner,
+						agent->path,
+						IWD_AGENT_INTERFACE,
+						"Cancel");
+
+	l_dbus_message_set_arguments(message, "s", reasonstr);
+
+	l_dbus_send(dbus_get_bus(), message);
 }
 
 static void agent_request_free(void *user_data)
@@ -177,7 +207,7 @@ static void request_timeout(struct l_timeout *timeout, void *user_data)
 
 	l_dbus_cancel(dbus_get_bus(), agent->pending_id);
 
-	send_cancel_request(agent);
+	send_cancel_request(agent, -ETIMEDOUT);
 
 	agent_finalize_pending(agent, NULL);
 
@@ -301,7 +331,7 @@ static bool find_request(const void *a, const void *b)
 	return request->id == id;
 }
 
-bool agent_request_cancel(unsigned int req_id)
+bool agent_request_cancel(unsigned int req_id, int reason)
 {
 	struct agent_request *request;
 
@@ -314,7 +344,7 @@ bool agent_request_cancel(unsigned int req_id)
 		return false;
 
 	if (!request->message)
-		send_cancel_request(default_agent);
+		send_cancel_request(default_agent, reason);
 
 	agent_request_free(request);
 
diff --git a/src/agent.h b/src/agent.h
index fd6aaaf1..09e3fef2 100644
--- a/src/agent.h
+++ b/src/agent.h
@@ -40,4 +40,4 @@ unsigned int agent_request_passphrase(const char *path,
 				agent_request_passphrase_func_t callback,
 				struct l_dbus_message *message,
 				void *user_data);
-bool agent_request_cancel(unsigned int req_id);
+bool agent_request_cancel(unsigned int req_id, int reason);
diff --git a/src/network.c b/src/network.c
index 5e21ad51..a7291f2a 100644
--- a/src/network.c
+++ b/src/network.c
@@ -645,11 +645,11 @@ bool network_register(struct network *network, const char *path)
 	return true;
 }
 
-static void network_unregister(struct network *network)
+static void network_unregister(struct network *network, int reason)
 {
 	struct l_dbus *dbus = dbus_get_bus();
 
-	agent_request_cancel(network->agent_request);
+	agent_request_cancel(network->agent_request, reason);
 	network_settings_close(network);
 
 	l_dbus_unregister_object(dbus, network->object_path);
@@ -658,10 +658,10 @@ static void network_unregister(struct network *network)
 	network->object_path = NULL;
 }
 
-void network_remove(struct network *network)
+void network_remove(struct network *network, int reason)
 {
 	if (network->object_path)
-		network_unregister(network);
+		network_unregister(network, reason);
 
 	l_queue_destroy(network->bss_list, NULL);
 	l_free(network->psk);
diff --git a/src/network.h b/src/network.h
index 8443ba7a..7071324e 100644
--- a/src/network.h
+++ b/src/network.h
@@ -54,7 +54,7 @@ void network_bss_list_clear(struct network *network);
 
 bool network_register(struct network *network, const char *path);
 
-void network_remove(struct network *network);
+void network_remove(struct network *network, int reason);
 
 void network_init();
 void network_exit();
diff --git a/src/wiphy.c b/src/wiphy.c
index aeb87e1e..fe63eac3 100644
--- a/src/wiphy.c
+++ b/src/wiphy.c
@@ -325,7 +325,7 @@ static void network_free(void *data)
 {
 	struct network *network = data;
 
-	network_remove(network);
+	network_remove(network, -ESHUTDOWN);
 }
 
 const char *device_get_path(struct device *device)
@@ -1176,7 +1176,7 @@ static bool network_remove_if_lost(const void *key, void *data, void *user_data)
 
 	l_debug("No remaining BSSs for SSID: %s -- Removing network",
 			network_get_ssid(network));
-	network_remove(network);
+	network_remove(network, -ERANGE);
 
 	return true;
 }
@@ -1253,7 +1253,7 @@ static void process_bss(struct device *device, struct scan_bss *bss)
 						security);
 
 		if (!network_register(network, path)) {
-			network_remove(network);
+			network_remove(network, -EINVAL);
 			return;
 		}