path: root/camel/providers/local/camel-local-summary.c

/* -*- Mode: C; tab-width: 8; indent-tabs-mode: t; c-basic-offset: 8; fill-column: 160 -*- */
/*
 *  Copyright (C) 2000 Ximian Inc.
 *
 *  Authors: Michael Zucchi <notzed@ximian.com>
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of version 2 of the GNU General Public
 * License as published by the Free Software Foundation.
 *
 * 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.
 */

#ifdef HAVE_CONFIG_H
#include <config.h>
#endif

#include <ctype.h>
#include <sys/stat.h>
#include <sys/uio.h>
#include <unistd.h>
#include <errno.h>
#include <string.h>
#include <stdlib.h>

#include "camel-local-summary.h"
#include "camel/camel-mime-message.h"
#include "camel/camel-stream-null.h"
#include "camel/camel-file-utils.h"

#define w(x)
#define io(x)
#define d(x) /*(printf("%s(%d): ", __FILE__, __LINE__),(x))*/

#define CAMEL_LOCAL_SUMMARY_VERSION (1)

static int summary_header_load (CamelFolderSummary *, FILE *);
static int summary_header_save (CamelFolderSummary *, FILE *);

static CamelMessageInfo * message_info_new (CamelFolderSummary *, struct _camel_header_raw *);

static int local_summary_decode_x_evolution(CamelLocalSummary *cls, const char *xev, CamelMessageInfo *mi);
static char *local_summary_encode_x_evolution(CamelLocalSummary *cls, const CamelMessageInfo *mi);

static int local_summary_load(CamelLocalSummary *cls, int forceindex, CamelException *ex);
static int local_summary_check(CamelLocalSummary *cls, CamelFolderChangeInfo *changeinfo, CamelException *ex);
static int local_summary_sync(CamelLocalSummary *cls, gboolean expunge, CamelFolderChangeInfo *changeinfo, CamelException *ex);
static CamelMessageInfo *local_summary_add(CamelLocalSummary *cls, CamelMimeMessage *msg, const CamelMessageInfo *info, CamelFolderChangeInfo *, CamelException *ex);

static void camel_local_summary_class_init (CamelLocalSummaryClass *klass);
static void camel_local_summary_init       (CamelLocalSummary *obj);
static void camel_local_summary_finalise   (CamelObject *obj);
static CamelFolderSummaryClass *camel_local_summary_parent;

CamelType
camel_local_summary_get_type(void)
{
    static CamelType type = CAMEL_INVALID_TYPE;
    
    if (type == CAMEL_INVALID_TYPE) {
        type = camel_type_register(camel_folder_summary_get_type(), "CamelLocalSummary",
                       sizeof (CamelLocalSummary),
                       sizeof (CamelLocalSummaryClass),
                       (CamelObjectClassInitFunc) camel_local_summary_class_init,
                       NULL,
                       (CamelObjectInitFunc) camel_local_summary_init,
                       (CamelObjectFinalizeFunc) camel_local_summary_finalise);
    }
    
    return type;
}

static void
camel_local_summary_class_init(CamelLocalSummaryClass *klass)
{
    CamelFolderSummaryClass *sklass = (CamelFolderSummaryClass *) klass;
    
    camel_local_summary_parent = CAMEL_FOLDER_SUMMARY_CLASS(camel_type_get_global_classfuncs(camel_folder_summary_get_type()));

    sklass->summary_header_load = summary_header_load;
    sklass->summary_header_save = summary_header_save;

    sklass->message_info_new  = message_info_new;

    klass->load = local_summary_load;
    klass->check = local_summary_check;
    klass->sync = local_summary_sync;
    klass->add = local_summary_add;

    klass->encode_x_evolution = local_summary_encode_x_evolution;
    klass->decode_x_evolution = local_summary_decode_x_evolution;
}

static void
camel_local_summary_init(CamelLocalSummary *obj)
{
    struct _CamelFolderSummary *s = (CamelFolderSummary *)obj;

    /* subclasses need to set the right instance data sizes */
    s->message_info_size = sizeof(CamelMessageInfo);
    s->content_info_size = sizeof(CamelMessageContentInfo);

    /* and a unique file version */
    s->version += CAMEL_LOCAL_SUMMARY_VERSION;
}

static void
camel_local_summary_finalise(CamelObject *obj)
{
    CamelLocalSummary *mbs = CAMEL_LOCAL_SUMMARY(obj);

    if (mbs->index)
        camel_object_unref((CamelObject *)mbs->index);
    g_free(mbs->folder_path);
}

