wireshark/print.c

412 lines
10 KiB
C

/* print.c
* Routines for printing packet analysis trees.
*
* $Id: print.c,v 1.37 2001/11/13 23:55:30 gram Exp $
*
* Gilbert Ramirez <gram@alumni.rice.edu>
*
* Ethereal - Network traffic analyzer
* By Gerald Combs <gerald@ethereal.com>
* Copyright 1998 Gerald Combs
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
* as published by the Free Software Foundation; either version 2
* of the License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
*/
#ifdef HAVE_CONFIG_H
# include "config.h"
#endif
#include <stdio.h>
#include <string.h>
#ifdef HAVE_SYS_TYPES_H
# include <sys/types.h>
#endif
#include "packet.h"
#include "print.h"
#include "ps.h"
#include "util.h"
#include "tvbuff.h"
static void proto_tree_print_node_text(GNode *node, gpointer data);
static void proto_tree_print_node_ps(GNode *node, gpointer data);
static void ps_clean_string(unsigned char *out, const unsigned char *in,
int outbuf_size);
static void print_hex_data_text(FILE *fh, register const u_char *cp,
register u_int length, char_enc encoding);
static void print_hex_data_ps(FILE *fh, register const u_char *cp,
register u_int length, char_enc encoding);
extern int proto_data; /* in packet-data.c */
typedef struct {
int level;
FILE *fh;
GSList *src_list;
gboolean print_all_levels;
gboolean print_hex_for_data;
char_enc encoding;
} print_data;
FILE *open_print_dest(int to_file, const char *dest)
{
FILE *fh;
/* Open the file or command for output */
if (to_file)
fh = fopen(dest, "w");
else
fh = popen(dest, "w");
return fh;
}
void close_print_dest(int to_file, FILE *fh)
{
/* Close the file or command */
if (to_file)
fclose(fh);
else
pclose(fh);
}
void print_preamble(FILE *fh, gint format)
{
if (format == PR_FMT_PS)
print_ps_preamble(fh);
}
void print_finale(FILE *fh, gint format)
{
if (format == PR_FMT_PS)
print_ps_finale(fh);
}
void proto_tree_print(gboolean print_one_packet, print_args_t *print_args,
GNode *protocol_tree, frame_data *fd, FILE *fh)
{
print_data data;
/* Create the output */
data.level = 0;
data.fh = fh;
data.src_list = fd->data_src;
data.encoding = fd->flags.encoding;
data.print_all_levels = print_args->expand_all;
data.print_hex_for_data = !print_args->print_hex;
/* If we're printing the entire packet in hex, don't
print uninterpreted data fields in hex as well. */
if (print_args->format == PR_FMT_TEXT) {
g_node_children_foreach((GNode*) protocol_tree, G_TRAVERSE_ALL,
proto_tree_print_node_text, &data);
} else {
g_node_children_foreach((GNode*) protocol_tree, G_TRAVERSE_ALL,
proto_tree_print_node_ps, &data);
}
}
/*
* Find the data source tvbuff with a specified name, and return a
* pointer to the data in it.
*/
static const guint8 *
get_field_data(GSList *src_list, field_info *fi)
{
GSList *src;
tvbuff_t *src_tvb;
for (src = src_list; src != NULL; src = g_slist_next(src)) {
src_tvb = src->data;
if (strcmp(fi->ds_name, tvb_get_name(src_tvb)) == 0) {
/*
* Found it.
*/
return tvb_get_ptr(src_tvb, fi->start, fi->length);
}
}
g_assert_not_reached();
return NULL; /* not found */
}
/* Print a tree's data, and any child nodes, in plain text */
static
void proto_tree_print_node_text(GNode *node, gpointer data)
{
field_info *fi = (field_info*) (node->data);
print_data *pdata = (print_data*) data;
int i;
int num_spaces;
char space[41];
const guint8 *pd;
gchar label_str[ITEM_LABEL_LENGTH];
gchar *label_ptr;
/* Don't print invisible entries. */
if (!fi->visible)
return;
/* was a free format label produced? */
if (fi->representation) {
label_ptr = fi->representation;
}
else { /* no, make a generic label */
label_ptr = label_str;
proto_item_fill_label(fi, label_str);
}
/* Prepare the tabs for printing, depending on tree level */
num_spaces = pdata->level * 4;
if (num_spaces > 40) {
num_spaces = 40;
}
for (i = 0; i < num_spaces; i++) {
space[i] = ' ';
}
/* The string is NUL-terminated */
space[num_spaces] = 0;
/* Print the text */
fprintf(pdata->fh, "%s%s\n", space, label_ptr);
/* If it's uninterpreted data, dump it (unless our caller will
be printing the entire packet in hex). */
if (fi->hfinfo->id == proto_data && pdata->print_hex_for_data) {
/*
* Find the data for this field.
*/
pd = get_field_data(pdata->src_list, fi);
print_hex_data_text(pdata->fh, pd, fi->length, pdata->encoding);
}
/* If we're printing all levels, or if this level is expanded,
recurse into the subtree, if it exists. */
if (pdata->print_all_levels || tree_is_expanded[fi->tree_type]) {
if (g_node_n_children(node) > 0) {
pdata->level++;
g_node_children_foreach(node, G_TRAVERSE_ALL,
proto_tree_print_node_text, pdata);
pdata->level--;
}
}
}
void print_hex_data(FILE *fh, gint format, frame_data *fd)
{
gboolean multiple_sources;
GSList *src;
tvbuff_t *tvb;
char *name;
char *line;
const u_char *cp;
guint length;
/*
* Set "multiple_sources" iff this frame has more than one
* data source; if it does, we need to print the name of
* the data source before printing the data from the
* data source.
*/
multiple_sources = (fd->data_src->next != NULL);
for (src = fd->data_src; src != NULL; src = src->next) {
tvb = src->data;
if (multiple_sources) {
name = tvb_get_name(tvb);
print_line(fh, format, "\n");
line = g_malloc(strlen(name) + 3); /* <name>:\n\0 */
strcpy(line, name);
strcat(line, ":\n");
print_line(fh, format, line);
g_free(line);
}
length = tvb_length(tvb);
cp = tvb_get_ptr(tvb, 0, length);
if (format == PR_FMT_PS)
print_hex_data_ps(fh, cp, length, fd->flags.encoding);
else
print_hex_data_text(fh, cp, length, fd->flags.encoding);
}
}
/* This routine was created by Dan Lasley <DLASLEY@PROMUS.com>, and
only slightly modified for ethereal by Gilbert Ramirez. */
static
void print_hex_data_text(FILE *fh, register const u_char *cp,
register u_int length, char_enc encoding)
{
register unsigned int ad, i, j, k;
u_char c;
u_char line[80];
static u_char binhex[16] = {
'0', '1', '2', '3', '4', '5', '6', '7',
'8', '9', 'a', 'b', 'c', 'd', 'e', 'f'};
memset (line, ' ', sizeof line);
line[sizeof (line)-1] = 0;
for (ad=i=j=k=0; i<length; i++) {
c = *cp++;
line[j++] = binhex[c>>4];
line[j++] = binhex[c&0xf];
j++;
if (encoding == CHAR_EBCDIC) {
c = EBCDIC_to_ASCII1(c);
}
line[50+k++] = c >= ' ' && c < 0x7f ? c : '.';
if ((i & 15) == 15) {
fprintf (fh, "\n%04x %s", ad, line);
/*if (i==15) printf (" %d", length);*/
memset (line, ' ', sizeof line);
line[sizeof (line)-1] = j = k = 0;
ad += 16;
}
}
if (line[0] != ' ') fprintf (fh, "\n%04x %s", ad, line);
fprintf(fh, "\n");
return;
}
#define MAX_LINE_LENGTH 256
/* Print a node's data, and any child nodes, in PostScript */
static
void proto_tree_print_node_ps(GNode *node, gpointer data)
{
field_info *fi = (field_info*) (node->data);
print_data *pdata = (print_data*) data;
gchar label_str[ITEM_LABEL_LENGTH];
gchar *label_ptr;
const guint8 *pd;
char psbuffer[MAX_LINE_LENGTH]; /* static sized buffer! */
if (!fi->visible)
return;
/* was a free format label produced? */
if (fi->representation) {
label_ptr = fi->representation;
}
else { /* no, make a generic label */
label_ptr = label_str;
proto_item_fill_label(fi, label_str);
}
/* Print the text */
ps_clean_string(psbuffer, label_ptr, MAX_LINE_LENGTH);
fprintf(pdata->fh, "%d (%s) putline\n", pdata->level, psbuffer);
/* If it's uninterpreted data, dump it (unless our caller will
be printing the entire packet in hex). */
if (fi->hfinfo->id == proto_data && pdata->print_hex_for_data) {
/*
* Find the data for this field.
*/
pd = get_field_data(pdata->src_list, fi);
print_hex_data_ps(pdata->fh, pd, fi->length, pdata->encoding);
}
/* Recurse into the subtree, if it exists */
if (g_node_n_children(node) > 0) {
pdata->level++;
g_node_children_foreach(node, G_TRAVERSE_ALL,
proto_tree_print_node_ps, pdata);
pdata->level--;
}
}
static
void ps_clean_string(unsigned char *out, const unsigned char *in,
int outbuf_size)
{
int rd, wr;
char c;
for (rd = 0, wr = 0 ; wr < outbuf_size; rd++, wr++ ) {
c = in[rd];
switch (c) {
case '(':
case ')':
case '\\':
out[wr] = '\\';
out[++wr] = c;
break;
default:
out[wr] = c;
break;
}
if (c == 0) {
break;
}
}
}
static
void print_hex_data_ps(FILE *fh, register const u_char *cp,
register u_int length, char_enc encoding)
{
register unsigned int ad, i, j, k;
u_char c;
u_char line[60];
static u_char binhex[16] = {
'0', '1', '2', '3', '4', '5', '6', '7',
'8', '9', 'a', 'b', 'c', 'd', 'e', 'f'};
u_char psline[MAX_LINE_LENGTH];
print_ps_hex(fh);
memset (line, ' ', sizeof line);
line[sizeof (line)-1] = 0;
for (ad=i=j=k=0; i<length; i++) {
c = *cp++;
line[j++] = binhex[c>>4];
line[j++] = binhex[c&0xf];
if (i&1) j++;
if (encoding == CHAR_EBCDIC) {
c = EBCDIC_to_ASCII1(c);
}
line[42+k++] = c >= ' ' && c < 0x7f ? c : '.';
if ((i & 15) == 15) {
ps_clean_string(psline, line, MAX_LINE_LENGTH);
fprintf (fh, "(%4x %s) hexdump\n", ad, psline);
memset (line, ' ', sizeof line);
line[sizeof (line)-1] = j = k = 0;
ad += 16;
}
}
if (line[0] != ' ') {
ps_clean_string(psline, line, MAX_LINE_LENGTH);
fprintf (fh, "(%4x %s) hexdump\n", ad, psline);
}
return;
}
void print_line(FILE *fh, gint format, char *line)
{
char psbuffer[MAX_LINE_LENGTH]; /* static sized buffer! */
if (format == PR_FMT_PS) {
ps_clean_string(psbuffer, line, MAX_LINE_LENGTH);
fprintf(fh, "(%s) hexdump\n", psbuffer);
} else
fputs(line, fh);
}