[gupnp/wip/phako/new-api] wip: Implement action cancelling with GCancellable

[Jens Georg <jensgeorg src gnome org>]

commit d49e0184c96b1f7f3f7ecc50fdfbf3ee77ccc1d2
Author: Jens Georg <mail jensge org>
Date:   Sun Jan 13 17:41:50 2019 +0100

    wip: Implement action cancelling with GCancellable

 libgupnp/gupnp-service-proxy-action-private.h |  3 ++
 libgupnp/gupnp-service-proxy-action.c         |  6 ++-
 libgupnp/gupnp-service-proxy.c                | 73 ++++++++++++++++++++-------
 3 files changed, 63 insertions(+), 19 deletions(-)
---
diff --git a/libgupnp/gupnp-service-proxy-action-private.h b/libgupnp/gupnp-service-proxy-action-private.h
index 1dd8b03..31927a4 100644
--- a/libgupnp/gupnp-service-proxy-action-private.h
+++ b/libgupnp/gupnp-service-proxy-action-private.h
@@ -153,6 +153,9 @@ struct _GUPnPServiceProxyAction {
         SoupMessage *msg;
         GString *msg_str;
 
+        GCancellable *cancellable;
+        gulong cancellable_connection_id;
+
         GUPnPServiceProxyActionCallback callback;
         gpointer user_data;
 
diff --git a/libgupnp/gupnp-service-proxy-action.c b/libgupnp/gupnp-service-proxy-action.c
index 4cfb094..31e15a6 100644
--- a/libgupnp/gupnp-service-proxy-action.c
+++ b/libgupnp/gupnp-service-proxy-action.c
@@ -209,13 +209,17 @@ gupnp_service_proxy_action_ref (GUPnPServiceProxyAction *action)
 static void
 action_dispose (GUPnPServiceProxyAction *action)
 {
-        g_debug ("=> action_dispose");
         if (action->proxy != NULL) {
                 g_object_remove_weak_pointer (G_OBJECT (action->proxy),
                                 (gpointer *)&(action->proxy));
                 gupnp_service_proxy_remove_action (action->proxy, action);
         }
 
+        if (action->cancellable != NULL && action->cancellable_connection_id != 0) {
+                g_cancellable_disconnect (action->cancellable,
+                                          action->cancellable_connection_id);
+        }
+        g_clear_object (&action->cancellable);
         g_clear_error (&action->error);
         g_clear_object (&action->msg);
         g_free (action->name);
diff --git a/libgupnp/gupnp-service-proxy.c b/libgupnp/gupnp-service-proxy.c
index 6636e54..6db9a50 100644
--- a/libgupnp/gupnp-service-proxy.c
+++ b/libgupnp/gupnp-service-proxy.c
@@ -265,7 +265,7 @@ gupnp_service_proxy_dispose (GObject *object)
                         g_list_delete_link (priv->pending_actions,
                                             priv->pending_actions);
 
-                gupnp_service_proxy_cancel_action (proxy, action);
+                g_cancellable_cancel (action->cancellable);
         }
 
         /* Cancel pending messages */
@@ -608,10 +608,33 @@ gupnp_service_proxy_begin_action (GUPnPServiceProxy              *proxy,
                                                       ret);
 }
 
