[evolution-kolab] CamelIMAPXExtdServer: keep extension code to separate files

[Christian Hilberg <chilberg src gnome org>]

commit 5088d4cda6c8391cebc2948981d8dc65657f2029
Author: Christian Hilberg <hilberg kernelconcepts de>
Date:   Mon Jul 30 16:38:53 2012 +0200

    CamelIMAPXExtdServer: keep extension code to separate files
    
    * moving IMAP ANNOTATEMORE/METADATA code to separate
      files which implement the functional extensions
      CamelIMAPXExtdServer provides over CamelIMAPXServer
    * ACL support is supposed to be added in the same way

 src/libekolab/Makefile.am                        |    2 +
 src/libekolab/camel-imapx-extd-server-metadata.c |  215 ++++++++++++++++++++++
 src/libekolab/camel-imapx-extd-server-metadata.h |   71 +++++++
 3 files changed, 288 insertions(+), 0 deletions(-)
---
diff --git a/src/libekolab/Makefile.am b/src/libekolab/Makefile.am
index 012c163..9886b8d 100644
--- a/src/libekolab/Makefile.am
+++ b/src/libekolab/Makefile.am
@@ -38,6 +38,7 @@ libekolab_la_SOURCES =				\
 	camel-kolab-imapx-settings.c		\
 	camel-kolab-imapx-store.c		\
 	camel-kolab-session.c			\
+	camel-imapx-extd-server-metadata.c	\
 	camel-imapx-extd-server.c		\
 	camel-imapx-extd-store.c		\
 	camel-imapx-metadata.c			\
@@ -54,6 +55,7 @@ noinst_HEADERS =				\
 	camel-kolab-imapx-settings.h		\
 	camel-kolab-imapx-store.h		\
 	camel-kolab-session.h			\
+	camel-imapx-extd-server-metadata.h	\
 	camel-imapx-extd-server.h		\
 	camel-imapx-extd-store.h		\
 	camel-imapx-extd-store-friend.h		\
