Initial cut for local provider, to handle mh/mailbox/maildir at

	least.
	Checking in to make a backup.

svn path=/trunk/; revision=6575

1 files changed, 322 insertions, 0 deletions

diff --git a/camel/providers/local/camel-mbox-folder.c b/camel/providers/local/camel-mbox-folder.c
new file mode 100644
index 0000000000..d12b6431de
--- /dev/null
+++ b/camel/providers/local/camel-mbox-folder.c
@@ -0,0 +1,322 @@
+/* -*- Mode: C; tab-width: 8; indent-tabs-mode: t; c-basic-offset: 8; fill-column: 160 -*-
+ *
+ * Authors: Michael Zucchi <notzed@helixcode.com>
+ *
+ * Copyright (C) 1999, 2000 Helix Code Inc.
+ *
+ * This program is free software; you can redistribute it and/or 
+ * modify it under the terms of the GNU General Public License as 
+ * published by the Free Software Foundation; either version 2 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 General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
+ * USA
+ */
+
+#include <config.h>
+
+#include <stdlib.h>
+#include <sys/types.h>
+#include <dirent.h>
+#include <sys/stat.h>
+#include <unistd.h>
+#include <errno.h>
+#include <string.h>
+#include <fcntl.h>
+
+#include "camel-mbox-folder.h"
+#include "camel-mbox-store.h"
+#include "string-utils.h"
+#include "camel-stream-fs.h"
+#include "camel-mbox-summary.h"
+#include "camel-data-wrapper.h"
+#include "camel-mime-message.h"
+#include "camel-stream-filter.h"
+#include "camel-mime-filter-from.h"
+#include "camel-exception.h"
+
+#define d(x) (printf("%s(%d): ", __FILE__, __LINE__),(x))
+
+static CamelLocalFolderClass *parent_class = NULL;
+
+/* Returns the class for a CamelMboxFolder */
+#define CMBOXF_CLASS(so) CAMEL_MBOX_FOLDER_CLASS (CAMEL_OBJECT_GET_CLASS(so))
+#define CF_CLASS(so) CAMEL_FOLDER_CLASS (CAMEL_OBJECT_GET_CLASS(so))
+#define CMBOXS_CLASS(so) CAMEL_STORE_CLASS (CAMEL_OBJECT_GET_CLASS(so))
+
+
+static void mbox_append_message(CamelFolder *folder, CamelMimeMessage * message, const CamelMessageInfo * info,	CamelException *ex);
+static CamelMimeMessage *mbox_get_message(CamelFolder *folder, const gchar * uid, CamelException *ex);
+static CamelLocalSummary *mbox_create_summary(const char *path, const char *folder, ibex *index);
+
+static void mbox_finalise(CamelObject * object);
+
+static void
+camel_mbox_folder_class_init(CamelMboxFolderClass * camel_mbox_folder_class)
+{
+	CamelFolderClass *camel_folder_class = CAMEL_FOLDER_CLASS(camel_mbox_folder_class);
+	CamelLocalFolderClass *lclass = (CamelLocalFolderClass *)camel_mbox_folder_class;
+
+	parent_class = (CamelLocalFolderClass *)camel_type_get_global_classfuncs(camel_local_folder_get_type());
+
+	/* virtual method definition */
+
+	/* virtual method overload */
+	camel_folder_class->append_message = mbox_append_message;
+	camel_folder_class->get_message = mbox_get_message;
+
+	lclass->create_summary = mbox_create_summary;
+}
+
+static void
+mbox_init(gpointer object, gpointer klass)
+{
+	/*CamelFolder *folder = object;
+	  CamelMboxFolder *mbox_folder = object;*/
+}
+
+static void
+mbox_finalise(CamelObject * object)
+{
+	/*CamelMboxFolder *mbox_folder = CAMEL_MBOX_FOLDER(object);*/
+}
+
+CamelType camel_mbox_folder_get_type(void)
+{
+	static CamelType camel_mbox_folder_type = CAMEL_INVALID_TYPE;
+
+	if (camel_mbox_folder_type == CAMEL_INVALID_TYPE) {
+		camel_mbox_folder_type = camel_type_register(CAMEL_LOCAL_FOLDER_TYPE, "CamelMboxFolder",
+							     sizeof(CamelMboxFolder),
+							     sizeof(CamelMboxFolderClass),
+							     (CamelObjectClassInitFunc) camel_mbox_folder_class_init,
+							     NULL,
+							     (CamelObjectInitFunc) mbox_init,
+							     (CamelObjectFinalizeFunc) mbox_finalise);
+	}
+
+	return camel_mbox_folder_type;
+}
+
+CamelFolder *
+camel_mbox_folder_new(CamelStore *parent_store, const char *full_name, guint32 flags, CamelException *ex)
+{
+	CamelFolder *folder;
+
+	d(printf("Creating mbox folder: %s\n", full_name));
+
+	folder = (CamelFolder *)camel_object_new(CAMEL_MBOX_FOLDER_TYPE);
+	folder = (CamelFolder *)camel_local_folder_construct((CamelLocalFolder *)folder,
+							     parent_store, full_name, flags, ex);
+
+	return folder;
+}
+
+static CamelLocalSummary *mbox_create_summary(const char *path, const char *folder, ibex *index)
+{
+	return (CamelLocalSummary *)camel_mbox_summary_new(path, folder, index);
+}
+
+static void
+mbox_append_message(CamelFolder *folder, CamelMimeMessage * message, const CamelMessageInfo * info, CamelException *ex)
+{
+	CamelLocalFolder *lf = (CamelLocalFolder *)folder;
+	CamelStream *output_stream = NULL, *filter_stream = NULL;
+	CamelMimeFilter *filter_from = NULL;
+	CamelMboxSummary *mbs = (CamelMboxSummary *)lf->summary;
+	CamelMessageInfo *mi;
+	char *fromline = NULL;
+	int fd;
+	struct stat st;
+
+	/* FIXME: Locking */
+
+	d(printf("Appending message\n"));
+
+	/* first, check the summary is correct (updates folder_size too) */
+	camel_local_summary_check(lf->summary, lf->changes, ex);
+	if (camel_exception_is_set(ex))
+		return;
+
+	/* add it to the summary/assign the uid, etc */
+	mi = camel_local_summary_add(lf->summary, message, info, lf->changes, ex);
+	if (camel_exception_is_set(ex)) {
+		return;
+	}
+
+	d(printf("Appending message: uid is %s\n", mi->uid));
+
+	output_stream = camel_stream_fs_new_with_name(lf->folder_path, O_WRONLY|O_APPEND, 0600);
+	if (output_stream == NULL) {
+		camel_exception_setv(ex, 1, _("Cannot open mailbox: %s: %s\n"), lf->folder_path, strerror(errno));
+		return;
+	}
+
+	/* we must write this to the non-filtered stream ... prepend a \n if not at the start of the file */
+	fromline = camel_mbox_summary_build_from(((CamelMimePart *)message)->headers);
+	if (camel_stream_printf(output_stream, mbs->folder_size==0?"%s":"\n%s", fromline) == -1)
+		goto fail_write;
+
+	/* and write the content to the filtering stream, that translated '\nFrom' into '\n>From' */
+	filter_stream = (CamelStream *) camel_stream_filter_new_with_stream(output_stream);
+	filter_from = (CamelMimeFilter *) camel_mime_filter_from_new();
+	camel_stream_filter_add((CamelStreamFilter *) filter_stream, filter_from);
+	if (camel_data_wrapper_write_to_stream((CamelDataWrapper *)message, filter_stream) == -1)
+		goto fail_write;
+
+	if (camel_stream_close(filter_stream) == -1)
+		goto fail_write;
+
+	/* now we 'fudge' the summary  to tell it its uptodate, because its idea of uptodate has just changed */
+	/* the stat really shouldn't fail, we just wrote to it */
+	if (stat(lf->folder_path, &st) == 0) {
+		mbs->folder_size = st.st_size;
+		((CamelFolderSummary *)mbs)->time = st.st_mtime;
+	}
+
+	/* filter stream ref's the output stream itself, so we need to unref it too */
+	camel_object_unref((CamelObject *)filter_from);
+	camel_object_unref((CamelObject *)filter_stream);
+	camel_object_unref((CamelObject *)output_stream);
+	g_free(fromline);
+
+	if (camel_folder_change_info_changed(lf->changes)) {
+		camel_object_trigger_event((CamelObject *)folder, "folder_changed", lf->changes);
+		camel_folder_change_info_clear(lf->changes);
+	}
+
+	return;
+
+fail_write:
+	camel_exception_setv(ex, CAMEL_EXCEPTION_SYSTEM,
+			     _("Cannot append message to mbox file: %s: %s"), lf->folder_path, g_strerror(errno));
+
+	if (filter_stream)
+		camel_object_unref(CAMEL_OBJECT(filter_stream));
+
+	if (output_stream)
+		camel_object_unref(CAMEL_OBJECT(output_stream));
+
+	if (filter_from)
+		camel_object_unref(CAMEL_OBJECT(filter_from));
+
+	g_free(fromline);
+
+	/* reset the file to original size */
+	fd = open(lf->folder_path, O_WRONLY, 0600);
+
+	if (fd != -1) {
+		ftruncate(fd, mbs->folder_size);
+		close(fd);
+	}
+
+	/* and tell the summary its uptodate */
+	if (stat(lf->folder_path, &st) == 0) {
+		mbs->folder_size = st.st_size;
+		((CamelFolderSummary *)mbs)->time = st.st_mtime;
+	}
+
+	/* cascade the changes through, anyway, if there are any outstanding */
+	if (camel_folder_change_info_changed(lf->changes)) {
+		camel_object_trigger_event((CamelObject *)folder, "folder_changed", lf->changes);
+		camel_folder_change_info_clear(lf->changes);
+	}
+}
+
+static CamelMimeMessage *
+mbox_get_message(CamelFolder *folder, const gchar * uid, CamelException *ex)
+{
+	CamelLocalFolder *lf = (CamelLocalFolder *)folder;
+	CamelMimeMessage *message;
+	CamelMboxMessageInfo *info;
+	CamelMimeParser *parser;
+	int fd;
+	int retried = FALSE;
+	
+	d(printf("Getting message %s\n", uid));
+
+	/* FIXME: mbox locking */
+	
+retry:
+	/* get the message summary info */
+	info = (CamelMboxMessageInfo *) camel_folder_summary_uid((CamelFolderSummary *)lf->summary, uid);
+
+	if (info == NULL) {
+		camel_exception_setv(ex, CAMEL_EXCEPTION_FOLDER_INVALID_UID,
+				     _("Cannot get message: %s\n  %s"), uid, _("No such message"));
+		return NULL;
+	}
+
+	/* if this has no content, its an error in the library */
+	g_assert(info->info.content);
+	g_assert(info->frompos != -1);
+	
+	/* we use an fd instead of a normal stream here - the reason is subtle, camel_mime_part will cache
+	   the whole message in memory if the stream is non-seekable (which it is when built from a parser
+	   with no stream).  This means we dont have to lock the mbox for the life of the message. */
+
+	fd = open(lf->folder_path, O_RDONLY);
+	if (fd == -1) {
+		camel_exception_setv(ex, CAMEL_EXCEPTION_FOLDER_INVALID_UID,
+				     _("Cannot get message: %s from folder %s\n  %s"), uid, lf->folder_path,
+				     strerror(errno));
+		return NULL;
+	}
+
+	/* we use a parser to verify the message is correct, and in the correct position */
+	parser = camel_mime_parser_new();
+	camel_mime_parser_init_with_fd(parser, fd);
+	camel_mime_parser_scan_from(parser, TRUE);
+
+	camel_mime_parser_seek(parser, info->frompos, SEEK_SET);
+	if (camel_mime_parser_step(parser, NULL, NULL) != HSCAN_FROM
+	    || camel_mime_parser_tell_start_from(parser) != info->frompos) {
+
+		g_warning("Summary doesn't match the folder contents!  eek!\n"
+			  "  expecting offset %ld got %ld", (long int)info->frompos,
+			  (long int)camel_mime_parser_tell_start_from(parser));
+
+		camel_object_unref((CamelObject *)parser);
+
+		if (!retried) {
+			retried = TRUE;
+			camel_local_summary_check(lf->summary, lf->changes, ex);
+			if (!camel_exception_is_set(ex))
+				goto retry;
+		}
+
+		camel_exception_setv(ex, CAMEL_EXCEPTION_FOLDER_INVALID_UID,
+				     _("Cannot get message: %s from folder %s\n  %s"), uid, lf->folder_path,
+				     _("The folder appears to be irrecoverably corrupted."));
+
+		return NULL;
+	}
+	
+	message = camel_mime_message_new();
+	if (camel_mime_part_construct_from_parser((CamelMimePart *)message, parser) == -1) {
+		g_warning("Construction failed");
+		camel_exception_setv(ex, CAMEL_EXCEPTION_FOLDER_INVALID_UID,
+				     _("Cannot get message: %s from folder %s\n  %s"), uid, lf->folder_path,
+				     _("Message construction failed: Corrupt mailbox?"));
+		camel_object_unref((CamelObject *)parser);
+		camel_object_unref((CamelObject *)message);
+		return NULL;
+	}
+
+	camel_object_unref((CamelObject *)parser);
+	
+	/* use the opportunity to notify of changes (particularly if we had a rebuild) */
+	if (camel_folder_change_info_changed(lf->changes)) {
+		camel_object_trigger_event((CamelObject *)folder, "folder_changed", lf->changes);
+		camel_folder_change_info_clear(lf->changes);
+	}
+	
+	return message;
+}