path: root/camel/providers/mh/camel-mh-folder.c

/* -*- Mode: C; tab-width: 8; indent-tabs-mode: t; c-basic-offset: 8; fill-column: 160 -*- */
/* camel-mh-folder.c : Abstract class for an email folder */

/* 
 * 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-mh-folder.h"
#include "camel-mh-store.h"
#include "string-utils.h"
#include "camel-stream-fs.h"
#include "camel-mh-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)

static CamelFolderClass *parent_class = NULL;

/* Returns the class for a CamelMhFolder */
#define CMHF_CLASS(so) CAMEL_MH_FOLDER_CLASS (CAMEL_OBJECT_GET_CLASS(so))
#define CF_CLASS(so) CAMEL_FOLDER_CLASS (CAMEL_OBJECT_GET_CLASS(so))
#define CMHS_CLASS(so) CAMEL_STORE_CLASS (CAMEL_OBJECT_GET_CLASS(so))

static void mh_sync(CamelFolder * folder, gboolean expunge, CamelException * ex);
static gint mh_get_message_count(CamelFolder * folder);
static gint mh_get_unread_message_count(CamelFolder * folder);
static void mh_append_message(CamelFolder * folder, CamelMimeMessage * message, const CamelMessageInfo *info, CamelException * ex);
static GPtrArray *mh_get_uids(CamelFolder * folder);
static GPtrArray *mh_get_summary(CamelFolder * folder);
static CamelMimeMessage *mh_get_message(CamelFolder * folder, const gchar * uid, CamelException * ex);

static void mh_expunge(CamelFolder * folder, CamelException * ex);

static const CamelMessageInfo *mh_get_message_info(CamelFolder * folder, const char *uid);

static GPtrArray *mh_search_by_expression(CamelFolder * folder, const char *expression, CamelException * ex);
static void mh_search_free(CamelFolder *folder, GPtrArray *result);

static guint32 mh_get_message_flags(CamelFolder * folder, const char *uid);
static void mh_set_message_flags(CamelFolder * folder, const char *uid, guint32 flags, guint32 set);
static gboolean mh_get_message_user_flag(CamelFolder * folder, const char *uid, const char *name);
static void mh_set_message_user_flag(CamelFolder * folder, const char *uid, const char *name, gboolean value);
static const char *mh_get_message_user_tag(CamelFolder *folder, const char *uid, const char *name);
static void mh_set_message_user_tag(CamelFolder *folder, const char *uid, const char *name, const char *value);

static void mh_finalize(CamelObject * object);

static void camel_mh_folder_class_init(CamelObjectClass * camel_mh_folder_class)
{
    CamelFolderClass *camel_folder_class = CAMEL_FOLDER_CLASS(camel_mh_folder_class);

    parent_class = CAMEL_FOLDER_CLASS (camel_type_get_global_classfuncs(camel_folder_get_type()));

    /* virtual method definition */

    /* virtual method overload */
    camel_folder_class->sync = mh_sync;
    camel_folder_class->get_message_count = mh_get_message_count;
    camel_folder_class->get_unread_message_count = mh_get_unread_message_count;
    camel_folder_class->append_message = mh_append_message;
    camel_folder_class->get_uids = mh_get_uids;
    camel_folder_class->free_uids = camel_folder_free_deep;
    camel_folder_class->get_summary = mh_get_summary;
    camel_folder_class->free_summary = camel_folder_free_nop;
    camel_folder_class->expunge = mh_expunge;

    camel_folder_class->get_message = mh_get_message;

    camel_folder_class->search_by_expression = mh_search_by_expression;
    camel_folder_class->search_free = mh_search_free;

    camel_folder_class->get_message_info = mh_get_message_info;

    camel_folder_class->get_message_flags = mh_get_message_flags;
    camel_folder_class->set_message_flags = mh_set_message_flags;
    camel_folder_class->get_message_user_flag = mh_get_message_user_flag;
    camel_folder_class->set_message_user_flag = mh_set_message_user_flag;
    camel_folder_class->get_message_user_tag = mh_get_message_user_tag;
    camel_folder_class->set_message_user_tag = mh_set_message_user_tag;
}