void
camel_local_summary_construct(CamelLocalSummary *new, const char *filename, const char *local_name, CamelIndex *index)
{
    camel_folder_summary_set_build_content(CAMEL_FOLDER_SUMMARY(new), FALSE);
    camel_folder_summary_set_filename(CAMEL_FOLDER_SUMMARY(new), filename);
    new->folder_path = g_strdup(local_name);
    new->index = index;
    if (index)
        camel_object_ref((CamelObject *)index);
}

static int
local_summary_load(CamelLocalSummary *cls, int forceindex, CamelException *ex)
{
    return camel_folder_summary_load((CamelFolderSummary *)cls);
}

/* load/check the summary */
int
camel_local_summary_load(CamelLocalSummary *cls, int forceindex, CamelException *ex)
{
    struct stat st;
    CamelFolderSummary *s = (CamelFolderSummary *)cls;

    d(printf("Loading summary ...\n"));

    if (forceindex
        || stat(s->summary_path, &st) == -1
        || ((CamelLocalSummaryClass *)(CAMEL_OBJECT_GET_CLASS(cls)))->load(cls, forceindex, ex) == -1) {
        w(g_warning("Could not load summary: flags may be reset"));
        camel_folder_summary_clear((CamelFolderSummary *)cls);
        return -1;
    }

    return 0;
}

void camel_local_summary_check_force(CamelLocalSummary *cls)
{
    cls->check_force = 1;
}

char *
camel_local_summary_encode_x_evolution(CamelLocalSummary *cls, const CamelMessageInfo *info)
{
    return ((CamelLocalSummaryClass *)(CAMEL_OBJECT_GET_CLASS(cls)))->encode_x_evolution(cls, info);
}

int
camel_local_summary_decode_x_evolution(CamelLocalSummary *cls, const char *xev, CamelMessageInfo *info)
{
    return ((CamelLocalSummaryClass *)(CAMEL_OBJECT_GET_CLASS(cls)))->decode_x_evolution(cls, xev, info);
}

/*#define DOSTATS*/
#ifdef DOSTATS
struct _stat_info {
    int mitotal;
    int micount;
    int citotal;
    int cicount;
    int msgid;
    int msgcount;
};

static void
do_stat_ci(CamelLocalSummary *cls, struct _stat_info *info, CamelMessageContentInfo *ci)
{
    info->cicount++;
    info->citotal += ((CamelFolderSummary *)cls)->content_info_size /*+ 4 memchunks are 1/4 byte overhead per mi */;
    if (ci->id)
        info->citotal += strlen(ci->id) + 4;
    if (ci->description)
        info->citotal += strlen(ci->description) + 4;
    if (ci->encoding)
        info->citotal += strlen(ci->encoding) + 4;
    if (ci->type) {
        CamelContentType *ct = ci->type;
        struct _camel_header_param *param;

        info->citotal += sizeof(*ct) + 4;
        if (ct->type)
            info->citotal += strlen(ct->type) + 4;
        if (ct->subtype)
            info->citotal += strlen(ct->subtype) + 4;
        param = ct->params;
        while (param) {
            info->citotal += sizeof(*param) + 4;
            if (param->name)
                info->citotal += strlen(param->name)+4;
            if (param->value)
                info->citotal += strlen(param->value)+4;
            param = param->next;
        }
    }
    ci = ci->childs;
    while (ci) {
        do_stat_ci(cls, info, ci);
        ci = ci->next;
    }
}

static void
do_stat_mi(CamelLocalSummary *cls, struct _stat_info *info, CamelMessageInfo *mi)
{
    info->micount++;
    info->mitotal += ((CamelFolderSummary *)cls)->content_info_size /*+ 4*/;

    if (mi->subject)
        info->mitotal += strlen(mi->subject) + 4;
    if (mi->to)
        info->mitotal += strlen(mi->to) + 4;
    if (mi->from)
        info->mitotal += strlen(mi->from) + 4;
    if (mi->cc)
        info->mitotal += strlen(mi->cc) + 4;
    if (mi->uid)
        info->mitotal += strlen(mi->uid) + 4;

    if (mi->references) {
        info->mitotal += (mi->references->size-1) * sizeof(CamelSummaryMessageID) + sizeof(CamelSummaryReferences) + 4;
        info->msgid += (mi->references->size) * sizeof(CamelSummaryMessageID);
        info->msgcount += mi->references->size;
    }

    /* dont have any user flags yet */

    if (mi->content) {
        do_stat_ci(cls, info, mi->content);
    }
}

