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
  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 typedef struct expert_tapdata_s {
  74         GtkWidget       *win;
  75         GtkWidget       *scrolled_window;
  76         GtkCList        *table;
  77         GtkWidget       *label;
  78         GList           *all_events;
  79         GList           *new_events;
  80         guint32         disp_events;
  81         guint32         chat_events;
  82         guint32         note_events;
  83         guint32         warn_events;
  84         guint32         error_events;
  85         int                     severity_report_level;
  86 } expert_tapdata_t;
  87
  88
  89 /* reset of display only, e.g. for filtering */
  90 static void expert_dlg_display_reset(expert_tapdata_t * etd)
  91 {
  92         etd->disp_events = 0;
  93         gtk_clist_clear(etd->table);
  94         gtk_clist_columns_autosize(etd->table);
  95
  96         gtk_window_set_title(GTK_WINDOW(etd->win), "Wireshark: ? Expert Infos");
  97         if(etd->label) {
  98                 gtk_label_set_text(GTK_LABEL(etd->label), "Please wait ...");
  99         }
 100 }
 101
 102
 103 /* complete reset, e.g. capture file closed */
 104 void expert_dlg_reset(void *tapdata)
 105 {
 106         expert_tapdata_t * etd = tapdata;
 107
 108         g_list_free(etd->all_events);
 109         etd->all_events = NULL;
 110         g_list_free(etd->new_events);
 111         etd->new_events = NULL;
 112         etd->chat_events = 0;
 113         etd->note_events = 0;
 114         etd->warn_events = 0;
 115         etd->error_events = 0;
 116
 117         expert_dlg_display_reset(etd);
 118 }
 119
 120 int expert_dlg_packet(void *tapdata, packet_info *pinfo _U_, epan_dissect_t *edt _U_, const void *pointer)
 121 {
 122     expert_info_t       *ei = se_memdup(pointer,sizeof(expert_info_t));
 123         expert_tapdata_t * etd = tapdata;
 124
 125     ei->protocol = se_strdup(ei->protocol);
 126     ei->summary = se_strdup(ei->summary);
 127
 128         switch(ei->severity) {
 129         case(PI_CHAT):
 130                 etd->chat_events++;
 131                 break;
 132         case(PI_NOTE):
 133                 etd->note_events++;
 134                 break;
 135         case(PI_WARN):
 136                 etd->warn_events++;
 137                 break;
 138         case(PI_ERROR):
 139                 etd->error_events++;
 140                 break;
 141         default:
 142                 g_assert_not_reached();
 143         }
 144
 145         /* insert(0) is a *lot* faster than append! */
 146         etd->new_events = g_list_insert(etd->new_events, ei, 0);
 147
 148         if(ei->severity < etd->severity_report_level) {
 149                 return 0; /* draw not required */
 150         } else {
 151                 return 1; /* draw required */
 152         }
 153 }
 154
 155 void
 156 expert_dlg_draw(void *data)
 157 {
 158         expert_tapdata_t *etd = data;
 159         int row;
 160         int displayed;
 161         char *strp;
 162         expert_info_t *ei;
 163         gchar *title;
 164         const char *entries[5];   /**< column entries */
 165
 166
 167         displayed = etd->disp_events;
 168
 169         if(etd->label) {
 170                 if(etd->new_events != NULL) {
 171                         title = g_strdup_printf("Adding: %u new messages",
 172                                 g_list_length(etd->new_events));
 173                         gtk_label_set_text(GTK_LABEL(etd->label), title);
 174                         g_free(title);
 175                 }
 176         }
 177
 178         gtk_clist_freeze(etd->table);
 179
 180         /* append new events (remove from new list, append to displayed list and clist) */
 181         while(etd->new_events != NULL){
 182                 ei = etd->new_events->data;
 183
 184                 etd->new_events = g_list_remove(etd->new_events, ei);
 185                 /* insert(0) is a *lot* faster than append! */
 186                 etd->all_events = g_list_insert(etd->all_events, ei, 0);
 187
 188                 if(ei->severity < etd->severity_report_level) {
 189                         continue;
 190                 }
 191                 etd->disp_events++;
 192
 193                 if(etd->disp_events == 1000)
 194                         gtk_clist_columns_autosize(etd->table);
 195
 196                 /* packet number */
 197                 if(ei->packet_num) {
 198                         /* XXX */
 199                         strp= se_strdup_printf("%u", ei->packet_num);
 200                         entries[0] = strp;
 201                         /*entries[0] = itoa(ei->packet_num, str, 10);*/
 202                 } else {
 203                         entries[0] = "-";
 204                 }
 205
 206                 /* severity */
 207                 entries[1] = val_to_str(ei->severity, expert_severity_vals, "Unknown severity (%u)");
 208
 209                 /* group */
 210                 entries[2] = val_to_str(ei->group, expert_group_vals, "Unknown group (%u)");
 211
 212                 /* protocol */
 213                 if(ei->protocol) {
 214                         entries[3] = ei->protocol;
 215                 } else {
 216                         entries[3] = "-";
 217                 }
 218
 219                 /* summary */
 220                 entries[4] = ei->summary;
 221
 222                 /*gtk_clist_set_pixmap(etd->table, row, 5, ascend_pm, ascend_bm);*/
 223
 224                 row=gtk_clist_append(etd->table, (gchar **) entries);
 225                 gtk_clist_set_row_data(etd->table, row, ei);
 226
 227                 /* set rows background color depending on severity */
 228                 switch(ei->severity) {
 229                 case(PI_CHAT):
 230                         gtk_clist_set_background(etd->table, row, &expert_color_chat);
 231                         break;
 232                 case(PI_NOTE):
 233                         gtk_clist_set_background(etd->table, row, &expert_color_note);
 234                         break;
 235                 case(PI_WARN):
 236                         gtk_clist_set_background(etd->table, row, &expert_color_warn);
 237                         break;
 238                 case(PI_ERROR):
 239                         gtk_clist_set_background(etd->table, row, &expert_color_error);
 240                         break;
 241                 default:
 242                         g_assert_not_reached();
 243                 }
 244                 gtk_clist_set_foreground(etd->table, row, &expert_color_foreground);
 245         }
 246
 247         gtk_clist_sort(etd->table);
 248         /* column autosizing is very slow for large number of entries,
 249          * so do it only for the first 1000 of it
 250          * (there might be no large changes behind this amount) */
 251         if(etd->disp_events < 1000)
 252                 gtk_clist_columns_autosize(etd->table);
 253         gtk_clist_moveto(etd->table,
 254                      etd->disp_events - 1, -1, 1.0f, 1.0f);
 255         gtk_clist_thaw(etd->table);
 256
 257         if(etd->label) {
 258                 title = g_strdup_printf("Errors: %u Warnings: %u Notes: %u Chats: %u",
 259                         etd->error_events, etd->warn_events, etd->note_events, etd->chat_events);
 260                         gtk_label_set_text(GTK_LABEL(etd->label), title);
 261                 g_free(title);
 262         }
 263
 264         title = g_strdup_printf("Wireshark: %u Expert Info%s",
 265                 etd->disp_events,
 266                 plurality(etd->disp_events, "", "s"));
 267         gtk_window_set_title(GTK_WINDOW(etd->win), title);
 268         g_free(title);
 269 }
 270
 271
 272 typedef struct column_arrows {
 273         GtkWidget *table;
 274         GtkWidget *ascend_pm;
 275         GtkWidget *descend_pm;
 276 } column_arrows;
 277
 278
 279 static gint
 280 srt_sort_column(GtkCList *clist, gconstpointer ptr1, gconstpointer ptr2)
 281 {
 282         char *text1 = NULL;
 283         char *text2 = NULL;
 284         int i1, i2;
 285
 286         const GtkCListRow *row1 = ptr1;
 287         const GtkCListRow *row2 = ptr2;
 288
 289         text1 = GTK_CELL_TEXT (row1->cell[clist->sort_column])->text;
 290         text2 = GTK_CELL_TEXT (row2->cell[clist->sort_column])->text;
 291
 292         switch(clist->sort_column){
 293         case 0:
 294                 i1=atoi(text1);
 295                 i2=atoi(text2);
 296                 return i1-i2;
 297         case 1:
 298         case 2:
 299         case 3:
 300         case 4:
 301                 return strcmp (text1, text2);
 302         }
 303         g_assert_not_reached();
 304         return 0;
 305 }
 306
 307
 308 static void
 309 srt_click_column_cb(GtkCList *clist, gint column, gpointer data)
 310 {
 311         column_arrows *col_arrows = (column_arrows *) data;
 312         int i;
 313
 314         gtk_clist_freeze(clist);
 315
 316         for (i = 0; i < 5; i++) {
 317                 gtk_widget_hide(col_arrows[i].ascend_pm);
 318                 gtk_widget_hide(col_arrows[i].descend_pm);
 319         }
 320
 321         if (column == clist->sort_column) {
 322                 if (clist->sort_type == GTK_SORT_ASCENDING) {
 323                         clist->sort_type = GTK_SORT_DESCENDING;
 324                         gtk_widget_show(col_arrows[column].descend_pm);
 325                 } else {
 326                         clist->sort_type = GTK_SORT_ASCENDING;
 327                         gtk_widget_show(col_arrows[column].ascend_pm);
 328                 }
 329         } else {
 330                 clist->sort_type = GTK_SORT_ASCENDING;
 331                 gtk_widget_show(col_arrows[column].ascend_pm);
 332                 gtk_clist_set_sort_column(clist, column);
 333         }
 334         gtk_clist_sort(clist);
 335
 336         gtk_clist_thaw(clist);
 337 }
 338
 339
 340 static void
 341 select_row_cb(GtkCList *clist, gint row, gint column _U_, GdkEventButton *event _U_, gpointer user_data _U_)
 342 {
 343         expert_info_t   *ei;
 344
 345
 346         ei = (expert_info_t *) gtk_clist_get_row_data(clist, row);
 347
 348         cf_goto_frame(&cfile, ei->packet_num);
 349 }
 350
 351
 352 void
 353 expert_dlg_init_table(expert_tapdata_t * etd, GtkWidget *vbox)
 354 {
 355         int i;
 356         column_arrows *col_arrows;
 357         GtkStyle *win_style;
 358         GtkWidget *column_lb;
 359         GdkBitmap *ascend_bm, *descend_bm;
 360         GdkPixmap *ascend_pm, *descend_pm;
 361         const char *default_titles[] = { "No.", "Sever.", "Group", "Protocol", "Summary" };
 362
 363
 364         etd->scrolled_window=scrolled_window_new(NULL, NULL);
 365         gtk_box_pack_start(GTK_BOX(vbox), etd->scrolled_window, TRUE, TRUE, 0);
 366
 367         etd->table=(GtkCList *)gtk_clist_new(5);
 368         g_signal_connect(etd->table, "select-row", G_CALLBACK(select_row_cb), etd);
 369
 370         gtk_widget_show(GTK_WIDGET(etd->table));
 371         gtk_widget_show(etd->scrolled_window);
 372
 373         col_arrows = (column_arrows *) g_malloc(sizeof(column_arrows) * 5);
 374         win_style = gtk_widget_get_style(etd->scrolled_window);
 375         ascend_pm = gdk_pixmap_create_from_xpm_d(etd->scrolled_window->window,
 376                         &ascend_bm,
 377                         &win_style->bg[GTK_STATE_NORMAL],
 378                         (gchar **)clist_ascend_xpm);
 379         descend_pm = gdk_pixmap_create_from_xpm_d(etd->scrolled_window->window,
 380                         &descend_bm,
 381                         &win_style->bg[GTK_STATE_NORMAL],
 382                         (gchar **)clist_descend_xpm);
 383         for (i = 0; i < 5; i++) {
 384                 col_arrows[i].table = gtk_table_new(2, 2, FALSE);
 385                 gtk_table_set_col_spacings(GTK_TABLE(col_arrows[i].table), 5);
 386                 column_lb = gtk_label_new(default_titles[i]);
 387                 gtk_table_attach(GTK_TABLE(col_arrows[i].table), column_lb, 0, 1, 0, 2, GTK_SHRINK, GTK_SHRINK, 0, 0);
 388                 gtk_widget_show(column_lb);
 389
 390                 col_arrows[i].ascend_pm = gtk_pixmap_new(ascend_pm, ascend_bm);
 391                 gtk_table_attach(GTK_TABLE(col_arrows[i].table), col_arrows[i].ascend_pm, 1, 2, 1, 2, GTK_SHRINK, GTK_SHRINK, 0, 0);
 392                 col_arrows[i].descend_pm = gtk_pixmap_new(descend_pm, descend_bm);
 393                 gtk_table_attach(GTK_TABLE(col_arrows[i].table), col_arrows[i].descend_pm, 1, 2, 0, 1, GTK_SHRINK, GTK_SHRINK, 0, 0);
 394                 if (i == 0) {
 395                         gtk_widget_show(col_arrows[i].ascend_pm);
 396                 }
 397                 gtk_clist_set_column_widget(GTK_CLIST(etd->table), i, col_arrows[i].table);
 398                 gtk_widget_show(col_arrows[i].table);
 399         }
 400         gtk_clist_column_titles_show(GTK_CLIST(etd->table));
 401
 402         gtk_clist_set_compare_func(etd->table, srt_sort_column);
 403         gtk_clist_set_sort_column(etd->table, 0);
 404         gtk_clist_set_sort_type(etd->table, GTK_SORT_ASCENDING);
 405
 406         gtk_clist_set_column_justification(etd->table, 0, GTK_JUSTIFY_RIGHT);
 407         gtk_clist_set_column_justification(etd->table, 3, GTK_JUSTIFY_RIGHT);
 408         gtk_clist_set_shadow_type(etd->table, GTK_SHADOW_IN);
 409         gtk_clist_column_titles_show(etd->table);
 410         gtk_clist_columns_autosize(etd->table);
 411 /*      gtk_clist_set_selection_mode(etd->table, GTK_SELECTION_SINGLE);*/
 412 /*    gtk_list_set_selection_mode(GTK_LIST(etd->table), GTK_SELECTION_BROWSE);*/
 413 /*    gtk_list_select_item(GTK_LIST(value_list), 0);*/
 414         gtk_container_add(GTK_CONTAINER(etd->scrolled_window), (GtkWidget *)etd->table);
 415
 416         g_signal_connect(etd->table, "click-column", G_CALLBACK(srt_click_column_cb), col_arrows);
 417
 418         gtk_widget_show(GTK_WIDGET(etd->table));
 419         gtk_widget_show(etd->scrolled_window);
 420
 421         /* create popup menu for this table */
 422         /*if(etd->filter_string){
 423                 srt_create_popup_menu(etd);
 424         }*/
 425 }
 426
 427 static void
 428 expert_dlg_destroy_cb(GtkWindow *win _U_, gpointer data)
 429 {
 430         expert_tapdata_t *etd=(expert_tapdata_t *)data;
 431
 432         protect_thread_critical_region();
 433         remove_tap_listener(etd);
 434         unprotect_thread_critical_region();
 435
 436         /*free_srt_table_data(&etd->afp_srt_table);*/
 437         g_free(etd);
 438 }
 439
 440
 441 static void
 442 expert_dlg_severity_cb(GtkWidget *w, gpointer data)
 443 {
 444         int i = GPOINTER_TO_INT(data);
 445         expert_tapdata_t * etd;
 446
 447
 448         etd = g_object_get_data(G_OBJECT(w), "tapdata");
 449
 450         etd->severity_report_level = expert_severity_om_vals[i].value;
 451
 452         /* "move" all events from "all" back to "new" lists */
 453         protect_thread_critical_region();
 454         etd->new_events = g_list_concat(etd->new_events, etd->all_events);
 455         etd->all_events = NULL;
 456         unprotect_thread_critical_region();
 457
 458         /* redraw table */
 459         expert_dlg_display_reset(etd);
 460         expert_dlg_draw(etd);
 461 }
 462
 463
 464 static void
 465 expert_dlg_init(const char *optarg, void* userdata _U_)
 466 {
 467         expert_tapdata_t * etd;
 468         const char *filter=NULL;
 469         GString *error_string;
 470         GtkWidget *vbox;
 471         GtkWidget *table;
 472         GtkWidget *bbox;
 473         GtkWidget *close_bt;
 474         GtkWidget *help_bt;
 475
 476         GtkWidget *severity_box;
 477         GtkWidget *severity_om;
 478         GtkWidget *menu;
 479         GtkWidget *menu_item;
 480         GtkWidget *label;
 481         GtkTooltips *tooltips = gtk_tooltips_new();
 482         int i;
 483
 484         if(!strncmp(optarg,"afp,srt,",8)){
 485                 filter=optarg+8;
 486         } else {
 487                 filter=NULL;
 488         }
 489
 490         proto_draw_colors_init();
 491
 492         etd=g_malloc(sizeof(expert_tapdata_t));
 493         etd->all_events = NULL;
 494         etd->new_events = NULL;
 495         etd->disp_events = 0;
 496         etd->chat_events = 0;
 497         etd->note_events = 0;
 498         etd->warn_events = 0;
 499         etd->error_events = 0;
 500         etd->severity_report_level = PI_CHAT;
 501
 502         etd->win=window_new(GTK_WINDOW_TOPLEVEL, "Wireshark: Expert Info");
 503         gtk_window_set_default_size(GTK_WINDOW(etd->win), 650, 600);
 504
 505         vbox=gtk_vbox_new(FALSE, 3);
 506         gtk_container_add(GTK_CONTAINER(etd->win), vbox);
 507         gtk_container_set_border_width(GTK_CONTAINER(vbox), 12);
 508
 509         table = gtk_table_new(1, 2, TRUE /* homogeneous */);
 510         gtk_box_pack_start(GTK_BOX(vbox), table, FALSE, FALSE, 0);
 511
 512         etd->label=gtk_label_new("Please wait ...");
 513         gtk_misc_set_alignment(GTK_MISC(etd->label), 0.0f, 0.5f);
 514         gtk_table_attach_defaults(GTK_TABLE(table), etd->label, 0, 1, 0, 1);
 515
 516         severity_box = gtk_hbox_new(FALSE, 0);
 517         gtk_table_attach_defaults(GTK_TABLE(table), severity_box, 1, 2, 0, 1);
 518
 519         label=gtk_label_new("Severity filter: ");
 520         gtk_box_pack_start(GTK_BOX(severity_box), label, FALSE, FALSE, 0);
 521
 522         menu=gtk_menu_new();
 523         for(i=0; expert_severity_om_vals[i].strptr != NULL;i++){
 524                 menu_item=gtk_menu_item_new_with_label(expert_severity_om_vals[i].strptr);
 525                 g_object_set_data(G_OBJECT(menu_item), "tapdata", etd);
 526                 g_signal_connect(menu_item, "activate", G_CALLBACK(expert_dlg_severity_cb), (gpointer)(long) i);
 527                 gtk_menu_shell_append(GTK_MENU_SHELL(menu), menu_item);
 528                 if(expert_severity_om_vals[i].value == (guint) etd->severity_report_level) {
 529                         gtk_menu_set_active(GTK_MENU(menu), i);
 530                 }
 531         }
 532         severity_om=gtk_option_menu_new();
 533         gtk_option_menu_set_menu(GTK_OPTION_MENU(severity_om), menu);
 534         gtk_box_pack_start(GTK_BOX(severity_box), severity_om, FALSE, FALSE, 0);
 535
 536         /* We must display TOP LEVEL Widget before calling init_srt_table() */
 537         gtk_widget_show_all(etd->win);
 538
 539         expert_dlg_init_table(etd, vbox);
 540         /*for(i=0;i<256;i++){
 541                 init_srt_table_row(&etd->afp_srt_table, i, val_to_str(i, CommandCode_vals, "Unknown(%u)"));
 542         }*/
 543
 544         error_string=register_tap_listener("expert", etd, NULL /* fstring */,
 545                 0,
 546                 expert_dlg_reset,
 547                 expert_dlg_packet,
 548                 expert_dlg_draw);
 549         if(error_string){
 550                 simple_dialog(ESD_TYPE_ERROR, ESD_BTN_OK, "%s", error_string->str);
 551                 g_string_free(error_string, TRUE);
 552                 g_free(etd);
 553                 return;
 554         }
 555
 556         /* Button row. */
 557         bbox = dlg_button_row_new(GTK_STOCK_CLOSE, GTK_STOCK_HELP, NULL);
 558         gtk_box_pack_end(GTK_BOX(vbox), bbox, FALSE, FALSE, 0);
 559
 560         close_bt = g_object_get_data(G_OBJECT(bbox), GTK_STOCK_CLOSE);
 561         window_set_cancel_button(etd->win, close_bt, window_cancel_button_cb);
 562
 563         help_bt = g_object_get_data(G_OBJECT(bbox), GTK_STOCK_HELP);
 564         g_signal_connect(help_bt, "clicked", G_CALLBACK(topic_cb), (gpointer)HELP_EXPERT_INFO_DIALOG);
 565         gtk_tooltips_set_tip (tooltips, help_bt, "Show topic specific help", NULL);
 566
 567         g_signal_connect(etd->win, "delete_event", G_CALLBACK(window_delete_event_cb), NULL);
 568         g_signal_connect(etd->win, "destroy", G_CALLBACK(expert_dlg_destroy_cb), etd);
 569
 570         gtk_widget_show_all(etd->win);
 571         window_present(etd->win);
 572
 573         cf_retap_packets(&cfile);
 574
 575         /* This will bring up the progress bar
 576          * Put our window back in front
 577          */
 578         gdk_window_raise(etd->win->window);
 579
 580 }
 581
 582
 583 static void
 584 expert_dlg_cb(GtkWidget *w _U_, gpointer d _U_)
 585 {
 586         expert_dlg_init("", NULL);
 587 }
 588
 589
 590
 591
 592 void
 593 register_tap_listener_expert(void)
 594 {
 595         register_stat_cmd_arg("expert", expert_dlg_init,NULL);
 596
 597         register_stat_menu_item("E_xpert Info", REGISTER_ANALYZE_GROUP_UNSORTED,
 598         expert_dlg_cb, NULL, NULL, NULL);
 599 }