static void mh_init(gpointer object, gpointer klass)
{
    CamelFolder *folder = object;
    CamelMhFolder *mh_folder = object;

    folder->has_summary_capability = TRUE;
    folder->has_search_capability = TRUE;

    folder->permanent_flags = CAMEL_MESSAGE_ANSWERED |
        CAMEL_MESSAGE_DELETED | CAMEL_MESSAGE_DRAFT |
        CAMEL_MESSAGE_FLAGGED | CAMEL_MESSAGE_SEEN | CAMEL_MESSAGE_USER;

    mh_folder->summary = NULL;
    mh_folder->search = NULL;
}

static void mh_finalize(CamelObject * object)
{
    CamelMhFolder *mh_folder = CAMEL_MH_FOLDER(object);

    if (mh_folder->index)
        ibex_close(mh_folder->index);

    g_free(mh_folder->folder_file_path);
    g_free(mh_folder->summary_file_path);
    g_free(mh_folder->folder_dir_path);
    g_free(mh_folder->index_file_path);
}

CamelType camel_mh_folder_get_type(void)
{
    static CamelType camel_mh_folder_type = CAMEL_INVALID_TYPE;

    if (camel_mh_folder_type == CAMEL_INVALID_TYPE) {
        camel_mh_folder_type = camel_type_register(CAMEL_FOLDER_TYPE, "CamelMhFolder",
                               sizeof(CamelMhFolder),
                               sizeof(CamelMhFolderClass),
                               (CamelObjectClassInitFunc) camel_mh_folder_class_init,
                               NULL,
                               (CamelObjectInitFunc) mh_init,
                               (CamelObjectFinalizeFunc) mh_finalize);
    }

    return camel_mh_folder_type;
}

CamelFolder *
camel_mh_folder_new(CamelStore *parent_store, const char *full_name, guint32 flags, CamelException *ex)
{
    CamelFolder *folder;
    CamelMhFolder *mh_folder;
    const char *root_dir_path, *name;
    int forceindex;
    struct stat st;

    folder = CAMEL_FOLDER (camel_object_new(CAMEL_MH_FOLDER_TYPE));
    mh_folder = (CamelMhFolder *)folder;

    name = strrchr(full_name, '/');
    if (name)
        name++;
    else
        name = full_name;
    camel_folder_construct (folder, parent_store, full_name, name);

    root_dir_path = camel_mh_store_get_toplevel_dir(CAMEL_MH_STORE(folder->parent_store));

    mh_folder->folder_file_path = g_strdup_printf("%s/%s", root_dir_path, full_name);
    mh_folder->summary_file_path = g_strdup_printf("%s/%s/ev-summary", root_dir_path, full_name);
    mh_folder->folder_dir_path = g_strdup_printf("%s/%s", root_dir_path, full_name);
    mh_folder->index_file_path = g_strdup_printf("%s/%s/ev-index.ibex", root_dir_path, full_name);

    /* if we have no index file, force it */
    forceindex = stat(mh_folder->index_file_path, &st) == -1;
    /* check if we need to setup an index */
    if (flags & CAMEL_STORE_FOLDER_BODY_INDEX) {
        mh_folder->index = ibex_open(mh_folder->index_file_path, O_CREAT | O_RDWR, 0600);
        if (mh_folder->index == NULL) {
            /* yes, this isn't fatal at all */
            g_warning("Could not open/create index file: %s: indexing not performed", strerror(errno));
            forceindex = FALSE;
        }
    } else {
        /* if we do have an index file, remove it */
        if (forceindex == FALSE) {
            unlink(mh_folder->index_file_path);
        }
        forceindex = FALSE;
    }

    /* no summary (disk or memory), and we're proverbially screwed */
    mh_folder->summary = camel_mh_summary_new(mh_folder->summary_file_path,
                          mh_folder->folder_file_path,
                          mh_folder->index);

    if (camel_mh_summary_load(mh_folder->summary, forceindex) == -1) {
        camel_exception_set(ex, CAMEL_EXCEPTION_FOLDER_INVALID, /* FIXME: right error code */
                    _("Could not load or create summary"));
        camel_object_unref (CAMEL_OBJECT (folder));
        return NULL;
    }

    return folder;
}

