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

/* -*- Mode: C; tab-width: 8; indent-tabs-mode: t; c-basic-offset: 8 -*-
 * 
 * Authors: Michael Zucchi <notzed@ximian.com>
 *
 * Copyright (C) 2000 Ximian (www.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 <stdio.h>
#include <string.h>

#include "camel-provider.h"
#include "camel-session.h"
#include "camel-url.h"

#include "camel-mh-store.h"
#include "camel-mbox-store.h"
#include "camel-maildir-store.h"
#include "camel-spool-store.h"
#include "camel-spoold-store.h"

#define d(x)

static CamelProviderConfEntry mh_conf_entries[] = {
    CAMEL_PROVIDER_CONF_DEFAULT_PATH,
    { CAMEL_PROVIDER_CONF_CHECKBOX, "dotfolders", NULL,
      N_("Use the `.folders' folder summary file (exmh)"), "0" },
    { CAMEL_PROVIDER_CONF_END }
};

static CamelProvider mh_provider = {
    "mh",
    N_("MH-format mail directories"),
    N_("For storing local mail in MH-like mail directories."),
    "mail",
    CAMEL_PROVIDER_IS_SOURCE | CAMEL_PROVIDER_IS_STORAGE | CAMEL_PROVIDER_IS_LOCAL,
    CAMEL_URL_NEED_PATH | CAMEL_URL_PATH_IS_ABSOLUTE,
    mh_conf_entries,
    /* ... */
};

static CamelProviderConfEntry mbox_conf_entries[] = {
    CAMEL_PROVIDER_CONF_DEFAULT_PATH,
    { CAMEL_PROVIDER_CONF_END }
};

static CamelProvider mbox_provider = {
    "mbox",
    N_("Local delivery"),
    N_("For retrieving local mail from standard mbox formated spools."),
    "mail",
    CAMEL_PROVIDER_IS_SOURCE | CAMEL_PROVIDER_IS_LOCAL,
    CAMEL_URL_NEED_PATH | CAMEL_URL_PATH_IS_ABSOLUTE,
    mbox_conf_entries,
    /* ... */
};

static CamelProviderConfEntry maildir_conf_entries[] = {
    CAMEL_PROVIDER_CONF_DEFAULT_PATH,
    { CAMEL_PROVIDER_CONF_CHECKBOX, "filter", NULL,
      N_("Apply filters to new messages in INBOX"), "0" },
    { CAMEL_PROVIDER_CONF_END }
};

static CamelProvider maildir_provider = {
    "maildir",
    N_("Maildir-format mail directories"),
    N_("For storing local mail in maildir directories."),
    "mail",
    CAMEL_PROVIDER_IS_SOURCE | CAMEL_PROVIDER_IS_STORAGE | CAMEL_PROVIDER_IS_LOCAL,
    CAMEL_URL_NEED_PATH | CAMEL_URL_PATH_IS_ABSOLUTE,
    maildir_conf_entries,
    /* ... */
};

static CamelProviderConfEntry spool_conf_entries[] = {
    CAMEL_PROVIDER_CONF_DEFAULT_PATH,
    { CAMEL_PROVIDER_CONF_CHECKBOX, "filter", NULL,
      N_("Apply filters to new messages in INBOX"), "0" },
    { CAMEL_PROVIDER_CONF_END }
};

static CamelProvider spool_provider = {
    "spool",
    N_("Standard Unix mbox spools"),
    N_("For reading and storing local mail in standard mbox spool files."),
    "mail",
    CAMEL_PROVIDER_IS_SOURCE | CAMEL_PROVIDER_IS_STORAGE,
    CAMEL_URL_NEED_PATH | CAMEL_URL_PATH_IS_ABSOLUTE,
    spool_conf_entries,
    /* ... */
};

static CamelProviderConfEntry spoold_conf_entries[] = {
    CAMEL_PROVIDER_CONF_DEFAULT_PATH,
    { CAMEL_PROVIDER_CONF_END }
};

static CamelProvider spoold_provider = {
    "spoold",
    N_("Directory tree of mbox files"),
    N_("For accessing mail storedin an external tree of mbox files.\nThis will allow you to directly access pine and elm folders.\nNOTE: This provider is still experimental so ensure you backup any mail folders first."),
    "mail",
    CAMEL_PROVIDER_IS_SOURCE | CAMEL_PROVIDER_IS_STORAGE | CAMEL_PROVIDER_IS_LOCAL,
    CAMEL_URL_NEED_PATH | CAMEL_URL_PATH_IS_ABSOLUTE,
    NULL,
    /* ... */
};

