core: add dynamic password infrastructure

Some media sources (e.g., DAAP) support notifying a client that
a password is required at connection time. Since such sources
are commonly detected with protocols like DNS-SD, Grilo needs a
mechanism to support handling such password requests.

This work adds a new "grl_source_notify_authenticate" function which a
plugin can call when a password is needed. The function, in turn, emits an
"authenticate" signal which the application should respond to by obtaining
a password. The application then provides the password back to the plugin
by calling the new "grl_daap_source_continue_with_password" function.

Signed-off-by: W. Michael Petullo <[email protected]>

Author: flyn-org

src/grl-marshal.list

@@ -1 +1,2 @@
 VOID:BOXED,ENUM,BOOLEAN
+VOID:POINTER

src/grl-source.c

@@ -74,6 +74,7 @@ enum {
 
 enum {
   SIG_CONTENT_CHANGED,
+  SIG_AUTHENTICATE,
   SIG_LAST
 };
 
@@ -513,6 +514,26 @@ grl_source_class_init (GrlSourceClass *source_class)
                  GRL_TYPE_SOURCE_CHANGE_TYPE,
                  G_TYPE_BOOLEAN);
 
+  /**
+   * GrlSource::authenticate:
+   * @source: source that requires authentication to continue.
+   *
+   * Signals that the source requires authentication to continue.
+   *
+   * Since: 0.3.5
+   */
+  source_signals[SIG_AUTHENTICATE] =
+    g_signal_new("authenticate",
+                 G_TYPE_FROM_CLASS (gobject_class),
+                 G_SIGNAL_RUN_FIRST | G_SIGNAL_ACTION,
+                 0,
+                 NULL,
+                 NULL,
+                 grl_marshal_VOID__POINTER,
+                 G_TYPE_NONE,
+                 1,
+                 G_TYPE_POINTER);
+
   g_type_class_add_private (source_class,
                             sizeof (GrlSourcePrivate));
 }
@@ -3984,6 +4005,27 @@ grl_source_search_sync (GrlSource *source,
   return result;
 }
 
