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