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