src/gtk/quicksearch.c

   1 /*
   2  * Claws Mail -- a GTK+ based, lightweight, and fast e-mail client
   3  * Copyright (C) 1999-2011 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         FolderItem                      *folderItem;
  54         gboolean                         recursive;
  55 };
  56 typedef struct _QuickSearchRequest QuickSearchRequest;
  57
  58 struct _QuickSearch
  59 {
  60         GtkWidget                       *hbox_search;
  61         GtkWidget                       *search_type;
  62 #if !GTK_CHECK_VERSION(3, 0, 0)
  63         GtkWidget                       *search_type_opt;
  64 #endif
  65         GtkWidget                       *search_string_entry;
  66         GtkWidget                       *search_condition_expression;
  67         GtkWidget                       *search_description;
  68         GtkWidget                       *clear_search;
  69
  70         gboolean                         active;
  71         gchar                           *search_string;
  72         MatcherList                     *matcher_list;
  73
  74         QuickSearchRequest              *request;
  75         QuickSearchExecuteCallback       callback;
  76         gpointer                         callback_data;
  77         gboolean                         running;
  78         gboolean                         has_focus;
  79         gboolean                         matching;
  80         gboolean                         deferred_free;
  81         FolderItem                      *root_folder_item;
  82         gboolean                         is_fast;
  83         gboolean                         in_typing;
  84         guint                            press_timeout_id;
  85
  86         GList                           *normal_search_strings;
  87         GList                           *extended_search_strings;
  88
  89         /* dynamic and autorun qs settings are exclusive*/
  90         GtkWidget                        *dynamic_menuitem;
  91         GtkWidget                        *autorun_menuitem;
  92
  93         gboolean                        gui;
  94 };
  95
  96 static void quicksearch_set_running(QuickSearch *quicksearch, gboolean run);
  97 static void quicksearch_set_matchstring(QuickSearch *quicksearch, const gchar *matchstring);
  98 static void quicksearch_set_active(QuickSearch *quicksearch, gboolean active);
  99 static void quicksearch_reset_folder_items(QuickSearch *quicksearch, FolderItem *folder_item);
 100 static gchar *expand_search_string(const gchar *str);
 101 static gchar *expand_tag_search_string(const gchar *str);
 102
 103 static gboolean quicksearch_from_gui(QuickSearch *quicksearch)
 104 {
 105         return quicksearch->gui;
 106 }
 107
 108 gboolean quicksearch_is_fast(QuickSearch *quicksearch)
 109 {
 110         return quicksearch->is_fast;
 111 }
 112
 113 void quicksearch_set_recursive(QuickSearch *quicksearch, gboolean recursive)
 114 {
 115         quicksearch->request->recursive = recursive;
 116 }
 117
 118 static void quicksearch_set_type(QuickSearch *quicksearch, gint type)
 119 {
 120 #if !GTK_CHECK_VERSION(3, 0, 0)
 121         gint index;
 122         quicksearch->request->type = type;
 123         if (quicksearch->gui == FALSE)
 124                 return;
 125         index = menu_find_option_menu_index(GTK_CMOPTION_MENU(quicksearch->search_type_opt),
 126                                         GINT_TO_POINTER(type),
 127                                         NULL);
 128         gtk_cmoption_menu_set_history(GTK_CMOPTION_MENU(quicksearch->search_type_opt), index);
 129 #endif
 130 }
 131
 132 static gchar *quicksearch_get_text(QuickSearch * quicksearch)
 133 {
 134         gchar *search_string = gtk_editable_get_chars(GTK_EDITABLE(gtk_bin_get_child(GTK_BIN((quicksearch->search_string_entry)))), 0, -1);
 135
 136         g_strstrip(search_string);
 137         return search_string;
 138 }
 139
 140 static void quicksearch_set_popdown_strings(QuickSearch *quicksearch)
 141 {
 142         GtkWidget *search_string_entry = quicksearch->search_string_entry;
 143
 144         combobox_unset_popdown_strings(GTK_COMBO_BOX(search_string_entry));
 145
 146         if (prefs_common.summary_quicksearch_type == QUICK_SEARCH_EXTENDED)
 147                 combobox_set_popdown_strings(GTK_COMBO_BOX(search_string_entry),
 148                         quicksearch->extended_search_strings);
 149         else
 150                 combobox_set_popdown_strings(GTK_COMBO_BOX(search_string_entry),
 151                         quicksearch->normal_search_strings);
 152 }
 153
 154 static void prepare_matcher(QuickSearch *quicksearch)
 155 {
 156         /* param search_string is "matchstring" */
 157         const gchar *search_string;
 158         QuickSearchType quicksearch_type;
 159
 160         if (quicksearch == NULL)
 161                 return;
 162
 163         /* When called from the GUI, reset type and matchstring */
 164         if (quicksearch_from_gui(quicksearch)) {
 165                 gchar *s = quicksearch_get_text(quicksearch);
 166                 quicksearch_set_matchstring(quicksearch, s);
 167                 g_free(s);
 168                 quicksearch->request->type = prefs_common.summary_quicksearch_type;
 169         }
 170         quicksearch_type = quicksearch->request->type;
 171         search_string = quicksearch->request->matchstring;
 172
 173         if (search_string == NULL || search_string[0] == '\0') {
 174                 quicksearch_set_active(quicksearch, FALSE);
 175         }
 176
 177         if (quicksearch->matcher_list != NULL) {
 178                 if (quicksearch->matching) {
 179                         quicksearch->deferred_free = TRUE;
 180                         return;
 181                 }
 182                 quicksearch->deferred_free = FALSE;
 183                 matcherlist_free(quicksearch->matcher_list);
 184                 quicksearch->matcher_list = NULL;
 185         }
 186
 187         if (search_string == NULL || search_string[0] == '\0') {
 188                 return;
 189         }
 190         if (quicksearch_type == QUICK_SEARCH_EXTENDED) {
 191                 char *newstr = NULL;
 192
 193                 newstr = expand_search_string(search_string);
 194                 if (newstr && newstr[0] != '\0') {
 195                         quicksearch->matcher_list = matcher_parser_get_cond(newstr, &quicksearch->is_fast);
 196                         g_free(newstr);
 197                 } else {
 198                         quicksearch->matcher_list = NULL;
 199                         quicksearch_set_active(quicksearch, FALSE);
 200                         return;
 201                 }
 202         } else if (quicksearch_type == QUICK_SEARCH_TAG) {
 203                 char *newstr = expand_tag_search_string(search_string);
 204                 quicksearch->matcher_list = matcher_parser_get_cond(newstr, &quicksearch->is_fast);
 205                 g_free(newstr);
 206         } else if (quicksearch_type == QUICK_SEARCH_MIXED) {
 207                 char *newstr = expand_tag_search_string(search_string);
 208                 quicksearch->matcher_list = matcher_parser_get_cond(newstr, &quicksearch->is_fast);
 209                 g_free(newstr);
 210                 g_free(quicksearch->search_string);
 211                 quicksearch->search_string = g_utf8_casefold(search_string, -1);
 212         } else {
 213                 quicksearch->is_fast = TRUE;
 214                 g_free(quicksearch->search_string);
 215                 quicksearch->search_string = g_utf8_casefold(search_string, -1);
 216         }
 217         quicksearch_set_active(quicksearch, TRUE);
 218 }
 219
 220 static void update_extended_buttons (QuickSearch *quicksearch)
 221 {
 222         GtkWidget *expr_btn = quicksearch->search_condition_expression;
 223         GtkWidget *ext_btn = quicksearch->search_description;
 224
 225         cm_return_if_fail(expr_btn != NULL);
 226         cm_return_if_fail(ext_btn != NULL);
 227
 228         if (prefs_common.summary_quicksearch_type == QUICK_SEARCH_EXTENDED) {
 229                 gtk_widget_show(expr_btn);
 230                 gtk_widget_show(ext_btn);
 231         } else {
 232                 gtk_widget_hide(expr_btn);
 233                 gtk_widget_hide(ext_btn);
 234         }
 235 }
 236
 237 static gboolean searchbar_focus_evt_in(GtkWidget *widget, GdkEventFocus *event,
 238                                   QuickSearch *qs)
 239 {
 240         qs->has_focus = TRUE;
 241         return FALSE;
 242 }
 243
 244 static gboolean searchbar_focus_evt_out(GtkWidget *widget, GdkEventFocus *event,
 245                                   QuickSearch *qs)
 246 {
 247         qs->has_focus = FALSE;
 248         qs->in_typing = FALSE;
 249         return FALSE;
 250 }
 251
 252 gboolean quicksearch_has_focus(QuickSearch *quicksearch)
 253 {
 254         return quicksearch->has_focus;
 255 }
 256
 257 static void searchbar_run(QuickSearch *quicksearch, gboolean run_only_if_fast)
 258 {
 259         gchar *search_string = quicksearch_get_text(quicksearch);
 260         quicksearch_set_matchstring(quicksearch, search_string);
 261         prepare_matcher(quicksearch);
 262
 263         /* add to history, for extended search add only correct matching rules */
 264         if (!quicksearch->in_typing && search_string && strlen(search_string) != 0) {
 265                 switch (prefs_common.summary_quicksearch_type) {
 266                         case QUICK_SEARCH_EXTENDED:
 267                                 if (quicksearch->matcher_list) {
 268                                         quicksearch->extended_search_strings =
 269                                                 add_history(quicksearch->extended_search_strings,
 270                                                                 g_strdup(search_string));
 271                                         prefs_common.summary_quicksearch_history =
 272                                                 add_history(prefs_common.summary_quicksearch_history,
 273                                                                 g_strdup(search_string));
 274                                 }
 275                                 break;
 276                         default:
 277                                 quicksearch->normal_search_strings =
 278                                         add_history(quicksearch->normal_search_strings,
 279                                                         g_strdup(search_string));
 280                                 prefs_common.summary_quicksearch_history =
 281                                         add_history(prefs_common.summary_quicksearch_history,
 282                                                         g_strdup(search_string));
 283                                 break;
 284                 }
 285
 286                 quicksearch_set_popdown_strings(quicksearch);
 287
 288         }
 289
 290         if (run_only_if_fast && !quicksearch->is_fast) {
 291                 g_free(search_string);
 292                 return;
 293         }
 294         if (quicksearch->matcher_list == NULL &&
 295             prefs_common.summary_quicksearch_type == QUICK_SEARCH_EXTENDED &&
 296             search_string && strlen(search_string) != 0) {
 297                 g_free(search_string);
 298                 return;
 299         }
 300         quicksearch_set_running(quicksearch, TRUE);
 301         if (quicksearch->callback != NULL)
 302                 quicksearch->callback(quicksearch, quicksearch->callback_data);
 303         quicksearch_set_running(quicksearch, FALSE);
 304         g_free(search_string);
 305 }
 306
 307 static int searchbar_changed_timeout(void *data)
 308 {
 309         QuickSearch *qs = (QuickSearch *)data;
 310         if (qs && prefs_common.summary_quicksearch_dynamic) {
 311                 qs->in_typing = TRUE;
 312                 searchbar_run(qs, TRUE);
 313         }
 314         return FALSE;
 315 }
 316
 317 static void searchbar_changed_cb(GtkWidget *widget, QuickSearch *qs)
 318 {
 319         if (!qs->has_focus && prefs_common.summary_quicksearch_autorun) {
 320                 gtk_widget_grab_focus(qs->search_string_entry);
 321                 searchbar_run(qs, TRUE);
 322                 return;
 323         }
 324
 325         if (prefs_common.summary_quicksearch_dynamic) {
 326                 if (qs->press_timeout_id != -1) {
 327                         g_source_remove(qs->press_timeout_id);
 328                 }
 329                 qs->press_timeout_id = g_timeout_add(500,
 330                                 searchbar_changed_timeout, qs);
 331         }
 332
 333         if (!qs->has_focus)
 334                 gtk_widget_grab_focus(qs->search_string_entry);
 335 }
 336
 337 static gboolean searchbar_pressed(GtkWidget *widget, GdkEventKey *event,
 338                                   QuickSearch *quicksearch)
 339 {
 340         if (event && (event->keyval == GDK_KEY_Escape)) {
 341                 gchar *str;
 342
 343                 quicksearch->in_typing = FALSE;
 344
 345                 str = quicksearch_get_text(quicksearch);
 346                 cm_return_val_if_fail(str != NULL, TRUE);
 347
 348                 /* If the string entry is empty -> hide quicksearch bar. If not -> empty it */
 349                 if (!*str) {
 350                         summaryview_activate_quicksearch(
 351                                 mainwindow_get_mainwindow()->summaryview,
 352                                 FALSE);
 353                 } else {
 354                         quicksearch_set(quicksearch, prefs_common.summary_quicksearch_type, "");
 355                         gtk_widget_grab_focus(
 356                                         mainwindow_get_mainwindow()->summaryview->ctree);
 357                 }
 358                 g_free(str);
 359                 return TRUE;
 360         }
 361
 362         if (event != NULL && (event->keyval == GDK_KEY_Return || event->keyval == GDK_KEY_KP_Enter)) {
 363                 if (quicksearch->press_timeout_id != -1) {
 364                         g_source_remove(quicksearch->press_timeout_id);
 365                         quicksearch->press_timeout_id = -1;
 366                 }
 367                 quicksearch->in_typing = FALSE;
 368                 /* add expression to history list and exec quicksearch */
 369                 searchbar_run(quicksearch, FALSE);
 370
 371                 g_signal_stop_emission_by_name(G_OBJECT(widget), "key_press_event");
 372                 return TRUE;
 373         }
 374
 375         if (event && (event->keyval == GDK_KEY_Down || event->keyval == GDK_KEY_Up)) {
 376                 combobox_set_value_from_arrow_key(
 377                                 GTK_COMBO_BOX(quicksearch->search_string_entry),
 378                                 event->keyval);
 379                 return TRUE;
 380         }
 381
 382         return FALSE;
 383 }
 384
 385 static gboolean searchtype_changed(GtkMenuItem *widget, gpointer data)
 386 {
 387         QuickSearch *quicksearch = (QuickSearch *)data;
 388         gchar *search_string = quicksearch_get_text(quicksearch);
 389         quicksearch_set_matchstring(quicksearch, search_string);
 390
 391         prefs_common.summary_quicksearch_type = GPOINTER_TO_INT(g_object_get_data(
 392                                    G_OBJECT(GTK_MENU_ITEM(gtk_menu_get_active(
 393                                    GTK_MENU(quicksearch->search_type)))), MENU_VAL_ID));
 394
 395         /* Show extended search description button, only when Extended is selected */
 396         update_extended_buttons(quicksearch);
 397         quicksearch_set_popdown_strings(quicksearch);
 398
 399         if (!search_string || *(search_string) == 0) {
 400                 g_free(search_string);
 401                 return TRUE;
 402         }
 403
 404         prepare_matcher(quicksearch);
 405
 406         quicksearch_set_running(quicksearch, TRUE);
 407         if (quicksearch->callback != NULL)
 408                 quicksearch->callback(quicksearch, quicksearch->callback_data);
 409         quicksearch_set_running(quicksearch, FALSE);
 410         g_free(search_string);
 411         return TRUE;
 412 }
 413
 414 static gboolean searchtype_recursive_changed(GtkMenuItem *widget, gpointer data)
 415 {
 416         QuickSearch *quicksearch = (QuickSearch *)data;
 417         gboolean checked = gtk_check_menu_item_get_active(GTK_CHECK_MENU_ITEM(widget));
 418         gchar *search_string = quicksearch_get_text(quicksearch);
 419         /* not needed to quicksearch_set_matchstring(search_string);
 420            wait for prepare_matcher() */
 421
 422         prefs_common.summary_quicksearch_recurse = checked;
 423         quicksearch_set_recursive(quicksearch, checked);
 424
 425         /* reselect the search type */
 426         quicksearch_set_type(quicksearch, prefs_common.summary_quicksearch_type);
 427
 428         if (!search_string || *(search_string) == 0) {
 429                 g_free(search_string);
 430                 return TRUE;
 431         }
 432
 433         prepare_matcher(quicksearch);
 434
 435         quicksearch_set_running(quicksearch, TRUE);
 436         if (quicksearch->callback != NULL)
 437                 quicksearch->callback(quicksearch, quicksearch->callback_data);
 438         quicksearch_set_running(quicksearch, FALSE);
 439         g_free(search_string);
 440         return TRUE;
 441 }
 442
 443 static gboolean searchtype_sticky_changed(GtkMenuItem *widget, gpointer data)
 444 {
 445         QuickSearch *quicksearch = (QuickSearch *)data;
 446         gboolean checked = gtk_check_menu_item_get_active(GTK_CHECK_MENU_ITEM(widget));
 447
 448         prefs_common.summary_quicksearch_sticky = checked;
 449
 450         /* reselect the search type */
 451         quicksearch_set_type(quicksearch, prefs_common.summary_quicksearch_type);
 452
 453         return TRUE;
 454 }
 455
 456 static gboolean searchtype_dynamic_changed(GtkMenuItem *widget, gpointer data)
 457 {
 458         QuickSearch *quicksearch = (QuickSearch *)data;
 459         gboolean checked = gtk_check_menu_item_get_active(GTK_CHECK_MENU_ITEM(widget));
 460
 461         prefs_common.summary_quicksearch_dynamic = checked;
 462         if (checked)
 463                 gtk_check_menu_item_set_active(
 464                                 GTK_CHECK_MENU_ITEM(quicksearch->autorun_menuitem),
 465                                 FALSE);
 466
 467         /* reselect the search type */
 468         quicksearch_set_type(quicksearch, prefs_common.summary_quicksearch_type);
 469
 470         return TRUE;
 471 }
 472
 473 static gboolean searchtype_autorun_changed(GtkMenuItem *widget, gpointer data)
 474 {
 475         QuickSearch *quicksearch = (QuickSearch *)data;
 476         gboolean checked = gtk_check_menu_item_get_active(GTK_CHECK_MENU_ITEM(widget));
 477
 478         prefs_common.summary_quicksearch_autorun = checked;
 479         if (checked)
 480                 gtk_check_menu_item_set_active(
 481                                 GTK_CHECK_MENU_ITEM(quicksearch->dynamic_menuitem),
 482                                 FALSE);
 483
 484         /* reselect the search type */
 485         quicksearch_set_type(quicksearch, prefs_common.summary_quicksearch_type);
 486
 487         return TRUE;
 488 }
 489
 490 /*
 491  * Strings describing how to use Extended Search
 492  *
 493  * When adding new lines, remember to put 2 strings for each line
 494  */
 495 static gchar *search_descr_strings[] = {
 496         "a",     N_("all messages"),
 497         "ag #",  N_("messages whose age is greater than #"),
 498         "al #",  N_("messages whose age is less than #"),
 499         "b S",   N_("messages which contain S in the message body"),
 500         "B S",   N_("messages which contain S in the whole message"),
 501         "c S",   N_("messages carbon-copied to S"),
 502         "C S",   N_("message is either to: or cc: to S"),
 503         "D",     N_("deleted messages"), /** how I can filter deleted messages **/
 504         "e S",   N_("messages which contain S in the Sender field"),
 505         "E S",   N_("true if execute \"S\" succeeds"),
 506         "f S",   N_("messages originating from user S"),
 507         "F",     N_("forwarded messages"),
 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         CLAWS_TIP_DECL();
 699         GtkWidget *vbox;
 700
 701         quicksearch = quicksearch_new_nogui();
 702         quicksearch->gui = TRUE;
 703
 704         /* quick search */
 705         hbox_search = gtk_hbox_new(FALSE, 0);
 706
 707 #if !GTK_CHECK_VERSION(3, 0, 0)
 708         search_type_opt = gtk_cmoption_menu_new();
 709         gtk_widget_show(search_type_opt);
 710         gtk_box_pack_start(GTK_BOX(hbox_search), search_type_opt, FALSE, FALSE, 0);
 711 #endif
 712
 713         search_type = gtk_menu_new();
 714         MENUITEM_ADD (search_type, menuitem,
 715                         prefs_common_translated_header_name("Subject"), QUICK_SEARCH_SUBJECT);
 716         g_signal_connect(G_OBJECT(menuitem), "activate",
 717                          G_CALLBACK(searchtype_changed),
 718                          quicksearch);
 719         MENUITEM_ADD (search_type, menuitem,
 720                         prefs_common_translated_header_name("From"), QUICK_SEARCH_FROM);
 721         g_signal_connect(G_OBJECT(menuitem), "activate",
 722                          G_CALLBACK(searchtype_changed),
 723                          quicksearch);
 724         MENUITEM_ADD (search_type, menuitem,
 725                         prefs_common_translated_header_name("To"), QUICK_SEARCH_TO);
 726         g_signal_connect(G_OBJECT(menuitem), "activate",
 727                          G_CALLBACK(searchtype_changed),
 728                          quicksearch);
 729         MENUITEM_ADD (search_type, menuitem,
 730                         prefs_common_translated_header_name("Tag"), QUICK_SEARCH_TAG);
 731         g_signal_connect(G_OBJECT(menuitem), "activate",
 732                          G_CALLBACK(searchtype_changed),
 733                          quicksearch);
 734         MENUITEM_ADD (search_type, menuitem,
 735                         _("From/To/Subject/Tag"), QUICK_SEARCH_MIXED);
 736         g_signal_connect(G_OBJECT(menuitem), "activate",
 737                          G_CALLBACK(searchtype_changed),
 738                          quicksearch);
 739         MENUITEM_ADD (search_type, menuitem, _("Extended"), QUICK_SEARCH_EXTENDED);
 740         g_signal_connect(G_OBJECT(menuitem), "activate",
 741                          G_CALLBACK(searchtype_changed),
 742                          quicksearch);
 743
 744         gtk_menu_shell_append(GTK_MENU_SHELL(search_type), gtk_separator_menu_item_new());
 745
 746         menuitem = gtk_check_menu_item_new_with_label(_("Recursive"));
 747         gtk_menu_shell_append(GTK_MENU_SHELL(search_type), menuitem);
 748
 749         gtk_check_menu_item_set_active(GTK_CHECK_MENU_ITEM(menuitem),
 750                                         prefs_common.summary_quicksearch_recurse);
 751         quicksearch_set_recursive(quicksearch, prefs_common.summary_quicksearch_recurse);
 752         g_signal_connect(G_OBJECT(menuitem), "activate",
 753                          G_CALLBACK(searchtype_recursive_changed),
 754                          quicksearch);
 755
 756         menuitem = gtk_check_menu_item_new_with_label(_("Sticky"));
 757         gtk_menu_shell_append(GTK_MENU_SHELL(search_type), menuitem);
 758
 759         gtk_check_menu_item_set_active(GTK_CHECK_MENU_ITEM(menuitem),
 760                                         prefs_common.summary_quicksearch_sticky);
 761
 762         g_signal_connect(G_OBJECT(menuitem), "activate",
 763                          G_CALLBACK(searchtype_sticky_changed),
 764                          quicksearch);
 765
 766         menuitem = gtk_check_menu_item_new_with_label(_("Type-ahead"));
 767         gtk_menu_shell_append(GTK_MENU_SHELL(search_type), menuitem);
 768
 769         gtk_check_menu_item_set_active(GTK_CHECK_MENU_ITEM(menuitem),
 770                                         prefs_common.summary_quicksearch_dynamic);
 771
 772         quicksearch->dynamic_menuitem = menuitem;
 773
 774         g_signal_connect(G_OBJECT(menuitem), "activate",
 775                          G_CALLBACK(searchtype_dynamic_changed),
 776                          quicksearch);
 777
 778         menuitem = gtk_check_menu_item_new_with_label(_("Run on select"));
 779         gtk_menu_shell_append(GTK_MENU_SHELL(search_type), menuitem);
 780
 781         gtk_check_menu_item_set_active(GTK_CHECK_MENU_ITEM(menuitem),
 782                                         prefs_common.summary_quicksearch_autorun);
 783
 784         quicksearch->autorun_menuitem = menuitem;
 785
 786         g_signal_connect(G_OBJECT(menuitem), "activate",
 787                          G_CALLBACK(searchtype_autorun_changed),
 788                          quicksearch);
 789
 790 #if !GTK_CHECK_VERSION(3, 0, 0)
 791         gtk_cmoption_menu_set_menu(GTK_CMOPTION_MENU(search_type_opt), search_type);
 792
 793         quicksearch->search_type_opt = search_type_opt;
 794 #endif
 795         quicksearch_set_type(quicksearch, prefs_common.summary_quicksearch_type);
 796
 797         gtk_widget_show(search_type);
 798
 799         search_string_entry = gtk_combo_box_entry_new_text ();
 800         gtk_combo_box_set_active(GTK_COMBO_BOX(search_string_entry), -1);
 801
 802         vbox = gtk_vbox_new(TRUE, 0);
 803         gtk_box_pack_start(GTK_BOX(vbox), search_string_entry, FALSE, FALSE, 0);
 804         gtk_box_pack_start(GTK_BOX(hbox_search), vbox, TRUE, TRUE, 4);
 805
 806         gtk_widget_show(vbox);
 807         gtk_widget_show(search_string_entry);
 808
 809         search_hbox = gtk_hbox_new(FALSE, 5);
 810         clear_search = gtk_button_new_from_stock(GTK_STOCK_CLEAR);
 811         gtk_box_pack_start(GTK_BOX(search_hbox), clear_search,
 812                            FALSE, FALSE, 0);
 813         g_signal_connect(G_OBJECT(clear_search), "clicked",
 814                          G_CALLBACK(clear_search_cb), quicksearch);
 815         CLAWS_SET_TIP(clear_search,
 816                              _("Clear the current search"));
 817         gtk_widget_show(clear_search);
 818
 819         search_condition_expression = gtk_button_new_from_stock(GTK_STOCK_EDIT);
 820         gtk_box_pack_start(GTK_BOX(search_hbox), search_condition_expression,
 821                            FALSE, FALSE, 0);
 822         g_signal_connect(G_OBJECT (search_condition_expression), "clicked",
 823                          G_CALLBACK(search_condition_expr),
 824                          quicksearch);
 825         CLAWS_SET_TIP(search_condition_expression,
 826                              _("Edit search criteria"));
 827         gtk_widget_show(search_condition_expression);
 828
 829         search_description = gtk_button_new_from_stock(GTK_STOCK_INFO);
 830         gtk_box_pack_start(GTK_BOX(search_hbox), search_description,
 831                            FALSE, FALSE, 0);
 832         g_signal_connect(G_OBJECT(search_description), "clicked",
 833                          G_CALLBACK(search_description_cb), NULL);
 834         CLAWS_SET_TIP(search_description,
 835                              _("Information about extended symbols"));
 836         gtk_widget_show(search_description);
 837
 838         gtk_box_pack_start(GTK_BOX(hbox_search), search_hbox, FALSE, FALSE, 2);
 839         gtk_widget_show(search_hbox);
 840
 841         g_signal_connect(G_OBJECT(gtk_bin_get_child(GTK_BIN((search_string_entry)))),
 842                            "key_press_event",
 843                            G_CALLBACK(searchbar_pressed),
 844                            quicksearch);
 845
 846         g_signal_connect(G_OBJECT(gtk_bin_get_child(GTK_BIN((search_string_entry)))),
 847                          "changed",
 848                          G_CALLBACK(searchbar_changed_cb),
 849                          quicksearch);
 850
 851         g_signal_connect(G_OBJECT(gtk_bin_get_child(GTK_BIN((search_string_entry)))),
 852                          "focus_in_event",
 853                          G_CALLBACK(searchbar_focus_evt_in),
 854                          quicksearch);
 855         g_signal_connect(G_OBJECT(gtk_bin_get_child(GTK_BIN((search_string_entry)))),
 856                          "focus_out_event",
 857                          G_CALLBACK(searchbar_focus_evt_out),
 858                          quicksearch);
 859
 860         quicksearch->hbox_search = hbox_search;
 861         quicksearch->search_type = search_type;
 862         quicksearch->search_string_entry = search_string_entry;
 863         quicksearch->search_condition_expression = search_condition_expression;
 864         quicksearch->search_description = search_description;
 865         quicksearch->matcher_list = NULL;
 866         quicksearch->active = FALSE;
 867         quicksearch->running = FALSE;
 868         quicksearch->clear_search = clear_search;
 869         quicksearch->in_typing = FALSE;
 870         quicksearch->press_timeout_id = -1;
 871         quicksearch->normal_search_strings = NULL;
 872         quicksearch->extended_search_strings = NULL;
 873
 874         quicksearch_set_button(GTK_BUTTON(quicksearch->search_description), GTK_STOCK_INFO, _("_Information"));
 875         quicksearch_set_button(GTK_BUTTON(quicksearch->search_condition_expression), GTK_STOCK_EDIT, _("_Edit"));
 876         quicksearch_set_button(GTK_BUTTON(quicksearch->clear_search), GTK_STOCK_CLEAR, _("C_lear"));
 877
 878         update_extended_buttons(quicksearch);
 879
 880         return quicksearch;
 881 }
 882
 883 void quicksearch_relayout(QuickSearch *quicksearch)
 884 {
 885         switch (prefs_common.layout_mode) {
 886         case NORMAL_LAYOUT:
 887         case WIDE_LAYOUT:
 888         case WIDE_MSGLIST_LAYOUT:
 889                 quicksearch_set_button(GTK_BUTTON(quicksearch->search_description), GTK_STOCK_INFO, _("_Information"));
 890                 quicksearch_set_button(GTK_BUTTON(quicksearch->search_condition_expression), GTK_STOCK_EDIT, _("_Edit"));
 891                 quicksearch_set_button(GTK_BUTTON(quicksearch->clear_search), GTK_STOCK_CLEAR, _("C_lear"));
 892                 break;
 893         case SMALL_LAYOUT:
 894         case VERTICAL_LAYOUT:
 895                 quicksearch_set_button(GTK_BUTTON(quicksearch->search_description), GTK_STOCK_INFO, "");
 896                 quicksearch_set_button(GTK_BUTTON(quicksearch->search_condition_expression), GTK_STOCK_EDIT, "");
 897                 quicksearch_set_button(GTK_BUTTON(quicksearch->clear_search), GTK_STOCK_CLEAR, "");
 898                 break;
 899         }
 900 }
 901
 902 GtkWidget *quicksearch_get_widget(QuickSearch *quicksearch)
 903 {
 904         return quicksearch->hbox_search;
 905 }
 906
 907 void quicksearch_show(QuickSearch *quicksearch)
 908 {
 909         MainWindow *mainwin = mainwindow_get_mainwindow();
 910         GtkWidget *ctree = NULL;
 911         prepare_matcher(quicksearch);
 912         gtk_widget_show(quicksearch->hbox_search);
 913         update_extended_buttons(quicksearch);
 914         gtk_widget_grab_focus(
 915                 GTK_WIDGET(gtk_bin_get_child(GTK_BIN((quicksearch->search_string_entry)))));
 916
 917         GTK_EVENTS_FLUSH();
 918
 919         if (!mainwin || !mainwin->summaryview) {
 920                 return;
 921         }
 922
 923         ctree = summary_get_main_widget(mainwin->summaryview);
 924
 925         if (ctree && mainwin->summaryview->selected)
 926                 gtk_cmctree_node_moveto(GTK_CMCTREE(ctree),
 927                                 mainwin->summaryview->selected,
 928                                 0, 0.5, 0);
 929 }
 930
 931 void quicksearch_hide(QuickSearch *quicksearch)
 932 {
 933         if (quicksearch_is_active(quicksearch)) {
 934                 quicksearch_set(quicksearch, prefs_common.summary_quicksearch_type, "");
 935                 quicksearch_set_active(quicksearch, FALSE);
 936         }
 937         gtk_widget_hide(quicksearch->hbox_search);
 938 }
 939
 940 /*
 941  *\brief        Sets the matchstring.
 942  *
 943  *\param        quicksearch quicksearch to set
 944  *\param        matchstring the match string; it is duplicated, not stored
 945  */
 946 static void quicksearch_set_matchstring(QuickSearch *quicksearch,
 947                                         const gchar *matchstring)
 948 {
 949         g_free(quicksearch->request->matchstring);
 950         quicksearch->request->matchstring = g_strdup(matchstring);
 951 }
 952
 953 void quicksearch_set(QuickSearch *quicksearch, QuickSearchType type,
 954                      const gchar *matchstring)
 955 {
 956         quicksearch_set_type(quicksearch, type);
 957
 958         if (!matchstring || !(*matchstring))
 959                 quicksearch->in_typing = FALSE;
 960
 961         quicksearch_set_matchstring(quicksearch, matchstring);
 962
 963         if (!quicksearch_from_gui(quicksearch)) {
 964                 prepare_matcher(quicksearch);
 965                 /* no callback */
 966                 return;
 967         }
 968
 969         g_signal_handlers_block_by_func(G_OBJECT(gtk_bin_get_child(GTK_BIN((quicksearch->search_string_entry)))),
 970                                         G_CALLBACK(searchbar_changed_cb), quicksearch);
 971         gtk_entry_set_text(GTK_ENTRY(gtk_bin_get_child(GTK_BIN((quicksearch->search_string_entry)))),
 972                            matchstring);
 973         g_signal_handlers_unblock_by_func(G_OBJECT(gtk_bin_get_child(GTK_BIN((quicksearch->search_string_entry)))),
 974                                           G_CALLBACK(searchbar_changed_cb), quicksearch);
 975
 976         prefs_common.summary_quicksearch_type = type;
 977
 978         prepare_matcher(quicksearch);
 979
 980         quicksearch_set_running(quicksearch, TRUE);
 981         if (quicksearch->callback != NULL)
 982                 quicksearch->callback(quicksearch, quicksearch->callback_data);
 983         quicksearch_set_running(quicksearch, FALSE);
 984 }
 985
 986 gboolean quicksearch_is_active(QuickSearch *quicksearch)
 987 {
 988         return quicksearch->active &&
 989                 (prefs_common.summary_quicksearch_type != QUICK_SEARCH_EXTENDED
 990                  || quicksearch->matcher_list != NULL);
 991 }
 992
 993 static void quicksearch_set_active(QuickSearch *quicksearch, gboolean active)
 994 {
 995 #if !GTK_CHECK_VERSION(3, 0, 0)
 996         static GdkColor yellow;
 997         static GdkColor red;
 998         static GdkColor black;
 999         static gboolean colors_initialised = FALSE;
1000 #else
1001         static GdkColor yellow = { (guint32)0, (guint16)0xf5, (guint16)0xf6, (guint16)0xbe };
1002         static GdkColor red = { (guint32)0, (guint16)0xff, (guint16)0x70, (guint16)0x70 };
1003         static GdkColor black = { (guint32)0, (guint16)0x0, (guint16)0x0, (guint16)0x0 };
1004 #endif
1005         gboolean error = FALSE;
1006
1007
1008         quicksearch->active = active;
1009         if (quicksearch->gui == FALSE)
1010                 return;
1011
1012 #if !GTK_CHECK_VERSION(3, 0, 0)
1013         if (!colors_initialised) {
1014                 gdk_color_parse("#f5f6be", &yellow);
1015                 gdk_color_parse("#000000", &black);
1016                 gdk_color_parse("#ff7070", &red);
1017                 colors_initialised = gdk_colormap_alloc_color(
1018                         gdk_colormap_get_system(), &yellow, FALSE, TRUE);
1019                 colors_initialised &= gdk_colormap_alloc_color(
1020                         gdk_colormap_get_system(), &black, FALSE, TRUE);
1021                 colors_initialised &= gdk_colormap_alloc_color(
1022                         gdk_colormap_get_system(), &red, FALSE, TRUE);
1023         }
1024 #endif
1025
1026         if (active &&
1027                 (prefs_common.summary_quicksearch_type == QUICK_SEARCH_EXTENDED
1028                  && quicksearch->matcher_list == NULL))
1029                 error = TRUE;
1030
1031         if (active) {
1032                 gtk_widget_set_sensitive(quicksearch->clear_search, TRUE);
1033 #if !GTK_CHECK_VERSION(3, 0, 0)
1034                 if (colors_initialised) {
1035 #endif
1036                         gtk_widget_modify_base(
1037                                 gtk_bin_get_child(GTK_BIN((quicksearch->search_string_entry))),
1038                                 GTK_STATE_NORMAL, error ? &red : &yellow);
1039                         gtk_widget_modify_text(
1040                                 gtk_bin_get_child(GTK_BIN((quicksearch->search_string_entry))),
1041                                 GTK_STATE_NORMAL, &black);
1042 #if !GTK_CHECK_VERSION(3, 0, 0)
1043                 }
1044 #endif
1045         } else {
1046                 gtk_widget_set_sensitive(quicksearch->clear_search, FALSE);
1047                 if (colors_initialised) {
1048                         gtk_widget_modify_base(
1049                                 gtk_bin_get_child(GTK_BIN((quicksearch->search_string_entry))),
1050                                 GTK_STATE_NORMAL, NULL);
1051                         gtk_widget_modify_text(
1052                                 gtk_bin_get_child(GTK_BIN((quicksearch->search_string_entry))),
1053                                 GTK_STATE_NORMAL, NULL);
1054 #if !GTK_CHECK_VERSION(3, 0, 0)
1055                 }
1056 #endif
1057         }
1058
1059         if (!active) {
1060                 quicksearch_reset_cur_folder_item(quicksearch);
1061         }
1062 }
1063
1064 void quicksearch_set_execute_callback(QuickSearch *quicksearch,
1065                                       QuickSearchExecuteCallback callback,
1066                                       gpointer data)
1067 {
1068         quicksearch->callback = callback;
1069         quicksearch->callback_data = data;
1070 }
1071
1072 gboolean quicksearch_match(QuickSearch *quicksearch, MsgInfo *msginfo)
1073 {
1074         gchar *searched_header = NULL;
1075         gboolean result = FALSE;
1076         gchar *to = NULL, *from = NULL, *subject = NULL;
1077         QuickSearchType quicksearch_type;
1078
1079         if (!quicksearch->active)
1080                 return TRUE;
1081
1082         quicksearch_type = quicksearch->request->type;
1083
1084         switch (quicksearch_type) {
1085         case QUICK_SEARCH_SUBJECT:
1086                 if (msginfo->subject)
1087                         searched_header = g_utf8_casefold(msginfo->subject, -1);
1088                 else
1089                         return FALSE;
1090                 break;
1091         case QUICK_SEARCH_FROM:
1092                 if (msginfo->from)
1093                         searched_header = g_utf8_casefold(msginfo->from, -1);
1094                 else
1095                         return FALSE;
1096                 break;
1097         case QUICK_SEARCH_TO:
1098                 if (msginfo->to)
1099                         searched_header = g_utf8_casefold(msginfo->to, -1);
1100                 else
1101                         return FALSE;
1102                 break;
1103         case QUICK_SEARCH_MIXED:
1104                 if (msginfo->to)
1105                         to = g_utf8_casefold(msginfo->to, -1);
1106                 if (msginfo->from)
1107                         from = g_utf8_casefold(msginfo->from, -1);
1108                 if (msginfo->subject)
1109                         subject = g_utf8_casefold(msginfo->subject, -1);
1110                 break;
1111         case QUICK_SEARCH_EXTENDED:
1112                 break;
1113         default:
1114                 debug_print("unknown search type (%d)\n", quicksearch_type);
1115                 break;
1116         }
1117
1118         quicksearch->matching = TRUE;
1119         if (quicksearch_type != QUICK_SEARCH_EXTENDED &&
1120             quicksearch_type != QUICK_SEARCH_MIXED &&
1121             quicksearch_type != QUICK_SEARCH_TAG &&
1122             quicksearch->search_string &&
1123             searched_header && strstr(searched_header, quicksearch->search_string) != NULL)
1124                 result = TRUE;
1125         else if (quicksearch_type == QUICK_SEARCH_MIXED &&
1126                 quicksearch->search_string && (
1127                 (to && strstr(to, quicksearch->search_string) != NULL) ||
1128                 (from && strstr(from, quicksearch->search_string) != NULL) ||
1129                 (subject && strstr(subject, quicksearch->search_string) != NULL) ||
1130                 ((quicksearch->matcher_list != NULL) &&
1131                  matcherlist_match(quicksearch->matcher_list, msginfo))  ))
1132                 result = TRUE;
1133         else if ((quicksearch->matcher_list != NULL) &&
1134                  matcherlist_match(quicksearch->matcher_list, msginfo))
1135                 result = TRUE;
1136
1137         quicksearch->matching = FALSE;
1138         if (quicksearch_from_gui(quicksearch)==TRUE && quicksearch->deferred_free) {
1139                 /* Ref. http://lists.claws-mail.org/pipermail/users/2010-August/003063.html
1140                    See also 2.0.0cvs140 ChangeLog entry
1141                    and comment in search_msgs_in_folder() */
1142                 prepare_matcher(quicksearch);
1143         }
1144
1145         g_free(to);
1146         g_free(from);
1147         g_free(subject);
1148         g_free(searched_header);
1149
1150         return result;
1151 }
1152
1153 /* allow Mutt-like patterns in quick search */
1154 static gchar *expand_search_string(const gchar *search_string)
1155 {
1156         int i = 0;
1157         gchar term_char, save_char;
1158         gchar *cmd_start, *cmd_end;
1159         GString *matcherstr;
1160         gchar *returnstr = NULL;
1161         gchar *copy_str;
1162         gboolean casesens, dontmatch;
1163         /* list of allowed pattern abbreviations */
1164         struct {
1165                 gchar           *abbreviated;   /* abbreviation */
1166                 gchar           *command;       /* actual matcher command */
1167                 gint            numparams;      /* number of params for cmd */
1168                 gboolean        qualifier;      /* do we append regexpcase */
1169                 gboolean        quotes;         /* do we need quotes */
1170         }
1171         cmds[] = {
1172                 { "a",  "all",                          0,      FALSE,  FALSE },
1173                 { "ag", "age_greater",                  1,      FALSE,  FALSE },
1174                 { "al", "age_lower",                    1,      FALSE,  FALSE },
1175                 { "b",  "body_part",                    1,      TRUE,   TRUE  },
1176                 { "B",  "message",                      1,      TRUE,   TRUE  },
1177                 { "c",  "cc",                           1,      TRUE,   TRUE  },
1178                 { "C",  "to_or_cc",                     1,      TRUE,   TRUE  },
1179                 { "D",  "deleted",                      0,      FALSE,  FALSE },
1180                 { "e",  "header \"Sender\"",            1,      TRUE,   TRUE  },
1181                 { "E",  "execute",                      1,      FALSE,  TRUE  },
1182                 { "f",  "from",                         1,      TRUE,   TRUE  },
1183                 { "F",  "forwarded",                    0,      FALSE,  FALSE },
1184                 { "h",  "headers_part",                 1,      TRUE,   TRUE  },
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 gboolean quicksearch_is_in_typing(QuickSearch *quicksearch)
1516 {
1517         return quicksearch->in_typing;
1518 }
1519
1520 void quicksearch_set_search_strings(QuickSearch *quicksearch)
1521 {
1522         GList *strings = prefs_common.summary_quicksearch_history;
1523         gchar *newstr = NULL;
1524         MatcherList *matcher_list = NULL;
1525
1526         if (!strings)
1527                 return;
1528
1529         matcher_parser_disable_warnings(TRUE);
1530
1531         do {
1532                 newstr = expand_search_string((gchar *) strings->data);
1533                 if (newstr && newstr[0] != '\0') {
1534                         if (!strchr(newstr, ' ')) {
1535                                 quicksearch->normal_search_strings =
1536                                         g_list_append(
1537                                                 quicksearch->normal_search_strings,
1538                                                 g_strdup(strings->data));
1539                                 g_free(newstr);
1540                                 continue;
1541                         }
1542
1543                         matcher_list = matcher_parser_get_cond(newstr, FALSE);
1544                         g_free(newstr);
1545
1546                         if (matcher_list) {
1547                                 quicksearch->extended_search_strings =
1548                                         g_list_prepend(
1549                                                 quicksearch->extended_search_strings,
1550                                                 g_strdup(strings->data));
1551                                 matcherlist_free(matcher_list);
1552                         } else
1553                                 quicksearch->normal_search_strings =
1554                                         g_list_prepend(
1555                                                 quicksearch->normal_search_strings,
1556                                                 g_strdup(strings->data));
1557                 }
1558
1559         } while ((strings = g_list_next(strings)) != NULL);
1560
1561         matcher_parser_disable_warnings(FALSE);
1562
1563         quicksearch->normal_search_strings = g_list_reverse(quicksearch->normal_search_strings);
1564         quicksearch->extended_search_strings = g_list_reverse(quicksearch->extended_search_strings);
1565
1566         quicksearch_set_popdown_strings(quicksearch);
1567 }
1568
1569 /*
1570  * Searches in the supplied folderItem the messages (MessageInfo) matching a
1571  * QuickSearchType + search string (ex.: QUICK_SEARCH_FROM and "foo@bar.com").
1572  *
1573  * Found messages are appended to the array 'messages' and their ref.counts
1574  * are incremented by 1 --so they need to be released (procmsg_msginfo_free())
1575  * before the array 'messages' is freed.
1576  */
1577 void search_msgs_in_folder(GSList **messages, QuickSearch* quicksearch,
1578                            FolderItem* folderItem)
1579 {
1580         /* from quicksearch_match_subfolder */
1581         GSList *msglist = NULL;
1582         GSList *cur;
1583
1584         /* The list is built w/ MsgInfo items whose ref.counts are incremented,
1585            but they are decremented when the list is freed by
1586            procmsg_msg_list_free(): we'll  ask for a new ref., below
1587         */
1588         msglist = folder_item_get_msg_list(folderItem);
1589
1590         for (cur = msglist; cur != NULL; cur = cur->next) {
1591                 MsgInfo *msg = (MsgInfo *)cur->data;
1592                 if (quicksearch_match(quicksearch, msg)) {
1593                         /*debug_print("found: %s from:%s\n",procmsg_get_message_file_path(msg),msg->from);*/
1594                         *messages = g_slist_prepend(*messages, procmsg_msginfo_new_ref(msg));
1595                 }
1596                 /* See 2.0.0cvs140 ChangeLog entry for details
1597                    see also comments in quicksearch_match() */
1598                 if (quicksearch_from_gui(quicksearch)==TRUE
1599                     && !quicksearch_is_active(quicksearch))
1600                         break;
1601         }
1602         procmsg_msg_list_free(msglist);
1603 }
1604
1605 /*
1606  * Searches within the folderItem and its sub-folders (if recursive is TRUE)
1607  * the messages matching the search request.
1608  *
1609  * NB: search within a Folder can be done this way:
1610  *         search_msg_in_folders(messages, quicksearch, searchType,
1611  *                               FOLDER_ITEM(folder->node->data), TRUE);
1612  */
1613 void search_msgs_in_folders(GSList **messages, QuickSearch* quicksearch,
1614                             FolderItem* folderItem)
1615 {
1616         FolderItem *cur = NULL;
1617
1618         search_msgs_in_folder(messages, quicksearch, folderItem);
1619         if (quicksearch->request->recursive == FALSE)
1620                 return;
1621
1622         GNode *node = folderItem->node->children;
1623         for (; node != NULL; node = node->next) {
1624                 cur = FOLDER_ITEM(node->data);
1625                 debug_print("in: %s\n",cur->path);
1626                 if (cur->node->children)
1627                         search_msgs_in_folders(messages, quicksearch, cur);
1628                 else
1629                         search_msgs_in_folder(messages, quicksearch, cur);
1630         }
1631         *messages = g_slist_reverse(*messages);
1632 }
1633
1634  /*
1635   * Returns the QuickSearchType associated to the supplied string.
1636   */
1637 QuickSearchType quicksearch_type(const gchar* type)
1638 {
1639         QuickSearchType searchType = QUICK_SEARCH_EXTENDED;
1640         if (!type)
1641                 return searchType;
1642         switch(toupper(*type)) {
1643         case 'S':
1644                 searchType = QUICK_SEARCH_SUBJECT;
1645         break;
1646         case 'F':
1647                 searchType = QUICK_SEARCH_FROM;
1648         break;
1649         case 'T':
1650                 searchType = QUICK_SEARCH_TO;
1651         break;
1652         case 'E':
1653                 searchType = QUICK_SEARCH_EXTENDED;
1654         break;
1655         case 'M':
1656                 searchType = QUICK_SEARCH_MIXED;
1657         break;
1658         case 'G':
1659                 searchType = QUICK_SEARCH_TAG;
1660         break;
1661         }
1662         return searchType;
1663 }