Add a fast way to search for Message-ID (at least)
[claws.git] / src / advsearch.c
1 /*
2  * Claws Mail -- a GTK+ based, lightweight, and fast e-mail client
3  * Copyright (C) 2012-2014 the Claws Mail team
4  *
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.
9  *
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.
14  *
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/>.
17  * 
18  */
19
20 #ifdef HAVE_CONFIG_H
21 # include "config.h"
22 # include "claws-features.h"
23 #endif
24
25 #include "advsearch.h"
26
27 #include <glib.h>
28 #include <ctype.h>
29
30 #include "matcher.h"
31 #include "matcher_parser.h"
32 #include "utils.h"
33 #include "prefs_common.h"
34
35 struct _AdvancedSearch {
36         struct {
37                 AdvancedSearchType       type;
38                 gchar                   *matchstring;
39         } request;
40
41         MatcherList                     *predicate;
42         gboolean                         is_fast;
43         gboolean                         search_aborted;
44
45         struct {
46                 gboolean (*cb)(gpointer data, guint at, guint matched, guint total);
47                 gpointer data;
48         } on_progress_cb;
49         struct {
50                 void (*cb)(gpointer data);
51                 gpointer data;
52         } on_error_cb;
53 };
54
55 void advsearch_set_on_progress_cb(AdvancedSearch *search, gboolean (*cb)(gpointer, guint, guint, guint), gpointer data)
56 {
57         search->on_progress_cb.cb = cb;
58         search->on_progress_cb.data = data;
59 }
60
61 void advsearch_set_on_error_cb(AdvancedSearch* search, void (*cb)(gpointer data), gpointer data)
62 {
63         search->on_error_cb.cb = cb;
64         search->on_error_cb.data = data;
65 }
66
67 static void prepare_matcher(AdvancedSearch *search);
68 static gboolean search_impl(MsgInfoList **messages, AdvancedSearch* search,
69                             FolderItem* folderItem, gboolean recursive);
70
71 // --------------------------
72
73 AdvancedSearch* advsearch_new()
74 {
75         AdvancedSearch *result;
76
77         result = g_new0(AdvancedSearch, 1);
78
79         return result;
80 }
81
82 void advsearch_free(AdvancedSearch *search)
83 {
84         if (search->predicate != NULL)
85                 matcherlist_free(search->predicate);
86
87         g_free(search->request.matchstring);
88         g_free(search);
89 }
90
91 void advsearch_set(AdvancedSearch *search, AdvancedSearchType type, const gchar *matchstring)
92 {
93         cm_return_if_fail(search != NULL);
94
95         search->request.type = type;
96
97         g_free(search->request.matchstring);
98         search->request.matchstring = g_strdup(matchstring);
99
100         prepare_matcher(search);
101 }
102
103 gboolean advsearch_is_fast(AdvancedSearch *search)
104 {
105         cm_return_val_if_fail(search != NULL, FALSE);
106
107         return search->is_fast;
108 }
109
110 gboolean advsearch_has_proper_predicate(AdvancedSearch *search)
111 {
112         cm_return_val_if_fail(search != NULL, FALSE);
113
114         return search->predicate != NULL;
115 }
116
117 gboolean advsearch_search_msgs_in_folders(AdvancedSearch* search, MsgInfoList **messages,
118                                           FolderItem* folderItem, gboolean recursive)
119 {
120         if (search == NULL || search->predicate == NULL)
121                 return FALSE;
122
123         search->search_aborted = FALSE;
124         return search_impl(messages, search, folderItem, recursive);
125 }
126
127 void advsearch_abort(AdvancedSearch *search)
128 {
129         search->search_aborted = TRUE;
130 }
131
132 gchar *advsearch_expand_search_string(const gchar *search_string)
133 {
134         int i = 0;
135         gchar term_char, save_char;
136         gchar *cmd_start, *cmd_end;
137         GString *matcherstr;
138         gchar *returnstr = NULL;
139         gchar *copy_str;
140         gboolean casesens, dontmatch, regex;
141         /* list of allowed pattern abbreviations */
142         struct {
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 */
148         }
149         cmds[] = {
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                 { "H",  "headers_cont",                 1,      TRUE,   TRUE  },
166                 { "ha", "has_attachments",              0,      FALSE,  FALSE },
167                 { "i",  "messageid",                    1,      TRUE,   TRUE  },
168                 { "I",  "inreplyto",                    1,      TRUE,   TRUE  },
169                 { "k",  "colorlabel",                   1,      FALSE,  FALSE },
170                 { "L",  "locked",                       0,      FALSE,  FALSE },
171                 { "n",  "newsgroups",                   1,      TRUE,   TRUE  },
172                 { "N",  "new",                          0,      FALSE,  FALSE },
173                 { "O",  "~new",                         0,      FALSE,  FALSE },
174                 { "r",  "replied",                      0,      FALSE,  FALSE },
175                 { "R",  "~unread",                      0,      FALSE,  FALSE },
176                 { "s",  "subject",                      1,      TRUE,   TRUE  },
177                 { "se", "score_equal",                  1,      FALSE,  FALSE },
178                 { "sg", "score_greater",                1,      FALSE,  FALSE },
179                 { "sl", "score_lower",                  1,      FALSE,  FALSE },
180                 { "Se", "size_equal",                   1,      FALSE,  FALSE },
181                 { "Sg", "size_greater",                 1,      FALSE,  FALSE },
182                 { "Ss", "size_smaller",                 1,      FALSE,  FALSE },
183                 { "t",  "to",                           1,      TRUE,   TRUE  },
184                 { "tg", "tag",                          1,      TRUE,   TRUE  },
185                 { "T",  "marked",                       0,      FALSE,  FALSE },
186                 { "U",  "unread",                       0,      FALSE,  FALSE },
187                 { "x",  "header \"References\"",        1,      TRUE,   TRUE  },
188                 { "X",  "test",                         1,      FALSE,  FALSE },
189                 { "y",  "header \"X-Label\"",           1,      TRUE,   TRUE  },
190                 { "&",  "&",                            0,      FALSE,  FALSE },
191                 { "|",  "|",                            0,      FALSE,  FALSE },
192                 { "p",  "partial",                      0,      FALSE,  FALSE },
193                 { NULL, NULL,                           0,      FALSE,  FALSE }
194         };
195
196         if (search_string == NULL)
197                 return NULL;
198
199         copy_str = g_strdup(search_string);
200
201         matcherstr = g_string_sized_new(16);
202         cmd_start = copy_str;
203         while (cmd_start && *cmd_start) {
204                 /* skip all white spaces */
205                 while (*cmd_start && isspace((guchar)*cmd_start))
206                         cmd_start++;
207                 cmd_end = cmd_start;
208
209                 /* extract a command */
210                 while (*cmd_end && !isspace((guchar)*cmd_end))
211                         cmd_end++;
212
213                 /* save character */
214                 save_char = *cmd_end;
215                 *cmd_end = '\0';
216
217                 dontmatch = FALSE;
218                 casesens = FALSE;
219                 regex = FALSE;
220
221                 /* ~ and ! mean logical NOT */
222                 if (*cmd_start == '~' || *cmd_start == '!')
223                 {
224                         dontmatch = TRUE;
225                         cmd_start++;
226                 }
227                 /* % means case sensitive match */
228                 if (*cmd_start == '%')
229                 {
230                         casesens = TRUE;
231                         cmd_start++;
232                 }
233                 /* # means regex match */
234                 if (*cmd_start == '#') {
235                         regex = TRUE;
236                         cmd_start++;
237                 }
238
239                 /* find matching abbreviation */
240                 for (i = 0; cmds[i].command; i++) {
241                         if (!strcmp(cmd_start, cmds[i].abbreviated)) {
242                                 /* restore character */
243                                 *cmd_end = save_char;
244
245                                 /* copy command */
246                                 if (matcherstr->len > 0) {
247                                         g_string_append(matcherstr, " ");
248                                 }
249                                 if (dontmatch)
250                                         g_string_append(matcherstr, "~");
251                                 g_string_append(matcherstr, cmds[i].command);
252                                 g_string_append(matcherstr, " ");
253
254                                 /* stop if no params required */
255                                 if (cmds[i].numparams == 0)
256                                         break;
257
258                                 /* extract a parameter, allow quotes */
259                                 while (*cmd_end && isspace((guchar)*cmd_end))
260                                         cmd_end++;
261
262                                 cmd_start = cmd_end;
263                                 if (*cmd_start == '"') {
264                                         term_char = '"';
265                                         cmd_end++;
266                                 }
267                                 else
268                                         term_char = ' ';
269
270                                 /* extract actual parameter */
271                                 while ((*cmd_end) && (*cmd_end != term_char))
272                                         cmd_end++;
273
274                                 if (*cmd_end == '"')
275                                         cmd_end++;
276
277                                 save_char = *cmd_end;
278                                 *cmd_end = '\0';
279
280                                 if (cmds[i].qualifier) {
281                                         if (casesens)
282                                                 g_string_append(matcherstr, regex ? "regexp " : "match ");
283                                         else
284                                                 g_string_append(matcherstr, regex ? "regexpcase " : "matchcase ");
285                                 }
286
287                                 /* do we need to add quotes ? */
288                                 if (cmds[i].quotes && term_char != '"')
289                                         g_string_append(matcherstr, "\"");
290
291                                 /* copy actual parameter */
292                                 g_string_append(matcherstr, cmd_start);
293
294                                 /* do we need to add quotes ? */
295                                 if (cmds[i].quotes && term_char != '"')
296                                         g_string_append(matcherstr, "\"");
297
298                                 /* restore original character */
299                                 *cmd_end = save_char;
300
301                                 break;
302                         }
303                 }
304
305                 if (*cmd_end)
306                         cmd_end++;
307                 cmd_start = cmd_end;
308         }
309
310         g_free(copy_str);
311
312         /* return search string if no match is found to allow
313            all available filtering expressions in advanced search */
314         if (matcherstr->len > 0) returnstr = matcherstr->str;
315         else returnstr = g_strdup(search_string);
316         g_string_free(matcherstr, FALSE);
317         return returnstr;
318 }
319
320 static void prepare_matcher_extended(AdvancedSearch *search)
321 {
322         gchar *newstr = advsearch_expand_search_string(search->request.matchstring);
323
324         if (newstr && newstr[0] != '\0') {
325                 search->predicate = matcher_parser_get_cond(newstr, &search->is_fast);
326                 g_free(newstr);
327         }
328 }
329
330 #define debug_matcher_list(prefix, list)                                        \
331 do {                                                                            \
332         gchar *str = list ? matcherlist_to_string(list) : g_strdup("(NULL)");   \
333                                                                                 \
334         debug_print("%s: %s\n", prefix, str);                                   \
335                                                                                 \
336         g_free(str);                                                            \
337 } while(0)
338
339 static void prepare_matcher_tag(AdvancedSearch *search)
340 {
341         gchar **words = search->request.matchstring 
342                         ? g_strsplit(search->request.matchstring, " ", -1)
343                         : NULL;
344         gint i = 0;
345
346         if (search->predicate == NULL) {
347                 search->predicate = g_new0(MatcherList, 1);
348                 search->predicate->bool_and = FALSE;
349                 search->is_fast = TRUE;
350         }
351
352         while (words && words[i] && *words[i]) {
353                 MatcherProp *matcher;
354
355                 g_strstrip(words[i]);
356
357                 matcher = matcherprop_new(MATCHCRITERIA_TAG, NULL,
358                                           MATCHTYPE_MATCHCASE, words[i], 0);
359
360                 search->predicate->matchers = g_slist_prepend(search->predicate->matchers, matcher);
361
362                 i++;
363         }
364         g_strfreev(words);
365 }
366
367 static void prepare_matcher_header(AdvancedSearch *search, gint match_header)
368 {
369         MatcherProp *matcher;
370
371         if (search->predicate == NULL) {
372                 search->predicate = g_new0(MatcherList, 1);
373                 search->predicate->bool_and = FALSE;
374                 search->is_fast = TRUE;
375         }
376
377         matcher = matcherprop_new(match_header, NULL, MATCHTYPE_MATCHCASE,
378                         search->request.matchstring, 0);
379
380         search->predicate->matchers = g_slist_prepend(search->predicate->matchers, matcher);
381 }
382
383 static void prepare_matcher_mixed(AdvancedSearch *search)
384 {
385         prepare_matcher_tag(search);
386         debug_matcher_list("tag matcher list", search->predicate);
387
388         /* we want an OR search */
389         if (search->predicate)
390                 search->predicate->bool_and = FALSE;
391
392         prepare_matcher_header(search, MATCHCRITERIA_SUBJECT);
393         debug_matcher_list("tag + subject matcher list", search->predicate);
394         prepare_matcher_header(search, MATCHCRITERIA_FROM);
395         debug_matcher_list("tag + subject + from matcher list", search->predicate);
396         prepare_matcher_header(search, MATCHCRITERIA_TO);
397         debug_matcher_list("tag + subject + from + to matcher list", search->predicate);
398         prepare_matcher_header(search, MATCHCRITERIA_CC);
399         debug_matcher_list("tag + subject + from + to + cc matcher list", search->predicate);
400 }
401
402 static void prepare_matcher(AdvancedSearch *search)
403 {
404         const gchar *search_string;
405
406         cm_return_if_fail(search != NULL);
407
408         if (search->predicate) {
409                 matcherlist_free(search->predicate);
410                 search->predicate = NULL;
411         }
412
413         search_string = search->request.matchstring;
414
415         if (search_string == NULL || search_string[0] == '\0')
416                 return;
417
418         switch (search->request.type) {
419                 case ADVANCED_SEARCH_SUBJECT:
420                         prepare_matcher_header(search, MATCHCRITERIA_SUBJECT);
421                         debug_matcher_list("subject search", search->predicate);
422                         break;
423
424                 case ADVANCED_SEARCH_FROM:
425                         prepare_matcher_header(search, MATCHCRITERIA_FROM);
426                         debug_matcher_list("from search", search->predicate);
427                         break;
428
429                 case ADVANCED_SEARCH_TO:
430                         prepare_matcher_header(search, MATCHCRITERIA_TO);
431                         debug_matcher_list("to search", search->predicate);
432                         break;
433
434                 case ADVANCED_SEARCH_TAG:
435                         prepare_matcher_tag(search);
436                         debug_matcher_list("tag search", search->predicate);
437                         break;
438
439                 case ADVANCED_SEARCH_MIXED:
440                         prepare_matcher_mixed(search);
441                         debug_matcher_list("mixed search", search->predicate);
442                         break;
443
444                 case ADVANCED_SEARCH_EXTENDED:
445                         prepare_matcher_extended(search);
446                         debug_matcher_list("extended search", search->predicate);
447                         break;
448
449                 default:
450                         debug_print("unknown search type (%d)\n", search->request.type);
451                         break;
452         }
453 }
454
455 static gboolean search_progress_notify_cb(gpointer data, gboolean on_server, guint at,
456                 guint matched, guint total)
457 {
458         AdvancedSearch *search = (AdvancedSearch*) data;
459
460         if (search->search_aborted)
461                 return FALSE;
462
463         if (on_server || search->on_progress_cb.cb == NULL)
464                 return TRUE;
465
466         return search->on_progress_cb.cb(search->on_progress_cb.data, at, matched, total);
467 }
468
469 static gboolean search_filter_folder(MsgNumberList **msgnums, AdvancedSearch *search,
470                                           FolderItem *folderItem, gboolean onServer)
471 {
472         gint matched;
473         gboolean tried_server = onServer;
474
475         matched = folder_item_search_msgs(folderItem->folder,
476                 folderItem,
477                 msgnums,
478                 &onServer,
479                 search->predicate,
480                 search_progress_notify_cb,
481                 search);
482
483         if (matched < 0) {
484                 if (search->on_error_cb.cb != NULL)
485                         search->on_error_cb.cb(search->on_error_cb.data);
486                 return FALSE;
487         }
488
489         if (folderItem->folder->klass->supports_server_search && tried_server && !onServer) {
490                 return search_filter_folder(msgnums, search, folderItem, onServer);
491         } else {
492                 return TRUE;
493         }
494 }
495
496 static gboolean search_impl(MsgInfoList **messages, AdvancedSearch* search,
497                             FolderItem* folderItem, gboolean recursive)
498 {
499         if (recursive) {
500                 if (!search_impl(messages, search, folderItem, FALSE))
501                         return FALSE;
502
503                 if (folderItem->node->children != NULL && !search->search_aborted) {
504                         GNode *node;
505                         for (node = folderItem->node->children; node != NULL; node = node->next) {
506                                 FolderItem *cur = FOLDER_ITEM(node->data);
507                                 debug_print("in: %s\n", cur->path);
508                                 if (!search_impl(messages, search, cur, TRUE))
509                                         return FALSE;
510                         }
511                 }
512         } else if (!folderItem->no_select) {
513                 MsgNumberList *msgnums = NULL;
514                 MsgNumberList *cur;
515                 MsgInfoList *msgs = NULL;
516                 gboolean can_search_on_server = folderItem->folder->klass->supports_server_search;
517
518                 if (!search_filter_folder(&msgnums, search, folderItem,
519                                           can_search_on_server)) {
520                         g_slist_free(msgnums);
521                         return FALSE;
522                 }
523
524                 for (cur = msgnums; cur != NULL; cur = cur->next) {
525                         MsgInfo *msg = folder_item_get_msginfo(folderItem, GPOINTER_TO_UINT(cur->data));
526
527                         msgs = g_slist_prepend(msgs, msg);
528                 }
529
530                 while (msgs != NULL) {
531                         MsgInfoList *front = msgs;
532
533                         msgs = msgs->next;
534
535                         front->next = *messages;
536                         *messages = front;
537                 }
538
539                 g_slist_free(msgnums);
540         }
541
542         return TRUE;
543 }