+/**
+ * grl_source_continue_with_password:
+ * @source: a source
+ * @opaque: opaque data from the plugin which bears the information necessary
+ * for the plugin to continue the browse or search operation once the password
+ * is known
+ * @password: the password needed to complete browse or search operation
+ *
+ * Complete a browse or search operation by providing the plugin the needed
+ * password.
+ *
+ * Since: 0.3.5
+ */
+void
+grl_source_continue_with_password (GrlSource *source,
+                                   gpointer opaque,
+                                   gchar *password)
+{
+  GRL_SOURCE_GET_CLASS (source)->continue_with_password (source, opaque, password);
+}
+
 /**
  * grl_source_query:
  * @source: a source
@@ -4579,6 +4621,36 @@ void grl_source_notify_change_list (GrlSource *source,
   g_ptr_array_unref (changed_medias);
 }
 
+/**
+ * grl_source_notify_authenticate:
+ * @source: a source
+ * @opaque: opaque data from the plugin which bears the information necessary
+ * for the plugin to continue the browse or search operation once the password
+ * is known
+ *
+ * Complete a browse or search operation by providing the plugin the requisite
+ * password.
+ *
+ * Emits "authenticate" signal to notify subscribers that authentication is
+ * needed for @source to proceed.
+ *
+ * See GrlSource::authenticate signal.
+ *
+ * <note>
+ *  <para>
+ *    This function is intended to be used only by plugins.
+ *  </para>
+ * </note>
+ *
+ * Since: 0.3.5
+ */
+void grl_source_notify_authenticate (GrlSource *source, gpointer opaque)
+{
+  g_return_if_fail (GRL_IS_SOURCE (source));
+
+  g_signal_emit (source, source_signals[SIG_AUTHENTICATE], 0, opaque);
+}
+
 /**
  * grl_source_notify_change:
  * @source: a source

src/grl-source.h

@@ -413,6 +413,7 @@ typedef struct _GrlSourceClass GrlSourceClass;
  * exposed by a certain URI.
  * @browse: browse through a list of media
  * @search: search for media
+ * @continue_with_password: continue search or browse with password
  * @query: query for a specific media
  * @remove: remove a media from a container
  * @store: store a media in a container
@@ -454,6 +455,10 @@ struct _GrlSourceClass {
 
   void (*search) (GrlSource *source, GrlSourceSearchSpec *ss);
 
+  void (*continue_with_password) (GrlSource *source,
+                                  gpointer opaque,
+                                  gchar *password);
+
   void (*query) (GrlSource *source, GrlSourceQuerySpec *qs);
 
   void (*remove) (GrlSource *source, GrlSourceRemoveSpec *rs);
@@ -555,6 +560,10 @@ GList *grl_source_search_sync (GrlSource *source,
                                GrlOperationOptions *options,
                                GError **error);
 
+void grl_source_continue_with_password (GrlSource *source,
+                                        gpointer opaque,
+                                        gchar *password);
+
 guint grl_source_query (GrlSource *source,
                         const gchar *query,
                         const GList *keys,
@@ -619,6 +628,8 @@ void grl_source_notify_change (GrlSource *source,
                                GrlSourceChangeType change_type,
                                gboolean location_unknown);
 
+void grl_source_notify_authenticate (GrlSource *source, gpointer opaque);
+
 const gchar *grl_source_get_id (GrlSource *source);
 
 const gchar *grl_source_get_name (GrlSource *source);

tools/grilo-test-ui/main.c

@@ -1398,6 +1398,27 @@ query_btn_clicked_cb (GtkButton *btn, gpointer user_data)
   }
 }
 
+typedef struct {
+  GrlSource *source;
+  GtkWindow *window;
+  GtkEntry *entry;
+  gpointer opaque;
+} AuthCbArgs;
+
+static void
+auth_btn_clicked_cb (GtkButton *btn, gpointer user_data)
+{
+  gchar *password;
+  AuthCbArgs *args = user_data;
+
+  password = g_strdup(gtk_entry_get_text (args->entry));
+  gtk_widget_destroy (args->window);
+  grl_source_continue_with_password (args->source, args->opaque, password);
+
+  g_free(password);
+  g_free(args);
+}
+
 static void
 query_combo_setup (void)
 {
@@ -2249,6 +2270,41 @@ metadata_key_added_cb (GrlRegistry *registry,
   g_free (message);
 }
 
+static void
+authenticate_cb (GrlSource *source, gpointer opaque, gpointer user_data)
+{
+  GtkWidget *window;
+  GtkWidget *vbox;
+  GtkWidget *entry;
+  GtkWidget *button;
+  AuthCbArgs *args;
+
+  window = gtk_window_new (GTK_WINDOW_TOPLEVEL);
+  gtk_window_set_title (GTK_WINDOW (view->window), "Enter password");
+  gtk_window_resize (GTK_WINDOW (view->window), 200, 100);
+
+  vbox = gtk_vbox_new (FALSE, 0);
+  gtk_container_add (GTK_CONTAINER (window), vbox);
+
+  entry = gtk_entry_new ();
+  gtk_entry_set_max_length (GTK_ENTRY (entry), 50);
+  gtk_box_pack_start (GTK_BOX (vbox), entry, TRUE, TRUE, 0);
+
+  button = gtk_button_new_from_stock (GTK_STOCK_OK);
+  args = g_new(AuthCbArgs, 1);
+  args->source = source;
+  args->window = window;
+  args->entry  = entry;
+  args->opaque = opaque;
+  g_signal_connect (button, "clicked", G_CALLBACK (auth_btn_clicked_cb), args);
+  gtk_box_pack_start (GTK_BOX (vbox), button, TRUE, TRUE, 0);
+
+  gtk_widget_show (button);
+  gtk_widget_show (entry);
+  gtk_widget_show (vbox);
+  gtk_widget_show (window);
+}
+
 static void
 source_added_cb (GrlRegistry *registry,
                  GrlSource *source,
@@ -2269,6 +2325,9 @@ source_added_cb (GrlRegistry *registry,
   search_combo_setup ();
   query_combo_setup ();
 
+  /* Handle authentication requests. */
+  g_signal_connect (GRL_SOURCE (source), "authenticate", G_CALLBACK (authenticate_cb), NULL);
+
   /* Check for changes in source (if supported) */
   if (ui_state->changes_notification &&
       (grl_source_supported_operations (source) &