src/gtk/quicksearch.c

   1 /*
   2  * Sylpheed -- a GTK+ based, lightweight, and fast e-mail client
   3  * Copyright (C) 2004 Hiroyuki Yamamoto & the Sylpheed-Claws 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 2 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, write to the Free Software
  17  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
  18  */
  19
  20 #ifdef HAVE_CONFIG_H
  21 #  include "config.h"
  22 #endif
  23
  24 #include <gtk/gtk.h>
  25 #include <gdk/gdkkeysyms.h>
  26
  27 #include "intl.h"
  28 #include "utils.h"
  29 #include "menu.h"
  30 #include "prefs_common.h"
  31 #include "description_window.h"
  32 #include "matcher.h"
  33 #include "matcher_parser.h"
  34 #include "quicksearch.h"
  35
  36 struct _QuickSearch
  37 {
  38         GtkWidget                       *hbox_search;
  39         GtkWidget                       *search_type;
  40         GtkWidget                       *search_type_opt;
  41         GtkWidget                       *search_string_entry;
  42         GtkWidget                       *search_description;
  43
  44         gboolean                         active;
  45         gchar                           *search_string;
  46         MatcherList                     *matcher_list;
  47
  48         QuickSearchExecuteCallback       callback;
  49         gpointer                         callback_data;
  50 };
  51
  52 static void prepare_matcher(QuickSearch *quicksearch)
  53 {
  54         gchar *search_string = gtk_entry_get_text(GTK_ENTRY(GTK_COMBO(quicksearch->search_string_entry)->entry));
  55
  56         if (quicksearch->matcher_list != NULL) {
  57                 matcherlist_free(quicksearch->matcher_list);
  58                 quicksearch->matcher_list = NULL;
  59         }
  60
  61         if (search_string == NULL || search_string[0] == '\0') {
  62                 quicksearch->active = FALSE;
  63                 return;
  64         }
  65
  66         if (prefs_common.summary_quicksearch_type == QUICK_SEARCH_EXTENDED) {
  67                 char *newstr = NULL;
  68
  69                 newstr = expand_search_string(search_string);
  70                 if (newstr && newstr[0] != '\0') {
  71                         quicksearch->matcher_list = matcher_parser_get_cond(newstr);
  72                         g_free(newstr);
  73                 } else {
  74                         quicksearch->matcher_list = NULL;
  75                         quicksearch->active = FALSE;
  76
  77                         return;
  78                 }
  79         } else {
  80                 if (quicksearch->search_string != NULL)
  81                         g_free(quicksearch->search_string);
  82                 quicksearch->search_string = g_strdup(search_string);
  83         }
  84
  85         quicksearch->active = TRUE;
  86 }
  87
  88 static gint searchbar_pressed(GtkWidget *widget, GdkEventKey *event,
  89                               QuickSearch *quicksearch)
  90 {
  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));
  93
  94                 if (search_string && strlen(search_string) != 0) {
  95                         prefs_common.summary_quicksearch_history =
  96                                 add_history(prefs_common.summary_quicksearch_history,
  97                                             search_string);
  98                         gtk_combo_set_popdown_strings(GTK_COMBO(quicksearch->search_string_entry),
  99                                 prefs_common.summary_quicksearch_history);
 100                 }
 101
 102                 prepare_matcher(quicksearch);
 103
 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");
 107         }
 108
 109         return TRUE;
 110 }
 111
 112 static void searchtype_changed(GtkMenuItem *widget, gpointer data)
 113 {
 114         QuickSearch *quicksearch = (QuickSearch *)data;
 115
 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))))));
 119
 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);
 123         } else {
 124                 gtk_widget_hide(quicksearch->search_description);
 125
 126         }
 127
 128         prepare_matcher(quicksearch);
 129
 130         if (quicksearch->callback != NULL)
 131                 quicksearch->callback(quicksearch, quicksearch->callback_data);
 132 }
 133
 134 /*
 135  * Strings describing how to use Extended Search
 136  *
 137  * When adding new lines, remember to put 2 strings for each line
 138  */
 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"),
 174          "",     "" ,
 175         "&",     N_("logical AND operator"),
 176         "|",     N_("logical OR operator"),
 177         "! or ~",       N_("logical NOT operator"),
 178         "%",     N_("case sensitive search"),
 179         NULL,    NULL
 180 };
 181
 182 static DescriptionWindow search_descr = {
 183         NULL,
 184         2,
 185         N_("Extended Search symbols"),
 186         search_descr_strings
 187 };
 188
 189 static void search_description_cb(GtkWidget *widget)
 190 {
 191         description_window_create(&search_descr);
 192 };
 193
 194 /*
 195 static void summary_searchbar_focus_evt(GtkWidget *widget, GdkEventFocus *event,
 196                                         SummaryView *summaryview)
 197 {
 198         if (event != NULL && event->in)
 199                 gtk_signal_handler_block_by_func(GTK_OBJECT(summaryview->mainwin->window),
 200                                                  GTK_SIGNAL_FUNC(mainwindow_key_pressed),
 201                                                  summaryview->mainwin);
 202         else
 203                 gtk_signal_handler_unblock_by_func(GTK_OBJECT(summaryview->mainwin->window),
 204                                                    GTK_SIGNAL_FUNC(mainwindow_key_pressed),
 205                                                    summaryview->mainwin);
 206 }
 207 */
 208
 209 QuickSearch *quicksearch_new()
 210 {
 211         QuickSearch *quicksearch;
 212
 213         GtkWidget *hbox_search;
 214         GtkWidget *search_type_opt;
 215         GtkWidget *search_type;
 216         GtkWidget *search_string_entry;
 217         GtkWidget *search_hbbox;
 218         GtkWidget *search_description;
 219         GtkWidget *menuitem;
 220
 221         quicksearch = g_new0(QuickSearch, 1);
 222
 223         /* quick search */
 224         hbox_search = gtk_hbox_new(FALSE, 0);
 225
 226         search_type_opt = gtk_option_menu_new();
 227         gtk_widget_show(search_type_opt);
 228         gtk_box_pack_start(GTK_BOX(hbox_search), search_type_opt, FALSE, FALSE, 0);
 229
 230         search_type = gtk_menu_new();
 231         MENUITEM_ADD (search_type, menuitem, _("Subject"), QUICK_SEARCH_SUBJECT);
 232         gtk_signal_connect(GTK_OBJECT(menuitem), "activate",
 233                            GTK_SIGNAL_FUNC(searchtype_changed),
 234                            quicksearch);
 235         MENUITEM_ADD (search_type, menuitem, _("From"), QUICK_SEARCH_FROM);
 236         gtk_signal_connect(GTK_OBJECT(menuitem), "activate",
 237                            GTK_SIGNAL_FUNC(searchtype_changed),
 238                            quicksearch);
 239         MENUITEM_ADD (search_type, menuitem, _("To"), QUICK_SEARCH_TO);
 240         gtk_signal_connect(GTK_OBJECT(menuitem), "activate",
 241                            GTK_SIGNAL_FUNC(searchtype_changed),
 242                            quicksearch);
 243         MENUITEM_ADD (search_type, menuitem, _("Extended"), QUICK_SEARCH_EXTENDED);
 244         gtk_signal_connect(GTK_OBJECT(menuitem), "activate",
 245                            GTK_SIGNAL_FUNC(searchtype_changed),
 246                            quicksearch);
 247
 248         gtk_option_menu_set_menu(GTK_OPTION_MENU(search_type_opt), search_type);
 249
 250         gtk_option_menu_set_history(GTK_OPTION_MENU(search_type_opt), prefs_common.summary_quicksearch_type);
 251
 252         gtk_widget_show(search_type);
 253
 254         search_string_entry = gtk_combo_new();
 255         gtk_box_pack_start(GTK_BOX(hbox_search), search_string_entry, FALSE, FALSE, 2);
 256         gtk_combo_set_value_in_list(GTK_COMBO(search_string_entry), FALSE, TRUE);
 257         gtk_combo_set_case_sensitive(GTK_COMBO(search_string_entry), TRUE);
 258         if (prefs_common.summary_quicksearch_history)
 259                 gtk_combo_set_popdown_strings(GTK_COMBO(search_string_entry),
 260                         prefs_common.summary_quicksearch_history);
 261         gtk_entry_set_text(GTK_ENTRY(GTK_COMBO(search_string_entry)->entry), "");
 262         gtk_widget_show(search_string_entry);
 263
 264         gtkut_button_set_create(&search_hbbox, &search_description, _("Extended Symbols"),
 265                                 NULL, NULL, NULL, NULL);
 266         gtk_signal_connect(GTK_OBJECT(search_description), "clicked",
 267                            GTK_SIGNAL_FUNC(search_description_cb), NULL);
 268         gtk_box_pack_start(GTK_BOX(hbox_search), search_hbbox, FALSE, FALSE, 2);
 269         gtk_widget_show(search_hbbox);
 270         if (prefs_common.summary_quicksearch_type == QUICK_SEARCH_EXTENDED)
 271                 gtk_widget_show(search_description);
 272         else
 273                 gtk_widget_hide(search_description);
 274
 275         gtk_signal_connect(GTK_OBJECT(GTK_COMBO(search_string_entry)->entry),
 276                            "key_press_event",
 277                            GTK_SIGNAL_FUNC(searchbar_pressed),
 278                            quicksearch);
 279
 280         /*
 281         gtk_signal_connect(GTK_OBJECT(GTK_COMBO(search_string_entry)->entry),
 282                            "focus_in_event",
 283                            GTK_SIGNAL_FUNC(searchbar_focus_evt),
 284                            quicksearch);
 285
 286         gtk_signal_connect(GTK_OBJECT(GTK_COMBO(search_string_entry)->entry),
 287                            "focus_out_event",
 288                            GTK_SIGNAL_FUNC(searchbar_focus_evt),
 289                            quicksearch);
 290         */
 291
 292         quicksearch->hbox_search = hbox_search;
 293         quicksearch->search_type = search_type;
 294         quicksearch->search_type_opt = search_type_opt;
 295         quicksearch->search_string_entry = search_string_entry;
 296         quicksearch->search_description = search_description;
 297         quicksearch->matcher_list = NULL;
 298         quicksearch->active = FALSE;
 299
 300         return quicksearch;
 301 }
 302
 303 GtkWidget *quicksearch_get_widget(QuickSearch *quicksearch)
 304 {
 305         return quicksearch->hbox_search;
 306 }
 307
 308 void quicksearch_show(QuickSearch *quicksearch)
 309 {
 310         prepare_matcher(quicksearch);
 311         gtk_widget_show(quicksearch->hbox_search);
 312 }
 313
 314 void quicksearch_hide(QuickSearch *quicksearch)
 315 {
 316         quicksearch->active = FALSE;
 317         gtk_widget_hide(quicksearch->hbox_search);
 318 }
 319
 320 void quicksearch_set(QuickSearch *quicksearch, QuickSearchType type,
 321                      const gchar *matchstring)
 322 {
 323         gtk_option_menu_set_history(GTK_OPTION_MENU(quicksearch->search_type_opt),
 324                                     type);
 325         gtk_entry_set_text(GTK_ENTRY(GTK_COMBO(quicksearch->search_string_entry)->entry),
 326                            matchstring);
 327         prefs_common.summary_quicksearch_type = type;
 328
 329         prepare_matcher(quicksearch);
 330
 331         if (quicksearch->callback != NULL)
 332                 quicksearch->callback(quicksearch, quicksearch->callback_data);
 333 }
 334
 335 gboolean quicksearch_is_active(QuickSearch *quicksearch)
 336 {
 337         return quicksearch->active;
 338 }
 339
 340 void quicksearch_set_execute_callback(QuickSearch *quicksearch,
 341                                       QuickSearchExecuteCallback callback,
 342                                       gpointer data)
 343 {
 344         quicksearch->callback = callback;
 345         quicksearch->callback_data = data;
 346 }
 347
 348 gboolean quicksearch_match(QuickSearch *quicksearch, MsgInfo *msginfo)
 349 {
 350         gchar *searched_header = NULL;
 351
 352         if (!quicksearch->active)
 353                 return TRUE;
 354
 355         switch (prefs_common.summary_quicksearch_type) {
 356         case QUICK_SEARCH_SUBJECT:
 357                 searched_header = msginfo->subject;
 358                 break;
 359         case QUICK_SEARCH_FROM:
 360                 searched_header = msginfo->from;
 361                 break;
 362         case QUICK_SEARCH_TO:
 363                 searched_header = msginfo->to;
 364                 break;
 365         case QUICK_SEARCH_EXTENDED:
 366                 break;
 367         default:
 368                 debug_print("unknown search type (%d)\n", prefs_common.summary_quicksearch_type);
 369                 break;
 370         }
 371
 372         if (prefs_common.summary_quicksearch_type != QUICK_SEARCH_EXTENDED && quicksearch->search_string &&
 373             searched_header && strcasestr(searched_header, quicksearch->search_string) != NULL)
 374                 return TRUE;
 375         else if ((quicksearch->matcher_list != NULL) && matcherlist_match(quicksearch->matcher_list, msginfo))
 376                 return TRUE;
 377
 378         return FALSE;
 379 }