#endif

int
camel_local_summary_check(CamelLocalSummary *cls, CamelFolderChangeInfo *changeinfo, CamelException *ex)
{
    int ret;

    ret = ((CamelLocalSummaryClass *)(CAMEL_OBJECT_GET_CLASS(cls)))->check(cls, changeinfo, ex);

#ifdef DOSTATS
    if (ret != -1) {
        int i;
        CamelFolderSummary *s = (CamelFolderSummary *)cls;
        struct _stat_info stats = { 0 };

        for (i=0;i<camel_folder_summary_count(s);i++) {
            CamelMessageInfo *info = camel_folder_summary_index(s, i);
            do_stat_mi(cls, &stats, info);
            camel_folder_summary_info_free(s, info);
        }

        printf("\nMemory used by summary:\n\n");
        printf("Total of %d messages\n", camel_folder_summary_count(s)); 
        printf("Total: %d bytes (ave %f)\n", stats.citotal + stats.mitotal,
               (double)(stats.citotal+stats.mitotal)/(double)camel_folder_summary_count(s));
        printf("Message Info: %d (ave %f)\n", stats.mitotal, (double)stats.mitotal/(double)stats.micount);
        printf("Content Info; %d (ave %f) count %d\n", stats.citotal, (double)stats.citotal/(double)stats.cicount, stats.cicount);
        printf("message id's: %d (ave %f) count %d\n", stats.msgid, (double)stats.msgid/(double)stats.msgcount, stats.msgcount);
    }
#endif
    return ret;
}

int
camel_local_summary_sync(CamelLocalSummary *cls, gboolean expunge, CamelFolderChangeInfo *changeinfo, CamelException *ex)
{
    return ((CamelLocalSummaryClass *)(CAMEL_OBJECT_GET_CLASS(cls)))->sync(cls, expunge, changeinfo, ex);
}

CamelMessageInfo *
camel_local_summary_add(CamelLocalSummary *cls, CamelMimeMessage *msg, const CamelMessageInfo *info, CamelFolderChangeInfo *ci, CamelException *ex)
{
    return ((CamelLocalSummaryClass *)(CAMEL_OBJECT_GET_CLASS(cls)))->add(cls, msg, info, ci, ex);
}

/**
 * camel_local_summary_write_headers:
 * @fd: 
 * @header: 
 * @xevline: 
 * @status:
 * @xstatus:
 * 
 * Write a bunch of headers to the file @fd.  IF xevline is non NULL, then
 * an X-Evolution header line is created at the end of all of the headers.
 * If @status is non NULL, then a Status header line is also written.
 * The headers written are termianted with a blank line.
 * 
 * Return value: -1 on error, otherwise the number of bytes written.
 **/
int
camel_local_summary_write_headers(int fd, struct _camel_header_raw *header, const char *xevline, const char *status, const char *xstatus)
{
    int outlen = 0, len;
    int newfd;
    FILE *out;

    /* dum de dum, maybe the whole sync function should just use stdio for output */
    newfd = dup(fd);
    if (newfd == -1)
        return -1;

    out = fdopen(newfd, "w");
    if (out == NULL) {
        close(newfd);
        errno = EINVAL;
        return -1;
    }

    while (header) {
        if (strcmp(header->name, "X-Evolution") != 0
            && (status == NULL || strcmp(header->name, "Status") != 0)
            && (xstatus == NULL || strcmp(header->name, "X-Status") != 0)) {
            len = fprintf(out, "%s:%s\n", header->name, header->value);
            if (len == -1) {
                fclose(out);
                return -1;
            }
            outlen += len;
        }
        header = header->next;
    }

    if (status) {
        len = fprintf(out, "Status: %s\n", status);
        if (len == -1) {
            fclose(out);
            return -1;
        }
        outlen += len;
    }

    if (xstatus) {
        len = fprintf(out, "X-Status: %s\n", xstatus);
        if (len == -1) {
            fclose(out);
            return -1;
        }
        outlen += len;
    }

    if (xevline) {
        len = fprintf(out, "X-Evolution: %s\n", xevline);
        if (len == -1) {
            fclose(out);
            return -1;
        }
        outlen += len;
    }

    len = fprintf(out, "\n");
    if (len == -1) {
        fclose(out);
        return -1;
    }
    outlen += len;

    if (fclose(out) == -1)
        return -1;

    return outlen;
}