static void mh_sync(CamelFolder * folder, gboolean expunge, CamelException * ex)
{
    CamelMhFolder *mh_folder = CAMEL_MH_FOLDER(folder);

    if (expunge)
        mh_expunge(folder, ex);
    else
        camel_mh_summary_sync(mh_folder->summary, FALSE, ex);

    /* save index */
    if (mh_folder->index)
        ibex_save(mh_folder->index);
    if (mh_folder->summary)
        camel_folder_summary_save(CAMEL_FOLDER_SUMMARY(mh_folder->summary));
}

static void mh_expunge(CamelFolder * folder, CamelException * ex)
{
    CamelMhFolder *mh = CAMEL_MH_FOLDER(folder);

    camel_mh_summary_sync(mh->summary, TRUE, ex);

    /* TODO: check it actually changed */
    camel_object_trigger_event(CAMEL_OBJECT(folder), "folder_changed", GINT_TO_POINTER (0));
}

static gint mh_get_message_count(CamelFolder * folder)
{
    CamelMhFolder *mh_folder = CAMEL_MH_FOLDER(folder);

    g_return_val_if_fail(mh_folder->summary != NULL, -1);

    return camel_folder_summary_count(CAMEL_FOLDER_SUMMARY(mh_folder->summary));
}

static gint mh_get_unread_message_count(CamelFolder * folder)
{
    CamelMhFolder *mh_folder = CAMEL_MH_FOLDER(folder);
    CamelMessageInfo *info;
    GPtrArray *infolist;
    gint i, count = 0;

    g_return_val_if_fail(mh_folder->summary != NULL, -1);

    infolist = mh_get_summary(folder);

    for (i = 0; i < infolist->len; i++) {
        info = (CamelMessageInfo *) g_ptr_array_index(infolist, i);
        if (!(info->flags & CAMEL_MESSAGE_SEEN))
            count++;
    }

    return count;
}

static void mh_append_message(CamelFolder * folder, CamelMimeMessage * message, const CamelMessageInfo *info, CamelException * ex)
{
    CamelMhFolder *mh_folder = CAMEL_MH_FOLDER(folder);
    CamelStream *output_stream = NULL;
    char *name = NULL;
    char *uid = NULL;
    CamelMessageInfo *newinfo;

    /* FIXME: probably needs additional locking */

    /* keep trying uid's until we find one thats ok */
    do {
        g_free(uid);
        g_free(name);
        uid = camel_folder_summary_next_uid_string((CamelFolderSummary *)mh_folder->summary);
        name = g_strdup_printf("%s/%s", mh_folder->folder_file_path, uid);
        output_stream = camel_stream_fs_new_with_name(name, O_WRONLY|O_CREAT|O_EXCL, 0600);
    } while (output_stream == NULL && errno == EEXIST);

    if (output_stream == NULL)
        goto fail;

    /* write the message */
    if (camel_data_wrapper_write_to_stream(CAMEL_DATA_WRAPPER(message), output_stream) == -1)
        goto fail;

    if (camel_stream_close(output_stream) == -1)
        goto fail;

    /* index/summarise the message.  Yes this re-reads it, its just simpler */
    camel_mh_summary_add(mh_folder->summary, uid, TRUE);

    if (info
        && (newinfo = camel_folder_summary_uid(CAMEL_FOLDER_SUMMARY(mh_folder->summary), uid))) {
        CamelFlag *flag = info->user_flags;
        CamelTag *tag = info->user_tags;

        newinfo->flags = info->flags;
        while (flag) {
            camel_flag_set(&newinfo->user_flags, flag->name, TRUE);
            flag = flag->next;
        }
        while (tag) {
            camel_tag_set(&newinfo->user_tags, tag->name, tag->value);
            tag = tag->next;
        }
    }

    camel_object_trigger_event(CAMEL_OBJECT(folder), "folder_changed", GPOINTER_TO_INT (0));
    g_free(name);
    g_free(uid);
    return;

fail:
    if (camel_exception_is_set(ex)) {
        camel_exception_setv(ex, camel_exception_get_id(ex),
                     _("Cannot append message to mh folder: %s"), camel_exception_get_description(ex));
    } else {
        camel_exception_setv(ex, CAMEL_EXCEPTION_SYSTEM,
                     _("Cannot append message to mh folder: %s"), g_strerror(errno));
    }
    if (output_stream)
        camel_object_unref(CAMEL_OBJECT(output_stream));
    if (name) {
        unlink(name);
        g_free(name);
    }
    g_free(uid);
}

