2012-05-27 [paul] 3.8.0cvs48
[claws.git] / src / gtk / quicksearch.c
1 /*
2  * Claws Mail -- a GTK+ based, lightweight, and fast e-mail client
3  * Copyright (C) 1999-2012 Colin Leroy <colin@colino.net> 
4  * and the Claws Mail team
5  *
6  * This program is free software; you can redistribute it and/or modify
7  * it under the terms of the GNU General Public License as published by
8  * the Free Software Foundation; either version 3 of the License, or
9  * (at your option) any later version.
10  *
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
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program. If not, see <http://www.gnu.org/licenses/>.
18  * 
19  */
20
21 #ifdef HAVE_CONFIG_H
22 #  include "config.h"
23 #endif
24
25 #include <glib.h>
26 #include <glib/gi18n.h>
27 #include <ctype.h>
28
29 #include <gtk/gtk.h>
30 #include <gdk/gdkkeysyms.h>
31
32 #if !GTK_CHECK_VERSION(3, 0, 0)
33 #include "gtkcmoptionmenu.h"
34 #endif
35 #include "utils.h"
36 #include "combobox.h"
37 #include "menu.h"
38 #include "prefs_common.h"
39 #include "description_window.h"
40 #include "matcher.h"
41 #include "matcher_parser.h"
42 #include "quicksearch.h"
43 #include "folderview.h"
44 #include "folder.h"
45 #include "prefs_matcher.h"
46 #include "claws.h"
47 #include "statusbar.h"
48
49 struct _QuickSearchRequest
50 {
51         QuickSearchType                  type;
52         gchar                           *matchstring;
53         gboolean                         recursive;
54 };
55 typedef struct _QuickSearchRequest QuickSearchRequest;
56
57 struct _QuickSearch
58 {
59         GtkWidget                       *hbox_search;
60         GtkWidget                       *search_type;
61 #if !GTK_CHECK_VERSION(3, 0, 0)
62         GtkWidget                       *search_type_opt;
63 #endif
64         GtkWidget                       *search_string_entry;
65         GtkWidget                       *search_condition_expression;
66         GtkWidget                       *search_description;
67         GtkWidget                       *clear_search;
68
69         gboolean                         active;
70         gchar                           *search_string;
71         MatcherList                     *matcher_list;
72
73         QuickSearchRequest              *request;
74         QuickSearchExecuteCallback       callback;
75         gpointer                         callback_data;
76         gboolean                         running;
77         gboolean                         has_focus;
78         gboolean                         matching;
79         gboolean                         deferred_free;
80         FolderItem                      *root_folder_item;
81         gboolean                         is_fast;
82         gboolean                         in_typing;
83         guint                            press_timeout_id;
84
85         GList                           *normal_search_strings;
86         GList                           *extended_search_strings;
87         
88         /* dynamic and autorun qs settings are exclusive*/
89         GtkWidget                        *dynamic_menuitem;
90         GtkWidget                        *autorun_menuitem;
91
92         gboolean                        gui;
93 };
94
95 static void quicksearch_set_running(QuickSearch *quicksearch, gboolean run);
96 static void quicksearch_set_matchstring(QuickSearch *quicksearch, const gchar *matchstring);
97 static void quicksearch_set_active(QuickSearch *quicksearch, gboolean active);
98 static void quicksearch_reset_folder_items(QuickSearch *quicksearch, FolderItem *folder_item);
99 static gchar *expand_search_string(const gchar *str);
100 static gchar *expand_tag_search_string(const gchar *str);
101
102 static gboolean quicksearch_from_gui(QuickSearch *quicksearch)
103 {
104         return quicksearch->gui;
105 }
106
107 gboolean quicksearch_is_fast(QuickSearch *quicksearch)
108 {
109         return quicksearch->is_fast;
110 }
111
112 void quicksearch_set_recursive(QuickSearch *quicksearch, gboolean recursive)
113 {
114         quicksearch->request->recursive = recursive;
115 }
116
117 static void quicksearch_set_type(QuickSearch *quicksearch, gint type)
118 {
119 #if !GTK_CHECK_VERSION(3, 0, 0)
120         gint index;
121         quicksearch->request->type = type;
122         if (quicksearch->gui == FALSE)
123                 return;
124         index = menu_find_option_menu_index(GTK_CMOPTION_MENU(quicksearch->search_type_opt), 
125                                         GINT_TO_POINTER(type),
126                                         NULL);
127         gtk_cmoption_menu_set_history(GTK_CMOPTION_MENU(quicksearch->search_type_opt), index);  
128 #endif
129 }
130
131 static gchar *quicksearch_get_text(QuickSearch * quicksearch)
132 {
133         gchar *search_string = gtk_editable_get_chars(GTK_EDITABLE(gtk_bin_get_child(GTK_BIN((quicksearch->search_string_entry)))), 0, -1);
134
135         g_strstrip(search_string);
136         return search_string;
137 }
138
139 static void quicksearch_set_popdown_strings(QuickSearch *quicksearch)
140 {
141         GtkWidget *search_string_entry = quicksearch->search_string_entry;
142
143         combobox_unset_popdown_strings(GTK_COMBO_BOX(search_string_entry));
144
145         if (prefs_common.summary_quicksearch_type == QUICK_SEARCH_EXTENDED)
146                 combobox_set_popdown_strings(GTK_COMBO_BOX(search_string_entry),
147                         quicksearch->extended_search_strings);  
148         else
149                 combobox_set_popdown_strings(GTK_COMBO_BOX(search_string_entry),
150                         quicksearch->normal_search_strings);
151 }
152
153 static void prepare_matcher(QuickSearch *quicksearch)
154 {
155         /* param search_string is "matchstring" */
156         const gchar *search_string;
157         QuickSearchType quicksearch_type;
158
159         if (quicksearch == NULL)
160                 return;
161
162         /* When called from the GUI, reset type and matchstring */
163         if (quicksearch_from_gui(quicksearch)) {
164                 gchar *s = quicksearch_get_text(quicksearch);
165                 quicksearch_set_matchstring(quicksearch, s);
166                 g_free(s);
167                 quicksearch->request->type = prefs_common.summary_quicksearch_type;
168         }
169         quicksearch_type = quicksearch->request->type;
170         search_string = quicksearch->request->matchstring;
171
172         if (search_string == NULL || search_string[0] == '\0') {
173                 quicksearch_set_active(quicksearch, FALSE);
174         }
175
176         if (quicksearch->matcher_list != NULL) {
177                 if (quicksearch->matching) {
178                         quicksearch->deferred_free = TRUE;
179                         return;
180                 }
181                 quicksearch->deferred_free = FALSE;
182                 matcherlist_free(quicksearch->matcher_list);
183                 quicksearch->matcher_list = NULL;
184         }
185
186         if (search_string == NULL || search_string[0] == '\0') {
187                 return;
188         }
189         if (quicksearch_type == QUICK_SEARCH_EXTENDED) {
190                 char *newstr = NULL;
191
192                 newstr = expand_search_string(search_string);
193                 if (newstr && newstr[0] != '\0') {
194                         quicksearch->matcher_list = matcher_parser_get_cond(newstr, &quicksearch->is_fast);
195                         g_free(newstr);
196                 } else {
197                         quicksearch->matcher_list = NULL;
198                         quicksearch_set_active(quicksearch, FALSE);
199                         return;
200                 }
201         } else if (quicksearch_type == QUICK_SEARCH_TAG) {
202                 char *newstr = expand_tag_search_string(search_string);
203                 quicksearch->matcher_list = matcher_parser_get_cond(newstr, &quicksearch->is_fast);
204                 g_free(newstr);
205         } else if (quicksearch_type == QUICK_SEARCH_MIXED) {
206                 char *newstr = expand_tag_search_string(search_string);
207                 quicksearch->matcher_list = matcher_parser_get_cond(newstr, &quicksearch->is_fast);
208                 g_free(newstr);
209                 g_free(quicksearch->search_string);
210                 quicksearch->search_string = g_utf8_casefold(search_string, -1);
211         } else {
212                 quicksearch->is_fast = TRUE;
213                 g_free(quicksearch->search_string);
214                 quicksearch->search_string = g_utf8_casefold(search_string, -1);
215         }
216         quicksearch_set_active(quicksearch, TRUE);
217 }
218
219 static void update_extended_buttons (QuickSearch *quicksearch)
220 {
221         GtkWidget *expr_btn = quicksearch->search_condition_expression;
222         GtkWidget *ext_btn = quicksearch->search_description;
223
224         cm_return_if_fail(expr_btn != NULL);
225         cm_return_if_fail(ext_btn != NULL);
226
227         if (prefs_common.summary_quicksearch_type == QUICK_SEARCH_EXTENDED) {
228                 gtk_widget_show(expr_btn);
229                 gtk_widget_show(ext_btn);
230         } else {
231                 gtk_widget_hide(expr_btn);
232                 gtk_widget_hide(ext_btn);
233         }
234 }
235
236 static gboolean searchbar_focus_evt_in(GtkWidget *widget, GdkEventFocus *event,
237                                   QuickSearch *qs)
238 {
239         qs->has_focus = TRUE;
240         return FALSE;
241 }
242
243 static gboolean searchbar_focus_evt_out(GtkWidget *widget, GdkEventFocus *event,
244                                   QuickSearch *qs)
245 {
246         qs->has_focus = FALSE;
247         qs->in_typing = FALSE;
248         return FALSE;
249 }
250
251 gboolean quicksearch_has_focus(QuickSearch *quicksearch)
252 {
253         return quicksearch->has_focus;
254 }
255
256 static void searchbar_run(QuickSearch *quicksearch, gboolean run_only_if_fast)
257 {
258         gchar *search_string = quicksearch_get_text(quicksearch);
259         quicksearch_set_matchstring(quicksearch, search_string);
260         prepare_matcher(quicksearch);
261
262         /* add to history, for extended search add only correct matching rules */
263         if (!quicksearch->in_typing && search_string && strlen(search_string) != 0) {
264                 switch (prefs_common.summary_quicksearch_type) {
265                         case QUICK_SEARCH_EXTENDED:
266                                 if (quicksearch->matcher_list) {
267                                         quicksearch->extended_search_strings =
268                                                 add_history(quicksearch->extended_search_strings,
269                                                                 g_strdup(search_string));
270                                         prefs_common.summary_quicksearch_history =
271                                                 add_history(prefs_common.summary_quicksearch_history,
272                                                                 g_strdup(search_string));
273                                 }
274                                 break;
275                         default:
276                                 quicksearch->normal_search_strings =
277                                         add_history(quicksearch->normal_search_strings,
278                                                         g_strdup(search_string));               
279                                 prefs_common.summary_quicksearch_history =
280                                         add_history(prefs_common.summary_quicksearch_history,
281                                                         g_strdup(search_string));
282                                 break;
283                 }
284
285                 quicksearch_set_popdown_strings(quicksearch);
286
287         }
288
289         if (run_only_if_fast && !quicksearch->is_fast) {
290                 g_free(search_string);
291                 return;
292         }
293         if (quicksearch->matcher_list == NULL && 
294             prefs_common.summary_quicksearch_type == QUICK_SEARCH_EXTENDED &&
295             search_string && strlen(search_string) != 0) {
296                 g_free(search_string);
297                 return;
298         }
299         quicksearch_set_running(quicksearch, TRUE);
300         if (quicksearch->callback != NULL)
301                 quicksearch->callback(quicksearch, quicksearch->callback_data);
302         quicksearch_set_running(quicksearch, FALSE);
303         g_free(search_string);
304 }
305
306 static int searchbar_changed_timeout(void *data)
307 {
308         QuickSearch *qs = (QuickSearch *)data;
309         if (qs && prefs_common.summary_quicksearch_dynamic) {
310                 qs->in_typing = TRUE;
311                 searchbar_run(qs, TRUE);
312         }
313         return FALSE;
314 }
315
316 static void searchbar_changed_cb(GtkWidget *widget, QuickSearch *qs)
317 {
318         if (!qs->has_focus && prefs_common.summary_quicksearch_autorun) {
319                 gtk_widget_grab_focus(qs->search_string_entry);
320                 searchbar_run(qs, TRUE);
321                 return;
322         }
323
324         if (prefs_common.summary_quicksearch_dynamic) {
325                 if (qs->press_timeout_id != -1) {
326                         g_source_remove(qs->press_timeout_id);
327                 }
328                 qs->press_timeout_id = g_timeout_add(500,
329                                 searchbar_changed_timeout, qs);
330         }
331
332         if (!qs->has_focus)
333                 gtk_widget_grab_focus(qs->search_string_entry);
334 }
335
336 static gboolean searchbar_pressed(GtkWidget *widget, GdkEventKey *event,
337                                   QuickSearch *quicksearch)
338 {
339         if (event && (event->keyval == GDK_KEY_Escape)) {
340                 gchar *str;
341
342                 quicksearch->in_typing = FALSE;
343
344                 str = quicksearch_get_text(quicksearch);
345                 cm_return_val_if_fail(str != NULL, TRUE);
346
347                 /* If the string entry is empty -> hide quicksearch bar. If not -> empty it */
348                 if (!*str) {
349                         summaryview_activate_quicksearch(
350                                 mainwindow_get_mainwindow()->summaryview, 
351                                 FALSE);
352                 } else {
353                         quicksearch_set(quicksearch, prefs_common.summary_quicksearch_type, "");
354                         gtk_widget_grab_focus(
355                                         mainwindow_get_mainwindow()->summaryview->ctree);
356                 }
357                 g_free(str);
358                 return TRUE;
359         }
360
361         if (event != NULL && (event->keyval == GDK_KEY_Return || event->keyval == GDK_KEY_KP_Enter)) {
362                 if (quicksearch->press_timeout_id != -1) {
363                         g_source_remove(quicksearch->press_timeout_id);
364                         quicksearch->press_timeout_id = -1;
365                 }
366                 quicksearch->in_typing = FALSE;
367                 /* add expression to history list and exec quicksearch */
368                 searchbar_run(quicksearch, FALSE);
369
370                 g_signal_stop_emission_by_name(G_OBJECT(widget), "key_press_event");
371                 return TRUE;
372         }
373
374         if (event && (event->keyval == GDK_KEY_Down || event->keyval == GDK_KEY_Up)) {
375                 combobox_set_value_from_arrow_key(
376                                 GTK_COMBO_BOX(quicksearch->search_string_entry),
377                                 event->keyval);
378                 return TRUE;
379         }
380
381         return FALSE;
382 }
383
384 static gboolean searchtype_changed(GtkMenuItem *widget, gpointer data)
385 {
386         QuickSearch *quicksearch = (QuickSearch *)data;
387         gchar *search_string = quicksearch_get_text(quicksearch);
388         quicksearch_set_matchstring(quicksearch, search_string);
389
390         prefs_common.summary_quicksearch_type = GPOINTER_TO_INT(g_object_get_data(
391                                    G_OBJECT(GTK_MENU_ITEM(gtk_menu_get_active(
392                                    GTK_MENU(quicksearch->search_type)))), MENU_VAL_ID));
393
394         /* Show extended search description button, only when Extended is selected */
395         update_extended_buttons(quicksearch);
396         quicksearch_set_popdown_strings(quicksearch);
397
398         if (!search_string || *(search_string) == 0) {
399                 g_free(search_string);
400                 return TRUE;
401         }
402
403         prepare_matcher(quicksearch);
404
405         quicksearch_set_running(quicksearch, TRUE);
406         if (quicksearch->callback != NULL)
407                 quicksearch->callback(quicksearch, quicksearch->callback_data);
408         quicksearch_set_running(quicksearch, FALSE);
409         g_free(search_string);
410         return TRUE;
411 }
412
413 static gboolean searchtype_recursive_changed(GtkMenuItem *widget, gpointer data)
414 {
415         QuickSearch *quicksearch = (QuickSearch *)data;
416         gboolean checked = gtk_check_menu_item_get_active(GTK_CHECK_MENU_ITEM(widget));
417         gchar *search_string = quicksearch_get_text(quicksearch);
418         /* not needed to quicksearch_set_matchstring(search_string);
419            wait for prepare_matcher() */
420
421         prefs_common.summary_quicksearch_recurse = checked;
422         quicksearch_set_recursive(quicksearch, checked);
423
424         /* reselect the search type */
425         quicksearch_set_type(quicksearch, prefs_common.summary_quicksearch_type);
426
427         if (!search_string || *(search_string) == 0) {
428                 g_free(search_string);
429                 return TRUE;
430         }
431
432         prepare_matcher(quicksearch);
433
434         quicksearch_set_running(quicksearch, TRUE);
435         if (quicksearch->callback != NULL)
436                 quicksearch->callback(quicksearch, quicksearch->callback_data);
437         quicksearch_set_running(quicksearch, FALSE);
438         g_free(search_string);
439         return TRUE;
440 }
441
442 static gboolean searchtype_sticky_changed(GtkMenuItem *widget, gpointer data)
443 {
444         QuickSearch *quicksearch = (QuickSearch *)data;
445         gboolean checked = gtk_check_menu_item_get_active(GTK_CHECK_MENU_ITEM(widget));
446
447         prefs_common.summary_quicksearch_sticky = checked;
448
449         /* reselect the search type */
450         quicksearch_set_type(quicksearch, prefs_common.summary_quicksearch_type);
451
452         return TRUE;
453 }
454
455 static gboolean searchtype_dynamic_changed(GtkMenuItem *widget, gpointer data)
456 {
457         QuickSearch *quicksearch = (QuickSearch *)data;
458         gboolean checked = gtk_check_menu_item_get_active(GTK_CHECK_MENU_ITEM(widget));
459
460         prefs_common.summary_quicksearch_dynamic = checked;
461         if (checked)
462                 gtk_check_menu_item_set_active(
463                                 GTK_CHECK_MENU_ITEM(quicksearch->autorun_menuitem),
464                                 FALSE);
465
466         /* reselect the search type */
467         quicksearch_set_type(quicksearch, prefs_common.summary_quicksearch_type);
468
469         return TRUE;
470 }
471
472 static gboolean searchtype_autorun_changed(GtkMenuItem *widget, gpointer data)
473 {
474         QuickSearch *quicksearch = (QuickSearch *)data;
475         gboolean checked = gtk_check_menu_item_get_active(GTK_CHECK_MENU_ITEM(widget));
476
477         prefs_common.summary_quicksearch_autorun = checked;
478         if (checked)
479                 gtk_check_menu_item_set_active(
480                                 GTK_CHECK_MENU_ITEM(quicksearch->dynamic_menuitem),
481                                 FALSE);
482
483         /* reselect the search type */
484         quicksearch_set_type(quicksearch, prefs_common.summary_quicksearch_type);
485
486         return TRUE;
487 }
488
489 /*
490  * Strings describing how to use Extended Search
491  *
492  * When adding new lines, remember to put 2 strings for each line
493  */
494 static gchar *search_descr_strings[] = {
495         "a",     N_("all messages"),
496         "ag #",  N_("messages whose age is greater than #"),
497         "al #",  N_("messages whose age is less than #"),
498         "b S",   N_("messages which contain S in the message body"),
499         "B S",   N_("messages which contain S in the whole message"),
500         "c S",   N_("messages carbon-copied to S"),
501         "C S",   N_("message is either to: or cc: to S"),
502         "D",     N_("deleted messages"), /** how I can filter deleted messages **/
503         "e S",   N_("messages which contain S in the Sender field"),
504         "E S",   N_("true if execute \"S\" succeeds"),
505         "f S",   N_("messages originating from user S"),
506         "F",     N_("forwarded messages"),
507         "ha",    N_("messages which have attachments"),
508         "h S",   N_("messages which contain header S"),
509         "i S",   N_("messages which contain S in Message-ID header"),
510         "I S",   N_("messages which contain S in In-Reply-To header"),
511         "k #",   N_("messages which are marked with color #"),
512         "L",     N_("locked messages"),
513         "n S",   N_("messages which are in newsgroup S"),
514         "N",     N_("new messages"),
515         "O",     N_("old messages"),
516         "p",     N_("incomplete messages (not entirely downloaded)"),
517         "r",     N_("messages which have been replied to"),
518         "R",     N_("read messages"),
519         "s S",   N_("messages which contain S in subject"),
520         "se #",  N_("messages whose score is equal to #"),
521         "sg #",  N_("messages whose score is greater than #"),
522         "sl #",  N_("messages whose score is lower than #"),
523         "Se #",  N_("messages whose size is equal to #"),
524         "Sg #",  N_("messages whose size is greater than #"),
525         "Ss #",  N_("messages whose size is smaller than #"),
526         "t S",   N_("messages which have been sent to S"),
527         "tg S",  N_("messages which tags contain S"),
528         "tagged",N_("messages which have tag(s)"),
529         "T",     N_("marked messages"),
530         "U",     N_("unread messages"),
531         "x S",   N_("messages which contain S in References header"),
532         "X \"cmd args\"", N_("messages returning 0 when passed to command - %F is message file"),
533         "y S",   N_("messages which contain S in X-Label header"),
534         "",      "" ,
535         "&amp;",         N_("logical AND operator"),
536         "|",     N_("logical OR operator"),
537         "! or ~",       N_("logical NOT operator"),
538         "%",     N_("case sensitive search"),
539         "",      "" ,
540         " ",     N_("all filtering expressions are allowed"),
541         NULL,    NULL
542 };
543
544 static DescriptionWindow search_descr = {
545         NULL,
546         NULL,
547         2,
548         N_("Extended Search"),
549         N_("Extended Search allows the user to define criteria that messages must "
550            "have in order to match and be displayed in the message list.\n"
551            "The following symbols can be used:"),
552         search_descr_strings
553 };
554
555 static void search_description_cb(GtkWidget *widget)
556 {
557         description_window_create(&search_descr);
558 };
559
560 static gboolean clear_search_cb(GtkMenuItem *widget, gpointer data)
561 {
562         QuickSearch *quicksearch = (QuickSearch *)data;
563
564         if (!quicksearch->active)
565                 return TRUE;
566
567         quicksearch_set(quicksearch, prefs_common.summary_quicksearch_type, "");
568
569         return TRUE;
570 };
571
572 static void search_condition_expr_done(MatcherList * matchers)
573 {
574         gchar *str;
575
576         cm_return_if_fail(
577                         mainwindow_get_mainwindow()->summaryview->quicksearch != NULL);
578
579         if (matchers == NULL)
580                 return;
581
582         str = matcherlist_to_string(matchers);
583
584         if (str != NULL) {
585                 quicksearch_set(mainwindow_get_mainwindow()->summaryview->quicksearch,
586                                 prefs_common.summary_quicksearch_type, str);
587                 g_free(str);
588
589                 /* add expression to history list and exec quicksearch */
590                 searchbar_run(mainwindow_get_mainwindow()->summaryview->quicksearch, FALSE);
591         }
592 }
593
594 static gboolean search_condition_expr(GtkMenuItem *widget, gpointer data)
595 {
596         gchar * cond_str;
597         MatcherList * matchers = NULL;
598         
599         cm_return_val_if_fail(
600                         mainwindow_get_mainwindow()->summaryview->quicksearch != NULL,
601                         FALSE);
602
603         /* re-use the current quicksearch value if it's a condition expression,
604            otherwise ignore it silently */
605         cond_str = quicksearch_get_text(mainwindow_get_mainwindow()->summaryview->quicksearch);
606
607         if (*cond_str != '\0') {
608                 matchers = matcher_parser_get_cond((gchar*)cond_str, NULL);
609         }
610
611         prefs_matcher_open(matchers, search_condition_expr_done);
612
613         if (matchers != NULL)
614                 matcherlist_free(matchers);
615
616         g_free(cond_str);
617
618         return TRUE;
619 };
620
621 static void quicksearch_set_button(GtkButton *button, const gchar *icon, const gchar *text)
622 {
623         GList *children = gtk_container_get_children(GTK_CONTAINER(button));
624         GList *cur;
625         GtkWidget *box;
626         gboolean icon_visible;
627
628         g_object_get(gtk_settings_get_default(), 
629                                          "gtk-button-images", &icon_visible, 
630                                          NULL);
631
632         for (cur = children; cur; cur = cur->next)
633                 gtk_container_remove(GTK_CONTAINER(button), GTK_WIDGET(cur->data));
634         
635         g_list_free(children);
636         box = gtk_hbox_new(FALSE, 0);
637         
638         gtk_container_add(GTK_CONTAINER(button), box);
639         if (icon_visible || !text || !*text)
640                 gtk_box_pack_start(GTK_BOX(box), gtk_image_new_from_stock(icon, 
641                         GTK_ICON_SIZE_BUTTON), FALSE, FALSE, 0);
642         gtk_box_pack_start(GTK_BOX(box), gtk_label_new_with_mnemonic(text), FALSE, FALSE, 0);
643         gtk_widget_show_all(box);
644 }
645
646 /*
647  * Builds a new QuickSearchRequest
648  */
649 static QuickSearchRequest *quicksearchrequest_new(void)
650 {
651         QuickSearchRequest *request;
652         request = g_new0(QuickSearchRequest, 1);
653         return request;
654 }
655
656 /*
657  * Builds a new QuickSearch object independent from the GUI
658  */
659 QuickSearch *quicksearch_new_nogui(void)
660 {
661         QuickSearch *quicksearch;
662         QuickSearchRequest *request;
663
664         request = quicksearchrequest_new();
665         quicksearch = g_new0(QuickSearch, 1);
666         quicksearch->request = request;
667         quicksearch->gui = FALSE;
668
669         /* init. values initally found in quicksearch_new().
670            There's no need to init. all pointers to NULL since we use g_new0
671          */
672         quicksearch->matcher_list = NULL;
673         quicksearch->active = FALSE;
674         quicksearch->running = FALSE;
675         quicksearch->in_typing = FALSE;
676         quicksearch->press_timeout_id = -1;
677         quicksearch->normal_search_strings = NULL;
678         quicksearch->extended_search_strings = NULL;
679
680         return quicksearch;
681 }
682
683 QuickSearch *quicksearch_new()
684 {
685         QuickSearch *quicksearch;
686
687         GtkWidget *hbox_search;
688 #if !GTK_CHECK_VERSION(3, 0, 0)
689         GtkWidget *search_type_opt;
690 #endif
691         GtkWidget *search_type;
692         GtkWidget *search_string_entry;
693         GtkWidget *search_hbox;
694         GtkWidget *search_description;
695         GtkWidget *clear_search;
696         GtkWidget *search_condition_expression;
697         GtkWidget *menuitem;
698         GtkWidget *vbox;
699
700         quicksearch = quicksearch_new_nogui();
701         quicksearch->gui = TRUE;
702
703         /* quick search */
704         hbox_search = gtk_hbox_new(FALSE, 0);
705
706 #if !GTK_CHECK_VERSION(3, 0, 0)
707         search_type_opt = gtk_cmoption_menu_new();
708         gtk_widget_show(search_type_opt);
709         gtk_box_pack_start(GTK_BOX(hbox_search), search_type_opt, FALSE, FALSE, 0);
710 #endif
711
712         search_type = gtk_menu_new();
713         MENUITEM_ADD (search_type, menuitem,
714                         prefs_common_translated_header_name("Subject"), QUICK_SEARCH_SUBJECT);
715         g_signal_connect(G_OBJECT(menuitem), "activate",
716                          G_CALLBACK(searchtype_changed),
717                          quicksearch);
718         MENUITEM_ADD (search_type, menuitem,
719                         prefs_common_translated_header_name("From"), QUICK_SEARCH_FROM);
720         g_signal_connect(G_OBJECT(menuitem), "activate",
721                          G_CALLBACK(searchtype_changed),
722                          quicksearch);
723         MENUITEM_ADD (search_type, menuitem,
724                         prefs_common_translated_header_name("To"), QUICK_SEARCH_TO);
725         g_signal_connect(G_OBJECT(menuitem), "activate",
726                          G_CALLBACK(searchtype_changed),
727                          quicksearch);
728         MENUITEM_ADD (search_type, menuitem,
729                         prefs_common_translated_header_name("Tag"), QUICK_SEARCH_TAG);
730         g_signal_connect(G_OBJECT(menuitem), "activate",
731                          G_CALLBACK(searchtype_changed),
732                          quicksearch);
733         MENUITEM_ADD (search_type, menuitem,
734                         _("From/To/Subject/Tag"), QUICK_SEARCH_MIXED);
735         g_signal_connect(G_OBJECT(menuitem), "activate",
736                          G_CALLBACK(searchtype_changed),
737                          quicksearch);
738         MENUITEM_ADD (search_type, menuitem, _("Extended"), QUICK_SEARCH_EXTENDED);
739         g_signal_connect(G_OBJECT(menuitem), "activate",
740                          G_CALLBACK(searchtype_changed),
741                          quicksearch);
742
743         gtk_menu_shell_append(GTK_MENU_SHELL(search_type), gtk_separator_menu_item_new());
744
745         menuitem = gtk_check_menu_item_new_with_label(_("Recursive"));
746         gtk_menu_shell_append(GTK_MENU_SHELL(search_type), menuitem);
747
748         gtk_check_menu_item_set_active(GTK_CHECK_MENU_ITEM(menuitem),
749                                         prefs_common.summary_quicksearch_recurse);
750         quicksearch_set_recursive(quicksearch, prefs_common.summary_quicksearch_recurse);
751         g_signal_connect(G_OBJECT(menuitem), "activate",
752                          G_CALLBACK(searchtype_recursive_changed),
753                          quicksearch);
754
755         menuitem = gtk_check_menu_item_new_with_label(_("Sticky"));
756         gtk_menu_shell_append(GTK_MENU_SHELL(search_type), menuitem);
757
758         gtk_check_menu_item_set_active(GTK_CHECK_MENU_ITEM(menuitem),
759                                         prefs_common.summary_quicksearch_sticky);
760
761         g_signal_connect(G_OBJECT(menuitem), "activate",
762                          G_CALLBACK(searchtype_sticky_changed),
763                          quicksearch);
764
765         menuitem = gtk_check_menu_item_new_with_label(_("Type-ahead"));
766         gtk_menu_shell_append(GTK_MENU_SHELL(search_type), menuitem);
767
768         gtk_check_menu_item_set_active(GTK_CHECK_MENU_ITEM(menuitem),
769                                         prefs_common.summary_quicksearch_dynamic);
770
771         quicksearch->dynamic_menuitem = menuitem;
772
773         g_signal_connect(G_OBJECT(menuitem), "activate",
774                          G_CALLBACK(searchtype_dynamic_changed),
775                          quicksearch);
776
777         menuitem = gtk_check_menu_item_new_with_label(_("Run on select"));
778         gtk_menu_shell_append(GTK_MENU_SHELL(search_type), menuitem);
779
780         gtk_check_menu_item_set_active(GTK_CHECK_MENU_ITEM(menuitem),
781                                         prefs_common.summary_quicksearch_autorun);
782
783         quicksearch->autorun_menuitem = menuitem;
784
785         g_signal_connect(G_OBJECT(menuitem), "activate",
786                          G_CALLBACK(searchtype_autorun_changed),
787                          quicksearch);
788
789 #if !GTK_CHECK_VERSION(3, 0, 0)
790         gtk_cmoption_menu_set_menu(GTK_CMOPTION_MENU(search_type_opt), search_type);
791
792         quicksearch->search_type_opt = search_type_opt;
793 #endif
794         quicksearch_set_type(quicksearch, prefs_common.summary_quicksearch_type);
795
796         gtk_widget_show(search_type);
797
798         search_string_entry = gtk_combo_box_entry_new_text ();
799         gtk_combo_box_set_active(GTK_COMBO_BOX(search_string_entry), -1);
800
801         vbox = gtk_vbox_new(TRUE, 0);
802         gtk_box_pack_start(GTK_BOX(vbox), search_string_entry, FALSE, FALSE, 0);
803         gtk_box_pack_start(GTK_BOX(hbox_search), vbox, TRUE, TRUE, 4);
804
805         gtk_widget_show(vbox);
806         gtk_widget_show(search_string_entry);
807
808         search_hbox = gtk_hbox_new(FALSE, 5);
809         clear_search = gtk_button_new_from_stock(GTK_STOCK_CLEAR);
810         gtk_box_pack_start(GTK_BOX(search_hbox), clear_search,
811                            FALSE, FALSE, 0);
812         g_signal_connect(G_OBJECT(clear_search), "clicked",
813                          G_CALLBACK(clear_search_cb), quicksearch);
814         CLAWS_SET_TIP(clear_search,
815                              _("Clear the current search"));
816         gtk_widget_show(clear_search);
817
818         search_condition_expression = gtk_button_new_from_stock(GTK_STOCK_EDIT);
819         gtk_box_pack_start(GTK_BOX(search_hbox), search_condition_expression,
820                            FALSE, FALSE, 0);
821         g_signal_connect(G_OBJECT (search_condition_expression), "clicked",
822                          G_CALLBACK(search_condition_expr),
823                          quicksearch);
824         CLAWS_SET_TIP(search_condition_expression,
825                              _("Edit search criteria"));
826         gtk_widget_show(search_condition_expression);
827
828         search_description = gtk_button_new_from_stock(GTK_STOCK_INFO);
829         gtk_box_pack_start(GTK_BOX(search_hbox), search_description,
830                            FALSE, FALSE, 0);
831         g_signal_connect(G_OBJECT(search_description), "clicked",
832                          G_CALLBACK(search_description_cb), NULL);
833         CLAWS_SET_TIP(search_description,
834                              _("Information about extended symbols"));
835         gtk_widget_show(search_description);
836
837         gtk_box_pack_start(GTK_BOX(hbox_search), search_hbox, FALSE, FALSE, 2);
838         gtk_widget_show(search_hbox);
839
840         g_signal_connect(G_OBJECT(gtk_bin_get_child(GTK_BIN((search_string_entry)))),
841                            "key_press_event",
842                            G_CALLBACK(searchbar_pressed),
843                            quicksearch);
844
845         g_signal_connect(G_OBJECT(gtk_bin_get_child(GTK_BIN((search_string_entry)))),
846                          "changed",
847                          G_CALLBACK(searchbar_changed_cb),
848                          quicksearch);
849
850         g_signal_connect(G_OBJECT(gtk_bin_get_child(GTK_BIN((search_string_entry)))),
851                          "focus_in_event",
852                          G_CALLBACK(searchbar_focus_evt_in),
853                          quicksearch);
854         g_signal_connect(G_OBJECT(gtk_bin_get_child(GTK_BIN((search_string_entry)))),
855                          "focus_out_event",
856                          G_CALLBACK(searchbar_focus_evt_out),
857                          quicksearch);
858
859         quicksearch->hbox_search = hbox_search;
860         quicksearch->search_type = search_type;
861         quicksearch->search_string_entry = search_string_entry;
862         quicksearch->search_condition_expression = search_condition_expression;
863         quicksearch->search_description = search_description;
864         quicksearch->matcher_list = NULL;
865         quicksearch->active = FALSE;
866         quicksearch->running = FALSE;
867         quicksearch->clear_search = clear_search;
868         quicksearch->in_typing = FALSE;
869         quicksearch->press_timeout_id = -1;
870         quicksearch->normal_search_strings = NULL;
871         quicksearch->extended_search_strings = NULL;
872
873         quicksearch_set_button(GTK_BUTTON(quicksearch->search_description), GTK_STOCK_INFO, _("_Information"));
874         quicksearch_set_button(GTK_BUTTON(quicksearch->search_condition_expression), GTK_STOCK_EDIT, _("_Edit"));
875         quicksearch_set_button(GTK_BUTTON(quicksearch->clear_search), GTK_STOCK_CLEAR, _("C_lear"));
876         
877         update_extended_buttons(quicksearch);
878
879         return quicksearch;
880 }
881
882 void quicksearch_relayout(QuickSearch *quicksearch)
883 {
884         switch (prefs_common.layout_mode) {
885         case NORMAL_LAYOUT:
886         case WIDE_LAYOUT:
887         case WIDE_MSGLIST_LAYOUT:
888                 quicksearch_set_button(GTK_BUTTON(quicksearch->search_description), GTK_STOCK_INFO, _("_Information"));
889                 quicksearch_set_button(GTK_BUTTON(quicksearch->search_condition_expression), GTK_STOCK_EDIT, _("_Edit"));
890                 quicksearch_set_button(GTK_BUTTON(quicksearch->clear_search), GTK_STOCK_CLEAR, _("C_lear"));
891                 break;
892         case SMALL_LAYOUT:
893         case VERTICAL_LAYOUT:
894                 quicksearch_set_button(GTK_BUTTON(quicksearch->search_description), GTK_STOCK_INFO, "");
895                 quicksearch_set_button(GTK_BUTTON(quicksearch->search_condition_expression), GTK_STOCK_EDIT, "");
896                 quicksearch_set_button(GTK_BUTTON(quicksearch->clear_search), GTK_STOCK_CLEAR, "");
897                 break;
898         }
899 }
900
901 GtkWidget *quicksearch_get_widget(QuickSearch *quicksearch)
902 {
903         return quicksearch->hbox_search;
904 }
905
906 void quicksearch_show(QuickSearch *quicksearch)
907 {
908         MainWindow *mainwin = mainwindow_get_mainwindow();
909         GtkWidget *ctree = NULL;
910         prepare_matcher(quicksearch);
911         gtk_widget_show(quicksearch->hbox_search);
912         update_extended_buttons(quicksearch);
913         gtk_widget_grab_focus(
914                 GTK_WIDGET(gtk_bin_get_child(GTK_BIN((quicksearch->search_string_entry)))));
915
916         GTK_EVENTS_FLUSH();
917
918         if (!mainwin || !mainwin->summaryview) {
919                 return;
920         }
921         
922         ctree = summary_get_main_widget(mainwin->summaryview);
923         
924         if (ctree && mainwin->summaryview->selected)
925                 gtk_cmctree_node_moveto(GTK_CMCTREE(ctree), 
926                                 mainwin->summaryview->selected, 
927                                 0, 0.5, 0);
928 }
929
930 void quicksearch_hide(QuickSearch *quicksearch)
931 {
932         if (quicksearch_is_active(quicksearch)) {
933                 quicksearch_set(quicksearch, prefs_common.summary_quicksearch_type, "");
934                 quicksearch_set_active(quicksearch, FALSE);
935         }
936         gtk_widget_hide(quicksearch->hbox_search);
937 }
938
939 /*
940  *\brief        Sets the matchstring.
941  *
942  *\param        quicksearch quicksearch to set
943  *\param        matchstring the match string; it is duplicated, not stored
944  */
945 static void quicksearch_set_matchstring(QuickSearch *quicksearch,
946                                         const gchar *matchstring)
947 {
948         g_free(quicksearch->request->matchstring);
949         quicksearch->request->matchstring = g_strdup(matchstring);
950 }
951
952 void quicksearch_set(QuickSearch *quicksearch, QuickSearchType type,
953                      const gchar *matchstring)
954 {
955         quicksearch_set_type(quicksearch, type);
956
957         if (!matchstring || !(*matchstring))
958                 quicksearch->in_typing = FALSE;
959
960         quicksearch_set_matchstring(quicksearch, matchstring);
961
962         if (!quicksearch_from_gui(quicksearch)) {
963                 prepare_matcher(quicksearch);
964                 /* no callback */
965                 return;
966         }
967                 
968         g_signal_handlers_block_by_func(G_OBJECT(gtk_bin_get_child(GTK_BIN((quicksearch->search_string_entry)))),
969                                         G_CALLBACK(searchbar_changed_cb), quicksearch);
970         gtk_entry_set_text(GTK_ENTRY(gtk_bin_get_child(GTK_BIN((quicksearch->search_string_entry)))),
971                            matchstring);
972         g_signal_handlers_unblock_by_func(G_OBJECT(gtk_bin_get_child(GTK_BIN((quicksearch->search_string_entry)))),
973                                           G_CALLBACK(searchbar_changed_cb), quicksearch);
974
975         prefs_common.summary_quicksearch_type = type;
976
977         prepare_matcher(quicksearch);
978
979         quicksearch_set_running(quicksearch, TRUE);
980         if (quicksearch->callback != NULL)
981                 quicksearch->callback(quicksearch, quicksearch->callback_data);
982         quicksearch_set_running(quicksearch, FALSE);
983 }
984
985 gboolean quicksearch_is_active(QuickSearch *quicksearch)
986 {
987         return quicksearch->active && 
988                 (prefs_common.summary_quicksearch_type != QUICK_SEARCH_EXTENDED
989                  || quicksearch->matcher_list != NULL);
990 }
991
992 static void quicksearch_set_active(QuickSearch *quicksearch, gboolean active)
993 {
994 #if !GTK_CHECK_VERSION(3, 0, 0)
995         static GdkColor yellow;
996         static GdkColor red;
997         static GdkColor black;
998         static gboolean colors_initialised = FALSE;
999 #else
1000         static GdkColor yellow = { (guint32)0, (guint16)0xf5, (guint16)0xf6, (guint16)0xbe };
1001         static GdkColor red = { (guint32)0, (guint16)0xff, (guint16)0x70, (guint16)0x70 };
1002         static GdkColor black = { (guint32)0, (guint16)0x0, (guint16)0x0, (guint16)0x0 };
1003 #endif
1004         gboolean error = FALSE;
1005
1006         
1007         quicksearch->active = active;
1008         if (quicksearch->gui == FALSE)
1009                 return;
1010
1011 #if !GTK_CHECK_VERSION(3, 0, 0)
1012         if (!colors_initialised) {
1013                 gdk_color_parse("#f5f6be", &yellow);
1014                 gdk_color_parse("#000000", &black);
1015                 gdk_color_parse("#ff7070", &red);
1016                 colors_initialised = gdk_colormap_alloc_color(
1017                         gdk_colormap_get_system(), &yellow, FALSE, TRUE);
1018                 colors_initialised &= gdk_colormap_alloc_color(
1019                         gdk_colormap_get_system(), &black, FALSE, TRUE);
1020                 colors_initialised &= gdk_colormap_alloc_color(
1021                         gdk_colormap_get_system(), &red, FALSE, TRUE);
1022         }
1023 #endif
1024
1025         if (active && 
1026                 (prefs_common.summary_quicksearch_type == QUICK_SEARCH_EXTENDED
1027                  && quicksearch->matcher_list == NULL))
1028                 error = TRUE;
1029
1030         if (active) {
1031                 gtk_widget_set_sensitive(quicksearch->clear_search, TRUE);
1032 #if !GTK_CHECK_VERSION(3, 0, 0)
1033                 if (colors_initialised) {
1034 #endif
1035                         gtk_widget_modify_base(
1036                                 gtk_bin_get_child(GTK_BIN((quicksearch->search_string_entry))),
1037                                 GTK_STATE_NORMAL, error ? &red : &yellow);
1038                         gtk_widget_modify_text(
1039                                 gtk_bin_get_child(GTK_BIN((quicksearch->search_string_entry))),
1040                                 GTK_STATE_NORMAL, &black);
1041 #if !GTK_CHECK_VERSION(3, 0, 0)
1042                 }
1043 #endif
1044         } else {
1045                 gtk_widget_set_sensitive(quicksearch->clear_search, FALSE);
1046                 if (colors_initialised) {
1047                         gtk_widget_modify_base(
1048                                 gtk_bin_get_child(GTK_BIN((quicksearch->search_string_entry))),
1049                                 GTK_STATE_NORMAL, NULL);
1050                         gtk_widget_modify_text(
1051                                 gtk_bin_get_child(GTK_BIN((quicksearch->search_string_entry))),
1052                                 GTK_STATE_NORMAL, NULL);
1053 #if !GTK_CHECK_VERSION(3, 0, 0)
1054                 }
1055 #endif
1056         }
1057
1058         if (!active) {
1059                 quicksearch_reset_cur_folder_item(quicksearch);
1060         }
1061 }
1062
1063 void quicksearch_set_execute_callback(QuickSearch *quicksearch,
1064                                       QuickSearchExecuteCallback callback,
1065                                       gpointer data)
1066 {
1067         quicksearch->callback = callback;
1068         quicksearch->callback_data = data;
1069 }
1070
1071 gboolean quicksearch_match(QuickSearch *quicksearch, MsgInfo *msginfo)
1072 {
1073         gchar *searched_header = NULL;
1074         gboolean result = FALSE;
1075         gchar *to = NULL, *from = NULL, *subject = NULL;
1076         QuickSearchType quicksearch_type;
1077
1078         if (!quicksearch->active)
1079                 return TRUE;
1080
1081         quicksearch_type = quicksearch->request->type;
1082
1083         switch (quicksearch_type) {
1084         case QUICK_SEARCH_SUBJECT:
1085                 if (msginfo->subject)
1086                         searched_header = g_utf8_casefold(msginfo->subject, -1);
1087                 else
1088                         return FALSE;
1089                 break;
1090         case QUICK_SEARCH_FROM:
1091                 if (msginfo->from)
1092                         searched_header = g_utf8_casefold(msginfo->from, -1);
1093                 else
1094                         return FALSE;
1095                 break;
1096         case QUICK_SEARCH_TO:
1097                 if (msginfo->to)
1098                         searched_header = g_utf8_casefold(msginfo->to, -1);
1099                 else
1100                         return FALSE;
1101                 break;
1102         case QUICK_SEARCH_MIXED:
1103                 if (msginfo->to)
1104                         to = g_utf8_casefold(msginfo->to, -1);
1105                 if (msginfo->from)
1106                         from = g_utf8_casefold(msginfo->from, -1);
1107                 if (msginfo->subject)
1108                         subject = g_utf8_casefold(msginfo->subject, -1);
1109                 break;
1110         case QUICK_SEARCH_EXTENDED:
1111                 break;
1112         default:
1113                 debug_print("unknown search type (%d)\n", quicksearch_type);
1114                 break;
1115         }
1116
1117         quicksearch->matching = TRUE;
1118         if (quicksearch_type != QUICK_SEARCH_EXTENDED &&
1119             quicksearch_type != QUICK_SEARCH_MIXED &&
1120             quicksearch_type != QUICK_SEARCH_TAG &&
1121             quicksearch->search_string &&
1122             searched_header && strstr(searched_header, quicksearch->search_string) != NULL)
1123                 result = TRUE;
1124         else if (quicksearch_type == QUICK_SEARCH_MIXED &&
1125                 quicksearch->search_string && (
1126                 (to && strstr(to, quicksearch->search_string) != NULL) ||
1127                 (from && strstr(from, quicksearch->search_string) != NULL) ||
1128                 (subject && strstr(subject, quicksearch->search_string) != NULL) ||
1129                 ((quicksearch->matcher_list != NULL) &&
1130                  matcherlist_match(quicksearch->matcher_list, msginfo))  ))
1131                 result = TRUE;
1132         else if ((quicksearch->matcher_list != NULL) &&
1133                  matcherlist_match(quicksearch->matcher_list, msginfo))
1134                 result = TRUE;
1135
1136         quicksearch->matching = FALSE;
1137         if (quicksearch_from_gui(quicksearch)==TRUE && quicksearch->deferred_free) {
1138                 /* Ref. http://lists.claws-mail.org/pipermail/users/2010-August/003063.html
1139                    See also 2.0.0cvs140 ChangeLog entry
1140                    and comment in search_msgs_in_folder() */
1141                 prepare_matcher(quicksearch);
1142         }
1143
1144         g_free(to);
1145         g_free(from);
1146         g_free(subject);
1147         g_free(searched_header);
1148
1149         return result;
1150 }
1151
1152 /* allow Mutt-like patterns in quick search */
1153 static gchar *expand_search_string(const gchar *search_string)
1154 {
1155         int i = 0;
1156         gchar term_char, save_char;
1157         gchar *cmd_start, *cmd_end;
1158         GString *matcherstr;
1159         gchar *returnstr = NULL;
1160         gchar *copy_str;
1161         gboolean casesens, dontmatch;
1162         /* list of allowed pattern abbreviations */
1163         struct {
1164                 gchar           *abbreviated;   /* abbreviation */
1165                 gchar           *command;       /* actual matcher command */
1166                 gint            numparams;      /* number of params for cmd */
1167                 gboolean        qualifier;      /* do we append regexpcase */
1168                 gboolean        quotes;         /* do we need quotes */
1169         }
1170         cmds[] = {
1171                 { "a",  "all",                          0,      FALSE,  FALSE },
1172                 { "ag", "age_greater",                  1,      FALSE,  FALSE },
1173                 { "al", "age_lower",                    1,      FALSE,  FALSE },
1174                 { "b",  "body_part",                    1,      TRUE,   TRUE  },
1175                 { "B",  "message",                      1,      TRUE,   TRUE  },
1176                 { "c",  "cc",                           1,      TRUE,   TRUE  },
1177                 { "C",  "to_or_cc",                     1,      TRUE,   TRUE  },
1178                 { "D",  "deleted",                      0,      FALSE,  FALSE },
1179                 { "e",  "header \"Sender\"",            1,      TRUE,   TRUE  },
1180                 { "E",  "execute",                      1,      FALSE,  TRUE  },
1181                 { "f",  "from",                         1,      TRUE,   TRUE  },
1182                 { "F",  "forwarded",                    0,      FALSE,  FALSE },
1183                 { "h",  "headers_part",                 1,      TRUE,   TRUE  },
1184                 { "ha", "has_attachments",              0,      FALSE,  FALSE },
1185                 { "i",  "header \"Message-ID\"",        1,      TRUE,   TRUE  },
1186                 { "I",  "inreplyto",                    1,      TRUE,   TRUE  },
1187                 { "k",  "colorlabel",                   1,      FALSE,  FALSE },
1188                 { "L",  "locked",                       0,      FALSE,  FALSE },
1189                 { "n",  "newsgroups",                   1,      TRUE,   TRUE  },
1190                 { "N",  "new",                          0,      FALSE,  FALSE },
1191                 { "O",  "~new",                         0,      FALSE,  FALSE },
1192                 { "r",  "replied",                      0,      FALSE,  FALSE },
1193                 { "R",  "~unread",                      0,      FALSE,  FALSE },
1194                 { "s",  "subject",                      1,      TRUE,   TRUE  },
1195                 { "se", "score_equal",                  1,      FALSE,  FALSE },
1196                 { "sg", "score_greater",                1,      FALSE,  FALSE },
1197                 { "sl", "score_lower",                  1,      FALSE,  FALSE },
1198                 { "Se", "size_equal",                   1,      FALSE,  FALSE },
1199                 { "Sg", "size_greater",                 1,      FALSE,  FALSE },
1200                 { "Ss", "size_smaller",                 1,      FALSE,  FALSE },
1201                 { "t",  "to",                           1,      TRUE,   TRUE  },
1202                 { "tg", "tag",                          1,      TRUE,   TRUE  },
1203                 { "T",  "marked",                       0,      FALSE,  FALSE },
1204                 { "U",  "unread",                       0,      FALSE,  FALSE },
1205                 { "x",  "header \"References\"",        1,      TRUE,   TRUE  },
1206                 { "X",  "test",                         1,      FALSE,  FALSE },
1207                 { "y",  "header \"X-Label\"",           1,      TRUE,   TRUE  },
1208                 { "&",  "&",                            0,      FALSE,  FALSE },
1209                 { "|",  "|",                            0,      FALSE,  FALSE },
1210                 { "p",  "partial",                      0,      FALSE,  FALSE },
1211                 { NULL, NULL,                           0,      FALSE,  FALSE }
1212         };
1213
1214         if (search_string == NULL)
1215                 return NULL;
1216
1217         copy_str = g_strdup(search_string);
1218
1219         matcherstr = g_string_sized_new(16);
1220         cmd_start = copy_str;
1221         while (cmd_start && *cmd_start) {
1222                 /* skip all white spaces */
1223                 while (*cmd_start && isspace((guchar)*cmd_start))
1224                         cmd_start++;
1225                 cmd_end = cmd_start;
1226
1227                 /* extract a command */
1228                 while (*cmd_end && !isspace((guchar)*cmd_end))
1229                         cmd_end++;
1230
1231                 /* save character */
1232                 save_char = *cmd_end;
1233                 *cmd_end = '\0';
1234
1235                 dontmatch = FALSE;
1236                 casesens = FALSE;
1237
1238                 /* ~ and ! mean logical NOT */
1239                 if (*cmd_start == '~' || *cmd_start == '!')
1240                 {
1241                         dontmatch = TRUE;
1242                         cmd_start++;
1243                 }
1244                 /* % means case sensitive match */
1245                 if (*cmd_start == '%')
1246                 {
1247                         casesens = TRUE;
1248                         cmd_start++;
1249                 }
1250
1251                 /* find matching abbreviation */
1252                 for (i = 0; cmds[i].command; i++) {
1253                         if (!strcmp(cmd_start, cmds[i].abbreviated)) {
1254                                 /* restore character */
1255                                 *cmd_end = save_char;
1256
1257                                 /* copy command */
1258                                 if (matcherstr->len > 0) {
1259                                         g_string_append(matcherstr, " ");
1260                                 }
1261                                 if (dontmatch)
1262                                         g_string_append(matcherstr, "~");
1263                                 g_string_append(matcherstr, cmds[i].command);
1264                                 g_string_append(matcherstr, " ");
1265
1266                                 /* stop if no params required */
1267                                 if (cmds[i].numparams == 0)
1268                                         break;
1269
1270                                 /* extract a parameter, allow quotes */
1271                                 while (*cmd_end && isspace((guchar)*cmd_end))
1272                                         cmd_end++;
1273
1274                                 cmd_start = cmd_end;
1275                                 if (*cmd_start == '"') {
1276                                         term_char = '"';
1277                                         cmd_end++;
1278                                 }
1279                                 else
1280                                         term_char = ' ';
1281
1282                                 /* extract actual parameter */
1283                                 while ((*cmd_end) && (*cmd_end != term_char))
1284                                         cmd_end++;
1285
1286                                 if (*cmd_end == '"')
1287                                         cmd_end++;
1288
1289                                 save_char = *cmd_end;
1290                                 *cmd_end = '\0';
1291
1292                                 if (cmds[i].qualifier) {
1293                                         if (casesens)
1294                                                 g_string_append(matcherstr, "regexp ");
1295                                         else
1296                                                 g_string_append(matcherstr, "regexpcase ");
1297                                 }
1298
1299                                 /* do we need to add quotes ? */
1300                                 if (cmds[i].quotes && term_char != '"')
1301                                         g_string_append(matcherstr, "\"");
1302
1303                                 /* copy actual parameter */
1304                                 g_string_append(matcherstr, cmd_start);
1305
1306                                 /* do we need to add quotes ? */
1307                                 if (cmds[i].quotes && term_char != '"')
1308                                         g_string_append(matcherstr, "\"");
1309
1310                                 /* restore original character */
1311                                 *cmd_end = save_char;
1312
1313                                 break;
1314                         }
1315                 }
1316
1317                 if (*cmd_end)
1318                         cmd_end++;
1319                 cmd_start = cmd_end;
1320         }
1321
1322         g_free(copy_str);
1323
1324         /* return search string if no match is found to allow
1325            all available filtering expressions in quicksearch */
1326         if (matcherstr->len > 0) returnstr = matcherstr->str;
1327         else returnstr = g_strdup(search_string);
1328         g_string_free(matcherstr, FALSE);
1329         return returnstr;
1330 }
1331
1332 static gchar *expand_tag_search_string(const gchar *search_string)
1333 {
1334         gchar *newstr = NULL;
1335         gchar **words = search_string ? g_strsplit(search_string, " ", -1):NULL;
1336         gint i = 0;
1337         while (words && words[i] && *words[i]) {
1338                 g_strstrip(words[i]);
1339                 if (!newstr) {
1340                         newstr = g_strdup_printf("tag regexpcase \"%s\"", words[i]);
1341                 } else {
1342                         gint o_len = strlen(newstr);
1343                         gint s_len = 18; /* strlen("|tag regexpcase \"\"") */
1344                         gint n_len = s_len + strlen(words[i]);
1345                         newstr = g_realloc(newstr,o_len+n_len+1);
1346                         strcpy(newstr+o_len, "|tag regexpcase \"");
1347                         strcpy(newstr+o_len+(s_len-1), words[i]);
1348                         strcpy(newstr+o_len+(n_len-1), "\"");
1349                 }
1350                 i++;
1351         }
1352         g_strfreev(words);
1353         return newstr;
1354 }
1355
1356 static void quicksearch_set_running(QuickSearch *quicksearch, gboolean run)
1357 {
1358         quicksearch->running = run;
1359 }
1360
1361 gboolean quicksearch_is_running(QuickSearch *quicksearch)
1362 {
1363         return quicksearch->running;
1364 }
1365
1366 void quicksearch_pass_key(QuickSearch *quicksearch, guint val, GdkModifierType mod)
1367 {
1368         GtkEntry *entry = GTK_ENTRY(gtk_bin_get_child(GTK_BIN((quicksearch->search_string_entry))));
1369         glong curpos = gtk_editable_get_position(GTK_EDITABLE(entry));
1370         guint32 c;
1371         char *str = g_strdup(gtk_entry_get_text(entry));
1372         char *begin = str;
1373         char *end = NULL;
1374         char *new = NULL;
1375         char key[7] = "";
1376         guint char_len = 0;
1377
1378         if (gtk_editable_get_selection_bounds(GTK_EDITABLE(entry), NULL, NULL)) {
1379                 /* remove selection */
1380                 gtk_editable_delete_selection(GTK_EDITABLE(entry));
1381                 curpos = gtk_editable_get_position(GTK_EDITABLE(entry));
1382                 /* refresh string */
1383                 g_free(str);
1384                 str = g_strdup(gtk_entry_get_text(entry));
1385                 begin = str;
1386         }
1387
1388         if (!(c = gdk_keyval_to_unicode(val))) {
1389                 g_free(str);
1390                 return;
1391         }
1392         char_len = g_unichar_to_utf8(c, key);
1393         if (char_len < 0)
1394                 return;
1395         key[char_len] = '\0';
1396         if (curpos < g_utf8_strlen(str, -1)) {
1397                 gchar *stop = g_utf8_offset_to_pointer(begin, curpos);
1398                 end = g_strdup(g_utf8_offset_to_pointer(str, curpos));
1399                 *stop = '\0';
1400                 new = g_strdup_printf("%s%s%s", begin, key, end);
1401                 gtk_entry_set_text(entry, new);
1402                 g_free(end);
1403         } else {
1404                 new = g_strdup_printf("%s%s", begin, key);
1405                 gtk_entry_set_text(entry, new);
1406         }
1407         g_free(str);
1408         g_free(new);
1409         gtk_editable_set_position(GTK_EDITABLE(entry), curpos+1);
1410
1411 }
1412
1413 static gboolean quicksearch_match_subfolder(QuickSearch *quicksearch,
1414                                  FolderItem *src)
1415 {
1416         GSList *msglist = NULL;
1417         GSList *cur;
1418         gboolean result = FALSE;
1419         gint num = 0, total = 0;
1420         gint interval = quicksearch_is_fast(quicksearch) ? 5000:100;
1421
1422         statusbar_print_all(_("Searching in %s... \n"),
1423                 src->path ? src->path : "(null)");
1424                 
1425         msglist = folder_item_get_msg_list(src);
1426         total = src->total_msgs;
1427         folder_item_update_freeze();
1428         for (cur = msglist; cur != NULL; cur = cur->next) {
1429                 MsgInfo *msg = (MsgInfo *)cur->data;
1430                 statusbar_progress_all(num++,total, interval);
1431                 if (quicksearch_match(quicksearch, msg)) {
1432                         result = TRUE;
1433                         break;
1434                 }
1435                 if (num % interval == 0)
1436                         GTK_EVENTS_FLUSH();
1437                 if (!quicksearch_is_active(quicksearch))
1438                         break;
1439         }
1440         folder_item_update_thaw();
1441         statusbar_progress_all(0,0,0);
1442         statusbar_pop_all();
1443
1444         procmsg_msg_list_free(msglist);
1445         return result;
1446 }
1447
1448 gboolean quicksearch_is_in_subfolder(QuickSearch *quicksearch, FolderItem *cur)
1449 {
1450         if (quicksearch->root_folder_item == NULL)
1451                 return FALSE;
1452         
1453         while (cur) {
1454                 if (cur == quicksearch->root_folder_item) {
1455                         return TRUE;
1456                 }
1457                 cur = folder_item_parent(cur);
1458         }
1459         return FALSE;
1460 }
1461
1462 void quicksearch_search_subfolders(QuickSearch *quicksearch,
1463                                    FolderView *folderview,
1464                                    FolderItem *folder_item)
1465 {
1466         FolderItem *cur = NULL;
1467         GNode *node = folder_item->node->children;
1468
1469         if (!prefs_common.summary_quicksearch_recurse
1470         ||  quicksearch->in_typing == TRUE)
1471                 return;
1472
1473         for (; node != NULL; node = node->next) {
1474                 cur = FOLDER_ITEM(node->data);
1475                 if (quicksearch_match_subfolder(quicksearch, cur)) {
1476                         folderview_update_search_icon(cur, TRUE);
1477                 } else {
1478                         folderview_update_search_icon(cur, FALSE);
1479                 }
1480                 if (cur->node->children)
1481                         quicksearch_search_subfolders(quicksearch,
1482                                                       folderview,
1483                                                       cur);
1484         }
1485         quicksearch->root_folder_item = folder_item;
1486         if (!quicksearch_is_active(quicksearch))
1487                 quicksearch_reset_cur_folder_item(quicksearch);
1488 }
1489
1490 static void quicksearch_reset_folder_items(QuickSearch *quicksearch,
1491                                     FolderItem *folder_item)
1492 {
1493         FolderItem *cur = NULL;
1494         GNode *node = (folder_item && folder_item->node) ?
1495                         folder_item->node->children : NULL;
1496
1497         for (; node != NULL; node = node->next) {
1498                 cur = FOLDER_ITEM(node->data);
1499                 folderview_update_search_icon(cur, FALSE);
1500                 if (cur->node->children)
1501                         quicksearch_reset_folder_items(quicksearch,
1502                                                        cur);
1503         }
1504 }
1505
1506 void quicksearch_reset_cur_folder_item(QuickSearch *quicksearch)
1507 {
1508         if (quicksearch->root_folder_item)
1509                 quicksearch_reset_folder_items(quicksearch,
1510                                                quicksearch->root_folder_item);
1511
1512         quicksearch->root_folder_item = NULL;
1513 }
1514
1515 void quicksearch_folder_item_invalidate(QuickSearch *quicksearch, FolderItem *item)
1516 {
1517         if (quicksearch->root_folder_item == item)
1518                 quicksearch->root_folder_item = NULL;
1519 }
1520
1521 gboolean quicksearch_is_in_typing(QuickSearch *quicksearch)
1522 {
1523         return quicksearch->in_typing;
1524 }
1525
1526 void quicksearch_set_search_strings(QuickSearch *quicksearch)
1527 {
1528         GList *strings = prefs_common.summary_quicksearch_history;
1529         gchar *newstr = NULL;
1530         MatcherList *matcher_list = NULL;
1531
1532         if (!strings)
1533                 return;
1534
1535         matcher_parser_disable_warnings(TRUE);
1536         
1537         do {
1538                 newstr = expand_search_string((gchar *) strings->data);
1539                 if (newstr && newstr[0] != '\0') {
1540                         if (!strchr(newstr, ' ')) {
1541                                 quicksearch->normal_search_strings =
1542                                         g_list_append(
1543                                                 quicksearch->normal_search_strings,
1544                                                 g_strdup(strings->data));
1545                                 g_free(newstr);
1546                                 continue;
1547                         }
1548                         
1549                         matcher_list = matcher_parser_get_cond(newstr, FALSE);
1550                         g_free(newstr);
1551                         
1552                         if (matcher_list) {
1553                                 quicksearch->extended_search_strings =
1554                                         g_list_prepend(
1555                                                 quicksearch->extended_search_strings,
1556                                                 g_strdup(strings->data));
1557                                 matcherlist_free(matcher_list);
1558                         } else
1559                                 quicksearch->normal_search_strings =
1560                                         g_list_prepend(
1561                                                 quicksearch->normal_search_strings,
1562                                                 g_strdup(strings->data));
1563                 }
1564         
1565         } while ((strings = g_list_next(strings)) != NULL);
1566
1567         matcher_parser_disable_warnings(FALSE); 
1568
1569         quicksearch->normal_search_strings = g_list_reverse(quicksearch->normal_search_strings);
1570         quicksearch->extended_search_strings = g_list_reverse(quicksearch->extended_search_strings);
1571
1572         quicksearch_set_popdown_strings(quicksearch);
1573 }
1574
1575 /*
1576  * Searches in the supplied folderItem the messages (MessageInfo) matching a
1577  * QuickSearchType + search string (ex.: QUICK_SEARCH_FROM and "foo@bar.com").
1578  *
1579  * Found messages are appended to the array 'messages' and their ref.counts
1580  * are incremented by 1 --so they need to be released (procmsg_msginfo_free())
1581  * before the array 'messages' is freed.
1582  */
1583 void search_msgs_in_folder(GSList **messages, QuickSearch* quicksearch,
1584                            FolderItem* folderItem)
1585 {
1586         /* from quicksearch_match_subfolder */
1587         GSList *msglist = NULL;
1588         GSList *cur;
1589
1590         /* The list is built w/ MsgInfo items whose ref.counts are incremented,
1591            but they are decremented when the list is freed by
1592            procmsg_msg_list_free(): we'll  ask for a new ref., below
1593         */
1594         msglist = folder_item_get_msg_list(folderItem);
1595
1596         for (cur = msglist; cur != NULL; cur = cur->next) {
1597                 MsgInfo *msg = (MsgInfo *)cur->data;
1598                 if (quicksearch_match(quicksearch, msg)) {
1599                         /*debug_print("found: %s from:%s\n",procmsg_get_message_file_path(msg),msg->from);*/
1600                         *messages = g_slist_prepend(*messages, procmsg_msginfo_new_ref(msg));
1601                 }
1602                 /* See 2.0.0cvs140 ChangeLog entry for details
1603                    see also comments in quicksearch_match() */
1604                 if (quicksearch_from_gui(quicksearch)==TRUE
1605                     && !quicksearch_is_active(quicksearch))
1606                         break;
1607         }
1608         procmsg_msg_list_free(msglist);
1609 }
1610
1611 /*
1612  * Searches within the folderItem and its sub-folders (if recursive is TRUE)
1613  * the messages matching the search request.
1614  *
1615  * NB: search within a Folder can be done this way:
1616  *         search_msg_in_folders(messages, quicksearch, searchType,
1617  *                               FOLDER_ITEM(folder->node->data), TRUE);
1618  */
1619 void search_msgs_in_folders(GSList **messages, QuickSearch* quicksearch,
1620                             FolderItem* folderItem)
1621 {
1622         FolderItem *cur = NULL;
1623
1624         search_msgs_in_folder(messages, quicksearch, folderItem);
1625         if (quicksearch->request->recursive == FALSE)
1626                 return;
1627
1628         GNode *node = folderItem->node->children;
1629         for (; node != NULL; node = node->next) {
1630                 cur = FOLDER_ITEM(node->data);
1631                 debug_print("in: %s\n",cur->path);
1632                 if (cur->node->children)
1633                         search_msgs_in_folders(messages, quicksearch, cur);
1634                 else
1635                         search_msgs_in_folder(messages, quicksearch, cur);
1636         }
1637         *messages = g_slist_reverse(*messages);
1638 }
1639
1640  /*
1641   * Returns the QuickSearchType associated to the supplied string.
1642   */
1643 QuickSearchType quicksearch_type(const gchar* type)
1644 {
1645         QuickSearchType searchType = QUICK_SEARCH_EXTENDED;
1646         if (!type)
1647                 return searchType;
1648         switch(toupper(*type)) {
1649         case 'S':
1650                 searchType = QUICK_SEARCH_SUBJECT;
1651         break;
1652         case 'F':
1653                 searchType = QUICK_SEARCH_FROM;
1654         break;
1655         case 'T':
1656                 searchType = QUICK_SEARCH_TO;
1657         break;
1658         case 'E':
1659                 searchType = QUICK_SEARCH_EXTENDED;
1660         break;
1661         case 'M':
1662                 searchType = QUICK_SEARCH_MIXED;
1663         break;
1664         case 'G':
1665                 searchType = QUICK_SEARCH_TAG;
1666         break;
1667         }
1668         return searchType;
1669 }