diff --git a/src/libekolab/camel-imapx-extd-server-metadata.c b/src/libekolab/camel-imapx-extd-server-metadata.c
new file mode 100644
index 0000000..39ffa0a
--- /dev/null
+++ b/src/libekolab/camel-imapx-extd-server-metadata.c
@@ -0,0 +1,215 @@
+/* -*- Mode: C; indent-tabs-mode: t; c-basic-offset: 8; tab-width: 8 -*- */
+/***************************************************************************
+ *            camel-imapx-extd-server-metadata.c
+ *
+ *  2012-07-27, 11:02:38
+ *  Copyright 2013, Christian Hilberg
+ *  <hilberg kernelconcepts de>
+ ****************************************************************************/
+
+/*
+ * 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.1 of the License, or (at your option) any later version.
+ *
+ * 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 main.c; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor Boston, MA 02110-1301,  USA
+ */
+
+/*----------------------------------------------------------------------------*/
+
+#ifdef HAVE_CONFIG_H
+#include <config.h>
+#endif
+
+#include <glib/gi18n.h>
+
+#include "camel-imapx-extd-store.h"
+#include "camel-imapx-extd-store-friend.h"
+#include "camel-imapx-extd-server.h"
+
+/*----------------------------------------------------------------------------*/
+
+static gboolean
+imapx_extd_server_untagged_annotation (CamelIMAPXServer *is,
+                                       GCancellable *cancellable,
+                                       GError **err);
+
+static const CamelIMAPXUntaggedRespHandlerDesc desc_annotation = {
+	IMAPX_IMAP_TOKEN_ANNOTATION,           /* untagged_response     */
+	imapx_extd_server_untagged_annotation, /* handler               */
+	NULL,                                  /* next_response         */
+	TRUE                                   /* skip_stream_when_done */
+};
+
+/*----------------------------------------------------------------------------*/
+
+static gboolean
+imapx_extd_server_untagged_annotation (CamelIMAPXServer *is,
+                                       GCancellable *cancellable,
+                                       GError **err)
+{
+	CamelIMAPXExtdStore *estore = NULL;
+	CamelImapxMetadata *md = NULL;
+	guint32 capa = 0;
+	guint32 capa_flag_id = 0;
+	GError *tmp_err = NULL;
+	gboolean parse_and_add_ok = FALSE;
+
+	g_assert (CAMEL_IS_IMAPX_SERVER (is));
+	/* cancellable may be NULL */
+	g_return_val_if_fail (err == NULL || *err == NULL, FALSE);
+
+	estore = CAMEL_IMAPX_EXTD_STORE (is->store);
+
+	/* capability check */
+	capa_flag_id =
+		camel_imapx_extd_store_get_capa_flag_id (estore,
+		                                         CAMEL_IMAPX_EXTD_STORE_CAPA_FLAG_ANNOTATEMORE);
+	capa = is->cinfo->capa & capa_flag_id;
+	if (! capa) {
+		g_set_error (err,
+		             CAMEL_IMAPX_ERROR,
+		             1, /* FIXME define and add a sensible code here */
+		             _("Got ANNOTATION response but server did not advertise ANNOTATEMORE capability"));
+		return FALSE;
+	}
+
+	md = camel_imapx_extd_store_get_md_table (estore);
+	parse_and_add_ok =
+		camel_imapx_metadata_add_from_server_response (md,
+		                                               is->stream,
+		                                               cancellable,
+		                                               &tmp_err);
+
+	if (! parse_and_add_ok) {
+		g_propagate_error (err, tmp_err);
+		return FALSE;
+	}
+
+	return TRUE;
+}
+
+/*----------------------------------------------------------------------------*/
+
+KolabGConstList*
+camel_imapx_extd_server_metadata_get_handler_descriptors (void)
+{
+	KolabGConstList *list = NULL;
+	list = kolab_util_glib_gconstlist_prepend (list,
+	                                           (gconstpointer)(&desc_annotation));
+	return list;
+}
+
+gboolean
+camel_imapx_extd_server_get_metadata (CamelIMAPXServer *is,
+                                      CamelImapxMetadataSpec *spec,
+                                      GCancellable *cancellable,
+                                      GError **err)
+{
+	CamelIMAPXCommand *ic = NULL;
+	gchar *cmd = NULL;
+	GError *tmp_err = NULL;
+	gboolean ok = FALSE;
+
+	g_assert (CAMEL_IS_IMAPX_SERVER (is));
+	g_assert (spec != NULL);
+	/* cancellable may be NULL */
+	g_return_val_if_fail (err == NULL || *err == NULL, FALSE);
+
+	/* TODO move GETANNOTATION string to -metadata.[hc]
+	 *      (add a function to return proper string depending
+	 *      on protocol type)
+	 */
+	cmd = g_strdup_printf ("%s \"%s\" \"%s\" \"%s\"",
+	                       IMAPX_IMAP_TOKEN_GETANNOTATION,
+	                       spec->mailbox_name,
+	                       spec->entry_name,
+	                       spec->attrib_name);
+
+	ic = camel_imapx_command_new (is,
+	                              IMAPX_IMAP_TOKEN_GETANNOTATION,
+	                              NULL,
+	                              cmd);
+
+	/* run GETANNOTATION command */
+	ok = camel_imapx_server_command_run (is,
+	                                     ic,
+	                                     cancellable,
+	                                     &tmp_err);
+	g_free (cmd);
+	camel_imapx_command_unref (ic);
+
+	if (! ok) {
+		g_propagate_error (err, tmp_err);
+		return FALSE;
+	}
+
+	return TRUE;
+}
+
+gboolean
+camel_imapx_extd_server_set_metadata (CamelIMAPXServer *is,
+                                      CamelImapxMetadata *md,
+                                      GCancellable *cancellable,
+                                      GError **err)
+{
+	CamelIMAPXCommand *ic = NULL;
+	GSList *commands = NULL;
+	GSList *cur_cmd = NULL;
+	GError *tmp_err = NULL;
+	gboolean ok = FALSE;
+
+	g_assert (CAMEL_IS_IMAPX_SERVER (is));
+	g_assert (md != NULL);
+	/* cancellable may be NULL */
+	g_return_val_if_fail (err == NULL || *err == NULL, FALSE);
+
+	commands = camel_imapx_metadata_new_commandlist (md);
+
+	if (commands == NULL)
+		return TRUE;
+
+	cur_cmd = commands;
+	while (cur_cmd != NULL) {
+		/* TODO move SETANNOTATION string to -metadata.[hc]
+		 *      (add a function to return proper string depending
+		 *      on protocol type)
+		 */
+		ic = camel_imapx_command_new (is,
+		                              IMAPX_IMAP_TOKEN_SETANNOTATION,
+		                              NULL,
+		                              (gchar *) cur_cmd->data);
+
+		/* TODO set more job details like priority? */
+
+		/* run SETANNOTATION command */
+		ok = camel_imapx_server_command_run (is,
+		                                     ic,
+		                                     cancellable,
+		                                     &tmp_err);
+
+		camel_imapx_command_unref (ic);
+
+		if (! ok) {
+			g_slist_free (commands);
+			g_propagate_error (err, tmp_err);
+			return FALSE;
+		}
+
+		cur_cmd = g_slist_next (cur_cmd);
+	}
+
+	g_slist_free (commands);
+
+	return TRUE;
+}
+
+/*----------------------------------------------------------------------------*/
diff --git a/src/libekolab/camel-imapx-extd-server-metadata.h b/src/libekolab/camel-imapx-extd-server-metadata.h
new file mode 100644
index 0000000..e9b6768
--- /dev/null
+++ b/src/libekolab/camel-imapx-extd-server-metadata.h
@@ -0,0 +1,71 @@
+/* -*- Mode: C; indent-tabs-mode: t; c-basic-offset: 8; tab-width: 8 -*- */
+/***************************************************************************
+ *            camel-imapx-extd-server-metadata.h
+ *
+ *  2012-07-27, 11:02:38
+ *  Copyright 2013, Christian Hilberg
+ *  <hilberg kernelconcepts de>
+ ****************************************************************************/
+
+/*
+ * 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.1 of the License, or (at your option) any later version.
+ *
+ * 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 main.c; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor Boston, MA 02110-1301,  USA
+ */
+
+/*----------------------------------------------------------------------------*/
+
+#ifndef _CAMEL_IMAPX_EXTD_SERVER_METADATA_H_
+#define _CAMEL_IMAPX_EXTD_SERVER_METADATA_H_
+
+/*----------------------------------------------------------------------------*/
+
+#include <glib.h>
+#include <glib-object.h>
+#include <gio/gio.h>
+
+#include <libekolabutil/kolab-util-glib.h>
+
+#include "camel-imapx-metadata.h"
+
+/*----------------------------------------------------------------------------*/
+
+#define IMAPX_IMAP_TOKEN_ANNOTATEMORE  "ANNOTATEMORE"
+#define IMAPX_IMAP_TOKEN_ANNOTATION    "ANNOTATION"
+#define IMAPX_IMAP_TOKEN_SETANNOTATION "SETANNOTATION"
+#define IMAPX_IMAP_TOKEN_GETANNOTATION "GETANNOTATION"
+
+/*----------------------------------------------------------------------------*/
+
+KolabGConstList*
+camel_imapx_extd_server_metadata_get_handler_descriptors (void);
+
+gboolean
+camel_imapx_extd_server_get_metadata (CamelIMAPXServer *self,
+                                      CamelImapxMetadataSpec *spec,
+                                      GCancellable *cancellable,
+                                      GError **err);
+
+gboolean
+camel_imapx_extd_server_set_metadata (CamelIMAPXServer *self,
+                                      CamelImapxMetadata *md,
+                                      GCancellable *cancellable,
+                                      GError **err);
+
+G_END_DECLS
+
+/*----------------------------------------------------------------------------*/
+
+#endif /* CAMEL_IMAPX_EXTD_SERVER_METADATA_H_ */
+
+/*----------------------------------------------------------------------------*/