2 * Sylpheed -- a GTK+ based, lightweight, and fast e-mail client
3 * Copyright (C) 2004 Hiroyuki Yamamoto & the Sylpheed-Claws team
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License
16 * along with this program; if not, write to the Free Software
17 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
25 #include <gdk/gdkkeysyms.h>
30 #include "prefs_common.h"
31 #include "description_window.h"
33 #include "matcher_parser.h"
34 #include "quicksearch.h"
38 GtkWidget *hbox_search;
39 GtkWidget *search_type;
40 GtkWidget *search_type_opt;
41 GtkWidget *search_string_entry;
42 GtkWidget *search_description;
46 MatcherList *matcher_list;
48 QuickSearchExecuteCallback callback;
49 gpointer callback_data;
52 static void prepare_matcher(QuickSearch *quicksearch)
54 gchar *search_string = gtk_entry_get_text(GTK_ENTRY(GTK_COMBO(quicksearch->search_string_entry)->entry));
56 if (quicksearch->matcher_list != NULL) {
57 matcherlist_free(quicksearch->matcher_list);
58 quicksearch->matcher_list = NULL;
61 if (search_string == NULL || search_string[0] == '\0') {
62 quicksearch->active = FALSE;
66 if (prefs_common.summary_quicksearch_type == QUICK_SEARCH_EXTENDED) {
69 newstr = expand_search_string(search_string);
70 if (newstr && newstr[0] != '\0') {
71 quicksearch->matcher_list = matcher_parser_get_cond(newstr);
74 quicksearch->matcher_list = NULL;
75 quicksearch->active = FALSE;
80 if (quicksearch->search_string != NULL)
81 g_free(quicksearch->search_string);
82 quicksearch->search_string = g_strdup(search_string);
85 quicksearch->active = TRUE;
88 static gint searchbar_pressed(GtkWidget *widget, GdkEventKey *event,
89 QuickSearch *quicksearch)
91 if (event != NULL && event->keyval == GDK_Return) {
92 gchar *search_string = gtk_entry_get_text(GTK_ENTRY(GTK_COMBO(quicksearch->search_string_entry)->entry));
94 if (search_string && strlen(search_string) != 0) {
95 prefs_common.summary_quicksearch_history =
96 add_history(prefs_common.summary_quicksearch_history,
98 gtk_combo_set_popdown_strings(GTK_COMBO(quicksearch->search_string_entry),
99 prefs_common.summary_quicksearch_history);
102 prepare_matcher(quicksearch);
104 if (quicksearch->callback != NULL)
105 quicksearch->callback(quicksearch, quicksearch->callback_data);
106 gtk_signal_emit_stop_by_name(GTK_OBJECT(widget), "key_press_event");
112 static void searchtype_changed(GtkMenuItem *widget, gpointer data)
114 QuickSearch *quicksearch = (QuickSearch *)data;
116 prefs_common.summary_quicksearch_type = GPOINTER_TO_INT(gtk_object_get_user_data(
117 GTK_OBJECT(GTK_MENU_ITEM(gtk_menu_get_active(
118 GTK_MENU(quicksearch->search_type))))));
120 /* Show extended search description button, only when Extended is selected */
121 if (prefs_common.summary_quicksearch_type == QUICK_SEARCH_EXTENDED) {
122 gtk_widget_show(quicksearch->search_description);
124 gtk_widget_hide(quicksearch->search_description);
128 prepare_matcher(quicksearch);
130 if (quicksearch->callback != NULL)
131 quicksearch->callback(quicksearch, quicksearch->callback_data);
135 * Strings describing how to use Extended Search
137 * When adding new lines, remember to put 2 strings for each line
139 static gchar *search_descr_strings[] = {
140 "a", N_("all messages"),
141 "ag #", N_("messages whose age is greater than #"),
142 "al #", N_("messages whose age is less than #"),
143 "b S", N_("messages which contain S in the message body"),
144 "B S", N_("messages which contain S in the whole message"),
145 "c S", N_("messages carbon-copied to S"),
146 "C S", N_("message is either to: or cc: to S"),
147 "D", N_("deleted messages"), /** how I can filter deleted messages **/
148 "e S", N_("messages which contain S in the Sender field"),
149 "E S", N_("true if execute \"S\" succeeds"),
150 "f S", N_("messages originating from user S"),
151 "F", N_("forwarded messages"),
152 "h S", N_("messages which contain header S"),
153 "i S", N_("messages which contain S in Message-Id header"),
154 "I S", N_("messages which contain S in inreplyto header"),
155 "L", N_("locked messages"),
156 "n S", N_("messages which are in newsgroup S"),
157 "N", N_("new messages"),
158 "O", N_("old messages"),
159 "r", N_("messages which have been replied to"),
160 "R", N_("read messages"),
161 "s S", N_("messages which contain S in subject"),
162 "se #", N_("messages whose score is equal to #"),
163 "sg #", N_("messages whose score is greater than #"),
164 "sl #", N_("messages whose score is lower than #"),
165 "Se #", N_("messages whose size is equal to #"),
166 "Sg #", N_("messages whose size is greater than #"),
167 "Ss #", N_("messages whose size is smaller than #"),
168 "t S", N_("messages which have been sent to S"),
169 "T", N_("marked messages"),
170 "U", N_("unread messages"),
171 "x S", N_("messages which contain S in References header"),
172 "X cmd", N_("messages returning 0 when passed to command"),
173 "y S", N_("messages which contain S in X-Label header"),
175 "&", N_("logical AND operator"),
176 "|", N_("logical OR operator"),
177 "! or ~", N_("logical NOT operator"),
178 "%", N_("case sensitive search"),
180 " ", N_("all filtering expressions are allowed"),
184 static DescriptionWindow search_descr = {
187 N_("Extended Search symbols"),
191 static void search_description_cb(GtkWidget *widget)
193 description_window_create(&search_descr);
197 static void summary_searchbar_focus_evt(GtkWidget *widget, GdkEventFocus *event,
198 SummaryView *summaryview)
200 if (event != NULL && event->in)
201 gtk_signal_handler_block_by_func(GTK_OBJECT(summaryview->mainwin->window),
202 GTK_SIGNAL_FUNC(mainwindow_key_pressed),
203 summaryview->mainwin);
205 gtk_signal_handler_unblock_by_func(GTK_OBJECT(summaryview->mainwin->window),
206 GTK_SIGNAL_FUNC(mainwindow_key_pressed),
207 summaryview->mainwin);
211 QuickSearch *quicksearch_new()
213 QuickSearch *quicksearch;
215 GtkWidget *hbox_search;
216 GtkWidget *search_type_opt;
217 GtkWidget *search_type;
218 GtkWidget *search_string_entry;
219 GtkWidget *search_hbbox;
220 GtkWidget *search_description;
223 quicksearch = g_new0(QuickSearch, 1);
226 hbox_search = gtk_hbox_new(FALSE, 0);
228 search_type_opt = gtk_option_menu_new();
229 gtk_widget_show(search_type_opt);
230 gtk_box_pack_start(GTK_BOX(hbox_search), search_type_opt, FALSE, FALSE, 0);
232 search_type = gtk_menu_new();
233 MENUITEM_ADD (search_type, menuitem, _("Subject"), QUICK_SEARCH_SUBJECT);
234 gtk_signal_connect(GTK_OBJECT(menuitem), "activate",
235 GTK_SIGNAL_FUNC(searchtype_changed),
237 MENUITEM_ADD (search_type, menuitem, _("From"), QUICK_SEARCH_FROM);
238 gtk_signal_connect(GTK_OBJECT(menuitem), "activate",
239 GTK_SIGNAL_FUNC(searchtype_changed),
241 MENUITEM_ADD (search_type, menuitem, _("To"), QUICK_SEARCH_TO);
242 gtk_signal_connect(GTK_OBJECT(menuitem), "activate",
243 GTK_SIGNAL_FUNC(searchtype_changed),
245 MENUITEM_ADD (search_type, menuitem, _("Extended"), QUICK_SEARCH_EXTENDED);
246 gtk_signal_connect(GTK_OBJECT(menuitem), "activate",
247 GTK_SIGNAL_FUNC(searchtype_changed),
250 gtk_option_menu_set_menu(GTK_OPTION_MENU(search_type_opt), search_type);
252 gtk_option_menu_set_history(GTK_OPTION_MENU(search_type_opt), prefs_common.summary_quicksearch_type);
254 gtk_widget_show(search_type);
256 search_string_entry = gtk_combo_new();
257 gtk_box_pack_start(GTK_BOX(hbox_search), search_string_entry, FALSE, FALSE, 2);
258 gtk_combo_set_value_in_list(GTK_COMBO(search_string_entry), FALSE, TRUE);
259 gtk_combo_set_case_sensitive(GTK_COMBO(search_string_entry), TRUE);
260 if (prefs_common.summary_quicksearch_history)
261 gtk_combo_set_popdown_strings(GTK_COMBO(search_string_entry),
262 prefs_common.summary_quicksearch_history);
263 gtk_entry_set_text(GTK_ENTRY(GTK_COMBO(search_string_entry)->entry), "");
264 gtk_widget_show(search_string_entry);
266 gtkut_button_set_create(&search_hbbox, &search_description, _("Extended Symbols"),
267 NULL, NULL, NULL, NULL);
268 gtk_signal_connect(GTK_OBJECT(search_description), "clicked",
269 GTK_SIGNAL_FUNC(search_description_cb), NULL);
270 gtk_box_pack_start(GTK_BOX(hbox_search), search_hbbox, FALSE, FALSE, 2);
271 gtk_widget_show(search_hbbox);
272 if (prefs_common.summary_quicksearch_type == QUICK_SEARCH_EXTENDED)
273 gtk_widget_show(search_description);
275 gtk_widget_hide(search_description);
277 gtk_signal_connect(GTK_OBJECT(GTK_COMBO(search_string_entry)->entry),
279 GTK_SIGNAL_FUNC(searchbar_pressed),
283 gtk_signal_connect(GTK_OBJECT(GTK_COMBO(search_string_entry)->entry),
285 GTK_SIGNAL_FUNC(searchbar_focus_evt),
288 gtk_signal_connect(GTK_OBJECT(GTK_COMBO(search_string_entry)->entry),
290 GTK_SIGNAL_FUNC(searchbar_focus_evt),
294 quicksearch->hbox_search = hbox_search;
295 quicksearch->search_type = search_type;
296 quicksearch->search_type_opt = search_type_opt;
297 quicksearch->search_string_entry = search_string_entry;
298 quicksearch->search_description = search_description;
299 quicksearch->matcher_list = NULL;
300 quicksearch->active = FALSE;
305 GtkWidget *quicksearch_get_widget(QuickSearch *quicksearch)
307 return quicksearch->hbox_search;
310 void quicksearch_show(QuickSearch *quicksearch)
312 prepare_matcher(quicksearch);
313 gtk_widget_show(quicksearch->hbox_search);
316 void quicksearch_hide(QuickSearch *quicksearch)
318 quicksearch->active = FALSE;
319 gtk_widget_hide(quicksearch->hbox_search);
322 void quicksearch_set(QuickSearch *quicksearch, QuickSearchType type,
323 const gchar *matchstring)
325 gtk_option_menu_set_history(GTK_OPTION_MENU(quicksearch->search_type_opt),
327 gtk_entry_set_text(GTK_ENTRY(GTK_COMBO(quicksearch->search_string_entry)->entry),
329 prefs_common.summary_quicksearch_type = type;
331 prepare_matcher(quicksearch);
333 if (quicksearch->callback != NULL)
334 quicksearch->callback(quicksearch, quicksearch->callback_data);
337 gboolean quicksearch_is_active(QuickSearch *quicksearch)
339 return quicksearch->active;
342 void quicksearch_set_execute_callback(QuickSearch *quicksearch,
343 QuickSearchExecuteCallback callback,
346 quicksearch->callback = callback;
347 quicksearch->callback_data = data;
350 gboolean quicksearch_match(QuickSearch *quicksearch, MsgInfo *msginfo)
352 gchar *searched_header = NULL;
354 if (!quicksearch->active)
357 switch (prefs_common.summary_quicksearch_type) {
358 case QUICK_SEARCH_SUBJECT:
359 searched_header = msginfo->subject;
361 case QUICK_SEARCH_FROM:
362 searched_header = msginfo->from;
364 case QUICK_SEARCH_TO:
365 searched_header = msginfo->to;
367 case QUICK_SEARCH_EXTENDED:
370 debug_print("unknown search type (%d)\n", prefs_common.summary_quicksearch_type);
374 if (prefs_common.summary_quicksearch_type != QUICK_SEARCH_EXTENDED && quicksearch->search_string &&
375 searched_header && strcasestr(searched_header, quicksearch->search_string) != NULL)
377 else if ((quicksearch->matcher_list != NULL) && matcherlist_match(quicksearch->matcher_list, msginfo))
383 /* allow Mutt-like patterns in quick search */
384 gchar *expand_search_string(const gchar *search_string)
387 gchar term_char, save_char;
388 gchar *cmd_start, *cmd_end;
390 gchar *returnstr = NULL;
392 gboolean casesens, dontmatch;
393 /* list of allowed pattern abbreviations */
395 gchar *abbreviated; /* abbreviation */
396 gchar *command; /* actual matcher command */
397 gint numparams; /* number of params for cmd */
398 gboolean qualifier; /* do we append regexpcase */
399 gboolean quotes; /* do we need quotes */
402 { "a", "all", 0, FALSE, FALSE },
403 { "ag", "age_greater", 1, FALSE, FALSE },
404 { "al", "age_lower", 1, FALSE, FALSE },
405 { "b", "body_part", 1, TRUE, TRUE },
406 { "B", "message", 1, TRUE, TRUE },
407 { "c", "cc", 1, TRUE, TRUE },
408 { "C", "to_or_cc", 1, TRUE, TRUE },
409 { "D", "deleted", 0, FALSE, FALSE },
410 { "e", "header \"Sender\"", 1, TRUE, TRUE },
411 { "E", "execute", 1, FALSE, TRUE },
412 { "f", "from", 1, TRUE, TRUE },
413 { "F", "forwarded", 0, FALSE, FALSE },
414 { "h", "headers_part", 1, TRUE, TRUE },
415 { "i", "header \"Message-Id\"", 1, TRUE, TRUE },
416 { "I", "inreplyto", 1, TRUE, TRUE },
417 { "L", "locked", 0, FALSE, FALSE },
418 { "n", "newsgroups", 1, TRUE, TRUE },
419 { "N", "new", 0, FALSE, FALSE },
420 { "O", "~new", 0, FALSE, FALSE },
421 { "r", "replied", 0, FALSE, FALSE },
422 { "R", "~unread", 0, FALSE, FALSE },
423 { "s", "subject", 1, TRUE, TRUE },
424 { "se", "score_equal", 1, FALSE, FALSE },
425 { "sg", "score_greater", 1, FALSE, FALSE },
426 { "sl", "score_lower", 1, FALSE, FALSE },
427 { "Se", "size_equal", 1, FALSE, FALSE },
428 { "Sg", "size_greater", 1, FALSE, FALSE },
429 { "Ss", "size_smaller", 1, FALSE, FALSE },
430 { "t", "to", 1, TRUE, TRUE },
431 { "T", "marked", 0, FALSE, FALSE },
432 { "U", "unread", 0, FALSE, FALSE },
433 { "x", "header \"References\"", 1, TRUE, TRUE },
434 { "X", "test", 1, FALSE, FALSE },
435 { "y", "header \"X-Label\"", 1, TRUE, TRUE },
436 { "&", "&", 0, FALSE, FALSE },
437 { "|", "|", 0, FALSE, FALSE },
438 { NULL, NULL, 0, FALSE, FALSE }
441 if (search_string == NULL)
444 copy_str = g_strdup(search_string);
446 matcherstr = g_string_sized_new(16);
447 cmd_start = copy_str;
448 while (cmd_start && *cmd_start) {
449 /* skip all white spaces */
450 while (*cmd_start && isspace((guchar)*cmd_start))
454 /* extract a command */
455 while (*cmd_end && !isspace((guchar)*cmd_end))
459 save_char = *cmd_end;
465 /* ~ and ! mean logical NOT */
466 if (*cmd_start == '~' || *cmd_start == '!')
471 /* % means case sensitive match */
472 if (*cmd_start == '%')
478 /* find matching abbreviation */
479 for (i = 0; cmds[i].command; i++) {
480 if (!strcmp(cmd_start, cmds[i].abbreviated)) {
481 /* restore character */
482 *cmd_end = save_char;
485 if (matcherstr->len > 0) {
486 g_string_append(matcherstr, " ");
489 g_string_append(matcherstr, "~");
490 g_string_append(matcherstr, cmds[i].command);
491 g_string_append(matcherstr, " ");
493 /* stop if no params required */
494 if (cmds[i].numparams == 0)
497 /* extract a parameter, allow quotes */
498 while (*cmd_end && isspace((guchar)*cmd_end))
502 if (*cmd_start == '"') {
509 /* extract actual parameter */
510 while ((*cmd_end) && (*cmd_end != term_char))
516 save_char = *cmd_end;
519 if (cmds[i].qualifier) {
521 g_string_append(matcherstr, "regexp ");
523 g_string_append(matcherstr, "regexpcase ");
526 /* do we need to add quotes ? */
527 if (cmds[i].quotes && term_char != '"')
528 g_string_append(matcherstr, "\"");
530 /* copy actual parameter */
531 g_string_append(matcherstr, cmd_start);
533 /* do we need to add quotes ? */
534 if (cmds[i].quotes && term_char != '"')
535 g_string_append(matcherstr, "\"");
537 /* restore original character */
538 *cmd_end = save_char;
551 /* return search string if no match is found to allow
552 all available filtering expressions in quicksearch */
553 if (matcherstr->len > 0) returnstr = matcherstr->str;
554 else returnstr = g_strdup(search_string);
556 g_string_free(matcherstr, FALSE);