1 /* -*- Mode: C; tab-width: 8; indent-tabs-mode: t; c-basic-offset: 8 -*- */
3 * Copyright (C) 1999-2008 Novell, Inc. (www.novell.com)
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 Lesser 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 Lesser General Public
17 * License along with this program; if not, write to the
18 * Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
19 * Boston, MA 02110-1301, 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. */
30 /* POSIX requires <sys/types.h> be included before <regex.h> */
31 #include <sys/types.h>
39 #include <glib/gi18n-lib.h>
41 #include "camel-exception.h"
42 #include "camel-folder-search.h"
43 #include "camel-folder-thread.h"
44 #include "camel-medium.h"
45 #include "camel-mime-message.h"
46 #include "camel-multipart.h"
47 #include "camel-search-private.h"
48 #include "camel-stream-mem.h"
50 #include "camel-debug.h"
51 #include "camel-store.h"
52 #include "camel-vee-folder.h"
53 #include "camel-string-utils.h"
54 #include "camel-search-sql.h"
55 #include "camel-search-sql-sexp.h"
59 #define dd(x) if (camel_debug("search")) x
61 struct _CamelFolderSearchPrivate {
64 CamelFolderThread *threads;
65 GHashTable *threads_hash;
68 #define _PRIVATE(o) (((CamelFolderSearch *)(o))->priv)
70 static ESExpResult *search_not(struct _ESExp *f, int argc, struct _ESExpResult **argv, CamelFolderSearch *search);
72 static ESExpResult *search_header_contains(struct _ESExp *f, int argc, struct _ESExpResult **argv, CamelFolderSearch *search);
73 static ESExpResult *search_header_matches(struct _ESExp *f, int argc, struct _ESExpResult **argv, CamelFolderSearch *search);
74 static ESExpResult *search_header_starts_with(struct _ESExp *f, int argc, struct _ESExpResult **argv, CamelFolderSearch *search);
75 static ESExpResult *search_header_ends_with(struct _ESExp *f, int argc, struct _ESExpResult **argv, CamelFolderSearch *search);
76 static ESExpResult *search_header_exists(struct _ESExp *f, int argc, struct _ESExpResult **argv, CamelFolderSearch *search);
77 static ESExpResult *search_match_all(struct _ESExp *f, int argc, struct _ESExpTerm **argv, CamelFolderSearch *search);
78 static ESExpResult *search_match_threads(struct _ESExp *f, int argc, struct _ESExpTerm **argv, CamelFolderSearch *s);
79 static ESExpResult *search_body_contains(struct _ESExp *f, int argc, struct _ESExpResult **argv, CamelFolderSearch *search);
80 static ESExpResult *search_user_flag(struct _ESExp *f, int argc, struct _ESExpResult **argv, CamelFolderSearch *s);
81 static ESExpResult *search_user_tag(struct _ESExp *f, int argc, struct _ESExpResult **argv, CamelFolderSearch *s);
82 static ESExpResult *search_system_flag(struct _ESExp *f, int argc, struct _ESExpResult **argv, CamelFolderSearch *s);
83 static ESExpResult *search_get_sent_date(struct _ESExp *f, int argc, struct _ESExpResult **argv, CamelFolderSearch *s);
84 static ESExpResult *search_get_received_date(struct _ESExp *f, int argc, struct _ESExpResult **argv, CamelFolderSearch *s);
85 static ESExpResult *search_get_current_date(struct _ESExp *f, int argc, struct _ESExpResult **argv, CamelFolderSearch *s);
86 static ESExpResult *search_get_size(struct _ESExp *f, int argc, struct _ESExpResult **argv, CamelFolderSearch *s);
87 static ESExpResult *search_uid(struct _ESExp *f, int argc, struct _ESExpResult **argv, CamelFolderSearch *s);
89 static ESExpResult *search_dummy(struct _ESExp *f, int argc, struct _ESExpResult **argv, CamelFolderSearch *search);
91 static void camel_folder_search_class_init (CamelFolderSearchClass *klass);
92 static void camel_folder_search_init (CamelFolderSearch *obj);
93 static void camel_folder_search_finalize (CamelObject *obj);
95 static int read_uid_callback (void * ref, int ncol, char ** cols, char **name);
97 static CamelObjectClass *camel_folder_search_parent;
100 camel_folder_search_class_init (CamelFolderSearchClass *klass)
102 camel_folder_search_parent = camel_type_get_global_classfuncs (camel_object_get_type ());
104 klass->not = search_not;
106 klass->match_all = search_match_all;
107 klass->match_threads = search_match_threads;
108 klass->body_contains = search_body_contains;
109 klass->header_contains = search_header_contains;
110 klass->header_matches = search_header_matches;
111 klass->header_starts_with = search_header_starts_with;
112 klass->header_ends_with = search_header_ends_with;
113 klass->header_exists = search_header_exists;
114 klass->user_tag = search_user_tag;
115 klass->user_flag = search_user_flag;
116 klass->system_flag = search_system_flag;
117 klass->get_sent_date = search_get_sent_date;
118 klass->get_received_date = search_get_received_date;
119 klass->get_current_date = search_get_current_date;
120 klass->get_size = search_get_size;
121 klass->uid = search_uid;
125 camel_folder_search_init (CamelFolderSearch *obj)
127 struct _CamelFolderSearchPrivate *p;
129 p = _PRIVATE(obj) = g_malloc0(sizeof(*p));
131 obj->sexp = e_sexp_new();
135 camel_folder_search_finalize (CamelObject *obj)
137 CamelFolderSearch *search = (CamelFolderSearch *)obj;
138 struct _CamelFolderSearchPrivate *p = _PRIVATE(obj);
141 e_sexp_unref(search->sexp);
143 g_free(search->last_search);
148 camel_folder_search_get_type (void)
150 static CamelType type = CAMEL_INVALID_TYPE;
152 if (type == CAMEL_INVALID_TYPE) {
153 type = camel_type_register (camel_object_get_type (), "CamelFolderSearch",
154 sizeof (CamelFolderSearch),
155 sizeof (CamelFolderSearchClass),
156 (CamelObjectClassInitFunc) camel_folder_search_class_init,
158 (CamelObjectInitFunc) camel_folder_search_init,
159 (CamelObjectFinalizeFunc) camel_folder_search_finalize);
166 #define CAMEL_STRUCT_OFFSET(type, field) ((gint) offsetof (type, field))
168 #define CAMEL_STRUCT_OFFSET(type, field) ((gint) ((gchar*) &((type *) 0)->field))
174 int flags; /* 0x02 = immediate, 0x01 = always enter */
176 /* these have default implementations in e-sexp */
177 { "and", CAMEL_STRUCT_OFFSET(CamelFolderSearchClass, and), 2 },
178 { "or", CAMEL_STRUCT_OFFSET(CamelFolderSearchClass, or), 2 },
179 /* we need to override this one though to implement an 'array not' */
180 { "not", CAMEL_STRUCT_OFFSET(CamelFolderSearchClass, not), 0 },
181 { "<", CAMEL_STRUCT_OFFSET(CamelFolderSearchClass, lt), 2 },
182 { ">", CAMEL_STRUCT_OFFSET(CamelFolderSearchClass, gt), 2 },
183 { "=", CAMEL_STRUCT_OFFSET(CamelFolderSearchClass, eq), 2 },
185 /* these we have to use our own default if there is none */
186 /* they should all be defined in the language? so it parses, or should they not?? */
187 { "match-all", CAMEL_STRUCT_OFFSET(CamelFolderSearchClass, match_all), 3 },
188 { "match-threads", CAMEL_STRUCT_OFFSET(CamelFolderSearchClass, match_threads), 3 },
189 { "body-contains", CAMEL_STRUCT_OFFSET(CamelFolderSearchClass, body_contains), 1 },
190 { "header-contains", CAMEL_STRUCT_OFFSET(CamelFolderSearchClass, header_contains), 1 },
191 { "header-matches", CAMEL_STRUCT_OFFSET(CamelFolderSearchClass, header_matches), 1 },
192 { "header-starts-with", CAMEL_STRUCT_OFFSET(CamelFolderSearchClass, header_starts_with), 1 },
193 { "header-ends-with", CAMEL_STRUCT_OFFSET(CamelFolderSearchClass, header_ends_with), 1 },
194 { "header-exists", CAMEL_STRUCT_OFFSET(CamelFolderSearchClass, header_exists), 1 },
195 { "user-tag", CAMEL_STRUCT_OFFSET(CamelFolderSearchClass, user_tag), 1 },
196 { "user-flag", CAMEL_STRUCT_OFFSET(CamelFolderSearchClass, user_flag), 1 },
197 { "system-flag", CAMEL_STRUCT_OFFSET(CamelFolderSearchClass, system_flag), 1 },
198 { "get-sent-date", CAMEL_STRUCT_OFFSET(CamelFolderSearchClass, get_sent_date), 1 },
199 { "get-received-date", CAMEL_STRUCT_OFFSET(CamelFolderSearchClass, get_received_date), 1 },
200 { "get-current-date", CAMEL_STRUCT_OFFSET(CamelFolderSearchClass, get_current_date), 1 },
201 { "get-size", CAMEL_STRUCT_OFFSET(CamelFolderSearchClass, get_size), 1 },
202 { "uid", CAMEL_STRUCT_OFFSET(CamelFolderSearchClass, uid), 1 },
206 camel_folder_search_construct (CamelFolderSearch *search)
209 CamelFolderSearchClass *klass = (CamelFolderSearchClass *)CAMEL_OBJECT_GET_CLASS(search);
211 for (i=0;i<sizeof(builtins)/sizeof(builtins[0]);i++) {
213 /* c is sure messy sometimes */
214 func = *((void **)(((char *)klass)+builtins[i].offset));
215 if (func == NULL && builtins[i].flags&1) {
216 g_warning("Search class doesn't implement '%s' method: %s", builtins[i].name, camel_type_to_name(CAMEL_OBJECT_GET_CLASS(search)));
217 func = (void *)search_dummy;
220 if (builtins[i].flags&2) {
221 e_sexp_add_ifunction(search->sexp, 0, builtins[i].name, (ESExpIFunc *)func, search);
223 e_sexp_add_function(search->sexp, 0, builtins[i].name, (ESExpFunc *)func, search);
230 * camel_folder_search_new:
232 * Create a new CamelFolderSearch object.
234 * A CamelFolderSearch is a subclassable, extensible s-exp
235 * evaluator which enforces a particular set of s-expressions.
236 * Particular methods may be overriden by an implementation to
237 * implement a search for any sort of backend.
239 * Return value: A new CamelFolderSearch widget.
242 camel_folder_search_new (void)
244 CamelFolderSearch *new = CAMEL_FOLDER_SEARCH (camel_object_new (camel_folder_search_get_type ()));
246 camel_folder_search_construct(new);
251 * camel_folder_search_set_folder:
255 * Set the folder attribute of the search. This is currently unused, but
256 * could be used to perform a slow-search when indexes and so forth are not
257 * available. Or for use by subclasses.
260 camel_folder_search_set_folder(CamelFolderSearch *search, CamelFolder *folder)
262 search->folder = folder;
266 * camel_folder_search_set_summary:
268 * @summary: An array of CamelMessageInfo pointers.
270 * Set the array of summary objects representing the span of the search.
272 * If this is not set, then a subclass must provide the functions
273 * for searching headers and for the match-all operator.
276 camel_folder_search_set_summary(CamelFolderSearch *search, GPtrArray *summary)
278 search->summary = summary;
282 * camel_folder_search_set_body_index:
286 * Set the index representing the contents of all messages
287 * in this folder. If this is not set, then the folder implementation
288 * should sub-class the CamelFolderSearch and provide its own
289 * body-contains function.
292 camel_folder_search_set_body_index(CamelFolderSearch *search, CamelIndex *index)
294 if (search->body_index)
295 camel_object_unref((CamelObject *)search->body_index);
296 search->body_index = index;
298 camel_object_ref((CamelObject *)index);
302 * camel_folder_search_execute_expression:
307 * Execute the search expression @expr, returning an array of
308 * all matches as a GPtrArray of uid's of matching messages.
310 * Note that any settings such as set_body_index(), set_folder(),
311 * and so on are reset to #NULL once the search has completed.
313 * TODO: The interface should probably return summary items instead
314 * (since they are much more useful to any client).
316 * Return value: A GPtrArray of strings of all matching messages.
317 * This must only be freed by camel_folder_search_free_result.
320 camel_folder_search_execute_expression(CamelFolderSearch *search, const char *expr, CamelException *ex)
326 struct _CamelFolderSearchPrivate *p = _PRIVATE(search);
330 /* only re-parse if the search has changed */
331 if (search->last_search == NULL
332 || strcmp(search->last_search, expr)) {
333 e_sexp_input_text(search->sexp, expr, strlen(expr));
334 if (e_sexp_parse(search->sexp) == -1) {
335 camel_exception_setv(ex, 1, _("Cannot parse search expression: %s:\n%s"), e_sexp_error(search->sexp), expr);
339 g_free(search->last_search);
340 search->last_search = g_strdup(expr);
342 r = e_sexp_eval(search->sexp);
344 if (!camel_exception_is_set(ex))
345 camel_exception_setv(ex, 1, _("Error executing search expression: %s:\n%s"), e_sexp_error(search->sexp), expr);
349 matches = g_ptr_array_new();
351 /* now create a folder summary to return?? */
352 if (r->type == ESEXP_RES_ARRAY_PTR) {
353 d(printf("got result ...\n"));
354 if (search->summary) {
355 /* reorder result in summary order */
356 results = g_hash_table_new(g_str_hash, g_str_equal);
357 for (i=0;i<r->value.ptrarray->len;i++) {
358 d(printf("adding match: %s\n", (char *)g_ptr_array_index(r->value.ptrarray, i)));
359 g_hash_table_insert(results, g_ptr_array_index(r->value.ptrarray, i), GINT_TO_POINTER (1));
361 for (i=0;i<search->summary->len;i++) {
362 char *uid = g_ptr_array_index(search->summary, i);
363 if (g_hash_table_lookup(results, uid)) {
364 g_ptr_array_add(matches, (gpointer) camel_pstring_strdup(uid));
367 g_hash_table_destroy(results);
369 for (i=0;i<r->value.ptrarray->len;i++) {
370 d(printf("adding match: %s\n", (char *)g_ptr_array_index(r->value.ptrarray, i)));
371 g_ptr_array_add(matches, (gpointer) camel_pstring_strdup(g_ptr_array_index(r->value.ptrarray, i)));
375 g_warning("Search returned an invalid result type");
378 e_sexp_result_free(search->sexp, r);
381 camel_folder_thread_messages_unref(p->threads);
383 g_hash_table_destroy(p->threads_hash);
386 p->threads_hash = NULL;
387 search->folder = NULL;
388 search->summary = NULL;
389 search->current = NULL;
390 search->body_index = NULL;
396 * camel_folder_search_search:
399 * @uids: to search against, NULL for all uid's.
402 * Run a search. Search must have had Folder already set on it, and
403 * it must implement summaries.
408 camel_folder_search_search(CamelFolderSearch *search, const char *expr, GPtrArray *uids, CamelException *ex)
411 GPtrArray *matches = NULL, *summary_set;
414 char *sql_query, *tmp, *tmp1;
417 struct _CamelFolderSearchPrivate *p = _PRIVATE(search);
419 g_assert(search->folder);
423 /* We route body-contains search and uid search through memory and not via db. */
424 if (uids || strstr((const char *) expr, "body-contains")) {
425 /* setup our search list only contains those we're interested in */
426 search->summary = camel_folder_get_summary(search->folder);
429 GHashTable *uids_hash = g_hash_table_new(g_str_hash, g_str_equal);
431 summary_set = search->summary_set = g_ptr_array_new();
432 for (i=0;i<uids->len;i++)
433 g_hash_table_insert(uids_hash, uids->pdata[i], uids->pdata[i]);
434 for (i=0;i<search->summary->len;i++)
435 if (g_hash_table_lookup(uids_hash, search->summary->pdata[i]))
436 g_ptr_array_add(search->summary_set, search->summary->pdata[i]);
437 g_hash_table_destroy(uids_hash);
439 summary_set = search->summary;
442 /* only re-parse if the search has changed */
443 if (search->last_search == NULL
444 || strcmp(search->last_search, expr)) {
445 e_sexp_input_text(search->sexp, expr, strlen(expr));
446 if (e_sexp_parse(search->sexp) == -1) {
447 camel_exception_setv(ex, 1, _("Cannot parse search expression: %s:\n%s"), e_sexp_error(search->sexp), expr);
451 g_free(search->last_search);
452 search->last_search = g_strdup(expr);
454 r = e_sexp_eval(search->sexp);
456 if (!camel_exception_is_set(ex))
457 camel_exception_setv(ex, 1, _("Error executing search expression: %s:\n%s"), e_sexp_error(search->sexp), expr);
461 matches = g_ptr_array_new();
463 /* now create a folder summary to return?? */
464 if (r->type == ESEXP_RES_ARRAY_PTR) {
465 d(printf("got result\n"));
467 /* reorder result in summary order */
468 results = g_hash_table_new(g_str_hash, g_str_equal);
469 for (i=0;i<r->value.ptrarray->len;i++) {
470 d(printf("adding match: %s\n", (char *)g_ptr_array_index(r->value.ptrarray, i)));
471 g_hash_table_insert(results, g_ptr_array_index(r->value.ptrarray, i), GINT_TO_POINTER (1));
474 for (i=0;i<summary_set->len;i++) {
475 char *uid = g_ptr_array_index(summary_set, i);
476 if (g_hash_table_lookup(results, uid))
477 g_ptr_array_add(matches, (gpointer) camel_pstring_strdup(uid));
479 g_hash_table_destroy(results);
482 e_sexp_result_free(search->sexp, r);
485 /* Sync the db, so that we search the db for changes */
486 camel_folder_summary_save_to_db (search->folder->summary, ex);
488 dd(printf ("sexp is : [%s]\n", expr));
489 if (g_getenv("SQL_SEARCH_OLD"))
490 sql_query = camel_sexp_to_sql (expr);
492 sql_query = camel_sexp_to_sql_sexp (expr);
493 tmp1 = camel_db_sqlize_string(search->folder->full_name);
494 tmp = g_strdup_printf ("SELECT uid FROM %s %s %s", tmp1, sql_query ? "WHERE":"", sql_query?sql_query:"");
495 camel_db_free_sqlized_string (tmp1);
497 dd(printf("Equivalent sql %s\n", tmp));
499 matches = g_ptr_array_new();
500 cdb = (CamelDB *) (search->folder->cdb);
501 camel_db_select (cdb, tmp, (CamelDBSelectCB) read_uid_callback, matches, ex);
502 if (ex && camel_exception_is_set(ex)) {
503 const char *exception = camel_exception_get_description (ex);
504 if (strncmp(exception, "no such table", 13) == 0) {
505 g_warning ("Error during searching %s: %s\n", tmp, exception);
506 camel_exception_clear (ex); /* Suppress no such table */
514 /* these might be allocated by match-threads */
516 camel_folder_thread_messages_unref(p->threads);
518 g_hash_table_destroy(p->threads_hash);
519 if (search->summary_set)
520 g_ptr_array_free(search->summary_set, TRUE);
522 camel_folder_free_summary(search->folder, search->summary);
525 p->threads_hash = NULL;
526 search->folder = NULL;
527 search->summary = NULL;
528 search->summary_set = NULL;
529 search->current = NULL;
530 search->body_index = NULL;
535 void camel_folder_search_free_result(CamelFolderSearch *search, GPtrArray *result)
537 g_ptr_array_foreach (result, (GFunc) camel_pstring_free, NULL);
538 g_ptr_array_free(result, TRUE);
541 /* dummy function, returns false always, or an empty match array */
543 search_dummy(struct _ESExp *f, int argc, struct _ESExpResult **argv, CamelFolderSearch *search)
547 if (search->current == NULL) {
548 r = e_sexp_result_new(f, ESEXP_RES_BOOL);
549 r->value.bool = FALSE;
551 r = e_sexp_result_new(f, ESEXP_RES_ARRAY_PTR);
552 r->value.ptrarray = g_ptr_array_new();
558 /* impelemnt an 'array not', i.e. everything in the summary, not in the supplied array */
560 search_not(struct _ESExp *f, int argc, struct _ESExpResult **argv, CamelFolderSearch *search)
566 if (argv[0]->type == ESEXP_RES_ARRAY_PTR) {
567 GPtrArray *v = argv[0]->value.ptrarray;
570 r = e_sexp_result_new(f, ESEXP_RES_ARRAY_PTR);
571 r->value.ptrarray = g_ptr_array_new();
573 /* not against a single message?*/
574 if (search->current) {
577 uid = camel_message_info_uid(search->current);
578 for (i=0;!found && i<v->len;i++) {
579 if (strcmp(uid, v->pdata[i]) == 0)
584 g_ptr_array_add(r->value.ptrarray, (char *)uid);
585 } else if (search->summary == NULL) {
586 g_warning("No summary set, 'not' against an array requires a summary");
588 /* 'not' against the whole summary */
589 GHashTable *have = g_hash_table_new(g_str_hash, g_str_equal);
593 s = (char **)v->pdata;
594 for (i=0;i<v->len;i++)
595 g_hash_table_insert(have, s[i], s[i]);
597 v = search->summary_set?search->summary_set:search->summary;
598 m = (char **)v->pdata;
599 for (i=0;i<v->len;i++) {
602 if (g_hash_table_lookup(have, uid) == NULL)
603 g_ptr_array_add(r->value.ptrarray, uid);
605 g_hash_table_destroy(have);
610 if (argv[0]->type == ESEXP_RES_BOOL)
611 res = ! argv[0]->value.bool;
613 r = e_sexp_result_new(f, ESEXP_RES_BOOL);
617 r = e_sexp_result_new(f, ESEXP_RES_BOOL);
618 r->value.bool = TRUE;
625 search_match_all(struct _ESExp *f, int argc, struct _ESExpTerm **argv, CamelFolderSearch *search)
633 g_warning("match-all only takes a single argument, other arguments ignored");
636 /* we are only matching a single message? or already inside a match-all? */
637 if (search->current) {
638 d(printf("matching against 1 message: %s\n", camel_message_info_subject(search->current)));
640 r = e_sexp_result_new(f, ESEXP_RES_BOOL);
641 r->value.bool = FALSE;
644 r1 = e_sexp_term_eval(f, argv[0]);
645 if (r1->type == ESEXP_RES_BOOL) {
646 r->value.bool = r1->value.bool;
648 g_warning("invalid syntax, matches require a single bool result");
649 error_msg = g_strdup_printf(_("(%s) requires a single bool result"), "match-all");
650 e_sexp_fatal_error(f, error_msg);
653 e_sexp_result_free(f, r1);
655 r->value.bool = TRUE;
660 r = e_sexp_result_new(f, ESEXP_RES_ARRAY_PTR);
661 r->value.ptrarray = g_ptr_array_new();
663 if (search->summary == NULL) {
664 /* TODO: make it work - e.g. use the folder and so forth for a slower search */
665 g_warning("No summary supplied, match-all doesn't work with no summary");
670 v = search->summary_set?search->summary_set:search->summary;
672 if (v->len > g_hash_table_size (search->folder->summary->loaded_infos) && !CAMEL_IS_VEE_FOLDER (search->folder)) {
673 camel_folder_summary_reload_from_db (search->folder->summary, search->priv->ex);
677 for (i=0;i<v->len;i++) {
680 search->current = camel_folder_summary_uid (search->folder->summary, v->pdata[i]);
681 if (!search->current)
683 uid = camel_message_info_uid(search->current);
686 r1 = e_sexp_term_eval(f, argv[0]);
687 if (r1->type == ESEXP_RES_BOOL) {
689 g_ptr_array_add(r->value.ptrarray, (char *)uid);
691 g_warning("invalid syntax, matches require a single bool result");
692 error_msg = g_strdup_printf(_("(%s) requires a single bool result"), "match-all");
693 e_sexp_fatal_error(f, error_msg);
696 e_sexp_result_free(f, r1);
698 g_ptr_array_add(r->value.ptrarray, (char *)uid);
700 camel_message_info_free (search->current);
702 search->current = NULL;
707 fill_thread_table(struct _CamelFolderThreadNode *root, GHashTable *id_hash)
710 g_hash_table_insert(id_hash, (char *)camel_message_info_uid(root->message), root);
712 fill_thread_table(root->child, id_hash);
718 add_thread_results(struct _CamelFolderThreadNode *root, GHashTable *result_hash)
721 g_hash_table_insert(result_hash, (char *)camel_message_info_uid(root->message), GINT_TO_POINTER (1));
723 add_thread_results(root->child, result_hash);
729 add_results(char *uid, void *dummy, GPtrArray *result)
731 g_ptr_array_add(result, uid);
735 search_match_threads(struct _ESExp *f, int argc, struct _ESExpTerm **argv, CamelFolderSearch *search)
738 struct _CamelFolderSearchPrivate *p = search->priv;
743 /* not supported in match-all */
744 if (search->current) {
745 error_msg = g_strdup_printf(_("(%s) not allowed inside %s"), "match-threads", "match-all");
746 e_sexp_fatal_error(f, error_msg);
751 error_msg = g_strdup_printf(_("(%s) requires a match type string"), "match-threads");
752 e_sexp_fatal_error(f, error_msg);
756 r = e_sexp_term_eval(f, argv[0]);
757 if (r->type != ESEXP_RES_STRING) {
758 error_msg = g_strdup_printf(_("(%s) requires a match type string"), "match-threads");
759 e_sexp_fatal_error(f, error_msg);
764 if (!strcmp(r->value.string, "none"))
766 else if (!strcmp(r->value.string, "all"))
768 else if (!strcmp(r->value.string, "replies"))
770 else if (!strcmp(r->value.string, "replies_parents"))
772 else if (!strcmp(r->value.string, "single"))
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 error_msg = g_strdup_printf(_("(%s) expects an array result"), "match-threads");
786 e_sexp_fatal_error(f, error_msg);
793 if (search->folder == NULL) {
794 error_msg = g_strdup_printf(_("(%s) requires the folder set"), "match-threads");
795 e_sexp_fatal_error(f, error_msg);
799 /* cache this, so we only have to re-calculate once per search at most */
800 if (p->threads == NULL) {
801 p->threads = camel_folder_thread_messages_new(search->folder, NULL, TRUE);
802 p->threads_hash = g_hash_table_new(g_str_hash, g_str_equal);
804 fill_thread_table(p->threads->tree, p->threads_hash);
807 results = g_hash_table_new(g_str_hash, g_str_equal);
808 for (i=0;i<r->value.ptrarray->len;i++) {
809 struct _CamelFolderThreadNode *node, *scan;
812 g_hash_table_insert(results, g_ptr_array_index(r->value.ptrarray, i), GINT_TO_POINTER(1));
814 node = g_hash_table_lookup(p->threads_hash, (char *)g_ptr_array_index(r->value.ptrarray, i));
815 if (node == NULL) /* this shouldn't happen but why cry over spilt milk */
818 /* select messages in thread according to search criteria */
820 if (node->child == NULL && node->parent == NULL)
821 g_hash_table_insert(results, (char *)camel_message_info_uid(node->message), GINT_TO_POINTER(1));
825 while (scan && scan->parent) {
827 g_hash_table_insert(results, (char *)camel_message_info_uid(scan->message), GINT_TO_POINTER(1));
829 } else if (type == 1) {
830 while (node && node->parent)
833 g_hash_table_insert(results, (char *)camel_message_info_uid(node->message), GINT_TO_POINTER(1));
835 add_thread_results(node->child, results);
838 e_sexp_result_free(f, r);
840 r = e_sexp_result_new(f, ESEXP_RES_ARRAY_PTR);
841 r->value.ptrarray = g_ptr_array_new();
843 g_hash_table_foreach(results, (GHFunc)add_results, r->value.ptrarray);
844 g_hash_table_destroy(results);
850 check_header (struct _ESExp *f, int argc, struct _ESExpResult **argv, CamelFolderSearch *search, camel_search_match_t how)
855 r(printf("executing check-header %d\n", how));
857 /* are we inside a match-all? */
858 if (search->current && argc>1
859 && argv[0]->type == ESEXP_RES_STRING) {
861 const char *header = NULL;
864 camel_search_t type = CAMEL_SEARCH_TYPE_ASIS;
865 struct _camel_search_words *words;
867 /* only a subset of headers are supported .. */
868 headername = argv[0]->value.string;
869 if (!g_ascii_strcasecmp(headername, "subject")) {
870 header = camel_message_info_subject(search->current);
871 } else if (!g_ascii_strcasecmp(headername, "date")) {
872 /* FIXME: not a very useful form of the date */
873 sprintf(strbuf, "%d", (int)camel_message_info_date_sent(search->current));
875 } else if (!g_ascii_strcasecmp(headername, "from")) {
876 header = camel_message_info_from(search->current);
877 type = CAMEL_SEARCH_TYPE_ADDRESS;
878 } else if (!g_ascii_strcasecmp(headername, "to")) {
879 header = camel_message_info_to(search->current);
880 type = CAMEL_SEARCH_TYPE_ADDRESS;
881 } else if (!g_ascii_strcasecmp(headername, "cc")) {
882 header = camel_message_info_cc(search->current);
883 type = CAMEL_SEARCH_TYPE_ADDRESS;
884 } else if (!g_ascii_strcasecmp(headername, "x-camel-mlist")) {
885 header = camel_message_info_mlist(search->current);
886 type = CAMEL_SEARCH_TYPE_MLIST;
888 e_sexp_resultv_free(f, argc, argv);
889 e_sexp_fatal_error(f, _("Performing query on unknown header: %s"), headername);
895 /* performs an OR of all words */
896 for (i=1;i<argc && !truth;i++) {
897 if (argv[i]->type == ESEXP_RES_STRING) {
898 if (argv[i]->value.string[0] == 0) {
900 } else if (how == CAMEL_SEARCH_MATCH_CONTAINS) {
901 /* doesn't make sense to split words on anything but contains i.e. we can't have an ending match different words */
902 words = camel_search_words_split((const unsigned char *) argv[i]->value.string);
904 for (j=0;j<words->len && truth;j++) {
905 truth = camel_search_header_match(header, words->words[j]->word, how, type, NULL);
907 camel_search_words_free(words);
909 truth = camel_search_header_match(header, argv[i]->value.string, how, type, NULL);
914 /* TODO: else, find all matches */
916 r = e_sexp_result_new(f, ESEXP_RES_BOOL);
917 r->value.bool = truth;
926 printf("%s\t", node);
931 search_header_contains(struct _ESExp *f, int argc, struct _ESExpResult **argv, CamelFolderSearch *search)
933 return check_header(f, argc, argv, search, CAMEL_SEARCH_MATCH_CONTAINS);
937 search_header_matches(struct _ESExp *f, int argc, struct _ESExpResult **argv, CamelFolderSearch *search)
939 return check_header(f, argc, argv, search, CAMEL_SEARCH_MATCH_EXACT);
943 search_header_starts_with (struct _ESExp *f, int argc, struct _ESExpResult **argv, CamelFolderSearch *search)
945 return check_header(f, argc, argv, search, CAMEL_SEARCH_MATCH_STARTS);
949 search_header_ends_with (struct _ESExp *f, int argc, struct _ESExpResult **argv, CamelFolderSearch *search)
951 return check_header(f, argc, argv, search, CAMEL_SEARCH_MATCH_ENDS);
955 search_header_exists (struct _ESExp *f, int argc, struct _ESExpResult **argv, CamelFolderSearch *search)
959 r(printf ("executing header-exists\n"));
961 if (search->current) {
962 r = e_sexp_result_new(f, ESEXP_RES_BOOL);
963 if (argc == 1 && argv[0]->type == ESEXP_RES_STRING)
964 r->value.bool = camel_medium_get_header(CAMEL_MEDIUM(search->current), argv[0]->value.string) != NULL;
967 r = e_sexp_result_new(f, ESEXP_RES_ARRAY_PTR);
968 r->value.ptrarray = g_ptr_array_new();
974 /* this is just to OR results together */
975 struct _glib_sux_donkeys {
980 /* or, store all unique values */
982 g_lib_sux_htor(char *key, int value, struct _glib_sux_donkeys *fuckup)
984 g_ptr_array_add(fuckup->uids, key);
987 /* and, only store duplicates */
989 g_lib_sux_htand(char *key, int value, struct _glib_sux_donkeys *fuckup)
991 if (value == fuckup->count)
992 g_ptr_array_add(fuckup->uids, key);
996 match_message_index(CamelIndex *idx, const char *uid, const char *match, CamelException *ex)
998 CamelIndexCursor *wc, *nc;
999 const char *word, *name;
1002 wc = camel_index_words(idx);
1004 while (!truth && (word = camel_index_cursor_next(wc))) {
1005 if (camel_ustrstrcase(word,match) != NULL) {
1006 /* perf: could have the wc cursor return the name cursor */
1007 nc = camel_index_find(idx, word);
1009 while (!truth && (name = camel_index_cursor_next(nc)))
1010 truth = strcmp(name, uid) == 0;
1011 camel_object_unref((CamelObject *)nc);
1015 camel_object_unref((CamelObject *)wc);
1022 "one two" "three" "four five"
1031 /* returns messages which contain all words listed in words */
1033 match_words_index(CamelFolderSearch *search, struct _camel_search_words *words, CamelException *ex)
1035 GPtrArray *result = g_ptr_array_new();
1036 GHashTable *ht = g_hash_table_new(g_str_hash, g_str_equal);
1037 struct _glib_sux_donkeys lambdafoo;
1038 CamelIndexCursor *wc, *nc;
1039 const char *word, *name;
1042 /* we can have a maximum of 32 words, as we use it as the AND mask */
1044 wc = camel_index_words(search->body_index);
1046 while ((word = camel_index_cursor_next(wc))) {
1047 for (i=0;i<words->len;i++) {
1048 if (camel_ustrstrcase(word, words->words[i]->word) != NULL) {
1049 /* perf: could have the wc cursor return the name cursor */
1050 nc = camel_index_find(search->body_index, word);
1052 while ((name = camel_index_cursor_next(nc))) {
1055 mask = (GPOINTER_TO_INT(g_hash_table_lookup(ht, name))) | (1<<i);
1056 g_hash_table_insert(ht, (char *) camel_pstring_peek(name), GINT_TO_POINTER(mask));
1058 camel_object_unref((CamelObject *)nc);
1063 camel_object_unref((CamelObject *)wc);
1065 lambdafoo.uids = result;
1066 lambdafoo.count = (1<<words->len) - 1;
1067 g_hash_table_foreach(ht, (GHFunc)g_lib_sux_htand, &lambdafoo);
1068 g_hash_table_destroy(ht);
1075 match_words_1message (CamelDataWrapper *object, struct _camel_search_words *words, guint32 *mask)
1077 CamelDataWrapper *containee;
1081 containee = camel_medium_get_content_object (CAMEL_MEDIUM (object));
1083 if (containee == NULL)
1086 /* using the object types is more accurate than using the mime/types */
1087 if (CAMEL_IS_MULTIPART (containee)) {
1088 parts = camel_multipart_get_number (CAMEL_MULTIPART (containee));
1089 for (i = 0; i < parts && truth == FALSE; i++) {
1090 CamelDataWrapper *part = (CamelDataWrapper *)camel_multipart_get_part (CAMEL_MULTIPART (containee), i);
1092 truth = match_words_1message(part, words, mask);
1094 } else if (CAMEL_IS_MIME_MESSAGE (containee)) {
1095 /* for messages we only look at its contents */
1096 truth = match_words_1message((CamelDataWrapper *)containee, words, mask);
1097 } else if (camel_content_type_is(CAMEL_DATA_WRAPPER (containee)->mime_type, "text", "*")) {
1098 /* for all other text parts, we look inside, otherwise we dont care */
1099 CamelStreamMem *mem = (CamelStreamMem *)camel_stream_mem_new ();
1101 /* FIXME: The match should be part of a stream op */
1102 camel_data_wrapper_decode_to_stream (containee, CAMEL_STREAM (mem));
1103 camel_stream_write (CAMEL_STREAM (mem), "", 1);
1104 for (i=0;i<words->len;i++) {
1105 /* FIXME: This is horridly slow, and should use a real search algorithm */
1106 if (camel_ustrstrcase((const char *) mem->buffer->data, words->words[i]->word) != NULL) {
1108 /* shortcut a match */
1109 if (*mask == (1<<(words->len))-1)
1114 camel_object_unref (mem);
1121 match_words_message(CamelFolder *folder, const char *uid, struct _camel_search_words *words, CamelException *ex)
1124 CamelMimeMessage *msg;
1125 CamelException x = CAMEL_EXCEPTION_INITIALISER;
1128 msg = camel_folder_get_message(folder, uid, &x);
1131 truth = match_words_1message((CamelDataWrapper *)msg, words, &mask);
1132 camel_object_unref((CamelObject *)msg);
1134 camel_exception_clear(&x);
1142 match_words_messages(CamelFolderSearch *search, struct _camel_search_words *words, CamelException *ex)
1145 GPtrArray *matches = g_ptr_array_new();
1147 if (search->body_index) {
1149 struct _camel_search_words *simple;
1151 simple = camel_search_words_simple(words);
1152 indexed = match_words_index(search, simple, ex);
1153 camel_search_words_free(simple);
1155 for (i=0;i<indexed->len;i++) {
1156 const char *uid = g_ptr_array_index(indexed, i);
1158 if (match_words_message(search->folder, uid, words, ex))
1159 g_ptr_array_add(matches, (char *)uid);
1162 g_ptr_array_free(indexed, TRUE);
1164 GPtrArray *v = search->summary_set?search->summary_set:search->summary;
1166 for (i=0;i<v->len;i++) {
1167 char *uid = g_ptr_array_index(v, i);
1169 if (match_words_message(search->folder, uid, words, ex))
1170 g_ptr_array_add(matches, (char *)uid);
1177 static ESExpResult *
1178 search_body_contains(struct _ESExp *f, int argc, struct _ESExpResult **argv, CamelFolderSearch *search)
1181 CamelException *ex = search->priv->ex;
1182 struct _camel_search_words *words;
1184 struct _glib_sux_donkeys lambdafoo;
1186 if (search->current) {
1189 if (argc == 1 && argv[0]->value.string[0] == 0) {
1192 for (i=0;i<argc && !truth;i++) {
1193 if (argv[i]->type == ESEXP_RES_STRING) {
1194 words = camel_search_words_split((const unsigned char *) argv[i]->value.string);
1196 if ((words->type & CAMEL_SEARCH_WORD_COMPLEX) == 0 && search->body_index) {
1197 for (j=0;j<words->len && truth;j++)
1198 truth = match_message_index(search->body_index, camel_message_info_uid(search->current), words->words[j]->word, ex);
1200 /* TODO: cache current message incase of multiple body search terms */
1201 truth = match_words_message(search->folder, camel_message_info_uid(search->current), words, ex);
1203 camel_search_words_free(words);
1207 r = e_sexp_result_new(f, ESEXP_RES_BOOL);
1208 r->value.bool = truth;
1210 r = e_sexp_result_new(f, ESEXP_RES_ARRAY_PTR);
1211 r->value.ptrarray = g_ptr_array_new();
1213 if (argc == 1 && argv[0]->value.string[0] == 0) {
1214 GPtrArray *v = search->summary_set?search->summary_set:search->summary;
1216 for (i=0;i<v->len;i++) {
1217 char *uid = g_ptr_array_index(v, i);
1219 g_ptr_array_add(r->value.ptrarray, uid);
1222 GHashTable *ht = g_hash_table_new(g_str_hash, g_str_equal);
1225 for (i=0;i<argc;i++) {
1226 if (argv[i]->type == ESEXP_RES_STRING) {
1227 words = camel_search_words_split((const unsigned char *) argv[i]->value.string);
1228 if ((words->type & CAMEL_SEARCH_WORD_COMPLEX) == 0 && search->body_index) {
1229 matches = match_words_index(search, words, ex);
1231 matches = match_words_messages(search, words, ex);
1233 for (j=0;j<matches->len;j++) {
1234 g_hash_table_insert(ht, matches->pdata[j], matches->pdata[j]);
1236 g_ptr_array_free(matches, TRUE);
1237 camel_search_words_free(words);
1240 lambdafoo.uids = r->value.ptrarray;
1241 g_hash_table_foreach(ht, (GHFunc)g_lib_sux_htor, &lambdafoo);
1242 g_hash_table_destroy(ht);
1249 static ESExpResult *
1250 search_user_flag(struct _ESExp *f, int argc, struct _ESExpResult **argv, CamelFolderSearch *search)
1255 r(printf("executing user-flag\n"));
1257 /* are we inside a match-all? */
1258 if (search->current) {
1260 /* performs an OR of all words */
1261 for (i=0;i<argc && !truth;i++) {
1262 if (argv[i]->type == ESEXP_RES_STRING
1263 && camel_message_info_user_flag(search->current, argv[i]->value.string)) {
1268 r = e_sexp_result_new(f, ESEXP_RES_BOOL);
1269 r->value.bool = truth;
1271 r = e_sexp_result_new(f, ESEXP_RES_ARRAY_PTR);
1272 r->value.ptrarray = g_ptr_array_new();
1278 static ESExpResult *
1279 search_system_flag (struct _ESExp *f, int argc, struct _ESExpResult **argv, CamelFolderSearch *search)
1283 r(printf ("executing system-flag\n"));
1285 if (search->current) {
1286 gboolean truth = FALSE;
1289 truth = camel_system_flag_get (camel_message_info_flags(search->current), argv[0]->value.string);
1291 r = e_sexp_result_new(f, ESEXP_RES_BOOL);
1292 r->value.bool = truth;
1294 r = e_sexp_result_new(f, ESEXP_RES_ARRAY_PTR);
1295 r->value.ptrarray = g_ptr_array_new ();
1301 static ESExpResult *
1302 search_user_tag(struct _ESExp *f, int argc, struct _ESExpResult **argv, CamelFolderSearch *search)
1304 const char *value = NULL;
1307 r(printf("executing user-tag\n"));
1309 if (search->current && argc == 1)
1310 value = camel_message_info_user_tag(search->current, argv[0]->value.string);
1312 r = e_sexp_result_new(f, ESEXP_RES_STRING);
1313 r->value.string = g_strdup (value ? value : "");
1318 static ESExpResult *
1319 search_get_sent_date(struct _ESExp *f, int argc, struct _ESExpResult **argv, CamelFolderSearch *s)
1323 r(printf("executing get-sent-date\n"));
1325 /* are we inside a match-all? */
1327 r = e_sexp_result_new(f, ESEXP_RES_INT);
1329 r->value.number = camel_message_info_date_sent(s->current);
1331 r = e_sexp_result_new(f, ESEXP_RES_ARRAY_PTR);
1332 r->value.ptrarray = g_ptr_array_new ();
1338 static ESExpResult *
1339 search_get_received_date(struct _ESExp *f, int argc, struct _ESExpResult **argv, CamelFolderSearch *s)
1343 r(printf("executing get-received-date\n"));
1345 /* are we inside a match-all? */
1347 r = e_sexp_result_new(f, ESEXP_RES_INT);
1349 r->value.number = camel_message_info_date_received(s->current);
1351 r = e_sexp_result_new(f, ESEXP_RES_ARRAY_PTR);
1352 r->value.ptrarray = g_ptr_array_new ();
1358 static ESExpResult *
1359 search_get_current_date(struct _ESExp *f, int argc, struct _ESExpResult **argv, CamelFolderSearch *s)
1363 r(printf("executing get-current-date\n"));
1365 r = e_sexp_result_new(f, ESEXP_RES_INT);
1366 r->value.number = time (NULL);
1370 static ESExpResult *
1371 search_get_size (struct _ESExp *f, int argc, struct _ESExpResult **argv, CamelFolderSearch *s)
1375 r(printf("executing get-size\n"));
1377 /* are we inside a match-all? */
1379 r = e_sexp_result_new (f, ESEXP_RES_INT);
1380 r->value.number = camel_message_info_size(s->current) / 1024;
1382 r = e_sexp_result_new (f, ESEXP_RES_ARRAY_PTR);
1383 r->value.ptrarray = g_ptr_array_new ();
1389 static ESExpResult *
1390 search_uid(struct _ESExp *f, int argc, struct _ESExpResult **argv, CamelFolderSearch *search)
1395 r(printf("executing uid\n"));
1397 /* are we inside a match-all? */
1398 if (search->current) {
1400 const char *uid = camel_message_info_uid(search->current);
1402 /* performs an OR of all words */
1403 for (i=0;i<argc && !truth;i++) {
1404 if (argv[i]->type == ESEXP_RES_STRING
1405 && !strcmp(uid, argv[i]->value.string)) {
1410 r = e_sexp_result_new(f, ESEXP_RES_BOOL);
1411 r->value.bool = truth;
1413 r = e_sexp_result_new(f, ESEXP_RES_ARRAY_PTR);
1414 r->value.ptrarray = g_ptr_array_new();
1415 for (i=0;i<argc;i++) {
1416 if (argv[i]->type == ESEXP_RES_STRING)
1417 g_ptr_array_add(r->value.ptrarray, argv[i]->value.string);
1425 read_uid_callback (void * ref, int ncol, char ** cols, char **name)
1429 matches = (GPtrArray *) ref;
1431 g_ptr_array_add (matches, (gpointer) camel_pstring_strdup (cols [0]));