print.c

   1 /* print.c
   2  * Routines for printing packet analysis trees.
   3  *
   4  * $Id: print.c,v 1.32 2001/03/24 23:49:14 guy Exp $
   5  *
   6  * Gilbert Ramirez <gram@xiexie.org>
   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 <stdio.h>
  33 #include <string.h>
  34
  35 #ifdef HAVE_SYS_TYPES_H
  36 # include <sys/types.h>
  37 #endif
  38
  39 #include "packet.h"
  40 #include "print.h"
  41 #include "ps.h"
  42 #include "util.h"
  43
  44 static void proto_tree_print_node_text(GNode *node, gpointer data);
  45 static void proto_tree_print_node_ps(GNode *node, gpointer data);
  46 static void ps_clean_string(unsigned char *out, const unsigned char *in,
  47                         int outbuf_size);
  48 static void print_hex_data_text(FILE *fh, register const u_char *cp,
  49                 register u_int length, char_enc encoding);
  50 static void print_hex_data_ps(FILE *fh, register const u_char *cp,
  51                 register u_int length, char_enc encoding);
  52
  53 extern int proto_data; /* in packet-data.c */
  54
  55
  56 typedef struct {
  57         int             level;
  58         FILE            *fh;
  59         const guint8    *pd;
  60         gboolean        print_all_levels;
  61         gboolean        print_hex_for_data;
  62         char_enc        encoding;
  63 } print_data;
  64
  65 FILE *open_print_dest(int to_file, const char *dest)
  66 {
  67         FILE    *fh;
  68
  69         /* Open the file or command for output */
  70         if (to_file)
  71                 fh = fopen(dest, "w");
  72         else
  73                 fh = popen(dest, "w");
  74
  75         return fh;
  76 }
  77
  78 void close_print_dest(int to_file, FILE *fh)
  79 {
  80         /* Close the file or command */
  81         if (to_file)
  82                 fclose(fh);
  83         else
  84                 pclose(fh);
  85 }
  86
  87 void print_preamble(FILE *fh, gint format)
  88 {
  89         if (format == PR_FMT_PS)
  90                 print_ps_preamble(fh);
  91 }
  92
  93 void print_finale(FILE *fh, gint format)
  94 {
  95         if (format == PR_FMT_PS)
  96                 print_ps_finale(fh);
  97 }
  98
  99 void proto_tree_print(gboolean print_one_packet, print_args_t *print_args,
 100     GNode *protocol_tree, const u_char *pd, frame_data *fd, FILE *fh)
 101 {
 102         print_data data;
 103
 104         /* Create the output */
 105         data.level = 0;
 106         data.fh = fh;
 107         data.pd = pd;
 108         data.encoding = fd->flags.encoding;
 109         data.print_all_levels = print_args->expand_all;
 110         data.print_hex_for_data = !print_args->print_hex;
 111             /* If we're printing the entire packet in hex, don't
 112                print uninterpreted data fields in hex as well. */
 113
 114         if (print_args->format == PR_FMT_TEXT) {
 115                 g_node_children_foreach((GNode*) protocol_tree, G_TRAVERSE_ALL,
 116                         proto_tree_print_node_text, &data);
 117         } else {
 118                 g_node_children_foreach((GNode*) protocol_tree, G_TRAVERSE_ALL,
 119                         proto_tree_print_node_ps, &data);
 120         }
 121 }
 122
 123 /* Print a tree's data, and any child nodes, in plain text */
 124 static
 125 void proto_tree_print_node_text(GNode *node, gpointer data)
 126 {
 127         field_info      *fi = (field_info*) (node->data);
 128         print_data      *pdata = (print_data*) data;
 129         int             i;
 130         int             num_spaces;
 131         char            space[41];
 132         gchar           label_str[ITEM_LABEL_LENGTH];
 133         gchar           *label_ptr;
 134
 135         /* Don't print invisible entries. */
 136         if (!fi->visible)
 137                 return;
 138
 139         /* was a free format label produced? */
 140         if (fi->representation) {
 141                 label_ptr = fi->representation;
 142         }
 143         else { /* no, make a generic label */
 144                 label_ptr = label_str;
 145                 proto_item_fill_label(fi, label_str);
 146         }
 147
 148         /* Prepare the tabs for printing, depending on tree level */
 149         num_spaces = pdata->level * 4;
 150         if (num_spaces > 40) {
 151                 num_spaces = 40;
 152         }
 153         for (i = 0; i < num_spaces; i++) {
 154                 space[i] = ' ';
 155         }
 156         /* The string is NUL-terminated */
 157         space[num_spaces] = 0;
 158
 159         /* Print the text */
 160         fprintf(pdata->fh, "%s%s\n", space, label_ptr);
 161
 162         /* If it's uninterpreted data, dump it (unless our caller will
 163            be printing the entire packet in hex). */
 164         if (fi->hfinfo->id == proto_data && pdata->print_hex_for_data)
 165                 print_hex_data_text(pdata->fh, &pdata->pd[fi->start],
 166                                 fi->length, pdata->encoding);
 167
 168         /* If we're printing all levels, or if this level is expanded,
 169            recurse into the subtree, if it exists. */
 170         if (pdata->print_all_levels || tree_is_expanded[fi->tree_type]) {
 171                 if (g_node_n_children(node) > 0) {
 172                         pdata->level++;
 173                         g_node_children_foreach(node, G_TRAVERSE_ALL,
 174                                 proto_tree_print_node_text, pdata);
 175                         pdata->level--;
 176                 }
 177         }
 178 }
 179
 180 void print_hex_data(FILE *fh, gint format, frame_data *fd)
 181 {
 182         gboolean multiple_sources;
 183         GSList *src;
 184         tvbuff_t *tvb;
 185         char *name;
 186         char *line;
 187         const u_char *cp;
 188         guint length;
 189
 190         /*
 191          * Set "multiple_sources" iff this frame has more than one
 192          * data source; if it does, we need to print the name of
 193          * the data source before printing the data from the
 194          * data source.
 195          */
 196         multiple_sources = (fd->data_src->next != NULL);
 197
 198         for (src = fd->data_src; src != NULL; src = src->next) {
 199                 tvb = src->data;
 200                 if (multiple_sources) {
 201                         name = tvb_get_name(tvb);
 202                         print_line(fh, format, "\n");
 203                         line = g_malloc(strlen(name) + 3);      /* <name>:\n\0 */
 204                         strcpy(line, name);
 205                         strcat(line, ":\n");
 206                         print_line(fh, format, line);
 207                         g_free(line);
 208                 }
 209                 length = tvb_length(tvb);
 210                 cp = tvb_get_ptr(tvb, 0, length);
 211                 if (format == PR_FMT_PS)
 212                         print_hex_data_ps(fh, cp, length, fd->flags.encoding);
 213                 else
 214                         print_hex_data_text(fh, cp, length, fd->flags.encoding);
 215         }
 216 }
 217
 218 /* This routine was created by Dan Lasley <DLASLEY@PROMUS.com>, and
 219 only slightly modified for ethereal by Gilbert Ramirez. */
 220 static
 221 void print_hex_data_text(FILE *fh, register const u_char *cp,
 222                 register u_int length, char_enc encoding)
 223 {
 224         register int ad, i, j, k;
 225         u_char c;
 226         u_char line[60];
 227         static u_char binhex[16] = {
 228                 '0', '1', '2', '3', '4', '5', '6', '7',
 229                 '8', '9', 'a', 'b', 'c', 'd', 'e', 'f'};
 230
 231         memset (line, ' ', sizeof line);
 232         line[sizeof (line)-1] = 0;
 233         for (ad=i=j=k=0; i<length; i++) {
 234                 c = *cp++;
 235                 line[j++] = binhex[c>>4];
 236                 line[j++] = binhex[c&0xf];
 237                 if (i&1) j++;
 238                 if (encoding == CHAR_EBCDIC) {
 239                         c = EBCDIC_to_ASCII1(c);
 240                 }
 241                 line[42+k++] = c >= ' ' && c < 0x7f ? c : '.';
 242                 if ((i & 15) == 15) {
 243                         fprintf (fh, "\n%4x  %s", ad, line);
 244                         /*if (i==15) printf (" %d", length);*/
 245                         memset (line, ' ', sizeof line);
 246                         line[sizeof (line)-1] = j = k = 0;
 247                         ad += 16;
 248                 }
 249         }
 250
 251         if (line[0] != ' ') fprintf (fh, "\n%4x  %s", ad, line);
 252         fprintf(fh, "\n");
 253         return;
 254
 255 }
 256
 257 #define MAX_LINE_LENGTH 256
 258
 259 /* Print a node's data, and any child nodes, in PostScript */
 260 static
 261 void proto_tree_print_node_ps(GNode *node, gpointer data)
 262 {
 263         field_info      *fi = (field_info*) (node->data);
 264         print_data      *pdata = (print_data*) data;
 265         gchar           label_str[ITEM_LABEL_LENGTH];
 266         gchar           *label_ptr;
 267         char            psbuffer[MAX_LINE_LENGTH]; /* static sized buffer! */
 268
 269         if (!fi->visible)
 270                 return;
 271
 272         /* was a free format label produced? */
 273         if (fi->representation) {
 274                 label_ptr = fi->representation;
 275         }
 276         else { /* no, make a generic label */
 277                 label_ptr = label_str;
 278                 proto_item_fill_label(fi, label_str);
 279         }
 280
 281         /* Print the text */
 282         ps_clean_string(psbuffer, label_ptr, MAX_LINE_LENGTH);
 283         fprintf(pdata->fh, "%d (%s) putline\n", pdata->level, psbuffer);
 284
 285         /* If it's uninterpreted data, dump it (unless our caller will
 286            be printing the entire packet in hex). */
 287         if (fi->hfinfo->id == proto_data && pdata->print_hex_for_data) {
 288                 print_hex_data_ps(pdata->fh, &pdata->pd[fi->start], fi->length,
 289                                 pdata->encoding);
 290         }
 291
 292         /* Recurse into the subtree, if it exists */
 293         if (g_node_n_children(node) > 0) {
 294                 pdata->level++;
 295                 g_node_children_foreach(node, G_TRAVERSE_ALL,
 296                         proto_tree_print_node_ps, pdata);
 297                 pdata->level--;
 298         }
 299 }
 300
 301 static
 302 void ps_clean_string(unsigned char *out, const unsigned char *in,
 303                         int outbuf_size)
 304 {
 305         int rd, wr;
 306         char c;
 307
 308         for (rd = 0, wr = 0 ; wr < outbuf_size; rd++, wr++ ) {
 309                 c = in[rd];
 310                 switch (c) {
 311                         case '(':
 312                         case ')':
 313                         case '\\':
 314                                 out[wr] = '\\';
 315                                 out[++wr] = c;
 316                                 break;
 317
 318                         default:
 319                                 out[wr] = c;
 320                                 break;
 321                 }
 322
 323                 if (c == 0) {
 324                         break;
 325                 }
 326         }
 327 }
 328
 329 static
 330 void print_hex_data_ps(FILE *fh, register const u_char *cp,
 331                 register u_int length, char_enc encoding)
 332 {
 333         register int ad, i, j, k;
 334         u_char c;
 335         u_char line[60];
 336         static u_char binhex[16] = {
 337                 '0', '1', '2', '3', '4', '5', '6', '7',
 338                 '8', '9', 'a', 'b', 'c', 'd', 'e', 'f'};
 339         u_char psline[MAX_LINE_LENGTH];
 340
 341         print_ps_hex(fh);
 342         memset (line, ' ', sizeof line);
 343         line[sizeof (line)-1] = 0;
 344         for (ad=i=j=k=0; i<length; i++) {
 345                 c = *cp++;
 346                 line[j++] = binhex[c>>4];
 347                 line[j++] = binhex[c&0xf];
 348                 if (i&1) j++;
 349                 if (encoding == CHAR_EBCDIC) {
 350                         c = EBCDIC_to_ASCII1(c);
 351                 }
 352                 line[42+k++] = c >= ' ' && c < 0x7f ? c : '.';
 353                 if ((i & 15) == 15) {
 354                         ps_clean_string(psline, line, MAX_LINE_LENGTH);
 355                         fprintf (fh, "(%4x  %s) hexdump\n", ad, psline);
 356                         memset (line, ' ', sizeof line);
 357                         line[sizeof (line)-1] = j = k = 0;
 358                         ad += 16;
 359                 }
 360         }
 361
 362         if (line[0] != ' ') {
 363                 ps_clean_string(psline, line, MAX_LINE_LENGTH);
 364                 fprintf (fh, "(%4x  %s) hexdump\n", ad, psline);
 365         }
 366         return;
 367
 368 }
 369
 370 void print_line(FILE *fh, gint format, char *line)
 371 {
 372         char            psbuffer[MAX_LINE_LENGTH]; /* static sized buffer! */
 373
 374         if (format == PR_FMT_PS) {
 375                 ps_clean_string(psbuffer, line, MAX_LINE_LENGTH);
 376                 fprintf(fh, "(%s) hexdump\n", psbuffer);
 377         } else
 378                 fputs(line, fh);
 379 }