src/message_search.c

   1 /*
   2  * Sylpheed -- a GTK+ based, lightweight, and fast e-mail client
   3  * Copyright (C) 1999-2013 Hiroyuki Yamamoto and the Claws Mail team
   4  *
   5  * This program is free software; you can redistribute it and/or modify
   6  * it under the terms of the GNU General Public License as published by
   7  * the Free Software Foundation; either version 3 of the License, or
   8  * (at your option) any later version.
   9  *
  10  * This program is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13  * GNU General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU General Public License
  16  * along with this program. If not, see <http://www.gnu.org/licenses/>.
  17  *
  18  */
  19
  20 #ifdef HAVE_CONFIG_H
  21 #  include "config.h"
  22 #include "claws-features.h"
  23 #endif
  24
  25 #include "defs.h"
  26
  27 #include <glib.h>
  28 #include <glib/gi18n.h>
  29 #include <gdk/gdkkeysyms.h>
  30 #include <gtk/gtk.h>
  31 #include <stdio.h>
  32 #include <stdlib.h>
  33 #include <string.h>
  34
  35 #include "main.h"
  36 #include "message_search.h"
  37 #include "messageview.h"
  38 #include "compose.h"
  39 #include "utils.h"
  40 #include "gtkutils.h"
  41 #include "combobox.h"
  42 #include "manage_window.h"
  43 #include "alertpanel.h"
  44 #include "manual.h"
  45 #include "prefs_common.h"
  46
  47 static struct MessageSearchWindow {
  48         GtkWidget *window;
  49         GtkWidget *body_entry;
  50         GtkWidget *case_checkbtn;
  51         GtkWidget *help_btn;
  52         GtkWidget *prev_btn;
  53         GtkWidget *next_btn;
  54         GtkWidget *close_btn;
  55         GtkWidget *stop_btn;
  56
  57         SearchInterface *interface;
  58         void *interface_obj;
  59
  60         gboolean is_searching;
  61         gboolean body_entry_has_focus;
  62 } search_window;
  63
  64 static SearchInterface compose_interface = {
  65         .search_string_backward = (SearchStringFunc) compose_search_string_backward,
  66         .set_position = (SetPositionFunc) compose_set_position,
  67         .search_string = (SearchStringFunc) compose_search_string,
  68 };
  69
  70 static SearchInterface messageview_interface = {
  71         .set_position = (SetPositionFunc) messageview_set_position,
  72         .search_string = (SearchStringFunc) messageview_search_string,
  73         .search_string_backward = (SearchStringFunc) messageview_search_string_backward,
  74 };
  75
  76 static void message_search_create       (void);
  77 static void message_search_execute      (gboolean        backward);
  78
  79 static void message_search_prev_clicked (GtkButton      *button,
  80                                          gpointer        data);
  81 static void message_search_next_clicked (GtkButton      *button,
  82                                          gpointer        data);
  83 static void message_search_stop_clicked (GtkButton      *button,
  84                                          gpointer        data);
  85 static void body_changed                (void);
  86 static gboolean body_entry_focus_evt_in(GtkWidget *widget, GdkEventFocus *event,
  87                                   gpointer data);
  88 static gboolean body_entry_focus_evt_out(GtkWidget *widget, GdkEventFocus *event,
  89                                   gpointer data);
  90 static gboolean key_pressed             (GtkWidget      *widget,
  91                                          GdkEventKey    *event,
  92                                          gpointer        data);
  93
  94
  95 #define GTK_BUTTON_SET_SENSITIVE(widget,sensitive) {                                    \
  96         gtk_widget_set_sensitive(widget, sensitive);                                    \
  97 }
  98
  99 static void message_show_stop_button(void)
 100 {
 101         gtk_widget_hide(search_window.close_btn);
 102         gtk_widget_show(search_window.stop_btn);
 103         GTK_BUTTON_SET_SENSITIVE(search_window.prev_btn, FALSE)
 104         GTK_BUTTON_SET_SENSITIVE(search_window.next_btn, FALSE)
 105 }
 106
 107 static void message_hide_stop_button(void)
 108 {
 109         gtk_widget_hide(search_window.stop_btn);
 110         gtk_widget_show(search_window.close_btn);
 111         gtk_widget_set_sensitive(search_window.prev_btn, TRUE);
 112         gtk_widget_set_sensitive(search_window.next_btn, TRUE);
 113 }
 114
 115 void message_search(MessageView *messageview)
 116 {
 117         message_search_other(&messageview_interface, (void *)messageview);
 118 }
 119
 120 void message_search_compose(Compose *compose)
 121 {
 122         message_search_other(&compose_interface, (void *)compose);
 123 }
 124
 125 void message_search_other(SearchInterface *interface, void *obj)
 126 {
 127         if (!search_window.window)
 128                 message_search_create();
 129         else
 130                 gtk_widget_hide(search_window.window);
 131
 132         search_window.interface_obj = obj;
 133         search_window.interface = interface;
 134
 135         gtk_widget_grab_focus(search_window.next_btn);
 136         gtk_widget_grab_focus(search_window.body_entry);
 137         gtk_widget_show(search_window.window);
 138 }
 139
 140
 141 static void message_search_create(void)
 142 {
 143         GtkWidget *window;
 144
 145         GtkWidget *vbox1;
 146         GtkWidget *hbox1;
 147         GtkWidget *body_label;
 148         GtkWidget *body_entry;
 149
 150         GtkWidget *checkbtn_hbox;
 151         GtkWidget *case_checkbtn;
 152
 153         GtkWidget *confirm_area;
 154         GtkWidget *help_btn;
 155         GtkWidget *prev_btn;
 156         GtkWidget *next_btn;
 157         GtkWidget *close_btn;
 158         GtkWidget *stop_btn;
 159
 160         window = gtkut_window_new(GTK_WINDOW_TOPLEVEL, "message_search");
 161         gtk_window_set_position(GTK_WINDOW(window), GTK_WIN_POS_CENTER_ALWAYS);
 162         gtk_window_set_title (GTK_WINDOW (window),
 163                               _("Find in current message"));
 164         gtk_widget_set_size_request (window, 450, -1);
 165         gtk_window_set_resizable(GTK_WINDOW(window), TRUE);
 166         gtk_container_set_border_width (GTK_CONTAINER (window), 8);
 167         g_signal_connect(G_OBJECT(window), "delete_event",
 168                          G_CALLBACK(gtk_widget_hide_on_delete), NULL);
 169         g_signal_connect(G_OBJECT(window), "key_press_event",
 170                          G_CALLBACK(key_pressed), NULL);
 171         MANAGE_WINDOW_SIGNALS_CONNECT(window);
 172
 173         vbox1 = gtk_vbox_new (FALSE, 0);
 174         gtk_widget_show (vbox1);
 175         gtk_container_add (GTK_CONTAINER (window), vbox1);
 176
 177         hbox1 = gtk_hbox_new (FALSE, 8);
 178         gtk_widget_show (hbox1);
 179         gtk_box_pack_start (GTK_BOX (vbox1), hbox1, TRUE, TRUE, 0);
 180
 181         body_label = gtk_label_new (_("Find text:"));
 182         gtk_widget_show (body_label);
 183         gtk_box_pack_start (GTK_BOX (hbox1), body_label, FALSE, FALSE, 0);
 184
 185 #if !GTK_CHECK_VERSION(2, 24, 0)
 186         body_entry = gtk_combo_box_entry_new_text ();
 187 #else
 188         body_entry = gtk_combo_box_text_new_with_entry ();
 189 #endif
 190         gtk_combo_box_set_active(GTK_COMBO_BOX(body_entry), -1);
 191         if (prefs_common.message_search_history)
 192 #if !GTK_CHECK_VERSION(2, 24, 0)
 193                 combobox_set_popdown_strings(GTK_COMBO_BOX(body_entry),
 194                                 prefs_common.message_search_history);
 195 #else
 196                 combobox_set_popdown_strings(GTK_COMBO_BOX_TEXT(body_entry),
 197                                 prefs_common.message_search_history);
 198 #endif
 199         gtk_widget_show (body_entry);
 200         gtk_box_pack_start (GTK_BOX (hbox1), body_entry, TRUE, TRUE, 0);
 201         g_signal_connect(G_OBJECT(body_entry), "changed",
 202                          G_CALLBACK(body_changed), NULL);
 203         g_signal_connect(G_OBJECT(gtk_bin_get_child(GTK_BIN((body_entry)))),
 204                          "focus_in_event", G_CALLBACK(body_entry_focus_evt_in), NULL);
 205         g_signal_connect(G_OBJECT(gtk_bin_get_child(GTK_BIN((body_entry)))),
 206                          "focus_out_event", G_CALLBACK(body_entry_focus_evt_out), NULL);
 207
 208         checkbtn_hbox = gtk_hbox_new (FALSE, 8);
 209         gtk_widget_show (checkbtn_hbox);
 210         gtk_box_pack_start (GTK_BOX (vbox1), checkbtn_hbox, TRUE, TRUE, 0);
 211         gtk_container_set_border_width (GTK_CONTAINER (checkbtn_hbox), 8);
 212
 213         case_checkbtn = gtk_check_button_new_with_label (_("Case sensitive"));
 214         gtk_widget_show (case_checkbtn);
 215         gtk_box_pack_start (GTK_BOX (checkbtn_hbox), case_checkbtn,
 216                             FALSE, FALSE, 0);
 217
 218         confirm_area = gtk_hbutton_box_new();
 219         gtk_widget_show (confirm_area);
 220         gtk_button_box_set_layout(GTK_BUTTON_BOX(confirm_area),
 221                                   GTK_BUTTONBOX_END);
 222         gtk_box_set_spacing(GTK_BOX(confirm_area), 5);
 223
 224         gtkut_stock_button_add_help(confirm_area, &help_btn);
 225
 226         prev_btn = gtk_button_new_from_stock(GTK_STOCK_GO_BACK);
 227         gtkut_widget_set_can_default(prev_btn, TRUE);
 228         gtk_box_pack_start(GTK_BOX(confirm_area), prev_btn, TRUE, TRUE, 0);
 229         gtk_widget_show(prev_btn);
 230
 231         next_btn = gtk_button_new_from_stock(GTK_STOCK_GO_FORWARD);
 232         gtkut_widget_set_can_default(next_btn, TRUE);
 233         gtk_box_pack_start(GTK_BOX(confirm_area), next_btn, TRUE, TRUE, 0);
 234         gtk_widget_show(next_btn);
 235
 236         close_btn = gtk_button_new_from_stock(GTK_STOCK_CLOSE);
 237         gtkut_widget_set_can_default(close_btn, TRUE);
 238         gtk_box_pack_start(GTK_BOX(confirm_area), close_btn, TRUE, TRUE, 0);
 239         gtk_widget_show(close_btn);
 240
 241         /* stop button hidden */
 242         stop_btn = gtk_button_new_from_stock(GTK_STOCK_STOP);
 243         gtkut_widget_set_can_default(stop_btn, TRUE);
 244         gtk_box_pack_start(GTK_BOX(confirm_area), stop_btn, TRUE, TRUE, 0);
 245
 246         gtk_widget_show (confirm_area);
 247         gtk_box_pack_start (GTK_BOX (vbox1), confirm_area, FALSE, FALSE, 0);
 248         gtk_widget_grab_default(next_btn);
 249
 250         g_signal_connect(G_OBJECT(help_btn), "clicked",
 251                          G_CALLBACK(manual_open_with_anchor_cb),
 252                          MANUAL_ANCHOR_SEARCHING);
 253         g_signal_connect(G_OBJECT(prev_btn), "clicked",
 254                          G_CALLBACK(message_search_prev_clicked), NULL);
 255         g_signal_connect(G_OBJECT(next_btn), "clicked",
 256                          G_CALLBACK(message_search_next_clicked), NULL);
 257         g_signal_connect_closure
 258                 (G_OBJECT(close_btn), "clicked",
 259                  g_cclosure_new_swap(G_CALLBACK(gtk_widget_hide),
 260                                      window, NULL),
 261                  FALSE);
 262         g_signal_connect(G_OBJECT(stop_btn), "clicked",
 263                          G_CALLBACK(message_search_stop_clicked), NULL);
 264
 265         search_window.window = window;
 266         search_window.body_entry = body_entry;
 267         search_window.case_checkbtn = case_checkbtn;
 268         search_window.help_btn = help_btn;
 269         search_window.prev_btn = prev_btn;
 270         search_window.next_btn = next_btn;
 271         search_window.close_btn = close_btn;
 272         search_window.stop_btn = stop_btn;
 273 }
 274
 275 static void message_search_execute(gboolean backward)
 276 {
 277         void *interface_obj = search_window.interface_obj;
 278         gboolean case_sens;
 279         gboolean all_searched = FALSE;
 280         gchar *body_str;
 281
 282 #if !GTK_CHECK_VERSION(2, 24, 0)
 283         body_str = gtk_combo_box_get_active_text(GTK_COMBO_BOX(search_window.body_entry));
 284 #else
 285         body_str = gtk_combo_box_text_get_active_text(GTK_COMBO_BOX_TEXT(search_window.body_entry));
 286 #endif
 287         if (!body_str)
 288                 body_str = gtk_editable_get_chars(
 289                                 GTK_EDITABLE(gtk_bin_get_child(GTK_BIN(search_window.body_entry))),0,-1);
 290         if (!body_str || *body_str == '\0') return;
 291
 292         /* add to history */
 293 #if !GTK_CHECK_VERSION(2, 24, 0)
 294         combobox_unset_popdown_strings(GTK_COMBO_BOX(search_window.body_entry));
 295 #else
 296         combobox_unset_popdown_strings(GTK_COMBO_BOX_TEXT(search_window.body_entry));
 297 #endif
 298         prefs_common.message_search_history = add_history(
 299                         prefs_common.message_search_history, body_str);
 300 #if !GTK_CHECK_VERSION(2, 24, 0)
 301         combobox_set_popdown_strings(GTK_COMBO_BOX(search_window.body_entry),
 302                         prefs_common.message_search_history);
 303 #else
 304         combobox_set_popdown_strings(GTK_COMBO_BOX_TEXT(search_window.body_entry),
 305                         prefs_common.message_search_history);
 306 #endif
 307
 308         case_sens = gtk_toggle_button_get_active
 309                 (GTK_TOGGLE_BUTTON(search_window.case_checkbtn));
 310
 311         search_window.is_searching = TRUE;
 312         message_show_stop_button();
 313
 314         for (; search_window.is_searching;) {
 315                 gchar *str;
 316                 AlertValue val;
 317
 318                 if (backward) {
 319                         if (search_window.interface->search_string_backward
 320                                 (interface_obj, body_str, case_sens) == TRUE)
 321                                 break;
 322                 } else {
 323                         if (search_window.interface->search_string
 324                                 (interface_obj, body_str, case_sens) == TRUE)
 325                                 break;
 326                 }
 327
 328                 if (all_searched) {
 329                         alertpanel_full(_("Search failed"),
 330                                         _("Search string not found."),
 331                                          GTK_STOCK_CLOSE, NULL, NULL, FALSE,
 332                                          NULL, ALERT_WARNING, G_ALERTDEFAULT);
 333                         break;
 334                 }
 335
 336                 all_searched = TRUE;
 337
 338                 if (backward)
 339                         str = _("Beginning of message reached; "
 340                                 "continue from end?");
 341                 else
 342                         str = _("End of message reached; "
 343                                 "continue from beginning?");
 344
 345                 val = alertpanel(_("Search finished"), str,
 346                                  GTK_STOCK_NO, "+" GTK_STOCK_YES, NULL);
 347                 if (G_ALERTALTERNATE == val) {
 348                         manage_window_focus_in(search_window.window,
 349                                                NULL, NULL);
 350                         search_window.interface->set_position(interface_obj,
 351                                                         backward ? -1 : 0);
 352                 } else
 353                         break;
 354         }
 355
 356         search_window.is_searching = FALSE;
 357         message_hide_stop_button();
 358         g_free(body_str);
 359 }
 360
 361 static void body_changed(void)
 362 {
 363         if (!search_window.body_entry_has_focus)
 364                 gtk_widget_grab_focus(search_window.body_entry);
 365 }
 366
 367 static gboolean body_entry_focus_evt_in(GtkWidget *widget, GdkEventFocus *event,
 368                                   gpointer data)
 369 {
 370         search_window.body_entry_has_focus = TRUE;
 371         return FALSE;
 372 }
 373
 374 static gboolean body_entry_focus_evt_out(GtkWidget *widget, GdkEventFocus *event,
 375                                   gpointer data)
 376 {
 377         search_window.body_entry_has_focus = FALSE;
 378         return FALSE;
 379 }
 380
 381 static void message_search_prev_clicked(GtkButton *button, gpointer data)
 382 {
 383         message_search_execute(TRUE);
 384 }
 385
 386 static void message_search_next_clicked(GtkButton *button, gpointer data)
 387 {
 388         message_search_execute(FALSE);
 389 }
 390
 391 static gboolean key_pressed(GtkWidget *widget, GdkEventKey *event,
 392                             gpointer data)
 393 {
 394         if (event && (event->keyval == GDK_KEY_Escape)) {
 395                 gtk_widget_hide(search_window.window);
 396         }
 397
 398         if (event && (event->keyval == GDK_KEY_Return || event->keyval == GDK_KEY_KP_Enter)) {
 399                 message_search_execute(FALSE);
 400         }
 401
 402         if (event && (event->keyval == GDK_KEY_Down || event->keyval == GDK_KEY_Up)) {
 403                 if (search_window.body_entry_has_focus) {
 404                         combobox_set_value_from_arrow_key(
 405                                         GTK_COMBO_BOX(search_window.body_entry),
 406                                         event->keyval);
 407                         return TRUE;
 408                 }
 409         }
 410
 411         return FALSE;
 412 }
 413
 414 static void message_search_stop_clicked(GtkButton *button, gpointer data)
 415 {
 416         search_window.is_searching = FALSE;
 417 }