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"
54 #include "camel-search-sql-sexp.h"
59 struct _CamelFolderSearchPrivate {
62 CamelFolderThread *threads;
63 GHashTable *threads_hash;
66 #define _PRIVATE(o) (((CamelFolderSearch *)(o))->priv)
68 static ESExpResult *search_not(struct _ESExp *f, int argc, struct _ESExpResult **argv, CamelFolderSearch *search);
70 static ESExpResult *search_header_contains(struct _ESExp *f, int argc, struct _ESExpResult **argv, CamelFolderSearch *search);
71 static ESExpResult *search_header_matches(struct _ESExp *f, int argc, struct _ESExpResult **argv, CamelFolderSearch *search);
72 static ESExpResult *search_header_starts_with(struct _ESExp *f, int argc, struct _ESExpResult **argv, CamelFolderSearch *search);
73 static ESExpResult *search_header_ends_with(struct _ESExp *f, int argc, struct _ESExpResult **argv, CamelFolderSearch *search);
74 static ESExpResult *search_header_exists(struct _ESExp *f, int argc, struct _ESExpResult **argv, CamelFolderSearch *search);
75 static ESExpResult *search_match_all(struct _ESExp *f, int argc, struct _ESExpTerm **argv, CamelFolderSearch *search);
76 static ESExpResult *search_match_threads(struct _ESExp *f, int argc, struct _ESExpTerm **argv, CamelFolderSearch *s);
77 static ESExpResult *search_body_contains(struct _ESExp *f, int argc, struct _ESExpResult **argv, CamelFolderSearch *search);
78 static ESExpResult *search_user_flag(struct _ESExp *f, int argc, struct _ESExpResult **argv, CamelFolderSearch *s);
79 static ESExpResult *search_user_tag(struct _ESExp *f, int argc, struct _ESExpResult **argv, CamelFolderSearch *s);
80 static ESExpResult *search_system_flag(struct _ESExp *f, int argc, struct _ESExpResult **argv, CamelFolderSearch *s);
81 static ESExpResult *search_get_sent_date(struct _ESExp *f, int argc, struct _ESExpResult **argv, CamelFolderSearch *s);
82 static ESExpResult *search_get_received_date(struct _ESExp *f, int argc, struct _ESExpResult **argv, CamelFolderSearch *s);
83 static ESExpResult *search_get_current_date(struct _ESExp *f, int argc, struct _ESExpResult **argv, CamelFolderSearch *s);
84 static ESExpResult *search_get_size(struct _ESExp *f, int argc, struct _ESExpResult **argv, CamelFolderSearch *s);
85 static ESExpResult *search_uid(struct _ESExp *f, int argc, struct _ESExpResult **argv, CamelFolderSearch *s);
87 static ESExpResult *search_dummy(struct _ESExp *f, int argc, struct _ESExpResult **argv, CamelFolderSearch *search);
89 static void camel_folder_search_class_init (CamelFolderSearchClass *klass);
90 static void camel_folder_search_init (CamelFolderSearch *obj);
91 static void camel_folder_search_finalize (CamelObject *obj);
93 static int read_uid_callback (void * ref, int ncol, char ** cols, char **name);
95 static CamelObjectClass *camel_folder_search_parent;
98 camel_folder_search_class_init (CamelFolderSearchClass *klass)
100 camel_folder_search_parent = camel_type_get_global_classfuncs (camel_object_get_type ());
102 klass->not = search_not;
104 klass->match_all = search_match_all;
105 klass->match_threads = search_match_threads;
106 klass->body_contains = search_body_contains;
107 klass->header_contains = search_header_contains;
108 klass->header_matches = search_header_matches;
109 klass->header_starts_with = search_header_starts_with;
110 klass->header_ends_with = search_header_ends_with;
111 klass->header_exists = search_header_exists;
112 klass->user_tag = search_user_tag;
113 klass->user_flag = search_user_flag;
114 klass->system_flag = search_system_flag;
115 klass->get_sent_date = search_get_sent_date;
116 klass->get_received_date = search_get_received_date;
117 klass->get_current_date = search_get_current_date;
118 klass->get_size = search_get_size;
119 klass->uid = search_uid;
123 camel_folder_search_init (CamelFolderSearch *obj)
125 struct _CamelFolderSearchPrivate *p;
127 p = _PRIVATE(obj) = g_malloc0(sizeof(*p));
129 obj->sexp = e_sexp_new();
133 camel_folder_search_finalize (CamelObject *obj)
135 CamelFolderSearch *search = (CamelFolderSearch *)obj;
136 struct _CamelFolderSearchPrivate *p = _PRIVATE(obj);
139 e_sexp_unref(search->sexp);
141 g_free(search->last_search);
146 camel_folder_search_get_type (void)
148 static CamelType type = CAMEL_INVALID_TYPE;
150 if (type == CAMEL_INVALID_TYPE) {
151 type = camel_type_register (camel_object_get_type (), "CamelFolderSearch",
152 sizeof (CamelFolderSearch),
153 sizeof (CamelFolderSearchClass),
154 (CamelObjectClassInitFunc) camel_folder_search_class_init,
156 (CamelObjectInitFunc) camel_folder_search_init,
157 (CamelObjectFinalizeFunc) camel_folder_search_finalize);
164 #define CAMEL_STRUCT_OFFSET(type, field) ((gint) offsetof (type, field))
166 #define CAMEL_STRUCT_OFFSET(type, field) ((gint) ((gchar*) &((type *) 0)->field))
172 int flags; /* 0x02 = immediate, 0x01 = always enter */
174 /* these have default implementations in e-sexp */
175 { "and", CAMEL_STRUCT_OFFSET(CamelFolderSearchClass, and), 2 },
176 { "or", CAMEL_STRUCT_OFFSET(CamelFolderSearchClass, or), 2 },
177 /* we need to override this one though to implement an 'array not' */
178 { "not", CAMEL_STRUCT_OFFSET(CamelFolderSearchClass, not), 0 },
179 { "<", CAMEL_STRUCT_OFFSET(CamelFolderSearchClass, lt), 2 },
180 { ">", CAMEL_STRUCT_OFFSET(CamelFolderSearchClass, gt), 2 },
181 { "=", CAMEL_STRUCT_OFFSET(CamelFolderSearchClass, eq), 2 },
183 /* these we have to use our own default if there is none */
184 /* they should all be defined in the language? so it parses, or should they not?? */
185 { "match-all", CAMEL_STRUCT_OFFSET(CamelFolderSearchClass, match_all), 3 },
186 { "match-threads", CAMEL_STRUCT_OFFSET(CamelFolderSearchClass, match_threads), 3 },
187 { "body-contains", CAMEL_STRUCT_OFFSET(CamelFolderSearchClass, body_contains), 1 },
188 { "header-contains", CAMEL_STRUCT_OFFSET(CamelFolderSearchClass, header_contains), 1 },
189 { "header-matches", CAMEL_STRUCT_OFFSET(CamelFolderSearchClass, header_matches), 1 },
190 { "header-starts-with", CAMEL_STRUCT_OFFSET(CamelFolderSearchClass, header_starts_with), 1 },
191 { "header-ends-with", CAMEL_STRUCT_OFFSET(CamelFolderSearchClass, header_ends_with), 1 },
192 { "header-exists", CAMEL_STRUCT_OFFSET(CamelFolderSearchClass, header_exists), 1 },
193 { "user-tag", CAMEL_STRUCT_OFFSET(CamelFolderSearchClass, user_tag), 1 },
194 { "user-flag", CAMEL_STRUCT_OFFSET(CamelFolderSearchClass, user_flag), 1 },
195 { "system-flag", CAMEL_STRUCT_OFFSET(CamelFolderSearchClass, system_flag), 1 },
196 { "get-sent-date", CAMEL_STRUCT_OFFSET(CamelFolderSearchClass, get_sent_date), 1 },
197 { "get-received-date", CAMEL_STRUCT_OFFSET(CamelFolderSearchClass, get_received_date), 1 },
198 { "get-current-date", CAMEL_STRUCT_OFFSET(CamelFolderSearchClass, get_current_date), 1 },
199 { "get-size", CAMEL_STRUCT_OFFSET(CamelFolderSearchClass, get_size), 1 },
200 { "uid", CAMEL_STRUCT_OFFSET(CamelFolderSearchClass, uid), 1 },
204 camel_folder_search_construct (CamelFolderSearch *search)
207 CamelFolderSearchClass *klass = (CamelFolderSearchClass *)CAMEL_OBJECT_GET_CLASS(search);
209 for (i=0;i<sizeof(builtins)/sizeof(builtins[0]);i++) {
211 /* c is sure messy sometimes */
212 func = *((void **)(((char *)klass)+builtins[i].offset));
213 if (func == NULL && builtins[i].flags&1) {
214 g_warning("Search class doesn't implement '%s' method: %s", builtins[i].name, camel_type_to_name(CAMEL_OBJECT_GET_CLASS(search)));
215 func = (void *)search_dummy;
218 if (builtins[i].flags&2) {
219 e_sexp_add_ifunction(search->sexp, 0, builtins[i].name, (ESExpIFunc *)func, search);
221 e_sexp_add_function(search->sexp, 0, builtins[i].name, (ESExpFunc *)func, search);
228 * camel_folder_search_new:
230 * Create a new CamelFolderSearch object.
232 * A CamelFolderSearch is a subclassable, extensible s-exp
233 * evaluator which enforces a particular set of s-expressions.
234 * Particular methods may be overriden by an implementation to
235 * implement a search for any sort of backend.
237 * Return value: A new CamelFolderSearch widget.
240 camel_folder_search_new (void)
242 CamelFolderSearch *new = CAMEL_FOLDER_SEARCH (camel_object_new (camel_folder_search_get_type ()));
244 camel_folder_search_construct(new);
249 * camel_folder_search_set_folder:
253 * Set the folder attribute of the search. This is currently unused, but
254 * could be used to perform a slow-search when indexes and so forth are not
255 * available. Or for use by subclasses.
258 camel_folder_search_set_folder(CamelFolderSearch *search, CamelFolder *folder)
260 search->folder = folder;
264 * camel_folder_search_set_summary:
266 * @summary: An array of CamelMessageInfo pointers.
268 * Set the array of summary objects representing the span of the search.
270 * If this is not set, then a subclass must provide the functions
271 * for searching headers and for the match-all operator.
274 camel_folder_search_set_summary(CamelFolderSearch *search, GPtrArray *summary)
276 search->summary = summary;
280 * camel_folder_search_set_body_index:
284 * Set the index representing the contents of all messages
285 * in this folder. If this is not set, then the folder implementation
286 * should sub-class the CamelFolderSearch and provide its own
287 * body-contains function.
290 camel_folder_search_set_body_index(CamelFolderSearch *search, CamelIndex *index)
292 if (search->body_index)
293 camel_object_unref((CamelObject *)search->body_index);
294 search->body_index = index;
296 camel_object_ref((CamelObject *)index);
300 * camel_folder_search_execute_expression:
305 * Execute the search expression @expr, returning an array of
306 * all matches as a GPtrArray of uid's of matching messages.
308 * Note that any settings such as set_body_index(), set_folder(),
309 * and so on are reset to #NULL once the search has completed.
311 * TODO: The interface should probably return summary items instead
312 * (since they are much more useful to any client).
314 * Return value: A GPtrArray of strings of all matching messages.
315 * This must only be freed by camel_folder_search_free_result.
318 camel_folder_search_execute_expression(CamelFolderSearch *search, const char *expr, CamelException *ex)
324 struct _CamelFolderSearchPrivate *p = _PRIVATE(search);
328 /* only re-parse if the search has changed */
329 if (search->last_search == NULL
330 || strcmp(search->last_search, expr)) {
331 e_sexp_input_text(search->sexp, expr, strlen(expr));
332 if (e_sexp_parse(search->sexp) == -1) {
333 camel_exception_setv(ex, 1, _("Cannot parse search expression: %s:\n%s"), e_sexp_error(search->sexp), expr);
337 g_free(search->last_search);
338 search->last_search = g_strdup(expr);
340 r = e_sexp_eval(search->sexp);
342 if (!camel_exception_is_set(ex))
343 camel_exception_setv(ex, 1, _("Error executing search expression: %s:\n%s"), e_sexp_error(search->sexp), expr);
347 matches = g_ptr_array_new();
349 /* now create a folder summary to return?? */
350 if (r->type == ESEXP_RES_ARRAY_PTR) {
351 d(printf("got result ...\n"));
352 if (search->summary) {
353 /* reorder result in summary order */
354 results = g_hash_table_new(g_str_hash, g_str_equal);
355 for (i=0;i<r->value.ptrarray->len;i++) {
356 d(printf("adding match: %s\n", (char *)g_ptr_array_index(r->value.ptrarray, i)));
357 g_hash_table_insert(results, g_ptr_array_index(r->value.ptrarray, i), GINT_TO_POINTER (1));
359 for (i=0;i<search->summary->len;i++) {
360 char *uid = g_ptr_array_index(search->summary, i);
361 if (g_hash_table_lookup(results, uid)) {
362 g_ptr_array_add(matches, (gpointer) camel_pstring_strdup(uid));
365 g_hash_table_destroy(results);
367 for (i=0;i<r->value.ptrarray->len;i++) {
368 d(printf("adding match: %s\n", (char *)g_ptr_array_index(r->value.ptrarray, i)));
369 g_ptr_array_add(matches, (gpointer) camel_pstring_strdup(g_ptr_array_index(r->value.ptrarray, i)));
373 g_warning("Search returned an invalid result type");
376 e_sexp_result_free(search->sexp, r);
379 camel_folder_thread_messages_unref(p->threads);
381 g_hash_table_destroy(p->threads_hash);
384 p->threads_hash = NULL;
385 search->folder = NULL;
386 search->summary = NULL;
387 search->current = NULL;
388 search->body_index = NULL;
394 * camel_folder_search_search:
397 * @uids: to search against, NULL for all uid's.
400 * Run a search. Search must have had Folder already set on it, and
401 * it must implement summaries.
406 camel_folder_search_search(CamelFolderSearch *search, const char *expr, GPtrArray *uids, CamelException *ex)
409 GPtrArray *matches = NULL, *summary_set;
412 char *sql_query, *tmp, *tmp1;
415 struct _CamelFolderSearchPrivate *p = _PRIVATE(search);
417 g_assert(search->folder);
421 /* We route body-contains search and uid search through memory and not via db. */
422 if (uids || strstr((const char *) expr, "body-contains")) {
423 /* setup our search list only contains those we're interested in */
424 search->summary = camel_folder_get_summary(search->folder);
427 GHashTable *uids_hash = g_hash_table_new(g_str_hash, g_str_equal);
429 summary_set = search->summary_set = g_ptr_array_new();
430 for (i=0;i<uids->len;i++)
431 g_hash_table_insert(uids_hash, uids->pdata[i], uids->pdata[i]);
432 for (i=0;i<search->summary->len;i++)
433 if (g_hash_table_lookup(uids_hash, search->summary->pdata[i]))
434 g_ptr_array_add(search->summary_set, search->summary->pdata[i]);
435 g_hash_table_destroy(uids_hash);
437 summary_set = search->summary;
440 /* only re-parse if the search has changed */
441 if (search->last_search == NULL
442 || strcmp(search->last_search, expr)) {
443 e_sexp_input_text(search->sexp, expr, strlen(expr));
444 if (e_sexp_parse(search->sexp) == -1) {
445 camel_exception_setv(ex, 1, _("Cannot parse search expression: %s:\n%s"), e_sexp_error(search->sexp), expr);
449 g_free(search->last_search);
450 search->last_search = g_strdup(expr);
452 r = e_sexp_eval(search->sexp);
454 if (!camel_exception_is_set(ex))
455 camel_exception_setv(ex, 1, _("Error executing search expression: %s:\n%s"), e_sexp_error(search->sexp), expr);
459 matches = g_ptr_array_new();
461 /* now create a folder summary to return?? */
462 if (r->type == ESEXP_RES_ARRAY_PTR) {
463 d(printf("got result\n"));
465 /* reorder result in summary order */
466 results = g_hash_table_new(g_str_hash, g_str_equal);
467 for (i=0;i<r->value.ptrarray->len;i++) {
468 d(printf("adding match: %s\n", (char *)g_ptr_array_index(r->value.ptrarray, i)));
469 g_hash_table_insert(results, g_ptr_array_index(r->value.ptrarray, i), GINT_TO_POINTER (1));
472 for (i=0;i<summary_set->len;i++) {
473 char *uid = g_ptr_array_index(summary_set, i);
474 if (g_hash_table_lookup(results, uid))
475 g_ptr_array_add(matches, (gpointer) camel_pstring_strdup(uid));
477 g_hash_table_destroy(results);
480 e_sexp_result_free(search->sexp, r);
483 /* Sync the db, so that we search the db for changes */
484 camel_folder_summary_save_to_db (search->folder->summary, ex);
486 d(printf ("sexp is : [%s]\n", expr));
487 if (g_getenv("SQL_SEARCH_OLD"))
488 sql_query = camel_sexp_to_sql (expr);
490 sql_query = camel_sexp_to_sql_sexp (expr);
491 tmp1 = camel_db_sqlize_string(search->folder->full_name);
492 tmp = g_strdup_printf ("SELECT uid FROM %s %s %s", tmp1, sql_query ? "WHERE":"", sql_query?sql_query:"");
493 camel_db_free_sqlized_string (tmp1);
495 d(printf("Equivalent sql %s\n", tmp));
497 matches = g_ptr_array_new();
498 cdb = (CamelDB *) (search->folder->cdb);
499 camel_db_select (cdb, tmp, (CamelDBSelectCB) read_uid_callback, matches, ex);
500 if (ex && camel_exception_is_set(ex)) {
501 const char *exception = camel_exception_get_description (ex);
502 if (strncmp(exception, "no such table", 13) == 0) {
503 g_warning ("Error during searching %s: %s\n", tmp, exception);
504 camel_exception_clear (ex); /* Suppress no such table */
512 /* these might be allocated by match-threads */
514 camel_folder_thread_messages_unref(p->threads);
516 g_hash_table_destroy(p->threads_hash);
517 if (search->summary_set)
518 g_ptr_array_free(search->summary_set, TRUE);
520 camel_folder_free_summary(search->folder, search->summary);
523 p->threads_hash = NULL;
524 search->folder = NULL;
525 search->summary = NULL;
526 search->summary_set = NULL;
527 search->current = NULL;
528 search->body_index = NULL;
533 void camel_folder_search_free_result(CamelFolderSearch *search, GPtrArray *result)
535 g_ptr_array_foreach (result, (GFunc) camel_pstring_free, NULL);
536 g_ptr_array_free(result, TRUE);
539 /* dummy function, returns false always, or an empty match array */
541 search_dummy(struct _ESExp *f, int argc, struct _ESExpResult **argv, CamelFolderSearch *search)
545 if (search->current == NULL) {
546 r = e_sexp_result_new(f, ESEXP_RES_BOOL);
547 r->value.bool = FALSE;
549 r = e_sexp_result_new(f, ESEXP_RES_ARRAY_PTR);
550 r->value.ptrarray = g_ptr_array_new();
556 /* impelemnt an 'array not', i.e. everything in the summary, not in the supplied array */
558 search_not(struct _ESExp *f, int argc, struct _ESExpResult **argv, CamelFolderSearch *search)
564 if (argv[0]->type == ESEXP_RES_ARRAY_PTR) {
565 GPtrArray *v = argv[0]->value.ptrarray;
568 r = e_sexp_result_new(f, ESEXP_RES_ARRAY_PTR);
569 r->value.ptrarray = g_ptr_array_new();
571 /* not against a single message?*/
572 if (search->current) {
575 uid = camel_message_info_uid(search->current);
576 for (i=0;!found && i<v->len;i++) {
577 if (strcmp(uid, v->pdata[i]) == 0)
582 g_ptr_array_add(r->value.ptrarray, (char *)uid);
583 } else if (search->summary == NULL) {
584 g_warning("No summary set, 'not' against an array requires a summary");
586 /* 'not' against the whole summary */
587 GHashTable *have = g_hash_table_new(g_str_hash, g_str_equal);
591 s = (char **)v->pdata;
592 for (i=0;i<v->len;i++)
593 g_hash_table_insert(have, s[i], s[i]);
595 v = search->summary_set?search->summary_set:search->summary;
596 m = (char **)v->pdata;
597 for (i=0;i<v->len;i++) {
600 if (g_hash_table_lookup(have, uid) == NULL)
601 g_ptr_array_add(r->value.ptrarray, uid);
603 g_hash_table_destroy(have);
608 if (argv[0]->type == ESEXP_RES_BOOL)
609 res = ! argv[0]->value.bool;
611 r = e_sexp_result_new(f, ESEXP_RES_BOOL);
615 r = e_sexp_result_new(f, ESEXP_RES_BOOL);
616 r->value.bool = TRUE;
623 search_match_all(struct _ESExp *f, int argc, struct _ESExpTerm **argv, CamelFolderSearch *search)
631 g_warning("match-all only takes a single argument, other arguments ignored");
634 /* we are only matching a single message? or already inside a match-all? */
635 if (search->current) {
636 d(printf("matching against 1 message: %s\n", camel_message_info_subject(search->current)));
638 r = e_sexp_result_new(f, ESEXP_RES_BOOL);
639 r->value.bool = FALSE;
642 r1 = e_sexp_term_eval(f, argv[0]);
643 if (r1->type == ESEXP_RES_BOOL) {
644 r->value.bool = r1->value.bool;
646 g_warning("invalid syntax, matches require a single bool result");
647 error_msg = g_strdup_printf(_("(%s) requires a single bool result"), "match-all");
648 e_sexp_fatal_error(f, error_msg);
651 e_sexp_result_free(f, r1);
653 r->value.bool = TRUE;
658 r = e_sexp_result_new(f, ESEXP_RES_ARRAY_PTR);
659 r->value.ptrarray = g_ptr_array_new();
661 if (search->summary == NULL) {
662 /* TODO: make it work - e.g. use the folder and so forth for a slower search */
663 g_warning("No summary supplied, match-all doesn't work with no summary");
668 v = search->summary_set?search->summary_set:search->summary;
670 if (v->len > g_hash_table_size (search->folder->summary->loaded_infos) && !CAMEL_IS_VEE_FOLDER (search->folder)) {
671 camel_folder_summary_reload_from_db (search->folder->summary, search->priv->ex);
674 e_sexp_term_eval (f, argv [0]);
676 for (i=0;i<v->len;i++) {
679 search->current = camel_folder_summary_uid (search->folder->summary, v->pdata[i]);
680 if (!search->current)
682 uid = camel_message_info_uid(search->current);
685 r1 = e_sexp_term_eval(f, argv[0]);
686 if (r1->type == ESEXP_RES_BOOL) {
688 g_ptr_array_add(r->value.ptrarray, (char *)uid);
690 g_warning("invalid syntax, matches require a single bool result");
691 error_msg = g_strdup_printf(_("(%s) requires a single bool result"), "match-all");
692 e_sexp_fatal_error(f, error_msg);
695 e_sexp_result_free(f, r1);
697 g_ptr_array_add(r->value.ptrarray, (char *)uid);
699 camel_message_info_free (search->current);
701 search->current = NULL;
706 fill_thread_table(struct _CamelFolderThreadNode *root, GHashTable *id_hash)
709 g_hash_table_insert(id_hash, (char *)camel_message_info_uid(root->message), root);
711 fill_thread_table(root->child, id_hash);
717 add_thread_results(struct _CamelFolderThreadNode *root, GHashTable *result_hash)
720 g_hash_table_insert(result_hash, (char *)camel_message_info_uid(root->message), GINT_TO_POINTER (1));
722 add_thread_results(root->child, result_hash);
728 add_results(char *uid, void *dummy, GPtrArray *result)
730 g_ptr_array_add(result, uid);
734 search_match_threads(struct _ESExp *f, int argc, struct _ESExpTerm **argv, CamelFolderSearch *search)
737 struct _CamelFolderSearchPrivate *p = search->priv;
742 /* not supported in match-all */
743 if (search->current) {
744 error_msg = g_strdup_printf(_("(%s) not allowed inside %s"), "match-threads", "match-all");
745 e_sexp_fatal_error(f, error_msg);
750 error_msg = g_strdup_printf(_("(%s) requires a match type string"), "match-threads");
751 e_sexp_fatal_error(f, error_msg);
755 r = e_sexp_term_eval(f, argv[0]);
756 if (r->type != ESEXP_RES_STRING) {
757 error_msg = g_strdup_printf(_("(%s) requires a match type string"), "match-threads");
758 e_sexp_fatal_error(f, error_msg);
763 if (!strcmp(r->value.string, "none"))
765 else if (!strcmp(r->value.string, "all"))
767 else if (!strcmp(r->value.string, "replies"))
769 else if (!strcmp(r->value.string, "replies_parents"))
771 else if (!strcmp(r->value.string, "single"))
773 e_sexp_result_free(f, r);
775 /* behave as (begin does */
777 for (i=1;i<argc;i++) {
779 e_sexp_result_free(f, r);
780 r = e_sexp_term_eval(f, argv[i]);
783 if (r == NULL || r->type != ESEXP_RES_ARRAY_PTR) {
784 error_msg = g_strdup_printf(_("(%s) expects an array result"), "match-threads");
785 e_sexp_fatal_error(f, error_msg);
792 if (search->folder == NULL) {
793 error_msg = g_strdup_printf(_("(%s) requires the folder set"), "match-threads");
794 e_sexp_fatal_error(f, error_msg);
798 /* cache this, so we only have to re-calculate once per search at most */
799 if (p->threads == NULL) {
800 p->threads = camel_folder_thread_messages_new(search->folder, NULL, TRUE);
801 p->threads_hash = g_hash_table_new(g_str_hash, g_str_equal);
803 fill_thread_table(p->threads->tree, p->threads_hash);
806 results = g_hash_table_new(g_str_hash, g_str_equal);
807 for (i=0;i<r->value.ptrarray->len;i++) {
808 struct _CamelFolderThreadNode *node, *scan;
811 g_hash_table_insert(results, g_ptr_array_index(r->value.ptrarray, i), GINT_TO_POINTER(1));
813 node = g_hash_table_lookup(p->threads_hash, (char *)g_ptr_array_index(r->value.ptrarray, i));
814 if (node == NULL) /* this shouldn't happen but why cry over spilt milk */
817 /* select messages in thread according to search criteria */
819 if (node->child == NULL && node->parent == NULL)
820 g_hash_table_insert(results, (char *)camel_message_info_uid(node->message), GINT_TO_POINTER(1));
824 while (scan && scan->parent) {
826 g_hash_table_insert(results, (char *)camel_message_info_uid(scan->message), GINT_TO_POINTER(1));
828 } else if (type == 1) {
829 while (node && node->parent)
832 g_hash_table_insert(results, (char *)camel_message_info_uid(node->message), GINT_TO_POINTER(1));
834 add_thread_results(node->child, results);
837 e_sexp_result_free(f, r);
839 r = e_sexp_result_new(f, ESEXP_RES_ARRAY_PTR);
840 r->value.ptrarray = g_ptr_array_new();
842 g_hash_table_foreach(results, (GHFunc)add_results, r->value.ptrarray);
843 g_hash_table_destroy(results);
849 check_header (struct _ESExp *f, int argc, struct _ESExpResult **argv, CamelFolderSearch *search, camel_search_match_t how)
854 r(printf("executing check-header %d\n", how));
856 /* are we inside a match-all? */
857 if (search->current && argc>1
858 && argv[0]->type == ESEXP_RES_STRING) {
860 const char *header = NULL;
863 camel_search_t type = CAMEL_SEARCH_TYPE_ASIS;
864 struct _camel_search_words *words;
866 /* only a subset of headers are supported .. */
867 headername = argv[0]->value.string;
868 if (!g_ascii_strcasecmp(headername, "subject")) {
869 header = camel_message_info_subject(search->current);
870 } else if (!g_ascii_strcasecmp(headername, "date")) {
871 /* FIXME: not a very useful form of the date */
872 sprintf(strbuf, "%d", (int)camel_message_info_date_sent(search->current));
874 } else if (!g_ascii_strcasecmp(headername, "from")) {
875 header = camel_message_info_from(search->current);
876 type = CAMEL_SEARCH_TYPE_ADDRESS;
877 } else if (!g_ascii_strcasecmp(headername, "to")) {
878 header = camel_message_info_to(search->current);
879 type = CAMEL_SEARCH_TYPE_ADDRESS;
880 } else if (!g_ascii_strcasecmp(headername, "cc")) {
881 header = camel_message_info_cc(search->current);
882 type = CAMEL_SEARCH_TYPE_ADDRESS;
883 } else if (!g_ascii_strcasecmp(headername, "x-camel-mlist")) {
884 header = camel_message_info_mlist(search->current);
885 type = CAMEL_SEARCH_TYPE_MLIST;
887 e_sexp_resultv_free(f, argc, argv);
888 e_sexp_fatal_error(f, _("Performing query on unknown header: %s"), headername);
894 /* performs an OR of all words */
895 for (i=1;i<argc && !truth;i++) {
896 if (argv[i]->type == ESEXP_RES_STRING) {
897 if (argv[i]->value.string[0] == 0) {
899 } else if (how == CAMEL_SEARCH_MATCH_CONTAINS) {
900 /* doesn't make sense to split words on anything but contains i.e. we can't have an ending match different words */
901 words = camel_search_words_split((const unsigned char *) argv[i]->value.string);
903 for (j=0;j<words->len && truth;j++) {
904 truth = camel_search_header_match(header, words->words[j]->word, how, type, NULL);
906 camel_search_words_free(words);
908 truth = camel_search_header_match(header, argv[i]->value.string, how, type, NULL);
913 /* TODO: else, find all matches */
915 r = e_sexp_result_new(f, ESEXP_RES_BOOL);
916 r->value.bool = truth;
925 printf("%s\t", node);
930 search_header_contains(struct _ESExp *f, int argc, struct _ESExpResult **argv, CamelFolderSearch *search)
932 return check_header(f, argc, argv, search, CAMEL_SEARCH_MATCH_CONTAINS);
936 search_header_matches(struct _ESExp *f, int argc, struct _ESExpResult **argv, CamelFolderSearch *search)
938 return check_header(f, argc, argv, search, CAMEL_SEARCH_MATCH_EXACT);
942 search_header_starts_with (struct _ESExp *f, int argc, struct _ESExpResult **argv, CamelFolderSearch *search)
944 return check_header(f, argc, argv, search, CAMEL_SEARCH_MATCH_STARTS);
948 search_header_ends_with (struct _ESExp *f, int argc, struct _ESExpResult **argv, CamelFolderSearch *search)
950 return check_header(f, argc, argv, search, CAMEL_SEARCH_MATCH_ENDS);
954 search_header_exists (struct _ESExp *f, int argc, struct _ESExpResult **argv, CamelFolderSearch *search)
958 r(printf ("executing header-exists\n"));
960 if (search->current) {
961 r = e_sexp_result_new(f, ESEXP_RES_BOOL);
962 if (argc == 1 && argv[0]->type == ESEXP_RES_STRING)
963 r->value.bool = camel_medium_get_header(CAMEL_MEDIUM(search->current), argv[0]->value.string) != NULL;
966 r = e_sexp_result_new(f, ESEXP_RES_ARRAY_PTR);
967 r->value.ptrarray = g_ptr_array_new();
973 /* this is just to OR results together */
974 struct _glib_sux_donkeys {
979 /* or, store all unique values */
981 g_lib_sux_htor(char *key, int value, struct _glib_sux_donkeys *fuckup)
983 g_ptr_array_add(fuckup->uids, key);
986 /* and, only store duplicates */
988 g_lib_sux_htand(char *key, int value, struct _glib_sux_donkeys *fuckup)
990 if (value == fuckup->count)
991 g_ptr_array_add(fuckup->uids, key);
995 match_message_index(CamelIndex *idx, const char *uid, const char *match, CamelException *ex)
997 CamelIndexCursor *wc, *nc;
998 const char *word, *name;
1001 wc = camel_index_words(idx);
1003 while (!truth && (word = camel_index_cursor_next(wc))) {
1004 if (camel_ustrstrcase(word,match) != NULL) {
1005 /* perf: could have the wc cursor return the name cursor */
1006 nc = camel_index_find(idx, word);
1008 while (!truth && (name = camel_index_cursor_next(nc)))
1009 truth = strcmp(name, uid) == 0;
1010 camel_object_unref((CamelObject *)nc);
1014 camel_object_unref((CamelObject *)wc);
1021 "one two" "three" "four five"
1030 /* returns messages which contain all words listed in words */
1032 match_words_index(CamelFolderSearch *search, struct _camel_search_words *words, CamelException *ex)
1034 GPtrArray *result = g_ptr_array_new();
1035 GHashTable *ht = g_hash_table_new(g_str_hash, g_str_equal);
1036 struct _glib_sux_donkeys lambdafoo;
1037 CamelIndexCursor *wc, *nc;
1038 const char *word, *name;
1041 /* we can have a maximum of 32 words, as we use it as the AND mask */
1043 wc = camel_index_words(search->body_index);
1045 while ((word = camel_index_cursor_next(wc))) {
1046 for (i=0;i<words->len;i++) {
1047 if (camel_ustrstrcase(word, words->words[i]->word) != NULL) {
1048 /* perf: could have the wc cursor return the name cursor */
1049 nc = camel_index_find(search->body_index, word);
1051 while ((name = camel_index_cursor_next(nc))) {
1054 mask = (GPOINTER_TO_INT(g_hash_table_lookup(ht, name))) | (1<<i);
1055 g_hash_table_insert(ht, (char *) camel_pstring_peek(name), GINT_TO_POINTER(mask));
1057 camel_object_unref((CamelObject *)nc);
1062 camel_object_unref((CamelObject *)wc);
1064 lambdafoo.uids = result;
1065 lambdafoo.count = (1<<words->len) - 1;
1066 g_hash_table_foreach(ht, (GHFunc)g_lib_sux_htand, &lambdafoo);
1067 g_hash_table_destroy(ht);
1074 match_words_1message (CamelDataWrapper *object, struct _camel_search_words *words, guint32 *mask)
1076 CamelDataWrapper *containee;
1080 containee = camel_medium_get_content_object (CAMEL_MEDIUM (object));
1082 if (containee == NULL)
1085 /* using the object types is more accurate than using the mime/types */
1086 if (CAMEL_IS_MULTIPART (containee)) {
1087 parts = camel_multipart_get_number (CAMEL_MULTIPART (containee));
1088 for (i = 0; i < parts && truth == FALSE; i++) {
1089 CamelDataWrapper *part = (CamelDataWrapper *)camel_multipart_get_part (CAMEL_MULTIPART (containee), i);
1091 truth = match_words_1message(part, words, mask);
1093 } else if (CAMEL_IS_MIME_MESSAGE (containee)) {
1094 /* for messages we only look at its contents */
1095 truth = match_words_1message((CamelDataWrapper *)containee, words, mask);
1096 } else if (camel_content_type_is(CAMEL_DATA_WRAPPER (containee)->mime_type, "text", "*")) {
1097 /* for all other text parts, we look inside, otherwise we dont care */
1098 CamelStreamMem *mem = (CamelStreamMem *)camel_stream_mem_new ();
1100 /* FIXME: The match should be part of a stream op */
1101 camel_data_wrapper_decode_to_stream (containee, CAMEL_STREAM (mem));
1102 camel_stream_write (CAMEL_STREAM (mem), "", 1);
1103 for (i=0;i<words->len;i++) {
1104 /* FIXME: This is horridly slow, and should use a real search algorithm */
1105 if (camel_ustrstrcase((const char *) mem->buffer->data, words->words[i]->word) != NULL) {
1107 /* shortcut a match */
1108 if (*mask == (1<<(words->len))-1)
1113 camel_object_unref (mem);
1120 match_words_message(CamelFolder *folder, const char *uid, struct _camel_search_words *words, CamelException *ex)
1123 CamelMimeMessage *msg;
1124 CamelException x = CAMEL_EXCEPTION_INITIALISER;
1127 msg = camel_folder_get_message(folder, uid, &x);
1130 truth = match_words_1message((CamelDataWrapper *)msg, words, &mask);
1131 camel_object_unref((CamelObject *)msg);
1133 camel_exception_clear(&x);
1141 match_words_messages(CamelFolderSearch *search, struct _camel_search_words *words, CamelException *ex)
1144 GPtrArray *matches = g_ptr_array_new();
1146 if (search->body_index) {
1148 struct _camel_search_words *simple;
1150 simple = camel_search_words_simple(words);
1151 indexed = match_words_index(search, simple, ex);
1152 camel_search_words_free(simple);
1154 for (i=0;i<indexed->len;i++) {
1155 const char *uid = g_ptr_array_index(indexed, i);
1157 if (match_words_message(search->folder, uid, words, ex))
1158 g_ptr_array_add(matches, (char *)uid);
1161 g_ptr_array_free(indexed, TRUE);
1163 GPtrArray *v = search->summary_set?search->summary_set:search->summary;
1165 for (i=0;i<v->len;i++) {
1166 char *uid = g_ptr_array_index(v, i);
1168 if (match_words_message(search->folder, uid, words, ex))
1169 g_ptr_array_add(matches, (char *)uid);
1176 static ESExpResult *
1177 search_body_contains(struct _ESExp *f, int argc, struct _ESExpResult **argv, CamelFolderSearch *search)
1180 CamelException *ex = search->priv->ex;
1181 struct _camel_search_words *words;
1183 struct _glib_sux_donkeys lambdafoo;
1185 if (search->current) {
1188 if (argc == 1 && argv[0]->value.string[0] == 0) {
1191 for (i=0;i<argc && !truth;i++) {
1192 if (argv[i]->type == ESEXP_RES_STRING) {
1193 words = camel_search_words_split((const unsigned char *) argv[i]->value.string);
1195 if ((words->type & CAMEL_SEARCH_WORD_COMPLEX) == 0 && search->body_index) {
1196 for (j=0;j<words->len && truth;j++)
1197 truth = match_message_index(search->body_index, camel_message_info_uid(search->current), words->words[j]->word, ex);
1199 /* TODO: cache current message incase of multiple body search terms */
1200 truth = match_words_message(search->folder, camel_message_info_uid(search->current), words, ex);
1202 camel_search_words_free(words);
1206 r = e_sexp_result_new(f, ESEXP_RES_BOOL);
1207 r->value.bool = truth;
1209 r = e_sexp_result_new(f, ESEXP_RES_ARRAY_PTR);
1210 r->value.ptrarray = g_ptr_array_new();
1212 if (argc == 1 && argv[0]->value.string[0] == 0) {
1213 GPtrArray *v = search->summary_set?search->summary_set:search->summary;
1215 for (i=0;i<v->len;i++) {
1216 char *uid = g_ptr_array_index(v, i);
1218 g_ptr_array_add(r->value.ptrarray, uid);
1221 GHashTable *ht = g_hash_table_new(g_str_hash, g_str_equal);
1224 for (i=0;i<argc;i++) {
1225 if (argv[i]->type == ESEXP_RES_STRING) {
1226 words = camel_search_words_split((const unsigned char *) argv[i]->value.string);
1227 if ((words->type & CAMEL_SEARCH_WORD_COMPLEX) == 0 && search->body_index) {
1228 matches = match_words_index(search, words, ex);
1230 matches = match_words_messages(search, words, ex);
1232 for (j=0;j<matches->len;j++) {
1233 g_hash_table_insert(ht, matches->pdata[j], matches->pdata[j]);
1235 g_ptr_array_free(matches, TRUE);
1236 camel_search_words_free(words);
1239 lambdafoo.uids = r->value.ptrarray;
1240 g_hash_table_foreach(ht, (GHFunc)g_lib_sux_htor, &lambdafoo);
1241 g_hash_table_destroy(ht);
1248 static ESExpResult *
1249 search_user_flag(struct _ESExp *f, int argc, struct _ESExpResult **argv, CamelFolderSearch *search)
1254 r(printf("executing user-flag\n"));
1256 /* are we inside a match-all? */
1257 if (search->current) {
1259 /* performs an OR of all words */
1260 for (i=0;i<argc && !truth;i++) {
1261 if (argv[i]->type == ESEXP_RES_STRING
1262 && camel_message_info_user_flag(search->current, argv[i]->value.string)) {
1267 r = e_sexp_result_new(f, ESEXP_RES_BOOL);
1268 r->value.bool = truth;
1270 r = e_sexp_result_new(f, ESEXP_RES_ARRAY_PTR);
1271 r->value.ptrarray = g_ptr_array_new();
1277 static ESExpResult *
1278 search_system_flag (struct _ESExp *f, int argc, struct _ESExpResult **argv, CamelFolderSearch *search)
1282 r(printf ("executing system-flag\n"));
1284 if (search->current) {
1285 gboolean truth = FALSE;
1288 truth = camel_system_flag_get (camel_message_info_flags(search->current), argv[0]->value.string);
1290 r = e_sexp_result_new(f, ESEXP_RES_BOOL);
1291 r->value.bool = truth;
1293 r = e_sexp_result_new(f, ESEXP_RES_ARRAY_PTR);
1294 r->value.ptrarray = g_ptr_array_new ();
1300 static ESExpResult *
1301 search_user_tag(struct _ESExp *f, int argc, struct _ESExpResult **argv, CamelFolderSearch *search)
1303 const char *value = NULL;
1306 r(printf("executing user-tag\n"));
1308 if (search->current && argc == 1)
1309 value = camel_message_info_user_tag(search->current, argv[0]->value.string);
1311 r = e_sexp_result_new(f, ESEXP_RES_STRING);
1312 r->value.string = g_strdup (value ? value : "");
1317 static ESExpResult *
1318 search_get_sent_date(struct _ESExp *f, int argc, struct _ESExpResult **argv, CamelFolderSearch *s)
1322 r(printf("executing get-sent-date\n"));
1324 /* are we inside a match-all? */
1326 r = e_sexp_result_new(f, ESEXP_RES_INT);
1328 r->value.number = camel_message_info_date_sent(s->current);
1330 r = e_sexp_result_new(f, ESEXP_RES_ARRAY_PTR);
1331 r->value.ptrarray = g_ptr_array_new ();
1337 static ESExpResult *
1338 search_get_received_date(struct _ESExp *f, int argc, struct _ESExpResult **argv, CamelFolderSearch *s)
1342 r(printf("executing get-received-date\n"));
1344 /* are we inside a match-all? */
1346 r = e_sexp_result_new(f, ESEXP_RES_INT);
1348 r->value.number = camel_message_info_date_received(s->current);
1350 r = e_sexp_result_new(f, ESEXP_RES_ARRAY_PTR);
1351 r->value.ptrarray = g_ptr_array_new ();
1357 static ESExpResult *
1358 search_get_current_date(struct _ESExp *f, int argc, struct _ESExpResult **argv, CamelFolderSearch *s)
1362 r(printf("executing get-current-date\n"));
1364 r = e_sexp_result_new(f, ESEXP_RES_INT);
1365 r->value.number = time (NULL);
1369 static ESExpResult *
1370 search_get_size (struct _ESExp *f, int argc, struct _ESExpResult **argv, CamelFolderSearch *s)
1374 r(printf("executing get-size\n"));
1376 /* are we inside a match-all? */
1378 r = e_sexp_result_new (f, ESEXP_RES_INT);
1379 r->value.number = camel_message_info_size(s->current) / 1024;
1381 r = e_sexp_result_new (f, ESEXP_RES_ARRAY_PTR);
1382 r->value.ptrarray = g_ptr_array_new ();
1388 static ESExpResult *
1389 search_uid(struct _ESExp *f, int argc, struct _ESExpResult **argv, CamelFolderSearch *search)
1394 r(printf("executing uid\n"));
1396 /* are we inside a match-all? */
1397 if (search->current) {
1399 const char *uid = camel_message_info_uid(search->current);
1401 /* performs an OR of all words */
1402 for (i=0;i<argc && !truth;i++) {
1403 if (argv[i]->type == ESEXP_RES_STRING
1404 && !strcmp(uid, argv[i]->value.string)) {
1409 r = e_sexp_result_new(f, ESEXP_RES_BOOL);
1410 r->value.bool = truth;
1412 r = e_sexp_result_new(f, ESEXP_RES_ARRAY_PTR);
1413 r->value.ptrarray = g_ptr_array_new();
1414 for (i=0;i<argc;i++) {
1415 if (argv[i]->type == ESEXP_RES_STRING)
1416 g_ptr_array_add(r->value.ptrarray, argv[i]->value.string);
1424 read_uid_callback (void * ref, int ncol, char ** cols, char **name)
1428 matches = (GPtrArray *) ref;
1430 g_ptr_array_add (matches, (gpointer) camel_pstring_strdup (cols [0]));