static GPtrArray *mh_get_uids(CamelFolder * folder)
{
    GPtrArray *array;
    CamelMhFolder *mh_folder = CAMEL_MH_FOLDER(folder);
    int i, count;

    count = camel_folder_summary_count(CAMEL_FOLDER_SUMMARY(mh_folder->summary));
    array = g_ptr_array_new();
    g_ptr_array_set_size(array, count);
    for (i = 0; i < count; i++) {
        CamelMessageInfo *info =
            camel_folder_summary_index(CAMEL_FOLDER_SUMMARY(mh_folder->summary), i);

        array->pdata[i] = g_strdup(info->uid);
    }

    return array;
}

static CamelMimeMessage *mh_get_message(CamelFolder * folder, const gchar * uid, CamelException * ex)
{
    CamelMhFolder *mh_folder = CAMEL_MH_FOLDER(folder);
    CamelStream *message_stream = NULL;
    CamelMimeMessage *message = NULL;
    CamelMessageInfo *info;
    char *name;

    name = g_strdup_printf("%s/%s", mh_folder->folder_file_path, uid);

    /* get the message summary info */
    info = camel_folder_summary_uid(CAMEL_FOLDER_SUMMARY(mh_folder->summary), uid);

    if (info == NULL) {
        errno = ENOENT;
        goto fail;
    }

    message_stream = camel_stream_fs_new_with_name(name, O_RDONLY, 0);

    /* where we read from */
    if (message_stream == NULL)
        goto fail;

    message = camel_mime_message_new();
    if (camel_data_wrapper_construct_from_stream(CAMEL_DATA_WRAPPER(message), message_stream) == -1) {
        g_warning("Construction failed");
        errno = EINVAL;
        goto fail;
    }
    camel_object_unref(CAMEL_OBJECT(message_stream));
    g_free(name);

    return message;

fail:
    camel_exception_setv(ex, CAMEL_EXCEPTION_FOLDER_INVALID_UID, _("Cannot get message: %s\n  %s"),
                 name, g_strerror(errno));

    if (message_stream)
        camel_object_unref(CAMEL_OBJECT(message_stream));

    if (message)
        camel_object_unref(CAMEL_OBJECT(message));

    g_free(name);

    return NULL;
}

GPtrArray *mh_get_summary(CamelFolder * folder)
{
    CamelMhFolder *mh_folder = CAMEL_MH_FOLDER(folder);

    return CAMEL_FOLDER_SUMMARY(mh_folder->summary)->messages;
}

/* get a single message info, by uid */
static const CamelMessageInfo *mh_get_message_info(CamelFolder * folder, const char *uid)
{
    CamelMhFolder *mh_folder = CAMEL_MH_FOLDER(folder);

    return camel_folder_summary_uid(CAMEL_FOLDER_SUMMARY(mh_folder->summary), uid);
}

static GPtrArray *mh_search_by_expression(CamelFolder * folder, const char *expression, CamelException * ex)
{
    CamelMhFolder *mh_folder = CAMEL_MH_FOLDER(folder);

    if (mh_folder->search == NULL) {
        mh_folder->search = camel_folder_search_new();
    }

    camel_folder_search_set_folder(mh_folder->search, folder);
    if (mh_folder->summary) {
        /* FIXME: dont access summary array directly? */
        camel_folder_search_set_summary(mh_folder->search,
                        CAMEL_FOLDER_SUMMARY(mh_folder->summary)->messages);
    }

    camel_folder_search_set_body_index(mh_folder->search, mh_folder->index);

    return camel_folder_search_execute_expression(mh_folder->search, expression, ex);
}

