Reorder accounts by drag-and-drop.

This implements https://bugzilla.gnome.org/show_bug.cgi?id=663527#c3.

Account reordering is now done by drag-and-drop instead of up/down
buttons.

Turned out to be a wee bit more complicated than I initially thought.

This scraps EAccountManager and EAccountTreeView and replaces them with
new classes centered around EMailAccountStore, which EMailSession owns.

EMailAccountStore is the model behind the account list in Preferences.
The folder tree model now uses it to sort its own top-level rows using
gtk_tree_path_compare().  It also broadcasts account operations through
signals so we don't have to rely so heavily on EAccountList signals,
since EAccountList is going away soon.

Also as part of this work, the e-mail-local.h and e-mail-store.h APIs
have been merged into EMailSession and MailFolderCache.

1 files changed, 565 insertions, 0 deletions

diff --git a/mail/e-mail-account-manager.c b/mail/e-mail-account-manager.c
new file mode 100644
index 0000000000..97a4fe3fe0
--- /dev/null
+++ b/mail/e-mail-account-manager.c
@@ -0,0 +1,565 @@
+/*
+ * e-mail-account-manager.c
+ *
+ * This program is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation; either
+ * version 2 of the License, or (at your option) version 3.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with the program; if not, see <http://www.gnu.org/licenses/>
+ *
+ */
+
+#include "e-mail-account-manager.h"
+
+#include <config.h>
+#include <glib/gi18n-lib.h>
+#include <gdk/gdkkeysyms.h>
+
+#include <mail/e-mail-account-tree-view.h>
+
+#define E_MAIL_ACCOUNT_MANAGER_GET_PRIVATE(obj) \
+	(G_TYPE_INSTANCE_GET_PRIVATE \
+	((obj), E_TYPE_MAIL_ACCOUNT_MANAGER, EMailAccountManagerPrivate))
+
+#define DEFAULT_ORDER_RESPONSE GTK_RESPONSE_APPLY
+
+struct _EMailAccountManagerPrivate {
+	EMailAccountStore *store;
+	gulong row_changed_handler_id;
+
+	GtkWidget *tree_view;		/* not referenced */
+	GtkWidget *add_button;		/* not referenced */
+	GtkWidget *edit_button;		/* not referenced */
+	GtkWidget *delete_button;	/* not referenced */
+	GtkWidget *default_button;	/* not referenced */
+};
+
+enum {
+	PROP_0,
+	PROP_STORE
+};
+
+enum {
+	ADD_ACCOUNT,
+	EDIT_ACCOUNT,
+	LAST_SIGNAL
+};
+
+static guint signals[LAST_SIGNAL];
+
+G_DEFINE_TYPE (
+	EMailAccountManager,
+	e_mail_account_manager,
+	GTK_TYPE_TABLE)
+
+static void
+mail_account_manager_add_cb (EMailAccountManager *manager)
+{
+	e_mail_account_manager_add_account (manager);
+}
+
+static void
+mail_account_manager_edit_cb (EMailAccountManager *manager)
+{
+	EMailAccountTreeView *tree_view;
+	EAccount *account;
+	CamelService *service;
+	const gchar *uid;
+
+	tree_view = E_MAIL_ACCOUNT_TREE_VIEW (manager->priv->tree_view);
+	service = e_mail_account_tree_view_get_selected_service (tree_view);
+
+	uid = camel_service_get_uid (service);
+	account = e_get_account_by_uid (uid);
+	g_return_if_fail (account != NULL);
+
+	e_mail_account_manager_edit_account (manager, account);
+}
+
+static void
+mail_account_manager_remove_cb (EMailAccountManager *manager)
+{
+	EMailAccountTreeView *tree_view;
+	EMailAccountStore *store;
+	CamelService *service;
+	gpointer parent;
+
+	tree_view = E_MAIL_ACCOUNT_TREE_VIEW (manager->priv->tree_view);
+	service = e_mail_account_tree_view_get_selected_service (tree_view);
+
+	parent = gtk_widget_get_toplevel (GTK_WIDGET (manager));
+	parent = gtk_widget_is_toplevel (parent) ? parent : NULL;
+
+	store = e_mail_account_manager_get_store (manager);
+	e_mail_account_store_remove_service (store, parent, service);
+}
+
+static void
+mail_account_manager_enable_cb (EMailAccountManager *manager)
+{
+	EMailAccountTreeView *tree_view;
+	EMailAccountStore *store;
+	CamelService *service;
+	gpointer parent;
+
+	tree_view = E_MAIL_ACCOUNT_TREE_VIEW (manager->priv->tree_view);
+	service = e_mail_account_tree_view_get_selected_service (tree_view);
+
+	parent = gtk_widget_get_toplevel (GTK_WIDGET (manager));
+	parent = gtk_widget_is_toplevel (parent) ? parent : NULL;
+
+	store = e_mail_account_manager_get_store (manager);
+	e_mail_account_store_enable_service (store, parent, service);
+}
+
+static void
+mail_account_manager_disable_cb (EMailAccountManager *manager)
+{
+	EMailAccountTreeView *tree_view;
+	EMailAccountStore *store;
+	CamelService *service;
+	gpointer parent;
+
+	tree_view = E_MAIL_ACCOUNT_TREE_VIEW (manager->priv->tree_view);
+	service = e_mail_account_tree_view_get_selected_service (tree_view);
+
+	parent = gtk_widget_get_toplevel (GTK_WIDGET (manager));
+	parent = gtk_widget_is_toplevel (parent) ? parent : NULL;
+
+	store = e_mail_account_manager_get_store (manager);
+	e_mail_account_store_disable_service (store, parent, service);
+}
+
+static void
+mail_account_manager_default_cb (EMailAccountManager *manager)
+{
+	EMailAccountTreeView *tree_view;
+	EMailAccountStore *store;
+	CamelService *service;
+
+	tree_view = E_MAIL_ACCOUNT_TREE_VIEW (manager->priv->tree_view);
+	service = e_mail_account_tree_view_get_selected_service (tree_view);
+
+	store = e_mail_account_manager_get_store (manager);
+	e_mail_account_store_set_default_service (store, service);
+}
+
+static void
+mail_account_manager_info_bar_response_cb (EMailAccountManager *manager,
+                                           gint response)
+{
+	EMailAccountStore *store;
+
+	store = e_mail_account_manager_get_store (manager);
+
+	if (response == DEFAULT_ORDER_RESPONSE)
+		e_mail_account_store_reorder_services (store, NULL);
+}
+
+static gboolean
+mail_account_manager_key_press_event_cb (EMailAccountManager *manager,
+                                         GdkEventKey *event)
+{
+	if (event->keyval == GDK_KEY_Delete) {
+		mail_account_manager_remove_cb (manager);
+		return TRUE;
+	}
+
+	return FALSE;
+}
+
+static void
+mail_account_manager_row_changed_cb (GtkTreeModel *tree_model,
+                                     GtkTreePath *path,
+                                     GtkTreeIter *iter,
+                                     EMailAccountManager *manager)
+{
+	GtkTreeView *tree_view;
+	GtkTreeSelection *selection;
+
+	tree_view = GTK_TREE_VIEW (manager->priv->tree_view);
+	selection = gtk_tree_view_get_selection (tree_view);
+
+	/* Update buttons for the selected row (which is not
+	 * necessarily the row that changed, but do it anyway). */
+	g_signal_emit_by_name (selection, "changed");
+}
+
+static void
+mail_account_manager_selection_changed_cb (EMailAccountManager *manager,
+                                           GtkTreeSelection *selection)
+{
+	GtkTreeModel *tree_model;
+	GtkTreeIter iter;
+	EMailAccountStore *store;
+	CamelService *default_service;
+	CamelService *service;
+	GtkWidget *add_button;
+	GtkWidget *edit_button;
+	GtkWidget *delete_button;
+	GtkWidget *default_button;
+	gboolean builtin;
+	gboolean sensitive;
+	gboolean not_default;
+
+	add_button = manager->priv->add_button;
+	edit_button = manager->priv->edit_button;
+	delete_button = manager->priv->delete_button;
+	default_button = manager->priv->default_button;
+
+	if (gtk_tree_selection_get_selected (selection, &tree_model, &iter)) {
+		gtk_tree_model_get (
+			tree_model, &iter,
+			E_MAIL_ACCOUNT_STORE_COLUMN_SERVICE, &service,
+			E_MAIL_ACCOUNT_STORE_COLUMN_BUILTIN, &builtin,
+			-1);
+	} else {
+		service = NULL;
+		builtin = FALSE;
+	}
+
+	store = e_mail_account_manager_get_store (manager);
+	default_service = e_mail_account_store_get_default_service (store);
+	not_default = (service != default_service);
+
+	if (service == NULL)
+		gtk_widget_grab_focus (add_button);
+
+	sensitive = (service != NULL && !builtin);
+	gtk_widget_set_sensitive (edit_button, sensitive);
+
+	sensitive = (service != NULL && !builtin);
+	gtk_widget_set_sensitive (delete_button, sensitive);
+
+	sensitive = (service != NULL && !builtin && not_default);
+	gtk_widget_set_sensitive (default_button, sensitive);
+}
+
+static void
+mail_account_manager_set_store (EMailAccountManager *manager,
+                                EMailAccountStore *store)
+{
+	g_return_if_fail (E_IS_MAIL_ACCOUNT_STORE (store));
+	g_return_if_fail (manager->priv->store == NULL);
+
+	manager->priv->store = g_object_ref (store);
+}
+
+static void
+mail_account_manager_set_property (GObject *object,
+                                   guint property_id,
+                                   const GValue *value,
+                                   GParamSpec *pspec)
+{
+	switch (property_id) {
+		case PROP_STORE:
+			mail_account_manager_set_store (
+				E_MAIL_ACCOUNT_MANAGER (object),
+				g_value_get_object (value));
+			return;
+	}
+
+	G_OBJECT_WARN_INVALID_PROPERTY_ID (object, property_id, pspec);
+}
+
+static void
+mail_account_manager_get_property (GObject *object,
+                                   guint property_id,
+                                   GValue *value,
+                                   GParamSpec *pspec)
+{
+	switch (property_id) {
+		case PROP_STORE:
+			g_value_set_object (
+				value,
+				e_mail_account_manager_get_store (
+				E_MAIL_ACCOUNT_MANAGER (object)));
+			return;
+	}
+
+	G_OBJECT_WARN_INVALID_PROPERTY_ID (object, property_id, pspec);
+}
+
+static void
+mail_account_manager_dispose (GObject *object)
+{
+	EMailAccountManagerPrivate *priv;
+
+	priv = E_MAIL_ACCOUNT_MANAGER_GET_PRIVATE (object);
+
+	if (priv->store != NULL) {
+		g_signal_handler_disconnect (
+			priv->store, priv->row_changed_handler_id);
+		g_object_unref (priv->store);
+		priv->store = NULL;
+	}
+
+	/* Chain up to parent's dispose() method. */
+	G_OBJECT_CLASS (e_mail_account_manager_parent_class)->dispose (object);
+}
+
+static void
+mail_account_manager_constructed (GObject *object)
+{
+	EMailAccountManager *manager;
+	EMailAccountStore *store;
+	GtkTreeSelection *selection;
+	GtkWidget *container;
+	GtkWidget *widget;
+	gulong handler_id;
+
+	manager = E_MAIL_ACCOUNT_MANAGER (object);
+	store = e_mail_account_manager_get_store (manager);
+
+	/* Chain up to parent's constructed() method. */
+	G_OBJECT_CLASS (e_mail_account_manager_parent_class)->
+		constructed (object);
+
+	g_object_bind_property (
+		store, "busy",
+		manager, "sensitive",
+		G_BINDING_SYNC_CREATE |
+		G_BINDING_INVERT_BOOLEAN);
+
+	handler_id = g_signal_connect (
+		store, "row-changed",
+		G_CALLBACK (mail_account_manager_row_changed_cb),
+		manager);
+
+	/* We disconnect the handler in dispose(). */
+	manager->priv->row_changed_handler_id = handler_id;
+
+	gtk_table_resize (GTK_TABLE (manager), 2, 2);
+	gtk_table_set_col_spacings (GTK_TABLE (manager), 6);
+	gtk_table_set_row_spacings (GTK_TABLE (manager), 0);
+
+	container = GTK_WIDGET (manager);
+
+	widget = gtk_scrolled_window_new (NULL, NULL);
+	gtk_scrolled_window_set_policy (
+		GTK_SCROLLED_WINDOW (widget),
+		GTK_POLICY_AUTOMATIC, GTK_POLICY_AUTOMATIC);
+	gtk_scrolled_window_set_shadow_type (
+		GTK_SCROLLED_WINDOW (widget), GTK_SHADOW_IN);
+	gtk_table_attach (
+		GTK_TABLE (container), widget, 0, 1, 0, 1,
+		GTK_EXPAND | GTK_FILL, GTK_EXPAND | GTK_FILL, 0, 0);
+	gtk_widget_show (widget);
+
+	container = widget;
+
+	widget = e_mail_account_tree_view_new (store);
+	gtk_container_add (GTK_CONTAINER (container), widget);
+	manager->priv->tree_view = widget;  /* not referenced */
+	gtk_widget_show (widget);
+
+	g_signal_connect_swapped (
+		widget, "enable",
+		G_CALLBACK (mail_account_manager_enable_cb), manager);
+
+	g_signal_connect_swapped (
+		widget, "disable",
+		G_CALLBACK (mail_account_manager_disable_cb), manager);
+
+	g_signal_connect_swapped (
+		widget, "key-press-event",
+		G_CALLBACK (mail_account_manager_key_press_event_cb),
+		manager);
+
+	g_signal_connect_swapped (
+		widget, "row-activated",
+		G_CALLBACK (mail_account_manager_edit_cb), manager);
+
+	selection = gtk_tree_view_get_selection (GTK_TREE_VIEW (widget));
+
+	g_signal_connect_swapped (
+		selection, "changed",
+		G_CALLBACK (mail_account_manager_selection_changed_cb),
+		manager);
+
+	container = GTK_WIDGET (manager);
+
+	widget = gtk_frame_new (NULL);
+	gtk_frame_set_shadow_type (
+		GTK_FRAME (widget), GTK_SHADOW_IN);
+	gtk_table_attach (
+		GTK_TABLE (container), widget,
+		0, 1, 1, 2, GTK_FILL, 0, 0, 0);
+	gtk_widget_show (widget);
+
+	container = widget;
+
+	widget = gtk_info_bar_new ();
+	gtk_info_bar_set_message_type (
+		GTK_INFO_BAR (widget), GTK_MESSAGE_INFO);
+	gtk_info_bar_add_button (
+		GTK_INFO_BAR (widget),
+		_("_Restore Default"),
+		DEFAULT_ORDER_RESPONSE);
+	gtk_container_add (GTK_CONTAINER (container), widget);
+	gtk_widget_show (widget);
+
+	g_signal_connect_swapped (
+		widget, "response",
+		G_CALLBACK (mail_account_manager_info_bar_response_cb),
+		manager);
+
+	container = gtk_info_bar_get_content_area (GTK_INFO_BAR (widget));
+
+	widget = gtk_label_new (
+		_("You can drag and drop account names to reorder them."));
+	gtk_misc_set_alignment (GTK_MISC (widget), 0.0, 0.5);
+	gtk_box_pack_start (GTK_BOX (container), widget, TRUE, TRUE, 0);
+	gtk_widget_show (widget);
+
+	container = GTK_WIDGET (manager);
+
+	widget = gtk_vbutton_box_new ();
+	gtk_button_box_set_layout (
+		GTK_BUTTON_BOX (widget), GTK_BUTTONBOX_START);
+	gtk_box_set_spacing (GTK_BOX (widget), 6);
+	gtk_table_attach (
+		GTK_TABLE (container), widget,
+		1, 2, 0, 2, 0, GTK_FILL, 0, 0);
+	gtk_widget_show (widget);
+
+	container = widget;
+
+	widget = gtk_button_new_from_stock (GTK_STOCK_ADD);
+	gtk_box_pack_start (GTK_BOX (container), widget, TRUE, TRUE, 0);
+	manager->priv->add_button = widget;  /* not referenced */
+	gtk_widget_show (widget);
+
+	g_signal_connect_swapped (
+		widget, "clicked",
+		G_CALLBACK (mail_account_manager_add_cb), manager);
+
+	widget = gtk_button_new_from_stock (GTK_STOCK_EDIT);
+	gtk_box_pack_start (GTK_BOX (container), widget, TRUE, TRUE, 0);
+	manager->priv->edit_button = widget;  /* not referenced */
+	gtk_widget_show (widget);
+
+	g_signal_connect_swapped (
+		widget, "clicked",
+		G_CALLBACK (mail_account_manager_edit_cb), manager);
+
+	widget = gtk_button_new_from_stock (GTK_STOCK_DELETE);
+	gtk_box_pack_start (GTK_BOX (container), widget, TRUE, TRUE, 0);
+	manager->priv->delete_button = widget;  /* not referenced */
+	gtk_widget_show (widget);
+
+	g_signal_connect_swapped (
+		widget, "clicked",
+		G_CALLBACK (mail_account_manager_remove_cb), manager);
+
+	widget = gtk_button_new_with_mnemonic (_("De_fault"));
+	gtk_button_set_image (
+		GTK_BUTTON (widget),
+		gtk_image_new_from_icon_name (
+		"emblem-default", GTK_ICON_SIZE_BUTTON));
+	gtk_box_pack_start (GTK_BOX (container), widget, TRUE, TRUE, 0);
+	manager->priv->default_button = widget;  /* not referenced */
+	gtk_widget_show (widget);
+
+	g_signal_connect_swapped (
+		widget, "clicked",
+		G_CALLBACK (mail_account_manager_default_cb), manager);
+
+	/* Initialize button states. */
+	g_signal_emit_by_name (selection, "changed");
+}
+
+static void
+e_mail_account_manager_class_init (EMailAccountManagerClass *class)
+{
+	GObjectClass *object_class;
+
+	g_type_class_add_private (class, sizeof (EMailAccountManagerPrivate));
+
+	object_class = G_OBJECT_CLASS (class);
+	object_class->set_property = mail_account_manager_set_property;
+	object_class->get_property = mail_account_manager_get_property;
+	object_class->dispose = mail_account_manager_dispose;
+	object_class->constructed = mail_account_manager_constructed;
+
+	g_object_class_install_property (
+		object_class,
+		PROP_STORE,
+		g_param_spec_object (
+			"store",
+			"Store",
+			NULL,
+			E_TYPE_MAIL_ACCOUNT_STORE,
+			G_PARAM_READWRITE |
+			G_PARAM_CONSTRUCT_ONLY |
+			G_PARAM_STATIC_STRINGS));
+
+	signals[ADD_ACCOUNT] = g_signal_new (
+		"add-account",
+		G_OBJECT_CLASS_TYPE (class),
+		G_SIGNAL_RUN_LAST,
+		G_STRUCT_OFFSET (EMailAccountManagerClass, add_account),
+		NULL, NULL,
+		g_cclosure_marshal_VOID__VOID,
+		G_TYPE_NONE, 0);
+
+	signals[EDIT_ACCOUNT] = g_signal_new (
+		"edit-account",
+		G_OBJECT_CLASS_TYPE (class),
+		G_SIGNAL_RUN_LAST,
+		G_STRUCT_OFFSET (EMailAccountManagerClass, edit_account),
+		NULL, NULL,
+		g_cclosure_marshal_VOID__OBJECT,
+		G_TYPE_NONE, 1,
+		E_TYPE_ACCOUNT);
+}
+
+static void
+e_mail_account_manager_init (EMailAccountManager *manager)
+{
+	manager->priv = E_MAIL_ACCOUNT_MANAGER_GET_PRIVATE (manager);
+}
+
+GtkWidget *
+e_mail_account_manager_new (EMailAccountStore *store)
+{
+	g_return_val_if_fail (E_IS_MAIL_ACCOUNT_STORE (store), NULL);
+
+	return g_object_new (
+		E_TYPE_MAIL_ACCOUNT_MANAGER,
+		"store", store, NULL);
+}
+
+EMailAccountStore *
+e_mail_account_manager_get_store (EMailAccountManager *manager)
+{
+	g_return_val_if_fail (E_IS_MAIL_ACCOUNT_MANAGER (manager), NULL);
+
+	return manager->priv->store;
+}
+
+void
+e_mail_account_manager_add_account (EMailAccountManager *manager)
+{
+	g_return_if_fail (E_IS_MAIL_ACCOUNT_MANAGER (manager));
+
+	g_signal_emit (manager, signals[ADD_ACCOUNT], 0);
+}
+
+void
+e_mail_account_manager_edit_account (EMailAccountManager *manager,
+                                     EAccount *account)
+{
+	g_return_if_fail (E_IS_MAIL_ACCOUNT_MANAGER (manager));
+	g_return_if_fail (E_IS_ACCOUNT (account));
+
+	g_signal_emit (manager, signals[EDIT_ACCOUNT], 0, account);
+}
+