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