static int
local_summary_check(CamelLocalSummary *cls, CamelFolderChangeInfo *changeinfo, CamelException *ex)
{
    /* FIXME: sync index here ? */
    return 0;
}

static int
local_summary_sync(CamelLocalSummary *cls, gboolean expunge, CamelFolderChangeInfo *changeinfo, CamelException *ex)
{
    int ret = 0;

    ret = camel_folder_summary_save((CamelFolderSummary *)cls);
    if (ret == -1) {
        camel_exception_setv (ex, CAMEL_EXCEPTION_SYSTEM,
                      _("Could not save summary: %s: %s"),
                      cls->folder_path, g_strerror (errno));
        
        g_warning ("Could not save summary for %s: %s", cls->folder_path, strerror (errno));
    }

    if (cls->index && camel_index_sync(cls->index) == -1)
        g_warning ("Could not sync index for %s: %s", cls->folder_path, strerror (errno));

    return ret;
}

static CamelMessageInfo *
local_summary_add(CamelLocalSummary *cls, CamelMimeMessage *msg, const CamelMessageInfo *info, CamelFolderChangeInfo *ci, CamelException *ex)
{
    CamelMessageInfo *mi;
    char *xev;

    d(printf("Adding message to summary\n"));
    
    mi = camel_folder_summary_add_from_message((CamelFolderSummary *)cls, msg);
    if (mi) {
        d(printf("Added, uid = %s\n", mi->uid));
        if (info) {
            CamelTag *tag = info->user_tags;
            CamelFlag *flag = info->user_flags;

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

            mi->flags = mi->flags | (info->flags & 0xffff);
            if (info->size)
                mi->size = info->size;
        }

        /* we need to calculate the size ourselves */
        if (mi->size == 0) {
            CamelStreamNull *sn = (CamelStreamNull *)camel_stream_null_new();

            camel_data_wrapper_write_to_stream((CamelDataWrapper *)msg, (CamelStream *)sn);
            mi->size = sn->written;
            camel_object_unref((CamelObject *)sn);
        }

        mi->flags &= ~(CAMEL_MESSAGE_FOLDER_NOXEV|CAMEL_MESSAGE_FOLDER_FLAGGED);
        xev = camel_local_summary_encode_x_evolution(cls, mi);
        camel_medium_set_header((CamelMedium *)msg, "X-Evolution", xev);
        g_free(xev);
        camel_folder_change_info_add_uid(ci, camel_message_info_uid(mi));
    } else {
        d(printf("Failed!\n"));
        camel_exception_set (ex, CAMEL_EXCEPTION_SYSTEM,
                     _("Unable to add message to summary: unknown reason"));
    }
    return mi;
}

static char *
local_summary_encode_x_evolution(CamelLocalSummary *cls, const CamelMessageInfo *mi)
{
    GString *out = g_string_new("");
    struct _camel_header_param *params = NULL;
    GString *val = g_string_new("");
    CamelFlag *flag = mi->user_flags;
    CamelTag *tag = mi->user_tags;
    char *ret;
    const char *p, *uidstr;
    guint32 uid;

    /* FIXME: work out what to do with uid's that aren't stored here? */
    /* FIXME: perhaps make that a mbox folder only issue?? */
    p = uidstr = camel_message_info_uid(mi);
    while (*p && isdigit(*p))
        p++;
    if (*p == 0 && sscanf (uidstr, "%u", &uid) == 1) {
        g_string_printf (out, "%08x-%04x", uid, mi->flags & 0xffff);
    } else {
        g_string_printf (out, "%s-%04x", uidstr, mi->flags & 0xffff);
    }

    if (flag || tag) {
        val = g_string_new ("");
        
        if (flag) {
            while (flag) {
                g_string_append (val, flag->name);
                if (flag->next)
                    g_string_append_c (val, ',');
                flag = flag->next;
            }
            camel_header_set_param (&params, "flags", val->str);
            g_string_truncate (val, 0);
        }
        if (tag) {
            while (tag) {
                g_string_append (val, tag->name);
                g_string_append_c (val, '=');
                g_string_append (val, tag->value);
                if (tag->next)
                    g_string_append_c (val, ',');
                tag = tag->next;
            }
            camel_header_set_param (&params, "tags", val->str);
        }
        g_string_free (val, TRUE);
        camel_header_param_list_format_append (out, params);
        camel_header_param_list_free (params);
    }
    ret = out->str;
    g_string_free (out, FALSE);
    
    return ret;
}

