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