aboutsummaryrefslogtreecommitdiffstats
path: root/camel/camel-folder-search.c
blob: e065316ef70e703c9aaeaf450e73195be64e433f (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
/*
 *  Copyright (C) 2000 Helix Code Inc.
 *
 *  Authors: Michael Zucchi <notzed@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
 */

/* This is a helper class for folders to implement the search function.
   It implements enough to do basic searches on folders that can provide
   an in-memory summary and a body index. */

#include <stdio.h>
#include <string.h>
#include <glib.h>

#include "camel-folder-search.h"
#include "string-utils.h"

#define d(x)
#define r(x)

struct _CamelFolderSearchPrivate {
};

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

static ESExpResult *search_header_contains(struct _ESExp *f, int argc, struct _ESExpResult **argv, CamelFolderSearch *search);
static ESExpResult *search_match_all(struct _ESExp *f, int argc, struct _ESExpTerm **argv, CamelFolderSearch *search);
static ESExpResult *search_body_contains(struct _ESExp *f, int argc, struct _ESExpResult **argv, CamelFolderSearch *search);
static ESExpResult *search_user_flag(struct _ESExp *f, int argc, struct _ESExpResult **argv, CamelFolderSearch *s);

static ESExpResult *search_dummy(struct _ESExp *f, int argc, struct _ESExpResult **argv, CamelFolderSearch *search);

static void camel_folder_search_class_init (CamelFolderSearchClass *klass);
static void camel_folder_search_init       (CamelFolderSearch *obj);
static void camel_folder_search_finalise   (GtkObject *obj);

static CamelObjectClass *camel_folder_search_parent;

enum SIGNALS {
    LAST_SIGNAL
};

static guint signals[LAST_SIGNAL] = { 0 };

guint
camel_folder_search_get_type (void)
{
    static guint type = 0;
    
    if (!type) {
        GtkTypeInfo type_info = {
            "CamelFolderSearch",
            sizeof (CamelFolderSearch),
            sizeof (CamelFolderSearchClass),
            (GtkClassInitFunc) camel_folder_search_class_init,
            (GtkObjectInitFunc) camel_folder_search_init,
            (GtkArgSetFunc) NULL,
            (GtkArgGetFunc) NULL
        };
        
        type = gtk_type_unique (camel_object_get_type (), &type_info);
    }
    
    return type;
}

static void
camel_folder_search_class_init (CamelFolderSearchClass *klass)
{
    GtkObjectClass *object_class = (GtkObjectClass *) klass;
    
    camel_folder_search_parent = gtk_type_class (camel_object_get_type ());

    object_class->finalize = camel_folder_search_finalise;

    klass->match_all = search_match_all;
    klass->body_contains = search_body_contains;
    klass->header_contains = search_header_contains;
    klass->user_flag = search_user_flag;

    gtk_object_class_add_signals (object_class, signals, LAST_SIGNAL);
}

static void
camel_folder_search_init (CamelFolderSearch *obj)
{
    struct _CamelFolderSearchPrivate *p;

    p = _PRIVATE(obj) = g_malloc0(sizeof(*p));

    obj->sexp = e_sexp_new();
}

static void
camel_folder_search_finalise (GtkObject *obj)
{
    CamelFolderSearch *search = (CamelFolderSearch *)obj;
    if (search->sexp)
        gtk_object_unref((GtkObject *)search->sexp);

    g_free(search->last_search);

    ((GtkObjectClass *)(camel_folder_search_parent))->finalize((GtkObject *)obj);
}

struct {
    char *name;
    int offset;
    int flags;      /* 0x02 = immediate, 0x01 = always enter */
} builtins[] = {
    /* these have default implementations in e-sexp */
    { "and", GTK_STRUCT_OFFSET(CamelFolderSearchClass, and), 2 },
    { "or", GTK_STRUCT_OFFSET(CamelFolderSearchClass, or), 2 },
    { "not", GTK_STRUCT_OFFSET(CamelFolderSearchClass, not), 2 },
    { "<", GTK_STRUCT_OFFSET(CamelFolderSearchClass, lt), 2 },
    { ">", GTK_STRUCT_OFFSET(CamelFolderSearchClass, gt), 2 },
    { "=", GTK_STRUCT_OFFSET(CamelFolderSearchClass, eq), 2 },

    /* these we have to use our own default if there is none */
    /* they should all be defined in the language? so it poarses, or should they not?? */
    { "match-all", GTK_STRUCT_OFFSET(CamelFolderSearchClass, match_all), 3 },
    { "body-contains", GTK_STRUCT_OFFSET(CamelFolderSearchClass, body_contains), 1 },
    { "header-contains", GTK_STRUCT_OFFSET(CamelFolderSearchClass, header_contains), 1 },
    { "user-flag", GTK_STRUCT_OFFSET(CamelFolderSearchClass, user_flag), 1 },
};

void
camel_folder_search_construct (CamelFolderSearch *search)
{
    int i;
    CamelFolderSearchClass *klass = (CamelFolderSearchClass *)GTK_OBJECT(search)->klass;

    for (i=0;i<sizeof(builtins)/sizeof(builtins[0]);i++) {
        void *func;
        /* c is sure messy sometimes */
        func = *((void **)(((char *)klass)+builtins[i].offset));
        if (func == NULL && builtins[i].flags&1) {
            g_warning("Search class doesn't implement '%s' method: %s", builtins[i].name, gtk_type_name(GTK_OBJECT(search)->klass->type));
            func = (void *)search_dummy;
        }
        if (func != NULL) {
            if (builtins[i].flags&2) {
                e_sexp_add_ifunction(search->sexp, 0, builtins[i].name, (ESExpIFunc *)func, search);
            } else {
                e_sexp_add_function(search->sexp, 0, builtins[i].name, (ESExpFunc *)func, search);
            }
        }
    }
}

/**
 * camel_folder_search_new:
 *
 * Create a new CamelFolderSearch object.
 * 
 * A CamelFolderSearch is a subclassable, extensible s-exp
 * evaluator which enforces a particular set of s-expressions.
 * Particular methods may be overriden by an implementation to
 * implement a search for any sort of backend.
 *
 * Return value: A new CamelFolderSearch widget.
 **/
CamelFolderSearch *
camel_folder_search_new (void)
{
    CamelFolderSearch *new = CAMEL_FOLDER_SEARCH ( gtk_type_new (camel_folder_search_get_type ()));

    camel_folder_search_construct(new);
    return new;
}

/**
 * camel_folder_search_set_folder:
 * @search:
 * @folder: A folder.
 * 
 * Set the folder attribute of the search.  This is currently unused, but
 * could be used to perform a slow-search when indexes and so forth are not
 * available.  Or for use by subclasses.
 **/
void
camel_folder_search_set_folder(CamelFolderSearch *search, CamelFolder *folder)
{
    search->folder = folder;
}

/**
 * camel_folder_search_set_summary:
 * @search: 
 * @summary: An array of CamelMessageInfo pointers.
 * 
 * Set the array of summary objects representing the span of the search.
 *
 * If this is not set, then a subclass must provide the functions
 * for searching headers and for the match-all operator.
 **/
void
camel_folder_search_set_summary(CamelFolderSearch *search, GPtrArray *summary)
{
    search->summary = summary;
}

/**
 * camel_folder_search_set_body_index:
 * @search: 
 * @index: 
 * 
 * Set the index (ibex) representing the contents of all messages
 * in this folder.  If this is not set, then the folder implementation
 * should sub-class the CamelFolderSearch and provide its own
 * body-contains function.
 **/
void
camel_folder_search_set_body_index(CamelFolderSearch *search, ibex *index)
{
    search->body_index = index;
}

/**
 * camel_folder_search_execute_expression:
 * @search: 
 * @expr: 
 * @ex: 
 * 
 * Execute the search expression @expr, returning a list of
 * all matches as a GList of uid's of matching messages.
 *
 * Note that any settings such as set_body_index(), set_folder(),
 * and so on are reset to #NULL once the search has completed.
 *
 * TODO: The interface should probably return a GPtrArray
 * of summary items instead (since they are much more useful
 * to any client).
 * 
 * Return value: A GList of strings of all matching messages.  Once
 * finished with this, the array AND CONTENTS should be free'd
 * by the caller.
 **/
GList *
camel_folder_search_execute_expression(CamelFolderSearch *search, const char *expr, CamelException *ex)
{
    ESExpResult *r;
    GList *matches = NULL;
    int i;

    /* only re-parse if the search has changed */
    if (search->last_search == NULL
        || strcmp(search->last_search, expr)) {
        e_sexp_input_text(search->sexp, expr, strlen(expr));
        e_sexp_parse(search->sexp);
        g_free(search->last_search);
        search->last_search = g_strdup(expr);
    }
    r = e_sexp_eval(search->sexp);

    /* now create a folder summary to return?? */
    if (r
        && r->type == ESEXP_RES_ARRAY_PTR) {
        d(printf("got result ...\n"));
        for (i=0;i<r->value.ptrarray->len;i++) {
            d(printf("adding match: %s\n", (char *)g_ptr_array_index(r->value.ptrarray, i)));
            matches = g_list_prepend(matches, g_strdup(g_ptr_array_index(r->value.ptrarray, i)));
        }
        e_sexp_result_free(r);
    } else {
        printf("no result!\n");
    }

    search->folder = NULL;
    search->summary = NULL;
    search->current = NULL;
    search->body_index = NULL;

    return matches;
}

/* dummy function, returns false always, or an empty match array */
static ESExpResult *
search_dummy(struct _ESExp *f, int argc, struct _ESExpResult **argv, CamelFolderSearch *search)
{
    ESExpResult *r;

    if (search->current == NULL) {
        r = e_sexp_result_new(ESEXP_RES_BOOL);
        r->value.bool = FALSE;
    } else {
        r = e_sexp_result_new(ESEXP_RES_ARRAY_PTR);
        r->value.ptrarray = g_ptr_array_new();
    }

    return r;
}

static ESExpResult *
search_match_all(struct _ESExp *f, int argc, struct _ESExpTerm **argv, CamelFolderSearch *search)
{
    int i;
    ESExpResult *r, *r1;

    if (argc>1) {
        g_warning("match-all only takes a single argument, other arguments ignored");
    }
    r = e_sexp_result_new(ESEXP_RES_ARRAY_PTR);
    r->value.ptrarray = g_ptr_array_new();

    if (search->summary == NULL) {
        /* TODO: make it work - e.g. use the folder and so forth for a slower search */
        g_warning("No summary supplied, match-all doesn't work with no summary");
        return r;
    }

    /* TODO: Could make this a bit faster in the uncommon case (of match-everything) */
    for (i=0;i<search->summary->len;i++) {
        search->current = g_ptr_array_index(search->summary, i);
        if (argc>0) {
            r1 = e_sexp_term_eval(f, argv[0]);
            if (r1->type == ESEXP_RES_BOOL) {
                if (r1->value.bool)
                    g_ptr_array_add(r->value.ptrarray, search->current->uid);
            } else {
                g_warning("invalid syntax, matches require a single bool result");
            }
            e_sexp_result_free(r1);
        } else {
            g_ptr_array_add(r->value.ptrarray, search->current->uid);
        }
    }
    search->current = NULL;

    return r;
}

static ESExpResult *
search_header_contains(struct _ESExp *f, int argc, struct _ESExpResult **argv, CamelFolderSearch *search)
{
    ESExpResult *r;
    int truth = FALSE;

    r(printf("executing header-contains\n"));

    /* are we inside a match-all? */
    if (search->current && argc>1
        && argv[0]->type == ESEXP_RES_STRING) {
        char *headername, *header = NULL;
        char strbuf[32];
        int i;

        /* only a subset of headers are supported .. */
        headername = argv[0]->value.string;
        if (!strcasecmp(headername, "subject")) {
            header = search->current->subject;
        } else if (!strcasecmp(headername, "date")) {
            /* FIXME: not a very useful form of the date */
            sprintf(strbuf, "%d", (int)search->current->date_sent);
            header = strbuf;
        } else if (!strcasecmp(headername, "from")) {
            header = search->current->from;
        } else if (!strcasecmp(headername, "to")) {
            header = search->current->to;
        } else if (!strcasecmp(headername, "cc")) {
            header = search->current->cc;
        } else {
            g_warning("Performing query on unknown header: %s", headername);
        }

        if (header) {
            /* performs an OR of all words */
            for (i=1;i<argc && !truth;i++) {
                if (argv[i]->type == ESEXP_RES_STRING
                    && strstrcase(header, argv[i]->value.string)) {
                    r(printf("%s got a match with %s of %s\n", search->current->uid, header, argv[i]->value.string));
                    truth = TRUE;
                    break;
                }
            }
        }
    }
    /* TODO: else, find all matches */

    r = e_sexp_result_new(ESEXP_RES_BOOL);
    r->value.bool = truth;

    return r;
}

/* this is just to OR results together */
struct _glib_sux_donkeys {
    int count;
    GPtrArray *uids;
};

/* or, store all unique values */
static void
g_lib_sux_htor(char *key, int value, struct _glib_sux_donkeys *fuckup)
{
    g_ptr_array_add(fuckup->uids, key);
}

static ESExpResult *
search_body_contains(struct _ESExp *f, int argc, struct _ESExpResult **argv, CamelFolderSearch *search)
{
    ESExpResult *r;
    int i, j;

    if (search->current) {
        int truth = FALSE;

        r = e_sexp_result_new(ESEXP_RES_BOOL);
        if (search->body_index) {
            for (i=0;i<argc && !truth;i++) {
                if (argv[i]->type == ESEXP_RES_STRING) {
                    truth = ibex_find_name(search->body_index, search->current->uid, argv[i]->value.string);
                } else {
                    g_warning("Invalid type passed to body-contains match function");
                }
            }
        } else {
            g_warning("Cannot perform indexed body query with no index");
        }
        r->value.bool = truth;
    } else {
        r = e_sexp_result_new(ESEXP_RES_ARRAY_PTR);

        if (search->body_index) {
            if (argc==1) {
                /* common case */
                r->value.ptrarray = ibex_find(search->body_index, argv[0]->value.string);
            } else {
                GHashTable *ht = g_hash_table_new(g_str_hash, g_str_equal);
                GPtrArray *pa;
                struct _glib_sux_donkeys lambdafoo;

                /* this sux, perform an or operation on the result(s) of each word */
                for (i=0;i<argc;i++) {
                    if (argv[i]->type == ESEXP_RES_STRING) {
                        pa = ibex_find(search->body_index, argv[i]->value.string);
                        for (j=0;j<pa->len;j++) {
                            g_hash_table_insert(ht, g_ptr_array_index(pa, j), (void *)1);
                        }
                        g_ptr_array_free(pa, FALSE);
                    } else {
                        g_warning("invalid type passed to body-contains");
                    }
                }
                lambdafoo.uids = g_ptr_array_new();
                g_hash_table_foreach(ht, (GHFunc)g_lib_sux_htor, &lambdafoo);
                r->value.ptrarray = lambdafoo.uids;
                g_hash_table_destroy(ht);
            }
        } else {
            r->value.ptrarray = g_ptr_array_new();
        }
    }

    return r;
}

static ESExpResult *search_user_flag(struct _ESExp *f, int argc, struct _ESExpResult **argv, CamelFolderSearch *search)
{
    ESExpResult *r;
    int i;

    r(printf("executing user-flag\n"));

    /* are we inside a match-all? */
    if (search->current) {
        int truth = FALSE;
        /* performs an OR of all words */
        for (i=0;i<argc && !truth;i++) {
            if (argv[i]->type == ESEXP_RES_STRING
                && camel_flag_get(&search->current->user_flags, argv[i]->value.string)) {
                truth = TRUE;
                break;
            }
        }
        r = e_sexp_result_new(ESEXP_RES_BOOL);
        r->value.bool = truth;
    } else {
        r = e_sexp_result_new(ESEXP_RES_ARRAY_PTR);
        r->value.ptrarray = g_ptr_array_new();
    }

    return r;
}