aboutsummaryrefslogtreecommitdiffstats
path: root/camel/camel-store.c
blob: b4eae9975e9a975f842493708b8209c7f26bf8dd (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
/* -*- Mode: C; tab-width: 8; indent-tabs-mode: t; c-basic-offset: 8 -*- */
/* camel-store.c : Abstract class for an email store */

/* 
 *
 * Authors:
 *  Bertrand Guiheneuf <bertrand@helixcode.com>
 *  Dan Winship <danw@helixcode.com>
 *
 * Copyright 1999, 2000 Helix Code, Inc. (http://www.helixcode.com)
 *
 * 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 "camel-store.h"
#include "camel-folder.h"
#include "camel-exception.h"

static CamelServiceClass *parent_class = NULL;

/* Returns the class for a CamelStore */
#define CS_CLASS(so) CAMEL_STORE_CLASS (GTK_OBJECT(so)->klass)

static CamelFolder *get_folder (CamelStore *store, const char *folder_name,
                CamelException *ex);

static char *get_folder_name (CamelStore *store, const char *folder_name,
                  CamelException *ex);
static char *get_root_folder_name (CamelStore *store, CamelException *ex);
static char *get_default_folder_name (CamelStore *store, CamelException *ex);

static CamelFolder *lookup_folder (CamelStore *store, const char *folder_name);
static void cache_folder (CamelStore *store, const char *folder_name,
              CamelFolder *folder);
static void uncache_folder (CamelStore *store, CamelFolder *folder);

static void finalize (GtkObject *object);

static void
camel_store_class_init (CamelStoreClass *camel_store_class)
{
    GtkObjectClass *gtk_object_class =
        GTK_OBJECT_CLASS (camel_store_class);

    parent_class = gtk_type_class (camel_service_get_type ());

    /* virtual method definition */
    camel_store_class->get_folder = get_folder;
    camel_store_class->get_folder_name = get_folder_name;
    camel_store_class->get_root_folder_name = get_root_folder_name;
    camel_store_class->get_default_folder_name = get_default_folder_name;
    camel_store_class->lookup_folder = lookup_folder;
    camel_store_class->cache_folder = cache_folder;
    camel_store_class->uncache_folder = uncache_folder;

    /* virtual method override */
    gtk_object_class->finalize = finalize;
}

static void
camel_store_init (void *o, void *k)
{
    CamelStore *store = o;

    store->folders = g_hash_table_new (g_str_hash, g_str_equal);
}

GtkType
camel_store_get_type (void)
{
    static GtkType camel_store_type = 0;

    if (!camel_store_type) {
        GtkTypeInfo camel_store_info =
        {
            "CamelStore",
            sizeof (CamelStore),
            sizeof (CamelStoreClass),
            (GtkClassInitFunc) camel_store_class_init,
            (GtkObjectInitFunc) camel_store_init,
                /* reserved_1 */ NULL,
                /* reserved_2 */ NULL,
            (GtkClassInitFunc) NULL,
        };

        camel_store_type = gtk_type_unique (CAMEL_SERVICE_TYPE, &camel_store_info);
    }

    return camel_store_type;
}


static void
finalize (GtkObject *object)
{
    CamelStore *store = CAMEL_STORE (object);

    if (store->folders) {
        if (g_hash_table_size (store->folders) != 0) {
            g_warning ("Folder cache for store %p contains "
                   "%d folders at destruction.", store,
                   g_hash_table_size (store->folders));
        }
        g_hash_table_destroy (store->folders);
    }
}


static CamelFolder *
get_folder (CamelStore *store, const char *folder_name, CamelException *ex)
{
    g_warning ("CamelStore::get_folder not implemented for `%s'",
           gtk_type_name (GTK_OBJECT_TYPE (store)));
    return NULL;
}

static char *
get_folder_name (CamelStore *store, const char *folder_name,
         CamelException *ex)
{
    g_warning ("CamelStore::get_folder_name not implemented for `%s'",
           gtk_type_name (GTK_OBJECT_TYPE (store)));
    return NULL;
}

static char *
get_root_folder_name (CamelStore *store, CamelException *ex)
{
    return g_strdup ("/");
}

static char *
get_default_folder_name (CamelStore *store, CamelException *ex)
{
    return CS_CLASS (store)->get_root_folder_name (store, ex);
}

static CamelFolder *
lookup_folder (CamelStore *store, const char *folder_name)
{
    if (store->folders)
        return g_hash_table_lookup (store->folders, folder_name);
    return NULL;
}

static void
cache_folder (CamelStore *store, const char *folder_name, CamelFolder *folder)
{
    if (!store->folders)
        return;

    if (g_hash_table_lookup (store->folders, folder_name)) {
        g_warning ("Caching folder %s that already exists.",
               folder_name);
    }
    g_hash_table_insert (store->folders, (gpointer)g_strdup(folder_name), folder);
    gtk_signal_connect_object (GTK_OBJECT (folder), "destroy",
                   GTK_SIGNAL_FUNC (CS_CLASS (store)->uncache_folder),
                   GTK_OBJECT (store));
}

static void
uncache_folder (CamelStore *store, CamelFolder *folder)
{
    /* FIXME: free name index */
    g_hash_table_remove (store->folders,
                 camel_folder_get_full_name (folder));
}


static CamelFolder *
get_folder_internal (CamelStore *store, const char *folder_name,
             CamelException *ex)
{
    CamelFolder *folder = NULL;

    printf("Getting folder %p '%s'\n", store, folder_name);
    /* Try cache first. */
    folder = CS_CLASS (store)->lookup_folder (store, folder_name);

    if (folder) {
        printf("Folder cached!\n");
    } else {
        printf("Folder not cached!\n");
    }

    if (!folder) {
        folder = CS_CLASS (store)->get_folder (store, folder_name, ex);
        if (!folder)
            return NULL;

        printf("storing folder in cache: %p '%s'\n", store, folder_name);
        CS_CLASS (store)->cache_folder (store, folder_name, folder);
    }

    return folder;
}



/** 
 * camel_store_get_folder: Return the folder corresponding to a path.
 * @store: a CamelStore
 * @folder_name: name of the folder to get
 * @ex: a CamelException
 * 
 * Returns the folder corresponding to the path "name". If the path
 * begins with the separator character, it is relative to the root
 * folder. Otherwise, it is relative to the default folder. The folder
 * does not necessarily already exist on the store. To test if it
 * already exists, use its "exists" method. If it does not exist, you
 * can create it with its "create" method.
 *
 * Return value: the folder
 **/
CamelFolder *
camel_store_get_folder (CamelStore *store, const char *folder_name,
            CamelException *ex)
{
    char *name;
    CamelFolder *folder = NULL;

    name = CS_CLASS (store)->get_folder_name (store, folder_name, ex);
    if (name) {
        folder = get_folder_internal (store, name, ex);
        g_free (name);
    }
    return folder;
}


/**
 * camel_store_get_root_folder: return the top-level folder
 * 
 * Returns the folder which is at the top of the folder hierarchy.
 * This folder may or may not be the same as the default folder.
 * 
 * Return value: the top-level folder.
 **/
CamelFolder *
camel_store_get_root_folder (CamelStore *store, CamelException *ex)
{
    char *name;
    CamelFolder *folder = NULL;

    name = CS_CLASS (store)->get_root_folder_name (store, ex);
    if (name) {
        folder = get_folder_internal (store, name, ex);
        g_free (name);
    }
    return folder;
}

/** 
 * camel_store_get_default_folder: return the store default folder
 *
 * The default folder is the folder which is presented to the user in
 * the default configuration. This defaults to the root folder if
 * the store doesn't override it.
 *
 * Return value: the default folder.
 **/
CamelFolder *
camel_store_get_default_folder (CamelStore *store, CamelException *ex)
{
    char *name;
    CamelFolder *folder = NULL;

    name = CS_CLASS (store)->get_default_folder_name (store, ex);
    if (name) {
        folder = get_folder_internal (store, name, ex);
        g_free (name);
    }
    return folder;
}