ESourceRegistry: Do not mandate builtin sources.
[platform/upstream/evolution-data-server.git] / libedataserver / e-source-registry.c
index 5664135..5d2c553 100644 (file)
 #define E_SETTINGS_DEFAULT_MEMO_LIST_KEY       "default-memo-list"
 #define E_SETTINGS_DEFAULT_TASK_LIST_KEY       "default-task-list"
 
-/* This forces the GType to be registered in a way that
- * avoids a "statement with no effect" compiler warning.
- * FIXME Use g_type_ensure() once we require GLib 2.34. */
-#define REGISTER_TYPE(type) \
-       (g_type_class_unref (g_type_class_ref (type)))
-
 typedef struct _AsyncContext AsyncContext;
 typedef struct _AuthContext AuthContext;
+typedef struct _CreateContext CreateContext;
 typedef struct _SourceClosure SourceClosure;
 typedef struct _ThreadClosure ThreadClosure;
 
@@ -108,10 +103,10 @@ struct _ESourceRegistryPrivate {
        EDBusSourceManager *dbus_source_manager;
 
        GHashTable *object_path_table;
-       GMutex *object_path_table_lock;
+       GMutex object_path_table_lock;
 
        GHashTable *sources;
-       GMutex *sources_lock;
+       GMutex sources_lock;
 
        GSettings *settings;
 };
@@ -135,6 +130,13 @@ struct _AuthContext {
        GError **error;
 };
 
+/* Used in e_source_registry_create_sources_sync() */
+struct _CreateContext {
+       GHashTable *pending_uids;
+       GMainContext *main_context;
+       GMainLoop *main_loop;
+};
+
 struct _SourceClosure {
        ESourceRegistry *registry;
        ESource *source;
@@ -144,8 +146,8 @@ struct _ThreadClosure {
        ESourceRegistry *registry;
        GMainContext *main_context;
        GMainLoop *main_loop;
-       GCond *main_loop_cond;
-       GMutex *main_loop_mutex;
+       GCond main_loop_cond;
+       GMutex main_loop_mutex;
        GError *error;
 };
 
@@ -223,6 +225,37 @@ auth_context_free (AuthContext *auth_context)
        g_slice_free (AuthContext, auth_context);
 }
 
