gtk/expert_dlg.c

   1 /* expert_dlg.c
   2  * Display of Expert information.
   3  *
   4  * Implemented as a tap listener to the "expert" tap.
   5  *
   6  * $Id$
   7  *
   8  * Wireshark - Network traffic analyzer
   9  * By Gerald Combs <gerald@wireshark.org>
  10  * Copyright 1998 Gerald Combs
  11  *
  12  * This program is free software; you can redistribute it and/or
  13  * modify it under the terms of the GNU General Public License
  14  * as published by the Free Software Foundation; either version 2
  15  * of the License, or (at your option) any later version.
  16  *
  17  * This program is distributed in the hope that it will be useful,
  18  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  19  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  20  * GNU General Public License for more details.
  21  *
  22  * You should have received a copy of the GNU General Public License
  23  * along with this program; if not, write to the Free Software
  24  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
  25  */
  26
  27 #ifdef HAVE_CONFIG_H
  28 # include "config.h"
  29 #endif
  30 #include <string.h>
  31 #include <stdlib.h>
  32 #include <stdio.h>
  33 #include <math.h>
  34
  35 #include <gtk/gtk.h>
  36
  37 #include <epan/packet.h>
  38 #include <epan/expert.h>
  39 #include <epan/emem.h>
  40 #include <epan/tap.h>
  41 #include "epan/packet_info.h"
  42 #include <epan/stat_cmd_args.h>
  43 #include <epan/prefs.h>
  44
  45 #include "../simple_dialog.h"
  46 #include "../globals.h"
  47 #include "../color.h"
  48 #include "../stat_menu.h"
  49 #include "image/clist_ascend.xpm"
  50 #include "image/clist_descend.xpm"
  51
  52 #include "gtk/find_dlg.h"
  53 #include "gtk/color_dlg.h"
  54 #include "gtk/main.h"
  55 #include "gtk/gui_utils.h"
  56 #include "gtk/gtkglobals.h"
  57 #include "gtk/dlg_utils.h"
  58 #include "gtk/gui_stat_menu.h"
  59 #include "gtk/tap_dfilter_dlg.h"
  60 #include "gtk/color_utils.h"
  61 #include "gtk/main_proto_draw.h"
  62 #include "gtk/help_dlg.h"
  63 #include "gtk/expert_dlg.h"
  64
  65 static const value_string expert_severity_om_vals[] = {
  66         { PI_ERROR,             "Errors only" },
  67         { PI_WARN,              "Error+Warn" },
  68         { PI_NOTE,              "Error+Warn+Note" },
  69         { PI_CHAT,              "Error+Warn+Note+Chat" },
  70         { 0, NULL }
  71 };
  72
  73
  74 /* reset of display only, e.g. for filtering */
  75 static void expert_dlg_display_reset(expert_tapdata_t * etd)
  76 {
  77         etd->disp_events = 0;
  78         gtk_clist_clear(etd->table);
  79         gtk_clist_columns_autosize(etd->table);
  80
  81         gtk_window_set_title(GTK_WINDOW(etd->win), "Wireshark: ? Expert Infos");
  82         if(etd->label) {
  83                 gtk_label_set_text(GTK_LABEL(etd->label), "Please wait ...");
  84         }
  85 }
  86
  87
  88 /* complete reset, e.g. capture file closed */
  89 void expert_dlg_reset(void *tapdata)
  90 {
  91         expert_tapdata_t * etd = tapdata;
  92
  93         etd->chat_events = 0;
  94         etd->note_events = 0;
  95         etd->warn_events = 0;
  96         etd->error_events = 0;
  97         etd->last = 0;
  98         etd->first = 0;
  99         g_string_chunk_clear(etd->text);
 100         g_array_set_size(etd->ei_array, 0);
 101
 102         expert_dlg_display_reset(etd);
 103 }
 104
 105 int expert_dlg_packet(void *tapdata, packet_info *pinfo _U_, epan_dissect_t *edt _U_, const void *pointer)
 106 {
 107     expert_info_t       *ei;
 108     expert_tapdata_t * etd = tapdata;
 109
 110     g_array_append_val(etd->ei_array, *(expert_info_t *)pointer);
 111     etd->last = etd->ei_array->len;
 112     ei = &g_array_index(etd->ei_array, expert_info_t, etd->last -1); /* ugly */
 113     ei->protocol = ei->protocol;
 114     ei->summary = g_string_chunk_insert_const(etd->text, ei->summary);
 115
 116         switch(ei->severity) {
 117         case(PI_CHAT):
 118                 etd->chat_events++;
 119                 break;
 120         case(PI_NOTE):
 121                 etd->note_events++;
 122                 break;
 123         case(PI_WARN):
 124                 etd->warn_events++;
 125                 break;
 126         case(PI_ERROR):
 127                 etd->error_events++;
 128                 break;
 129         default:
 130                 g_assert_not_reached();
 131         }
 132         if(ei->severity < etd->severity_report_level) {
 133                 return 0; /* draw not required */
 134         } else {
 135                 return 1; /* draw required */
 136         }
 137 }
 138
 139 void
 140 expert_dlg_draw(void *data)
 141 {
 142         expert_tapdata_t *etd = data;
 143         int row;
 144         int displayed;
 145         expert_info_t *ei;
 146         gchar *title;
 147         const char *entries[5];   /**< column entries */
 148
 149
 150         displayed = etd->disp_events;
 151
 152         if(etd->label) {
 153                 if(etd->last - etd->first) {
 154                         title = g_strdup_printf("Adding: %u new messages",etd->last - etd->first);
 155                         gtk_label_set_text(GTK_LABEL(etd->label), title);
 156                         g_free(title);
 157                 }
 158         }
 159
 160         gtk_clist_freeze(etd->table);
 161
 162         /* append new events (remove from new list, append to displayed list and clist) */
 163         while(etd->first < etd->last){
 164                 ei = &g_array_index(etd->ei_array, expert_info_t, etd->first);
 165                 etd->first++;
 166
 167                 if(ei->severity < etd->severity_report_level) {
 168                         continue;
 169                 }
 170                 etd->disp_events++;
 171
 172                 if(etd->disp_events == 1000)
 173                         gtk_clist_columns_autosize(etd->table);
 174
 175                 /* packet number */
 176                 if(ei->packet_num) {
 177             char str_buf[10];
 178
 179                         g_snprintf(str_buf, sizeof(str_buf), "%u", ei->packet_num);
 180                         entries[0] = str_buf;
 181                 } else {
 182                         entries[0] = "-";
 183                 }
 184
 185                 /* severity */
 186                 entries[1] = val_to_str(ei->severity, expert_severity_vals, "Unknown severity (%u)");
 187
 188                 /* group */
 189                 entries[2] = val_to_str(ei->group, expert_group_vals, "Unknown group (%u)");
 190
 191                 /* protocol */
 192                 if(ei->protocol) {
 193                         entries[3] = ei->protocol;
 194                 } else {
 195                         entries[3] = "-";
 196                 }
 197
 198                 /* summary */
 199                 entries[4] = ei->summary;
 200
 201                 /*gtk_clist_set_pixmap(etd->table, row, 5, ascend_pm, ascend_bm);*/
 202
 203                 row=gtk_clist_append(etd->table, (gchar **) entries);
 204                 gtk_clist_set_row_data(etd->table, row, GUINT_TO_POINTER(ei->packet_num));
 205
 206                 /* set rows background color depending on severity */
 207                 switch(ei->severity) {
 208                 case(PI_CHAT):
 209                         gtk_clist_set_background(etd->table, row, &expert_color_chat);
 210                         break;
 211                 case(PI_NOTE):
 212                         gtk_clist_set_background(etd->table, row, &expert_color_note);
 213                         break;
 214                 case(PI_WARN):
 215                         gtk_clist_set_background(etd->table, row, &expert_color_warn);
 216                         break;
 217                 case(PI_ERROR):
 218                         gtk_clist_set_background(etd->table, row, &expert_color_error);
 219                         break;
 220                 default:
 221                         g_assert_not_reached();
 222                 }
 223                 gtk_clist_set_foreground(etd->table, row, &expert_color_foreground);
 224         }
 225
 226         if (etd->table->sort_column || etd->table->sort_type != GTK_SORT_ASCENDING)
 227         gtk_clist_sort(etd->table);
 228
 229         /* column autosizing is very slow for large number of entries,
 230          * so do it only for the first 1000 of it
 231          * (there might be no large changes behind this amount) */
 232         if(etd->disp_events < 1000)
 233                 gtk_clist_columns_autosize(etd->table);
 234         gtk_clist_moveto(etd->table,
 235                      etd->disp_events - 1, -1, 1.0f, 1.0f);
 236         gtk_clist_thaw(etd->table);
 237
 238         if(etd->label) {
 239                 title = g_strdup_printf("Errors: %u Warnings: %u Notes: %u Chats: %u",
 240                         etd->error_events, etd->warn_events, etd->note_events, etd->chat_events);
 241                         gtk_label_set_text(GTK_LABEL(etd->label), title);
 242                 g_free(title);
 243         }
 244
 245         title = g_strdup_printf("Wireshark: %u Expert Info%s",
 246                 etd->disp_events,
 247                 plurality(etd->disp_events, "", "s"));
 248         gtk_window_set_title(GTK_WINDOW(etd->win), title);
 249         g_free(title);
 250 }
 251
 252
 253 typedef struct column_arrows {
 254         GtkWidget *table;
 255         GtkWidget *ascend_pm;
 256         GtkWidget *descend_pm;
 257 } column_arrows;
 258
 259
 260 static gint
 261 srt_sort_column(GtkCList *clist, gconstpointer ptr1, gconstpointer ptr2)
 262 {
 263         char *text1 = NULL;
 264         char *text2 = NULL;
 265         int i1, i2;
 266
 267         const GtkCListRow *row1 = ptr1;
 268         const GtkCListRow *row2 = ptr2;
 269
 270         text1 = GTK_CELL_TEXT (row1->cell[clist->sort_column])->text;
 271         text2 = GTK_CELL_TEXT (row2->cell[clist->sort_column])->text;
 272
 273         switch(clist->sort_column){
 274         case 0:
 275                 i1=atoi(text1);
 276                 i2=atoi(text2);
 277                 return i1-i2;
 278         case 1:
 279         case 2:
 280         case 3:
 281         case 4:
 282                 return strcmp (text1, text2);
 283         }
 284         g_assert_not_reached();
 285         return 0;
 286 }
 287
 288
 289 static void
 290 srt_click_column_cb(GtkCList *clist, gint column, gpointer data)
 291 {
 292         column_arrows *col_arrows = (column_arrows *) data;
 293         int i;
 294
 295         gtk_clist_freeze(clist);
 296
 297         for (i = 0; i < 5; i++) {
 298                 gtk_widget_hide(col_arrows[i].ascend_pm);
 299                 gtk_widget_hide(col_arrows[i].descend_pm);
 300         }
 301
 302         if (column == clist->sort_column) {
 303                 if (clist->sort_type == GTK_SORT_ASCENDING) {
 304                         clist->sort_type = GTK_SORT_DESCENDING;
 305                         gtk_widget_show(col_arrows[column].descend_pm);
 306                 } else {
 307                         clist->sort_type = GTK_SORT_ASCENDING;
 308                         gtk_widget_show(col_arrows[column].ascend_pm);
 309                 }
 310         } else {
 311                 clist->sort_type = GTK_SORT_ASCENDING;
 312                 gtk_widget_show(col_arrows[column].ascend_pm);
 313                 gtk_clist_set_sort_column(clist, column);
 314         }
 315         gtk_clist_sort(clist);
 316
 317         gtk_clist_thaw(clist);
 318 }
 319
 320
 321 static void
 322 select_row_cb(GtkCList *clist, gint row, gint column _U_, GdkEventButton *event _U_, gpointer user_data _U_)
 323 {
 324         guint num = GPOINTER_TO_UINT(gtk_clist_get_row_data(clist, row));
 325
 326         cf_goto_frame(&cfile, num);
 327 }
 328
 329
 330 void
 331 expert_dlg_init_table(expert_tapdata_t * etd, GtkWidget *vbox)
 332 {
 333         int i;
 334         column_arrows *col_arrows;
 335         GtkStyle *win_style;
 336         GtkWidget *column_lb;
 337         GdkBitmap *ascend_bm, *descend_bm;
 338         GdkPixmap *ascend_pm, *descend_pm;
 339         const char *default_titles[] = { "No.", "Sever.", "Group", "Protocol", "Summary" };
 340
 341
 342         etd->scrolled_window=scrolled_window_new(NULL, NULL);
 343         gtk_box_pack_start(GTK_BOX(vbox), etd->scrolled_window, TRUE, TRUE, 0);
 344
 345         etd->table=(GtkCList *)gtk_clist_new(5);
 346         g_signal_connect(etd->table, "select-row", G_CALLBACK(select_row_cb), etd);
 347
 348         gtk_widget_show(GTK_WIDGET(etd->table));
 349         gtk_widget_show(etd->scrolled_window);
 350
 351         col_arrows = (column_arrows *) g_malloc(sizeof(column_arrows) * 5);
 352         win_style = gtk_widget_get_style(etd->scrolled_window);
 353         ascend_pm = gdk_pixmap_create_from_xpm_d(etd->scrolled_window->window,
 354                         &ascend_bm,
 355                         &win_style->bg[GTK_STATE_NORMAL],
 356                         (gchar **)clist_ascend_xpm);
 357         descend_pm = gdk_pixmap_create_from_xpm_d(etd->scrolled_window->window,
 358                         &descend_bm,
 359                         &win_style->bg[GTK_STATE_NORMAL],
 360                         (gchar **)clist_descend_xpm);
 361         for (i = 0; i < 5; i++) {
 362                 col_arrows[i].table = gtk_table_new(2, 2, FALSE);
 363                 gtk_table_set_col_spacings(GTK_TABLE(col_arrows[i].table), 5);
 364                 column_lb = gtk_label_new(default_titles[i]);
 365                 gtk_table_attach(GTK_TABLE(col_arrows[i].table), column_lb, 0, 1, 0, 2, GTK_SHRINK, GTK_SHRINK, 0, 0);
 366                 gtk_widget_show(column_lb);
 367
 368                 col_arrows[i].ascend_pm = gtk_pixmap_new(ascend_pm, ascend_bm);
 369                 gtk_table_attach(GTK_TABLE(col_arrows[i].table), col_arrows[i].ascend_pm, 1, 2, 1, 2, GTK_SHRINK, GTK_SHRINK, 0, 0);
 370                 col_arrows[i].descend_pm = gtk_pixmap_new(descend_pm, descend_bm);
 371                 gtk_table_attach(GTK_TABLE(col_arrows[i].table), col_arrows[i].descend_pm, 1, 2, 0, 1, GTK_SHRINK, GTK_SHRINK, 0, 0);
 372                 if (i == 0) {
 373                         gtk_widget_show(col_arrows[i].ascend_pm);
 374                 }
 375                 gtk_clist_set_column_widget(GTK_CLIST(etd->table), i, col_arrows[i].table);
 376                 gtk_widget_show(col_arrows[i].table);
 377         }
 378         gtk_clist_column_titles_show(GTK_CLIST(etd->table));
 379
 380         gtk_clist_set_compare_func(etd->table, srt_sort_column);
 381         gtk_clist_set_sort_column(etd->table, 0);
 382         gtk_clist_set_sort_type(etd->table, GTK_SORT_ASCENDING);
 383
 384         gtk_clist_set_column_justification(etd->table, 0, GTK_JUSTIFY_RIGHT);
 385         gtk_clist_set_column_justification(etd->table, 3, GTK_JUSTIFY_RIGHT);
 386         gtk_clist_set_shadow_type(etd->table, GTK_SHADOW_IN);
 387         gtk_clist_column_titles_show(etd->table);
 388         gtk_clist_columns_autosize(etd->table);
 389 /*      gtk_clist_set_selection_mode(etd->table, GTK_SELECTION_SINGLE);*/
 390 /*    gtk_list_set_selection_mode(GTK_LIST(etd->table), GTK_SELECTION_BROWSE);*/
 391 /*    gtk_list_select_item(GTK_LIST(value_list), 0);*/
 392         gtk_container_add(GTK_CONTAINER(etd->scrolled_window), (GtkWidget *)etd->table);
 393
 394         g_signal_connect(etd->table, "click-column", G_CALLBACK(srt_click_column_cb), col_arrows);
 395
 396         gtk_widget_show(GTK_WIDGET(etd->table));
 397         gtk_widget_show(etd->scrolled_window);
 398
 399         /* create popup menu for this table */
 400         /*if(etd->filter_string){
 401                 srt_create_popup_menu(etd);
 402         }*/
 403 }
 404
 405 void
 406 expert_dlg_destroy_cb(GtkWindow *win _U_, gpointer data)
 407 {
 408         expert_tapdata_t *etd=(expert_tapdata_t *)data;
 409
 410         protect_thread_critical_region();
 411         remove_tap_listener(etd);
 412         unprotect_thread_critical_region();
 413
 414         /*free_srt_table_data(&etd->afp_srt_table);*/
 415         g_array_free(etd->ei_array, TRUE);
 416         g_string_chunk_free(etd->text);
 417         g_free(etd);
 418 }
 419
 420
 421 static void
 422 expert_dlg_severity_cb(GtkWidget *w, gpointer data)
 423 {
 424         int i = GPOINTER_TO_INT(data);
 425         expert_tapdata_t * etd;
 426
 427
 428         etd = g_object_get_data(G_OBJECT(w), "tapdata");
 429
 430         etd->severity_report_level = expert_severity_om_vals[i].value;
 431
 432         /* "move" all events from "all" back to "new" lists */
 433         protect_thread_critical_region();
 434         etd->first = 0;
 435         unprotect_thread_critical_region();
 436
 437         /* redraw table */
 438         expert_dlg_display_reset(etd);
 439         expert_dlg_draw(etd);
 440 }
 441
 442 expert_tapdata_t * expert_dlg_new_table(void)
 443 {
 444         expert_tapdata_t * etd;
 445         etd=g_malloc0(sizeof(expert_tapdata_t));
 446
 447         etd->ei_array = g_array_sized_new(FALSE, FALSE, sizeof(expert_info_t), 1000);
 448         etd->text = g_string_chunk_new(100);
 449         etd->severity_report_level = PI_CHAT;
 450         return etd;
 451 }
 452
 453 static void
 454 expert_dlg_init(const char *optarg, void* userdata _U_)
 455 {
 456         expert_tapdata_t * etd;
 457         const char *filter=NULL;
 458         GString *error_string;
 459         GtkWidget *vbox;
 460         GtkWidget *table;
 461         GtkWidget *bbox;
 462         GtkWidget *close_bt;
 463         GtkWidget *help_bt;
 464
 465         GtkWidget *severity_box;
 466         GtkWidget *severity_om;
 467         GtkWidget *menu;
 468         GtkWidget *menu_item;
 469         GtkWidget *label;
 470         GtkTooltips *tooltips = gtk_tooltips_new();
 471         int i;
 472
 473         if(!strncmp(optarg,"afp,srt,",8)){
 474                 filter=optarg+8;
 475         } else {
 476                 filter=NULL;
 477         }
 478
 479         proto_draw_colors_init();
 480
 481         etd = expert_dlg_new_table();
 482         etd->win=window_new(GTK_WINDOW_TOPLEVEL, "Wireshark: Expert Info");
 483         gtk_window_set_default_size(GTK_WINDOW(etd->win), 650, 600);
 484
 485         vbox=gtk_vbox_new(FALSE, 3);
 486         gtk_container_add(GTK_CONTAINER(etd->win), vbox);
 487         gtk_container_set_border_width(GTK_CONTAINER(vbox), 12);
 488
 489         table = gtk_table_new(1, 2, TRUE /* homogeneous */);
 490         gtk_box_pack_start(GTK_BOX(vbox), table, FALSE, FALSE, 0);
 491
 492         etd->label=gtk_label_new("Please wait ...");
 493         gtk_misc_set_alignment(GTK_MISC(etd->label), 0.0f, 0.5f);
 494         gtk_table_attach_defaults(GTK_TABLE(table), etd->label, 0, 1, 0, 1);
 495
 496         severity_box = gtk_hbox_new(FALSE, 0);
 497         gtk_table_attach_defaults(GTK_TABLE(table), severity_box, 1, 2, 0, 1);
 498
 499         label=gtk_label_new("Severity filter: ");
 500         gtk_box_pack_start(GTK_BOX(severity_box), label, FALSE, FALSE, 0);
 501
 502         menu=gtk_menu_new();
 503         for(i=0; expert_severity_om_vals[i].strptr != NULL;i++){
 504                 menu_item=gtk_menu_item_new_with_label(expert_severity_om_vals[i].strptr);
 505                 g_object_set_data(G_OBJECT(menu_item), "tapdata", etd);
 506                 g_signal_connect(menu_item, "activate", G_CALLBACK(expert_dlg_severity_cb), (gpointer)(long) i);
 507                 gtk_menu_shell_append(GTK_MENU_SHELL(menu), menu_item);
 508                 if(expert_severity_om_vals[i].value == (guint) etd->severity_report_level) {
 509                         gtk_menu_set_active(GTK_MENU(menu), i);
 510                 }
 511         }
 512         severity_om=gtk_option_menu_new();
 513         gtk_option_menu_set_menu(GTK_OPTION_MENU(severity_om), menu);
 514         gtk_box_pack_start(GTK_BOX(severity_box), severity_om, FALSE, FALSE, 0);
 515
 516         /* We must display TOP LEVEL Widget before calling init_srt_table() */
 517         gtk_widget_show_all(etd->win);
 518
 519         expert_dlg_init_table(etd, vbox);
 520         /*for(i=0;i<256;i++){
 521                 init_srt_table_row(&etd->afp_srt_table, i, val_to_str(i, CommandCode_vals, "Unknown(%u)"));
 522         }*/
 523
 524         error_string=register_tap_listener("expert", etd, NULL /* fstring */,
 525                 0,
 526                 expert_dlg_reset,
 527                 expert_dlg_packet,
 528                 expert_dlg_draw);
 529         if(error_string){
 530                 simple_dialog(ESD_TYPE_ERROR, ESD_BTN_OK, "%s", error_string->str);
 531                 g_string_free(error_string, TRUE);
 532                 g_free(etd);
 533                 return;
 534         }
 535
 536         /* Button row. */
 537         bbox = dlg_button_row_new(GTK_STOCK_CLOSE, GTK_STOCK_HELP, NULL);
 538         gtk_box_pack_end(GTK_BOX(vbox), bbox, FALSE, FALSE, 0);
 539
 540         close_bt = g_object_get_data(G_OBJECT(bbox), GTK_STOCK_CLOSE);
 541         window_set_cancel_button(etd->win, close_bt, window_cancel_button_cb);
 542
 543         help_bt = g_object_get_data(G_OBJECT(bbox), GTK_STOCK_HELP);
 544         g_signal_connect(help_bt, "clicked", G_CALLBACK(topic_cb), (gpointer)HELP_EXPERT_INFO_DIALOG);
 545         gtk_tooltips_set_tip (tooltips, help_bt, "Show topic specific help", NULL);
 546
 547         g_signal_connect(etd->win, "delete_event", G_CALLBACK(window_delete_event_cb), NULL);
 548         g_signal_connect(etd->win, "destroy", G_CALLBACK(expert_dlg_destroy_cb), etd);
 549
 550         gtk_widget_show_all(etd->win);
 551         window_present(etd->win);
 552
 553         cf_retap_packets(&cfile);
 554
 555         /* This will bring up the progress bar
 556          * Put our window back in front
 557          */
 558         gdk_window_raise(etd->win->window);
 559
 560 }
 561
 562
 563 static void
 564 expert_dlg_cb(GtkWidget *w _U_, gpointer d _U_)
 565 {
 566         expert_dlg_init("", NULL);
 567 }
 568
 569
 570
 571
 572 void
 573 register_tap_listener_expert(void)
 574 {
 575         register_stat_cmd_arg("expert", expert_dlg_init,NULL);
 576
 577         register_stat_menu_item("E_xpert Info", REGISTER_ANALYZE_GROUP_UNSORTED,
 578         expert_dlg_cb, NULL, NULL, NULL);
 579 }