diff options
author | Matthew Barnes <mbarnes@redhat.com> | 2012-06-24 07:02:01 +0800 |
---|---|---|
committer | Matthew Barnes <mbarnes@redhat.com> | 2012-06-24 07:02:01 +0800 |
commit | 18420e77507819dcee97dcc6cf5f5811915df82a (patch) | |
tree | 0dcab97792e92e478818ce4fe5bb6d410c1a4141 /widgets/misc | |
parent | 922ca943bb348ca1445cb5403aa77aaa4c1cdec6 (diff) | |
download | gsoc2013-evolution-18420e77507819dcee97dcc6cf5f5811915df82a.tar gsoc2013-evolution-18420e77507819dcee97dcc6cf5f5811915df82a.tar.gz gsoc2013-evolution-18420e77507819dcee97dcc6cf5f5811915df82a.tar.bz2 gsoc2013-evolution-18420e77507819dcee97dcc6cf5f5811915df82a.tar.lz gsoc2013-evolution-18420e77507819dcee97dcc6cf5f5811915df82a.tar.xz gsoc2013-evolution-18420e77507819dcee97dcc6cf5f5811915df82a.tar.zst gsoc2013-evolution-18420e77507819dcee97dcc6cf5f5811915df82a.zip |
Bug 678634 - Criticals warnings when creating new book/cal
This required some reworking of assumptions I made early on when I first
wrote ESourceConfig, before I thought up the whole "collection" concept.
Not all ESourceConfigBackends will use a fixed parent UID, specifically
collection backends. In fact we may use multiple instances of the same
ESourceConfigBackend subclass if, for example, a user has two different
Exchange Web Services accounts configured. We would need to show both
EWS account (or "collection") names in the "Type" combo box.
For the moment collection-based ESourceConfigBackends are not listed
when creating a new calendar or address book since we lack support for
creating new resources on a remote server. A D-Bus interface for that
is in the works.
Diffstat (limited to 'widgets/misc')
-rw-r--r-- | widgets/misc/e-book-source-config.c | 33 | ||||
-rw-r--r-- | widgets/misc/e-cal-source-config.c | 33 | ||||
-rw-r--r-- | widgets/misc/e-source-config-backend.h | 7 | ||||
-rw-r--r-- | widgets/misc/e-source-config.c | 383 | ||||
-rw-r--r-- | widgets/misc/e-source-config.h | 4 |
5 files changed, 355 insertions, 105 deletions
diff --git a/widgets/misc/e-book-source-config.c b/widgets/misc/e-book-source-config.c index 6fca964b68..56d9771d9f 100644 --- a/widgets/misc/e-book-source-config.c +++ b/widgets/misc/e-book-source-config.c @@ -130,6 +130,37 @@ book_source_config_get_backend_extension_name (ESourceConfig *config) return E_SOURCE_EXTENSION_ADDRESS_BOOK; } +static GList * +book_source_config_list_eligible_collections (ESourceConfig *config) +{ + GQueue trash = G_QUEUE_INIT; + GList *list, *link; + + /* Chain up to parent's list_eligible_collections() method. */ + list = E_SOURCE_CONFIG_CLASS (e_book_source_config_parent_class)-> + list_eligible_collections (config); + + for (link = list; link != NULL; link = g_list_next (link)) { + ESource *source = E_SOURCE (link->data); + ESourceCollection *extension; + const gchar *extension_name; + + extension_name = E_SOURCE_EXTENSION_COLLECTION; + extension = e_source_get_extension (source, extension_name); + + if (!e_source_collection_get_contacts_enabled (extension)) + g_queue_push_tail (&trash, link); + } + + /* Remove ineligible collections from the list. */ + while ((link = g_queue_pop_head (&trash)) != NULL) { + g_object_unref (link->data); + list = g_list_delete_link (list, link); + } + + return list; +} + static void book_source_config_init_candidate (ESourceConfig *config, ESource *scratch_source) @@ -202,6 +233,8 @@ e_book_source_config_class_init (EBookSourceConfigClass *class) source_config_class = E_SOURCE_CONFIG_CLASS (class); source_config_class->get_backend_extension_name = book_source_config_get_backend_extension_name; + source_config_class->list_eligible_collections = + book_source_config_list_eligible_collections; source_config_class->init_candidate = book_source_config_init_candidate; source_config_class->commit_changes = book_source_config_commit_changes; } diff --git a/widgets/misc/e-cal-source-config.c b/widgets/misc/e-cal-source-config.c index 1d3243c77b..e57d0c6745 100644 --- a/widgets/misc/e-cal-source-config.c +++ b/widgets/misc/e-cal-source-config.c @@ -229,6 +229,37 @@ cal_source_config_get_backend_extension_name (ESourceConfig *config) return extension_name; } +static GList * +cal_source_config_list_eligible_collections (ESourceConfig *config) +{ + GQueue trash = G_QUEUE_INIT; + GList *list, *link; + + /* Chain up to parent's list_eligible_collections() method. */ + list = E_SOURCE_CONFIG_CLASS (e_cal_source_config_parent_class)-> + list_eligible_collections (config); + + for (link = list; link != NULL; link = g_list_next (link)) { + ESource *source = E_SOURCE (link->data); + ESourceCollection *extension; + const gchar *extension_name; + + extension_name = E_SOURCE_EXTENSION_COLLECTION; + extension = e_source_get_extension (source, extension_name); + + if (!e_source_collection_get_calendar_enabled (extension)) + g_queue_push_tail (&trash, link); + } + + /* Remove ineligible collections from the list. */ + while ((link = g_queue_pop_head (&trash)) != NULL) { + g_object_unref (link->data); + list = g_list_delete_link (list, link); + } + + return list; +} + static void cal_source_config_init_candidate (ESourceConfig *config, ESource *scratch_source) @@ -306,6 +337,8 @@ e_cal_source_config_class_init (ECalSourceConfigClass *class) source_config_class = E_SOURCE_CONFIG_CLASS (class); source_config_class->get_backend_extension_name = cal_source_config_get_backend_extension_name; + source_config_class->list_eligible_collections = + cal_source_config_list_eligible_collections; source_config_class->init_candidate = cal_source_config_init_candidate; source_config_class->commit_changes = cal_source_config_commit_changes; diff --git a/widgets/misc/e-source-config-backend.h b/widgets/misc/e-source-config-backend.h index 72cef5d4d1..8141cea1a5 100644 --- a/widgets/misc/e-source-config-backend.h +++ b/widgets/misc/e-source-config-backend.h @@ -56,9 +56,14 @@ struct _ESourceConfigBackend { struct _ESourceConfigBackendClass { EExtensionClass parent_class; - const gchar *parent_uid; + /* This should match backend names used in ESourceBackend. */ const gchar *backend_name; + /* Optional. Collection-based backends can leave this NULL. + * This is only for sources which have a fixed parent source, + * usually one of the "stub" placeholders ("local-stub", etc). */ + const gchar *parent_uid; + gboolean (*allow_creation) (ESourceConfigBackend *backend); void (*insert_widgets) (ESourceConfigBackend *backend, ESource *scratch_source); diff --git a/widgets/misc/e-source-config.c b/widgets/misc/e-source-config.c index 8372da1448..baf09a3b37 100644 --- a/widgets/misc/e-source-config.c +++ b/widgets/misc/e-source-config.c @@ -117,73 +117,66 @@ source_config_init_backends (ESourceConfig *config) } static gint -source_config_compare_backends (ESourceConfigBackend *backend_a, - ESourceConfigBackend *backend_b, - ESourceConfig *config) +source_config_compare_sources (gconstpointer a, + gconstpointer b, + gpointer user_data) { - ESourceConfigBackendClass *class_a; - ESourceConfigBackendClass *class_b; - ESourceRegistry *registry; ESource *source_a; ESource *source_b; + ESource *parent_a; + ESource *parent_b; + ESourceConfig *config; + ESourceRegistry *registry; const gchar *parent_uid_a; const gchar *parent_uid_b; - const gchar *backend_name_a; - const gchar *backend_name_b; gint result; - registry = e_source_config_get_registry (config); - - class_a = E_SOURCE_CONFIG_BACKEND_GET_CLASS (backend_a); - class_b = E_SOURCE_CONFIG_BACKEND_GET_CLASS (backend_b); + source_a = E_SOURCE (a); + source_b = E_SOURCE (b); + config = E_SOURCE_CONFIG (user_data); - parent_uid_a = class_a->parent_uid; - parent_uid_b = class_b->parent_uid; - - backend_name_a = class_a->backend_name; - backend_name_b = class_b->backend_name; - - if (g_strcmp0 (backend_name_a, backend_name_b) == 0) + if (e_source_equal (source_a, source_b)) return 0; /* "On This Computer" always comes first. */ - if (g_strcmp0 (backend_name_a, "local") == 0) + parent_uid_a = e_source_get_parent (source_a); + parent_uid_b = e_source_get_parent (source_b); + + if (g_strcmp0 (parent_uid_a, "local-stub") == 0) return -1; - if (g_strcmp0 (backend_name_b, "local") == 0) + if (g_strcmp0 (parent_uid_b, "local-stub") == 0) return 1; - source_a = e_source_registry_ref_source (registry, parent_uid_a); - source_b = e_source_registry_ref_source (registry, parent_uid_b); + registry = e_source_config_get_registry (config); + + parent_a = e_source_registry_ref_source (registry, parent_uid_a); + parent_b = e_source_registry_ref_source (registry, parent_uid_b); - g_return_val_if_fail (source_a != NULL, 1); - g_return_val_if_fail (source_b != NULL, -1); + g_return_val_if_fail (parent_a != NULL, 1); + g_return_val_if_fail (parent_b != NULL, -1); - result = e_source_compare_by_display_name (source_a, source_b); + result = e_source_compare_by_display_name (parent_a, parent_b); - g_object_unref (source_a); - g_object_unref (source_b); + g_object_unref (parent_a); + g_object_unref (parent_b); return result; } static void source_config_add_candidate (ESourceConfig *config, + ESource *scratch_source, ESourceConfigBackend *backend) { Candidate *candidate; GtkBox *backend_box; GtkLabel *type_label; GtkComboBoxText *type_combo; - ESourceConfigBackendClass *class; - ESourceRegistry *registry; - ESourceBackend *extension; - ESource *original_source; ESource *parent_source; - GDBusObject *dbus_object; + ESourceRegistry *registry; const gchar *display_name; - const gchar *extension_name; const gchar *parent_uid; backend_box = GTK_BOX (config->priv->backend_box); @@ -191,55 +184,18 @@ source_config_add_candidate (ESourceConfig *config, type_combo = GTK_COMBO_BOX_TEXT (config->priv->type_combo); registry = e_source_config_get_registry (config); - class = E_SOURCE_CONFIG_BACKEND_GET_CLASS (backend); - - original_source = e_source_config_get_original_source (config); - - if (original_source != NULL) - parent_uid = e_source_get_parent (original_source); - else - parent_uid = class->parent_uid; - - /* Make sure the parent source exists. This will either - * be a collection source or a built-in "stub" source. */ + parent_uid = e_source_get_parent (scratch_source); parent_source = e_source_registry_ref_source (registry, parent_uid); - if (parent_source == NULL) - return; - - /* Some backends don't allow new sources to be created. - * The "contacts" calendar backend is one such example. */ - if (original_source == NULL) { - if (!e_source_config_backend_allow_creation (backend)) - return; - } + g_return_if_fail (parent_source != NULL); candidate = g_slice_new (Candidate); candidate->backend = g_object_ref (backend); - - /* Skip passing a GError here. If dbus_object is NULL, this should - * never fail. If dbus_object is non-NULL, then its data should have - * been produced by a GKeyFile on the server-side, so the chances of - * it failing to load this time are slim. */ - if (original_source != NULL) - dbus_object = e_source_ref_dbus_object (original_source); - else - dbus_object = NULL; - candidate->scratch_source = e_source_new (dbus_object, NULL, NULL); - if (dbus_object != NULL) - g_object_unref (dbus_object); + candidate->scratch_source = g_object_ref (scratch_source); /* Do not show the page here. */ candidate->page = g_object_ref_sink (gtk_vbox_new (FALSE, 6)); gtk_box_pack_start (backend_box, candidate->page, FALSE, FALSE, 0); - e_source_set_parent (candidate->scratch_source, parent_uid); - - extension_name = - e_source_config_get_backend_extension_name (config); - extension = e_source_get_extension ( - candidate->scratch_source, extension_name); - e_source_backend_set_backend_name (extension, class->backend_name); - g_ptr_array_add (config->priv->candidates, candidate); display_name = e_source_get_display_name (parent_source); @@ -319,6 +275,215 @@ source_config_type_combo_changed_cb (GtkComboBox *type_combo, e_source_config_resize_window (config); } +static gboolean +source_config_init_for_adding_source_foreach (gpointer key, + gpointer value, + gpointer user_data) +{ + ESource *scratch_source; + ESourceBackend *extension; + ESourceConfig *config; + ESourceConfigBackend *backend; + ESourceConfigBackendClass *class; + const gchar *extension_name; + + scratch_source = E_SOURCE (key); + backend = E_SOURCE_CONFIG_BACKEND (value); + config = E_SOURCE_CONFIG (user_data); + + /* This may not be the correct backend name for the child of a + * collection. For example, the "yahoo" collection backend uses + * the "caldav" calender backend for calendar children. But the + * ESourceCollectionBackend can override our setting if needed. */ + class = E_SOURCE_CONFIG_BACKEND_GET_CLASS (backend); + extension_name = e_source_config_get_backend_extension_name (config); + extension = e_source_get_extension (scratch_source, extension_name); + e_source_backend_set_backend_name (extension, class->backend_name); + + source_config_add_candidate (config, scratch_source, backend); + + return FALSE; /* don't stop traversal */ +} + +static void +source_config_init_for_adding_source (ESourceConfig *config) +{ + GList *list, *link; + ESourceRegistry *registry; + GTree *scratch_source_tree; + + /* Candidates are drawn from two sources: + * + * ESourceConfigBackend classes that specify a fixed parent UID, + * meaning there exists one only possible parent source for any + * scratch source created by the backend. The fixed parent UID + * should be a built-in "stub" placeholder ("local-stub", etc). + * + * -and- + * + * Collection sources. We let ESourceConfig subclasses gather + * eligible collection sources to serve as parents for scratch + * sources. A scratch source is matched to a backend based on + * the collection's backend name. The "calendar-enabled" and + * "contacts-enabled" settings also factor into eligibility. + */ + + /* Use a GTree instead of a GHashTable so inserted scratch + * sources automatically sort themselves by their parent's + * display name. */ + scratch_source_tree = g_tree_new_full ( + source_config_compare_sources, config, + (GDestroyNotify) g_object_unref, + (GDestroyNotify) g_object_unref); + + registry = e_source_config_get_registry (config); + + /* First pick out the backends with a fixed parent UID. */ + + list = g_hash_table_get_values (config->priv->backends); + + for (link = list; link != NULL; link = g_list_next (link)) { + ESourceConfigBackend *backend; + ESourceConfigBackendClass *class; + ESource *scratch_source; + ESource *parent_source; + gboolean parent_is_disabled; + + backend = E_SOURCE_CONFIG_BACKEND (link->data); + class = E_SOURCE_CONFIG_BACKEND_GET_CLASS (backend); + + if (class->parent_uid == NULL) + continue; + + /* Verify the fixed parent UID is valid. */ + parent_source = e_source_registry_ref_source ( + registry, class->parent_uid); + if (parent_source == NULL) { + g_warning ( + "%s: %sClass specifies " + "an invalid parent_uid '%s'", + G_STRFUNC, + G_OBJECT_TYPE_NAME (backend), + class->parent_uid); + continue; + } + parent_is_disabled = !e_source_get_enabled (parent_source); + g_object_unref (parent_source); + + /* It's unusual for a fixed parent source to be disabled. + * A user would have to go out of his way to do this, but + * we should honor it regardless. */ + if (parent_is_disabled) + continue; + + /* Some backends don't allow new sources to be created. + * The "contacts" calendar backend is one such example. */ + if (!e_source_config_backend_allow_creation (backend)) + continue; + + scratch_source = e_source_new (NULL, NULL, NULL); + g_return_if_fail (scratch_source != NULL); + + e_source_set_parent (scratch_source, class->parent_uid); + + g_tree_insert ( + scratch_source_tree, + g_object_ref (scratch_source), + g_object_ref (backend)); + + g_object_unref (scratch_source); + } + + g_list_free (list); + + /* Next gather eligible collection sources to serve as parents. */ + + list = e_source_config_list_eligible_collections (config); + + for (link = list; link != NULL; link = g_list_next (link)) { + ESource *parent_source; + ESource *scratch_source; + ESourceBackend *extension; + ESourceConfigBackend *backend = NULL; + const gchar *backend_name; + const gchar *parent_uid; + + parent_source = E_SOURCE (link->data); + parent_uid = e_source_get_uid (parent_source); + + extension = e_source_get_extension ( + parent_source, E_SOURCE_EXTENSION_COLLECTION); + backend_name = e_source_backend_get_backend_name (extension); + + if (backend_name != NULL) + backend = g_hash_table_lookup ( + config->priv->backends, backend_name); + + if (backend == NULL) + continue; + + scratch_source = e_source_new (NULL, NULL, NULL); + g_return_if_fail (scratch_source != NULL); + + e_source_set_parent (scratch_source, parent_uid); + + /* XXX Leave this disabled until we actually support + * creating remote resources through ESourceConfig. */ +#if 0 + g_tree_insert ( + scratch_source_tree, + g_object_ref (scratch_source), + g_object_ref (backend)); +#endif + + g_object_unref (scratch_source); + } + + g_list_free_full (list, (GDestroyNotify) g_object_unref); + + /* XXX GTree doesn't get as much love as GHashTable. + * It's missing an equivalent to GHashTableIter. */ + g_tree_foreach ( + scratch_source_tree, + source_config_init_for_adding_source_foreach, config); + + g_tree_unref (scratch_source_tree); +} + +static void +source_config_init_for_editing_source (ESourceConfig *config) +{ + ESource *original_source; + ESource *scratch_source; + ESourceBackend *extension; + ESourceConfigBackend *backend; + GDBusObject *dbus_object; + const gchar *backend_name; + const gchar *extension_name; + + original_source = e_source_config_get_original_source (config); + g_return_if_fail (original_source != NULL); + + extension_name = e_source_config_get_backend_extension_name (config); + extension = e_source_get_extension (original_source, extension_name); + backend_name = e_source_backend_get_backend_name (extension); + g_return_if_fail (backend_name != NULL); + + backend = g_hash_table_lookup (config->priv->backends, backend_name); + g_return_if_fail (backend != NULL); + + dbus_object = e_source_ref_dbus_object (original_source); + g_return_if_fail (dbus_object != NULL); + + scratch_source = e_source_new (dbus_object, NULL, NULL); + g_return_if_fail (scratch_source != NULL); + + source_config_add_candidate (config, scratch_source, backend); + + g_object_unref (scratch_source); + g_object_unref (dbus_object); +} + static void source_config_set_original_source (ESourceConfig *config, ESource *original_source) @@ -538,42 +703,37 @@ source_config_realize (GtkWidget *widget) config = E_SOURCE_CONFIG (widget); original_source = e_source_config_get_original_source (config); - if (original_source != NULL) { - ESourceBackend *extension; - ESourceConfigBackend *backend; - const gchar *backend_name; - const gchar *extension_name; - - extension_name = - e_source_config_get_backend_extension_name (config); - extension = e_source_get_extension ( - original_source, extension_name); - backend_name = e_source_backend_get_backend_name (extension); - g_return_if_fail (backend_name != NULL); - - backend = g_hash_table_lookup ( - config->priv->backends, backend_name); - g_return_if_fail (E_IS_SOURCE_CONFIG_BACKEND (backend)); - - source_config_add_candidate (config, backend); + if (original_source == NULL) + source_config_init_for_adding_source (config); + else + source_config_init_for_editing_source (config); +} - } else { - GList *list, *link; +static GList * +source_config_list_eligible_collections (ESourceConfig *config) +{ + ESourceRegistry *registry; + GQueue trash = G_QUEUE_INIT; + GList *list, *link; + const gchar *extension_name; - list = g_list_sort_with_data ( - g_hash_table_get_values (config->priv->backends), - (GCompareDataFunc) source_config_compare_backends, - config); + extension_name = E_SOURCE_EXTENSION_COLLECTION; + registry = e_source_config_get_registry (config); - for (link = list; link != NULL; link = g_list_next (link)) { - ESourceConfigBackend *backend; + list = e_source_registry_list_sources (registry, extension_name); - backend = E_SOURCE_CONFIG_BACKEND (link->data); - source_config_add_candidate (config, backend); - } + for (link = list; link != NULL; link = g_list_next (link)) { + if (!e_source_get_enabled (E_SOURCE (link->data))) + g_queue_push_tail (&trash, link); + } - g_list_free (list); + /* Remove ineligible collections from the list. */ + while ((link = g_queue_pop_head (&trash)) != NULL) { + g_object_unref (link->data); + list = g_list_delete_link (list, link); } + + return list; } static void @@ -676,6 +836,8 @@ e_source_config_class_init (ESourceConfigClass *class) widget_class = GTK_WIDGET_CLASS (class); widget_class->realize = source_config_realize; + class->list_eligible_collections = + source_config_list_eligible_collections; class->init_candidate = source_config_init_candidate; class->check_complete = source_config_check_complete; class->commit_changes = source_config_commit_changes; @@ -934,6 +1096,19 @@ e_source_config_get_backend_extension_name (ESourceConfig *config) return class->get_backend_extension_name (config); } +GList * +e_source_config_list_eligible_collections (ESourceConfig *config) +{ + ESourceConfigClass *class; + + g_return_val_if_fail (E_IS_SOURCE_CONFIG (config), NULL); + + class = E_SOURCE_CONFIG_GET_CLASS (config); + g_return_val_if_fail (class->list_eligible_collections != NULL, NULL); + + return class->list_eligible_collections (config); +} + gboolean e_source_config_check_complete (ESourceConfig *config) { diff --git a/widgets/misc/e-source-config.h b/widgets/misc/e-source-config.h index 1a5b549924..5d9ff7c93a 100644 --- a/widgets/misc/e-source-config.h +++ b/widgets/misc/e-source-config.h @@ -58,6 +58,8 @@ struct _ESourceConfigClass { /* Methods */ const gchar * (*get_backend_extension_name) (ESourceConfig *config); + GList * (*list_eligible_collections) + (ESourceConfig *config); /* Signals */ void (*init_candidate) (ESourceConfig *config, @@ -80,6 +82,8 @@ GtkWidget * e_source_config_get_page (ESourceConfig *config, ESource *scratch_source); const gchar * e_source_config_get_backend_extension_name (ESourceConfig *config); +GList * e_source_config_list_eligible_collections + (ESourceConfig *config); gboolean e_source_config_check_complete (ESourceConfig *config); ESource * e_source_config_get_original_source (ESourceConfig *config); |