+static CreateContext *
+create_context_new (void)
+{
+       CreateContext *create_context;
+
+       create_context = g_slice_new0 (CreateContext);
+
+       create_context->pending_uids = g_hash_table_new_full (
+               (GHashFunc) g_str_hash,
+               (GEqualFunc) g_str_equal,
+               (GDestroyNotify) g_free,
+               (GDestroyNotify) NULL);
+
+       create_context->main_context = g_main_context_new ();
+
+       create_context->main_loop = g_main_loop_new (
+               create_context->main_context, FALSE);
+
+       return create_context;
+}
+
+static void
+create_context_free (CreateContext *create_context)
+{
+       g_main_loop_unref (create_context->main_loop);
+       g_main_context_unref (create_context->main_context);
+       g_hash_table_unref (create_context->pending_uids);
+
+       g_slice_free (CreateContext, create_context);
+}
+
 static void
 source_closure_free (SourceClosure *closure)
 {
@@ -239,8 +272,8 @@ thread_closure_free (ThreadClosure *closure)
 
        g_main_context_unref (closure->main_context);
        g_main_loop_unref (closure->main_loop);
-       g_cond_free (closure->main_loop_cond);
-       g_mutex_free (closure->main_loop_mutex);
+       g_cond_clear (&closure->main_loop_cond);
+       g_mutex_clear (&closure->main_loop_mutex);
 
        /* The GError should be NULL at this point,
         * regardless of whether an error occurred. */
@@ -257,14 +290,14 @@ source_registry_object_path_table_insert (ESourceRegistry *registry,
        g_return_if_fail (object_path != NULL);
        g_return_if_fail (E_IS_SOURCE (source));
 
-       g_mutex_lock (registry->priv->object_path_table_lock);
+       g_mutex_lock (&registry->priv->object_path_table_lock);
 
        g_hash_table_insert (
                registry->priv->object_path_table,
                g_strdup (object_path),
                g_object_ref (source));
 
-       g_mutex_unlock (registry->priv->object_path_table_lock);
+       g_mutex_unlock (&registry->priv->object_path_table_lock);
 }
 
 static ESource *
@@ -275,14 +308,14 @@ source_registry_object_path_table_lookup (ESourceRegistry *registry,
 
        g_return_val_if_fail (object_path != NULL, NULL);
 
-       g_mutex_lock (registry->priv->object_path_table_lock);
+       g_mutex_lock (&registry->priv->object_path_table_lock);
 
        source = g_hash_table_lookup (
                registry->priv->object_path_table, object_path);
        if (source != NULL)
                g_object_ref (source);
 
-       g_mutex_unlock (registry->priv->object_path_table_lock);
+       g_mutex_unlock (&registry->priv->object_path_table_lock);
 
        return source;
 }
@@ -295,12 +328,12 @@ source_registry_object_path_table_remove (ESourceRegistry *registry,
 
        g_return_val_if_fail (object_path != NULL, FALSE);
 
-       g_mutex_lock (registry->priv->object_path_table_lock);
+       g_mutex_lock (&registry->priv->object_path_table_lock);
 
        removed = g_hash_table_remove (
                registry->priv->object_path_table, object_path);
 
-       g_mutex_unlock (registry->priv->object_path_table_lock);
+       g_mutex_unlock (&registry->priv->object_path_table_lock);
 
        return removed;
 }
@@ -314,13 +347,13 @@ source_registry_sources_insert (ESourceRegistry *registry,
        uid = e_source_get_uid (source);
        g_return_if_fail (uid != NULL);
 
-       g_mutex_lock (registry->priv->sources_lock);
+       g_mutex_lock (&registry->priv->sources_lock);
 
        g_hash_table_insert (
                registry->priv->sources,
                g_strdup (uid), g_object_ref (source));
 
-       g_mutex_unlock (registry->priv->sources_lock);
+       g_mutex_unlock (&registry->priv->sources_lock);
 }
 
 static gboolean
@@ -333,11 +366,11 @@ source_registry_sources_remove (ESourceRegistry *registry,
        uid = e_source_get_uid (source);
        g_return_val_if_fail (uid != NULL, FALSE);
 
-       g_mutex_lock (registry->priv->sources_lock);
+       g_mutex_lock (&registry->priv->sources_lock);
 
        removed = g_hash_table_remove (registry->priv->sources, uid);
 
-       g_mutex_unlock (registry->priv->sources_lock);
+       g_mutex_unlock (&registry->priv->sources_lock);
 
        return removed;
 }
@@ -350,14 +383,14 @@ source_registry_sources_lookup (ESourceRegistry *registry,
 
        g_return_val_if_fail (uid != NULL, NULL);
 
-       g_mutex_lock (registry->priv->sources_lock);
+       g_mutex_lock (&registry->priv->sources_lock);
 
        source = g_hash_table_lookup (registry->priv->sources, uid);
 
        if (source != NULL)
                g_object_ref (source);
 
-       g_mutex_unlock (registry->priv->sources_lock);
+       g_mutex_unlock (&registry->priv->sources_lock);
 
        return source;
 }
@@ -367,13 +400,13 @@ source_registry_sources_get_values (ESourceRegistry *registry)
 {
        GList *values;
 
-       g_mutex_lock (registry->priv->sources_lock);
+       g_mutex_lock (&registry->priv->sources_lock);
 
        values = g_hash_table_get_values (registry->priv->sources);
 
        g_list_foreach (values, (GFunc) g_object_ref, NULL);
 
-       g_mutex_unlock (registry->priv->sources_lock);
+       g_mutex_unlock (&registry->priv->sources_lock);
 
        return values;
 }
@@ -386,7 +419,7 @@ source_registry_sources_build_tree (ESourceRegistry *registry)
        GHashTableIter iter;
        gpointer key, value;
 
-       g_mutex_lock (registry->priv->sources_lock);
+       g_mutex_lock (&registry->priv->sources_lock);
 
        root = g_node_new (NULL);
        index = g_hash_table_new (g_str_hash, g_str_equal);
@@ -424,7 +457,7 @@ source_registry_sources_build_tree (ESourceRegistry *registry)
 
        g_hash_table_destroy (index);
 
-       g_mutex_unlock (registry->priv->sources_lock);
+       g_mutex_unlock (&registry->priv->sources_lock);
 
        return root;
 }