static int
local_summary_decode_x_evolution(CamelLocalSummary *cls, const char *xev, CamelMessageInfo *mi)
{
    struct _camel_header_param *params, *scan;
    guint32 uid, flags;
    char *header;
    int i;

    /* check for uid/flags */
    header = camel_header_token_decode(xev);
    if (header && strlen(header) == strlen("00000000-0000")
        && sscanf(header, "%08x-%04x", &uid, &flags) == 2) {
        char uidstr[20];
        if (mi) {
            sprintf(uidstr, "%u", uid);
            camel_message_info_set_uid(mi, g_strdup(uidstr));
            mi->flags = flags;
        }
    } else {
        g_free(header);
        return -1;
    }
    g_free(header);

    if (mi == NULL)
        return 0;

    /* check for additional data */ 
    header = strchr(xev, ';');
    if (header) {
        params = camel_header_param_list_decode(header+1);
        scan = params;
        while (scan) {
            if (!strcasecmp(scan->name, "flags")) {
                char **flagv = g_strsplit(scan->value, ",", 1000);

                for (i=0;flagv[i];i++) {
                    camel_flag_set(&mi->user_flags, flagv[i], TRUE);
                }
                g_strfreev(flagv);
            } else if (!strcasecmp(scan->name, "tags")) {
                char **tagv = g_strsplit(scan->value, ",", 10000);
                char *val;

                for (i=0;tagv[i];i++) {
                    val = strchr(tagv[i], '=');
                    if (val) {
                        *val++ = 0;
                        camel_tag_set(&mi->user_tags, tagv[i], val);
                        val[-1]='=';
                    }
                }
                g_strfreev(tagv);
            }
            scan = scan->next;
        }
        camel_header_param_list_free(params);
    }
    return 0;
}

static int
summary_header_load(CamelFolderSummary *s, FILE *in)
{
    CamelLocalSummary *cls = (CamelLocalSummary *)s;

    /* We dont actually add our own headers, but version that we don't anyway */

    if (((CamelFolderSummaryClass *)camel_local_summary_parent)->summary_header_load(s, in) == -1)
        return -1;

    /* Legacy version, version is in summary only */
    if ((s->version & 0xfff) == 0x20c)
        return 0;

    /* otherwise load the version number */
    return camel_file_util_decode_fixed_int32(in, &cls->version);
}

static int
summary_header_save(CamelFolderSummary *s, FILE *out)
{
    /*CamelLocalSummary *cls = (CamelLocalSummary *)s;*/

    if (((CamelFolderSummaryClass *)camel_local_summary_parent)->summary_header_save(s, out) == -1)
        return -1;

    return camel_file_util_encode_fixed_int32(out, CAMEL_LOCAL_SUMMARY_VERSION);
}

static CamelMessageInfo *
message_info_new(CamelFolderSummary *s, struct _camel_header_raw *h)
{
    CamelMessageInfo *mi;
    CamelLocalSummary *cls = (CamelLocalSummary *)s;

    mi = ((CamelFolderSummaryClass *)camel_local_summary_parent)->message_info_new(s, h);
    if (mi) {
        const char *xev;
        int doindex = FALSE;

        xev = camel_header_raw_find(&h, "X-Evolution", NULL);
        if (xev==NULL || camel_local_summary_decode_x_evolution(cls, xev, mi) == -1) {
            /* to indicate it has no xev header */
            mi->flags |= CAMEL_MESSAGE_FOLDER_FLAGGED | CAMEL_MESSAGE_FOLDER_NOXEV;
            camel_message_info_set_uid(mi, camel_folder_summary_next_uid_string(s));

            /* shortcut, no need to look it up in the index library */
            doindex = TRUE;
        }
        
        if (cls->index
            && (doindex
            || cls->index_force
            || !camel_index_has_name(cls->index, camel_message_info_uid(mi)))) {
            d(printf("Am indexing message %s\n", camel_message_info_uid(mi)));
            camel_folder_summary_set_index(s, cls->index);
        } else {
            d(printf("Not indexing message %s\n", camel_message_info_uid(mi)));
            camel_folder_summary_set_index(s, NULL);
        }
    }
    
    return mi;
}