ui/gtk/main_filter_toolbar.c

   1 /* main_filter_toolbar.c
   2  * The filter toolbar
   3  *
   4  * $Id$
   5  *
   6  * Wireshark - Network traffic analyzer
   7  * By Gerald Combs <gerald@wireshark.org>
   8  * Copyright 1998 Gerald Combs
   9  *
  10  * This program is free software; you can redistribute it and/or
  11  * modify it under the terms of the GNU General Public License
  12  * as published by the Free Software Foundation; either version 2
  13  * of the License, or (at your option) any later version.
  14  *
  15  * This program is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU General Public License for more details.
  19  *
  20  * You should have received a copy of the GNU General Public License
  21  * along with this program; if not, write to the Free Software
  22  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  23  */
  24
  25 /*
  26  * This file implements the "filter" toolbar for Wireshark.
  27  */
  28
  29 #include "config.h"
  30
  31 #include <stdio.h>
  32 #include <string.h>
  33
  34 #include <gtk/gtk.h>
  35
  36 #include "ui/recent.h"
  37 #include "ui/recent_utils.h"
  38
  39 #include "ui/gtk/old-gtk-compat.h"
  40
  41 #include "filter_dlg.h"
  42 #include "filter_autocomplete.h"
  43
  44 #include "epan/prefs.h"
  45
  46 #include "keys.h"
  47 #include "gtkglobals.h"
  48 #include "stock_icons.h"
  49
  50 #include "main.h"
  51 #include "menus.h"
  52 #include "main_toolbar.h"
  53 #include "main_filter_toolbar.h"
  54 #include "filter_expression_save_dlg.h"
  55
  56 #define MENU_BAR_PATH_FILE_OPEN                         "/Menubar/FileMenu/Open"
  57 #define MENU_BAR_PATH_EDIT_COPY_AS_FLT                  "/Menubar/EditMenu/Copy/AsFilter"
  58 #define MENU_BAR_PATH_ANALYZE_DISPLAY_FLT               "/Menubar/AnalyzeMenu/DisplayFilters"
  59 #define MENU_BAR_PATH_ANALYZE_FOLLOW_TCP_STREAM         "/Menubar/AnalyzeMenu/FollowTCPStream"
  60 #define MENU_BAR_PATH_ANALYZE_FOLLOW_UDP_STREAM         "/Menubar/AnalyzeMenu/FollowUDPStream"
  61 #define MENU_BAR_PATH_ANALYZE_FOLLOW_SSL_STREAM         "/Menubar/AnalyzeMenu/FollowSSLStream"
  62 #define MENU_BAR_PATH_ANALYZE_APL_AS_FLT_SEL            "/Menubar/AnalyzeMenu/ApplyAsFilter/Selected"
  63 #define MENU_BAR_PATH_ANALYZE_APL_AS_FLT_NOT_SEL        "/Menubar/AnalyzeMenu/ApplyAsFilter/NotSelected"
  64 #define MENU_BAR_PATH_ANALYZE_APL_AS_FLT_AND_SEL        "/Menubar/AnalyzeMenu/ApplyAsFilter/AndSelected"
  65 #define MENU_BAR_PATH_ANALYZE_APL_AS_FLT_OR_SEL         "/Menubar/AnalyzeMenu/ApplyAsFilter/OrSelected"
  66 #define MENU_BAR_PATH_ANALYZE_APL_AS_FLT_AND_NOT_SEL    "/Menubar/AnalyzeMenu/ApplyAsFilter/AndNotSelected"
  67 #define MENU_BAR_PATH_ANALYZE_APL_AS_FLT_OR_NOT_SEL     "/Menubar/AnalyzeMenu/ApplyAsFilter/OrNotSelected"
  68 #define MENU_BAR_PATH_ANALYZE_PREP_A_FLT_SEL            "/Menubar/AnalyzeMenu/PrepareaFilter/Selected"
  69 #define MENU_BAR_PATH_ANALYZE_PREP_A_FLT_NOT_SEL        "/Menubar/AnalyzeMenu/PrepareaFilter/NotSelected"
  70 #define MENU_BAR_PATH_ANALYZE_PREP_A_FLT_AND_SEL        "/Menubar/AnalyzeMenu/PrepareaFilter/AndSelected"
  71 #define MENU_BAR_PATH_ANALYZE_PREP_A_FLT_OR_SEL         "/Menubar/AnalyzeMenu/PrepareaFilter/OrSelected"
  72 #define MENU_BAR_PATH_ANALYZE_PREP_A_FLT_AND_NOT_SEL    "/Menubar/AnalyzeMenu/PrepareaFilter/AndNotSelected"
  73 #define MENU_BAR_PATH_ANALYZE_PREP_A_FLT_OR_NOT_SEL     "/Menubar/AnalyzeMenu/PrepareaFilter/OrNotSelected"
  74
  75 GtkWidget   *main_display_filter_widget=NULL;
  76
  77 /* Run the current display filter on the current packet set, and
  78    redisplay. */
  79 static void
  80 filter_activate_cb(GtkWidget *w _U_, gpointer data)
  81 {
  82     const char *s;
  83
  84     s = gtk_entry_get_text(GTK_ENTRY(data));
  85     main_filter_packets(&cfile, s, FALSE);
  86 }
  87
  88 /* Enable both Clear and Apply button when filter is changed */
  89 static void
  90 filter_changed_cb(GtkWidget *w _U_, gpointer data)
  91 {
  92     gtk_widget_set_sensitive ((GtkWidget *)g_object_get_data (G_OBJECT(data), E_DFILTER_APPLY_KEY), TRUE);
  93     gtk_widget_set_sensitive ((GtkWidget *)g_object_get_data (G_OBJECT(data), E_DFILTER_CLEAR_KEY), TRUE);
  94     gtk_widget_set_sensitive ((GtkWidget *)g_object_get_data (G_OBJECT(data), E_DFILTER_SAVE_KEY), TRUE);
  95 }
  96
  97 /* redisplay with no display filter */
  98 static void
  99 filter_reset_cb(GtkWidget *w, gpointer data _U_)
 100 {
 101     GtkWidget *filter_te = NULL;
 102
 103     if ((filter_te = (GtkWidget *)g_object_get_data(G_OBJECT(w), E_DFILTER_TE_KEY))) {
 104         gtk_entry_set_text(GTK_ENTRY(filter_te), "");
 105     }
 106     main_filter_packets(&cfile, NULL, FALSE);
 107 }
 108
 109 static void
 110 filter_save_cb(GtkWidget *w _U_, GtkWindow *parent_w)
 111 {
 112     filter_expression_save_dlg(parent_w);
 113 }
 114
 115
 116 GtkWidget *
 117 filter_toolbar_new(void)
 118 {
 119     GtkWidget     *filter_cm;
 120     GtkWidget     *filter_te;
 121     GtkWidget     *filter_tb;
 122     GtkToolItem   *filter_bt, *filter_add_expr_bt, *filter_reset;
 123     GtkToolItem   *filter_apply, *filter_save, *item;
 124
 125
 126     /* Display filter construct dialog has an Apply button, and "OK" not
 127        only sets our text widget, it activates it (i.e., it causes us to
 128        filter the capture). */
 129     static construct_args_t args = {
 130         "Wireshark: Display Filter",
 131         TRUE,
 132         TRUE,
 133         FALSE
 134     };
 135
 136     /* filter toolbar */
 137     filter_tb = gtk_toolbar_new();
 138     gtk_orientable_set_orientation(GTK_ORIENTABLE(filter_tb),
 139                                    GTK_ORIENTATION_HORIZONTAL);
 140
 141     g_object_set_data(G_OBJECT(top_level), E_TB_FILTER_KEY, filter_tb);
 142     gtk_widget_show(filter_tb);
 143
 144     /* Create the "Filter:" button */
 145     filter_bt = gtk_tool_button_new_from_stock (WIRESHARK_STOCK_DISPLAY_FILTER_ENTRY);
 146     g_signal_connect(filter_bt, "clicked", G_CALLBACK(display_filter_construct_cb), &args);
 147     gtk_widget_show(GTK_WIDGET (filter_bt));
 148     g_object_set_data(G_OBJECT(top_level), E_FILT_BT_PTR_KEY, filter_bt);
 149
 150     gtk_toolbar_insert(GTK_TOOLBAR(filter_tb),
 151                        filter_bt,
 152                        -1);
 153     gtk_widget_set_tooltip_text(GTK_WIDGET(filter_bt), "Open the \"Display Filter\" dialog, to edit/apply filters");
 154
 155     /* Create the filter combobox */
 156     filter_cm = gtk_combo_box_text_new_with_entry ();
 157     filter_te = gtk_bin_get_child(GTK_BIN(filter_cm));
 158     main_display_filter_widget=filter_te;
 159     g_object_set_data(G_OBJECT(filter_bt), E_FILT_TE_PTR_KEY, filter_te);
 160     g_object_set_data(G_OBJECT(filter_te), E_DFILTER_CM_KEY, filter_cm);
 161     g_object_set_data(G_OBJECT(top_level), E_DFILTER_CM_KEY, filter_cm);
 162     g_signal_connect(filter_te, "activate", G_CALLBACK(filter_activate_cb), filter_te);
 163     g_signal_connect(filter_te, "changed", G_CALLBACK(filter_changed_cb), filter_cm);
 164     g_signal_connect(filter_te, "changed", G_CALLBACK(filter_te_syntax_check_cb), NULL);
 165     g_object_set_data(G_OBJECT(filter_tb), E_FILT_AUTOCOMP_PTR_KEY, NULL);
 166     g_object_set_data(G_OBJECT(filter_te), E_FILT_FIELD_USE_STATUSBAR_KEY, (gpointer)"");
 167     g_signal_connect(filter_te, "key-press-event", G_CALLBACK (filter_string_te_key_pressed_cb), NULL);
 168     g_signal_connect(filter_tb, "key-press-event", G_CALLBACK (filter_parent_dlg_key_pressed_cb), NULL);
 169
 170     gtk_widget_set_size_request(filter_cm, 400, -1);
 171     gtk_widget_show(filter_cm);
 172     item = gtk_tool_item_new ();
 173     gtk_container_add (GTK_CONTAINER (item), filter_cm);
 174     gtk_widget_show (GTK_WIDGET (item));
 175
 176     gtk_toolbar_insert(GTK_TOOLBAR(filter_tb), item, -1);
 177
 178     /* setting a tooltip for a combobox will do nothing, so add it to the corresponding text entry */
 179     gtk_widget_set_tooltip_text(filter_cm,
 180         "Enter a display filter, or choose one of your recently used filters. "
 181         "The background color of this field is changed by a continuous syntax check "
 182         "(green is valid, red is invalid, yellow may have unexpected results).");
 183
 184     /* Create the "Add Expression..." button, to pop up a dialog
 185        for constructing filter comparison expressions. */
 186     filter_add_expr_bt = gtk_tool_button_new_from_stock(WIRESHARK_STOCK_ADD_EXPRESSION);
 187     g_object_set_data(G_OBJECT(filter_tb), E_FILT_FILTER_TE_KEY, filter_te);
 188     g_signal_connect(filter_add_expr_bt, "clicked", G_CALLBACK(filter_add_expr_bt_cb), filter_tb);
 189     gtk_widget_show(GTK_WIDGET(filter_add_expr_bt));
 190
 191     gtk_toolbar_insert(GTK_TOOLBAR(filter_tb),
 192                        filter_add_expr_bt,
 193                        -1);
 194
 195     gtk_widget_set_tooltip_text(GTK_WIDGET(filter_add_expr_bt), "Add an expression to this filter string");
 196
 197     /* Create the "Clear" button */
 198     filter_reset = gtk_tool_button_new_from_stock(WIRESHARK_STOCK_CLEAR_EXPRESSION);
 199     g_object_set_data(G_OBJECT(filter_reset), E_DFILTER_TE_KEY, filter_te);
 200     g_object_set_data (G_OBJECT(filter_cm), E_DFILTER_CLEAR_KEY, filter_reset);
 201     g_signal_connect(filter_reset, "clicked", G_CALLBACK(filter_reset_cb), NULL);
 202     gtk_widget_set_sensitive (GTK_WIDGET(filter_reset), FALSE);
 203     gtk_widget_show(GTK_WIDGET(filter_reset));
 204     gtk_toolbar_insert(GTK_TOOLBAR(filter_tb),
 205                        filter_reset,
 206                        -1);
 207
 208     gtk_widget_set_tooltip_text(GTK_WIDGET(filter_reset), "Clear this filter string and update the display");
 209
 210     /* Create the "Apply" button */
 211     filter_apply = gtk_tool_button_new_from_stock(WIRESHARK_STOCK_APPLY_EXPRESSION);
 212     g_object_set_data(G_OBJECT(filter_apply), E_DFILTER_CM_KEY, filter_cm);
 213     g_object_set_data (G_OBJECT(filter_cm), E_DFILTER_APPLY_KEY, filter_apply);
 214     g_signal_connect(filter_apply, "clicked", G_CALLBACK(filter_activate_cb), filter_te);
 215     gtk_widget_set_sensitive (GTK_WIDGET(filter_apply), FALSE);
 216     gtk_widget_show(GTK_WIDGET(filter_apply));
 217
 218     gtk_toolbar_insert(GTK_TOOLBAR(filter_tb),
 219                        filter_apply,
 220                        -1);
 221
 222     gtk_widget_set_tooltip_text(GTK_WIDGET(filter_apply), "Apply this filter string to the display");
 223
 224     /* Create the "Save" button */
 225     filter_save = gtk_tool_button_new_from_stock(GTK_STOCK_SAVE);
 226     g_object_set_data(G_OBJECT(filter_save), E_DFILTER_CM_KEY, filter_cm);
 227     g_object_set_data(G_OBJECT(filter_cm), E_DFILTER_SAVE_KEY, filter_save);
 228     g_signal_connect(filter_save, "clicked", G_CALLBACK(filter_save_cb), filter_te);
 229     gtk_widget_set_sensitive (GTK_WIDGET(filter_save), FALSE);
 230     gtk_widget_show(GTK_WIDGET(filter_save));
 231
 232     gtk_toolbar_insert(GTK_TOOLBAR(filter_tb),
 233                        filter_save,
 234                        -1);
 235
 236     gtk_widget_set_tooltip_text(GTK_WIDGET(filter_save), "Create a button based on the current display filter");
 237
 238     /* Sets the text entry widget pointer as the E_DILTER_TE_KEY data
 239      * of any widget that ends up calling a callback which needs
 240      * that text entry pointer */
 241     set_menu_object_data(MENU_BAR_PATH_FILE_OPEN, E_DFILTER_TE_KEY, filter_te);
 242     set_menu_object_data(MENU_BAR_PATH_EDIT_COPY_AS_FLT, E_DFILTER_TE_KEY,
 243                          filter_te);
 244     set_menu_object_data(MENU_BAR_PATH_ANALYZE_DISPLAY_FLT, E_FILT_TE_PTR_KEY,
 245                          filter_te);
 246     set_menu_object_data(MENU_BAR_PATH_ANALYZE_FOLLOW_TCP_STREAM, E_DFILTER_TE_KEY,
 247                          filter_te);
 248     set_menu_object_data(MENU_BAR_PATH_ANALYZE_FOLLOW_UDP_STREAM, E_DFILTER_TE_KEY,
 249                          filter_te);
 250     set_menu_object_data(MENU_BAR_PATH_ANALYZE_FOLLOW_SSL_STREAM, E_DFILTER_TE_KEY,
 251                          filter_te);
 252     set_menu_object_data(MENU_BAR_PATH_ANALYZE_APL_AS_FLT_SEL, E_DFILTER_TE_KEY,
 253                          filter_te);
 254     set_menu_object_data(MENU_BAR_PATH_ANALYZE_APL_AS_FLT_NOT_SEL, E_DFILTER_TE_KEY,
 255                          filter_te);
 256     set_menu_object_data(MENU_BAR_PATH_ANALYZE_APL_AS_FLT_AND_SEL, E_DFILTER_TE_KEY,
 257                          filter_te);
 258     set_menu_object_data(MENU_BAR_PATH_ANALYZE_APL_AS_FLT_OR_SEL, E_DFILTER_TE_KEY,
 259                          filter_te);
 260     set_menu_object_data(MENU_BAR_PATH_ANALYZE_APL_AS_FLT_AND_NOT_SEL, E_DFILTER_TE_KEY,
 261                          filter_te);
 262     set_menu_object_data(MENU_BAR_PATH_ANALYZE_APL_AS_FLT_OR_NOT_SEL, E_DFILTER_TE_KEY,
 263                          filter_te);
 264     set_menu_object_data(MENU_BAR_PATH_ANALYZE_PREP_A_FLT_SEL, E_DFILTER_TE_KEY,
 265                          filter_te);
 266     set_menu_object_data(MENU_BAR_PATH_ANALYZE_PREP_A_FLT_NOT_SEL, E_DFILTER_TE_KEY,
 267                          filter_te);
 268     set_menu_object_data(MENU_BAR_PATH_ANALYZE_PREP_A_FLT_AND_SEL, E_DFILTER_TE_KEY,
 269                          filter_te);
 270     set_menu_object_data(MENU_BAR_PATH_ANALYZE_PREP_A_FLT_OR_SEL, E_DFILTER_TE_KEY,
 271                          filter_te);
 272     set_menu_object_data(MENU_BAR_PATH_ANALYZE_PREP_A_FLT_AND_NOT_SEL, E_DFILTER_TE_KEY,
 273                          filter_te);
 274     set_menu_object_data(MENU_BAR_PATH_ANALYZE_PREP_A_FLT_OR_NOT_SEL, E_DFILTER_TE_KEY,
 275                          filter_te);
 276
 277     set_toolbar_object_data(E_DFILTER_TE_KEY, filter_te);
 278     g_object_set_data(G_OBJECT(popup_menu_object), E_DFILTER_TE_KEY, filter_te);
 279
 280     filter_expression_save_dlg_init(filter_tb, filter_te);
 281
 282     /* make current preferences effective */
 283     toolbar_redraw_all();
 284
 285     return filter_tb;
 286 }
 287
 288 static gboolean
 289 dfilter_entry_match(GtkWidget *filter_cm, char *s, int *indx)
 290 {
 291     GtkTreeModel *model = gtk_combo_box_get_model (GTK_COMBO_BOX(filter_cm));
 292     GtkTreeIter   iter;
 293     GValue value = { 0, {{0}}};
 294     const char *filter_str;
 295     int i;
 296
 297     i = -1;
 298     if (!gtk_tree_model_get_iter_first (model, &iter)) {
 299         *indx = i;
 300         return FALSE;
 301     }
 302     do {
 303         i++;
 304         gtk_tree_model_get_value (model, &iter, 0, &value);
 305         filter_str = g_value_get_string (&value);
 306         if(filter_str) {
 307             if(strcmp(s, filter_str) == 0) {
 308                 g_value_unset (&value);
 309                 *indx = i;
 310                 return TRUE;
 311             }
 312         }
 313         g_value_unset (&value);
 314     } while (gtk_tree_model_iter_next (model, &iter));
 315
 316     *indx = -1;
 317     return FALSE;
 318 }
 319
 320 /* add a display filter to the combo box */
 321 /* Note: a new filter string will not replace an old identical one */
 322 static gboolean
 323 dfilter_combo_add(GtkWidget *filter_cm, char *s) {
 324     int indx;
 325
 326     if(!dfilter_entry_match(filter_cm,s, &indx))
 327          gtk_combo_box_text_append_text (GTK_COMBO_BOX_TEXT(filter_cm), s);
 328     g_free(s);
 329
 330     return TRUE;
 331 }
 332
 333
 334 /* write all non empty display filters (until maximum count)
 335  * of the combo box GList to the user's recent file */
 336 void
 337 dfilter_recent_combo_write_all(FILE *rf) {
 338     GtkWidget *filter_cm = (GtkWidget *)g_object_get_data(G_OBJECT(top_level), E_DFILTER_CM_KEY);
 339     GtkTreeModel *model = gtk_combo_box_get_model (GTK_COMBO_BOX(filter_cm));
 340     GtkTreeIter   iter;
 341     GValue value = { 0, {{0}}};
 342     const char *filter_str;
 343     guint      max_count = 0;
 344
 345     if (!gtk_tree_model_get_iter_first (model, &iter))
 346         return;
 347     do {
 348         gtk_tree_model_get_value (model, &iter, 0, &value);
 349         filter_str = g_value_get_string (&value);
 350         if(filter_str)
 351             fprintf (rf, RECENT_KEY_DISPLAY_FILTER ": %s\n", filter_str);
 352         g_value_unset (&value);
 353
 354     } while (gtk_tree_model_iter_next (model, &iter)&& (max_count++ < prefs.gui_recent_df_entries_max));
 355
 356 }
 357
 358 /* add a display filter coming from the user's recent file to the dfilter combo box */
 359 gboolean
 360 dfilter_combo_add_recent(const gchar *s) {
 361     GtkWidget *filter_cm = (GtkWidget *)g_object_get_data(G_OBJECT(top_level), E_DFILTER_CM_KEY);
 362     char      *dupstr;
 363
 364     dupstr = g_strdup(s);
 365
 366     return dfilter_combo_add(filter_cm, dupstr);
 367 }
 368
 369 /* call cf_filter_packets() and add this filter string to the recent filter list */
 370 gboolean
 371 main_filter_packets(capture_file *cf, const gchar *dftext, gboolean force)
 372 {
 373     GtkWidget *filter_cm = (GtkWidget *)g_object_get_data(G_OBJECT(top_level), E_DFILTER_CM_KEY);
 374     gboolean   free_filter = TRUE;
 375     char      *s;
 376     cf_status_t cf_status;
 377     gint filter_count;
 378
 379     s = g_strdup(dftext);
 380
 381     cf_status = cf_filter_packets(cf, s, force);
 382
 383     if (cf_status == CF_OK) {
 384         gtk_widget_set_sensitive ((GtkWidget *)g_object_get_data (G_OBJECT(filter_cm), E_DFILTER_APPLY_KEY), FALSE);
 385         if (!s || strlen (s) == 0) {
 386             gtk_widget_set_sensitive ((GtkWidget *)g_object_get_data (G_OBJECT(filter_cm), E_DFILTER_CLEAR_KEY), FALSE);
 387             gtk_widget_set_sensitive ((GtkWidget *)g_object_get_data (G_OBJECT(filter_cm), E_DFILTER_SAVE_KEY), FALSE);
 388         }
 389     }
 390
 391     if (!s)
 392         return (cf_status == CF_OK);
 393
 394     if (cf_status == CF_OK && strlen(s) > 0) {
 395         int indx;
 396
 397         if(!dfilter_entry_match(filter_cm,s, &indx) || indx > -1) {
 398
 399             /* If the filter is already there but not the first entry, remove it */
 400             if (indx > -1) {
 401                 gtk_combo_box_text_remove(GTK_COMBO_BOX_TEXT(filter_cm), indx);
 402                 indx--;
 403             }
 404
 405             /* Add the filter (at the head of the list) */
 406             gtk_combo_box_text_prepend_text(GTK_COMBO_BOX_TEXT(filter_cm), s);
 407             indx++;
 408         }
 409     }
 410     if (free_filter)
 411         g_free(s);
 412
 413     /* If we have too many entries, remove some */
 414     filter_count = gtk_tree_model_iter_n_children(gtk_combo_box_get_model(GTK_COMBO_BOX(filter_cm)), NULL);
 415     while (filter_count >= (gint)prefs.gui_recent_df_entries_max) {
 416         filter_count--;
 417         gtk_combo_box_text_remove(GTK_COMBO_BOX_TEXT(filter_cm), filter_count);
 418     }
 419
 420     return (cf_status == CF_OK);
 421 }
 422
 423 /*
 424  * Editor modelines
 425  *
 426  * Local Variables:
 427  * c-basic-offset: 4
 428  * tab-width: 8
 429  * indent-tabs-mode: nil
 430  * End:
 431  *
 432  * ex: set shiftwidth=4 tabstop=8 expandtab:
 433  * :indentSize=4:tabSize=8:noTabs=true:
 434  */