src/message_search.c

   1 /*
   2  * Claws Mail -- a GTK based, lightweight, and fast e-mail client
   3  * Copyright (C) 1999-2022 the Claws Mail team and Hiroyuki Yamamoto
   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_close (void *obj)
 126 {
 127         if(!search_window.window) {
 128                 return;
 129         }
 130         if (search_window.interface_obj == obj) {
 131                 gtk_widget_hide(search_window.window);
 132                 search_window.interface_obj = NULL;
 133         }
 134 }
 135
 136 void message_search_other(SearchInterface *interface, void *obj)
 137 {
 138         if (!search_window.window)
 139                 message_search_create();
 140         else
 141                 gtk_widget_hide(search_window.window);
 142
 143         search_window.interface_obj = obj;
 144         search_window.interface = interface;
 145
 146         gtk_widget_grab_focus(search_window.next_btn);
 147         gtk_widget_grab_focus(search_window.body_entry);
 148         gtk_widget_show(search_window.window);
 149 }
 150
 151
 152 static void message_search_create(void)
 153 {
 154         GtkWidget *window;
 155
 156         GtkWidget *vbox1;
 157         GtkWidget *hbox1;
 158         GtkWidget *body_label;
 159         GtkWidget *body_entry;
 160
 161         GtkWidget *checkbtn_hbox;
 162         GtkWidget *case_checkbtn;
 163
 164         GtkWidget *confirm_area;
 165         GtkWidget *help_btn;
 166         GtkWidget *prev_btn;
 167         GtkWidget *next_btn;
 168         GtkWidget *close_btn;
 169         GtkWidget *stop_btn;
 170
 171         window = gtkut_window_new(GTK_WINDOW_TOPLEVEL, "message_search");
 172         gtk_window_set_title (GTK_WINDOW (window),
 173                               _("Find in current message"));
 174         gtk_widget_set_size_request (window, 450, -1);
 175         gtk_window_set_resizable(GTK_WINDOW(window), TRUE);
 176         gtk_window_set_type_hint(GTK_WINDOW(window), GDK_WINDOW_TYPE_HINT_DIALOG);
 177         gtk_container_set_border_width (GTK_CONTAINER (window), 8);
 178         g_signal_connect(G_OBJECT(window), "delete_event",
 179                          G_CALLBACK(gtk_widget_hide_on_delete), NULL);
 180         g_signal_connect(G_OBJECT(window), "key_press_event",
 181                          G_CALLBACK(key_pressed), NULL);
 182         MANAGE_WINDOW_SIGNALS_CONNECT(window);
 183
 184         vbox1 = gtk_box_new(GTK_ORIENTATION_VERTICAL, 0);
 185         gtk_widget_show (vbox1);
 186         gtk_container_add (GTK_CONTAINER (window), vbox1);
 187
 188         hbox1 = gtk_box_new(GTK_ORIENTATION_HORIZONTAL, 8);
 189         gtk_widget_show (hbox1);
 190         gtk_box_pack_start (GTK_BOX (vbox1), hbox1, TRUE, TRUE, 0);
 191
 192         body_label = gtk_label_new (_("Find text:"));
 193         gtk_widget_show (body_label);
 194         gtk_box_pack_start (GTK_BOX (hbox1), body_label, FALSE, FALSE, 0);
 195
 196         body_entry = gtk_combo_box_text_new_with_entry ();
 197         gtk_combo_box_set_active(GTK_COMBO_BOX(body_entry), -1);
 198         if (prefs_common.message_search_history)
 199                 combobox_set_popdown_strings(GTK_COMBO_BOX_TEXT(body_entry),
 200                                 prefs_common.message_search_history);
 201         gtk_widget_show (body_entry);
 202         gtk_box_pack_start (GTK_BOX (hbox1), body_entry, TRUE, TRUE, 0);
 203         g_signal_connect(G_OBJECT(body_entry), "changed",
 204                          G_CALLBACK(body_changed), NULL);
 205         g_signal_connect(G_OBJECT(gtk_bin_get_child(GTK_BIN((body_entry)))),
 206                          "focus_in_event", G_CALLBACK(body_entry_focus_evt_in), NULL);
 207         g_signal_connect(G_OBJECT(gtk_bin_get_child(GTK_BIN((body_entry)))),
 208                          "focus_out_event", G_CALLBACK(body_entry_focus_evt_out), NULL);
 209
 210         checkbtn_hbox = gtk_box_new(GTK_ORIENTATION_HORIZONTAL, 8);
 211         gtk_widget_show (checkbtn_hbox);
 212         gtk_box_pack_start (GTK_BOX (vbox1), checkbtn_hbox, TRUE, TRUE, 0);
 213         gtk_container_set_border_width (GTK_CONTAINER (checkbtn_hbox), 8);
 214
 215         case_checkbtn = gtk_check_button_new_with_label (_("Case sensitive"));
 216         gtk_widget_show (case_checkbtn);
 217         gtk_box_pack_start (GTK_BOX (checkbtn_hbox), case_checkbtn,
 218                             FALSE, FALSE, 0);
 219
 220         confirm_area = gtk_button_box_new(GTK_ORIENTATION_HORIZONTAL);
 221         gtk_widget_show (confirm_area);
 222         gtk_button_box_set_layout(GTK_BUTTON_BOX(confirm_area),
 223                                   GTK_BUTTONBOX_END);
 224         gtk_box_set_spacing(GTK_BOX(confirm_area), 5);
 225
 226         gtkut_stock_button_add_help(confirm_area, &help_btn);
 227
 228         prev_btn = gtkut_stock_button("go-previous", _("_Previous"));
 229         gtk_widget_set_can_default(prev_btn, TRUE);
 230         gtk_box_pack_start(GTK_BOX(confirm_area), prev_btn, TRUE, TRUE, 0);
 231         gtk_widget_show(prev_btn);
 232
 233         next_btn = gtkut_stock_button("go-next", _("_Next"));
 234         gtk_widget_set_can_default(next_btn, TRUE);
 235         gtk_box_pack_start(GTK_BOX(confirm_area), next_btn, TRUE, TRUE, 0);
 236         gtk_widget_show(next_btn);
 237
 238         close_btn = gtkut_stock_button("window-close", _("_Close"));
 239         gtk_widget_set_can_default(close_btn, TRUE);
 240         gtk_box_pack_start(GTK_BOX(confirm_area), close_btn, TRUE, TRUE, 0);
 241         gtk_widget_show(close_btn);
 242
 243         /* stop button hidden */
 244         stop_btn = gtk_button_new_with_mnemonic("_Stop");
 245         gtk_widget_set_can_default(stop_btn, TRUE);
 246         gtk_box_pack_start(GTK_BOX(confirm_area), stop_btn, TRUE, TRUE, 0);
 247
 248         gtk_widget_show (confirm_area);
 249         gtk_box_pack_start (GTK_BOX (vbox1), confirm_area, FALSE, FALSE, 0);
 250         gtk_widget_grab_default(next_btn);
 251
 252         g_signal_connect(G_OBJECT(help_btn), "clicked",
 253                          G_CALLBACK(manual_open_with_anchor_cb),
 254                          MANUAL_ANCHOR_SEARCHING);
 255         g_signal_connect(G_OBJECT(prev_btn), "clicked",
 256                          G_CALLBACK(message_search_prev_clicked), NULL);
 257         g_signal_connect(G_OBJECT(next_btn), "clicked",
 258                          G_CALLBACK(message_search_next_clicked), NULL);
 259         g_signal_connect_closure
 260                 (G_OBJECT(close_btn), "clicked",
 261                  g_cclosure_new_swap(G_CALLBACK(gtk_widget_hide),
 262                                      window, NULL),
 263                  FALSE);
 264         g_signal_connect(G_OBJECT(stop_btn), "clicked",
 265                          G_CALLBACK(message_search_stop_clicked), NULL);
 266
 267         search_window.window = window;
 268         search_window.body_entry = body_entry;
 269         search_window.case_checkbtn = case_checkbtn;
 270         search_window.help_btn = help_btn;
 271         search_window.prev_btn = prev_btn;
 272         search_window.next_btn = next_btn;
 273         search_window.close_btn = close_btn;
 274         search_window.stop_btn = stop_btn;
 275 }
 276
 277 static void message_search_execute(gboolean backward)
 278 {
 279         void *interface_obj = search_window.interface_obj;
 280         gboolean case_sens;
 281         gboolean all_searched = FALSE;
 282         gchar *body_str;
 283
 284         body_str = gtk_combo_box_text_get_active_text(GTK_COMBO_BOX_TEXT(search_window.body_entry));
 285         if (!body_str)
 286                 body_str = gtk_editable_get_chars(
 287                                 GTK_EDITABLE(gtk_bin_get_child(GTK_BIN(search_window.body_entry))),0,-1);
 288         if (!body_str || *body_str == '\0') return;
 289
 290         /* add to history */
 291         combobox_unset_popdown_strings(GTK_COMBO_BOX_TEXT(search_window.body_entry));
 292         prefs_common.message_search_history = add_history(
 293                         prefs_common.message_search_history, body_str);
 294         combobox_set_popdown_strings(GTK_COMBO_BOX_TEXT(search_window.body_entry),
 295                         prefs_common.message_search_history);
 296
 297         case_sens = gtk_toggle_button_get_active
 298                 (GTK_TOGGLE_BUTTON(search_window.case_checkbtn));
 299
 300         search_window.is_searching = TRUE;
 301         message_show_stop_button();
 302
 303         for (; search_window.is_searching;) {
 304                 gchar *str;
 305                 AlertValue val;
 306
 307                 if (backward) {
 308                         if (search_window.interface->search_string_backward
 309                                 (interface_obj, body_str, case_sens) == TRUE)
 310                                 break;
 311                 } else {
 312                         if (search_window.interface->search_string
 313                                 (interface_obj, body_str, case_sens) == TRUE)
 314                                 break;
 315                 }
 316
 317                 if (all_searched) {
 318                         alertpanel_full(_("Search failed"),
 319                                         _("Search string not found."),
 320                                         "window-close", _("_Close"), NULL, NULL, NULL, NULL,
 321                                         FALSE, ALERTFOCUS_FIRST, NULL, ALERT_WARNING);
 322                         break;
 323                 }
 324
 325                 all_searched = TRUE;
 326
 327                 if (backward)
 328                         str = _("Beginning of message reached; "
 329                                 "continue from end?");
 330                 else
 331                         str = _("End of message reached; "
 332                                 "continue from beginning?");
 333
 334                 val = alertpanel(_("Search finished"), str,
 335                                  NULL, _("_No"), NULL, _("_Yes"), NULL, NULL,
 336                                  ALERTFOCUS_SECOND);
 337                 if (G_ALERTALTERNATE == val) {
 338                         manage_window_focus_in(search_window.window,
 339                                                NULL, NULL);
 340                         search_window.interface->set_position(interface_obj,
 341                                                         backward ? -1 : 0);
 342                 } else
 343                         break;
 344         }
 345
 346         search_window.is_searching = FALSE;
 347         message_hide_stop_button();
 348         g_free(body_str);
 349 }
 350
 351 static void body_changed(void)
 352 {
 353         if (!search_window.body_entry_has_focus)
 354                 gtk_widget_grab_focus(search_window.body_entry);
 355 }
 356
 357 static gboolean body_entry_focus_evt_in(GtkWidget *widget, GdkEventFocus *event,
 358                                   gpointer data)
 359 {
 360         search_window.body_entry_has_focus = TRUE;
 361         return FALSE;
 362 }
 363
 364 static gboolean body_entry_focus_evt_out(GtkWidget *widget, GdkEventFocus *event,
 365                                   gpointer data)
 366 {
 367         search_window.body_entry_has_focus = FALSE;
 368         return FALSE;
 369 }
 370
 371 static void message_search_prev_clicked(GtkButton *button, gpointer data)
 372 {
 373         message_search_execute(TRUE);
 374 }
 375
 376 static void message_search_next_clicked(GtkButton *button, gpointer data)
 377 {
 378         message_search_execute(FALSE);
 379 }
 380
 381 static gboolean key_pressed(GtkWidget *widget, GdkEventKey *event,
 382                             gpointer data)
 383 {
 384         if (event && (event->keyval == GDK_KEY_Escape)) {
 385                 gtk_widget_hide(search_window.window);
 386         }
 387
 388         if (event && (event->keyval == GDK_KEY_Return || event->keyval == GDK_KEY_KP_Enter)) {
 389                 message_search_execute(FALSE);
 390         }
 391
 392         if (event && (event->keyval == GDK_KEY_Down || event->keyval == GDK_KEY_Up)) {
 393                 if (search_window.body_entry_has_focus) {
 394                         combobox_set_value_from_arrow_key(
 395                                         GTK_COMBO_BOX(search_window.body_entry),
 396                                         event->keyval);
 397                         return TRUE;
 398                 }
 399         }
 400
 401         return FALSE;
 402 }
 403
 404 static void message_search_stop_clicked(GtkButton *button, gpointer data)
 405 {
 406         search_window.is_searching = FALSE;
 407 }