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-store.h"
51 #include "camel-vee-folder.h"
52 #include "camel-string-utils.h"
53 #include "camel-search-sql.h"
58 struct _CamelFolderSearchPrivate {
61 CamelFolderThread *threads;
62 GHashTable *threads_hash;
65 #define _PRIVATE(o) (((CamelFolderSearch *)(o))->priv)
67 static ESExpResult *search_not(struct _ESExp *f, int argc, struct _ESExpResult **argv, CamelFolderSearch *search);
69 static ESExpResult *search_header_contains(struct _ESExp *f, int argc, struct _ESExpResult **argv, CamelFolderSearch *search);
70 static ESExpResult *search_header_matches(struct _ESExp *f, int argc, struct _ESExpResult **argv, CamelFolderSearch *search);
71 static ESExpResult *search_header_starts_with(struct _ESExp *f, int argc, struct _ESExpResult **argv, CamelFolderSearch *search);
72 static ESExpResult *search_header_ends_with(struct _ESExp *f, int argc, struct _ESExpResult **argv, CamelFolderSearch *search);
73 static ESExpResult *search_header_exists(struct _ESExp *f, int argc, struct _ESExpResult **argv, CamelFolderSearch *search);
74 static ESExpResult *search_match_all(struct _ESExp *f, int argc, struct _ESExpTerm **argv, CamelFolderSearch *search);
75 static ESExpResult *search_match_threads(struct _ESExp *f, int argc, struct _ESExpTerm **argv, CamelFolderSearch *s);
76 static ESExpResult *search_body_contains(struct _ESExp *f, int argc, struct _ESExpResult **argv, CamelFolderSearch *search);
77 static ESExpResult *search_user_flag(struct _ESExp *f, int argc, struct _ESExpResult **argv, CamelFolderSearch *s);
78 static ESExpResult *search_user_tag(struct _ESExp *f, int argc, struct _ESExpResult **argv, CamelFolderSearch *s);
79 static ESExpResult *search_system_flag(struct _ESExp *f, int argc, struct _ESExpResult **argv, CamelFolderSearch *s);
80 static ESExpResult *search_get_sent_date(struct _ESExp *f, int argc, struct _ESExpResult **argv, CamelFolderSearch *s);
81 static ESExpResult *search_get_received_date(struct _ESExp *f, int argc, struct _ESExpResult **argv, CamelFolderSearch *s);
82 static ESExpResult *search_get_current_date(struct _ESExp *f, int argc, struct _ESExpResult **argv, CamelFolderSearch *s);
83 static ESExpResult *search_get_size(struct _ESExp *f, int argc, struct _ESExpResult **argv, CamelFolderSearch *s);
84 static ESExpResult *search_uid(struct _ESExp *f, int argc, struct _ESExpResult **argv, CamelFolderSearch *s);
86 static ESExpResult *search_dummy(struct _ESExp *f, int argc, struct _ESExpResult **argv, CamelFolderSearch *search);
88 static void camel_folder_search_class_init (CamelFolderSearchClass *klass);
89 static void camel_folder_search_init (CamelFolderSearch *obj);
90 static void camel_folder_search_finalize (CamelObject *obj);
92 static int read_uid_callback (void * ref, int ncol, char ** cols, char **name);
94 static CamelObjectClass *camel_folder_search_parent;
97 camel_folder_search_class_init (CamelFolderSearchClass *klass)
99 camel_folder_search_parent = camel_type_get_global_classfuncs (camel_object_get_type ());
101 klass->not = search_not;
103 klass->match_all = search_match_all;
104 klass->match_threads = search_match_threads;
105 klass->body_contains = search_body_contains;
106 klass->header_contains = search_header_contains;
107 klass->header_matches = search_header_matches;
108 klass->header_starts_with = search_header_starts_with;
109 klass->header_ends_with = search_header_ends_with;
110 klass->header_exists = search_header_exists;
111 klass->user_tag = search_user_tag;
112 klass->user_flag = search_user_flag;
113 klass->system_flag = search_system_flag;
114 klass->get_sent_date = search_get_sent_date;
115 klass->get_received_date = search_get_received_date;
116 klass->get_current_date = search_get_current_date;
117 klass->get_size = search_get_size;
118 klass->uid = search_uid;
122 camel_folder_search_init (CamelFolderSearch *obj)
124 struct _CamelFolderSearchPrivate *p;
126 p = _PRIVATE(obj) = g_malloc0(sizeof(*p));
128 obj->sexp = e_sexp_new();
132 camel_folder_search_finalize (CamelObject *obj)
134 CamelFolderSearch *search = (CamelFolderSearch *)obj;
135 struct _CamelFolderSearchPrivate *p = _PRIVATE(obj);
138 e_sexp_unref(search->sexp);
140 g_free(search->last_search);
145 camel_folder_search_get_type (void)
147 static CamelType type = CAMEL_INVALID_TYPE;
149 if (type == CAMEL_INVALID_TYPE) {
150 type = camel_type_register (camel_object_get_type (), "CamelFolderSearch",
151 sizeof (CamelFolderSearch),
152 sizeof (CamelFolderSearchClass),
153 (CamelObjectClassInitFunc) camel_folder_search_class_init,
155 (CamelObjectInitFunc) camel_folder_search_init,
156 (CamelObjectFinalizeFunc) camel_folder_search_finalize);
163 #define CAMEL_STRUCT_OFFSET(type, field) ((gint) offsetof (type, field))
165 #define CAMEL_STRUCT_OFFSET(type, field) ((gint) ((gchar*) &((type *) 0)->field))
171 int flags; /* 0x02 = immediate, 0x01 = always enter */
173 /* these have default implementations in e-sexp */
174 { "and", CAMEL_STRUCT_OFFSET(CamelFolderSearchClass, and), 2 },
175 { "or", CAMEL_STRUCT_OFFSET(CamelFolderSearchClass, or), 2 },
176 /* we need to override this one though to implement an 'array not' */
177 { "not", CAMEL_STRUCT_OFFSET(CamelFolderSearchClass, not), 0 },
178 { "<", CAMEL_STRUCT_OFFSET(CamelFolderSearchClass, lt), 2 },
179 { ">", CAMEL_STRUCT_OFFSET(CamelFolderSearchClass, gt), 2 },
180 { "=", CAMEL_STRUCT_OFFSET(CamelFolderSearchClass, eq), 2 },
182 /* these we have to use our own default if there is none */
183 /* they should all be defined in the language? so it parses, or should they not?? */
184 { "match-all", CAMEL_STRUCT_OFFSET(CamelFolderSearchClass, match_all), 3 },
185 { "match-threads", CAMEL_STRUCT_OFFSET(CamelFolderSearchClass, match_threads), 3 },
186 { "body-contains", CAMEL_STRUCT_OFFSET(CamelFolderSearchClass, body_contains), 1 },
187 { "header-contains", CAMEL_STRUCT_OFFSET(CamelFolderSearchClass, header_contains), 1 },
188 { "header-matches", CAMEL_STRUCT_OFFSET(CamelFolderSearchClass, header_matches), 1 },
189 { "header-starts-with", CAMEL_STRUCT_OFFSET(CamelFolderSearchClass, header_starts_with), 1 },
190 { "header-ends-with", CAMEL_STRUCT_OFFSET(CamelFolderSearchClass, header_ends_with), 1 },
191 { "header-exists", CAMEL_STRUCT_OFFSET(CamelFolderSearchClass, header_exists), 1 },
192 { "user-tag", CAMEL_STRUCT_OFFSET(CamelFolderSearchClass, user_tag), 1 },
193 { "user-flag", CAMEL_STRUCT_OFFSET(CamelFolderSearchClass, user_flag), 1 },
194 { "system-flag", CAMEL_STRUCT_OFFSET(CamelFolderSearchClass, system_flag), 1 },
195 { "get-sent-date", CAMEL_STRUCT_OFFSET(CamelFolderSearchClass, get_sent_date), 1 },
196 { "get-received-date", CAMEL_STRUCT_OFFSET(CamelFolderSearchClass, get_received_date), 1 },
197 { "get-current-date", CAMEL_STRUCT_OFFSET(CamelFolderSearchClass, get_current_date), 1 },
198 { "get-size", CAMEL_STRUCT_OFFSET(CamelFolderSearchClass, get_size), 1 },
199 { "uid", CAMEL_STRUCT_OFFSET(CamelFolderSearchClass, uid), 1 },
203 camel_folder_search_construct (CamelFolderSearch *search)
206 CamelFolderSearchClass *klass = (CamelFolderSearchClass *)CAMEL_OBJECT_GET_CLASS(search);
208 for (i=0;i<sizeof(builtins)/sizeof(builtins[0]);i++) {
210 /* c is sure messy sometimes */
211 func = *((void **)(((char *)klass)+builtins[i].offset));
212 if (func == NULL && builtins[i].flags&1) {
213 g_warning("Search class doesn't implement '%s' method: %s", builtins[i].name, camel_type_to_name(CAMEL_OBJECT_GET_CLASS(search)));
214 func = (void *)search_dummy;
217 if (builtins[i].flags&2) {
218 e_sexp_add_ifunction(search->sexp, 0, builtins[i].name, (ESExpIFunc *)func, search);
220 e_sexp_add_function(search->sexp, 0, builtins[i].name, (ESExpFunc *)func, search);
227 * camel_folder_search_new:
229 * Create a new CamelFolderSearch object.
231 * A CamelFolderSearch is a subclassable, extensible s-exp
232 * evaluator which enforces a particular set of s-expressions.
233 * Particular methods may be overriden by an implementation to
234 * implement a search for any sort of backend.
236 * Return value: A new CamelFolderSearch widget.
239 camel_folder_search_new (void)
241 CamelFolderSearch *new = CAMEL_FOLDER_SEARCH (camel_object_new (camel_folder_search_get_type ()));
243 camel_folder_search_construct(new);
248 * camel_folder_search_set_folder:
252 * Set the folder attribute of the search. This is currently unused, but
253 * could be used to perform a slow-search when indexes and so forth are not
254 * available. Or for use by subclasses.
257 camel_folder_search_set_folder(CamelFolderSearch *search, CamelFolder *folder)
259 search->folder = folder;
263 * camel_folder_search_set_summary:
265 * @summary: An array of CamelMessageInfo pointers.
267 * Set the array of summary objects representing the span of the search.
269 * If this is not set, then a subclass must provide the functions
270 * for searching headers and for the match-all operator.
273 camel_folder_search_set_summary(CamelFolderSearch *search, GPtrArray *summary)
275 search->summary = summary;
279 * camel_folder_search_set_body_index:
283 * Set the index representing the contents of all messages
284 * in this folder. If this is not set, then the folder implementation
285 * should sub-class the CamelFolderSearch and provide its own
286 * body-contains function.
289 camel_folder_search_set_body_index(CamelFolderSearch *search, CamelIndex *index)
291 if (search->body_index)
292 camel_object_unref((CamelObject *)search->body_index);
293 search->body_index = index;
295 camel_object_ref((CamelObject *)index);
299 * camel_folder_search_execute_expression:
304 * Execute the search expression @expr, returning an array of
305 * all matches as a GPtrArray of uid's of matching messages.
307 * Note that any settings such as set_body_index(), set_folder(),
308 * and so on are reset to #NULL once the search has completed.
310 * TODO: The interface should probably return summary items instead
311 * (since they are much more useful to any client).
313 * Return value: A GPtrArray of strings of all matching messages.
314 * This must only be freed by camel_folder_search_free_result.
317 camel_folder_search_execute_expression(CamelFolderSearch *search, const char *expr, CamelException *ex)
323 struct _CamelFolderSearchPrivate *p = _PRIVATE(search);
327 /* only re-parse if the search has changed */
328 if (search->last_search == NULL
329 || strcmp(search->last_search, expr)) {
330 e_sexp_input_text(search->sexp, expr, strlen(expr));
331 if (e_sexp_parse(search->sexp) == -1) {
332 camel_exception_setv(ex, 1, _("Cannot parse search expression: %s:\n%s"), e_sexp_error(search->sexp), expr);
336 g_free(search->last_search);
337 search->last_search = g_strdup(expr);
339 r = e_sexp_eval(search->sexp);
341 if (!camel_exception_is_set(ex))
342 camel_exception_setv(ex, 1, _("Error executing search expression: %s:\n%s"), e_sexp_error(search->sexp), expr);
346 matches = g_ptr_array_new();
348 /* now create a folder summary to return?? */
349 if (r->type == ESEXP_RES_ARRAY_PTR) {
350 d(printf("got result ...\n"));
351 if (search->summary) {
352 /* reorder result in summary order */
353 results = g_hash_table_new(g_str_hash, g_str_equal);
354 for (i=0;i<r->value.ptrarray->len;i++) {
355 d(printf("adding match: %s\n", (char *)g_ptr_array_index(r->value.ptrarray, i)));
356 g_hash_table_insert(results, g_ptr_array_index(r->value.ptrarray, i), GINT_TO_POINTER (1));
358 for (i=0;i<search->summary->len;i++) {
359 char *uid = g_ptr_array_index(search->summary, i);
360 if (g_hash_table_lookup(results, uid)) {
361 g_ptr_array_add(matches, (gpointer) camel_pstring_strdup(uid));
364 g_hash_table_destroy(results);
366 for (i=0;i<r->value.ptrarray->len;i++) {
367 d(printf("adding match: %s\n", (char *)g_ptr_array_index(r->value.ptrarray, i)));
368 g_ptr_array_add(matches, (gpointer) camel_pstring_strdup(g_ptr_array_index(r->value.ptrarray, i)));
372 g_warning("Search returned an invalid result type");
375 e_sexp_result_free(search->sexp, r);
378 camel_folder_thread_messages_unref(p->threads);
380 g_hash_table_destroy(p->threads_hash);
383 p->threads_hash = NULL;
384 search->folder = NULL;
385 search->summary = NULL;
386 search->current = NULL;
387 search->body_index = NULL;
393 * camel_folder_search_search:
396 * @uids: to search against, NULL for all uid's.
399 * Run a search. Search must have had Folder already set on it, and
400 * it must implement summaries.
405 camel_folder_search_search(CamelFolderSearch *search, const char *expr, GPtrArray *uids, CamelException *ex)
408 GPtrArray *matches = NULL, *summary_set;
411 char *sql_query, *tmp, *tmp1;
414 struct _CamelFolderSearchPrivate *p = _PRIVATE(search);
416 g_assert(search->folder);
420 /* We route body-contains search and uid search through memory and not via db. */
421 if (uids || strstr((const char *) expr, "body-contains")) {
422 /* setup our search list only contains those we're interested in */
423 search->summary = camel_folder_get_summary(search->folder);
426 GHashTable *uids_hash = g_hash_table_new(g_str_hash, g_str_equal);
428 summary_set = search->summary_set = g_ptr_array_new();
429 for (i=0;i<uids->len;i++)
430 g_hash_table_insert(uids_hash, uids->pdata[i], uids->pdata[i]);
431 for (i=0;i<search->summary->len;i++)
432 if (g_hash_table_lookup(uids_hash, search->summary->pdata[i]))
433 g_ptr_array_add(search->summary_set, search->summary->pdata[i]);
434 g_hash_table_destroy(uids_hash);
436 summary_set = search->summary;
439 /* only re-parse if the search has changed */
440 if (search->last_search == NULL
441 || strcmp(search->last_search, expr)) {
442 e_sexp_input_text(search->sexp, expr, strlen(expr));
443 if (e_sexp_parse(search->sexp) == -1) {
444 camel_exception_setv(ex, 1, _("Cannot parse search expression: %s:\n%s"), e_sexp_error(search->sexp), expr);
448 g_free(search->last_search);
449 search->last_search = g_strdup(expr);
451 r = e_sexp_eval(search->sexp);
453 if (!camel_exception_is_set(ex))
454 camel_exception_setv(ex, 1, _("Error executing search expression: %s:\n%s"), e_sexp_error(search->sexp), expr);
458 matches = g_ptr_array_new();
460 /* now create a folder summary to return?? */
461 if (r->type == ESEXP_RES_ARRAY_PTR) {
462 d(printf("got result\n"));
464 /* reorder result in summary order */
465 results = g_hash_table_new(g_str_hash, g_str_equal);
466 for (i=0;i<r->value.ptrarray->len;i++) {
467 d(printf("adding match: %s\n", (char *)g_ptr_array_index(r->value.ptrarray, i)));
468 g_hash_table_insert(results, g_ptr_array_index(r->value.ptrarray, i), GINT_TO_POINTER (1));
471 for (i=0;i<summary_set->len;i++) {
472 char *uid = g_ptr_array_index(summary_set, i);
473 if (g_hash_table_lookup(results, uid))
474 g_ptr_array_add(matches, (gpointer) camel_pstring_strdup(uid));
476 g_hash_table_destroy(results);
479 e_sexp_result_free(search->sexp, r);
482 /* Sync the db, so that we search the db for changes */
483 camel_folder_summary_save_to_db (search->folder->summary, ex);
485 d(printf ("sexp is : [%s]\n", expr));
486 sql_query = camel_sexp_to_sql (expr);
487 tmp1 = camel_db_sqlize_string(search->folder->full_name);
488 tmp = g_strdup_printf ("SELECT uid FROM %s %s %s", tmp1, sql_query ? "WHERE":"", sql_query?sql_query:"");
489 camel_db_free_sqlized_string (tmp1);
491 d(printf("Equivalent sql %s\n", tmp));
493 matches = g_ptr_array_new();
494 cdb = (CamelDB *) (search->folder->cdb);
495 camel_db_select (cdb, tmp, (CamelDBSelectCB) read_uid_callback, matches, ex);
496 if (ex && camel_exception_is_set(ex)) {
497 const char *exception = camel_exception_get_description (ex);
498 if (strncmp(exception, "no such table", 13) == 0) {
499 g_warning ("Error during searching %s: %s\n", tmp, exception);
500 camel_exception_clear (ex); /* Suppress no such table */
508 /* these might be allocated by match-threads */
510 camel_folder_thread_messages_unref(p->threads);
512 g_hash_table_destroy(p->threads_hash);
513 if (search->summary_set)
514 g_ptr_array_free(search->summary_set, TRUE);
516 camel_folder_free_summary(search->folder, search->summary);
519 p->threads_hash = NULL;
520 search->folder = NULL;
521 search->summary = NULL;
522 search->summary_set = NULL;
523 search->current = NULL;
524 search->body_index = NULL;
529 void camel_folder_search_free_result(CamelFolderSearch *search, GPtrArray *result)
531 g_ptr_array_foreach (result, (GFunc) camel_pstring_free, NULL);
532 g_ptr_array_free(result, TRUE);
535 /* dummy function, returns false always, or an empty match array */
537 search_dummy(struct _ESExp *f, int argc, struct _ESExpResult **argv, CamelFolderSearch *search)
541 if (search->current == NULL) {
542 r = e_sexp_result_new(f, ESEXP_RES_BOOL);
543 r->value.bool = FALSE;
545 r = e_sexp_result_new(f, ESEXP_RES_ARRAY_PTR);
546 r->value.ptrarray = g_ptr_array_new();
552 /* impelemnt an 'array not', i.e. everything in the summary, not in the supplied array */
554 search_not(struct _ESExp *f, int argc, struct _ESExpResult **argv, CamelFolderSearch *search)
560 if (argv[0]->type == ESEXP_RES_ARRAY_PTR) {
561 GPtrArray *v = argv[0]->value.ptrarray;
564 r = e_sexp_result_new(f, ESEXP_RES_ARRAY_PTR);
565 r->value.ptrarray = g_ptr_array_new();
567 /* not against a single message?*/
568 if (search->current) {
571 uid = camel_message_info_uid(search->current);
572 for (i=0;!found && i<v->len;i++) {
573 if (strcmp(uid, v->pdata[i]) == 0)
578 g_ptr_array_add(r->value.ptrarray, (char *)uid);
579 } else if (search->summary == NULL) {
580 g_warning("No summary set, 'not' against an array requires a summary");
582 /* 'not' against the whole summary */
583 GHashTable *have = g_hash_table_new(g_str_hash, g_str_equal);
587 s = (char **)v->pdata;
588 for (i=0;i<v->len;i++)
589 g_hash_table_insert(have, s[i], s[i]);
591 v = search->summary_set?search->summary_set:search->summary;
592 m = (char **)v->pdata;
593 for (i=0;i<v->len;i++) {
596 if (g_hash_table_lookup(have, uid) == NULL)
597 g_ptr_array_add(r->value.ptrarray, uid);
599 g_hash_table_destroy(have);
604 if (argv[0]->type == ESEXP_RES_BOOL)
605 res = ! argv[0]->value.bool;
607 r = e_sexp_result_new(f, ESEXP_RES_BOOL);
611 r = e_sexp_result_new(f, ESEXP_RES_BOOL);
612 r->value.bool = TRUE;
619 search_match_all(struct _ESExp *f, int argc, struct _ESExpTerm **argv, CamelFolderSearch *search)
627 g_warning("match-all only takes a single argument, other arguments ignored");
630 /* we are only matching a single message? or already inside a match-all? */
631 if (search->current) {
632 d(printf("matching against 1 message: %s\n", camel_message_info_subject(search->current)));
634 r = e_sexp_result_new(f, ESEXP_RES_BOOL);
635 r->value.bool = FALSE;
638 r1 = e_sexp_term_eval(f, argv[0]);
639 if (r1->type == ESEXP_RES_BOOL) {
640 r->value.bool = r1->value.bool;
642 g_warning("invalid syntax, matches require a single bool result");
643 error_msg = g_strdup_printf(_("(%s) requires a single bool result"), "match-all");
644 e_sexp_fatal_error(f, error_msg);
647 e_sexp_result_free(f, r1);
649 r->value.bool = TRUE;
654 r = e_sexp_result_new(f, ESEXP_RES_ARRAY_PTR);
655 r->value.ptrarray = g_ptr_array_new();
657 if (search->summary == NULL) {
658 /* TODO: make it work - e.g. use the folder and so forth for a slower search */
659 g_warning("No summary supplied, match-all doesn't work with no summary");
664 v = search->summary_set?search->summary_set:search->summary;
666 if (v->len > g_hash_table_size (search->folder->summary->loaded_infos) && !CAMEL_IS_VEE_FOLDER (search->folder)) {
667 camel_folder_summary_reload_from_db (search->folder->summary, search->priv->ex);
670 e_sexp_term_eval (f, argv [0]);
672 for (i=0;i<v->len;i++) {
675 search->current = camel_folder_summary_uid (search->folder->summary, v->pdata[i]);
676 uid = camel_message_info_uid(search->current);
679 r1 = e_sexp_term_eval(f, argv[0]);
680 if (r1->type == ESEXP_RES_BOOL) {
682 g_ptr_array_add(r->value.ptrarray, (char *)uid);
684 g_warning("invalid syntax, matches require a single bool result");
685 error_msg = g_strdup_printf(_("(%s) requires a single bool result"), "match-all");
686 e_sexp_fatal_error(f, error_msg);
689 e_sexp_result_free(f, r1);
691 g_ptr_array_add(r->value.ptrarray, (char *)uid);
693 camel_message_info_free (search->current);
695 search->current = NULL;
700 fill_thread_table(struct _CamelFolderThreadNode *root, GHashTable *id_hash)
703 g_hash_table_insert(id_hash, (char *)camel_message_info_uid(root->message), root);
705 fill_thread_table(root->child, id_hash);
711 add_thread_results(struct _CamelFolderThreadNode *root, GHashTable *result_hash)
714 g_hash_table_insert(result_hash, (char *)camel_message_info_uid(root->message), GINT_TO_POINTER (1));
716 add_thread_results(root->child, result_hash);
722 add_results(char *uid, void *dummy, GPtrArray *result)
724 g_ptr_array_add(result, uid);
728 search_match_threads(struct _ESExp *f, int argc, struct _ESExpTerm **argv, CamelFolderSearch *search)
731 struct _CamelFolderSearchPrivate *p = search->priv;
736 /* not supported in match-all */
737 if (search->current) {
738 error_msg = g_strdup_printf(_("(%s) not allowed inside %s"), "match-threads", "match-all");
739 e_sexp_fatal_error(f, error_msg);
744 error_msg = g_strdup_printf(_("(%s) requires a match type string"), "match-threads");
745 e_sexp_fatal_error(f, error_msg);
749 r = e_sexp_term_eval(f, argv[0]);
750 if (r->type != ESEXP_RES_STRING) {
751 error_msg = g_strdup_printf(_("(%s) requires a match type string"), "match-threads");
752 e_sexp_fatal_error(f, error_msg);
757 if (!strcmp(r->value.string, "none"))
759 else if (!strcmp(r->value.string, "all"))
761 else if (!strcmp(r->value.string, "replies"))
763 else if (!strcmp(r->value.string, "replies_parents"))
765 else if (!strcmp(r->value.string, "single"))
767 e_sexp_result_free(f, r);
769 /* behave as (begin does */
771 for (i=1;i<argc;i++) {
773 e_sexp_result_free(f, r);
774 r = e_sexp_term_eval(f, argv[i]);
777 if (r == NULL || r->type != ESEXP_RES_ARRAY_PTR) {
778 error_msg = g_strdup_printf(_("(%s) expects an array result"), "match-threads");
779 e_sexp_fatal_error(f, error_msg);
786 if (search->folder == NULL) {
787 error_msg = g_strdup_printf(_("(%s) requires the folder set"), "match-threads");
788 e_sexp_fatal_error(f, error_msg);
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 struct _CamelFolderThreadNode *node, *scan;
805 g_hash_table_insert(results, g_ptr_array_index(r->value.ptrarray, i), GINT_TO_POINTER(1));
807 node = g_hash_table_lookup(p->threads_hash, (char *)g_ptr_array_index(r->value.ptrarray, i));
808 if (node == NULL) /* this shouldn't happen but why cry over spilt milk */
811 /* select messages in thread according to search criteria */
813 if (node->child == NULL && node->parent == NULL)
814 g_hash_table_insert(results, (char *)camel_message_info_uid(node->message), GINT_TO_POINTER(1));
818 while (scan && scan->parent) {
820 g_hash_table_insert(results, (char *)camel_message_info_uid(scan->message), GINT_TO_POINTER(1));
822 } else if (type == 1) {
823 while (node && node->parent)
826 g_hash_table_insert(results, (char *)camel_message_info_uid(node->message), GINT_TO_POINTER(1));
828 add_thread_results(node->child, results);
831 e_sexp_result_free(f, r);
833 r = e_sexp_result_new(f, ESEXP_RES_ARRAY_PTR);
834 r->value.ptrarray = g_ptr_array_new();
836 g_hash_table_foreach(results, (GHFunc)add_results, r->value.ptrarray);
837 g_hash_table_destroy(results);
843 check_header (struct _ESExp *f, int argc, struct _ESExpResult **argv, CamelFolderSearch *search, camel_search_match_t how)
848 r(printf("executing check-header %d\n", how));
850 /* are we inside a match-all? */
851 if (search->current && argc>1
852 && argv[0]->type == ESEXP_RES_STRING) {
854 const char *header = NULL;
857 camel_search_t type = CAMEL_SEARCH_TYPE_ASIS;
858 struct _camel_search_words *words;
860 /* only a subset of headers are supported .. */
861 headername = argv[0]->value.string;
862 if (!g_ascii_strcasecmp(headername, "subject")) {
863 header = camel_message_info_subject(search->current);
864 } else if (!g_ascii_strcasecmp(headername, "date")) {
865 /* FIXME: not a very useful form of the date */
866 sprintf(strbuf, "%d", (int)camel_message_info_date_sent(search->current));
868 } else if (!g_ascii_strcasecmp(headername, "from")) {
869 header = camel_message_info_from(search->current);
870 type = CAMEL_SEARCH_TYPE_ADDRESS;
871 } else if (!g_ascii_strcasecmp(headername, "to")) {
872 header = camel_message_info_to(search->current);
873 type = CAMEL_SEARCH_TYPE_ADDRESS;
874 } else if (!g_ascii_strcasecmp(headername, "cc")) {
875 header = camel_message_info_cc(search->current);
876 type = CAMEL_SEARCH_TYPE_ADDRESS;
877 } else if (!g_ascii_strcasecmp(headername, "x-camel-mlist")) {
878 header = camel_message_info_mlist(search->current);
879 type = CAMEL_SEARCH_TYPE_MLIST;
881 e_sexp_resultv_free(f, argc, argv);
882 e_sexp_fatal_error(f, _("Performing query on unknown header: %s"), headername);
888 /* performs an OR of all words */
889 for (i=1;i<argc && !truth;i++) {
890 if (argv[i]->type == ESEXP_RES_STRING) {
891 if (argv[i]->value.string[0] == 0) {
893 } else if (how == CAMEL_SEARCH_MATCH_CONTAINS) {
894 /* doesn't make sense to split words on anything but contains i.e. we can't have an ending match different words */
895 words = camel_search_words_split((const unsigned char *) argv[i]->value.string);
897 for (j=0;j<words->len && truth;j++) {
898 truth = camel_search_header_match(header, words->words[j]->word, how, type, NULL);
900 camel_search_words_free(words);
902 truth = camel_search_header_match(header, argv[i]->value.string, how, type, NULL);
907 /* TODO: else, find all matches */
909 r = e_sexp_result_new(f, ESEXP_RES_BOOL);
910 r->value.bool = truth;
919 printf("%s\t", node);
924 search_header_contains(struct _ESExp *f, int argc, struct _ESExpResult **argv, CamelFolderSearch *search)
926 return check_header(f, argc, argv, search, CAMEL_SEARCH_MATCH_CONTAINS);
930 search_header_matches(struct _ESExp *f, int argc, struct _ESExpResult **argv, CamelFolderSearch *search)
932 return check_header(f, argc, argv, search, CAMEL_SEARCH_MATCH_EXACT);
936 search_header_starts_with (struct _ESExp *f, int argc, struct _ESExpResult **argv, CamelFolderSearch *search)
938 return check_header(f, argc, argv, search, CAMEL_SEARCH_MATCH_STARTS);
942 search_header_ends_with (struct _ESExp *f, int argc, struct _ESExpResult **argv, CamelFolderSearch *search)
944 return check_header(f, argc, argv, search, CAMEL_SEARCH_MATCH_ENDS);
948 search_header_exists (struct _ESExp *f, int argc, struct _ESExpResult **argv, CamelFolderSearch *search)
952 r(printf ("executing header-exists\n"));
954 if (search->current) {
955 r = e_sexp_result_new(f, ESEXP_RES_BOOL);
956 if (argc == 1 && argv[0]->type == ESEXP_RES_STRING)
957 r->value.bool = camel_medium_get_header(CAMEL_MEDIUM(search->current), argv[0]->value.string) != NULL;
960 r = e_sexp_result_new(f, ESEXP_RES_ARRAY_PTR);
961 r->value.ptrarray = g_ptr_array_new();
967 /* this is just to OR results together */
968 struct _glib_sux_donkeys {
973 /* or, store all unique values */
975 g_lib_sux_htor(char *key, int value, struct _glib_sux_donkeys *fuckup)
977 g_ptr_array_add(fuckup->uids, key);
980 /* and, only store duplicates */
982 g_lib_sux_htand(char *key, int value, struct _glib_sux_donkeys *fuckup)
984 if (value == fuckup->count)
985 g_ptr_array_add(fuckup->uids, key);
989 match_message_index(CamelIndex *idx, const char *uid, const char *match, CamelException *ex)
991 CamelIndexCursor *wc, *nc;
992 const char *word, *name;
995 wc = camel_index_words(idx);
997 while (!truth && (word = camel_index_cursor_next(wc))) {
998 if (camel_ustrstrcase(word,match) != NULL) {
999 /* perf: could have the wc cursor return the name cursor */
1000 nc = camel_index_find(idx, word);
1002 while (!truth && (name = camel_index_cursor_next(nc)))
1003 truth = strcmp(name, uid) == 0;
1004 camel_object_unref((CamelObject *)nc);
1008 camel_object_unref((CamelObject *)wc);
1015 "one two" "three" "four five"
1024 /* returns messages which contain all words listed in words */
1026 match_words_index(CamelFolderSearch *search, struct _camel_search_words *words, CamelException *ex)
1028 GPtrArray *result = g_ptr_array_new();
1029 GHashTable *ht = g_hash_table_new(g_str_hash, g_str_equal);
1030 struct _glib_sux_donkeys lambdafoo;
1031 CamelIndexCursor *wc, *nc;
1032 const char *word, *name;
1035 /* we can have a maximum of 32 words, as we use it as the AND mask */
1037 wc = camel_index_words(search->body_index);
1039 while ((word = camel_index_cursor_next(wc))) {
1040 for (i=0;i<words->len;i++) {
1041 if (camel_ustrstrcase(word, words->words[i]->word) != NULL) {
1042 /* perf: could have the wc cursor return the name cursor */
1043 nc = camel_index_find(search->body_index, word);
1045 while ((name = camel_index_cursor_next(nc))) {
1048 mask = (GPOINTER_TO_INT(g_hash_table_lookup(ht, name))) | (1<<i);
1049 g_hash_table_insert(ht, (char *) camel_pstring_peek(name), GINT_TO_POINTER(mask));
1051 camel_object_unref((CamelObject *)nc);
1056 camel_object_unref((CamelObject *)wc);
1058 lambdafoo.uids = result;
1059 lambdafoo.count = (1<<words->len) - 1;
1060 g_hash_table_foreach(ht, (GHFunc)g_lib_sux_htand, &lambdafoo);
1061 g_hash_table_destroy(ht);
1068 match_words_1message (CamelDataWrapper *object, struct _camel_search_words *words, guint32 *mask)
1070 CamelDataWrapper *containee;
1074 containee = camel_medium_get_content_object (CAMEL_MEDIUM (object));
1076 if (containee == NULL)
1079 /* using the object types is more accurate than using the mime/types */
1080 if (CAMEL_IS_MULTIPART (containee)) {
1081 parts = camel_multipart_get_number (CAMEL_MULTIPART (containee));
1082 for (i = 0; i < parts && truth == FALSE; i++) {
1083 CamelDataWrapper *part = (CamelDataWrapper *)camel_multipart_get_part (CAMEL_MULTIPART (containee), i);
1085 truth = match_words_1message(part, words, mask);
1087 } else if (CAMEL_IS_MIME_MESSAGE (containee)) {
1088 /* for messages we only look at its contents */
1089 truth = match_words_1message((CamelDataWrapper *)containee, words, mask);
1090 } else if (camel_content_type_is(CAMEL_DATA_WRAPPER (containee)->mime_type, "text", "*")) {
1091 /* for all other text parts, we look inside, otherwise we dont care */
1092 CamelStreamMem *mem = (CamelStreamMem *)camel_stream_mem_new ();
1094 /* FIXME: The match should be part of a stream op */
1095 camel_data_wrapper_decode_to_stream (containee, CAMEL_STREAM (mem));
1096 camel_stream_write (CAMEL_STREAM (mem), "", 1);
1097 for (i=0;i<words->len;i++) {
1098 /* FIXME: This is horridly slow, and should use a real search algorithm */
1099 if (camel_ustrstrcase((const char *) mem->buffer->data, words->words[i]->word) != NULL) {
1101 /* shortcut a match */
1102 if (*mask == (1<<(words->len))-1)
1107 camel_object_unref (mem);
1114 match_words_message(CamelFolder *folder, const char *uid, struct _camel_search_words *words, CamelException *ex)
1117 CamelMimeMessage *msg;
1118 CamelException x = CAMEL_EXCEPTION_INITIALISER;
1121 msg = camel_folder_get_message(folder, uid, &x);
1124 truth = match_words_1message((CamelDataWrapper *)msg, words, &mask);
1125 camel_object_unref((CamelObject *)msg);
1127 camel_exception_clear(&x);
1135 match_words_messages(CamelFolderSearch *search, struct _camel_search_words *words, CamelException *ex)
1138 GPtrArray *matches = g_ptr_array_new();
1140 if (search->body_index) {
1142 struct _camel_search_words *simple;
1144 simple = camel_search_words_simple(words);
1145 indexed = match_words_index(search, simple, ex);
1146 camel_search_words_free(simple);
1148 for (i=0;i<indexed->len;i++) {
1149 const char *uid = g_ptr_array_index(indexed, i);
1151 if (match_words_message(search->folder, uid, words, ex))
1152 g_ptr_array_add(matches, (char *)uid);
1155 g_ptr_array_free(indexed, TRUE);
1157 GPtrArray *v = search->summary_set?search->summary_set:search->summary;
1159 for (i=0;i<v->len;i++) {
1160 char *uid = g_ptr_array_index(v, i);
1162 if (match_words_message(search->folder, uid, words, ex))
1163 g_ptr_array_add(matches, (char *)uid);
1170 static ESExpResult *
1171 search_body_contains(struct _ESExp *f, int argc, struct _ESExpResult **argv, CamelFolderSearch *search)
1174 CamelException *ex = search->priv->ex;
1175 struct _camel_search_words *words;
1177 struct _glib_sux_donkeys lambdafoo;
1179 if (search->current) {
1182 if (argc == 1 && argv[0]->value.string[0] == 0) {
1185 for (i=0;i<argc && !truth;i++) {
1186 if (argv[i]->type == ESEXP_RES_STRING) {
1187 words = camel_search_words_split((const unsigned char *) argv[i]->value.string);
1189 if ((words->type & CAMEL_SEARCH_WORD_COMPLEX) == 0 && search->body_index) {
1190 for (j=0;j<words->len && truth;j++)
1191 truth = match_message_index(search->body_index, camel_message_info_uid(search->current), words->words[j]->word, ex);
1193 /* TODO: cache current message incase of multiple body search terms */
1194 truth = match_words_message(search->folder, camel_message_info_uid(search->current), words, ex);
1196 camel_search_words_free(words);
1200 r = e_sexp_result_new(f, ESEXP_RES_BOOL);
1201 r->value.bool = truth;
1203 r = e_sexp_result_new(f, ESEXP_RES_ARRAY_PTR);
1204 r->value.ptrarray = g_ptr_array_new();
1206 if (argc == 1 && argv[0]->value.string[0] == 0) {
1207 GPtrArray *v = search->summary_set?search->summary_set:search->summary;
1209 for (i=0;i<v->len;i++) {
1210 char *uid = g_ptr_array_index(v, i);
1212 g_ptr_array_add(r->value.ptrarray, uid);
1215 GHashTable *ht = g_hash_table_new(g_str_hash, g_str_equal);
1218 for (i=0;i<argc;i++) {
1219 if (argv[i]->type == ESEXP_RES_STRING) {
1220 words = camel_search_words_split((const unsigned char *) argv[i]->value.string);
1221 if ((words->type & CAMEL_SEARCH_WORD_COMPLEX) == 0 && search->body_index) {
1222 matches = match_words_index(search, words, ex);
1224 matches = match_words_messages(search, words, ex);
1226 for (j=0;j<matches->len;j++) {
1227 g_hash_table_insert(ht, matches->pdata[j], matches->pdata[j]);
1229 g_ptr_array_free(matches, TRUE);
1230 camel_search_words_free(words);
1233 lambdafoo.uids = r->value.ptrarray;
1234 g_hash_table_foreach(ht, (GHFunc)g_lib_sux_htor, &lambdafoo);
1235 g_hash_table_destroy(ht);
1242 static ESExpResult *
1243 search_user_flag(struct _ESExp *f, int argc, struct _ESExpResult **argv, CamelFolderSearch *search)
1248 r(printf("executing user-flag\n"));
1250 /* are we inside a match-all? */
1251 if (search->current) {
1253 /* performs an OR of all words */
1254 for (i=0;i<argc && !truth;i++) {
1255 if (argv[i]->type == ESEXP_RES_STRING
1256 && camel_message_info_user_flag(search->current, argv[i]->value.string)) {
1261 r = e_sexp_result_new(f, ESEXP_RES_BOOL);
1262 r->value.bool = truth;
1264 r = e_sexp_result_new(f, ESEXP_RES_ARRAY_PTR);
1265 r->value.ptrarray = g_ptr_array_new();
1271 static ESExpResult *
1272 search_system_flag (struct _ESExp *f, int argc, struct _ESExpResult **argv, CamelFolderSearch *search)
1276 r(printf ("executing system-flag\n"));
1278 if (search->current) {
1279 gboolean truth = FALSE;
1282 truth = camel_system_flag_get (camel_message_info_flags(search->current), argv[0]->value.string);
1284 r = e_sexp_result_new(f, ESEXP_RES_BOOL);
1285 r->value.bool = truth;
1287 r = e_sexp_result_new(f, ESEXP_RES_ARRAY_PTR);
1288 r->value.ptrarray = g_ptr_array_new ();
1294 static ESExpResult *
1295 search_user_tag(struct _ESExp *f, int argc, struct _ESExpResult **argv, CamelFolderSearch *search)
1297 const char *value = NULL;
1300 r(printf("executing user-tag\n"));
1302 if (search->current && argc == 1)
1303 value = camel_message_info_user_tag(search->current, argv[0]->value.string);
1305 r = e_sexp_result_new(f, ESEXP_RES_STRING);
1306 r->value.string = g_strdup (value ? value : "");
1311 static ESExpResult *
1312 search_get_sent_date(struct _ESExp *f, int argc, struct _ESExpResult **argv, CamelFolderSearch *s)
1316 r(printf("executing get-sent-date\n"));
1318 /* are we inside a match-all? */
1320 r = e_sexp_result_new(f, ESEXP_RES_INT);
1322 r->value.number = camel_message_info_date_sent(s->current);
1324 r = e_sexp_result_new(f, ESEXP_RES_ARRAY_PTR);
1325 r->value.ptrarray = g_ptr_array_new ();
1331 static ESExpResult *
1332 search_get_received_date(struct _ESExp *f, int argc, struct _ESExpResult **argv, CamelFolderSearch *s)
1336 r(printf("executing get-received-date\n"));
1338 /* are we inside a match-all? */
1340 r = e_sexp_result_new(f, ESEXP_RES_INT);
1342 r->value.number = camel_message_info_date_received(s->current);
1344 r = e_sexp_result_new(f, ESEXP_RES_ARRAY_PTR);
1345 r->value.ptrarray = g_ptr_array_new ();
1351 static ESExpResult *
1352 search_get_current_date(struct _ESExp *f, int argc, struct _ESExpResult **argv, CamelFolderSearch *s)
1356 r(printf("executing get-current-date\n"));
1358 r = e_sexp_result_new(f, ESEXP_RES_INT);
1359 r->value.number = time (NULL);
1363 static ESExpResult *
1364 search_get_size (struct _ESExp *f, int argc, struct _ESExpResult **argv, CamelFolderSearch *s)
1368 r(printf("executing get-size\n"));
1370 /* are we inside a match-all? */
1372 r = e_sexp_result_new (f, ESEXP_RES_INT);
1373 r->value.number = camel_message_info_size(s->current) / 1024;
1375 r = e_sexp_result_new (f, ESEXP_RES_ARRAY_PTR);
1376 r->value.ptrarray = g_ptr_array_new ();
1382 static ESExpResult *
1383 search_uid(struct _ESExp *f, int argc, struct _ESExpResult **argv, CamelFolderSearch *search)
1388 r(printf("executing uid\n"));
1390 /* are we inside a match-all? */
1391 if (search->current) {
1393 const char *uid = camel_message_info_uid(search->current);
1395 /* performs an OR of all words */
1396 for (i=0;i<argc && !truth;i++) {
1397 if (argv[i]->type == ESEXP_RES_STRING
1398 && !strcmp(uid, argv[i]->value.string)) {
1403 r = e_sexp_result_new(f, ESEXP_RES_BOOL);
1404 r->value.bool = truth;
1406 r = e_sexp_result_new(f, ESEXP_RES_ARRAY_PTR);
1407 r->value.ptrarray = g_ptr_array_new();
1408 for (i=0;i<argc;i++) {
1409 if (argv[i]->type == ESEXP_RES_STRING)
1410 g_ptr_array_add(r->value.ptrarray, argv[i]->value.string);
1418 read_uid_callback (void * ref, int ncol, char ** cols, char **name)
1422 matches = (GPtrArray *) ref;
1424 g_ptr_array_add (matches, (gpointer) camel_pstring_strdup (cols [0]));