ee941eed37b3c87e3cb3401cbf28ad0910c856dc
[obnox/wireshark/wip.git] / 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., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
23  */
24
25 /*
26  * This file implements the "filter" toolbar for Wireshark.
27  */
28
29 #include <string.h>
30
31 #ifdef HAVE_CONFIG_H
32 #include "config.h"
33 #endif
34
35 #include <gtk/gtk.h>
36
37 #include "filter_dlg.h"
38 #include "filter_autocomplete.h"
39
40 #include "epan/prefs.h"
41
42 #include "keys.h"
43 #include "gtkglobals.h"
44 #include "stock_icons.h"
45 #include "recent.h"
46
47 #include "main.h"
48 #include "main_menu.h"
49 #include "main_toolbar.h"
50 #include "main_filter_toolbar.h"
51
52
53 GtkWidget   *main_display_filter_widget=NULL;
54
55 /* Run the current display filter on the current packet set, and
56    redisplay. */
57 static void
58 filter_activate_cb(GtkWidget *w _U_, gpointer data)
59 {
60   const char *s;
61
62   s = gtk_entry_get_text(GTK_ENTRY(data));
63
64   main_filter_packets(&cfile, s, FALSE);
65 }
66
67 /* redisplay with no display filter */
68 static void
69 filter_reset_cb(GtkWidget *w, gpointer data _U_)
70 {
71   GtkWidget *filter_te = NULL;
72
73   if ((filter_te = g_object_get_data(G_OBJECT(w), E_DFILTER_TE_KEY))) {
74     gtk_entry_set_text(GTK_ENTRY(filter_te), "");
75   }
76   main_filter_packets(&cfile, NULL, FALSE);
77 }
78
79
80 GtkWidget *filter_toolbar_new()
81 {
82     GtkWidget
83               *filter_bt, *filter_cm, *filter_te,
84               *filter_add_expr_bt,
85               *filter_apply,
86               *filter_reset;
87     GtkWidget *filter_tb;
88     GList         *dfilter_list = NULL;
89     GtkTooltips   *tooltips;
90
91     /* Display filter construct dialog has an Apply button, and "OK" not
92        only sets our text widget, it activates it (i.e., it causes us to
93        filter the capture). */
94     static construct_args_t args = {
95         "Wireshark: Display Filter",
96         TRUE,
97         TRUE,
98         FALSE
99     };
100
101     tooltips = gtk_tooltips_new();
102
103     /* filter toolbar */
104     filter_tb = gtk_toolbar_new();
105     gtk_toolbar_set_orientation(GTK_TOOLBAR(filter_tb),
106                                 GTK_ORIENTATION_HORIZONTAL);
107     gtk_widget_show(filter_tb);
108
109     /* Create the "Filter:" button */
110     filter_bt = gtk_button_new_from_stock(WIRESHARK_STOCK_DISPLAY_FILTER_ENTRY);
111     g_signal_connect(filter_bt, "clicked", G_CALLBACK(display_filter_construct_cb), &args);
112     gtk_widget_show(filter_bt);
113     g_object_set_data(G_OBJECT(top_level), E_FILT_BT_PTR_KEY, filter_bt);
114
115     gtk_toolbar_append_widget(GTK_TOOLBAR(filter_tb), filter_bt,
116         "Open the \"Display Filter\" dialog, to edit/apply filters", "Private");
117
118     /* Create the filter combobox */
119     filter_cm = gtk_combo_new();
120     dfilter_list = NULL;
121     gtk_combo_disable_activate(GTK_COMBO(filter_cm));
122     gtk_combo_set_case_sensitive(GTK_COMBO(filter_cm), TRUE);
123     g_object_set_data(G_OBJECT(filter_cm), E_DFILTER_FL_KEY, dfilter_list);
124     filter_te = GTK_COMBO(filter_cm)->entry;
125     main_display_filter_widget=filter_te;
126     g_object_set_data(G_OBJECT(filter_bt), E_FILT_TE_PTR_KEY, filter_te);
127     g_object_set_data(G_OBJECT(filter_te), E_DFILTER_CM_KEY, filter_cm);
128     g_object_set_data(G_OBJECT(top_level), E_DFILTER_CM_KEY, filter_cm);
129     g_signal_connect(filter_te, "activate", G_CALLBACK(filter_activate_cb), filter_te);
130     g_signal_connect(filter_te, "changed", G_CALLBACK(filter_te_syntax_check_cb), NULL);
131     g_object_set_data(G_OBJECT(filter_tb), E_FILT_AUTOCOMP_PTR_KEY, NULL);
132     g_object_set_data(G_OBJECT(filter_te), E_FILT_FIELD_USE_STATUSBAR_KEY, "");
133     g_signal_connect(filter_te, "key-press-event", G_CALLBACK (filter_string_te_key_pressed_cb), NULL);
134     g_signal_connect(filter_tb, "key-press-event", G_CALLBACK (filter_parent_dlg_key_pressed_cb), NULL);
135     gtk_widget_set_size_request(filter_cm, 400, -1);
136     gtk_widget_show(filter_cm);
137     gtk_toolbar_append_widget(GTK_TOOLBAR(filter_tb), filter_cm,
138         NULL, NULL);
139     /* setting a tooltip for a combobox will do nothing, so add it to the corresponding text entry */
140     gtk_tooltips_set_tip(tooltips, filter_te,
141         "Enter a display filter, or choose one of your recently used filters. "
142         "The background color of this field is changed by a continuous syntax check (green is valid, red is invalid, yellow may have unexpected results).",
143         NULL);
144
145     /* Create the "Add Expression..." button, to pop up a dialog
146        for constructing filter comparison expressions. */
147     filter_add_expr_bt = gtk_button_new_from_stock(WIRESHARK_STOCK_ADD_EXPRESSION);
148     g_object_set_data(G_OBJECT(filter_tb), E_FILT_FILTER_TE_KEY, filter_te);
149     g_signal_connect(filter_add_expr_bt, "clicked", G_CALLBACK(filter_add_expr_bt_cb), filter_tb);
150     gtk_widget_show(filter_add_expr_bt);
151     gtk_toolbar_append_widget(GTK_TOOLBAR(filter_tb), filter_add_expr_bt,
152         "Add an expression to this filter string", "Private");
153
154     /* Create the "Clear" button */
155     filter_reset = gtk_button_new_from_stock(WIRESHARK_STOCK_CLEAR_EXPRESSION);
156     g_object_set_data(G_OBJECT(filter_reset), E_DFILTER_TE_KEY, filter_te);
157     g_signal_connect(filter_reset, "clicked", G_CALLBACK(filter_reset_cb), NULL);
158     gtk_widget_show(filter_reset);
159     gtk_toolbar_append_widget(GTK_TOOLBAR(filter_tb), filter_reset,
160         "Clear this filter string and update the display", "Private");
161
162     /* Create the "Apply" button */
163     filter_apply = gtk_button_new_from_stock(WIRESHARK_STOCK_APPLY_EXPRESSION);
164     g_object_set_data(G_OBJECT(filter_apply), E_DFILTER_CM_KEY, filter_cm);
165     g_signal_connect(filter_apply, "clicked", G_CALLBACK(filter_activate_cb), filter_te);
166     gtk_widget_show(filter_apply);
167     gtk_toolbar_append_widget(GTK_TOOLBAR(filter_tb), filter_apply,
168         "Apply this filter string to the display", "Private");
169
170     /* Sets the text entry widget pointer as the E_DILTER_TE_KEY data
171      * of any widget that ends up calling a callback which needs
172      * that text entry pointer */
173     set_menu_object_data("/File/Open...", E_DFILTER_TE_KEY, filter_te);
174     set_menu_object_data("/Edit/Copy/As Filter", E_DFILTER_TE_KEY,
175                          filter_te);
176     set_menu_object_data("/Analyze/Display Filters...", E_FILT_TE_PTR_KEY,
177                          filter_te);
178     set_menu_object_data("/Analyze/Follow TCP Stream", E_DFILTER_TE_KEY,
179                          filter_te);
180     set_menu_object_data("/Analyze/Follow UDP Stream", E_DFILTER_TE_KEY,
181                          filter_te);
182     set_menu_object_data("/Analyze/Follow SSL Stream", E_DFILTER_TE_KEY,
183                          filter_te);
184     set_menu_object_data("/Analyze/Apply as Filter/Selected", E_DFILTER_TE_KEY,
185                          filter_te);
186     set_menu_object_data("/Analyze/Apply as Filter/Not Selected", E_DFILTER_TE_KEY,
187                          filter_te);
188     set_menu_object_data("/Analyze/Apply as Filter/... and Selected", E_DFILTER_TE_KEY,
189                          filter_te);
190     set_menu_object_data("/Analyze/Apply as Filter/... or Selected", E_DFILTER_TE_KEY,
191                          filter_te);
192     set_menu_object_data("/Analyze/Apply as Filter/... and not Selected", E_DFILTER_TE_KEY,
193                          filter_te);
194     set_menu_object_data("/Analyze/Apply as Filter/... or not Selected", E_DFILTER_TE_KEY,
195                          filter_te);
196     set_menu_object_data("/Analyze/Prepare a Filter/Selected", E_DFILTER_TE_KEY,
197                          filter_te);
198     set_menu_object_data("/Analyze/Prepare a Filter/Not Selected", E_DFILTER_TE_KEY,
199                          filter_te);
200     set_menu_object_data("/Analyze/Prepare a Filter/... and Selected", E_DFILTER_TE_KEY,
201                          filter_te);
202     set_menu_object_data("/Analyze/Prepare a Filter/... or Selected", E_DFILTER_TE_KEY,
203                          filter_te);
204     set_menu_object_data("/Analyze/Prepare a Filter/... and not Selected", E_DFILTER_TE_KEY,
205                          filter_te);
206     set_menu_object_data("/Analyze/Prepare a Filter/... or not Selected", E_DFILTER_TE_KEY,
207                          filter_te);
208     set_menu_object_data("/Conversation Filter/Ethernet", E_DFILTER_TE_KEY,
209                          filter_te);
210     set_menu_object_data("/Conversation Filter/IP", E_DFILTER_TE_KEY,
211                          filter_te);
212     set_menu_object_data("/Conversation Filter/TCP", E_DFILTER_TE_KEY,
213                          filter_te);
214     set_menu_object_data("/Conversation Filter/UDP", E_DFILTER_TE_KEY,
215                          filter_te);
216     set_menu_object_data("/Conversation Filter/PN-CBA Server", E_DFILTER_TE_KEY,
217                          filter_te);
218     set_toolbar_object_data(E_DFILTER_TE_KEY, filter_te);
219     g_object_set_data(G_OBJECT(popup_menu_object), E_DFILTER_TE_KEY, filter_te);
220
221     return filter_tb;
222 }
223
224 static gint
225 dfilter_entry_match(gconstpointer a, gconstpointer b)
226 {
227     const char *s1 = a;
228     const char *s2 = b;
229
230     return strcmp(s1, s2);
231 }
232
233 /* add a display filter to the combo box */
234 /* Note: a new filter string will not replace an old identical one */
235 static gboolean
236 dfilter_combo_add(GtkWidget *filter_cm, char *s) {
237     GList     *dfilter_list = g_object_get_data(G_OBJECT(filter_cm), E_DFILTER_FL_KEY);
238
239     /* GtkCombos don't let us get at their list contents easily, so we maintain
240        our own filter list, and feed it to gtk_combo_set_popdown_strings when
241        a new filter is added. */
242     if (s && strlen(s) > 0 &&
243         g_list_length(dfilter_list) < prefs.gui_recent_df_entries_max &&
244         g_list_find_custom(dfilter_list, s, dfilter_entry_match) == NULL) {
245
246       dfilter_list = g_list_append(dfilter_list, s);
247       s = NULL;
248       g_object_set_data(G_OBJECT(filter_cm), E_DFILTER_FL_KEY, dfilter_list);
249       gtk_combo_set_popdown_strings(GTK_COMBO(filter_cm), dfilter_list);
250       gtk_entry_set_text(GTK_ENTRY(GTK_COMBO(filter_cm)->entry), g_list_first(dfilter_list)->data);
251     }
252
253     g_free(s);
254
255     return TRUE;
256 }
257
258
259 /* write all non empty display filters (until maximum count)
260  * of the combo box GList to the user's recent file */
261 void
262 dfilter_recent_combo_write_all(FILE *rf) {
263   GtkWidget *filter_cm = g_object_get_data(G_OBJECT(top_level), E_DFILTER_CM_KEY);
264   GList     *dfilter_list = g_object_get_data(G_OBJECT(filter_cm), E_DFILTER_FL_KEY);
265   GList     *li;
266   guint      max_count = 0;
267
268
269   /* write all non empty display filter strings to the recent file (until max count) */
270   li = g_list_first(dfilter_list);
271   while ( li && (max_count++ < prefs.gui_recent_df_entries_max) ) {
272     if (strlen(li->data)) {
273       fprintf (rf, RECENT_KEY_DISPLAY_FILTER ": %s\n", (char *)li->data);
274     }
275     li = li->next;
276   }
277 }
278
279 /* empty the combobox entry field */
280 void
281 dfilter_combo_add_empty(void) {
282   GtkWidget *filter_cm = g_object_get_data(G_OBJECT(top_level), E_DFILTER_CM_KEY);
283
284   gtk_entry_set_text(GTK_ENTRY(GTK_COMBO(filter_cm)->entry), "");
285 }
286
287
288 /* add a display filter coming from the user's recent file to the dfilter combo box */
289 gboolean
290 dfilter_combo_add_recent(gchar *s) {
291   GtkWidget *filter_cm = g_object_get_data(G_OBJECT(top_level), E_DFILTER_CM_KEY);
292   char      *dup;
293
294   dup = g_strdup(s);
295
296   return dfilter_combo_add(filter_cm, dup);
297 }
298
299 /* call cf_filter_packets() and add this filter string to the recent filter list */
300 gboolean
301 main_filter_packets(capture_file *cf, const gchar *dftext, gboolean force)
302 {
303   GtkCombo  *filter_cm = g_object_get_data(G_OBJECT(top_level), E_DFILTER_CM_KEY);
304   GList     *dfilter_list = g_object_get_data(G_OBJECT(filter_cm), E_DFILTER_FL_KEY);
305   gboolean   free_filter = TRUE;
306   char      *s;
307   cf_status_t cf_status;
308
309   s = g_strdup(dftext);
310
311   cf_status = cf_filter_packets(cf, s, force);
312   if (!s)
313     return (cf_status == CF_OK);
314
315   /* GtkCombos don't let us get at their list contents easily, so we maintain
316      our own filter list, and feed it to gtk_combo_set_popdown_strings when
317      a new filter is added. */
318   if (cf_status == CF_OK && strlen(s) > 0) {
319     GList *li;
320
321     while ((li = g_list_find_custom(dfilter_list, s, dfilter_entry_match)) != NULL)
322       /* Delete old/duplicate entry now. We'll re-add it later */
323       dfilter_list = g_list_delete_link(dfilter_list, li);
324
325     /* trim list size first */
326     while (g_list_length(dfilter_list) >= prefs.gui_recent_df_entries_max)
327       dfilter_list = g_list_delete_link(dfilter_list, g_list_last(dfilter_list));
328
329     free_filter = FALSE;
330     /* Push the filter to the front of the list */
331     dfilter_list = g_list_prepend(dfilter_list, s);
332     g_object_set_data(G_OBJECT(filter_cm), E_DFILTER_FL_KEY, dfilter_list);
333     gtk_combo_set_popdown_strings(filter_cm, dfilter_list);
334     gtk_entry_set_text(GTK_ENTRY(filter_cm->entry), g_list_first(dfilter_list)->data);
335   }
336
337   if (free_filter)
338     g_free(s);
339
340   return (cf_status == CF_OK);
341 }
342
343