print.c

   1 /* print.c
   2  * Routines for printing packet analysis trees.
   3  *
   4  * $Id: print.c,v 1.15 1999/07/23 08:30:57 guy Exp $
   5  *
   6  * Gilbert Ramirez <gram@verdict.uthscsa.edu>
   7  *
   8  * Ethereal - Network traffic analyzer
   9  * By Gerald Combs <gerald@zing.org>
  10  * Copyright 1998 Gerald Combs
  11  *
  12  *
  13  * This program is free software; you can redistribute it and/or
  14  * modify it under the terms of the GNU General Public License
  15  * as published by the Free Software Foundation; either version 2
  16  * of the License, or (at your option) any later version.
  17  *
  18  * This program is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU General Public License for more details.
  22  *
  23  * You should have received a copy of the GNU General Public License
  24  * along with this program; if not, write to the Free Software
  25  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
  26  */
  27
  28 #ifdef HAVE_CONFIG_H
  29 # include "config.h"
  30 #endif
  31
  32 #include <gtk/gtk.h>
  33 #include <stdio.h>
  34 #include <string.h>
  35
  36 #ifdef HAVE_SYS_TYPES_H
  37 # include <sys/types.h>
  38 #endif
  39
  40 #include "ethereal.h"
  41 #include "packet.h"
  42 #include "gtkpacket.h"
  43 #include "prefs.h"
  44 #include "print.h"
  45 #include "ps.h"
  46
  47 static void printer_opts_file_cb(GtkWidget *w, gpointer te);
  48 static void printer_opts_fs_cancel_cb(GtkWidget *w, gpointer data);
  49 static void printer_opts_fs_ok_cb(GtkWidget *w, gpointer data);
  50 static void printer_opts_toggle_format(GtkWidget *widget, gpointer data);
  51 static void printer_opts_toggle_dest(GtkWidget *widget, gpointer data);
  52 static void proto_tree_print_node_text(GNode *node, gpointer data);
  53 static void dumpit (FILE *fh, register const u_char *cp, register u_int length);
  54 static void proto_tree_print_node_ps(GNode *node, gpointer data);
  55 static void ps_clean_string(unsigned char *out, const unsigned char *in,
  56                         int outbuf_size);
  57 static void dumpit_ps (FILE *fh, register const u_char *cp, register u_int length);
  58
  59 extern int proto_data; /* in packet-data.c */
  60
  61 /* #include "ps.c" */
  62
  63 /* Key for gtk_object_set_data */
  64 #define PRINT_CMD_TE_KEY  "printer_command_entry"
  65 #define PRINT_FILE_TE_KEY "printer_file_entry"
  66
  67 GtkWidget * printer_prefs_show()
  68 {
  69         GtkWidget       *main_vb, *main_tb, *button;
  70         GtkWidget       *format_hb, *format_lb;
  71         GtkWidget       *dest_hb, *dest_lb;
  72         GtkWidget       *cmd_lb, *cmd_te;
  73         GtkWidget       *file_bt_hb, *file_bt, *file_te;
  74         GSList          *format_grp, *dest_grp;
  75
  76         /* Enclosing containers for each row of widgets */
  77   main_vb = gtk_vbox_new(FALSE, 5);
  78   gtk_container_border_width(GTK_CONTAINER(main_vb), 5);
  79
  80         main_tb = gtk_table_new(4, 2, FALSE);
  81         gtk_box_pack_start(GTK_BOX(main_vb), main_tb, FALSE, FALSE, 0);
  82   gtk_table_set_row_spacings(GTK_TABLE(main_tb), 10);
  83   gtk_table_set_col_spacings(GTK_TABLE(main_tb), 15);
  84   gtk_widget_show(main_tb);
  85
  86         /* Output format */
  87         format_lb = gtk_label_new("Format:");
  88   gtk_misc_set_alignment(GTK_MISC(format_lb), 1.0, 0.5);
  89   gtk_table_attach_defaults(GTK_TABLE(main_tb), format_lb, 0, 1, 0, 1);
  90         gtk_widget_show(format_lb);
  91
  92         format_hb = gtk_hbox_new(FALSE, 0);
  93   gtk_table_attach_defaults(GTK_TABLE(main_tb), format_hb, 1, 2, 0, 1);
  94         gtk_widget_show(format_hb);
  95
  96         button = gtk_radio_button_new_with_label(NULL, "Plain Text");
  97         if (prefs.pr_format == PR_FMT_TEXT) {
  98                 gtk_toggle_button_set_state(GTK_TOGGLE_BUTTON(button), TRUE);
  99         }
 100         format_grp = gtk_radio_button_group(GTK_RADIO_BUTTON(button));
 101         gtk_box_pack_start(GTK_BOX(format_hb), button, FALSE, FALSE, 10);
 102         gtk_widget_show(button);
 103
 104         button = gtk_radio_button_new_with_label(format_grp, "PostScript");
 105         if (prefs.pr_format == PR_FMT_PS) {
 106                 gtk_toggle_button_set_state(GTK_TOGGLE_BUTTON(button), TRUE);
 107         }
 108         gtk_signal_connect(GTK_OBJECT(button), "toggled",
 109                         GTK_SIGNAL_FUNC(printer_opts_toggle_format), NULL);
 110         gtk_box_pack_start(GTK_BOX(format_hb), button, FALSE, FALSE, 10);
 111         gtk_widget_show(button);
 112
 113         /* Output destination */
 114         dest_lb = gtk_label_new("Print to:");
 115   gtk_misc_set_alignment(GTK_MISC(dest_lb), 1.0, 0.5);
 116   gtk_table_attach_defaults(GTK_TABLE(main_tb), dest_lb, 0, 1, 1, 2);
 117         gtk_widget_show(dest_lb);
 118
 119         dest_hb = gtk_hbox_new(FALSE, 0);
 120   gtk_table_attach_defaults(GTK_TABLE(main_tb), dest_hb, 1, 2, 1, 2);
 121         gtk_widget_show(dest_hb);
 122
 123         button = gtk_radio_button_new_with_label(NULL, "Command");
 124         if (prefs.pr_dest == PR_DEST_CMD) {
 125                 gtk_toggle_button_set_state(GTK_TOGGLE_BUTTON(button), TRUE);
 126         }
 127         dest_grp = gtk_radio_button_group(GTK_RADIO_BUTTON(button));
 128         gtk_box_pack_start(GTK_BOX(dest_hb), button, FALSE, FALSE, 10);
 129         gtk_widget_show(button);
 130
 131         button = gtk_radio_button_new_with_label(dest_grp, "File");
 132         if (prefs.pr_dest == PR_DEST_FILE) {
 133                 gtk_toggle_button_set_state(GTK_TOGGLE_BUTTON(button), TRUE);
 134         }
 135         gtk_signal_connect(GTK_OBJECT(button), "toggled",
 136                         GTK_SIGNAL_FUNC(printer_opts_toggle_dest), NULL);
 137         gtk_box_pack_start(GTK_BOX(dest_hb), button, FALSE, FALSE, 10);
 138         gtk_widget_show(button);
 139
 140         /* Command text entry */
 141         cmd_lb = gtk_label_new("Command:");
 142   gtk_misc_set_alignment(GTK_MISC(cmd_lb), 1.0, 0.5);
 143   gtk_table_attach_defaults(GTK_TABLE(main_tb), cmd_lb, 0, 1, 2, 3);
 144         gtk_widget_show(cmd_lb);
 145
 146         cmd_te = gtk_entry_new();
 147         gtk_object_set_data(GTK_OBJECT(main_vb), PRINT_CMD_TE_KEY, cmd_te);
 148         if (prefs.pr_cmd) gtk_entry_set_text(GTK_ENTRY(cmd_te), prefs.pr_cmd);
 149   gtk_table_attach_defaults(GTK_TABLE(main_tb), cmd_te, 1, 2, 2, 3);
 150         gtk_widget_show(cmd_te);
 151
 152         /* File button and text entry */
 153         file_bt_hb = gtk_hbox_new(FALSE, 0);
 154   gtk_table_attach_defaults(GTK_TABLE(main_tb), file_bt_hb, 0, 1, 3, 4);
 155         gtk_widget_show(file_bt_hb);
 156
 157         file_bt = gtk_button_new_with_label("File:");
 158         gtk_box_pack_end(GTK_BOX(file_bt_hb), file_bt, FALSE, FALSE, 0);
 159         gtk_widget_show(file_bt);
 160
 161         file_te = gtk_entry_new();
 162         gtk_object_set_data(GTK_OBJECT(main_vb), PRINT_FILE_TE_KEY, file_te);
 163         if (prefs.pr_file) gtk_entry_set_text(GTK_ENTRY(file_te), prefs.pr_file);
 164   gtk_table_attach_defaults(GTK_TABLE(main_tb), file_te, 1, 2, 3, 4);
 165         gtk_widget_show(file_te);
 166
 167         gtk_signal_connect(GTK_OBJECT(file_bt), "clicked",
 168                         GTK_SIGNAL_FUNC(printer_opts_file_cb), GTK_OBJECT(file_te));
 169
 170         gtk_widget_show(main_vb);
 171         return(main_vb);
 172 }
 173
 174
 175 static void
 176 printer_opts_file_cb(GtkWidget *file_bt, gpointer file_te) {
 177   GtkWidget *fs;
 178
 179   fs = gtk_file_selection_new ("Ethereal: Print to a File");
 180         gtk_object_set_data(GTK_OBJECT(fs), PRINT_FILE_TE_KEY, file_te);
 181
 182   gtk_signal_connect (GTK_OBJECT (GTK_FILE_SELECTION(fs)->ok_button),
 183     "clicked", (GtkSignalFunc) printer_opts_fs_ok_cb, fs);
 184
 185   /* Connect the cancel_button to destroy the widget */
 186   gtk_signal_connect (GTK_OBJECT (GTK_FILE_SELECTION(fs)->cancel_button),
 187     "clicked", (GtkSignalFunc) printer_opts_fs_cancel_cb, fs);
 188
 189   gtk_widget_show(fs);
 190 }
 191
 192 static void
 193 printer_opts_fs_ok_cb(GtkWidget *w, gpointer data) {
 194
 195         gtk_entry_set_text(GTK_ENTRY(gtk_object_get_data(GTK_OBJECT(data),
 196         PRINT_FILE_TE_KEY)),
 197                 gtk_file_selection_get_filename (GTK_FILE_SELECTION(data)));
 198         printer_opts_fs_cancel_cb(w, data);
 199 }
 200
 201 static void
 202 printer_opts_fs_cancel_cb(GtkWidget *w, gpointer data) {
 203
 204         gtk_widget_destroy(GTK_WIDGET(data));
 205 }
 206
 207 void
 208 printer_prefs_ok(GtkWidget *w)
 209 {
 210         if(prefs.pr_cmd) g_free(prefs.pr_cmd);
 211         prefs.pr_cmd =
 212                 g_strdup(gtk_entry_get_text(GTK_ENTRY(gtk_object_get_data(GTK_OBJECT(w),
 213     PRINT_CMD_TE_KEY))));
 214
 215         if(prefs.pr_file) g_free(prefs.pr_file);
 216         prefs.pr_file =
 217                 g_strdup(gtk_entry_get_text(GTK_ENTRY(gtk_object_get_data(GTK_OBJECT(w),
 218     PRINT_FILE_TE_KEY))));
 219 }
 220
 221 void
 222 printer_prefs_save(GtkWidget *w)
 223 {
 224         printer_prefs_ok(w);
 225 }
 226
 227 void
 228 printer_prefs_cancel(GtkWidget *w)
 229 {
 230 }
 231
 232 static void
 233 printer_opts_toggle_format(GtkWidget *widget, gpointer data)
 234 {
 235                 if (GTK_TOGGLE_BUTTON (widget)->active) {
 236                         prefs.pr_format = PR_FMT_PS;
 237                         /* toggle file/cmd */
 238                 }
 239                 else {
 240                         prefs.pr_format = PR_FMT_TEXT;
 241                         /* toggle file/cmd */
 242                 }
 243 }
 244
 245 static void
 246 printer_opts_toggle_dest(GtkWidget *widget, gpointer data)
 247 {
 248                 if (GTK_TOGGLE_BUTTON (widget)->active) {
 249                         prefs.pr_dest = PR_DEST_FILE;
 250                 }
 251                 else {
 252                         prefs.pr_dest = PR_DEST_CMD;
 253                 }
 254 }
 255
 256 /* ========================================================== */
 257
 258 typedef struct {
 259         int             level;
 260         FILE            *fh;
 261         const guint8    *pd;
 262 } print_data;
 263
 264 FILE *open_print_dest(int to_file, const char *dest)
 265 {
 266         FILE    *fh;
 267
 268         /* Open the file or command for output */
 269         if (to_file)
 270                 fh = fopen(dest, "w");
 271         else
 272                 fh = popen(dest, "w");
 273
 274         return fh;
 275 }
 276
 277 void close_print_dest(int to_file, FILE *fh)
 278 {
 279         /* Close the file or command */
 280         if (to_file)
 281                 fclose(fh);
 282         else
 283                 pclose(fh);
 284 }
 285
 286 void proto_tree_print(GNode *protocol_tree, const u_char *pd, frame_data *fd,
 287     FILE *fh)
 288 {
 289         print_data data;
 290
 291         /* Create the output */
 292         data.level = 0;
 293         data.fh = fh;
 294         data.pd = pd;
 295         if (prefs.pr_format == PR_FMT_TEXT) {
 296                 g_node_children_foreach((GNode*) protocol_tree, G_TRAVERSE_ALL,
 297                         proto_tree_print_node_text, &data);
 298         } else {
 299                 print_ps_preamble(fh);
 300                 g_node_children_foreach((GNode*) protocol_tree, G_TRAVERSE_ALL,
 301                         proto_tree_print_node_ps, &data);
 302                 print_ps_finale(fh);
 303         }
 304 }
 305
 306 /* Print a tree's data, and any child nodes, in plain text */
 307 static
 308 void proto_tree_print_node_text(GNode *node, gpointer data)
 309 {
 310         field_info      *fi = (field_info*) (node->data);
 311         print_data      *pdata = (print_data*) data;
 312         int             i;
 313         int              num_spaces;
 314         char            space[41];
 315         gchar           label_str[ITEM_LABEL_LENGTH];
 316         gchar           *label_ptr;
 317
 318         if (!fi->visible)
 319                 return;
 320
 321         /* was a free format label produced? */
 322         if (fi->representation) {
 323                 label_ptr = fi->representation;
 324         }
 325         else { /* no, make a generic label */
 326                 label_ptr = label_str;
 327                 proto_item_fill_label(fi, label_str);
 328         }
 329
 330         /* Prepare the tabs for printing, depending on tree level */
 331         num_spaces = pdata->level * 4;
 332         if (num_spaces > 40) {
 333                 num_spaces = 40;
 334         }
 335         for (i = 0; i < num_spaces; i++) {
 336                 space[i] = ' ';
 337         }
 338         /* The string is NUL-terminated */
 339         space[num_spaces] = 0;
 340
 341         /* Print the text */
 342         fprintf(pdata->fh, "%s%s\n", space, label_ptr);
 343
 344         /* If it's uninterpreted data, dump it. */
 345         if (fi->hfinfo->id == proto_data)
 346                 dumpit(pdata->fh, &pdata->pd[fi->start], fi->length);
 347
 348         /* Recurse into the subtree, if it exists */
 349         if (g_node_n_children(node) > 0) {
 350                 pdata->level++;
 351                 g_node_children_foreach(node, G_TRAVERSE_ALL,
 352                         proto_tree_print_node_text, pdata);
 353                 pdata->level--;
 354         }
 355 }
 356
 357 /* This routine was created by Dan Lasley <DLASLEY@PROMUS.com>, and
 358 only slightly modified for ethereal by Gilbert Ramirez. */
 359 static
 360 void dumpit (FILE *fh, register const u_char *cp, register u_int length)
 361 {
 362         register int ad, i, j, k;
 363         u_char c;
 364         u_char line[60];
 365                 static u_char binhex[16] = {
 366                         '0', '1', '2', '3', '4', '5', '6', '7',
 367                         '8', '9', 'a', 'b', 'c', 'd', 'e', 'f'};
 368
 369         memset (line, ' ', sizeof line);
 370         line[sizeof (line)-1] = 0;
 371         for (ad=i=j=k=0; i<length; i++) {
 372                 c = *cp++;
 373                 line[j++] = binhex[c>>4];
 374                 line[j++] = binhex[c&0xf];
 375                 if (i&1) j++;
 376                 line[42+k++] = c >= ' ' && c < 0x7f ? c : '.';
 377                 if ((i & 15) == 15) {
 378                         fprintf (fh, "\n%4x  %s", ad, line);
 379                         /*if (i==15) printf (" %d", length);*/
 380                         memset (line, ' ', sizeof line);
 381                         line[sizeof (line)-1] = j = k = 0;
 382                         ad += 16;
 383                 }
 384         }
 385
 386         if (line[0] != ' ') fprintf (fh, "\n%4x  %s", ad, line);
 387         fprintf(fh, "\n");
 388         return;
 389
 390 }
 391
 392 #define MAX_LINE_LENGTH 256
 393
 394 /* Print a node's data, and any child nodes, in PostScript */
 395 static
 396 void proto_tree_print_node_ps(GNode *node, gpointer data)
 397 {
 398         field_info      *fi = (field_info*) (node->data);
 399         print_data      *pdata = (print_data*) data;
 400         gchar           label_str[ITEM_LABEL_LENGTH];
 401         gchar           *label_ptr;
 402         char            psbuffer[MAX_LINE_LENGTH]; /* static sized buffer! */
 403
 404         if (!fi->visible)
 405                 return;
 406
 407         /* was a free format label produced? */
 408         if (fi->representation) {
 409                 label_ptr = fi->representation;
 410         }
 411         else { /* no, make a generic label */
 412                 label_ptr = label_str;
 413                 proto_item_fill_label(fi, label_str);
 414         }
 415
 416         /* Print the text */
 417         ps_clean_string(psbuffer, label_ptr, MAX_LINE_LENGTH);
 418         fprintf(pdata->fh, "%d (%s) putline\n", pdata->level, psbuffer);
 419
 420         /* If it's uninterpreted data, dump it. */
 421         if (fi->hfinfo->id == proto_data) {
 422                 print_ps_hex(pdata->fh);
 423                 dumpit_ps(pdata->fh, &pdata->pd[fi->start], fi->length);
 424         }
 425
 426         /* Recurse into the subtree, if it exists */
 427         if (g_node_n_children(node) > 0) {
 428                 pdata->level++;
 429                 g_node_children_foreach(node, G_TRAVERSE_ALL,
 430                         proto_tree_print_node_ps, pdata);
 431                 pdata->level--;
 432         }
 433 }
 434
 435 static
 436 void ps_clean_string(unsigned char *out, const unsigned char *in,
 437                         int outbuf_size)
 438 {
 439         int rd, wr;
 440         char c;
 441
 442         for (rd = 0, wr = 0 ; wr < outbuf_size; rd++, wr++ ) {
 443                 c = in[rd];
 444                 switch (c) {
 445                         case '(':
 446                         case ')':
 447                         case '\\':
 448                                 out[wr] = '\\';
 449                                 out[++wr] = c;
 450                                 break;
 451
 452                         default:
 453                                 out[wr] = c;
 454                                 break;
 455                 }
 456
 457                 if (c == 0) {
 458                         break;
 459                 }
 460         }
 461 }
 462
 463 static
 464 void dumpit_ps (FILE *fh, register const u_char *cp, register u_int length)
 465 {
 466         register int ad, i, j, k;
 467         u_char c;
 468         u_char line[60];
 469                 static u_char binhex[16] = {
 470                         '0', '1', '2', '3', '4', '5', '6', '7',
 471                         '8', '9', 'a', 'b', 'c', 'd', 'e', 'f'};
 472                 u_char psline[MAX_LINE_LENGTH];
 473
 474         memset (line, ' ', sizeof line);
 475         line[sizeof (line)-1] = 0;
 476         for (ad=i=j=k=0; i<length; i++) {
 477                 c = *cp++;
 478                 line[j++] = binhex[c>>4];
 479                 line[j++] = binhex[c&0xf];
 480                 if (i&1) j++;
 481                 line[42+k++] = c >= ' ' && c < 0x7f ? c : '.';
 482                 if ((i & 15) == 15) {
 483                                                 ps_clean_string(psline, line, MAX_LINE_LENGTH);
 484                         fprintf (fh, "(%4x  %s) hexdump\n", ad, psline);
 485                         memset (line, ' ', sizeof line);
 486                         line[sizeof (line)-1] = j = k = 0;
 487                         ad += 16;
 488                 }
 489         }
 490
 491         if (line[0] != ' ') {
 492                         ps_clean_string(psline, line, MAX_LINE_LENGTH);
 493                         fprintf (fh, "(%4x  %s) hexdump\n", ad, psline);
 494                 }
 495         return;
 496
 497 }