@@ -569,14 +602,17 @@ source_registry_add_source (ESourceRegistry *registry,
 {
        const gchar *uid;
 
+       /* This is called in the manager thread during initialization
+        * and in response to "object-added" signals from the manager. */
+
        uid = e_source_get_uid (source);
        g_return_if_fail (uid != NULL);
 
-       g_mutex_lock (registry->priv->sources_lock);
+       g_mutex_lock (&registry->priv->sources_lock);
 
        /* Check if we already have this source in the registry. */
        if (g_hash_table_lookup (registry->priv->sources, uid) != NULL) {
-               g_mutex_unlock (registry->priv->sources_lock);
+               g_mutex_unlock (&registry->priv->sources_lock);
                return;
        }
 
@@ -590,31 +626,19 @@ source_registry_add_source (ESourceRegistry *registry,
                G_CALLBACK (source_registry_source_notify_enabled_cb),
                registry);
 
-       g_mutex_unlock (registry->priv->sources_lock);
+       g_mutex_unlock (&registry->priv->sources_lock);
 
        source_registry_sources_insert (registry, source);
-
-       g_signal_emit (registry, signals[SOURCE_ADDED], 0, source);
-}
-
-static void
-source_registry_remove_source (ESourceRegistry *registry,
-                               ESource *source)
-{
-       g_object_ref (source);
-
-       if (source_registry_sources_remove (registry, source))
-               g_signal_emit (registry, signals[SOURCE_REMOVED], 0, source);
-
-       g_object_unref (source);
 }
 
 static gboolean
 source_registry_object_added_idle_cb (gpointer user_data)
 {
        SourceClosure *closure = user_data;
+       ESourceRegistry *registry = closure->registry;
+       ESource *source = closure->source;
 
-       source_registry_add_source (closure->registry, closure->source);
+       g_signal_emit (registry, signals[SOURCE_ADDED], 0, source);
 
        return FALSE;
 }
@@ -633,6 +657,10 @@ source_registry_object_added_cb (GDBusObjectManager *object_manager,
        source = source_registry_new_source (registry, dbus_object);
        g_return_if_fail (source != NULL);
 
+       /* Add the new ESource to our internal hash table so it can be
+        * obtained through e_source_registry_ref_source() immediately. */
+       source_registry_add_source (registry, source);
+
        /* Schedule a callback on the ESourceRegistry's GMainContext. */
 
        closure = g_slice_new0 (SourceClosure);
@@ -654,8 +682,13 @@ static gboolean
 source_registry_object_removed_idle_cb (gpointer user_data)
 {
        SourceClosure *closure = user_data;
+       ESourceRegistry *registry = closure->registry;
+       ESource *source = closure->source;
 
-       source_registry_remove_source (closure->registry, closure->source);
+       /* Removing the ESource won't finalize it because the
+        * SourceClosure itself still holds a reference on it. */
+       if (source_registry_sources_remove (registry, source))
+               g_signal_emit (registry, signals[SOURCE_REMOVED], 0, source);
 
        return FALSE;
 }
@@ -702,9 +735,9 @@ source_registry_object_manager_running (gpointer data)
 {
        ThreadClosure *closure = data;
 
-       g_mutex_lock (closure->main_loop_mutex);
-       g_cond_broadcast (closure->main_loop_cond);
-       g_mutex_unlock (closure->main_loop_mutex);
+       g_mutex_lock (&closure->main_loop_mutex);
+       g_cond_broadcast (&closure->main_loop_cond);
+       g_mutex_unlock (&closure->main_loop_mutex);
 
        return FALSE;
 }
@@ -952,6 +985,7 @@ source_registry_dispose (GObject *object)
        g_hash_table_remove_all (priv->sources);
 
        if (priv->settings != NULL) {
+               g_signal_handlers_disconnect_by_data (priv->settings, object);
                g_object_unref (priv->settings);
                priv->settings = NULL;
        }
@@ -968,10 +1002,10 @@ source_registry_finalize (GObject *object)
        priv = E_SOURCE_REGISTRY_GET_PRIVATE (object);
 
        g_hash_table_destroy (priv->object_path_table);
-       g_mutex_free (priv->object_path_table_lock);
+       g_mutex_clear (&priv->object_path_table_lock);
 
        g_hash_table_destroy (priv->sources);
-       g_mutex_free (priv->sources_lock);
+       g_mutex_clear (&priv->sources_lock);
 
        /* Chain up to parent's finalize() method. */
        G_OBJECT_CLASS (e_source_registry_parent_class)->finalize (object);
@@ -994,26 +1028,27 @@ source_registry_initable_init (GInitable *initable,
         * we wait for the main loop to start running as a way of
         * synchronizing with the manager thread. */
        closure->main_loop = g_main_loop_new (closure->main_context, FALSE);
-       closure->main_loop_cond = g_cond_new ();
-       closure->main_loop_mutex = g_mutex_new ();
+       g_cond_init (&closure->main_loop_cond);
+       g_mutex_init (&closure->main_loop_mutex);
 
        registry->priv->thread_closure = closure;
 
-       registry->priv->manager_thread = g_thread_create (
+       registry->priv->manager_thread = g_thread_new (
+               NULL,
                source_registry_object_manager_thread,
-               closure, TRUE /* joinable */, error);
+               closure);
 
        if (registry->priv->manager_thread == NULL)
                return FALSE;
 
        /* Wait for notification that the manager
         * thread's main loop has been started. */
-       g_mutex_lock (closure->main_loop_mutex);
+       g_mutex_lock (&closure->main_loop_mutex);
        while (!g_main_loop_is_running (closure->main_loop))
                g_cond_wait (
-                       closure->main_loop_cond,
-                       closure->main_loop_mutex);
-       g_mutex_unlock (closure->main_loop_mutex);
+                       &closure->main_loop_cond,
+                       &closure->main_loop_mutex);
+       g_mutex_unlock (&closure->main_loop_mutex);
 
        /* Check for error in the manager thread. */
        if (closure->error != NULL) {
@@ -1022,8 +1057,24 @@ source_registry_initable_init (GInitable *initable,
                return FALSE;
        }
 
-       /* The registry should now be populated with sources. */
-       g_warn_if_fail (g_hash_table_size (registry->priv->sources) > 0);
+       /* The registry should now be populated with sources.
+        *
+        * XXX Actually, not necessarily if the registry service was
+        *     just now activated.  There may yet be a small window
+        *     while the registry service starts up before it exports
+        *     any sources, even built-in sources.  This COULD create
+        *     problems if any logic that depends on those built-in
+        *     sources executes during this time window, but so far
+        *     we haven't seen any cases of that.
+        *
+        *     Attempts in the past to stop and wait for sources to
+        *     show up have proven problematic.  See for example:
+        *     https://bugzilla.gnome.org/678378
+        *
+        *     Leave the runtime check disabled for the moment.
+        *     I have a feeling I'll be revisiting this again.
+        */
+       /*g_warn_if_fail (g_hash_table_size (registry->priv->sources) > 0);*/
 
        /* The EDBusSourceManagerProxy is just another D-Bus interface
         * that resides at the same object path.  It's unrelated to the
@@ -1039,6 +1090,14 @@ source_registry_initable_init (GInitable *initable,
        if (registry->priv->dbus_source_manager == NULL)
                return FALSE;
 
+       /* Allow authentication prompts for all exported data sources
+        * when a new EDBusSourceManagerProxy is created.  The thought
+        * being, if you cancel an authentication prompt you will not
+        * be bothered again until you start (or restart) a new E-D-S
+        * client app.  Failure here is non-fatal, ignore errors. */
+       e_dbus_source_manager_call_allow_auth_prompt_all_sync (
+               registry->priv->dbus_source_manager, cancellable, NULL);
+
        return TRUE;
 }
 
@@ -1264,7 +1323,7 @@ e_source_registry_init (ESourceRegistry *registry)
                        (GDestroyNotify) g_free,
                        (GDestroyNotify) g_object_unref);
 
-       registry->priv->object_path_table_lock = g_mutex_new ();
+       g_mutex_init (&registry->priv->object_path_table_lock);
 
        /* UID string -> ESource */
        registry->priv->sources = g_hash_table_new_full (
@@ -1273,7 +1332,7 @@ e_source_registry_init (ESourceRegistry *registry)
                (GDestroyNotify) g_free,
                (GDestroyNotify) source_registry_unref_source);
 
-       registry->priv->sources_lock = g_mutex_new ();
+       g_mutex_init (&registry->priv->sources_lock);
 
        registry->priv->settings = g_settings_new (GSETTINGS_SCHEMA);
 
@@ -1302,7 +1361,7 @@ e_source_registry_new_sync (GCancellable *cancellable,
        /* XXX Work around http://bugzilla.gnome.org/show_bug.cgi?id=683519
         *     until GObject's type initialization deadlock issue is fixed.
         *     Apparently only the synchronous instantiation is affected. */
-       REGISTER_TYPE (G_TYPE_DBUS_CONNECTION);
+       g_type_ensure (G_TYPE_DBUS_CONNECTION);
 
        return g_initable_new (
                E_TYPE_SOURCE_REGISTRY,
@@ -1713,6 +1772,12 @@ e_source_registry_authenticate_sync (ESourceRegistry *registry,
 
 exit:
        g_main_context_pop_thread_default (main_context);
+
+       /* Make sure the main_context doesn't have pending operations;
+          workarounds https://bugzilla.gnome.org/show_bug.cgi?id=690126 */
+       while (g_main_context_pending (main_context))
+               g_main_context_iteration (main_context, FALSE);
+
        g_main_context_unref (main_context);
 
        return success;
@@ -2002,6 +2067,49 @@ source_registry_create_sources_thread (GSimpleAsyncResult *simple,
                g_simple_async_result_take_error (simple, error);
 }
 
+/* Helper for e_source_registry_create_sources_sync() */
+static gboolean
+source_registry_create_sources_main_loop_quit_cb (gpointer user_data)
+{
+       GMainLoop *main_loop = user_data;
+
+       g_main_loop_quit (main_loop);
+
+       return FALSE;
+}
+
+/* Helper for e_source_registry_create_sources_sync() */
+static void
+source_registry_create_sources_object_added_cb (GDBusObjectManager *object_manager,
+                                                GDBusObject *dbus_object,
+                                                CreateContext *create_context)
+{
+       EDBusObject *e_dbus_object;
+       EDBusSource *e_dbus_source;
+       const gchar *uid;
+
+       e_dbus_object = E_DBUS_OBJECT (dbus_object);
+       e_dbus_source = e_dbus_object_get_source (e_dbus_object);
+       uid = e_dbus_source_get_uid (e_dbus_source);
+
+       g_hash_table_remove (create_context->pending_uids, uid);
+
+       /* The hash table will be empty when all of the expected
+        * GDBusObjects have been added to the GDBusObjectManager. */
+       if (g_hash_table_size (create_context->pending_uids) == 0) {
+               GSource *idle_source;
+
+               idle_source = g_idle_source_new ();
+               g_source_set_callback (
+                       idle_source,
+                       source_registry_create_sources_main_loop_quit_cb,
+                       g_main_loop_ref (create_context->main_loop),
+                       (GDestroyNotify) g_main_loop_unref);
+               g_source_attach (idle_source, create_context->main_context);
+               g_source_unref (idle_source);
+       }
+}
+
 /**
  * e_source_registry_create_sources_sync:
  * @registry: an #ESourceRegistry
@@ -2026,9 +2134,11 @@ e_source_registry_create_sources_sync (ESourceRegistry *registry,
                                        GCancellable *cancellable,
                                        GError **error)
 {
+       CreateContext *create_context;
        GVariantBuilder builder;
        GVariant *variant;
        GList *link;
+       gulong object_added_id;
        gboolean success;
 
        g_return_val_if_fail (E_IS_SOURCE_REGISTRY (registry), FALSE);
@@ -2037,15 +2147,21 @@ e_source_registry_create_sources_sync (ESourceRegistry *registry,
        for (link = list_of_sources; link != NULL; link = g_list_next (link))
                g_return_val_if_fail (E_IS_SOURCE (link->data), FALSE);
 
+       create_context = create_context_new ();
+       g_main_context_push_thread_default (create_context->main_context);
+
        g_variant_builder_init (&builder, G_VARIANT_TYPE_ARRAY);
 
        for (link = list_of_sources; link != NULL; link = g_list_next (link)) {
                ESource *source;
-               const gchar *uid;
                gchar *source_data;
+               gchar *uid;
 
                source = E_SOURCE (link->data);
-               uid = e_source_get_uid (source);
+               uid = e_source_dup_uid (source);
+
+               /* Takes ownership of the UID string. */
+               g_hash_table_add (create_context->pending_uids, uid);
 
                source_data = e_source_to_string (source, NULL);
                g_variant_builder_add (&builder, "{ss}", uid, source_data);
@@ -2054,6 +2170,14 @@ e_source_registry_create_sources_sync (ESourceRegistry *registry,
 
        variant = g_variant_builder_end (&builder);
 
+       /* Use G_CONNECT_AFTER so source_registry_object_added_cb()
+        * runs first and actually adds the ESource to the internal
+        * hash table before we go quitting our main loop. */
+       object_added_id = g_signal_connect_after (
+               registry->priv->dbus_object_manager, "object-added",
+               G_CALLBACK (source_registry_create_sources_object_added_cb),
+               create_context);
+
        /* This function sinks the floating GVariant reference. */
        success = e_dbus_source_manager_call_create_sources_sync (
                registry->priv->dbus_source_manager,
@@ -2061,6 +2185,31 @@ e_source_registry_create_sources_sync (ESourceRegistry *registry,
 
        g_variant_builder_clear (&builder);
 
+       /* Wait for an "object-added" signal for each created ESource.
+        * But also set a short timeout to avoid getting stuck here in
+        * case the registry service adds sources to its orphan table,
+        * which prevents them from being exported over D-Bus. */
+       if (success) {
+               GSource *timeout_source;
+
+               timeout_source = g_timeout_source_new_seconds (2);
+               g_source_set_callback (
+                       timeout_source,
+                       source_registry_create_sources_main_loop_quit_cb,
+                       g_main_loop_ref (create_context->main_loop),
+                       (GDestroyNotify) g_main_loop_unref);
+               g_source_attach (timeout_source, create_context->main_context);
+               g_source_unref (timeout_source);
+
+               g_main_loop_run (create_context->main_loop);
+       }
+
+       g_signal_handler_disconnect (
+               registry->priv->dbus_object_manager, object_added_id);
+
+       g_main_context_pop_thread_default (create_context->main_context);
+       create_context_free (create_context);
+
        return success;
 }
 
@@ -2594,7 +2743,6 @@ e_source_registry_ref_builtin_address_book (ESourceRegistry *registry)
 
        uid = E_SOURCE_BUILTIN_ADDRESS_BOOK_UID;
        source = e_source_registry_ref_source (registry, uid);
-       g_return_val_if_fail (source != NULL, NULL);
 
        return source;
 }
@@ -2628,12 +2776,10 @@ e_source_registry_ref_default_address_book (ESourceRegistry *registry)
        source = e_source_registry_ref_source (registry, uid);
        g_free (uid);
 
-       /* The built-in source is always present. */
+       /* The built-in source is present in normal EDS installations. */
        if (source == NULL)
                source = e_source_registry_ref_builtin_address_book (registry);
 
-       g_return_val_if_fail (E_IS_SOURCE (source), NULL);
-
        return source;
 }
 
@@ -2696,7 +2842,6 @@ e_source_registry_ref_builtin_calendar (ESourceRegistry *registry)
 
        uid = E_SOURCE_BUILTIN_CALENDAR_UID;
        source = e_source_registry_ref_source (registry, uid);
-       g_return_val_if_fail (source != NULL, NULL);
 
        return source;
 }
@@ -2730,12 +2875,10 @@ e_source_registry_ref_default_calendar (ESourceRegistry *registry)
        source = e_source_registry_ref_source (registry, uid);
        g_free (uid);
 
-       /* The built-in source is always present. */
+       /* The built-in source is present in normal EDS installations. */
        if (source == NULL)
                source = e_source_registry_ref_builtin_calendar (registry);
 
-       g_return_val_if_fail (E_IS_SOURCE (source), NULL);
-
        return source;
 }