aboutsummaryrefslogtreecommitdiffstats
path: root/camel/providers/imap/camel-imap-store-summary.c
blob: 32530d3c3f2243b2993cc3d8032c4ad2bf0e820d (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
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
/* -*- Mode: C; tab-width: 8; indent-tabs-mode: t; c-basic-offset: 8 -*- */
/*
 * Copyright (C) 2002 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 <unistd.h>
#include <ctype.h>
#include <string.h>
#include <errno.h>
#include <stdlib.h>

#include "camel-imap-store-summary.h"

#include "camel-file-utils.h"

#include "e-util/md5-utils.h"
#include "e-util/e-memory.h"

#include "camel-private.h"
#include "camel-utf8.h"

#define d(x)
#define io(x)           /* io debug */

#define CAMEL_IMAP_STORE_SUMMARY_VERSION_0 (0)

#define CAMEL_IMAP_STORE_SUMMARY_VERSION (0)

#define _PRIVATE(o) (((CamelImapStoreSummary *)(o))->priv)

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

/*static CamelStoreInfo * store_info_new(CamelStoreSummary *, const char *);*/
static CamelStoreInfo * store_info_load(CamelStoreSummary *, FILE *);
static int       store_info_save(CamelStoreSummary *, FILE *, CamelStoreInfo *);
static void      store_info_free(CamelStoreSummary *, CamelStoreInfo *);

static const char *store_info_string(CamelStoreSummary *, const CamelStoreInfo *, int);
static void store_info_set_string(CamelStoreSummary *, CamelStoreInfo *, int, const char *);

static void camel_imap_store_summary_class_init (CamelImapStoreSummaryClass *klass);
static void camel_imap_store_summary_init       (CamelImapStoreSummary *obj);
static void camel_imap_store_summary_finalise   (CamelObject *obj);

static CamelStoreSummaryClass *camel_imap_store_summary_parent;

static void
camel_imap_store_summary_class_init (CamelImapStoreSummaryClass *klass)
{
    CamelStoreSummaryClass *ssklass = (CamelStoreSummaryClass *)klass;

    ssklass->summary_header_load = summary_header_load;
    ssklass->summary_header_save = summary_header_save;

    /*ssklass->store_info_new  = store_info_new;*/
    ssklass->store_info_load = store_info_load;
    ssklass->store_info_save = store_info_save;
    ssklass->store_info_free = store_info_free;

    ssklass->store_info_string = store_info_string;
    ssklass->store_info_set_string = store_info_set_string;
}

static void
camel_imap_store_summary_init (CamelImapStoreSummary *s)
{
    /*struct _CamelImapStoreSummaryPrivate *p;

      p = _PRIVATE(s) = g_malloc0(sizeof(*p));*/

    ((CamelStoreSummary *)s)->store_info_size = sizeof(CamelImapStoreInfo);
    s->version = CAMEL_IMAP_STORE_SUMMARY_VERSION;
}

static void
camel_imap_store_summary_finalise (CamelObject *obj)
{
    /*struct _CamelImapStoreSummaryPrivate *p;*/
    /*CamelImapStoreSummary *s = (CamelImapStoreSummary *)obj;*/

    /*p = _PRIVATE(obj);
      g_free(p);*/
}

CamelType
camel_imap_store_summary_get_type (void)
{
    static CamelType type = CAMEL_INVALID_TYPE;
    
    if (type == CAMEL_INVALID_TYPE) {
        camel_imap_store_summary_parent = (CamelStoreSummaryClass *)camel_store_summary_get_type();
        type = camel_type_register((CamelType)camel_imap_store_summary_parent, "CamelImapStoreSummary",
                       sizeof (CamelImapStoreSummary),
                       sizeof (CamelImapStoreSummaryClass),
                       (CamelObjectClassInitFunc) camel_imap_store_summary_class_init,
                       NULL,
                       (CamelObjectInitFunc) camel_imap_store_summary_init,
                       (CamelObjectFinalizeFunc) camel_imap_store_summary_finalise);
    }
    
    return type;
}

/**
 * camel_imap_store_summary_new:
 *
 * Create a new CamelImapStoreSummary object.
 * 
 * Return value: A new CamelImapStoreSummary widget.
 **/
CamelImapStoreSummary *
camel_imap_store_summary_new (void)
{
    CamelImapStoreSummary *new = CAMEL_IMAP_STORE_SUMMARY ( camel_object_new (camel_imap_store_summary_get_type ()));

    return new;
}

/**
 * camel_imap_store_summary_full_name:
 * @s: 
 * @path: 
 * 
 * Retrieve a summary item by full name.
 *
 * A referenced to the summary item is returned, which may be
 * ref'd or free'd as appropriate.
 * 
 * Return value: The summary item, or NULL if the @full_name name
 * is not available.
 * It must be freed using camel_store_summary_info_free().
 **/
CamelImapStoreInfo *
camel_imap_store_summary_full_name(CamelImapStoreSummary *s, const char *full_name)
{
    int count, i;
    CamelImapStoreInfo *info;

    count = camel_store_summary_count((CamelStoreSummary *)s);
    for (i=0;i<count;i++) {
        info = (CamelImapStoreInfo *)camel_store_summary_index((CamelStoreSummary *)s, i);
        if (info) {
            if (strcmp(info->full_name, full_name) == 0)
                return info;
            camel_store_summary_info_free((CamelStoreSummary *)s, (CamelStoreInfo *)info);
        }
    }

    return NULL;
}

char *
camel_imap_store_summary_full_to_path(CamelImapStoreSummary *s, const char *full_name, char dir_sep)
{
    char *path, *p;
    int c;
    const char *f;

    if (dir_sep != '/') {
        p = path = alloca(strlen(full_name)*3+1);
        f = full_name;
        while ( (c = *f++ & 0xff) ) {
            if (c == dir_sep)
                *p++ = '/';
            else if (c == '/' || c == '%')
                p += sprintf(p, "%%%02X", c);
            else
                *p++ = c;
        }
        *p = 0;
    } else
        path = (char *)full_name;

    return camel_utf7_utf8(path);
}

static guint32 hexnib(guint32 c)
{
    if (c >= '0' && c <= '9')
        return c-'0';
    else if (c>='A' && c <= 'Z')
        return c-'A'+10;
    else
        return 0;
}

char *
camel_imap_store_summary_path_to_full(CamelImapStoreSummary *s, const char *path, char dir_sep)
{
    unsigned char *full, *f;
    guint32 c, v = 0;
    const char *p;
    int state=0;
    char *subpath, *last = NULL;
    CamelStoreInfo *si;
    CamelImapStoreNamespace *ns;

    /* check to see if we have a subpath of path already defined */
    subpath = alloca(strlen(path)+1);
    strcpy(subpath, path);
    do {
        si = camel_store_summary_path((CamelStoreSummary *)s, subpath);
        if (si == NULL) {
            last = strrchr(subpath, '/');
            if (last)
                *last = 0;
        }
    } while (si == NULL && last);

    /* path is already present, use the raw version we have */
    if (si && strlen(subpath) == strlen(path)) {
        f = g_strdup(camel_imap_store_info_full_name(s, si));
        camel_store_summary_info_free((CamelStoreSummary *)s, si);
        return f;
    }

    ns = camel_imap_store_summary_namespace_find_path(s, path);

    f = full = alloca(strlen(path)*2+1);
    if (si)
        p = path + strlen(subpath);
    else if (ns)
        p = path + strlen(ns->path);
    else
        p = path;

    while ( (c = camel_utf8_getc((const unsigned char **)&p)) ) {
        switch(state) {
        case 0:
            if (c == '%')
                state = 1;
            else {
                if (c == '/')
                    c = dir_sep;
                camel_utf8_putc(&f, c);
            }
            break;
        case 1:
            state = 2;
            v = hexnib(c)<<4;
            break;
        case 2:
            state = 0;
            v |= hexnib(c);
            camel_utf8_putc(&f, v);
            break;
        }
    }
    camel_utf8_putc(&f, c);

    /* merge old path part if required */
    f = camel_utf8_utf7(full);
    if (si) {
        full = g_strdup_printf("%s%s", camel_imap_store_info_full_name(s, si), f);
        g_free(f);
        camel_store_summary_info_free((CamelStoreSummary *)s, si);
        f = full;
    } else if (ns) {
        full = g_strdup_printf("%s%s", ns->full_name, f);
        g_free(f);
        f = full;
    }

    return f;
}

CamelImapStoreInfo *
camel_imap_store_summary_add_from_full(CamelImapStoreSummary *s, const char *full, char dir_sep)
{
    CamelImapStoreInfo *info;
    char *pathu8, *prefix;
    int len;
    char *full_name;
    CamelImapStoreNamespace *ns;

    d(printf("adding full name '%s' '%c'\n", full, dir_sep));

    len = strlen(full);
    full_name = alloca(len+1);
    strcpy(full_name, full);
    if (full_name[len-1] == dir_sep)
        full_name[len-1] = 0;

    info = camel_imap_store_summary_full_name(s, full_name);
    if (info) {
        camel_store_summary_info_free((CamelStoreSummary *)s, (CamelStoreInfo *)info);
        d(printf("  already there\n"));
        return info;
    }

    ns = camel_imap_store_summary_namespace_find_full(s, full_name);
    if (ns) {
        d(printf("(found namespace for '%s' ns '%s') ", full_name, ns->path));
        len = strlen(ns->full_name);
        if (len >= strlen(full_name)) {
            pathu8 = g_strdup(ns->path);
        } else {
            if (full_name[len] == ns->sep)
                len++;
            
            prefix = camel_imap_store_summary_full_to_path(s, full_name+len, ns->sep);
            if (*ns->path) {
                pathu8 = g_strdup_printf ("%s/%s", ns->path, prefix);
                g_free (prefix);
            } else {
                pathu8 = prefix;
            }
        }
        d(printf(" (pathu8 = '%s')", pathu8));
    } else {
        d(printf("(Cannot find namespace for '%s')\n", full_name));
        pathu8 = camel_imap_store_summary_full_to_path(s, full_name, dir_sep);
    }

    info = (CamelImapStoreInfo *)camel_store_summary_add_from_path((CamelStoreSummary *)s, pathu8);
    if (info) {
        d(printf("  '%s' -> '%s'\n", pathu8, full_name));
        camel_store_info_set_string((CamelStoreSummary *)s, (CamelStoreInfo *)info, CAMEL_IMAP_STORE_INFO_FULL_NAME, full_name);
    } else
        d(printf("  failed\n"));

    return info;
}

/* should this be const? */
/* TODO: deprecate/merge this function with path_to_full */
char *
camel_imap_store_summary_full_from_path(CamelImapStoreSummary *s, const char *path)
{
    CamelImapStoreNamespace *ns;
    char *name = NULL;

    ns = camel_imap_store_summary_namespace_find_path(s, path);
    if (ns)
        name = camel_imap_store_summary_path_to_full(s, path, ns->sep);

    d(printf("looking up path %s -> %s\n", path, name?name:"not found"));

    return name;
}

/* TODO: this api needs some more work */
CamelImapStoreNamespace *camel_imap_store_summary_namespace_new(CamelImapStoreSummary *s, const char *full_name, char dir_sep)
{
    CamelImapStoreNamespace *ns;
    char *p, *o, c;
    int len;

    ns = g_malloc0(sizeof(*ns));
    ns->full_name = g_strdup(full_name);
    len = strlen(ns->full_name)-1;
    if (len >= 0 && ns->full_name[len] == dir_sep)
        ns->full_name[len] = 0;
    ns->sep = dir_sep;

    o = p = ns->path = camel_imap_store_summary_full_to_path(s, ns->full_name, dir_sep);
    while ((c = *p++)) {
        if (c != '#') {
            if (c == '/')
                c = '.';
            *o++ = c;
        }
    }
    *o = 0;

    return ns;
}

void camel_imap_store_summary_namespace_set(CamelImapStoreSummary *s, CamelImapStoreNamespace *ns)
{
    static void namespace_clear(CamelStoreSummary *s);

    d(printf("Setting namesapce to '%s' '%c' -> '%s'\n", ns->full_name, ns->sep, ns->path));
    namespace_clear((CamelStoreSummary *)s);
    s->namespace = ns;
    camel_store_summary_touch((CamelStoreSummary *)s);
}

CamelImapStoreNamespace *
camel_imap_store_summary_namespace_find_path(CamelImapStoreSummary *s, const char *path)
{
    int len;
    CamelImapStoreNamespace *ns;

    /* NB: this currently only compares against 1 namespace, in future compare against others */
    ns = s->namespace;
    while (ns) {
        len = strlen(ns->path);
        if (len == 0
            || (strncmp(ns->path, path, len) == 0
            && (path[len] == '/' || path[len] == 0)))
            break;
        ns = NULL;
    }

    /* have a default? */
    return ns;
}

CamelImapStoreNamespace *
camel_imap_store_summary_namespace_find_full(CamelImapStoreSummary *s, const char *full)
{
    int len;
    CamelImapStoreNamespace *ns;

    /* NB: this currently only compares against 1 namespace, in future compare against others */
    ns = s->namespace;
    while (ns) {
        len = strlen(ns->full_name);
        d(printf("find_full: comparing namespace '%s' to name '%s'\n", ns->full_name, full));
        if (len == 0
            || (strncmp(ns->full_name, full, len) == 0
            && (full[len] == ns->sep || full[len] == 0)))
            break;
        ns = NULL;
    }

    /* have a default? */
    return ns;
}

static void
namespace_free(CamelStoreSummary *s, CamelImapStoreNamespace *ns)
{
    g_free(ns->path);
    g_free(ns->full_name);
    g_free(ns);
}

static void
namespace_clear(CamelStoreSummary *s)
{
    CamelImapStoreSummary *is = (CamelImapStoreSummary *)s;

    if (is->namespace)
        namespace_free(s, is->namespace);
    is->namespace = NULL;
}

static CamelImapStoreNamespace *
namespace_load(CamelStoreSummary *s, FILE *in)
{
    CamelImapStoreNamespace *ns;
    guint32 sep = '/';

    ns = g_malloc0(sizeof(*ns));
    if (camel_file_util_decode_string(in, &ns->path) == -1
        || camel_file_util_decode_string(in, &ns->full_name) == -1
        || camel_file_util_decode_uint32(in, &sep) == -1) {
        namespace_free(s, ns);
        ns = NULL;
    } else {
        ns->sep = sep;
    }

    return ns;
}

static int
namespace_save(CamelStoreSummary *s, FILE *in, CamelImapStoreNamespace *ns)
{
    if (camel_file_util_encode_string(in, ns->path) == -1
        || camel_file_util_encode_string(in, ns->full_name) == -1
        || camel_file_util_encode_uint32(in, (guint32)ns->sep) == -1)
        return -1;

    return 0;
}

static int
summary_header_load(CamelStoreSummary *s, FILE *in)
{
    CamelImapStoreSummary *is = (CamelImapStoreSummary *)s;
    gint32 version, capabilities, count;

    namespace_clear(s);

    if (camel_imap_store_summary_parent->summary_header_load((CamelStoreSummary *)s, in) == -1
        || camel_file_util_decode_fixed_int32(in, &version) == -1)
        return -1;

    is->version = version;

    if (version < CAMEL_IMAP_STORE_SUMMARY_VERSION_0) {
        g_warning("Store summary header version too low");
        return -1;
    }

    /* note file format can be expanded to contain more namespaces, but only 1 at the moment */
    if (camel_file_util_decode_fixed_int32(in, &capabilities) == -1
        || camel_file_util_decode_fixed_int32(in, &count) == -1
        || count > 1)
        return -1;

    is->capabilities = capabilities;
    if (count == 1) {
        if ((is->namespace = namespace_load(s, in)) == NULL)
            return -1;
    }

    return 0;
}

static int
summary_header_save(CamelStoreSummary *s, FILE *out)
{
    CamelImapStoreSummary *is = (CamelImapStoreSummary *)s;
    guint32 count;

    count = is->namespace?1:0;

    /* always write as latest version */
    if (camel_imap_store_summary_parent->summary_header_save((CamelStoreSummary *)s, out) == -1
        || camel_file_util_encode_fixed_int32(out, CAMEL_IMAP_STORE_SUMMARY_VERSION) == -1
        || camel_file_util_encode_fixed_int32(out, is->capabilities) == -1
        || camel_file_util_encode_fixed_int32(out, count) == -1)        
        return -1;

    if (is->namespace && namespace_save(s, out, is->namespace) == -1)
        return -1;

    return 0;
}

static CamelStoreInfo *
store_info_load(CamelStoreSummary *s, FILE *in)
{
    CamelImapStoreInfo *mi;

    mi = (CamelImapStoreInfo *)camel_imap_store_summary_parent->store_info_load(s, in);
    if (mi) {
        if (camel_file_util_decode_string(in, &mi->full_name) == -1) {
            camel_store_summary_info_free(s, (CamelStoreInfo *)mi);
            mi = NULL;
        }
    }

    return (CamelStoreInfo *)mi;
}

static int
store_info_save(CamelStoreSummary *s, FILE *out, CamelStoreInfo *mi)
{
    CamelImapStoreInfo *isi = (CamelImapStoreInfo *)mi;

    if (camel_imap_store_summary_parent->store_info_save(s, out, mi) == -1
        || camel_file_util_encode_string(out, isi->full_name) == -1)
        return -1;

    return 0;
}

static void
store_info_free(CamelStoreSummary *s, CamelStoreInfo *mi)
{
    CamelImapStoreInfo *isi = (CamelImapStoreInfo *)mi;

    g_free(isi->full_name);
    camel_imap_store_summary_parent->store_info_free(s, mi);
}

static const char *
store_info_string(CamelStoreSummary *s, const CamelStoreInfo *mi, int type)
{
    CamelImapStoreInfo *isi = (CamelImapStoreInfo *)mi;

    /* FIXME: Locks? */

    g_assert (mi != NULL);

    switch (type) {
    case CAMEL_IMAP_STORE_INFO_FULL_NAME:
        return isi->full_name;
    default:
        return camel_imap_store_summary_parent->store_info_string(s, mi, type);
    }
}

static void
store_info_set_string(CamelStoreSummary *s, CamelStoreInfo *mi, int type, const char *str)
{
    CamelImapStoreInfo *isi = (CamelImapStoreInfo *)mi;

    g_assert(mi != NULL);

    switch(type) {
    case CAMEL_IMAP_STORE_INFO_FULL_NAME:
        d(printf("Set full name %s -> %s\n", isi->full_name, str));
        CAMEL_STORE_SUMMARY_LOCK(s, summary_lock);
        g_free(isi->full_name);
        isi->full_name = g_strdup(str);
        CAMEL_STORE_SUMMARY_UNLOCK(s, summary_lock);
        break;
    default:
        camel_imap_store_summary_parent->store_info_set_string(s, mi, type, str);
        break;
    }
}