Rewrite the mail label code from top to bottom.

  - Kill the e-util-labels API and read label information into a
    single-column GtkListStore.  Use GConfBridge to automatically
    keep GConf synched with the list store.

  - The list store (a singleton instance) is stored in EShellSettings
    so it's available everywhere.

  - The list store serves as the model for EMailLabelTreeView,
    which itself is embedded in EMailLabelManager; a complete
    label management UI as seen in the preferences dialog.

  - EMailLabelDialog is used to add or edit a label.  Avoid using a
    color button, instead embed a GtkColorSelection directly in the
    dialog so everything is in one window.

Open issues:

  - The weird toggle/color/text menu items in the popup menu aren't
    there.  For now they're just regular toggle items.  I'll deal
    with it later.

  - Filter intergration is broken at the moment.


svn path=/branches/kill-bonobo/; revision=37233

1 files changed, 513 insertions, 0 deletions

diff --git a/mail/e-mail-label-list-store.c b/mail/e-mail-label-list-store.c
new file mode 100644
index 0000000000..3892838aaf
--- /dev/null
+++ b/mail/e-mail-label-list-store.c
@@ -0,0 +1,513 @@
+/*
+ * e-mail-label-list-store.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/>  
+ *
+ *
+ * Copyright (C) 1999-2008 Novell, Inc. (www.novell.com)
+ *
+ */
+
+#include "e-mail-label-list-store.h"
+
+#include <glib/gi18n.h>
+#include <camel/camel-utf8.h>
+#include "e-util/gconf-bridge.h"
+
+#define E_MAIL_LABEL_LIST_STORE_GET_PRIVATE(obj) \
+	(G_TYPE_INSTANCE_GET_PRIVATE \
+	((obj), E_TYPE_MAIL_LABEL_LIST_STORE, EMailLabelListStorePrivate))
+
+struct _EMailLabelListStorePrivate {
+	GHashTable *tag_index;
+};
+
+static struct {
+	const gchar *label_name;
+	const gchar *label_color;
+	const gchar *label_tag;
+} label_defaults[] = {
+	{ N_("I_mportant"), "#EF2929", "$Labelimportant" },	/* red */
+	{ N_("_Work"),      "#F57900", "$Labelwork" },		/* orange */
+	{ N_("_Personal"),  "#4E9A06", "$Labelpersonal" },	/* green */
+	{ N_("_To Do"),     "#3465A4", "$Labeltodo" },		/* blue */
+	{ N_("_Later"),     "#75507B", "$Labellater" }		/* purple */
+};
+
+static gpointer parent_class;
+
+static gchar *
+mail_label_list_store_tag_from_name (const gchar *label_name)
+{
+	gchar *label_tag;
+	gchar *temp;
+
+	/* Thunderbird compatible */
+	temp = g_ascii_strdown (label_name, -1);
+	g_strdelimit (temp, " ()/{%*<>\\\"", '_');
+	label_tag = camel_utf8_utf7 (temp);
+	g_free (temp);
+
+	return label_tag;
+}
+
+static gchar *
+mail_label_list_store_encode_label (const gchar *label_name,
+                                      const gchar *label_color,
+                                      const gchar *label_tag)
+{
+	GString *string;
+
+	/* Encoded Form: <name> ':' <color> [ '|' <tag> ] */
+
+	string = g_string_new (label_name);
+	g_string_append_printf (string, ":%s", label_color);
+
+	if (label_tag != NULL)
+		g_string_append_printf (string, "|%s", label_tag);
+
+	return g_string_free (string, FALSE);
+}
+
+static void
+mail_label_list_store_ensure_defaults (EMailLabelListStore *store)
+{
+	gint ii;
+
+	for (ii = 0; ii < G_N_ELEMENTS (label_defaults); ii++) {
+		GtkTreeIter iter;
+		const gchar *label_name;
+		const gchar *label_color;
+		const gchar *label_tag;
+		gchar *encoded;
+
+		label_name = gettext (label_defaults[ii].label_name);
+		label_color = label_defaults[ii].label_color;
+		label_tag = label_defaults[ii].label_tag;
+
+		encoded = mail_label_list_store_encode_label (
+			label_name, label_color, label_tag);
+
+		if (e_mail_label_list_store_lookup (store, label_tag, &iter))
+			gtk_list_store_set (
+				GTK_LIST_STORE (store),
+				&iter, 0, encoded, -1);
+		else
+			gtk_list_store_insert_with_values (
+				GTK_LIST_STORE (store),
+				NULL, -1, 0, encoded, -1);
+
+		g_free (encoded);
+	}
+}
+
+static gchar *
+mail_label_list_store_get_stock_id (EMailLabelListStore *store,
+                                    const gchar *color_spec)
+{
+	EMailLabelListStoreClass *class;
+	GtkIconFactory *icon_factory;
+	GdkColor color;
+	gchar *stock_id;
+
+	class = E_MAIL_LABEL_LIST_STORE_GET_CLASS (store);
+	icon_factory = class->icon_factory;
+
+	if (!gdk_color_parse (color_spec, &color))
+		return NULL;
+
+	stock_id = g_strdup_printf ("evolution-label-%s", color_spec);
+
+	/* Themes need not be taken into account here.
+	 * It's just a solid block of a user-chosen color. */
+	if (gtk_icon_factory_lookup (icon_factory, stock_id) == NULL) {
+		GtkIconSet *icon_set;
+		GdkPixbuf *pixbuf;
+		guint32 pixel;
+
+		pixel = ((color.red & 0xFF00) << 16) +
+			((color.green & 0xFF00) << 8) +
+			(color.blue & 0xFF00);
+
+		pixbuf = gdk_pixbuf_new (
+			GDK_COLORSPACE_RGB, FALSE, 8, 16, 16);
+		gdk_pixbuf_fill (pixbuf, pixel);
+
+		icon_set = gtk_icon_set_new_from_pixbuf (pixbuf);
+		gtk_icon_factory_add (icon_factory, stock_id, icon_set);
+		gtk_icon_set_unref (icon_set);
+
+		g_object_unref (pixbuf);
+	}
+
+	return stock_id;
+}
+
+static void
+mail_label_list_store_finalize (GObject *object)
+{
+	EMailLabelListStorePrivate *priv;
+
+	priv = E_MAIL_LABEL_LIST_STORE_GET_PRIVATE (object);
+
+	g_hash_table_destroy (priv->tag_index);
+
+	/* Chain up to parent's finalize() method. */
+	G_OBJECT_CLASS (parent_class)->finalize (object);
+}
+
+static void
+mail_label_list_store_constructed (GObject *object)
+{
+	EMailLabelListStore *store;
+	GtkTreeModel *model;
+	GConfBridge *bridge;
+	const gchar *key;
+
+	model = GTK_TREE_MODEL (object);
+	store = E_MAIL_LABEL_LIST_STORE (object);
+
+	bridge = gconf_bridge_get ();
+	key = "/apps/evolution/mail/labels";
+	gconf_bridge_bind_string_list_store (
+		bridge, key, GTK_LIST_STORE (store));
+
+	mail_label_list_store_ensure_defaults (store);
+}
+
+static void
+mail_label_list_store_row_inserted (GtkTreeModel *model,
+                                    GtkTreePath *path,
+                                    GtkTreeIter *iter)
+{
+	EMailLabelListStore *store;
+	GtkTreeRowReference *reference;
+	GHashTable *tag_index;
+	gchar *tag;
+
+	store = E_MAIL_LABEL_LIST_STORE (model);
+
+	/* Hash table takes ownership of both tag and reference. */
+	tag_index = store->priv->tag_index;
+	tag = e_mail_label_list_store_get_tag (store, iter);
+	reference = gtk_tree_row_reference_new (model, path);
+	g_hash_table_insert (tag_index, tag, reference);
+
+	/* We don't need to do anything special for row deletion.
+	 * The reference will automatically become invalid (that's
+	 * why we're storing references and not iterators or paths),
+	 * so garbage collection is not important.  We'll do it
+	 * lazily. */
+}
+
+static void
+mail_label_list_store_class_init (EMailLabelListStoreClass *class)
+{
+	GObjectClass *object_class;
+
+	parent_class = g_type_class_peek_parent (class);
+	g_type_class_add_private (class, sizeof (EMailLabelListStorePrivate));
+
+	object_class = G_OBJECT_CLASS (class);
+	object_class->finalize = mail_label_list_store_finalize;
+	object_class->constructed = mail_label_list_store_constructed;
+
+	class->icon_factory = gtk_icon_factory_new ();
+	gtk_icon_factory_add_default (class->icon_factory);
+}
+
+static void
+mail_label_list_store_init (EMailLabelListStore *store)
+{
+	GHashTable *tag_index;
+	GType type = G_TYPE_STRING;
+
+	tag_index = g_hash_table_new_full (
+		g_str_hash, g_str_equal,
+		(GDestroyNotify) g_free,
+		(GDestroyNotify) gtk_tree_row_reference_free);
+
+	store->priv = E_MAIL_LABEL_LIST_STORE_GET_PRIVATE (store);
+	store->priv->tag_index = tag_index;
+
+	/* XXX While it may seem awkward to cram the label name and color
+	 *     into a single string column, we do it for the benefit of
+	 *     letting GConfBridge keep the model in sync with GConf.
+	 *
+	 * XXX There's a valid argument to be made that this information
+	 *     doesn't belong in GConf in the first place.  A key file
+	 *     under $(user_data_dir)/mail would work better. */
+	gtk_list_store_set_column_types (GTK_LIST_STORE (store), 1, &type);
+}
+
+static void
+mail_label_list_store_iface_init (GtkTreeModelIface *iface)
+{
+	iface->row_inserted = mail_label_list_store_row_inserted;
+}
+
+GType
+e_mail_label_list_store_get_type (void)
+{
+	static GType type = 0;
+
+	if (G_UNLIKELY (type == 0)) {
+		static const GTypeInfo type_info = {
+			sizeof (EMailLabelListStoreClass),
+			(GBaseInitFunc) NULL,
+			(GBaseFinalizeFunc) NULL,
+			(GClassInitFunc) mail_label_list_store_class_init,
+			(GClassFinalizeFunc) NULL,
+			NULL,  /* class_data */
+			sizeof (EMailLabelListStore),
+			0,     /* n_preallocs */
+			(GInstanceInitFunc) mail_label_list_store_init,
+			NULL   /* vaule_table */
+		};
+
+		static const GInterfaceInfo iface_info = {
+			(GInterfaceInitFunc) mail_label_list_store_iface_init,
+			(GInterfaceFinalizeFunc) NULL,
+			NULL   /* interface_data */
+		};
+
+		type = g_type_register_static (
+			GTK_TYPE_LIST_STORE, "EMailLabelListStore",
+			&type_info, 0);
+
+		g_type_add_interface_static (
+			type, GTK_TYPE_TREE_MODEL, &iface_info);
+	}
+
+	return type;
+}
+
+EMailLabelListStore *
+e_mail_label_list_store_new (void)
+{
+	return g_object_new (E_TYPE_MAIL_LABEL_LIST_STORE, NULL);
+}
+
+gchar *
+e_mail_label_list_store_get_name (EMailLabelListStore *store,
+                                  GtkTreeIter *iter)
+{
+	gchar *encoded;
+	gchar *result;
+	gchar **strv;
+
+	/* Encoded Form: <name> ':' <color> [ '|' <tag> ] */
+
+	g_return_val_if_fail (E_IS_MAIL_LABEL_LIST_STORE (store), NULL);
+	g_return_val_if_fail (iter != NULL, NULL);
+
+	gtk_tree_model_get (GTK_TREE_MODEL (store), iter, 0, &encoded, -1);
+
+	strv = g_strsplit_set (encoded, ":|", 3);
+
+	if (g_strv_length (strv) >= 2)
+		result = g_strdup (gettext (strv[0]));
+	else
+		result = NULL;
+
+	g_strfreev (strv);
+
+	return result;
+}
+
+gboolean
+e_mail_label_list_store_get_color (EMailLabelListStore *store,
+                                   GtkTreeIter *iter,
+                                   GdkColor *color)
+{
+	gchar *encoded;
+	gchar **strv;
+	gboolean valid;
+
+	/* Encoded Form: <name> ':' <color> [ '|' <tag> ] */
+
+	g_return_val_if_fail (E_IS_MAIL_LABEL_LIST_STORE (store), FALSE);
+	g_return_val_if_fail (iter != NULL, FALSE);
+	g_return_val_if_fail (color != NULL, FALSE);
+
+	gtk_tree_model_get (GTK_TREE_MODEL (store), iter, 0, &encoded, -1);
+
+	strv = g_strsplit_set (encoded, ":|", 3);
+
+	if (g_strv_length (strv) >= 2)
+		valid = gdk_color_parse (strv[1], color);
+	else
+		valid = FALSE;
+
+	g_strfreev (strv);
+
+	return valid;
+}
+
+gchar *
+e_mail_label_list_store_get_stock_id (EMailLabelListStore *store,
+                                      GtkTreeIter *iter)
+{
+	gchar *encoded;
+	gchar *result;
+	gchar **strv;
+
+	/* Encoded Form: <name> ':' <color> [ '|' <tag> ] */
+
+	g_return_val_if_fail (E_IS_MAIL_LABEL_LIST_STORE (store), NULL);
+	g_return_val_if_fail (iter != NULL, NULL);
+	gtk_tree_model_get (GTK_TREE_MODEL (store), iter, 0, &encoded, -1);
+
+	strv = g_strsplit_set (encoded, ":|", 3);
+
+	if (g_strv_length (strv) >= 2)
+		result = mail_label_list_store_get_stock_id (store, strv[1]);
+	else
+		result = NULL;
+
+	g_strfreev (strv);
+
+	return result;
+}
+
+gchar *
+e_mail_label_list_store_get_tag (EMailLabelListStore *store,
+                                 GtkTreeIter *iter)
+{
+	gchar *encoded;
+	gchar *result;
+	gchar **strv;
+
+	/* Encoded Form: <name> ':' <color> [ '|' <tag> ] */
+
+	g_return_val_if_fail (E_IS_MAIL_LABEL_LIST_STORE (store), NULL);
+	g_return_val_if_fail (iter != NULL, NULL);
+
+	gtk_tree_model_get (GTK_TREE_MODEL (store), iter, 0, &encoded, -1);
+
+	strv = g_strsplit_set (encoded, ":|", 3);
+
+	/* XXX I guess for historical reasons the default label tags have
+	 *     a "$Label" prefix, but the default list in GConf doesn't
+	 *     include tags.  That's why the <tag> part is optional.
+	 *     So if we're missing the <tag> part, look it up in the
+	 *     hard-coded default list above.
+	 *
+	 *     Not sure I got my facts straight here.  Double check. */
+	if (g_strv_length (strv) >= 3)
+		result = g_strdup (strv[2]);
+	else {
+		gint ii;
+
+		result = NULL;
+
+		for (ii = 0; ii < G_N_ELEMENTS (label_defaults); ii++) {
+			const gchar *label_name;
+			const gchar *label_tag;
+
+			label_name = label_defaults[ii].label_name;
+			label_tag = label_defaults[ii].label_tag;
+
+			if (strcmp (strv[0], label_name) == 0) {
+				result = g_strdup (label_tag);
+				break;
+			}
+		}
+	}
+
+	g_strfreev (strv);
+
+	return result;
+}
+
+void
+e_mail_label_list_store_set (EMailLabelListStore *store,
+                             GtkTreeIter *iter,
+                             const gchar *name,
+                             const GdkColor *color)
+{
+	gchar *encoded;
+	gchar *label_color;
+	gchar *label_tag = NULL;
+
+	g_return_if_fail (E_IS_MAIL_LABEL_LIST_STORE (store));
+	g_return_if_fail (name != NULL);
+	g_return_if_fail (color != NULL);
+
+	label_color = gdk_color_to_string (color);
+
+	if (iter != NULL)
+		label_tag = e_mail_label_list_store_get_tag (store, iter);
+	if (label_tag == NULL)
+		label_tag = mail_label_list_store_tag_from_name (name);
+
+	encoded = mail_label_list_store_encode_label (
+		name, label_color, label_tag);
+
+	/* We use gtk_list_store_insert_with_values() so the data is
+	 * in place when the 'row-inserted' signal is emitted and our
+	 * row_inserted() method executes. */
+	if (iter != NULL)
+		gtk_list_store_set (
+			GTK_LIST_STORE (store), iter, 0, encoded, -1);
+	else
+		gtk_list_store_insert_with_values (
+			GTK_LIST_STORE (store), NULL, -1, 0, encoded, -1);
+
+	g_free (label_color);
+	g_free (label_tag);
+	g_free (encoded);
+}
+
+gboolean
+e_mail_label_list_store_lookup (EMailLabelListStore *store,
+                                const gchar *tag,
+                                GtkTreeIter *iter)
+{
+	GtkTreeRowReference *reference;
+	GHashTable *tag_index;
+	GtkTreeModel *model;
+	GtkTreePath *path;
+
+	g_return_val_if_fail (E_IS_MAIL_LABEL_LIST_STORE (store), FALSE);
+	g_return_val_if_fail (tag != NULL, FALSE);
+	g_return_val_if_fail (iter != NULL, FALSE);
+
+	tag_index = store->priv->tag_index;
+	reference = g_hash_table_lookup (tag_index, tag);
+
+	if (reference == NULL)
+		return FALSE;
+
+	if (!gtk_tree_row_reference_valid (reference)) {
+		/* Garbage collect the dead reference. */
+		g_hash_table_remove (tag_index, tag);
+		return FALSE;
+	}
+
+	model = gtk_tree_row_reference_get_model (reference);
+	path = gtk_tree_row_reference_get_path (reference);
+	gtk_tree_model_get_iter (model, iter, path);
+	gtk_tree_path_free (path);
+
+	return TRUE;
+}
+
+gboolean
+e_mail_label_tag_is_default (const gchar *tag)
+{
+	g_return_val_if_fail (tag != NULL, FALSE);
+
+	return g_str_has_prefix (tag, "$Label");
+}