src/gtk/quicksearch.c

   1 /*
   2  * Claws Mail -- a GTK+ based, lightweight, and fast e-mail client
   3  * Copyright (C) 1999-2012 Colin Leroy <colin@colino.net>
   4  * and the Claws Mail team
   5  *
   6  * This program is free software; you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License as published by
   8  * the Free Software Foundation; either version 3 of the License, or
   9  * (at your option) any later version.
  10  *
  11  * This program is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  * GNU General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License
  17  * along with this program. If not, see <http://www.gnu.org/licenses/>.
  18  *
  19  */
  20
  21 #ifdef HAVE_CONFIG_H
  22 #  include "config.h"
  23 #include "claws-features.h"
  24 #endif
  25
  26 #include <glib.h>
  27 #include <glib/gi18n.h>
  28 #include <ctype.h>
  29
  30 #include <gtk/gtk.h>
  31 #include <gdk/gdkkeysyms.h>
  32
  33 #if !GTK_CHECK_VERSION(3, 0, 0)
  34 #include "gtkcmoptionmenu.h"
  35 #endif
  36 #include "utils.h"
  37 #include "combobox.h"
  38 #include "menu.h"
  39 #include "prefs_common.h"
  40 #include "description_window.h"
  41 #include "matcher.h"
  42 #include "matcher_parser.h"
  43 #include "quicksearch.h"
  44 #include "folderview.h"
  45 #include "folder.h"
  46 #include "prefs_matcher.h"
  47 #include "claws.h"
  48 #include "statusbar.h"
  49 #include "advsearch.h"
  50 #include "alertpanel.h"
  51
  52 struct _QuickSearchRequest
  53 {
  54         AdvancedSearchType               type;
  55         gchar                           *matchstring;
  56 };
  57 typedef struct _QuickSearchRequest QuickSearchRequest;
  58
  59 struct _QuickSearch
  60 {
  61         GtkWidget                       *hbox_search;
  62         GtkWidget                       *search_type;
  63 #if !GTK_CHECK_VERSION(3, 0, 0)
  64         GtkWidget                       *search_type_opt;
  65 #endif
  66         GtkWidget                       *search_string_entry;
  67         GtkWidget                       *search_condition_expression;
  68         GtkWidget                       *search_description;
  69         GtkWidget                       *clear_search;
  70
  71         gboolean                         active;
  72         gchar                           *search_string;
  73
  74         QuickSearchRequest               request;
  75         QuickSearchExecuteCallback       callback;
  76         gpointer                         callback_data;
  77         gboolean                         running;
  78         gboolean                         has_focus;
  79         gboolean                         in_typing;
  80         guint                            press_timeout_id;
  81
  82         GList                           *normal_search_strings;
  83         GList                           *extended_search_strings;
  84
  85         /* dynamic and autorun qs settings are exclusive*/
  86         GtkWidget                        *dynamic_menuitem;
  87         GtkWidget                        *autorun_menuitem;
  88
  89         AdvancedSearch                  *asearch;
  90         gboolean                         want_reexec;
  91         gboolean                         want_history;
  92 };
  93
  94 void quicksearch_set_on_progress_cb(QuickSearch* search,
  95                 gboolean (*cb)(gpointer data, guint at, guint matched, guint total), gpointer data)
  96 {
  97         advsearch_set_on_progress_cb(search->asearch, cb, data);
  98 }
  99
 100 static void quicksearch_set_running(QuickSearch *quicksearch, gboolean run);
 101 static void quicksearch_set_matchstring(QuickSearch *quicksearch, const gchar *matchstring);
 102 static void quicksearch_set_active(QuickSearch *quicksearch, gboolean active);
 103 static void quicksearch_set_popdown_strings(QuickSearch *quicksearch);
 104
 105 static void quicksearch_add_to_history(QuickSearch* quicksearch)
 106 {
 107         gchar* search_string = quicksearch->request.matchstring;
 108
 109         /* add to history, for extended search add only correct matching rules */
 110         if (quicksearch->want_history && !quicksearch->in_typing && search_string && strlen(search_string) != 0) {
 111                 switch (prefs_common.summary_quicksearch_type) {
 112                         case ADVANCED_SEARCH_EXTENDED:
 113                                 if (advsearch_has_proper_predicate(quicksearch->asearch)) {
 114                                         quicksearch->extended_search_strings =
 115                                                 add_history(quicksearch->extended_search_strings,
 116                                                                 g_strdup(search_string));
 117                                         prefs_common.summary_quicksearch_history =
 118                                                 add_history(prefs_common.summary_quicksearch_history,
 119                                                                 g_strdup(search_string));
 120                                 }
 121                                 break;
 122                         default:
 123                                 quicksearch->normal_search_strings =
 124                                         add_history(quicksearch->normal_search_strings,
 125                                                         g_strdup(search_string));
 126                                 prefs_common.summary_quicksearch_history =
 127                                         add_history(prefs_common.summary_quicksearch_history,
 128                                                         g_strdup(search_string));
 129                                 break;
 130                 }
 131
 132                 quicksearch_set_popdown_strings(quicksearch);
 133         }
 134
 135         quicksearch->want_history = FALSE;
 136 }
 137
 138 static void quicksearch_invoke_execute(QuickSearch *quicksearch, gboolean run_only_if_fast)
 139 {
 140         if (quicksearch->running) {
 141                 quicksearch->want_reexec = TRUE;
 142                 advsearch_abort(quicksearch->asearch);
 143                 return;
 144         }
 145
 146         do {
 147                 gboolean active = quicksearch->request.matchstring != NULL
 148                                    && g_strcmp0(quicksearch->request.matchstring, "");
 149                 advsearch_set(quicksearch->asearch, quicksearch->request.type,
 150                                 quicksearch->request.matchstring);
 151
 152                 if (run_only_if_fast && !advsearch_is_fast(quicksearch->asearch))
 153                         return;
 154
 155                 quicksearch_add_to_history(quicksearch);
 156
 157                 quicksearch_set_active(quicksearch, active);
 158
 159                 quicksearch->want_reexec = FALSE;
 160                 quicksearch_set_running(quicksearch, TRUE);
 161                 if (quicksearch->callback != NULL)
 162                         quicksearch->callback(quicksearch, quicksearch->callback_data);
 163                 quicksearch_set_running(quicksearch, FALSE);
 164         } while (quicksearch->want_reexec);
 165 }
 166
 167 gboolean quicksearch_run_on_folder(QuickSearch* quicksearch, FolderItem *folderItem, MsgInfoList **result)
 168 {
 169         if (quicksearch_has_sat_predicate(quicksearch)) {
 170                 gboolean searchres;
 171                 main_window_cursor_wait(mainwindow_get_mainwindow());
 172                 searchres = advsearch_search_msgs_in_folders(quicksearch->asearch, result, folderItem, FALSE);
 173                 main_window_cursor_normal(mainwindow_get_mainwindow());
 174                 if (quicksearch->want_reexec) {
 175                         advsearch_set(quicksearch->asearch, quicksearch->request.type, "");
 176                 }
 177                 return searchres;
 178         } else
 179                 return FALSE;
 180 }
 181
 182 gboolean quicksearch_is_fast(QuickSearch *quicksearch)
 183 {
 184         return advsearch_is_fast(quicksearch->asearch);
 185 }
 186
 187 static void quicksearch_set_type(QuickSearch *quicksearch, gint type)
 188 {
 189 #if !GTK_CHECK_VERSION(3, 0, 0)
 190         gint index;
 191         quicksearch->request.type = type;
 192         index = menu_find_option_menu_index(GTK_CMOPTION_MENU(quicksearch->search_type_opt),
 193                                         GINT_TO_POINTER(type),
 194                                         NULL);
 195         gtk_cmoption_menu_set_history(GTK_CMOPTION_MENU(quicksearch->search_type_opt), index);
 196 #endif
 197 }
 198
 199 static gchar *quicksearch_get_text(QuickSearch * quicksearch)
 200 {
 201         gchar *search_string = gtk_editable_get_chars(GTK_EDITABLE(gtk_bin_get_child(GTK_BIN((quicksearch->search_string_entry)))), 0, -1);
 202
 203         g_strstrip(search_string);
 204         return search_string;
 205 }
 206
 207 static void quicksearch_set_popdown_strings(QuickSearch *quicksearch)
 208 {
 209         GtkWidget *search_string_entry = quicksearch->search_string_entry;
 210
 211         combobox_unset_popdown_strings(GTK_COMBO_BOX(search_string_entry));
 212
 213         if (prefs_common.summary_quicksearch_type == ADVANCED_SEARCH_EXTENDED)
 214                 combobox_set_popdown_strings(GTK_COMBO_BOX(search_string_entry),
 215                         quicksearch->extended_search_strings);
 216         else
 217                 combobox_set_popdown_strings(GTK_COMBO_BOX(search_string_entry),
 218                         quicksearch->normal_search_strings);
 219 }
 220
 221 static void update_extended_buttons (QuickSearch *quicksearch)
 222 {
 223         GtkWidget *expr_btn = quicksearch->search_condition_expression;
 224         GtkWidget *ext_btn = quicksearch->search_description;
 225
 226         cm_return_if_fail(expr_btn != NULL);
 227         cm_return_if_fail(ext_btn != NULL);
 228
 229         if (prefs_common.summary_quicksearch_type == ADVANCED_SEARCH_EXTENDED) {
 230                 gtk_widget_show(expr_btn);
 231                 gtk_widget_show(ext_btn);
 232         } else {
 233                 gtk_widget_hide(expr_btn);
 234                 gtk_widget_hide(ext_btn);
 235         }
 236 }
 237
 238 static gboolean searchbar_focus_evt_in(GtkWidget *widget, GdkEventFocus *event,
 239                                   QuickSearch *qs)
 240 {
 241         qs->has_focus = TRUE;
 242         return FALSE;
 243 }
 244
 245 static gboolean searchbar_focus_evt_out(GtkWidget *widget, GdkEventFocus *event,
 246                                   QuickSearch *qs)
 247 {
 248         qs->has_focus = FALSE;
 249         qs->in_typing = FALSE;
 250         return FALSE;
 251 }
 252
 253 gboolean quicksearch_has_focus(QuickSearch *quicksearch)
 254 {
 255         return quicksearch->has_focus;
 256 }
 257
 258 static void searchbar_run(QuickSearch *quicksearch, gboolean run_only_if_fast)
 259 {
 260         gchar *search_string = quicksearch_get_text(quicksearch);
 261         quicksearch_set_matchstring(quicksearch, search_string);
 262         g_free(search_string);
 263
 264         quicksearch->want_history = TRUE;
 265
 266         quicksearch_invoke_execute(quicksearch, run_only_if_fast);
 267 }
 268
 269 static int searchbar_changed_timeout(void *data)
 270 {
 271         QuickSearch *qs = (QuickSearch *)data;
 272         if (qs && prefs_common.summary_quicksearch_dynamic) {
 273                 qs->in_typing = TRUE;
 274                 searchbar_run(qs, TRUE);
 275         }
 276         return FALSE;
 277 }
 278
 279 static void searchbar_changed_cb(GtkWidget *widget, QuickSearch *qs)
 280 {
 281         if (!qs->has_focus && prefs_common.summary_quicksearch_autorun) {
 282                 gtk_widget_grab_focus(qs->search_string_entry);
 283                 searchbar_run(qs, TRUE);
 284                 return;
 285         }
 286
 287         if (prefs_common.summary_quicksearch_dynamic) {
 288                 if (qs->press_timeout_id != -1) {
 289                         g_source_remove(qs->press_timeout_id);
 290                 }
 291                 qs->press_timeout_id = g_timeout_add(500,
 292                                 searchbar_changed_timeout, qs);
 293         }
 294
 295         if (!qs->has_focus)
 296                 gtk_widget_grab_focus(qs->search_string_entry);
 297 }
 298
 299 static gboolean searchbar_pressed(GtkWidget *widget, GdkEventKey *event,
 300                                   QuickSearch *quicksearch)
 301 {
 302         if (event && (event->keyval == GDK_KEY_Escape)) {
 303                 gchar *str;
 304
 305                 quicksearch->in_typing = FALSE;
 306
 307                 str = quicksearch_get_text(quicksearch);
 308                 cm_return_val_if_fail(str != NULL, TRUE);
 309
 310                 /* If the string entry is empty -> hide quicksearch bar. If not -> empty it */
 311                 if (!*str) {
 312                         summaryview_activate_quicksearch(
 313                                 mainwindow_get_mainwindow()->summaryview,
 314                                 FALSE);
 315                 } else {
 316                         quicksearch_set(quicksearch, prefs_common.summary_quicksearch_type, "");
 317                         gtk_widget_grab_focus(
 318                                         mainwindow_get_mainwindow()->summaryview->ctree);
 319                 }
 320                 g_free(str);
 321                 return TRUE;
 322         }
 323
 324         if (event != NULL && (event->keyval == GDK_KEY_Return || event->keyval == GDK_KEY_KP_Enter)) {
 325                 if (quicksearch->press_timeout_id != -1) {
 326                         g_source_remove(quicksearch->press_timeout_id);
 327                         quicksearch->press_timeout_id = -1;
 328                 }
 329                 quicksearch->in_typing = FALSE;
 330                 /* add expression to history list and exec quicksearch */
 331                 searchbar_run(quicksearch, FALSE);
 332
 333                 g_signal_stop_emission_by_name(G_OBJECT(widget), "key_press_event");
 334                 return TRUE;
 335         }
 336
 337         if (event && (event->keyval == GDK_KEY_Down || event->keyval == GDK_KEY_Up)) {
 338                 combobox_set_value_from_arrow_key(
 339                                 GTK_COMBO_BOX(quicksearch->search_string_entry),
 340                                 event->keyval);
 341                 return TRUE;
 342         }
 343
 344         return FALSE;
 345 }
 346
 347 static gboolean searchtype_changed(GtkMenuItem *widget, gpointer data)
 348 {
 349         QuickSearch *quicksearch = (QuickSearch *)data;
 350
 351         prefs_common.summary_quicksearch_type = GPOINTER_TO_INT(g_object_get_data(
 352                                    G_OBJECT(GTK_MENU_ITEM(gtk_menu_get_active(
 353                                    GTK_MENU(quicksearch->search_type)))), MENU_VAL_ID));
 354         quicksearch->request.type = prefs_common.summary_quicksearch_type;
 355
 356         /* Show extended search description button, only when Extended is selected */
 357         update_extended_buttons(quicksearch);
 358         quicksearch_set_popdown_strings(quicksearch);
 359
 360         quicksearch_invoke_execute(quicksearch, FALSE);
 361
 362         return TRUE;
 363 }
 364
 365 static gboolean searchtype_recursive_changed(GtkMenuItem *widget, gpointer data)
 366 {
 367         QuickSearch *quicksearch = (QuickSearch *)data;
 368         gboolean checked = gtk_check_menu_item_get_active(GTK_CHECK_MENU_ITEM(widget));
 369
 370         prefs_common.summary_quicksearch_recurse = checked;
 371
 372         /* reselect the search type */
 373         quicksearch_set_type(quicksearch, prefs_common.summary_quicksearch_type);
 374
 375         quicksearch_invoke_execute(quicksearch, FALSE);
 376
 377         return TRUE;
 378 }
 379
 380 static gboolean searchtype_sticky_changed(GtkMenuItem *widget, gpointer data)
 381 {
 382         QuickSearch *quicksearch = (QuickSearch *)data;
 383         gboolean checked = gtk_check_menu_item_get_active(GTK_CHECK_MENU_ITEM(widget));
 384
 385         prefs_common.summary_quicksearch_sticky = checked;
 386
 387         /* reselect the search type */
 388         quicksearch_set_type(quicksearch, prefs_common.summary_quicksearch_type);
 389
 390         return TRUE;
 391 }
 392
 393 static gboolean searchtype_dynamic_changed(GtkMenuItem *widget, gpointer data)
 394 {
 395         QuickSearch *quicksearch = (QuickSearch *)data;
 396         gboolean checked = gtk_check_menu_item_get_active(GTK_CHECK_MENU_ITEM(widget));
 397
 398         prefs_common.summary_quicksearch_dynamic = checked;
 399         if (checked)
 400                 gtk_check_menu_item_set_active(
 401                                 GTK_CHECK_MENU_ITEM(quicksearch->autorun_menuitem),
 402                                 FALSE);
 403
 404         /* reselect the search type */
 405         quicksearch_set_type(quicksearch, prefs_common.summary_quicksearch_type);
 406
 407         return TRUE;
 408 }
 409
 410 static gboolean searchtype_autorun_changed(GtkMenuItem *widget, gpointer data)
 411 {
 412         QuickSearch *quicksearch = (QuickSearch *)data;
 413         gboolean checked = gtk_check_menu_item_get_active(GTK_CHECK_MENU_ITEM(widget));
 414
 415         prefs_common.summary_quicksearch_autorun = checked;
 416         if (checked)
 417                 gtk_check_menu_item_set_active(
 418                                 GTK_CHECK_MENU_ITEM(quicksearch->dynamic_menuitem),
 419                                 FALSE);
 420
 421         /* reselect the search type */
 422         quicksearch_set_type(quicksearch, prefs_common.summary_quicksearch_type);
 423
 424         return TRUE;
 425 }
 426
 427 /*
 428  * Strings describing how to use Extended Search
 429  *
 430  * When adding new lines, remember to put 2 strings for each line
 431  */
 432 static gchar *search_descr_strings[] = {
 433         "a",     N_("all messages"),
 434         "ag #",  N_("messages whose age is greater than # days"),
 435         "al #",  N_("messages whose age is less than # days"),
 436         "agh #",  N_("messages whose age is greater than # hours"),
 437         "alh #",  N_("messages whose age is less than # hours"),
 438         "b S",   N_("messages which contain S in the message body"),
 439         "B S",   N_("messages which contain S in the whole message"),
 440         "c S",   N_("messages carbon-copied to S"),
 441         "C S",   N_("message is either to: or cc: to S"),
 442         "D",     N_("deleted messages"), /** how I can filter deleted messages **/
 443         "e S",   N_("messages which contain S in the Sender field"),
 444         "E S",   N_("true if execute \"S\" succeeds"),
 445         "f S",   N_("messages originating from user S"),
 446         "F",     N_("forwarded messages"),
 447         "ha",    N_("messages which have attachments"),
 448         "h S",   N_("messages which contain header S"),
 449         "i S",   N_("messages which contain S in Message-ID header"),
 450         "I S",   N_("messages which contain S in In-Reply-To header"),
 451         "k #",   N_("messages which are marked with color #"),
 452         "L",     N_("locked messages"),
 453         "n S",   N_("messages which are in newsgroup S"),
 454         "N",     N_("new messages"),
 455         "O",     N_("old messages"),
 456         "p",     N_("incomplete messages (not entirely downloaded)"),
 457         "r",     N_("messages which have been replied to"),
 458         "R",     N_("read messages"),
 459         "s S",   N_("messages which contain S in subject"),
 460         "se #",  N_("messages whose score is equal to # points"),
 461         "sg #",  N_("messages whose score is greater than # points"),
 462         "sl #",  N_("messages whose score is lower than # points"),
 463         "Se #",  N_("messages whose size is equal to # bytes"),
 464         "Sg #",  N_("messages whose size is greater than # bytes"),
 465         "Ss #",  N_("messages whose size is smaller than # bytes"),
 466         "t S",   N_("messages which have been sent to S"),
 467         "tg S",  N_("messages which tags contain S"),
 468         "tagged",N_("messages which have tag(s)"),
 469         "T",     N_("marked messages"),
 470         "U",     N_("unread messages"),
 471         "x S",   N_("messages which contain S in References header"),
 472         "X \"cmd args\"", N_("messages returning 0 when passed to command - %F is message file"),
 473         "y S",   N_("messages which contain S in X-Label header"),
 474         "",      "" ,
 475         "&amp;",         N_("logical AND operator"),
 476         "|",     N_("logical OR operator"),
 477         "! or ~",       N_("logical NOT operator"),
 478         "%",     N_("case sensitive search"),
 479         "#",     N_("match using regular expressions instead of substring search"),
 480         "",      "" ,
 481         " ",     N_("all filtering expressions are allowed"),
 482         NULL,    NULL
 483 };
 484
 485 static DescriptionWindow search_descr = {
 486         NULL,
 487         NULL,
 488         FALSE,
 489         2,
 490         N_("Extended Search"),
 491         N_("Extended Search allows the user to define criteria that messages must "
 492            "have in order to match and be displayed in the message list.\n"
 493            "The following symbols can be used:"),
 494         search_descr_strings
 495 };
 496
 497 static void search_description_cb(GtkWidget *widget)
 498 {
 499         search_descr.parent = mainwindow_get_mainwindow()->window;
 500         description_window_create(&search_descr);
 501 };
 502
 503 static gboolean clear_search_cb(GtkMenuItem *widget, gpointer data)
 504 {
 505         QuickSearch *quicksearch = (QuickSearch *)data;
 506
 507         if (!quicksearch->active)
 508                 return TRUE;
 509
 510         quicksearch_set(quicksearch, prefs_common.summary_quicksearch_type, "");
 511
 512         return TRUE;
 513 };
 514
 515 static void search_condition_expr_done(MatcherList * matchers)
 516 {
 517         gchar *str;
 518
 519         cm_return_if_fail(
 520                         mainwindow_get_mainwindow()->summaryview->quicksearch != NULL);
 521
 522         if (matchers == NULL)
 523                 return;
 524
 525         str = matcherlist_to_string(matchers);
 526
 527         if (str != NULL) {
 528                 quicksearch_set(mainwindow_get_mainwindow()->summaryview->quicksearch,
 529                                 prefs_common.summary_quicksearch_type, str);
 530                 g_free(str);
 531
 532                 /* add expression to history list and exec quicksearch */
 533                 searchbar_run(mainwindow_get_mainwindow()->summaryview->quicksearch, FALSE);
 534         }
 535 }
 536
 537 static gboolean search_condition_expr(GtkMenuItem *widget, gpointer data)
 538 {
 539         gchar * cond_str;
 540         MatcherList * matchers = NULL;
 541
 542         cm_return_val_if_fail(
 543                         mainwindow_get_mainwindow()->summaryview->quicksearch != NULL,
 544                         FALSE);
 545
 546         /* re-use the current quicksearch value if it's a condition expression,
 547            otherwise ignore it silently */
 548         cond_str = quicksearch_get_text(mainwindow_get_mainwindow()->summaryview->quicksearch);
 549
 550         if (*cond_str != '\0') {
 551                 matchers = matcher_parser_get_cond((gchar*)cond_str, NULL);
 552         }
 553
 554         prefs_matcher_open(matchers, search_condition_expr_done);
 555
 556         if (matchers != NULL)
 557                 matcherlist_free(matchers);
 558
 559         g_free(cond_str);
 560
 561         return TRUE;
 562 };
 563
 564 static void quicksearch_set_button(GtkButton *button, const gchar *icon, const gchar *text)
 565 {
 566         GList *children = gtk_container_get_children(GTK_CONTAINER(button));
 567         GList *cur;
 568         GtkWidget *box;
 569         gboolean icon_visible;
 570
 571         g_object_get(gtk_settings_get_default(),
 572                                          "gtk-button-images", &icon_visible,
 573                                          NULL);
 574
 575         for (cur = children; cur; cur = cur->next)
 576                 gtk_container_remove(GTK_CONTAINER(button), GTK_WIDGET(cur->data));
 577
 578         g_list_free(children);
 579         box = gtk_hbox_new(FALSE, 0);
 580
 581         gtk_container_add(GTK_CONTAINER(button), box);
 582         if (icon_visible || !text || !*text)
 583                 gtk_box_pack_start(GTK_BOX(box), gtk_image_new_from_stock(icon,
 584                         GTK_ICON_SIZE_BUTTON), FALSE, FALSE, 0);
 585         gtk_box_pack_start(GTK_BOX(box), gtk_label_new_with_mnemonic(text), FALSE, FALSE, 0);
 586         gtk_widget_show_all(box);
 587 }
 588
 589 static void quicksearch_error(gpointer data)
 590 {
 591         alertpanel_error(_("Something went wrong during search. Please check your logs."));
 592 }
 593
 594 QuickSearch *quicksearch_new()
 595 {
 596         QuickSearch *quicksearch;
 597
 598         GtkWidget *hbox_search;
 599 #if !GTK_CHECK_VERSION(3, 0, 0)
 600         GtkWidget *search_type_opt;
 601 #endif
 602         GtkWidget *search_type;
 603         GtkWidget *search_string_entry;
 604         GtkWidget *search_hbox;
 605         GtkWidget *search_description;
 606         GtkWidget *clear_search;
 607         GtkWidget *search_condition_expression;
 608         GtkWidget *menuitem;
 609         GtkWidget *vbox;
 610
 611         quicksearch = g_new0(QuickSearch, 1);
 612
 613         quicksearch->asearch = advsearch_new();
 614         advsearch_set_on_error_cb(quicksearch->asearch, quicksearch_error, NULL);
 615
 616         /* init. values initally found in quicksearch_new().
 617            There's no need to init. all pointers to NULL since we use g_new0
 618          */
 619         quicksearch->active = FALSE;
 620         quicksearch->running = FALSE;
 621         quicksearch->in_typing = FALSE;
 622         quicksearch->press_timeout_id = -1;
 623         quicksearch->normal_search_strings = NULL;
 624         quicksearch->extended_search_strings = NULL;
 625
 626         /* quick search */
 627         hbox_search = gtk_hbox_new(FALSE, 0);
 628
 629 #if !GTK_CHECK_VERSION(3, 0, 0)
 630         search_type_opt = gtk_cmoption_menu_new();
 631         gtk_widget_show(search_type_opt);
 632         gtk_box_pack_start(GTK_BOX(hbox_search), search_type_opt, FALSE, FALSE, 0);
 633 #endif
 634
 635         search_type = gtk_menu_new();
 636         MENUITEM_ADD (search_type, menuitem,
 637                         prefs_common_translated_header_name("Subject"), ADVANCED_SEARCH_SUBJECT);
 638         g_signal_connect(G_OBJECT(menuitem), "activate",
 639                          G_CALLBACK(searchtype_changed),
 640                          quicksearch);
 641         MENUITEM_ADD (search_type, menuitem,
 642                         prefs_common_translated_header_name("From"), ADVANCED_SEARCH_FROM);
 643         g_signal_connect(G_OBJECT(menuitem), "activate",
 644                          G_CALLBACK(searchtype_changed),
 645                          quicksearch);
 646         MENUITEM_ADD (search_type, menuitem,
 647                         prefs_common_translated_header_name("To"), ADVANCED_SEARCH_TO);
 648         g_signal_connect(G_OBJECT(menuitem), "activate",
 649                          G_CALLBACK(searchtype_changed),
 650                          quicksearch);
 651         MENUITEM_ADD (search_type, menuitem,
 652                         prefs_common_translated_header_name("Tag"), ADVANCED_SEARCH_TAG);
 653         g_signal_connect(G_OBJECT(menuitem), "activate",
 654                          G_CALLBACK(searchtype_changed),
 655                          quicksearch);
 656         MENUITEM_ADD (search_type, menuitem,
 657                         _("From/To/Subject/Tag"), ADVANCED_SEARCH_MIXED);
 658         g_signal_connect(G_OBJECT(menuitem), "activate",
 659                          G_CALLBACK(searchtype_changed),
 660                          quicksearch);
 661         MENUITEM_ADD (search_type, menuitem, _("Extended"), ADVANCED_SEARCH_EXTENDED);
 662         g_signal_connect(G_OBJECT(menuitem), "activate",
 663                          G_CALLBACK(searchtype_changed),
 664                          quicksearch);
 665
 666         gtk_menu_shell_append(GTK_MENU_SHELL(search_type), gtk_separator_menu_item_new());
 667
 668         menuitem = gtk_check_menu_item_new_with_label(_("Recursive"));
 669         gtk_menu_shell_append(GTK_MENU_SHELL(search_type), menuitem);
 670
 671         gtk_check_menu_item_set_active(GTK_CHECK_MENU_ITEM(menuitem),
 672                                         prefs_common.summary_quicksearch_recurse);
 673         g_signal_connect(G_OBJECT(menuitem), "activate",
 674                          G_CALLBACK(searchtype_recursive_changed),
 675                          quicksearch);
 676
 677         menuitem = gtk_check_menu_item_new_with_label(_("Sticky"));
 678         gtk_menu_shell_append(GTK_MENU_SHELL(search_type), menuitem);
 679
 680         gtk_check_menu_item_set_active(GTK_CHECK_MENU_ITEM(menuitem),
 681                                         prefs_common.summary_quicksearch_sticky);
 682
 683         g_signal_connect(G_OBJECT(menuitem), "activate",
 684                          G_CALLBACK(searchtype_sticky_changed),
 685                          quicksearch);
 686
 687         menuitem = gtk_check_menu_item_new_with_label(_("Type-ahead"));
 688         gtk_menu_shell_append(GTK_MENU_SHELL(search_type), menuitem);
 689
 690         gtk_check_menu_item_set_active(GTK_CHECK_MENU_ITEM(menuitem),
 691                                         prefs_common.summary_quicksearch_dynamic);
 692
 693         quicksearch->dynamic_menuitem = menuitem;
 694
 695         g_signal_connect(G_OBJECT(menuitem), "activate",
 696                          G_CALLBACK(searchtype_dynamic_changed),
 697                          quicksearch);
 698
 699         menuitem = gtk_check_menu_item_new_with_label(_("Run on select"));
 700         gtk_menu_shell_append(GTK_MENU_SHELL(search_type), menuitem);
 701
 702         gtk_check_menu_item_set_active(GTK_CHECK_MENU_ITEM(menuitem),
 703                                         prefs_common.summary_quicksearch_autorun);
 704
 705         quicksearch->autorun_menuitem = menuitem;
 706
 707         g_signal_connect(G_OBJECT(menuitem), "activate",
 708                          G_CALLBACK(searchtype_autorun_changed),
 709                          quicksearch);
 710
 711 #if !GTK_CHECK_VERSION(3, 0, 0)
 712         gtk_cmoption_menu_set_menu(GTK_CMOPTION_MENU(search_type_opt), search_type);
 713
 714         quicksearch->search_type_opt = search_type_opt;
 715 #endif
 716         quicksearch_set_type(quicksearch, prefs_common.summary_quicksearch_type);
 717
 718         gtk_widget_show(search_type);
 719
 720 #if !GTK_CHECK_VERSION(2, 24, 0)
 721         search_string_entry = gtk_combo_box_entry_new_text ();
 722 #else
 723         search_string_entry = gtk_combo_box_text_new_with_entry ();
 724 #endif
 725         gtk_combo_box_set_active(GTK_COMBO_BOX(search_string_entry), -1);
 726
 727         vbox = gtk_vbox_new(TRUE, 0);
 728         gtk_box_pack_start(GTK_BOX(vbox), search_string_entry, FALSE, FALSE, 0);
 729         gtk_box_pack_start(GTK_BOX(hbox_search), vbox, TRUE, TRUE, 4);
 730
 731         gtk_widget_show(vbox);
 732         gtk_widget_show(search_string_entry);
 733
 734         search_hbox = gtk_hbox_new(FALSE, 5);
 735         clear_search = gtk_button_new_from_stock(GTK_STOCK_CLEAR);
 736         gtk_box_pack_start(GTK_BOX(search_hbox), clear_search,
 737                            FALSE, FALSE, 0);
 738         g_signal_connect(G_OBJECT(clear_search), "clicked",
 739                          G_CALLBACK(clear_search_cb), quicksearch);
 740         CLAWS_SET_TIP(clear_search,
 741                              _("Clear the current search"));
 742         gtk_widget_show(clear_search);
 743
 744         search_condition_expression = gtk_button_new_from_stock(GTK_STOCK_EDIT);
 745         gtk_box_pack_start(GTK_BOX(search_hbox), search_condition_expression,
 746                            FALSE, FALSE, 0);
 747         g_signal_connect(G_OBJECT (search_condition_expression), "clicked",
 748                          G_CALLBACK(search_condition_expr),
 749                          quicksearch);
 750         CLAWS_SET_TIP(search_condition_expression,
 751                              _("Edit search criteria"));
 752         gtk_widget_show(search_condition_expression);
 753
 754         search_description = gtk_button_new_from_stock(GTK_STOCK_INFO);
 755         gtk_box_pack_start(GTK_BOX(search_hbox), search_description,
 756                            FALSE, FALSE, 0);
 757         g_signal_connect(G_OBJECT(search_description), "clicked",
 758                          G_CALLBACK(search_description_cb), NULL);
 759         CLAWS_SET_TIP(search_description,
 760                              _("Information about extended symbols"));
 761         gtk_widget_show(search_description);
 762
 763         gtk_box_pack_start(GTK_BOX(hbox_search), search_hbox, FALSE, FALSE, 2);
 764         gtk_widget_show(search_hbox);
 765
 766         g_signal_connect(G_OBJECT(gtk_bin_get_child(GTK_BIN((search_string_entry)))),
 767                            "key_press_event",
 768                            G_CALLBACK(searchbar_pressed),
 769                            quicksearch);
 770
 771         g_signal_connect(G_OBJECT(gtk_bin_get_child(GTK_BIN((search_string_entry)))),
 772                          "changed",
 773                          G_CALLBACK(searchbar_changed_cb),
 774                          quicksearch);
 775
 776         g_signal_connect(G_OBJECT(gtk_bin_get_child(GTK_BIN((search_string_entry)))),
 777                          "focus_in_event",
 778                          G_CALLBACK(searchbar_focus_evt_in),
 779                          quicksearch);
 780         g_signal_connect(G_OBJECT(gtk_bin_get_child(GTK_BIN((search_string_entry)))),
 781                          "focus_out_event",
 782                          G_CALLBACK(searchbar_focus_evt_out),
 783                          quicksearch);
 784
 785         quicksearch->hbox_search = hbox_search;
 786         quicksearch->search_type = search_type;
 787         quicksearch->search_string_entry = search_string_entry;
 788         quicksearch->search_condition_expression = search_condition_expression;
 789         quicksearch->search_description = search_description;
 790         quicksearch->active = FALSE;
 791         quicksearch->running = FALSE;
 792         quicksearch->clear_search = clear_search;
 793         quicksearch->in_typing = FALSE;
 794         quicksearch->press_timeout_id = -1;
 795         quicksearch->normal_search_strings = NULL;
 796         quicksearch->extended_search_strings = NULL;
 797
 798         quicksearch_set_button(GTK_BUTTON(quicksearch->search_description), GTK_STOCK_INFO, _("_Information"));
 799         quicksearch_set_button(GTK_BUTTON(quicksearch->search_condition_expression), GTK_STOCK_EDIT, _("_Edit"));
 800         quicksearch_set_button(GTK_BUTTON(quicksearch->clear_search), GTK_STOCK_CLEAR, _("C_lear"));
 801
 802         update_extended_buttons(quicksearch);
 803
 804         return quicksearch;
 805 }
 806
 807 void quicksearch_relayout(QuickSearch *quicksearch)
 808 {
 809         switch (prefs_common.layout_mode) {
 810         case NORMAL_LAYOUT:
 811         case WIDE_LAYOUT:
 812         case WIDE_MSGLIST_LAYOUT:
 813                 quicksearch_set_button(GTK_BUTTON(quicksearch->search_description), GTK_STOCK_INFO, _("_Information"));
 814                 quicksearch_set_button(GTK_BUTTON(quicksearch->search_condition_expression), GTK_STOCK_EDIT, _("_Edit"));
 815                 quicksearch_set_button(GTK_BUTTON(quicksearch->clear_search), GTK_STOCK_CLEAR, _("C_lear"));
 816                 break;
 817         case SMALL_LAYOUT:
 818         case VERTICAL_LAYOUT:
 819                 quicksearch_set_button(GTK_BUTTON(quicksearch->search_description), GTK_STOCK_INFO, "");
 820                 quicksearch_set_button(GTK_BUTTON(quicksearch->search_condition_expression), GTK_STOCK_EDIT, "");
 821                 quicksearch_set_button(GTK_BUTTON(quicksearch->clear_search), GTK_STOCK_CLEAR, "");
 822                 break;
 823         }
 824 }
 825
 826 GtkWidget *quicksearch_get_widget(QuickSearch *quicksearch)
 827 {
 828         return quicksearch->hbox_search;
 829 }
 830
 831 void quicksearch_show(QuickSearch *quicksearch)
 832 {
 833         MainWindow *mainwin = mainwindow_get_mainwindow();
 834         GtkWidget *ctree = NULL;
 835         gtk_widget_show(quicksearch->hbox_search);
 836         update_extended_buttons(quicksearch);
 837         gtk_widget_grab_focus(
 838                 GTK_WIDGET(gtk_bin_get_child(GTK_BIN((quicksearch->search_string_entry)))));
 839
 840         if (!mainwin || !mainwin->summaryview) {
 841                 return;
 842         }
 843
 844         ctree = summary_get_main_widget(mainwin->summaryview);
 845
 846         if (ctree && mainwin->summaryview->selected)
 847                 gtk_cmctree_node_moveto(GTK_CMCTREE(ctree),
 848                                 mainwin->summaryview->selected,
 849                                 0, 0.5, 0);
 850 }
 851
 852 void quicksearch_hide(QuickSearch *quicksearch)
 853 {
 854         if (quicksearch_has_sat_predicate(quicksearch)) {
 855                 quicksearch_set(quicksearch, prefs_common.summary_quicksearch_type, "");
 856                 quicksearch_set_active(quicksearch, FALSE);
 857         }
 858         gtk_widget_hide(quicksearch->hbox_search);
 859 }
 860
 861 /*
 862  *\brief        Sets the matchstring.
 863  *
 864  *\param        quicksearch quicksearch to set
 865  *\param        matchstring the match string; it is duplicated, not stored
 866  */
 867 static void quicksearch_set_matchstring(QuickSearch *quicksearch,
 868                                         const gchar *matchstring)
 869 {
 870         g_free(quicksearch->request.matchstring);
 871         quicksearch->request.matchstring = g_strdup(matchstring);
 872 }
 873
 874 void quicksearch_set(QuickSearch *quicksearch, AdvancedSearchType type, const gchar *matchstring)
 875 {
 876         quicksearch_set_type(quicksearch, type);
 877
 878         if (!matchstring || !(*matchstring))
 879                 quicksearch->in_typing = FALSE;
 880
 881         quicksearch_set_matchstring(quicksearch, matchstring);
 882
 883         g_signal_handlers_block_by_func(G_OBJECT(gtk_bin_get_child(GTK_BIN((quicksearch->search_string_entry)))),
 884                                         G_CALLBACK(searchbar_changed_cb), quicksearch);
 885         gtk_entry_set_text(GTK_ENTRY(gtk_bin_get_child(GTK_BIN((quicksearch->search_string_entry)))),
 886                            matchstring);
 887         g_signal_handlers_unblock_by_func(G_OBJECT(gtk_bin_get_child(GTK_BIN((quicksearch->search_string_entry)))),
 888                                           G_CALLBACK(searchbar_changed_cb), quicksearch);
 889
 890         prefs_common.summary_quicksearch_type = type;
 891
 892         quicksearch_invoke_execute(quicksearch, FALSE);
 893 }
 894
 895 gboolean quicksearch_has_sat_predicate(QuickSearch *quicksearch)
 896 {
 897         return quicksearch->active && advsearch_has_proper_predicate(quicksearch->asearch);
 898 }
 899
 900 static void quicksearch_set_active(QuickSearch *quicksearch, gboolean active)
 901 {
 902 #if !GTK_CHECK_VERSION(3, 0, 0)
 903         static GdkColor yellow;
 904         static GdkColor red;
 905         static GdkColor black;
 906         static gboolean colors_initialised = FALSE;
 907 #else
 908         static GdkColor yellow = { (guint32)0, (guint16)0xf5, (guint16)0xf6, (guint16)0xbe };
 909         static GdkColor red = { (guint32)0, (guint16)0xff, (guint16)0x70, (guint16)0x70 };
 910         static GdkColor black = { (guint32)0, (guint16)0x0, (guint16)0x0, (guint16)0x0 };
 911 #endif
 912         gboolean error = FALSE;
 913
 914
 915         quicksearch->active = active;
 916
 917 #if !GTK_CHECK_VERSION(3, 0, 0)
 918         if (!colors_initialised) {
 919                 gdk_color_parse("#f5f6be", &yellow);
 920                 gdk_color_parse("#000000", &black);
 921                 gdk_color_parse("#ff7070", &red);
 922                 colors_initialised = gdk_colormap_alloc_color(
 923                         gdk_colormap_get_system(), &yellow, FALSE, TRUE);
 924                 colors_initialised &= gdk_colormap_alloc_color(
 925                         gdk_colormap_get_system(), &black, FALSE, TRUE);
 926                 colors_initialised &= gdk_colormap_alloc_color(
 927                         gdk_colormap_get_system(), &red, FALSE, TRUE);
 928         }
 929 #endif
 930
 931         if (active &&
 932                 (prefs_common.summary_quicksearch_type == ADVANCED_SEARCH_EXTENDED
 933                  && !advsearch_has_proper_predicate(quicksearch->asearch)))
 934                 error = TRUE;
 935
 936         if (active) {
 937                 gtk_widget_set_sensitive(quicksearch->clear_search, TRUE);
 938 #if !GTK_CHECK_VERSION(3, 0, 0)
 939                 if (colors_initialised) {
 940 #endif
 941                         gtk_widget_modify_base(
 942                                 gtk_bin_get_child(GTK_BIN((quicksearch->search_string_entry))),
 943                                 GTK_STATE_NORMAL, error ? &red : &yellow);
 944                         gtk_widget_modify_text(
 945                                 gtk_bin_get_child(GTK_BIN((quicksearch->search_string_entry))),
 946                                 GTK_STATE_NORMAL, &black);
 947 #if !GTK_CHECK_VERSION(3, 0, 0)
 948                 }
 949 #endif
 950         } else {
 951                 gtk_widget_set_sensitive(quicksearch->clear_search, FALSE);
 952 #if !GTK_CHECK_VERSION(3, 0, 0)
 953                 if (colors_initialised) {
 954 #endif
 955                         gtk_widget_modify_base(
 956                                 gtk_bin_get_child(GTK_BIN((quicksearch->search_string_entry))),
 957                                 GTK_STATE_NORMAL, NULL);
 958                         gtk_widget_modify_text(
 959                                 gtk_bin_get_child(GTK_BIN((quicksearch->search_string_entry))),
 960                                 GTK_STATE_NORMAL, NULL);
 961 #if !GTK_CHECK_VERSION(3, 0, 0)
 962                 }
 963 #endif
 964         }
 965
 966         if (!active) {
 967                 advsearch_abort(quicksearch->asearch);
 968         }
 969 }
 970
 971 void quicksearch_set_execute_callback(QuickSearch *quicksearch,
 972                                       QuickSearchExecuteCallback callback,
 973                                       gpointer data)
 974 {
 975         quicksearch->callback = callback;
 976         quicksearch->callback_data = data;
 977 }
 978
 979 static void quicksearch_set_running(QuickSearch *quicksearch, gboolean run)
 980 {
 981         quicksearch->running = run;
 982 }
 983
 984 gboolean quicksearch_is_running(QuickSearch *quicksearch)
 985 {
 986         return quicksearch->running;
 987 }
 988
 989 void quicksearch_pass_key(QuickSearch *quicksearch, guint val, GdkModifierType mod)
 990 {
 991         GtkEntry *entry = GTK_ENTRY(gtk_bin_get_child(GTK_BIN((quicksearch->search_string_entry))));
 992         glong curpos = gtk_editable_get_position(GTK_EDITABLE(entry));
 993         guint32 c;
 994         char *str = g_strdup(gtk_entry_get_text(entry));
 995         char *begin = str;
 996         char *end = NULL;
 997         char *new = NULL;
 998         char key[7] = "";
 999         guint char_len = 0;
1000
1001         if (gtk_editable_get_selection_bounds(GTK_EDITABLE(entry), NULL, NULL)) {
1002                 /* remove selection */
1003                 gtk_editable_delete_selection(GTK_EDITABLE(entry));
1004                 curpos = gtk_editable_get_position(GTK_EDITABLE(entry));
1005                 /* refresh string */
1006                 g_free(str);
1007                 str = g_strdup(gtk_entry_get_text(entry));
1008                 begin = str;
1009         }
1010
1011         if (!(c = gdk_keyval_to_unicode(val))) {
1012                 g_free(str);
1013                 return;
1014         }
1015         char_len = g_unichar_to_utf8(c, key);
1016         if (char_len < 0)
1017                 return;
1018         key[char_len] = '\0';
1019         if (curpos < g_utf8_strlen(str, -1)) {
1020                 gchar *stop = g_utf8_offset_to_pointer(begin, curpos);
1021                 end = g_strdup(g_utf8_offset_to_pointer(str, curpos));
1022                 *stop = '\0';
1023                 new = g_strdup_printf("%s%s%s", begin, key, end);
1024                 gtk_entry_set_text(entry, new);
1025                 g_free(end);
1026         } else {
1027                 new = g_strdup_printf("%s%s", begin, key);
1028                 gtk_entry_set_text(entry, new);
1029         }
1030         g_free(str);
1031         g_free(new);
1032         gtk_editable_set_position(GTK_EDITABLE(entry), curpos+1);
1033
1034 }
1035
1036 gboolean quicksearch_is_in_typing(QuickSearch *quicksearch)
1037 {
1038         return quicksearch->in_typing;
1039 }
1040
1041 void quicksearch_set_search_strings(QuickSearch *quicksearch)
1042 {
1043         GList *strings = prefs_common.summary_quicksearch_history;
1044         gchar *newstr = NULL;
1045         MatcherList *matcher_list = NULL;
1046
1047         if (!strings)
1048                 return;
1049
1050         matcher_parser_disable_warnings(TRUE);
1051
1052         do {
1053                 newstr = advsearch_expand_search_string((gchar *) strings->data);
1054                 if (newstr && newstr[0] != '\0') {
1055                         if (!strchr(newstr, ' ')) {
1056                                 quicksearch->normal_search_strings =
1057                                         g_list_append(
1058                                                 quicksearch->normal_search_strings,
1059                                                 g_strdup(strings->data));
1060                                 g_free(newstr);
1061                                 continue;
1062                         }
1063
1064                         matcher_list = matcher_parser_get_cond(newstr, FALSE);
1065                         g_free(newstr);
1066
1067                         if (matcher_list) {
1068                                 quicksearch->extended_search_strings =
1069                                         g_list_prepend(
1070                                                 quicksearch->extended_search_strings,
1071                                                 g_strdup(strings->data));
1072                                 matcherlist_free(matcher_list);
1073                         } else
1074                                 quicksearch->normal_search_strings =
1075                                         g_list_prepend(
1076                                                 quicksearch->normal_search_strings,
1077                                                 g_strdup(strings->data));
1078                 }
1079
1080         } while ((strings = g_list_next(strings)) != NULL);
1081
1082         matcher_parser_disable_warnings(FALSE);
1083
1084         quicksearch->normal_search_strings = g_list_reverse(quicksearch->normal_search_strings);
1085         quicksearch->extended_search_strings = g_list_reverse(quicksearch->extended_search_strings);
1086
1087         quicksearch_set_popdown_strings(quicksearch);
1088 }
1089