static void mh_search_free(CamelFolder *folder, GPtrArray *result)
{
    CamelMhFolder *mh_folder = CAMEL_MH_FOLDER (folder);

    camel_folder_search_free_result(mh_folder->search, result);
}

static guint32 mh_get_message_flags(CamelFolder * folder, const char *uid)
{
    CamelMessageInfo *info;
    CamelMhFolder *mf = CAMEL_MH_FOLDER(folder);

    info = camel_folder_summary_uid(CAMEL_FOLDER_SUMMARY(mf->summary), uid);
    g_return_val_if_fail(info != NULL, 0);

    return info->flags;
}

static void mh_set_message_flags(CamelFolder * folder, const char *uid, guint32 flags, guint32 set)
{
    CamelMessageInfo *info;
    CamelMhFolder *mf = CAMEL_MH_FOLDER(folder);

    info = camel_folder_summary_uid(CAMEL_FOLDER_SUMMARY(mf->summary), uid);
    g_return_if_fail(info != NULL);

    info->flags = (info->flags & ~flags) | (set & flags) | CAMEL_MESSAGE_FOLDER_FLAGGED;
    camel_folder_summary_touch(CAMEL_FOLDER_SUMMARY(mf->summary));

    camel_object_trigger_event (CAMEL_OBJECT(folder), "message_changed", (char *) uid);
}

static gboolean mh_get_message_user_flag(CamelFolder * folder, const char *uid, const char *name)
{
    CamelMessageInfo *info;
    CamelMhFolder *mf = CAMEL_MH_FOLDER(folder);

    info = camel_folder_summary_uid(CAMEL_FOLDER_SUMMARY(mf->summary), uid);
    g_return_val_if_fail(info != NULL, FALSE);

    return camel_flag_get(&info->user_flags, name);
}

static void mh_set_message_user_flag(CamelFolder * folder, const char *uid, const char *name, gboolean value)
{
    CamelMessageInfo *info;
    CamelMhFolder *mf = CAMEL_MH_FOLDER(folder);

    info = camel_folder_summary_uid(CAMEL_FOLDER_SUMMARY(mf->summary), uid);
    g_return_if_fail(info != NULL);

    camel_flag_set(&info->user_flags, name, value);
    info->flags |= CAMEL_MESSAGE_FOLDER_FLAGGED;
    camel_folder_summary_touch(CAMEL_FOLDER_SUMMARY(mf->summary));
    camel_object_trigger_event (CAMEL_OBJECT(folder), "message_changed", (char *) uid);
}

static const char *mh_get_message_user_tag(CamelFolder *folder, const char *uid, const char *name)
{
    CamelMessageInfo *info;
    CamelMhFolder *mf = CAMEL_MH_FOLDER(folder);

    info = camel_folder_summary_uid(CAMEL_FOLDER_SUMMARY(mf->summary), uid);
    g_return_val_if_fail(info != NULL, FALSE);

    return camel_tag_get(&info->user_tags, name);
}

static void mh_set_message_user_tag(CamelFolder *folder, const char *uid, const char *name, const char *value)
{
    CamelMessageInfo *info;
    CamelMhFolder *mf = CAMEL_MH_FOLDER(folder);

    info = camel_folder_summary_uid(CAMEL_FOLDER_SUMMARY(mf->summary), uid);
    g_return_if_fail(info != NULL);

    camel_tag_set(&info->user_tags, name, value);
    info->flags |= CAMEL_MESSAGE_FOLDER_FLAGGED;
    camel_folder_summary_touch(CAMEL_FOLDER_SUMMARY(mf->summary));
    camel_object_trigger_event(CAMEL_OBJECT(folder), "message_changed", (char *) uid);
}