2 * Claws Mail -- a GTK+ based, lightweight, and fast e-mail client
3 * Copyright (C) 2012 the Claws Mail team
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 3 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License
16 * along with this program. If not, see <http://www.gnu.org/licenses/>.
22 # include "claws-features.h"
25 #include "advsearch.h"
31 #include "matcher_parser.h"
33 #include "prefs_common.h"
35 struct _AdvancedSearch {
37 AdvancedSearchType type;
41 MatcherList *predicate;
43 gboolean search_aborted;
46 gboolean (*cb)(gpointer data, guint at, guint matched, guint total);
50 void (*cb)(gpointer data);
55 void advsearch_set_on_progress_cb(AdvancedSearch *search, gboolean (*cb)(gpointer, guint, guint, guint), gpointer data)
57 search->on_progress_cb.cb = cb;
58 search->on_progress_cb.data = data;
61 void advsearch_set_on_error_cb(AdvancedSearch* search, void (*cb)(gpointer data), gpointer data)
63 search->on_error_cb.cb = cb;
64 search->on_error_cb.data = data;
67 static void prepare_matcher(AdvancedSearch *search);
68 static gboolean search_impl(MsgInfoList **messages, AdvancedSearch* search,
69 FolderItem* folderItem, gboolean recursive);
71 // --------------------------
73 AdvancedSearch* advsearch_new()
75 AdvancedSearch *result;
77 result = g_new0(AdvancedSearch, 1);
82 void advsearch_free(AdvancedSearch *search)
84 if (search->predicate != NULL)
85 matcherlist_free(search->predicate);
87 g_free(search->request.matchstring);
91 void advsearch_set(AdvancedSearch *search, AdvancedSearchType type, const gchar *matchstring)
93 cm_return_if_fail(search != NULL);
95 search->request.type = type;
97 g_free(search->request.matchstring);
98 search->request.matchstring = g_strdup(matchstring);
100 prepare_matcher(search);
103 gboolean advsearch_is_fast(AdvancedSearch *search)
105 cm_return_val_if_fail(search != NULL, FALSE);
107 return search->is_fast;
110 gboolean advsearch_has_proper_predicate(AdvancedSearch *search)
112 cm_return_val_if_fail(search != NULL, FALSE);
114 return search->predicate != NULL;
117 gboolean advsearch_search_msgs_in_folders(AdvancedSearch* search, MsgInfoList **messages,
118 FolderItem* folderItem, gboolean recursive)
120 if (search == NULL || search->predicate == NULL)
123 search->search_aborted = FALSE;
124 return search_impl(messages, search, folderItem, recursive);
127 void advsearch_abort(AdvancedSearch *search)
129 search->search_aborted = TRUE;
132 gchar *advsearch_expand_search_string(const gchar *search_string)
135 gchar term_char, save_char;
136 gchar *cmd_start, *cmd_end;
138 gchar *returnstr = NULL;
140 gboolean casesens, dontmatch, regex;
141 /* list of allowed pattern abbreviations */
143 gchar *abbreviated; /* abbreviation */
144 gchar *command; /* actual matcher command */
145 gint numparams; /* number of params for cmd */
146 gboolean qualifier; /* do we append stringmatch operations */
147 gboolean quotes; /* do we need quotes */
150 { "a", "all", 0, FALSE, FALSE },
151 { "ag", "age_greater", 1, FALSE, FALSE },
152 { "al", "age_lower", 1, FALSE, FALSE },
153 { "agh","age_greater_hours", 1, FALSE, FALSE },
154 { "alh","age_lower_hours", 1, FALSE, FALSE },
155 { "b", "body_part", 1, TRUE, TRUE },
156 { "B", "message", 1, TRUE, TRUE },
157 { "c", "cc", 1, TRUE, TRUE },
158 { "C", "to_or_cc", 1, TRUE, TRUE },
159 { "D", "deleted", 0, FALSE, FALSE },
160 { "e", "header \"Sender\"", 1, TRUE, TRUE },
161 { "E", "execute", 1, FALSE, TRUE },
162 { "f", "from", 1, TRUE, TRUE },
163 { "F", "forwarded", 0, FALSE, FALSE },
164 { "h", "headers_part", 1, TRUE, TRUE },
165 { "ha", "has_attachments", 0, FALSE, FALSE },
166 { "i", "header \"Message-ID\"", 1, TRUE, TRUE },
167 { "I", "inreplyto", 1, TRUE, TRUE },
168 { "k", "colorlabel", 1, FALSE, FALSE },
169 { "L", "locked", 0, FALSE, FALSE },
170 { "n", "newsgroups", 1, TRUE, TRUE },
171 { "N", "new", 0, FALSE, FALSE },
172 { "O", "~new", 0, FALSE, FALSE },
173 { "r", "replied", 0, FALSE, FALSE },
174 { "R", "~unread", 0, FALSE, FALSE },
175 { "s", "subject", 1, TRUE, TRUE },
176 { "se", "score_equal", 1, FALSE, FALSE },
177 { "sg", "score_greater", 1, FALSE, FALSE },
178 { "sl", "score_lower", 1, FALSE, FALSE },
179 { "Se", "size_equal", 1, FALSE, FALSE },
180 { "Sg", "size_greater", 1, FALSE, FALSE },
181 { "Ss", "size_smaller", 1, FALSE, FALSE },
182 { "t", "to", 1, TRUE, TRUE },
183 { "tg", "tag", 1, TRUE, TRUE },
184 { "T", "marked", 0, FALSE, FALSE },
185 { "U", "unread", 0, FALSE, FALSE },
186 { "x", "header \"References\"", 1, TRUE, TRUE },
187 { "X", "test", 1, FALSE, FALSE },
188 { "y", "header \"X-Label\"", 1, TRUE, TRUE },
189 { "&", "&", 0, FALSE, FALSE },
190 { "|", "|", 0, FALSE, FALSE },
191 { "p", "partial", 0, FALSE, FALSE },
192 { NULL, NULL, 0, FALSE, FALSE }
195 if (search_string == NULL)
198 copy_str = g_strdup(search_string);
200 matcherstr = g_string_sized_new(16);
201 cmd_start = copy_str;
202 while (cmd_start && *cmd_start) {
203 /* skip all white spaces */
204 while (*cmd_start && isspace((guchar)*cmd_start))
208 /* extract a command */
209 while (*cmd_end && !isspace((guchar)*cmd_end))
213 save_char = *cmd_end;
220 /* ~ and ! mean logical NOT */
221 if (*cmd_start == '~' || *cmd_start == '!')
226 /* % means case sensitive match */
227 if (*cmd_start == '%')
232 /* # means regex match */
233 if (*cmd_start == '#') {
238 /* find matching abbreviation */
239 for (i = 0; cmds[i].command; i++) {
240 if (!strcmp(cmd_start, cmds[i].abbreviated)) {
241 /* restore character */
242 *cmd_end = save_char;
245 if (matcherstr->len > 0) {
246 g_string_append(matcherstr, " ");
249 g_string_append(matcherstr, "~");
250 g_string_append(matcherstr, cmds[i].command);
251 g_string_append(matcherstr, " ");
253 /* stop if no params required */
254 if (cmds[i].numparams == 0)
257 /* extract a parameter, allow quotes */
258 while (*cmd_end && isspace((guchar)*cmd_end))
262 if (*cmd_start == '"') {
269 /* extract actual parameter */
270 while ((*cmd_end) && (*cmd_end != term_char))
276 save_char = *cmd_end;
279 if (cmds[i].qualifier) {
281 g_string_append(matcherstr, regex ? "regexp " : "match ");
283 g_string_append(matcherstr, regex ? "regexpcase " : "matchcase ");
286 /* do we need to add quotes ? */
287 if (cmds[i].quotes && term_char != '"')
288 g_string_append(matcherstr, "\"");
290 /* copy actual parameter */
291 g_string_append(matcherstr, cmd_start);
293 /* do we need to add quotes ? */
294 if (cmds[i].quotes && term_char != '"')
295 g_string_append(matcherstr, "\"");
297 /* restore original character */
298 *cmd_end = save_char;
311 /* return search string if no match is found to allow
312 all available filtering expressions in advanced search */
313 if (matcherstr->len > 0) returnstr = matcherstr->str;
314 else returnstr = g_strdup(search_string);
315 g_string_free(matcherstr, FALSE);
319 static void prepare_matcher_extended(AdvancedSearch *search)
321 gchar *newstr = advsearch_expand_search_string(search->request.matchstring);
323 if (newstr && newstr[0] != '\0') {
324 search->predicate = matcher_parser_get_cond(newstr, &search->is_fast);
329 #define debug_matcher_list(prefix, list) \
331 gchar *str = list ? matcherlist_to_string(list) : g_strdup("(NULL)"); \
333 debug_print("%s: %s\n", prefix, str); \
338 static void prepare_matcher_tag(AdvancedSearch *search)
340 gchar **words = search->request.matchstring
341 ? g_strsplit(search->request.matchstring, " ", -1)
345 if (search->predicate == NULL) {
346 search->predicate = g_new0(MatcherList, 1);
347 search->predicate->bool_and = FALSE;
348 search->is_fast = TRUE;
351 while (words && words[i] && *words[i]) {
352 MatcherProp *matcher;
354 g_strstrip(words[i]);
356 matcher = matcherprop_new(MATCHCRITERIA_TAG, NULL,
357 MATCHTYPE_MATCHCASE, words[i], 0);
359 search->predicate->matchers = g_slist_prepend(search->predicate->matchers, matcher);
366 static void prepare_matcher_header(AdvancedSearch *search, gint match_header)
368 MatcherProp *matcher;
370 if (search->predicate == NULL) {
371 search->predicate = g_new0(MatcherList, 1);
372 search->predicate->bool_and = FALSE;
373 search->is_fast = TRUE;
376 matcher = matcherprop_new(match_header, NULL, MATCHTYPE_MATCHCASE,
377 search->request.matchstring, 0);
379 search->predicate->matchers = g_slist_prepend(search->predicate->matchers, matcher);
382 static void prepare_matcher_mixed(AdvancedSearch *search)
384 prepare_matcher_tag(search);
385 debug_matcher_list("tag matcher list", search->predicate);
387 /* we want an OR search */
388 if (search->predicate)
389 search->predicate->bool_and = FALSE;
391 prepare_matcher_header(search, MATCHCRITERIA_SUBJECT);
392 debug_matcher_list("tag + subject matcher list", search->predicate);
393 prepare_matcher_header(search, MATCHCRITERIA_FROM);
394 debug_matcher_list("tag + subject + from matcher list", search->predicate);
395 prepare_matcher_header(search, MATCHCRITERIA_TO);
396 debug_matcher_list("tag + subject + from + to matcher list", search->predicate);
399 static void prepare_matcher(AdvancedSearch *search)
401 const gchar *search_string;
403 cm_return_if_fail(search != NULL);
405 if (search->predicate) {
406 matcherlist_free(search->predicate);
407 search->predicate = NULL;
410 search_string = search->request.matchstring;
412 if (search_string == NULL || search_string[0] == '\0')
415 switch (search->request.type) {
416 case ADVANCED_SEARCH_SUBJECT:
417 prepare_matcher_header(search, MATCHCRITERIA_SUBJECT);
418 debug_matcher_list("subject search", search->predicate);
421 case ADVANCED_SEARCH_FROM:
422 prepare_matcher_header(search, MATCHCRITERIA_FROM);
423 debug_matcher_list("from search", search->predicate);
426 case ADVANCED_SEARCH_TO:
427 prepare_matcher_header(search, MATCHCRITERIA_TO);
428 debug_matcher_list("to search", search->predicate);
431 case ADVANCED_SEARCH_TAG:
432 prepare_matcher_tag(search);
433 debug_matcher_list("tag search", search->predicate);
436 case ADVANCED_SEARCH_MIXED:
437 prepare_matcher_mixed(search);
438 debug_matcher_list("mixed search", search->predicate);
441 case ADVANCED_SEARCH_EXTENDED:
442 prepare_matcher_extended(search);
443 debug_matcher_list("extended search", search->predicate);
447 debug_print("unknown search type (%d)\n", search->request.type);
452 static gboolean search_progress_notify_cb(gpointer data, gboolean on_server, guint at,
453 guint matched, guint total)
455 AdvancedSearch *search = (AdvancedSearch*) data;
457 if (search->search_aborted)
460 if (on_server || search->on_progress_cb.cb == NULL)
463 return search->on_progress_cb.cb(search->on_progress_cb.data, at, matched, total);
466 static gboolean search_filter_folder(MsgNumberList **msgnums, AdvancedSearch *search,
467 FolderItem *folderItem, gboolean onServer)
470 gboolean tried_server = onServer;
472 matched = folder_item_search_msgs(folderItem->folder,
477 search_progress_notify_cb,
481 if (search->on_error_cb.cb != NULL)
482 search->on_error_cb.cb(search->on_error_cb.data);
486 if (folderItem->folder->klass->supports_server_search && tried_server && !onServer) {
487 return search_filter_folder(msgnums, search, folderItem, onServer);
493 static gboolean search_impl(MsgInfoList **messages, AdvancedSearch* search,
494 FolderItem* folderItem, gboolean recursive)
497 if (!search_impl(messages, search, folderItem, FALSE))
500 if (folderItem->node->children != NULL && !search->search_aborted) {
502 for (node = folderItem->node->children; node != NULL; node = node->next) {
503 FolderItem *cur = FOLDER_ITEM(node->data);
504 debug_print("in: %s\n", cur->path);
505 if (!search_impl(messages, search, cur, TRUE))
509 } else if (!folderItem->no_select) {
510 MsgNumberList *msgnums = NULL;
512 MsgInfoList *msgs = NULL;
513 gboolean can_search_on_server = folderItem->folder->klass->supports_server_search;
515 if (!search_filter_folder(&msgnums, search, folderItem,
516 can_search_on_server)) {
517 g_slist_free(msgnums);
521 for (cur = msgnums; cur != NULL; cur = cur->next) {
522 MsgInfo *msg = folder_item_get_msginfo(folderItem, GPOINTER_TO_UINT(cur->data));
524 msgs = g_slist_prepend(msgs, msg);
527 while (msgs != NULL) {
528 MsgInfoList *front = msgs;
532 front->next = *messages;
536 g_slist_free(msgnums);