1 /* -*- Mode: C; tab-width: 8; indent-tabs-mode: t; c-basic-offset: 8 -*- */
3 * Copyright (C) 2000-2003 Ximian Inc.
5 * Authors: Michael Zucchi <notzed@ximian.com>
7 * This program is free software; you can redistribute it and/or
8 * modify it under the terms of version 2 of the GNU General Public
9 * License as published by the Free Software Foundation.
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 * General Public License for more details.
16 * You should have received a copy of the GNU General Public
17 * License along with this program; if not, write to the
18 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
19 * Boston, MA 02111-1307, USA.
22 /* This is a helper class for folders to implement the search function.
23 It implements enough to do basic searches on folders that can provide
24 an in-memory summary and a body index. */
33 #include <sys/types.h>
38 #include "camel-folder-search.h"
39 #include "camel-folder-thread.h"
41 #include "camel-exception.h"
42 #include "camel-medium.h"
43 #include "camel-multipart.h"
44 #include "camel-mime-message.h"
45 #include "camel-stream-mem.h"
46 #include "e-util/e-memory.h"
47 #include "camel-search-private.h"
52 struct _CamelFolderSearchPrivate {
53 GHashTable *mempool_hash;
56 CamelFolderThread *threads;
57 GHashTable *threads_hash;
60 #define _PRIVATE(o) (((CamelFolderSearch *)(o))->priv)
62 static ESExpResult *search_not(struct _ESExp *f, int argc, struct _ESExpResult **argv, CamelFolderSearch *search);
64 static ESExpResult *search_header_contains(struct _ESExp *f, int argc, struct _ESExpResult **argv, CamelFolderSearch *search);
65 static ESExpResult *search_header_matches(struct _ESExp *f, int argc, struct _ESExpResult **argv, CamelFolderSearch *search);
66 static ESExpResult *search_header_starts_with(struct _ESExp *f, int argc, struct _ESExpResult **argv, CamelFolderSearch *search);
67 static ESExpResult *search_header_ends_with(struct _ESExp *f, int argc, struct _ESExpResult **argv, CamelFolderSearch *search);
68 static ESExpResult *search_header_exists(struct _ESExp *f, int argc, struct _ESExpResult **argv, CamelFolderSearch *search);
69 static ESExpResult *search_match_all(struct _ESExp *f, int argc, struct _ESExpTerm **argv, CamelFolderSearch *search);
70 static ESExpResult *search_match_threads(struct _ESExp *f, int argc, struct _ESExpTerm **argv, CamelFolderSearch *s);
71 static ESExpResult *search_body_contains(struct _ESExp *f, int argc, struct _ESExpResult **argv, CamelFolderSearch *search);
72 static ESExpResult *search_user_flag(struct _ESExp *f, int argc, struct _ESExpResult **argv, CamelFolderSearch *s);
73 static ESExpResult *search_user_tag(struct _ESExp *f, int argc, struct _ESExpResult **argv, CamelFolderSearch *s);
74 static ESExpResult *search_system_flag(struct _ESExp *f, int argc, struct _ESExpResult **argv, CamelFolderSearch *s);
75 static ESExpResult *search_get_sent_date(struct _ESExp *f, int argc, struct _ESExpResult **argv, CamelFolderSearch *s);
76 static ESExpResult *search_get_received_date(struct _ESExp *f, int argc, struct _ESExpResult **argv, CamelFolderSearch *s);
77 static ESExpResult *search_get_current_date(struct _ESExp *f, int argc, struct _ESExpResult **argv, CamelFolderSearch *s);
78 static ESExpResult *search_get_size(struct _ESExp *f, int argc, struct _ESExpResult **argv, CamelFolderSearch *s);
79 static ESExpResult *search_uid(struct _ESExp *f, int argc, struct _ESExpResult **argv, CamelFolderSearch *s);
81 static ESExpResult *search_dummy(struct _ESExp *f, int argc, struct _ESExpResult **argv, CamelFolderSearch *search);
83 static void camel_folder_search_class_init (CamelFolderSearchClass *klass);
84 static void camel_folder_search_init (CamelFolderSearch *obj);
85 static void camel_folder_search_finalize (CamelObject *obj);
87 static CamelObjectClass *camel_folder_search_parent;
90 camel_folder_search_class_init (CamelFolderSearchClass *klass)
92 camel_folder_search_parent = camel_type_get_global_classfuncs (camel_object_get_type ());
94 klass->not = search_not;
96 klass->match_all = search_match_all;
97 klass->match_threads = search_match_threads;
98 klass->body_contains = search_body_contains;
99 klass->header_contains = search_header_contains;
100 klass->header_matches = search_header_matches;
101 klass->header_starts_with = search_header_starts_with;
102 klass->header_ends_with = search_header_ends_with;
103 klass->header_exists = search_header_exists;
104 klass->user_tag = search_user_tag;
105 klass->user_flag = search_user_flag;
106 klass->system_flag = search_system_flag;
107 klass->get_sent_date = search_get_sent_date;
108 klass->get_received_date = search_get_received_date;
109 klass->get_current_date = search_get_current_date;
110 klass->get_size = search_get_size;
111 klass->uid = search_uid;
115 camel_folder_search_init (CamelFolderSearch *obj)
117 struct _CamelFolderSearchPrivate *p;
119 p = _PRIVATE(obj) = g_malloc0(sizeof(*p));
121 obj->sexp = e_sexp_new();
123 /* use a hash of mempools to associate the returned uid lists with
124 the backing mempool. yes pretty weird, but i didn't want to change
127 p->mempool_hash = g_hash_table_new(0, 0);
131 free_mempool(void *key, void *value, void *data)
133 GPtrArray *uids = key;
134 EMemPool *pool = value;
136 g_warning("Search closed with outstanding result unfreed: %p", uids);
138 g_ptr_array_free(uids, TRUE);
139 e_mempool_destroy(pool);
143 camel_folder_search_finalize (CamelObject *obj)
145 CamelFolderSearch *search = (CamelFolderSearch *)obj;
146 struct _CamelFolderSearchPrivate *p = _PRIVATE(obj);
149 e_sexp_unref(search->sexp);
150 if (search->summary_hash)
151 g_hash_table_destroy(search->summary_hash);
153 g_free(search->last_search);
154 g_hash_table_foreach(p->mempool_hash, free_mempool, obj);
155 g_hash_table_destroy(p->mempool_hash);
160 camel_folder_search_get_type (void)
162 static CamelType type = CAMEL_INVALID_TYPE;
164 if (type == CAMEL_INVALID_TYPE) {
165 type = camel_type_register (camel_object_get_type (), "CamelFolderSearch",
166 sizeof (CamelFolderSearch),
167 sizeof (CamelFolderSearchClass),
168 (CamelObjectClassInitFunc) camel_folder_search_class_init,
170 (CamelObjectInitFunc) camel_folder_search_init,
171 (CamelObjectFinalizeFunc) camel_folder_search_finalize);
178 #define CAMEL_STRUCT_OFFSET(type, field) ((gint) offsetof (type, field))
180 #define CAMEL_STRUCT_OFFSET(type, field) ((gint) ((gchar*) &((type *) 0)->field))
186 int flags; /* 0x02 = immediate, 0x01 = always enter */
188 /* these have default implementations in e-sexp */
189 { "and", CAMEL_STRUCT_OFFSET(CamelFolderSearchClass, and), 2 },
190 { "or", CAMEL_STRUCT_OFFSET(CamelFolderSearchClass, or), 2 },
191 /* we need to override this one though to implement an 'array not' */
192 { "not", CAMEL_STRUCT_OFFSET(CamelFolderSearchClass, not), 0 },
193 { "<", CAMEL_STRUCT_OFFSET(CamelFolderSearchClass, lt), 2 },
194 { ">", CAMEL_STRUCT_OFFSET(CamelFolderSearchClass, gt), 2 },
195 { "=", CAMEL_STRUCT_OFFSET(CamelFolderSearchClass, eq), 2 },
197 /* these we have to use our own default if there is none */
198 /* they should all be defined in the language? so it parses, or should they not?? */
199 { "match-all", CAMEL_STRUCT_OFFSET(CamelFolderSearchClass, match_all), 3 },
200 { "match-threads", CAMEL_STRUCT_OFFSET(CamelFolderSearchClass, match_threads), 3 },
201 { "body-contains", CAMEL_STRUCT_OFFSET(CamelFolderSearchClass, body_contains), 1 },
202 { "header-contains", CAMEL_STRUCT_OFFSET(CamelFolderSearchClass, header_contains), 1 },
203 { "header-matches", CAMEL_STRUCT_OFFSET(CamelFolderSearchClass, header_matches), 1 },
204 { "header-starts-with", CAMEL_STRUCT_OFFSET(CamelFolderSearchClass, header_starts_with), 1 },
205 { "header-ends-with", CAMEL_STRUCT_OFFSET(CamelFolderSearchClass, header_ends_with), 1 },
206 { "header-exists", CAMEL_STRUCT_OFFSET(CamelFolderSearchClass, header_exists), 1 },
207 { "user-tag", CAMEL_STRUCT_OFFSET(CamelFolderSearchClass, user_tag), 1 },
208 { "user-flag", CAMEL_STRUCT_OFFSET(CamelFolderSearchClass, user_flag), 1 },
209 { "system-flag", CAMEL_STRUCT_OFFSET(CamelFolderSearchClass, system_flag), 1 },
210 { "get-sent-date", CAMEL_STRUCT_OFFSET(CamelFolderSearchClass, get_sent_date), 1 },
211 { "get-received-date", CAMEL_STRUCT_OFFSET(CamelFolderSearchClass, get_received_date), 1 },
212 { "get-current-date", CAMEL_STRUCT_OFFSET(CamelFolderSearchClass, get_current_date), 1 },
213 { "get-size", CAMEL_STRUCT_OFFSET(CamelFolderSearchClass, get_size), 1 },
214 { "uid", CAMEL_STRUCT_OFFSET(CamelFolderSearchClass, uid), 1 },
218 camel_folder_search_construct (CamelFolderSearch *search)
221 CamelFolderSearchClass *klass = (CamelFolderSearchClass *)CAMEL_OBJECT_GET_CLASS(search);
223 for (i=0;i<sizeof(builtins)/sizeof(builtins[0]);i++) {
225 /* c is sure messy sometimes */
226 func = *((void **)(((char *)klass)+builtins[i].offset));
227 if (func == NULL && builtins[i].flags&1) {
228 g_warning("Search class doesn't implement '%s' method: %s", builtins[i].name, camel_type_to_name(CAMEL_OBJECT_GET_CLASS(search)));
229 func = (void *)search_dummy;
232 if (builtins[i].flags&2) {
233 e_sexp_add_ifunction(search->sexp, 0, builtins[i].name, (ESExpIFunc *)func, search);
235 e_sexp_add_function(search->sexp, 0, builtins[i].name, (ESExpFunc *)func, search);
242 * camel_folder_search_new:
244 * Create a new CamelFolderSearch object.
246 * A CamelFolderSearch is a subclassable, extensible s-exp
247 * evaluator which enforces a particular set of s-expressions.
248 * Particular methods may be overriden by an implementation to
249 * implement a search for any sort of backend.
251 * Return value: A new CamelFolderSearch widget.
254 camel_folder_search_new (void)
256 CamelFolderSearch *new = CAMEL_FOLDER_SEARCH (camel_object_new (camel_folder_search_get_type ()));
258 camel_folder_search_construct(new);
263 * camel_folder_search_set_folder:
267 * Set the folder attribute of the search. This is currently unused, but
268 * could be used to perform a slow-search when indexes and so forth are not
269 * available. Or for use by subclasses.
272 camel_folder_search_set_folder(CamelFolderSearch *search, CamelFolder *folder)
274 search->folder = folder;
278 * camel_folder_search_set_summary:
280 * @summary: An array of CamelMessageInfo pointers.
282 * Set the array of summary objects representing the span of the search.
284 * If this is not set, then a subclass must provide the functions
285 * for searching headers and for the match-all operator.
288 camel_folder_search_set_summary(CamelFolderSearch *search, GPtrArray *summary)
292 search->summary = summary;
293 if (search->summary_hash)
294 g_hash_table_destroy(search->summary_hash);
295 search->summary_hash = g_hash_table_new(g_str_hash, g_str_equal);
296 for (i=0;i<summary->len;i++)
297 g_hash_table_insert(search->summary_hash, (char *)camel_message_info_uid(summary->pdata[i]), summary->pdata[i]);
301 * camel_folder_search_set_body_index:
305 * Set the index representing the contents of all messages
306 * in this folder. If this is not set, then the folder implementation
307 * should sub-class the CamelFolderSearch and provide its own
308 * body-contains function.
311 camel_folder_search_set_body_index(CamelFolderSearch *search, CamelIndex *index)
313 if (search->body_index)
314 camel_object_unref((CamelObject *)search->body_index);
315 search->body_index = index;
317 camel_object_ref((CamelObject *)index);
321 * camel_folder_search_execute_expression:
326 * Execute the search expression @expr, returning an array of
327 * all matches as a GPtrArray of uid's of matching messages.
329 * Note that any settings such as set_body_index(), set_folder(),
330 * and so on are reset to #NULL once the search has completed.
332 * TODO: The interface should probably return summary items instead
333 * (since they are much more useful to any client).
335 * Return value: A GPtrArray of strings of all matching messages.
336 * This must only be freed by camel_folder_search_free_result.
339 camel_folder_search_execute_expression(CamelFolderSearch *search, const char *expr, CamelException *ex)
346 struct _CamelFolderSearchPrivate *p = _PRIVATE(search);
350 /* only re-parse if the search has changed */
351 if (search->last_search == NULL
352 || strcmp(search->last_search, expr)) {
353 e_sexp_input_text(search->sexp, expr, strlen(expr));
354 if (e_sexp_parse(search->sexp) == -1) {
355 camel_exception_setv(ex, 1, _("Cannot parse search expression: %s:\n%s"), e_sexp_error(search->sexp), expr);
359 g_free(search->last_search);
360 search->last_search = g_strdup(expr);
362 r = e_sexp_eval(search->sexp);
364 if (!camel_exception_is_set(ex))
365 camel_exception_setv(ex, 1, _("Error executing search expression: %s:\n%s"), e_sexp_error(search->sexp), expr);
369 matches = g_ptr_array_new();
371 /* now create a folder summary to return?? */
372 if (r->type == ESEXP_RES_ARRAY_PTR) {
373 d(printf("got result ...\n"));
374 /* we use a mempool to store the strings, packed in tight as possible, and freed together */
375 /* because the strings are often short (like <8 bytes long), we would be wasting appx 50%
376 of memory just storing the size tag that malloc assigns us and alignment padding, so this
377 gets around that (and is faster to allocate and free as a bonus) */
378 pool = e_mempool_new(512, 256, E_MEMPOOL_ALIGN_BYTE);
379 if (search->summary) {
380 /* reorder result in summary order */
381 results = g_hash_table_new(g_str_hash, g_str_equal);
382 for (i=0;i<r->value.ptrarray->len;i++) {
383 d(printf("adding match: %s\n", (char *)g_ptr_array_index(r->value.ptrarray, i)));
384 g_hash_table_insert(results, g_ptr_array_index(r->value.ptrarray, i), GINT_TO_POINTER (1));
386 for (i=0;i<search->summary->len;i++) {
387 CamelMessageInfo *info = g_ptr_array_index(search->summary, i);
388 char *uid = (char *)camel_message_info_uid(info);
389 if (g_hash_table_lookup(results, uid)) {
390 g_ptr_array_add(matches, e_mempool_strdup(pool, uid));
393 g_hash_table_destroy(results);
395 for (i=0;i<r->value.ptrarray->len;i++) {
396 d(printf("adding match: %s\n", (char *)g_ptr_array_index(r->value.ptrarray, i)));
397 g_ptr_array_add(matches, e_mempool_strdup(pool, g_ptr_array_index(r->value.ptrarray, i)));
400 /* instead of putting the mempool_hash in the structure, we keep the api clean by
401 putting a reference to it in a hashtable. Lets us do some debugging and catch
402 unfree'd results as well. */
403 g_hash_table_insert(p->mempool_hash, matches, pool);
405 g_warning("Search returned an invalid result type");
408 e_sexp_result_free(search->sexp, r);
411 camel_folder_thread_messages_unref(p->threads);
413 g_hash_table_destroy(p->threads_hash);
416 p->threads_hash = NULL;
417 search->folder = NULL;
418 search->summary = NULL;
419 search->current = NULL;
420 search->body_index = NULL;
426 * camel_folder_search_search:
429 * @uids: to search against, NULL for all uid's.
432 * Run a search. Search must have had Folder already set on it, and
433 * it must implement summaries.
438 camel_folder_search_search(CamelFolderSearch *search, const char *expr, GPtrArray *uids, CamelException *ex)
441 GPtrArray *matches = NULL, *summary_set;
445 struct _CamelFolderSearchPrivate *p = _PRIVATE(search);
447 g_assert(search->folder);
451 /* setup our search list, summary_hash only contains those we're interested in */
452 search->summary = camel_folder_get_summary(search->folder);
453 search->summary_hash = g_hash_table_new(g_str_hash, g_str_equal);
456 GHashTable *uids_hash = g_hash_table_new(g_str_hash, g_str_equal);
458 summary_set = search->summary_set = g_ptr_array_new();
459 for (i=0;i<uids->len;i++)
460 g_hash_table_insert(uids_hash, uids->pdata[i], uids->pdata[i]);
461 for (i=0;i<search->summary->len;i++)
462 if (g_hash_table_lookup(uids_hash, camel_message_info_uid(search->summary->pdata[i])))
463 g_ptr_array_add(search->summary_set, search->summary->pdata[i]);
465 summary_set = search->summary;
468 for (i=0;i<summary_set->len;i++)
469 g_hash_table_insert(search->summary_hash, (char *)camel_message_info_uid(summary_set->pdata[i]), summary_set->pdata[i]);
471 /* only re-parse if the search has changed */
472 if (search->last_search == NULL
473 || strcmp(search->last_search, expr)) {
474 e_sexp_input_text(search->sexp, expr, strlen(expr));
475 if (e_sexp_parse(search->sexp) == -1) {
476 camel_exception_setv(ex, 1, _("Cannot parse search expression: %s:\n%s"), e_sexp_error(search->sexp), expr);
480 g_free(search->last_search);
481 search->last_search = g_strdup(expr);
483 r = e_sexp_eval(search->sexp);
485 if (!camel_exception_is_set(ex))
486 camel_exception_setv(ex, 1, _("Error executing search expression: %s:\n%s"), e_sexp_error(search->sexp), expr);
490 matches = g_ptr_array_new();
492 /* now create a folder summary to return?? */
493 if (r->type == ESEXP_RES_ARRAY_PTR) {
494 d(printf("got result ...\n"));
496 /* we use a mempool to store the strings, packed in tight as possible, and freed together */
497 /* because the strings are often short (like <8 bytes long), we would be wasting appx 50%
498 of memory just storing the size tag that malloc assigns us and alignment padding, so this
499 gets around that (and is faster to allocate and free as a bonus) */
500 pool = e_mempool_new(512, 256, E_MEMPOOL_ALIGN_BYTE);
501 /* reorder result in summary order */
502 results = g_hash_table_new(g_str_hash, g_str_equal);
503 for (i=0;i<r->value.ptrarray->len;i++) {
504 d(printf("adding match: %s\n", (char *)g_ptr_array_index(r->value.ptrarray, i)));
505 g_hash_table_insert(results, g_ptr_array_index(r->value.ptrarray, i), GINT_TO_POINTER (1));
508 for (i=0;i<summary_set->len;i++) {
509 CamelMessageInfo *info = g_ptr_array_index(summary_set, i);
510 char *uid = (char *)camel_message_info_uid(info);
511 if (g_hash_table_lookup(results, uid))
512 g_ptr_array_add(matches, e_mempool_strdup(pool, uid));
514 g_hash_table_destroy(results);
516 /* instead of putting the mempool_hash in the structure, we keep the api clean by
517 putting a reference to it in a hashtable. Lets us do some debugging and catch
518 unfree'd results as well. */
519 g_hash_table_insert(p->mempool_hash, matches, pool);
521 g_warning("Search returned an invalid result type");
524 e_sexp_result_free(search->sexp, r);
526 /* these might be allocated by match-threads */
528 camel_folder_thread_messages_unref(p->threads);
530 g_hash_table_destroy(p->threads_hash);
531 if (search->summary_set)
532 g_ptr_array_free(search->summary_set, TRUE);
533 g_hash_table_destroy(search->summary_hash);
534 camel_folder_free_summary(search->folder, search->summary);
537 p->threads_hash = NULL;
538 search->folder = NULL;
539 search->summary = NULL;
540 search->summary_hash = NULL;
541 search->summary_set = NULL;
542 search->current = NULL;
543 search->body_index = NULL;
548 void camel_folder_search_free_result(CamelFolderSearch *search, GPtrArray *result)
551 struct _CamelFolderSearchPrivate *p = _PRIVATE(search);
554 pool = g_hash_table_lookup(p->mempool_hash, result);
556 e_mempool_destroy(pool);
557 g_hash_table_remove(p->mempool_hash, result);
559 for (i=0;i<result->len;i++)
560 g_free(g_ptr_array_index(result, i));
562 g_ptr_array_free(result, TRUE);
565 /* dummy function, returns false always, or an empty match array */
567 search_dummy(struct _ESExp *f, int argc, struct _ESExpResult **argv, CamelFolderSearch *search)
571 if (search->current == NULL) {
572 r = e_sexp_result_new(f, ESEXP_RES_BOOL);
573 r->value.bool = FALSE;
575 r = e_sexp_result_new(f, ESEXP_RES_ARRAY_PTR);
576 r->value.ptrarray = g_ptr_array_new();
582 /* impelemnt an 'array not', i.e. everything in the summary, not in the supplied array */
584 search_not(struct _ESExp *f, int argc, struct _ESExpResult **argv, CamelFolderSearch *search)
590 if (argv[0]->type == ESEXP_RES_ARRAY_PTR) {
591 GPtrArray *v = argv[0]->value.ptrarray;
594 r = e_sexp_result_new(f, ESEXP_RES_ARRAY_PTR);
595 r->value.ptrarray = g_ptr_array_new();
597 /* not against a single message?*/
598 if (search->current) {
601 uid = camel_message_info_uid(search->current);
602 for (i=0;!found && i<v->len;i++) {
603 if (strcmp(uid, v->pdata[i]) == 0)
608 g_ptr_array_add(r->value.ptrarray, (char *)uid);
609 } else if (search->summary == NULL) {
610 g_warning("No summary set, 'not' against an array requires a summary");
612 /* 'not' against the whole summary */
613 GHashTable *have = g_hash_table_new(g_str_hash, g_str_equal);
615 CamelMessageInfo **m;
617 s = (char **)v->pdata;
618 for (i=0;i<v->len;i++)
619 g_hash_table_insert(have, s[i], s[i]);
621 v = search->summary_set?search->summary_set:search->summary;
622 m = (CamelMessageInfo **)v->pdata;
623 for (i=0;i<v->len;i++) {
624 char *uid = (char *)camel_message_info_uid(m[i]);
626 if (g_hash_table_lookup(have, uid) == NULL)
627 g_ptr_array_add(r->value.ptrarray, uid);
629 g_hash_table_destroy(have);
634 if (argv[0]->type == ESEXP_RES_BOOL)
635 res = ! argv[0]->value.bool;
637 r = e_sexp_result_new(f, ESEXP_RES_BOOL);
641 r = e_sexp_result_new(f, ESEXP_RES_BOOL);
642 r->value.bool = TRUE;
649 search_match_all(struct _ESExp *f, int argc, struct _ESExpTerm **argv, CamelFolderSearch *search)
656 g_warning("match-all only takes a single argument, other arguments ignored");
659 /* we are only matching a single message? or already inside a match-all? */
660 if (search->current) {
661 d(printf("matching against 1 message: %s\n", camel_message_info_subject(search->current)));
663 r = e_sexp_result_new(f, ESEXP_RES_BOOL);
664 r->value.bool = FALSE;
667 r1 = e_sexp_term_eval(f, argv[0]);
668 if (r1->type == ESEXP_RES_BOOL) {
669 r->value.bool = r1->value.bool;
671 g_warning("invalid syntax, matches require a single bool result");
672 e_sexp_fatal_error(f, _("(match-all) requires a single bool result"));
674 e_sexp_result_free(f, r1);
676 r->value.bool = TRUE;
681 r = e_sexp_result_new(f, ESEXP_RES_ARRAY_PTR);
682 r->value.ptrarray = g_ptr_array_new();
684 if (search->summary == NULL) {
685 /* TODO: make it work - e.g. use the folder and so forth for a slower search */
686 g_warning("No summary supplied, match-all doesn't work with no summary");
691 v = search->summary_set?search->summary_set:search->summary;
692 for (i=0;i<v->len;i++) {
695 search->current = g_ptr_array_index(v, i);
696 uid = camel_message_info_uid(search->current);
699 r1 = e_sexp_term_eval(f, argv[0]);
700 if (r1->type == ESEXP_RES_BOOL) {
702 g_ptr_array_add(r->value.ptrarray, (char *)uid);
704 g_warning("invalid syntax, matches require a single bool result");
705 e_sexp_fatal_error(f, _("(match-all) requires a single bool result"));
707 e_sexp_result_free(f, r1);
709 g_ptr_array_add(r->value.ptrarray, (char *)uid);
712 search->current = NULL;
718 fill_thread_table(struct _CamelFolderThreadNode *root, GHashTable *id_hash)
721 g_hash_table_insert(id_hash, (char *)camel_message_info_uid(root->message), root);
723 fill_thread_table(root->child, id_hash);
729 add_thread_results(struct _CamelFolderThreadNode *root, GHashTable *result_hash)
732 g_hash_table_insert(result_hash, (char *)camel_message_info_uid(root->message), GINT_TO_POINTER (1));
734 add_thread_results(root->child, result_hash);
740 add_results(char *uid, void *dummy, GPtrArray *result)
742 g_ptr_array_add(result, uid);
746 search_match_threads(struct _ESExp *f, int argc, struct _ESExpTerm **argv, CamelFolderSearch *search)
749 struct _CamelFolderSearchPrivate *p = search->priv;
753 /* not supported in match-all */
755 e_sexp_fatal_error(f, _("(match-threads) not allowed inside match-all"));
758 e_sexp_fatal_error(f, _("(match-threads) requires a match type string"));
760 r = e_sexp_term_eval(f, argv[0]);
761 if (r->type != ESEXP_RES_STRING)
762 e_sexp_fatal_error(f, _("(match-threads) requires a match type string"));
765 if (!strcmp(r->value.string, "none"))
767 else if (!strcmp(r->value.string, "all"))
769 else if (!strcmp(r->value.string, "replies"))
771 else if (!strcmp(r->value.string, "replies_parents"))
773 e_sexp_result_free(f, r);
775 /* behave as (begin does */
777 for (i=1;i<argc;i++) {
779 e_sexp_result_free(f, r);
780 r = e_sexp_term_eval(f, argv[i]);
783 if (r == NULL || r->type != ESEXP_RES_ARRAY_PTR)
784 e_sexp_fatal_error(f, _("(match-threads) expects an array result"));
789 if (search->folder == NULL)
790 e_sexp_fatal_error(f, _("(match-threads) requires the folder set"));
792 /* cache this, so we only have to re-calculate once per search at most */
793 if (p->threads == NULL) {
794 p->threads = camel_folder_thread_messages_new(search->folder, NULL, TRUE);
795 p->threads_hash = g_hash_table_new(g_str_hash, g_str_equal);
797 fill_thread_table(p->threads->tree, p->threads_hash);
800 results = g_hash_table_new(g_str_hash, g_str_equal);
801 for (i=0;i<r->value.ptrarray->len;i++) {
802 d(printf("adding match: %s\n", (char *)g_ptr_array_index(r->value.ptrarray, i)));
803 g_hash_table_insert(results, g_ptr_array_index(r->value.ptrarray, i), GINT_TO_POINTER (1));
806 for (i=0;i<r->value.ptrarray->len;i++) {
807 struct _CamelFolderThreadNode *node, *scan;
809 node = g_hash_table_lookup(p->threads_hash, (char *)g_ptr_array_index(r->value.ptrarray, i));
810 if (node == NULL) /* this shouldn't happen but why cry over spilt milk */
813 /* select messages in thread according to search criteria */
816 while (scan && scan->parent) {
818 g_hash_table_insert(results, (char *)camel_message_info_uid(scan->message), GINT_TO_POINTER(1));
820 } else if (type == 1) {
821 while (node && node->parent)
824 g_hash_table_insert(results, (char *)camel_message_info_uid(node->message), GINT_TO_POINTER(1));
826 add_thread_results(node->child, results);
828 e_sexp_result_free(f, r);
830 r = e_sexp_result_new(f, ESEXP_RES_ARRAY_PTR);
831 r->value.ptrarray = g_ptr_array_new();
833 g_hash_table_foreach(results, (GHFunc)add_results, r->value.ptrarray);
834 g_hash_table_destroy(results);
840 check_header(struct _ESExp *f, int argc, struct _ESExpResult **argv, CamelFolderSearch *search, camel_search_match_t how)
845 r(printf("executing check-header %d\n", how));
847 /* are we inside a match-all? */
848 if (search->current && argc>1
849 && argv[0]->type == ESEXP_RES_STRING) {
851 const char *header = NULL;
854 camel_search_t type = CAMEL_SEARCH_TYPE_ASIS;
855 struct _camel_search_words *words;
857 /* only a subset of headers are supported .. */
858 headername = argv[0]->value.string;
859 if (!strcasecmp(headername, "subject")) {
860 header = camel_message_info_subject(search->current);
861 } else if (!strcasecmp(headername, "date")) {
862 /* FIXME: not a very useful form of the date */
863 sprintf(strbuf, "%d", (int)search->current->date_sent);
865 } else if (!strcasecmp(headername, "from")) {
866 header = camel_message_info_from(search->current);
867 type = CAMEL_SEARCH_TYPE_ADDRESS;
868 } else if (!strcasecmp(headername, "to")) {
869 header = camel_message_info_to(search->current);
870 type = CAMEL_SEARCH_TYPE_ADDRESS;
871 } else if (!strcasecmp(headername, "cc")) {
872 header = camel_message_info_cc(search->current);
873 type = CAMEL_SEARCH_TYPE_ADDRESS;
874 } else if (!strcasecmp(headername, "x-camel-mlist")) {
875 header = camel_message_info_mlist(search->current);
876 type = CAMEL_SEARCH_TYPE_MLIST;
878 e_sexp_resultv_free(f, argc, argv);
879 e_sexp_fatal_error(f, _("Performing query on unknown header: %s"), headername);
883 /* performs an OR of all words */
884 for (i=1;i<argc && !truth;i++) {
885 if (argv[i]->type == ESEXP_RES_STRING) {
886 if (argv[i]->value.string[0] == 0) {
888 } else if (how == CAMEL_SEARCH_MATCH_CONTAINS) {
889 /* doesn't make sense to split words on anything but contains i.e. we can't have an ending match different words */
890 words = camel_search_words_split(argv[i]->value.string);
892 for (j=0;j<words->len && truth;j++) {
893 truth = camel_search_header_match(header, words->words[j]->word, how, type, NULL);
895 camel_search_words_free(words);
897 truth = camel_search_header_match(header, argv[i]->value.string, how, type, NULL);
903 /* TODO: else, find all matches */
905 r = e_sexp_result_new(f, ESEXP_RES_BOOL);
906 r->value.bool = truth;
912 search_header_contains(struct _ESExp *f, int argc, struct _ESExpResult **argv, CamelFolderSearch *search)
914 return check_header(f, argc, argv, search, CAMEL_SEARCH_MATCH_CONTAINS);
918 search_header_matches(struct _ESExp *f, int argc, struct _ESExpResult **argv, CamelFolderSearch *search)
920 return check_header(f, argc, argv, search, CAMEL_SEARCH_MATCH_EXACT);
924 search_header_starts_with (struct _ESExp *f, int argc, struct _ESExpResult **argv, CamelFolderSearch *search)
926 return check_header(f, argc, argv, search, CAMEL_SEARCH_MATCH_STARTS);
930 search_header_ends_with (struct _ESExp *f, int argc, struct _ESExpResult **argv, CamelFolderSearch *search)
932 return check_header(f, argc, argv, search, CAMEL_SEARCH_MATCH_ENDS);
936 search_header_exists (struct _ESExp *f, int argc, struct _ESExpResult **argv, CamelFolderSearch *search)
940 r(printf ("executing header-exists\n"));
942 if (search->current) {
943 r = e_sexp_result_new(f, ESEXP_RES_BOOL);
944 if (argc == 1 && argv[0]->type == ESEXP_RES_STRING)
945 r->value.bool = camel_medium_get_header(CAMEL_MEDIUM(search->current), argv[0]->value.string) != NULL;
948 r = e_sexp_result_new(f, ESEXP_RES_ARRAY_PTR);
949 r->value.ptrarray = g_ptr_array_new();
955 /* this is just to OR results together */
956 struct _glib_sux_donkeys {
961 /* or, store all unique values */
963 g_lib_sux_htor(char *key, int value, struct _glib_sux_donkeys *fuckup)
965 g_ptr_array_add(fuckup->uids, key);
968 /* and, only store duplicates */
970 g_lib_sux_htand(char *key, int value, struct _glib_sux_donkeys *fuckup)
972 if (value == fuckup->count)
973 g_ptr_array_add(fuckup->uids, key);
977 match_message_index(CamelIndex *idx, const char *uid, const char *match, CamelException *ex)
979 CamelIndexCursor *wc, *nc;
980 const char *word, *name;
983 wc = camel_index_words(idx);
985 while (!truth && (word = camel_index_cursor_next(wc))) {
986 if (camel_ustrstrcase(word,match) != NULL) {
987 /* perf: could have the wc cursor return the name cursor */
988 nc = camel_index_find(idx, word);
990 while (!truth && (name = camel_index_cursor_next(nc)))
991 truth = strcmp(name, uid) == 0;
992 camel_object_unref((CamelObject *)nc);
996 camel_object_unref((CamelObject *)wc);
1003 "one two" "three" "four five"
1012 /* returns messages which contain all words listed in words */
1014 match_words_index(CamelFolderSearch *search, struct _camel_search_words *words, CamelException *ex)
1016 GPtrArray *result = g_ptr_array_new();
1017 GHashTable *ht = g_hash_table_new(g_str_hash, g_str_equal);
1018 struct _glib_sux_donkeys lambdafoo;
1019 CamelIndexCursor *wc, *nc;
1020 const char *word, *name;
1021 CamelMessageInfo *mi;
1024 /* we can have a maximum of 32 words, as we use it as the AND mask */
1026 wc = camel_index_words(search->body_index);
1028 while ((word = camel_index_cursor_next(wc))) {
1029 for (i=0;i<words->len;i++) {
1030 if (camel_ustrstrcase(word, words->words[i]->word) != NULL) {
1031 /* perf: could have the wc cursor return the name cursor */
1032 nc = camel_index_find(search->body_index, word);
1034 while ((name = camel_index_cursor_next(nc))) {
1035 mi = g_hash_table_lookup(search->summary_hash, name);
1038 const char *uid = camel_message_info_uid(mi);
1040 mask = (GPOINTER_TO_INT(g_hash_table_lookup(ht, uid))) | (1<<i);
1041 g_hash_table_insert(ht, (char *)uid, GINT_TO_POINTER(mask));
1044 camel_object_unref((CamelObject *)nc);
1049 camel_object_unref((CamelObject *)wc);
1051 lambdafoo.uids = result;
1052 lambdafoo.count = (1<<words->len) - 1;
1053 g_hash_table_foreach(ht, (GHFunc)g_lib_sux_htand, &lambdafoo);
1054 g_hash_table_destroy(ht);
1061 match_words_1message (CamelDataWrapper *object, struct _camel_search_words *words, guint32 *mask)
1063 CamelDataWrapper *containee;
1067 containee = camel_medium_get_content_object (CAMEL_MEDIUM (object));
1069 if (containee == NULL)
1072 /* using the object types is more accurate than using the mime/types */
1073 if (CAMEL_IS_MULTIPART (containee)) {
1074 parts = camel_multipart_get_number (CAMEL_MULTIPART (containee));
1075 for (i = 0; i < parts && truth == FALSE; i++) {
1076 CamelDataWrapper *part = (CamelDataWrapper *)camel_multipart_get_part (CAMEL_MULTIPART (containee), i);
1078 truth = match_words_1message(part, words, mask);
1080 } else if (CAMEL_IS_MIME_MESSAGE (containee)) {
1081 /* for messages we only look at its contents */
1082 truth = match_words_1message((CamelDataWrapper *)containee, words, mask);
1083 } else if (camel_content_type_is(CAMEL_DATA_WRAPPER (containee)->mime_type, "text", "*")) {
1084 /* for all other text parts, we look inside, otherwise we dont care */
1085 CamelStreamMem *mem = (CamelStreamMem *)camel_stream_mem_new ();
1087 /* FIXME: The match should be part of a stream op */
1088 camel_data_wrapper_decode_to_stream (containee, CAMEL_STREAM (mem));
1089 camel_stream_write (CAMEL_STREAM (mem), "", 1);
1090 for (i=0;i<words->len;i++) {
1091 /* FIXME: This is horridly slow, and should use a real search algorithm */
1092 if (camel_ustrstrcase(mem->buffer->data, words->words[i]->word) != NULL) {
1094 /* shortcut a match */
1095 if (*mask == (1<<(words->len))-1)
1100 camel_object_unref (mem);
1107 match_words_message(CamelFolder *folder, const char *uid, struct _camel_search_words *words, CamelException *ex)
1110 CamelMimeMessage *msg;
1113 msg = camel_folder_get_message(folder, uid, ex);
1116 truth = match_words_1message((CamelDataWrapper *)msg, words, &mask);
1117 camel_object_unref((CamelObject *)msg);
1119 camel_exception_clear(ex);
1127 match_words_messages(CamelFolderSearch *search, struct _camel_search_words *words, CamelException *ex)
1130 GPtrArray *matches = g_ptr_array_new();
1132 if (search->body_index) {
1134 struct _camel_search_words *simple;
1136 simple = camel_search_words_simple(words);
1137 indexed = match_words_index(search, simple, ex);
1138 camel_search_words_free(simple);
1140 for (i=0;i<indexed->len;i++) {
1141 const char *uid = g_ptr_array_index(indexed, i);
1143 if (match_words_message(search->folder, uid, words, ex))
1144 g_ptr_array_add(matches, (char *)uid);
1147 g_ptr_array_free(indexed, TRUE);
1149 GPtrArray *v = search->summary_set?search->summary_set:search->summary;
1151 for (i=0;i<v->len;i++) {
1152 CamelMessageInfo *info = g_ptr_array_index(v, i);
1153 const char *uid = camel_message_info_uid(info);
1155 if (match_words_message(search->folder, uid, words, ex))
1156 g_ptr_array_add(matches, (char *)uid);
1163 static ESExpResult *
1164 search_body_contains(struct _ESExp *f, int argc, struct _ESExpResult **argv, CamelFolderSearch *search)
1167 CamelException *ex = search->priv->ex;
1168 struct _camel_search_words *words;
1170 struct _glib_sux_donkeys lambdafoo;
1172 if (search->current) {
1175 if (argc == 1 && argv[0]->value.string[0] == 0) {
1178 for (i=0;i<argc && !truth;i++) {
1179 if (argv[i]->type == ESEXP_RES_STRING) {
1180 words = camel_search_words_split(argv[i]->value.string);
1182 if ((words->type & CAMEL_SEARCH_WORD_COMPLEX) == 0 && search->body_index) {
1183 for (j=0;j<words->len && truth;j++)
1184 truth = match_message_index(search->body_index, camel_message_info_uid(search->current), words->words[j]->word, ex);
1186 /* TODO: cache current message incase of multiple body search terms */
1187 truth = match_words_message(search->folder, camel_message_info_uid(search->current), words, ex);
1189 camel_search_words_free(words);
1193 r = e_sexp_result_new(f, ESEXP_RES_BOOL);
1194 r->value.bool = truth;
1196 r = e_sexp_result_new(f, ESEXP_RES_ARRAY_PTR);
1197 r->value.ptrarray = g_ptr_array_new();
1199 if (argc == 1 && argv[0]->value.string[0] == 0) {
1200 GPtrArray *v = search->summary_set?search->summary_set:search->summary;
1202 for (i=0;i<v->len;i++) {
1203 CamelMessageInfo *info = g_ptr_array_index(v, i);
1205 g_ptr_array_add(r->value.ptrarray, (char *)camel_message_info_uid(info));
1208 GHashTable *ht = g_hash_table_new(g_str_hash, g_str_equal);
1211 for (i=0;i<argc;i++) {
1212 if (argv[i]->type == ESEXP_RES_STRING) {
1213 words = camel_search_words_split(argv[i]->value.string);
1214 if ((words->type & CAMEL_SEARCH_WORD_COMPLEX) == 0 && search->body_index) {
1215 matches = match_words_index(search, words, ex);
1217 matches = match_words_messages(search, words, ex);
1219 for (j=0;j<matches->len;j++)
1220 g_hash_table_insert(ht, matches->pdata[j], matches->pdata[j]);
1221 g_ptr_array_free(matches, TRUE);
1222 camel_search_words_free(words);
1225 lambdafoo.uids = r->value.ptrarray;
1226 g_hash_table_foreach(ht, (GHFunc)g_lib_sux_htor, &lambdafoo);
1227 g_hash_table_destroy(ht);
1234 static ESExpResult *
1235 search_user_flag(struct _ESExp *f, int argc, struct _ESExpResult **argv, CamelFolderSearch *search)
1240 r(printf("executing user-flag\n"));
1242 /* are we inside a match-all? */
1243 if (search->current) {
1245 /* performs an OR of all words */
1246 for (i=0;i<argc && !truth;i++) {
1247 if (argv[i]->type == ESEXP_RES_STRING
1248 && camel_flag_get(&search->current->user_flags, argv[i]->value.string)) {
1253 r = e_sexp_result_new(f, ESEXP_RES_BOOL);
1254 r->value.bool = truth;
1256 r = e_sexp_result_new(f, ESEXP_RES_ARRAY_PTR);
1257 r->value.ptrarray = g_ptr_array_new();
1263 static ESExpResult *
1264 search_system_flag (struct _ESExp *f, int argc, struct _ESExpResult **argv, CamelFolderSearch *search)
1268 r(printf ("executing system-flag\n"));
1270 if (search->current) {
1271 gboolean truth = FALSE;
1274 truth = camel_system_flag_get (search->current->flags, argv[0]->value.string);
1276 r = e_sexp_result_new(f, ESEXP_RES_BOOL);
1277 r->value.bool = truth;
1279 r = e_sexp_result_new(f, ESEXP_RES_ARRAY_PTR);
1280 r->value.ptrarray = g_ptr_array_new ();
1286 static ESExpResult *
1287 search_user_tag(struct _ESExp *f, int argc, struct _ESExpResult **argv, CamelFolderSearch *search)
1289 const char *value = NULL;
1292 r(printf("executing user-tag\n"));
1295 value = camel_tag_get (&search->current->user_tags, argv[0]->value.string);
1297 r = e_sexp_result_new(f, ESEXP_RES_STRING);
1298 r->value.string = g_strdup (value ? value : "");
1303 static ESExpResult *
1304 search_get_sent_date(struct _ESExp *f, int argc, struct _ESExpResult **argv, CamelFolderSearch *s)
1308 r(printf("executing get-sent-date\n"));
1310 /* are we inside a match-all? */
1312 r = e_sexp_result_new(f, ESEXP_RES_INT);
1314 r->value.number = s->current->date_sent;
1316 r = e_sexp_result_new(f, ESEXP_RES_ARRAY_PTR);
1317 r->value.ptrarray = g_ptr_array_new ();
1323 static ESExpResult *
1324 search_get_received_date(struct _ESExp *f, int argc, struct _ESExpResult **argv, CamelFolderSearch *s)
1328 r(printf("executing get-received-date\n"));
1330 /* are we inside a match-all? */
1332 r = e_sexp_result_new(f, ESEXP_RES_INT);
1334 r->value.number = s->current->date_received;
1336 r = e_sexp_result_new(f, ESEXP_RES_ARRAY_PTR);
1337 r->value.ptrarray = g_ptr_array_new ();
1343 static ESExpResult *
1344 search_get_current_date(struct _ESExp *f, int argc, struct _ESExpResult **argv, CamelFolderSearch *s)
1348 r(printf("executing get-current-date\n"));
1350 r = e_sexp_result_new(f, ESEXP_RES_INT);
1351 r->value.number = time (NULL);
1355 static ESExpResult *
1356 search_get_size (struct _ESExp *f, int argc, struct _ESExpResult **argv, CamelFolderSearch *s)
1360 r(printf("executing get-size\n"));
1362 /* are we inside a match-all? */
1364 r = e_sexp_result_new (f, ESEXP_RES_INT);
1365 r->value.number = s->current->size / 1024;
1367 r = e_sexp_result_new (f, ESEXP_RES_ARRAY_PTR);
1368 r->value.ptrarray = g_ptr_array_new ();
1374 static ESExpResult *
1375 search_uid(struct _ESExp *f, int argc, struct _ESExpResult **argv, CamelFolderSearch *search)
1380 r(printf("executing uid\n"));
1382 /* are we inside a match-all? */
1383 if (search->current) {
1385 const char *uid = camel_message_info_uid(search->current);
1387 /* performs an OR of all words */
1388 for (i=0;i<argc && !truth;i++) {
1389 if (argv[i]->type == ESEXP_RES_STRING
1390 && !strcmp(uid, argv[i]->value.string)) {
1395 r = e_sexp_result_new(f, ESEXP_RES_BOOL);
1396 r->value.bool = truth;
1398 r = e_sexp_result_new(f, ESEXP_RES_ARRAY_PTR);
1399 r->value.ptrarray = g_ptr_array_new();
1400 for (i=0;i<argc;i++) {
1401 if (argv[i]->type == ESEXP_RES_STRING)
1402 g_ptr_array_add(r->value.ptrarray, argv[i]->value.string);