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"
48 #include "camel-i18n.h"
53 struct _CamelFolderSearchPrivate {
54 GHashTable *mempool_hash;
57 CamelFolderThread *threads;
58 GHashTable *threads_hash;
61 #define _PRIVATE(o) (((CamelFolderSearch *)(o))->priv)
63 static ESExpResult *search_not(struct _ESExp *f, int argc, struct _ESExpResult **argv, CamelFolderSearch *search);
65 static ESExpResult *search_header_contains(struct _ESExp *f, int argc, struct _ESExpResult **argv, CamelFolderSearch *search);
66 static ESExpResult *search_header_matches(struct _ESExp *f, int argc, struct _ESExpResult **argv, CamelFolderSearch *search);
67 static ESExpResult *search_header_starts_with(struct _ESExp *f, int argc, struct _ESExpResult **argv, CamelFolderSearch *search);
68 static ESExpResult *search_header_ends_with(struct _ESExp *f, int argc, struct _ESExpResult **argv, CamelFolderSearch *search);
69 static ESExpResult *search_header_exists(struct _ESExp *f, int argc, struct _ESExpResult **argv, CamelFolderSearch *search);
70 static ESExpResult *search_match_all(struct _ESExp *f, int argc, struct _ESExpTerm **argv, CamelFolderSearch *search);
71 static ESExpResult *search_match_threads(struct _ESExp *f, int argc, struct _ESExpTerm **argv, CamelFolderSearch *s);
72 static ESExpResult *search_body_contains(struct _ESExp *f, int argc, struct _ESExpResult **argv, CamelFolderSearch *search);
73 static ESExpResult *search_user_flag(struct _ESExp *f, int argc, struct _ESExpResult **argv, CamelFolderSearch *s);
74 static ESExpResult *search_user_tag(struct _ESExp *f, int argc, struct _ESExpResult **argv, CamelFolderSearch *s);
75 static ESExpResult *search_system_flag(struct _ESExp *f, int argc, struct _ESExpResult **argv, CamelFolderSearch *s);
76 static ESExpResult *search_get_sent_date(struct _ESExp *f, int argc, struct _ESExpResult **argv, CamelFolderSearch *s);
77 static ESExpResult *search_get_received_date(struct _ESExp *f, int argc, struct _ESExpResult **argv, CamelFolderSearch *s);
78 static ESExpResult *search_get_current_date(struct _ESExp *f, int argc, struct _ESExpResult **argv, CamelFolderSearch *s);
79 static ESExpResult *search_get_size(struct _ESExp *f, int argc, struct _ESExpResult **argv, CamelFolderSearch *s);
80 static ESExpResult *search_uid(struct _ESExp *f, int argc, struct _ESExpResult **argv, CamelFolderSearch *s);
82 static ESExpResult *search_dummy(struct _ESExp *f, int argc, struct _ESExpResult **argv, CamelFolderSearch *search);
84 static void camel_folder_search_class_init (CamelFolderSearchClass *klass);
85 static void camel_folder_search_init (CamelFolderSearch *obj);
86 static void camel_folder_search_finalize (CamelObject *obj);
88 static CamelObjectClass *camel_folder_search_parent;
91 camel_folder_search_class_init (CamelFolderSearchClass *klass)
93 camel_folder_search_parent = camel_type_get_global_classfuncs (camel_object_get_type ());
95 klass->not = search_not;
97 klass->match_all = search_match_all;
98 klass->match_threads = search_match_threads;
99 klass->body_contains = search_body_contains;
100 klass->header_contains = search_header_contains;
101 klass->header_matches = search_header_matches;
102 klass->header_starts_with = search_header_starts_with;
103 klass->header_ends_with = search_header_ends_with;
104 klass->header_exists = search_header_exists;
105 klass->user_tag = search_user_tag;
106 klass->user_flag = search_user_flag;
107 klass->system_flag = search_system_flag;
108 klass->get_sent_date = search_get_sent_date;
109 klass->get_received_date = search_get_received_date;
110 klass->get_current_date = search_get_current_date;
111 klass->get_size = search_get_size;
112 klass->uid = search_uid;
116 camel_folder_search_init (CamelFolderSearch *obj)
118 struct _CamelFolderSearchPrivate *p;
120 p = _PRIVATE(obj) = g_malloc0(sizeof(*p));
122 obj->sexp = e_sexp_new();
124 /* use a hash of mempools to associate the returned uid lists with
125 the backing mempool. yes pretty weird, but i didn't want to change
128 p->mempool_hash = g_hash_table_new(0, 0);
132 free_mempool(void *key, void *value, void *data)
134 GPtrArray *uids = key;
135 EMemPool *pool = value;
137 g_warning("Search closed with outstanding result unfreed: %p", uids);
139 g_ptr_array_free(uids, TRUE);
140 e_mempool_destroy(pool);
144 camel_folder_search_finalize (CamelObject *obj)
146 CamelFolderSearch *search = (CamelFolderSearch *)obj;
147 struct _CamelFolderSearchPrivate *p = _PRIVATE(obj);
150 e_sexp_unref(search->sexp);
151 if (search->summary_hash)
152 g_hash_table_destroy(search->summary_hash);
154 g_free(search->last_search);
155 g_hash_table_foreach(p->mempool_hash, free_mempool, obj);
156 g_hash_table_destroy(p->mempool_hash);
161 camel_folder_search_get_type (void)
163 static CamelType type = CAMEL_INVALID_TYPE;
165 if (type == CAMEL_INVALID_TYPE) {
166 type = camel_type_register (camel_object_get_type (), "CamelFolderSearch",
167 sizeof (CamelFolderSearch),
168 sizeof (CamelFolderSearchClass),
169 (CamelObjectClassInitFunc) camel_folder_search_class_init,
171 (CamelObjectInitFunc) camel_folder_search_init,
172 (CamelObjectFinalizeFunc) camel_folder_search_finalize);
179 #define CAMEL_STRUCT_OFFSET(type, field) ((gint) offsetof (type, field))
181 #define CAMEL_STRUCT_OFFSET(type, field) ((gint) ((gchar*) &((type *) 0)->field))
187 int flags; /* 0x02 = immediate, 0x01 = always enter */
189 /* these have default implementations in e-sexp */
190 { "and", CAMEL_STRUCT_OFFSET(CamelFolderSearchClass, and), 2 },
191 { "or", CAMEL_STRUCT_OFFSET(CamelFolderSearchClass, or), 2 },
192 /* we need to override this one though to implement an 'array not' */
193 { "not", CAMEL_STRUCT_OFFSET(CamelFolderSearchClass, not), 0 },
194 { "<", CAMEL_STRUCT_OFFSET(CamelFolderSearchClass, lt), 2 },
195 { ">", CAMEL_STRUCT_OFFSET(CamelFolderSearchClass, gt), 2 },
196 { "=", CAMEL_STRUCT_OFFSET(CamelFolderSearchClass, eq), 2 },
198 /* these we have to use our own default if there is none */
199 /* they should all be defined in the language? so it parses, or should they not?? */
200 { "match-all", CAMEL_STRUCT_OFFSET(CamelFolderSearchClass, match_all), 3 },
201 { "match-threads", CAMEL_STRUCT_OFFSET(CamelFolderSearchClass, match_threads), 3 },
202 { "body-contains", CAMEL_STRUCT_OFFSET(CamelFolderSearchClass, body_contains), 1 },
203 { "header-contains", CAMEL_STRUCT_OFFSET(CamelFolderSearchClass, header_contains), 1 },
204 { "header-matches", CAMEL_STRUCT_OFFSET(CamelFolderSearchClass, header_matches), 1 },
205 { "header-starts-with", CAMEL_STRUCT_OFFSET(CamelFolderSearchClass, header_starts_with), 1 },
206 { "header-ends-with", CAMEL_STRUCT_OFFSET(CamelFolderSearchClass, header_ends_with), 1 },
207 { "header-exists", CAMEL_STRUCT_OFFSET(CamelFolderSearchClass, header_exists), 1 },
208 { "user-tag", CAMEL_STRUCT_OFFSET(CamelFolderSearchClass, user_tag), 1 },
209 { "user-flag", CAMEL_STRUCT_OFFSET(CamelFolderSearchClass, user_flag), 1 },
210 { "system-flag", CAMEL_STRUCT_OFFSET(CamelFolderSearchClass, system_flag), 1 },
211 { "get-sent-date", CAMEL_STRUCT_OFFSET(CamelFolderSearchClass, get_sent_date), 1 },
212 { "get-received-date", CAMEL_STRUCT_OFFSET(CamelFolderSearchClass, get_received_date), 1 },
213 { "get-current-date", CAMEL_STRUCT_OFFSET(CamelFolderSearchClass, get_current_date), 1 },
214 { "get-size", CAMEL_STRUCT_OFFSET(CamelFolderSearchClass, get_size), 1 },
215 { "uid", CAMEL_STRUCT_OFFSET(CamelFolderSearchClass, uid), 1 },
219 camel_folder_search_construct (CamelFolderSearch *search)
222 CamelFolderSearchClass *klass = (CamelFolderSearchClass *)CAMEL_OBJECT_GET_CLASS(search);
224 for (i=0;i<sizeof(builtins)/sizeof(builtins[0]);i++) {
226 /* c is sure messy sometimes */
227 func = *((void **)(((char *)klass)+builtins[i].offset));
228 if (func == NULL && builtins[i].flags&1) {
229 g_warning("Search class doesn't implement '%s' method: %s", builtins[i].name, camel_type_to_name(CAMEL_OBJECT_GET_CLASS(search)));
230 func = (void *)search_dummy;
233 if (builtins[i].flags&2) {
234 e_sexp_add_ifunction(search->sexp, 0, builtins[i].name, (ESExpIFunc *)func, search);
236 e_sexp_add_function(search->sexp, 0, builtins[i].name, (ESExpFunc *)func, search);
243 * camel_folder_search_new:
245 * Create a new CamelFolderSearch object.
247 * A CamelFolderSearch is a subclassable, extensible s-exp
248 * evaluator which enforces a particular set of s-expressions.
249 * Particular methods may be overriden by an implementation to
250 * implement a search for any sort of backend.
252 * Return value: A new CamelFolderSearch widget.
255 camel_folder_search_new (void)
257 CamelFolderSearch *new = CAMEL_FOLDER_SEARCH (camel_object_new (camel_folder_search_get_type ()));
259 camel_folder_search_construct(new);
264 * camel_folder_search_set_folder:
268 * Set the folder attribute of the search. This is currently unused, but
269 * could be used to perform a slow-search when indexes and so forth are not
270 * available. Or for use by subclasses.
273 camel_folder_search_set_folder(CamelFolderSearch *search, CamelFolder *folder)
275 search->folder = folder;
279 * camel_folder_search_set_summary:
281 * @summary: An array of CamelMessageInfo pointers.
283 * Set the array of summary objects representing the span of the search.
285 * If this is not set, then a subclass must provide the functions
286 * for searching headers and for the match-all operator.
289 camel_folder_search_set_summary(CamelFolderSearch *search, GPtrArray *summary)
293 search->summary = summary;
294 if (search->summary_hash)
295 g_hash_table_destroy(search->summary_hash);
296 search->summary_hash = g_hash_table_new(g_str_hash, g_str_equal);
297 for (i=0;i<summary->len;i++)
298 g_hash_table_insert(search->summary_hash, (char *)camel_message_info_uid(summary->pdata[i]), summary->pdata[i]);
302 * camel_folder_search_set_body_index:
306 * Set the index representing the contents of all messages
307 * in this folder. If this is not set, then the folder implementation
308 * should sub-class the CamelFolderSearch and provide its own
309 * body-contains function.
312 camel_folder_search_set_body_index(CamelFolderSearch *search, CamelIndex *index)
314 if (search->body_index)
315 camel_object_unref((CamelObject *)search->body_index);
316 search->body_index = index;
318 camel_object_ref((CamelObject *)index);
322 * camel_folder_search_execute_expression:
327 * Execute the search expression @expr, returning an array of
328 * all matches as a GPtrArray of uid's of matching messages.
330 * Note that any settings such as set_body_index(), set_folder(),
331 * and so on are reset to #NULL once the search has completed.
333 * TODO: The interface should probably return summary items instead
334 * (since they are much more useful to any client).
336 * Return value: A GPtrArray of strings of all matching messages.
337 * This must only be freed by camel_folder_search_free_result.
340 camel_folder_search_execute_expression(CamelFolderSearch *search, const char *expr, CamelException *ex)
347 struct _CamelFolderSearchPrivate *p = _PRIVATE(search);
351 /* only re-parse if the search has changed */
352 if (search->last_search == NULL
353 || strcmp(search->last_search, expr)) {
354 e_sexp_input_text(search->sexp, expr, strlen(expr));
355 if (e_sexp_parse(search->sexp) == -1) {
356 camel_exception_setv(ex, 1, _("Cannot parse search expression: %s:\n%s"), e_sexp_error(search->sexp), expr);
360 g_free(search->last_search);
361 search->last_search = g_strdup(expr);
363 r = e_sexp_eval(search->sexp);
365 if (!camel_exception_is_set(ex))
366 camel_exception_setv(ex, 1, _("Error executing search expression: %s:\n%s"), e_sexp_error(search->sexp), expr);
370 matches = g_ptr_array_new();
372 /* now create a folder summary to return?? */
373 if (r->type == ESEXP_RES_ARRAY_PTR) {
374 d(printf("got result ...\n"));
375 /* we use a mempool to store the strings, packed in tight as possible, and freed together */
376 /* because the strings are often short (like <8 bytes long), we would be wasting appx 50%
377 of memory just storing the size tag that malloc assigns us and alignment padding, so this
378 gets around that (and is faster to allocate and free as a bonus) */
379 pool = e_mempool_new(512, 256, E_MEMPOOL_ALIGN_BYTE);
380 if (search->summary) {
381 /* reorder result in summary order */
382 results = g_hash_table_new(g_str_hash, g_str_equal);
383 for (i=0;i<r->value.ptrarray->len;i++) {
384 d(printf("adding match: %s\n", (char *)g_ptr_array_index(r->value.ptrarray, i)));
385 g_hash_table_insert(results, g_ptr_array_index(r->value.ptrarray, i), GINT_TO_POINTER (1));
387 for (i=0;i<search->summary->len;i++) {
388 CamelMessageInfo *info = g_ptr_array_index(search->summary, i);
389 char *uid = (char *)camel_message_info_uid(info);
390 if (g_hash_table_lookup(results, uid)) {
391 g_ptr_array_add(matches, e_mempool_strdup(pool, uid));
394 g_hash_table_destroy(results);
396 for (i=0;i<r->value.ptrarray->len;i++) {
397 d(printf("adding match: %s\n", (char *)g_ptr_array_index(r->value.ptrarray, i)));
398 g_ptr_array_add(matches, e_mempool_strdup(pool, g_ptr_array_index(r->value.ptrarray, i)));
401 /* instead of putting the mempool_hash in the structure, we keep the api clean by
402 putting a reference to it in a hashtable. Lets us do some debugging and catch
403 unfree'd results as well. */
404 g_hash_table_insert(p->mempool_hash, matches, pool);
406 g_warning("Search returned an invalid result type");
409 e_sexp_result_free(search->sexp, r);
412 camel_folder_thread_messages_unref(p->threads);
414 g_hash_table_destroy(p->threads_hash);
417 p->threads_hash = NULL;
418 search->folder = NULL;
419 search->summary = NULL;
420 search->current = NULL;
421 search->body_index = NULL;
427 * camel_folder_search_search:
430 * @uids: to search against, NULL for all uid's.
433 * Run a search. Search must have had Folder already set on it, and
434 * it must implement summaries.
439 camel_folder_search_search(CamelFolderSearch *search, const char *expr, GPtrArray *uids, CamelException *ex)
442 GPtrArray *matches = NULL, *summary_set;
446 struct _CamelFolderSearchPrivate *p = _PRIVATE(search);
448 g_assert(search->folder);
452 /* setup our search list, summary_hash only contains those we're interested in */
453 search->summary = camel_folder_get_summary(search->folder);
454 search->summary_hash = g_hash_table_new(g_str_hash, g_str_equal);
457 GHashTable *uids_hash = g_hash_table_new(g_str_hash, g_str_equal);
459 summary_set = search->summary_set = g_ptr_array_new();
460 for (i=0;i<uids->len;i++)
461 g_hash_table_insert(uids_hash, uids->pdata[i], uids->pdata[i]);
462 for (i=0;i<search->summary->len;i++)
463 if (g_hash_table_lookup(uids_hash, camel_message_info_uid(search->summary->pdata[i])))
464 g_ptr_array_add(search->summary_set, search->summary->pdata[i]);
466 summary_set = search->summary;
469 for (i=0;i<summary_set->len;i++)
470 g_hash_table_insert(search->summary_hash, (char *)camel_message_info_uid(summary_set->pdata[i]), summary_set->pdata[i]);
472 /* only re-parse if the search has changed */
473 if (search->last_search == NULL
474 || strcmp(search->last_search, expr)) {
475 e_sexp_input_text(search->sexp, expr, strlen(expr));
476 if (e_sexp_parse(search->sexp) == -1) {
477 camel_exception_setv(ex, 1, _("Cannot parse search expression: %s:\n%s"), e_sexp_error(search->sexp), expr);
481 g_free(search->last_search);
482 search->last_search = g_strdup(expr);
484 r = e_sexp_eval(search->sexp);
486 if (!camel_exception_is_set(ex))
487 camel_exception_setv(ex, 1, _("Error executing search expression: %s:\n%s"), e_sexp_error(search->sexp), expr);
491 matches = g_ptr_array_new();
493 /* now create a folder summary to return?? */
494 if (r->type == ESEXP_RES_ARRAY_PTR) {
495 d(printf("got result ...\n"));
497 /* we use a mempool to store the strings, packed in tight as possible, and freed together */
498 /* because the strings are often short (like <8 bytes long), we would be wasting appx 50%
499 of memory just storing the size tag that malloc assigns us and alignment padding, so this
500 gets around that (and is faster to allocate and free as a bonus) */
501 pool = e_mempool_new(512, 256, E_MEMPOOL_ALIGN_BYTE);
502 /* reorder result in summary order */
503 results = g_hash_table_new(g_str_hash, g_str_equal);
504 for (i=0;i<r->value.ptrarray->len;i++) {
505 d(printf("adding match: %s\n", (char *)g_ptr_array_index(r->value.ptrarray, i)));
506 g_hash_table_insert(results, g_ptr_array_index(r->value.ptrarray, i), GINT_TO_POINTER (1));
509 for (i=0;i<summary_set->len;i++) {
510 CamelMessageInfo *info = g_ptr_array_index(summary_set, i);
511 char *uid = (char *)camel_message_info_uid(info);
512 if (g_hash_table_lookup(results, uid))
513 g_ptr_array_add(matches, e_mempool_strdup(pool, uid));
515 g_hash_table_destroy(results);
517 /* instead of putting the mempool_hash in the structure, we keep the api clean by
518 putting a reference to it in a hashtable. Lets us do some debugging and catch
519 unfree'd results as well. */
520 g_hash_table_insert(p->mempool_hash, matches, pool);
522 g_warning("Search returned an invalid result type");
525 e_sexp_result_free(search->sexp, r);
527 /* these might be allocated by match-threads */
529 camel_folder_thread_messages_unref(p->threads);
531 g_hash_table_destroy(p->threads_hash);
532 if (search->summary_set)
533 g_ptr_array_free(search->summary_set, TRUE);
534 g_hash_table_destroy(search->summary_hash);
535 camel_folder_free_summary(search->folder, search->summary);
538 p->threads_hash = NULL;
539 search->folder = NULL;
540 search->summary = NULL;
541 search->summary_hash = NULL;
542 search->summary_set = NULL;
543 search->current = NULL;
544 search->body_index = NULL;
549 void camel_folder_search_free_result(CamelFolderSearch *search, GPtrArray *result)
552 struct _CamelFolderSearchPrivate *p = _PRIVATE(search);
555 pool = g_hash_table_lookup(p->mempool_hash, result);
557 e_mempool_destroy(pool);
558 g_hash_table_remove(p->mempool_hash, result);
560 for (i=0;i<result->len;i++)
561 g_free(g_ptr_array_index(result, i));
563 g_ptr_array_free(result, TRUE);
566 /* dummy function, returns false always, or an empty match array */
568 search_dummy(struct _ESExp *f, int argc, struct _ESExpResult **argv, CamelFolderSearch *search)
572 if (search->current == NULL) {
573 r = e_sexp_result_new(f, ESEXP_RES_BOOL);
574 r->value.bool = FALSE;
576 r = e_sexp_result_new(f, ESEXP_RES_ARRAY_PTR);
577 r->value.ptrarray = g_ptr_array_new();
583 /* impelemnt an 'array not', i.e. everything in the summary, not in the supplied array */
585 search_not(struct _ESExp *f, int argc, struct _ESExpResult **argv, CamelFolderSearch *search)
591 if (argv[0]->type == ESEXP_RES_ARRAY_PTR) {
592 GPtrArray *v = argv[0]->value.ptrarray;
595 r = e_sexp_result_new(f, ESEXP_RES_ARRAY_PTR);
596 r->value.ptrarray = g_ptr_array_new();
598 /* not against a single message?*/
599 if (search->current) {
602 uid = camel_message_info_uid(search->current);
603 for (i=0;!found && i<v->len;i++) {
604 if (strcmp(uid, v->pdata[i]) == 0)
609 g_ptr_array_add(r->value.ptrarray, (char *)uid);
610 } else if (search->summary == NULL) {
611 g_warning("No summary set, 'not' against an array requires a summary");
613 /* 'not' against the whole summary */
614 GHashTable *have = g_hash_table_new(g_str_hash, g_str_equal);
616 CamelMessageInfo **m;
618 s = (char **)v->pdata;
619 for (i=0;i<v->len;i++)
620 g_hash_table_insert(have, s[i], s[i]);
622 v = search->summary_set?search->summary_set:search->summary;
623 m = (CamelMessageInfo **)v->pdata;
624 for (i=0;i<v->len;i++) {
625 char *uid = (char *)camel_message_info_uid(m[i]);
627 if (g_hash_table_lookup(have, uid) == NULL)
628 g_ptr_array_add(r->value.ptrarray, uid);
630 g_hash_table_destroy(have);
635 if (argv[0]->type == ESEXP_RES_BOOL)
636 res = ! argv[0]->value.bool;
638 r = e_sexp_result_new(f, ESEXP_RES_BOOL);
642 r = e_sexp_result_new(f, ESEXP_RES_BOOL);
643 r->value.bool = TRUE;
650 search_match_all(struct _ESExp *f, int argc, struct _ESExpTerm **argv, CamelFolderSearch *search)
657 g_warning("match-all only takes a single argument, other arguments ignored");
660 /* we are only matching a single message? or already inside a match-all? */
661 if (search->current) {
662 d(printf("matching against 1 message: %s\n", camel_message_info_subject(search->current)));
664 r = e_sexp_result_new(f, ESEXP_RES_BOOL);
665 r->value.bool = FALSE;
668 r1 = e_sexp_term_eval(f, argv[0]);
669 if (r1->type == ESEXP_RES_BOOL) {
670 r->value.bool = r1->value.bool;
672 g_warning("invalid syntax, matches require a single bool result");
673 e_sexp_fatal_error(f, _("(match-all) requires a single bool result"));
675 e_sexp_result_free(f, r1);
677 r->value.bool = TRUE;
682 r = e_sexp_result_new(f, ESEXP_RES_ARRAY_PTR);
683 r->value.ptrarray = g_ptr_array_new();
685 if (search->summary == NULL) {
686 /* TODO: make it work - e.g. use the folder and so forth for a slower search */
687 g_warning("No summary supplied, match-all doesn't work with no summary");
692 v = search->summary_set?search->summary_set:search->summary;
693 for (i=0;i<v->len;i++) {
696 search->current = g_ptr_array_index(v, i);
697 uid = camel_message_info_uid(search->current);
700 r1 = e_sexp_term_eval(f, argv[0]);
701 if (r1->type == ESEXP_RES_BOOL) {
703 g_ptr_array_add(r->value.ptrarray, (char *)uid);
705 g_warning("invalid syntax, matches require a single bool result");
706 e_sexp_fatal_error(f, _("(match-all) requires a single bool result"));
708 e_sexp_result_free(f, r1);
710 g_ptr_array_add(r->value.ptrarray, (char *)uid);
713 search->current = NULL;
719 fill_thread_table(struct _CamelFolderThreadNode *root, GHashTable *id_hash)
722 g_hash_table_insert(id_hash, (char *)camel_message_info_uid(root->message), root);
724 fill_thread_table(root->child, id_hash);
730 add_thread_results(struct _CamelFolderThreadNode *root, GHashTable *result_hash)
733 g_hash_table_insert(result_hash, (char *)camel_message_info_uid(root->message), GINT_TO_POINTER (1));
735 add_thread_results(root->child, result_hash);
741 add_results(char *uid, void *dummy, GPtrArray *result)
743 g_ptr_array_add(result, uid);
747 search_match_threads(struct _ESExp *f, int argc, struct _ESExpTerm **argv, CamelFolderSearch *search)
750 struct _CamelFolderSearchPrivate *p = search->priv;
754 /* not supported in match-all */
756 e_sexp_fatal_error(f, _("(match-threads) not allowed inside match-all"));
759 e_sexp_fatal_error(f, _("(match-threads) requires a match type string"));
761 r = e_sexp_term_eval(f, argv[0]);
762 if (r->type != ESEXP_RES_STRING)
763 e_sexp_fatal_error(f, _("(match-threads) requires a match type string"));
766 if (!strcmp(r->value.string, "none"))
768 else if (!strcmp(r->value.string, "all"))
770 else if (!strcmp(r->value.string, "replies"))
772 else if (!strcmp(r->value.string, "replies_parents"))
774 e_sexp_result_free(f, r);
776 /* behave as (begin does */
778 for (i=1;i<argc;i++) {
780 e_sexp_result_free(f, r);
781 r = e_sexp_term_eval(f, argv[i]);
784 if (r == NULL || r->type != ESEXP_RES_ARRAY_PTR)
785 e_sexp_fatal_error(f, _("(match-threads) expects an array result"));
790 if (search->folder == NULL)
791 e_sexp_fatal_error(f, _("(match-threads) requires the folder set"));
793 /* cache this, so we only have to re-calculate once per search at most */
794 if (p->threads == NULL) {
795 p->threads = camel_folder_thread_messages_new(search->folder, NULL, TRUE);
796 p->threads_hash = g_hash_table_new(g_str_hash, g_str_equal);
798 fill_thread_table(p->threads->tree, p->threads_hash);
801 results = g_hash_table_new(g_str_hash, g_str_equal);
802 for (i=0;i<r->value.ptrarray->len;i++) {
803 d(printf("adding match: %s\n", (char *)g_ptr_array_index(r->value.ptrarray, i)));
804 g_hash_table_insert(results, g_ptr_array_index(r->value.ptrarray, i), GINT_TO_POINTER (1));
807 for (i=0;i<r->value.ptrarray->len;i++) {
808 struct _CamelFolderThreadNode *node, *scan;
810 node = g_hash_table_lookup(p->threads_hash, (char *)g_ptr_array_index(r->value.ptrarray, i));
811 if (node == NULL) /* this shouldn't happen but why cry over spilt milk */
814 /* select messages in thread according to search criteria */
817 while (scan && scan->parent) {
819 g_hash_table_insert(results, (char *)camel_message_info_uid(scan->message), GINT_TO_POINTER(1));
821 } else if (type == 1) {
822 while (node && node->parent)
825 g_hash_table_insert(results, (char *)camel_message_info_uid(node->message), GINT_TO_POINTER(1));
827 add_thread_results(node->child, results);
829 e_sexp_result_free(f, r);
831 r = e_sexp_result_new(f, ESEXP_RES_ARRAY_PTR);
832 r->value.ptrarray = g_ptr_array_new();
834 g_hash_table_foreach(results, (GHFunc)add_results, r->value.ptrarray);
835 g_hash_table_destroy(results);
841 check_header(struct _ESExp *f, int argc, struct _ESExpResult **argv, CamelFolderSearch *search, camel_search_match_t how)
846 r(printf("executing check-header %d\n", how));
848 /* are we inside a match-all? */
849 if (search->current && argc>1
850 && argv[0]->type == ESEXP_RES_STRING) {
852 const char *header = NULL;
855 camel_search_t type = CAMEL_SEARCH_TYPE_ASIS;
856 struct _camel_search_words *words;
858 /* only a subset of headers are supported .. */
859 headername = argv[0]->value.string;
860 if (!strcasecmp(headername, "subject")) {
861 header = camel_message_info_subject(search->current);
862 } else if (!strcasecmp(headername, "date")) {
863 /* FIXME: not a very useful form of the date */
864 sprintf(strbuf, "%d", (int)search->current->date_sent);
866 } else if (!strcasecmp(headername, "from")) {
867 header = camel_message_info_from(search->current);
868 type = CAMEL_SEARCH_TYPE_ADDRESS;
869 } else if (!strcasecmp(headername, "to")) {
870 header = camel_message_info_to(search->current);
871 type = CAMEL_SEARCH_TYPE_ADDRESS;
872 } else if (!strcasecmp(headername, "cc")) {
873 header = camel_message_info_cc(search->current);
874 type = CAMEL_SEARCH_TYPE_ADDRESS;
875 } else if (!strcasecmp(headername, "x-camel-mlist")) {
876 header = camel_message_info_mlist(search->current);
877 type = CAMEL_SEARCH_TYPE_MLIST;
879 e_sexp_resultv_free(f, argc, argv);
880 e_sexp_fatal_error(f, _("Performing query on unknown header: %s"), headername);
884 /* performs an OR of all words */
885 for (i=1;i<argc && !truth;i++) {
886 if (argv[i]->type == ESEXP_RES_STRING) {
887 if (argv[i]->value.string[0] == 0) {
889 } else if (how == CAMEL_SEARCH_MATCH_CONTAINS) {
890 /* doesn't make sense to split words on anything but contains i.e. we can't have an ending match different words */
891 words = camel_search_words_split(argv[i]->value.string);
893 for (j=0;j<words->len && truth;j++) {
894 truth = camel_search_header_match(header, words->words[j]->word, how, type, NULL);
896 camel_search_words_free(words);
898 truth = camel_search_header_match(header, argv[i]->value.string, how, type, NULL);
904 /* TODO: else, find all matches */
906 r = e_sexp_result_new(f, ESEXP_RES_BOOL);
907 r->value.bool = truth;
913 search_header_contains(struct _ESExp *f, int argc, struct _ESExpResult **argv, CamelFolderSearch *search)
915 return check_header(f, argc, argv, search, CAMEL_SEARCH_MATCH_CONTAINS);
919 search_header_matches(struct _ESExp *f, int argc, struct _ESExpResult **argv, CamelFolderSearch *search)
921 return check_header(f, argc, argv, search, CAMEL_SEARCH_MATCH_EXACT);
925 search_header_starts_with (struct _ESExp *f, int argc, struct _ESExpResult **argv, CamelFolderSearch *search)
927 return check_header(f, argc, argv, search, CAMEL_SEARCH_MATCH_STARTS);
931 search_header_ends_with (struct _ESExp *f, int argc, struct _ESExpResult **argv, CamelFolderSearch *search)
933 return check_header(f, argc, argv, search, CAMEL_SEARCH_MATCH_ENDS);
937 search_header_exists (struct _ESExp *f, int argc, struct _ESExpResult **argv, CamelFolderSearch *search)
941 r(printf ("executing header-exists\n"));
943 if (search->current) {
944 r = e_sexp_result_new(f, ESEXP_RES_BOOL);
945 if (argc == 1 && argv[0]->type == ESEXP_RES_STRING)
946 r->value.bool = camel_medium_get_header(CAMEL_MEDIUM(search->current), argv[0]->value.string) != NULL;
949 r = e_sexp_result_new(f, ESEXP_RES_ARRAY_PTR);
950 r->value.ptrarray = g_ptr_array_new();
956 /* this is just to OR results together */
957 struct _glib_sux_donkeys {
962 /* or, store all unique values */
964 g_lib_sux_htor(char *key, int value, struct _glib_sux_donkeys *fuckup)
966 g_ptr_array_add(fuckup->uids, key);
969 /* and, only store duplicates */
971 g_lib_sux_htand(char *key, int value, struct _glib_sux_donkeys *fuckup)
973 if (value == fuckup->count)
974 g_ptr_array_add(fuckup->uids, key);
978 match_message_index(CamelIndex *idx, const char *uid, const char *match, CamelException *ex)
980 CamelIndexCursor *wc, *nc;
981 const char *word, *name;
984 wc = camel_index_words(idx);
986 while (!truth && (word = camel_index_cursor_next(wc))) {
987 if (camel_ustrstrcase(word,match) != NULL) {
988 /* perf: could have the wc cursor return the name cursor */
989 nc = camel_index_find(idx, word);
991 while (!truth && (name = camel_index_cursor_next(nc)))
992 truth = strcmp(name, uid) == 0;
993 camel_object_unref((CamelObject *)nc);
997 camel_object_unref((CamelObject *)wc);
1004 "one two" "three" "four five"
1013 /* returns messages which contain all words listed in words */
1015 match_words_index(CamelFolderSearch *search, struct _camel_search_words *words, CamelException *ex)
1017 GPtrArray *result = g_ptr_array_new();
1018 GHashTable *ht = g_hash_table_new(g_str_hash, g_str_equal);
1019 struct _glib_sux_donkeys lambdafoo;
1020 CamelIndexCursor *wc, *nc;
1021 const char *word, *name;
1022 CamelMessageInfo *mi;
1025 /* we can have a maximum of 32 words, as we use it as the AND mask */
1027 wc = camel_index_words(search->body_index);
1029 while ((word = camel_index_cursor_next(wc))) {
1030 for (i=0;i<words->len;i++) {
1031 if (camel_ustrstrcase(word, words->words[i]->word) != NULL) {
1032 /* perf: could have the wc cursor return the name cursor */
1033 nc = camel_index_find(search->body_index, word);
1035 while ((name = camel_index_cursor_next(nc))) {
1036 mi = g_hash_table_lookup(search->summary_hash, name);
1039 const char *uid = camel_message_info_uid(mi);
1041 mask = (GPOINTER_TO_INT(g_hash_table_lookup(ht, uid))) | (1<<i);
1042 g_hash_table_insert(ht, (char *)uid, GINT_TO_POINTER(mask));
1045 camel_object_unref((CamelObject *)nc);
1050 camel_object_unref((CamelObject *)wc);
1052 lambdafoo.uids = result;
1053 lambdafoo.count = (1<<words->len) - 1;
1054 g_hash_table_foreach(ht, (GHFunc)g_lib_sux_htand, &lambdafoo);
1055 g_hash_table_destroy(ht);
1062 match_words_1message (CamelDataWrapper *object, struct _camel_search_words *words, guint32 *mask)
1064 CamelDataWrapper *containee;
1068 containee = camel_medium_get_content_object (CAMEL_MEDIUM (object));
1070 if (containee == NULL)
1073 /* using the object types is more accurate than using the mime/types */
1074 if (CAMEL_IS_MULTIPART (containee)) {
1075 parts = camel_multipart_get_number (CAMEL_MULTIPART (containee));
1076 for (i = 0; i < parts && truth == FALSE; i++) {
1077 CamelDataWrapper *part = (CamelDataWrapper *)camel_multipart_get_part (CAMEL_MULTIPART (containee), i);
1079 truth = match_words_1message(part, words, mask);
1081 } else if (CAMEL_IS_MIME_MESSAGE (containee)) {
1082 /* for messages we only look at its contents */
1083 truth = match_words_1message((CamelDataWrapper *)containee, words, mask);
1084 } else if (camel_content_type_is(CAMEL_DATA_WRAPPER (containee)->mime_type, "text", "*")) {
1085 /* for all other text parts, we look inside, otherwise we dont care */
1086 CamelStreamMem *mem = (CamelStreamMem *)camel_stream_mem_new ();
1088 /* FIXME: The match should be part of a stream op */
1089 camel_data_wrapper_decode_to_stream (containee, CAMEL_STREAM (mem));
1090 camel_stream_write (CAMEL_STREAM (mem), "", 1);
1091 for (i=0;i<words->len;i++) {
1092 /* FIXME: This is horridly slow, and should use a real search algorithm */
1093 if (camel_ustrstrcase(mem->buffer->data, words->words[i]->word) != NULL) {
1095 /* shortcut a match */
1096 if (*mask == (1<<(words->len))-1)
1101 camel_object_unref (mem);
1108 match_words_message(CamelFolder *folder, const char *uid, struct _camel_search_words *words, CamelException *ex)
1111 CamelMimeMessage *msg;
1112 CamelException x = CAMEL_EXCEPTION_INITIALISER;
1115 msg = camel_folder_get_message(folder, uid, &x);
1118 truth = match_words_1message((CamelDataWrapper *)msg, words, &mask);
1119 camel_object_unref((CamelObject *)msg);
1121 camel_exception_clear(&x);
1129 match_words_messages(CamelFolderSearch *search, struct _camel_search_words *words, CamelException *ex)
1132 GPtrArray *matches = g_ptr_array_new();
1134 if (search->body_index) {
1136 struct _camel_search_words *simple;
1138 simple = camel_search_words_simple(words);
1139 indexed = match_words_index(search, simple, ex);
1140 camel_search_words_free(simple);
1142 for (i=0;i<indexed->len;i++) {
1143 const char *uid = g_ptr_array_index(indexed, i);
1145 if (match_words_message(search->folder, uid, words, ex))
1146 g_ptr_array_add(matches, (char *)uid);
1149 g_ptr_array_free(indexed, TRUE);
1151 GPtrArray *v = search->summary_set?search->summary_set:search->summary;
1153 for (i=0;i<v->len;i++) {
1154 CamelMessageInfo *info = g_ptr_array_index(v, i);
1155 const char *uid = camel_message_info_uid(info);
1157 if (match_words_message(search->folder, uid, words, ex))
1158 g_ptr_array_add(matches, (char *)uid);
1165 static ESExpResult *
1166 search_body_contains(struct _ESExp *f, int argc, struct _ESExpResult **argv, CamelFolderSearch *search)
1169 CamelException *ex = search->priv->ex;
1170 struct _camel_search_words *words;
1172 struct _glib_sux_donkeys lambdafoo;
1174 if (search->current) {
1177 if (argc == 1 && argv[0]->value.string[0] == 0) {
1180 for (i=0;i<argc && !truth;i++) {
1181 if (argv[i]->type == ESEXP_RES_STRING) {
1182 words = camel_search_words_split(argv[i]->value.string);
1184 if ((words->type & CAMEL_SEARCH_WORD_COMPLEX) == 0 && search->body_index) {
1185 for (j=0;j<words->len && truth;j++)
1186 truth = match_message_index(search->body_index, camel_message_info_uid(search->current), words->words[j]->word, ex);
1188 /* TODO: cache current message incase of multiple body search terms */
1189 truth = match_words_message(search->folder, camel_message_info_uid(search->current), words, ex);
1191 camel_search_words_free(words);
1195 r = e_sexp_result_new(f, ESEXP_RES_BOOL);
1196 r->value.bool = truth;
1198 r = e_sexp_result_new(f, ESEXP_RES_ARRAY_PTR);
1199 r->value.ptrarray = g_ptr_array_new();
1201 if (argc == 1 && argv[0]->value.string[0] == 0) {
1202 GPtrArray *v = search->summary_set?search->summary_set:search->summary;
1204 for (i=0;i<v->len;i++) {
1205 CamelMessageInfo *info = g_ptr_array_index(v, i);
1207 g_ptr_array_add(r->value.ptrarray, (char *)camel_message_info_uid(info));
1210 GHashTable *ht = g_hash_table_new(g_str_hash, g_str_equal);
1213 for (i=0;i<argc;i++) {
1214 if (argv[i]->type == ESEXP_RES_STRING) {
1215 words = camel_search_words_split(argv[i]->value.string);
1216 if ((words->type & CAMEL_SEARCH_WORD_COMPLEX) == 0 && search->body_index) {
1217 matches = match_words_index(search, words, ex);
1219 matches = match_words_messages(search, words, ex);
1221 for (j=0;j<matches->len;j++)
1222 g_hash_table_insert(ht, matches->pdata[j], matches->pdata[j]);
1223 g_ptr_array_free(matches, TRUE);
1224 camel_search_words_free(words);
1227 lambdafoo.uids = r->value.ptrarray;
1228 g_hash_table_foreach(ht, (GHFunc)g_lib_sux_htor, &lambdafoo);
1229 g_hash_table_destroy(ht);
1236 static ESExpResult *
1237 search_user_flag(struct _ESExp *f, int argc, struct _ESExpResult **argv, CamelFolderSearch *search)
1242 r(printf("executing user-flag\n"));
1244 /* are we inside a match-all? */
1245 if (search->current) {
1247 /* performs an OR of all words */
1248 for (i=0;i<argc && !truth;i++) {
1249 if (argv[i]->type == ESEXP_RES_STRING
1250 && camel_flag_get(&search->current->user_flags, argv[i]->value.string)) {
1255 r = e_sexp_result_new(f, ESEXP_RES_BOOL);
1256 r->value.bool = truth;
1258 r = e_sexp_result_new(f, ESEXP_RES_ARRAY_PTR);
1259 r->value.ptrarray = g_ptr_array_new();
1265 static ESExpResult *
1266 search_system_flag (struct _ESExp *f, int argc, struct _ESExpResult **argv, CamelFolderSearch *search)
1270 r(printf ("executing system-flag\n"));
1272 if (search->current) {
1273 gboolean truth = FALSE;
1276 truth = camel_system_flag_get (search->current->flags, argv[0]->value.string);
1278 r = e_sexp_result_new(f, ESEXP_RES_BOOL);
1279 r->value.bool = truth;
1281 r = e_sexp_result_new(f, ESEXP_RES_ARRAY_PTR);
1282 r->value.ptrarray = g_ptr_array_new ();
1288 static ESExpResult *
1289 search_user_tag(struct _ESExp *f, int argc, struct _ESExpResult **argv, CamelFolderSearch *search)
1291 const char *value = NULL;
1294 r(printf("executing user-tag\n"));
1297 value = camel_tag_get (&search->current->user_tags, argv[0]->value.string);
1299 r = e_sexp_result_new(f, ESEXP_RES_STRING);
1300 r->value.string = g_strdup (value ? value : "");
1305 static ESExpResult *
1306 search_get_sent_date(struct _ESExp *f, int argc, struct _ESExpResult **argv, CamelFolderSearch *s)
1310 r(printf("executing get-sent-date\n"));
1312 /* are we inside a match-all? */
1314 r = e_sexp_result_new(f, ESEXP_RES_INT);
1316 r->value.number = s->current->date_sent;
1318 r = e_sexp_result_new(f, ESEXP_RES_ARRAY_PTR);
1319 r->value.ptrarray = g_ptr_array_new ();
1325 static ESExpResult *
1326 search_get_received_date(struct _ESExp *f, int argc, struct _ESExpResult **argv, CamelFolderSearch *s)
1330 r(printf("executing get-received-date\n"));
1332 /* are we inside a match-all? */
1334 r = e_sexp_result_new(f, ESEXP_RES_INT);
1336 r->value.number = s->current->date_received;
1338 r = e_sexp_result_new(f, ESEXP_RES_ARRAY_PTR);
1339 r->value.ptrarray = g_ptr_array_new ();
1345 static ESExpResult *
1346 search_get_current_date(struct _ESExp *f, int argc, struct _ESExpResult **argv, CamelFolderSearch *s)
1350 r(printf("executing get-current-date\n"));
1352 r = e_sexp_result_new(f, ESEXP_RES_INT);
1353 r->value.number = time (NULL);
1357 static ESExpResult *
1358 search_get_size (struct _ESExp *f, int argc, struct _ESExpResult **argv, CamelFolderSearch *s)
1362 r(printf("executing get-size\n"));
1364 /* are we inside a match-all? */
1366 r = e_sexp_result_new (f, ESEXP_RES_INT);
1367 r->value.number = s->current->size / 1024;
1369 r = e_sexp_result_new (f, ESEXP_RES_ARRAY_PTR);
1370 r->value.ptrarray = g_ptr_array_new ();
1376 static ESExpResult *
1377 search_uid(struct _ESExp *f, int argc, struct _ESExpResult **argv, CamelFolderSearch *search)
1382 r(printf("executing uid\n"));
1384 /* are we inside a match-all? */
1385 if (search->current) {
1387 const char *uid = camel_message_info_uid(search->current);
1389 /* performs an OR of all words */
1390 for (i=0;i<argc && !truth;i++) {
1391 if (argv[i]->type == ESEXP_RES_STRING
1392 && !strcmp(uid, argv[i]->value.string)) {
1397 r = e_sexp_result_new(f, ESEXP_RES_BOOL);
1398 r->value.bool = truth;
1400 r = e_sexp_result_new(f, ESEXP_RES_ARRAY_PTR);
1401 r->value.ptrarray = g_ptr_array_new();
1402 for (i=0;i<argc;i++) {
1403 if (argv[i]->type == ESEXP_RES_STRING)
1404 g_ptr_array_add(r->value.ptrarray, argv[i]->value.string);