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