/* build a canonical 'path' */
static char *
make_can_path(char *p, char *o)
{
    char c, last, *start = o;

    d(printf("canonical '%s' = ", p));

    last = 0;
    while ((c = *p++)) {
        if (c!='/'
            || (c=='/' && last != '/'))
            *o++ = c;
        last = c;
    }
    if (o>start && o[-1] == '/')
        o[-1] = 0;
    else
        *o = 0;

    d(printf("'%s'\n", start));

    return start;
}

/* 'helper' function for it */
#define get_can_path(p) ((p==NULL)?NULL:(make_can_path((p), alloca(strlen(p)+1))))

static guint
local_url_hash (const void *v)
{
    const CamelURL *u = v;
    guint hash = 0;

#define ADD_HASH(s) if (s) hash ^= g_str_hash (s);

    ADD_HASH (u->protocol);
    ADD_HASH (u->user);
    ADD_HASH (u->authmech);
    ADD_HASH (u->host);
    if (u->path)
        hash ^= g_str_hash(get_can_path(u->path));
    ADD_HASH (u->path);
    ADD_HASH (u->query);
    hash ^= u->port;
    
    return hash;
}

static int
check_equal (char *s1, char *s2)
{
    if (s1 == NULL) {
        if (s2 == NULL)
            return TRUE;
        else
            return FALSE;
    }
    
    if (s2 == NULL)
        return FALSE;

    return strcmp (s1, s2) == 0;
}

static int
local_url_equal(const void *v, const void *v2)
{
    const CamelURL *u1 = v, *u2 = v2;
    char *p1, *p2;

    p1 = get_can_path(u1->path);
    p2 = get_can_path(u2->path);
    return check_equal(p1, p2)
        && check_equal(u1->protocol, u2->protocol)
        && check_equal(u1->user, u2->user)
        && check_equal(u1->authmech, u2->authmech)
        && check_equal(u1->host, u2->host)
        && check_equal(u1->query, u2->query)
        && u1->port == u2->port;
}

void camel_provider_module_init(CamelSession * session)
{
    char *path;
    
    mh_conf_entries[0].value = "";  /* default path */
    mh_provider.object_types[CAMEL_PROVIDER_STORE] = camel_mh_store_get_type ();
    mh_provider.url_hash = local_url_hash;
    mh_provider.url_equal = local_url_equal;
    camel_session_register_provider(session, &mh_provider);
    
    if (!(path = getenv ("MAIL")))
        path = g_strdup_printf (SYSTEM_MAIL_DIR "/%s", g_get_user_name ());
    mbox_conf_entries[0].value = path;  /* default path */
    mbox_provider.object_types[CAMEL_PROVIDER_STORE] = camel_mbox_store_get_type ();
    mbox_provider.url_hash = local_url_hash;
    mbox_provider.url_equal = local_url_equal;
    camel_session_register_provider(session, &mbox_provider);
    
    spool_conf_entries[0].value = path;  /* default path - same as mbox */
    spool_provider.object_types[CAMEL_PROVIDER_STORE] = camel_spool_store_get_type ();
    spool_provider.url_hash = local_url_hash;
    spool_provider.url_equal = local_url_equal;
    camel_session_register_provider(session, &spool_provider);
    
    path = getenv ("MAILDIR");
    maildir_conf_entries[0].value = path ? path : "";  /* default path */
    maildir_provider.object_types[CAMEL_PROVIDER_STORE] = camel_maildir_store_get_type ();
    maildir_provider.url_hash = local_url_hash;
    maildir_provider.url_equal = local_url_equal;
    camel_session_register_provider(session, &maildir_provider);
    
    path = g_strdup_printf ("%s/mail", g_get_home_dir ());
    spoold_conf_entries[0].value = path;  /* default path */
    spoold_provider.object_types[CAMEL_PROVIDER_STORE] = camel_spoold_store_get_type ();
    spoold_provider.url_hash = local_url_hash;
    spoold_provider.url_equal = local_url_equal;
    camel_session_register_provider(session, &spoold_provider);
}