+static void
+on_action_cancelled (GCancellable *cancellable, gpointer user_data)
+{
+        GUPnPServiceProxyAction *action = (GUPnPServiceProxyAction *) user_data;
+
+        GUPnPContext *context;
+        SoupSession *session;
+
+        if (action->msg != NULL) {
+                context = gupnp_service_info_get_context
+                                        (GUPNP_SERVICE_INFO (action->proxy));
+                session = gupnp_context_get_session (context);
+
+                soup_session_cancel_message (session,
+                                             action->msg,
+                                             SOUP_STATUS_CANCELLED);
+                g_cancellable_disconnect (action->cancellable,
+                                          action->cancellable_connection_id);
+                action->cancellable_connection_id = 0;
+        }
+}
+
 /* Begins a basic action message */
 static void
 prepare_action_msg (GUPnPServiceProxy              *proxy,
-                    GUPnPServiceProxyAction        *ret)
+                    GUPnPServiceProxyAction        *ret,
+                    GCancellable                   *cancellable)
 {
         GUPnPServiceProxyPrivate *priv;
         char *control_url, *full_action;
@@ -624,6 +647,16 @@ prepare_action_msg (GUPnPServiceProxy              *proxy,
 
         priv->pending_actions = g_list_prepend (priv->pending_actions, ret);
 
+        if (cancellable != NULL) {
+                ret->cancellable = g_object_ref (cancellable);
+        } else {
+                ret->cancellable = g_cancellable_new ();
+        }
+        ret->cancellable_connection_id = g_cancellable_connect (ret->cancellable,
+                                                                G_CALLBACK (on_action_cancelled),
+                                                                ret,
+                                                                NULL);
+
         /* Make sure we have a service type */
         service_type = gupnp_service_info_get_service_type
                                         (GUPNP_SERVICE_INFO (proxy));
@@ -725,9 +758,16 @@ action_task_got_response (SoupSession *session,
                           gpointer    user_data)
 {
         GTask *task = G_TASK (user_data);
+        GUPnPServiceProxyAction *action = (GUPnPServiceProxyAction *) g_task_get_task_data (task);
 
         switch (msg->status_code) {
         case SOUP_STATUS_CANCELLED:
+                if (action->cancellable != NULL && action->cancellable_connection_id != 0) {
+                        g_cancellable_disconnect (action->cancellable,
+                                        action->cancellable_connection_id);
+                        action->cancellable_connection_id = 0;
+                }
+
                 g_task_return_new_error (task,
                                          G_IO_ERROR,
                                          G_IO_ERROR_CANCELLED,
@@ -743,6 +783,12 @@ action_task_got_response (SoupSession *session,
                 break;
 
         default:
+                if (action->cancellable != NULL && action->cancellable_connection_id != 0) {
+                        g_cancellable_disconnect (action->cancellable,
+                                        action->cancellable_connection_id);
+                        action->cancellable_connection_id = 0;
+                }
+
                 g_task_return_pointer (task,
                                        g_task_get_task_data (task),
                                        (GDestroyNotify) gupnp_service_proxy_action_unref);
@@ -1087,31 +1133,22 @@ gupnp_service_proxy_end_action_hash
  * @action: A #GUPnPServiceProxyAction handle
  *
  * Cancels @action, freeing the @action handle.
+ *
+ * Deprecated: 1.1.2: Use the #GCancellable passed to
+ * gupnp_service_proxy_call_action_async() or gupnp_service_proxy_call_action()
  **/
 void
 gupnp_service_proxy_cancel_action (GUPnPServiceProxy       *proxy,
                                    GUPnPServiceProxyAction *action)
 {
-        GUPnPContext *context;
-        SoupSession *session;
-
         g_return_if_fail (GUPNP_IS_SERVICE_PROXY (proxy));
         g_return_if_fail (action);
         g_return_if_fail (proxy == action->proxy);
 
-        if (action->msg != NULL) {
-                context = gupnp_service_info_get_context
-                                        (GUPNP_SERVICE_INFO (proxy));
-                session = gupnp_context_get_session (context);
-
-                soup_session_cancel_message (session,
-                                             action->msg,
-                                             SOUP_STATUS_CANCELLED);
+        if (action->cancellable != NULL) {
+                g_cancellable_cancel (action->cancellable);
         }
 
-        if (action->error != NULL)
-                g_error_free (action->error);
-
         gupnp_service_proxy_action_unref (action);
 }
 
@@ -2076,7 +2113,7 @@ gupnp_service_proxy_call_action_async (GUPnPServiceProxy       *proxy,
                               gupnp_service_proxy_action_ref (action),
                               (GDestroyNotify) gupnp_service_proxy_action_unref);
 
-        prepare_action_msg (proxy, action);
+        prepare_action_msg (proxy, action, cancellable);
 
         if (action->error != NULL) {
                 g_task_return_error (task, g_error_copy (action->error));
@@ -2114,7 +2151,7 @@ gupnp_service_proxy_call_action (GUPnPServiceProxy       *proxy,
 
         g_return_val_if_fail (GUPNP_IS_SERVICE_PROXY (proxy), NULL);
 
-        prepare_action_msg (proxy, action);
+        prepare_action_msg (proxy, action, cancellable);
 
         if (action->error != NULL) {
                 g_propagate_error (error, g_error_copy (action->error));