Mail formatter rewrite

All mail-parsing and formatting code has been moved to em-format.
Parsing is handeled by EMailParser class, formatting by EMailFormatter.
Both classes have registry which hold extensions - simple classes
that do actual parsing and formatting. Each supported mime-type
has it's own parser and formatter extension class.

1 files changed, 294 insertions, 0 deletions

diff --git a/em-format/e-mail-extension-registry.c b/em-format/e-mail-extension-registry.c
new file mode 100644
index 0000000000..ef08761300
--- /dev/null
+++ b/em-format/e-mail-extension-registry.c
@@ -0,0 +1,294 @@
+/*
+ * e-mail-extension-registry.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 <glib-object.h>
+
+#include "e-mail-extension-registry.h"
+#include "e-mail-extension.h"
+#include "e-mail-format-extensions.h"
+#include <libebackend/libebackend.h>
+#include <camel/camel.h>
+
+#include <glib-object.h>
+
+#include <string.h>
+
+#define E_MAIL_EXTENSION_REGISTRY_GET_PRIVATE(obj) \
+	(G_TYPE_INSTANCE_GET_PRIVATE \
+	((obj), E_TYPE_MAIL_EXTENSION_REGISTRY, EMailExtensionRegistryPrivate))
+
+struct _EMailExtensionRegistryPrivate {
+	GHashTable *table;
+};
+
+static gconstpointer parent_class = 0;
+
+G_DEFINE_ABSTRACT_TYPE (
+	EMailExtensionRegistry,
+	e_mail_extension_registry,
+	G_TYPE_OBJECT)
+
+/**
+ * EMailExtensionRegistry:
+ *
+ * The #EMailExtensionRegistry is an abstract class representing a registry
+ * for #EMailExtension<!-//>s.
+ *
+ * #EMailParser and #EMailFormatter both have internally a registry object
+ * based on the #EMailExtensionRegistry.
+ *
+ * One extension can registry itself for more mime-types.
+ */
+
+static void
+mail_extension_registry_finalize (GObject *object)
+{
+	EMailExtensionRegistry *reg = E_MAIL_EXTENSION_REGISTRY (object);
+
+	if (reg->priv->table) {
+		g_hash_table_destroy (reg->priv->table);
+		reg->priv->table = NULL;
+	}
+
+	/* Chain up to parent's finalize() */
+	G_OBJECT_CLASS (parent_class)->finalize (object);
+}
+
+void
+e_mail_extension_registry_class_init (EMailExtensionRegistryClass *klass)
+{
+	GObjectClass *object_class;
+
+	g_type_class_add_private (klass, sizeof (EMailExtensionRegistryPrivate));
+
+	object_class = G_OBJECT_CLASS (klass);
+	object_class->finalize = mail_extension_registry_finalize;
+}
+
+static void
+destroy_queue (GQueue *queue)
+{
+	g_queue_free_full (queue, g_object_unref);
+}
+
+void
+e_mail_extension_registry_init (EMailExtensionRegistry *reg)
+{
+	reg->priv = E_MAIL_EXTENSION_REGISTRY_GET_PRIVATE (reg);
+
+	reg->priv->table = g_hash_table_new_full (
+		g_str_hash, g_str_equal, NULL, (GDestroyNotify) destroy_queue);
+}
+
+/**
+ * e_mail_extension_registry_add_extension:
+ * @reg: An #EMailExtensionRegistry
+ * @extension: An #EMailExtension
+ *
+ * Registrys the @extension as a handler for all mime-types that it is able
+ * to handle.
+ */
+void
+e_mail_extension_registry_add_extension (EMailExtensionRegistry *reg,
+                                         EMailExtension *extension)
+{
+	gint i;
+	const gchar **types;
+
+	g_return_if_fail (E_IS_MAIL_EXTENSION_REGISTRY (reg));
+	g_return_if_fail (E_IS_MAIL_EXTENSION (extension));
+
+	/* One reference per extension is enough */
+	g_object_ref (extension);
+
+	types = e_mail_extension_get_mime_types (extension);
+	for (i = 0; types && types[i]; i++) {
+		GQueue *queue;
+
+		queue = g_hash_table_lookup (reg->priv->table, types[i]);
+		if (!queue) {
+			queue = g_queue_new ();
+			g_queue_push_head (queue, extension);
+			g_hash_table_insert (reg->priv->table, (gchar *) types[i], queue);
+		} else {
+			g_queue_push_head (queue, extension);
+		}
+
+		if (camel_debug ("emformat:registry")) {
+			printf("Added extension '%s' for type '%s'\n",
+				 G_OBJECT_TYPE_NAME (extension), types[i]);
+		}
+	}
+}
+
+/**
+ * e_mail_extension_registry_remove_extension:
+ * @reg: An #EMailExtensionRegistry
+ * @extension: An #EMailExtension
+ *
+ * Removes @extension from the registry.
+ */
+void
+e_mail_extension_registry_remove_extension (EMailExtensionRegistry *reg,
+                                            EMailExtension *extension)
+{
+	gint i;
+	const gchar **types;
+
+	g_return_if_fail (E_IS_MAIL_EXTENSION_REGISTRY (reg));
+	g_return_if_fail (E_IS_MAIL_EXTENSION (extension));
+
+	types = e_mail_extension_get_mime_types (extension);
+	for (i = 0; types && types[i]; i++) {
+		GQueue *queue;
+
+		queue = g_hash_table_lookup (reg->priv->table, types[i]);
+		if (!queue) {
+			i++;
+			continue;
+		}
+
+		g_queue_remove (queue, extension);
+
+		if (camel_debug ("emformat:registry")) {
+			printf("Removed extension '%s' from type '%s'\n",
+				G_OBJECT_TYPE_NAME (extension), types[i]);
+		}
+	}
+
+	g_object_unref (extension);
+}
+
+/**
+ * e_mail_extension_registry_get_for_mime_type:
+ * @reg: An #EMailExtensionRegistry
+ * @mime_type: A string with mime-type to look up
+ *
+ * Tries to lookup list of #EMailExtension<!-//>s that has registryed themselves
+ * as handlers for the @mime_type.
+ *
+ * Return value: Returns #GQueue of #EMailExtension<!-//>s or %NULL when there
+ * are no extension registryed for given @mime_type.
+ */
+GQueue *
+e_mail_extension_registry_get_for_mime_type (EMailExtensionRegistry *reg,
+                                             const gchar *mime_type)
+{
+	g_return_val_if_fail (E_IS_MAIL_EXTENSION_REGISTRY (reg), NULL);
+	g_return_val_if_fail (mime_type && *mime_type, NULL);
+
+	return g_hash_table_lookup (reg->priv->table, mime_type);
+}
+
+/**
+ * e_mail_extension_registry_get_fallback:
+ * @reg: An #EMailExtensionRegistry
+ * @mime_type: A string with mime-type whose fallback to look up
+ *
+ * Tries to lookup fallback parsers for given mime type. For instance, for
+ * multipart/alternative, it will try to lookup multipart/ * parser.
+ *
+ * Return Value: Returns #QGueue of #EMailExtension<!-//>>s or %NULL when there
+ * are no extensions registryed for the fallback type.
+ */
+GQueue *
+e_mail_extension_registry_get_fallback (EMailExtensionRegistry *reg,
+                                        const gchar *mime_type)
+{
+	gchar *s, *type;
+	gsize len;
+	GQueue *parsers;
+
+	g_return_val_if_fail (E_IS_MAIL_EXTENSION_REGISTRY (reg), NULL);
+	g_return_val_if_fail (mime_type && *mime_type, NULL);
+
+	s = strchr (mime_type, '/');
+	len = s - mime_type;
+
+	s = g_alloca (len);
+	strncpy (s, mime_type, len);
+	type = g_ascii_strdown (s, len);
+	s = g_strdup_printf ("%s/*", type);
+
+	parsers = g_hash_table_lookup (reg->priv->table, s);
+
+	g_free (type);
+	g_free (s);
+
+	return parsers;
+}
+
+/******************************************************************************/
+
+static void e_mail_parser_extension_registry_extensible_interface_init (EExtensibleInterface *iface);
+
+G_DEFINE_TYPE_WITH_CODE (
+	EMailParserExtensionRegistry,
+	e_mail_parser_extension_registry,
+	E_TYPE_MAIL_EXTENSION_REGISTRY,
+	G_IMPLEMENT_INTERFACE (
+		E_TYPE_EXTENSIBLE,
+		e_mail_parser_extension_registry_extensible_interface_init));
+
+static void
+e_mail_parser_extension_registry_init (EMailParserExtensionRegistry *parser_ereg)
+{
+
+}
+
+static void
+e_mail_parser_extension_registry_class_init (EMailParserExtensionRegistryClass *klass)
+{
+	e_mail_parser_extension_registry_parent_class = g_type_class_peek_parent (klass);
+}
+
+static void
+e_mail_parser_extension_registry_extensible_interface_init (EExtensibleInterface *interface)
+{
+
+}
+
+/******************************************************************************/
+
+static void e_mail_formatter_extension_registry_extensible_interface_init (EExtensibleInterface *iface);
+
+G_DEFINE_TYPE_WITH_CODE (
+	EMailFormatterExtensionRegistry,
+	e_mail_formatter_extension_registry,
+	E_TYPE_MAIL_EXTENSION_REGISTRY,
+	G_IMPLEMENT_INTERFACE (
+		E_TYPE_EXTENSIBLE,
+		e_mail_formatter_extension_registry_extensible_interface_init));
+
+static void
+e_mail_formatter_extension_registry_init (EMailFormatterExtensionRegistry *formatter_ereg)
+{
+
+}
+
+static void
+e_mail_formatter_extension_registry_class_init (EMailFormatterExtensionRegistryClass *klass)
+{
+	e_mail_formatter_extension_registry_parent_class = g_type_class_peek_parent (klass);
+}
+
+static void
+e_mail_formatter_extension_registry_extensible_interface_init (EExtensibleInterface *interface)
+{
+
+}