/* print.c
* Routines for printing packet analysis trees.
*
- * $Id: print.c,v 1.34 2001/06/08 08:50:49 guy Exp $
+ * $Id$
*
- * Gilbert Ramirez <gram@xiexie.org>
+ * Gilbert Ramirez <gram@alumni.rice.edu>
*
- * Ethereal - Network traffic analyzer
- * By Gerald Combs <gerald@ethereal.com>
+ * Wireshark - Network traffic analyzer
+ * By Gerald Combs <gerald@wireshark.org>
* 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.
#include <stdio.h>
#include <string.h>
-#ifdef HAVE_SYS_TYPES_H
-# include <sys/types.h>
-#endif
+#include <epan/epan.h>
+#include <epan/epan_dissect.h>
+#include <epan/tvbuff.h>
+#include <epan/packet.h>
-#include "packet.h"
+#include "packet-range.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 */
+#include "file_util.h"
+#include <epan/charsets.h>
+#include <epan/dissectors/packet-data.h>
+#include <epan/dissectors/packet-frame.h>
+#define PDML_VERSION "0"
+#define PSML_VERSION "0"
typedef struct {
- int level;
- FILE *fh;
- GSList *src_list;
- gboolean print_all_levels;
- gboolean print_hex_for_data;
- char_enc encoding;
+ int level;
+ print_stream_t *stream;
+ gboolean success;
+ GSList *src_list;
+ print_dissections_e print_dissections;
+ gboolean print_hex_for_data;
+ char_enc encoding;
+ epan_dissect_t *edt;
} print_data;
-FILE *open_print_dest(int to_file, const char *dest)
+typedef struct {
+ int level;
+ FILE *fh;
+ GSList *src_list;
+ epan_dissect_t *edt;
+} write_pdml_data;
+
+static void proto_tree_print_node(proto_node *node, gpointer data);
+static void proto_tree_write_node_pdml(proto_node *node, gpointer data);
+static const guint8 *get_field_data(GSList *src_list, field_info *fi);
+static void write_pdml_field_hex_value(write_pdml_data *pdata, field_info *fi);
+static gboolean print_hex_data_buffer(print_stream_t *stream, const guchar *cp,
+ guint length, char_enc encoding);
+static void ps_clean_string(unsigned char *out, const unsigned char *in,
+ int outbuf_size);
+static void print_escaped_xml(FILE *fh, const char *unescaped_string);
+
+static void print_pdml_geninfo(proto_tree *tree, FILE *fh);
+
+static 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");
+ fh = eth_fopen(dest, "w");
else
fh = popen(dest, "w");
return fh;
}
-void close_print_dest(int to_file, FILE *fh)
+static gboolean
+close_print_dest(int to_file, FILE *fh)
{
/* Close the file or command */
if (to_file)
- fclose(fh);
+ return (fclose(fh) == 0);
else
- pclose(fh);
+ return (pclose(fh) == 0);
}
-void print_preamble(FILE *fh, gint format)
-{
- if (format == PR_FMT_PS)
- print_ps_preamble(fh);
-}
+#define MAX_PS_LINE_LENGTH 256
-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)
+gboolean
+proto_tree_print(print_args_t *print_args, epan_dissect_t *edt,
+ print_stream_t *stream)
{
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.stream = stream;
+ data.success = TRUE;
+ data.src_list = edt->pi.data_src;
+ data.encoding = edt->pi.fd->flags.encoding;
+ data.print_dissections = print_args->print_dissections;
+ /* If we're printing the entire packet in hex, don't
+ print uninterpreted data fields in hex as well. */
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);
- }
-}
+ data.edt = edt;
-/*
- * Find the data source tvbuff with a specified name, and return a
- * pointer to the data in it.
- */
-static const guint8 *
-find_data_source(GSList *src_list, gchar *ds_name)
-{
- GSList *src;
- tvbuff_t *src_tvb;
- guint src_tvb_len;
-
- for (src = src_list; src != NULL; src = g_slist_next(src)) {
- src_tvb = src->data;
- if (strcmp(ds_name, tvb_get_name(src_tvb)) == 0) {
- /*
- * Found it.
- */
- src_tvb_len = tvb_length(src_tvb);
- return tvb_get_ptr(src_tvb, 0, src_tvb_len);
- }
- }
- return NULL; /* not found */
+ proto_tree_children_foreach(edt->tree, proto_tree_print_node, &data);
+ return data.success;
}
-/* Print a tree's data, and any child nodes, in plain text */
+#define MAX_INDENT 160
+
+/* Print a tree's data, and any child nodes. */
static
-void proto_tree_print_node_text(GNode *node, gpointer data)
+void proto_tree_print_node(proto_node *node, gpointer data)
{
- field_info *fi = (field_info*) (node->data);
+ field_info *fi = PITEM_FINFO(node);
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)
+ if (PROTO_ITEM_IS_HIDDEN(node))
+ return;
+
+ /* Give up if we've already gotten an error. */
+ if (!pdata->success)
return;
/* was a free format label produced? */
- if (fi->representation) {
- label_ptr = fi->representation;
+ if (fi->rep) {
+ label_ptr = fi->rep->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 (!print_line(pdata->stream, pdata->level, label_ptr)) {
+ pdata->success = FALSE;
+ return;
+ }
/* 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 source tvbuff for this field.
+ * Find the data for this field.
*/
- pd = find_data_source(pdata->src_list, fi->ds_name);
- print_hex_data_text(pdata->fh, &pd[fi->start],
- fi->length, pdata->encoding);
+ pd = get_field_data(pdata->src_list, fi);
+ if (pd) {
+ if (!print_hex_data_buffer(pdata->stream, pd,
+ fi->length, pdata->encoding)) {
+ pdata->success = FALSE;
+ return;
+ }
+ }
}
- /* 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) {
+ /* If we're printing all levels, or if this node is one with a
+ subtree and its subtree is expanded, recurse into the subtree,
+ if it exists. */
+ g_assert(fi->tree_type >= -1 && fi->tree_type < num_tree_types);
+ if (pdata->print_dissections == print_dissections_expanded ||
+ (pdata->print_dissections == print_dissections_as_displayed &&
+ fi->tree_type >= 0 && tree_is_expanded[fi->tree_type])) {
+ if (node->first_child != NULL) {
pdata->level++;
- g_node_children_foreach(node, G_TRAVERSE_ALL,
- proto_tree_print_node_text, pdata);
+ proto_tree_children_foreach(node,
+ proto_tree_print_node, pdata);
pdata->level--;
+ if (!pdata->success)
+ return;
+ }
+ }
+}
+
+void
+write_pdml_preamble(FILE *fh)
+{
+ fputs("<?xml version=\"1.0\"?>\n", fh);
+ fputs("<pdml version=\"" PDML_VERSION "\" ", fh);
+ fprintf(fh, "creator=\"%s/%s\">\n", PACKAGE, VERSION);
+}
+
+void
+proto_tree_write_pdml(epan_dissect_t *edt, FILE *fh)
+{
+ write_pdml_data data;
+
+ /* Create the output */
+ data.level = 0;
+ data.fh = fh;
+ data.src_list = edt->pi.data_src;
+ data.edt = edt;
+
+ fprintf(fh, "<packet>\n");
+
+ /* Print a "geninfo" protocol as required by PDML */
+ print_pdml_geninfo(edt->tree, fh);
+
+ proto_tree_children_foreach(edt->tree, proto_tree_write_node_pdml,
+ &data);
+
+ fprintf(fh, "</packet>\n\n");
+}
+
+/* Write out a tree's data, and any child nodes, as PDML */
+static void
+proto_tree_write_node_pdml(proto_node *node, gpointer data)
+{
+ field_info *fi = PITEM_FINFO(node);
+ write_pdml_data *pdata = (write_pdml_data*) data;
+ const gchar *label_ptr;
+ gchar label_str[ITEM_LABEL_LENGTH];
+ char *dfilter_string;
+ int chop_len;
+ int i;
+
+ for (i = -1; i < pdata->level; i++) {
+ fputs(" ", pdata->fh);
+ }
+
+ /* Text label. It's printed as a field with no name. */
+ if (fi->hfinfo->id == hf_text_only) {
+ /* Get the text */
+ if (fi->rep) {
+ label_ptr = fi->rep->representation;
+ }
+ else {
+ label_ptr = "";
+ }
+
+ fputs("<field show=\"", pdata->fh);
+ print_escaped_xml(pdata->fh, label_ptr);
+
+ fprintf(pdata->fh, "\" size=\"%d", fi->length);
+ fprintf(pdata->fh, "\" pos=\"%d", fi->start);
+
+ fputs("\" value=\"", pdata->fh);
+ write_pdml_field_hex_value(pdata, fi);
+
+ if (node->first_child != NULL) {
+ fputs("\">\n", pdata->fh);
+ }
+ else {
+ fputs("\"/>\n", pdata->fh);
+ }
+ }
+ /* Uninterpreted data, i.e., the "Data" protocol, is
+ * printed as a field instead of a protocol. */
+ else if (fi->hfinfo->id == proto_data) {
+
+ fputs("<field name=\"data\" value=\"", pdata->fh);
+
+ write_pdml_field_hex_value(pdata, fi);
+
+ fputs("\"/>\n", pdata->fh);
+
+ }
+ /* Normal protocols and fields */
+ else {
+ if (fi->hfinfo->type == FT_PROTOCOL) {
+ fputs("<proto name=\"", pdata->fh);
+ }
+ else {
+ fputs("<field name=\"", pdata->fh);
+ }
+ print_escaped_xml(pdata->fh, fi->hfinfo->abbrev);
+
+#if 0
+ /* PDML spec, see:
+ * http://analyzer.polito.it/30alpha/docs/dissectors/PDMLSpec.htm
+ *
+ * the show fields contains things in 'human readable' format
+ * showname: contains only the name of the field
+ * show: contains only the data of the field
+ * showdtl: contains additional details of the field data
+ * showmap: contains mappings of the field data (e.g. the hostname to an IP address)
+ *
+ * XXX - the showname shouldn't contain the field data itself
+ * (like it's contained in the fi->rep->representation).
+ * Unfortunately, we don't have the field data representation for
+ * all fields, so this isn't currently possible */
+ fputs("\" showname=\"", pdata->fh);
+ print_escaped_xml(pdata->fh, fi->hfinfo->name);
+#endif
+
+ if (fi->rep) {
+ fputs("\" showname=\"", pdata->fh);
+ print_escaped_xml(pdata->fh, fi->rep->representation);
+ }
+ else {
+ label_ptr = label_str;
+ proto_item_fill_label(fi, label_str);
+ fputs("\" showname=\"", pdata->fh);
+ print_escaped_xml(pdata->fh, label_ptr);
+ }
+
+ if (PROTO_ITEM_IS_HIDDEN(node))
+ fprintf(pdata->fh, "\" hide=\"yes");
+
+ fprintf(pdata->fh, "\" size=\"%d", fi->length);
+ fprintf(pdata->fh, "\" pos=\"%d", fi->start);
+/* fprintf(pdata->fh, "\" id=\"%d", fi->hfinfo->id);*/
+
+ if (fi->hfinfo->type != FT_PROTOCOL) {
+ /* Field */
+
+ /* XXX - this is a hack until we can just call
+ * fvalue_to_string_repr() for *all* FT_* types. */
+ dfilter_string = proto_construct_dfilter_string(fi,
+ pdata->edt);
+ if (dfilter_string != NULL) {
+ chop_len = strlen(fi->hfinfo->abbrev) + 4; /* for " == " */
+
+ /* XXX - Remove double-quotes. Again, once we
+ * can call fvalue_to_string_repr(), we can
+ * ask it not to produce the version for
+ * display-filters, and thus, no
+ * double-quotes. */
+ if (dfilter_string[strlen(dfilter_string)-1] == '"') {
+ dfilter_string[strlen(dfilter_string)-1] = '\0';
+ chop_len++;
+ }
+
+ fputs("\" show=\"", pdata->fh);
+ print_escaped_xml(pdata->fh, &dfilter_string[chop_len]);
+ }
+ if (fi->length > 0) {
+ fputs("\" value=\"", pdata->fh);
+
+ if (fi->hfinfo->bitmask!=0) {
+ fprintf(pdata->fh, "%X", fvalue_get_integer(&fi->value));
+ fputs("\" unmaskedvalue=\"", pdata->fh);
+ write_pdml_field_hex_value(pdata, fi);
+ }
+ else {
+ write_pdml_field_hex_value(pdata, fi);
+ }
+ }
+ }
+
+ if (node->first_child != NULL) {
+ fputs("\">\n", pdata->fh);
+ }
+ else if (fi->hfinfo->id == proto_data) {
+ fputs("\">\n", pdata->fh);
+ }
+ else {
+ fputs("\"/>\n", pdata->fh);
+ }
+ }
+
+ /* We always print all levels for PDML. Recurse here. */
+ if (node->first_child != NULL) {
+ pdata->level++;
+ proto_tree_children_foreach(node,
+ proto_tree_write_node_pdml, pdata);
+ pdata->level--;
+ }
+
+ if (node->first_child != NULL) {
+ for (i = -1; i < pdata->level; i++) {
+ fputs(" ", pdata->fh);
+ }
+ if (fi->hfinfo->type == FT_PROTOCOL) {
+ fputs("</proto>\n", pdata->fh);
+ }
+ else {
+ fputs("</field>\n", pdata->fh);
+ }
+ }
+}
+
+/* Print info for a 'geninfo' pseudo-protocol. This is required by
+ * the PDML spec. The information is contained in Wireshark's 'frame' protocol,
+ * but we produce a 'geninfo' protocol in the PDML to conform to spec.
+ * The 'frame' protocol follows the 'geninfo' protocol in the PDML. */
+static void
+print_pdml_geninfo(proto_tree *tree, FILE *fh)
+{
+ guint32 num, len, caplen;
+ nstime_t *timestamp;
+ GPtrArray *finfo_array;
+ field_info *frame_finfo;
+
+ /* Get frame protocol's finfo. */
+ finfo_array = proto_find_finfo(tree, proto_frame);
+ if (g_ptr_array_len(finfo_array) < 1) {
+ return;
+ }
+ frame_finfo = finfo_array->pdata[0];
+ g_ptr_array_free(finfo_array, FALSE);
+
+ /* frame.number --> geninfo.num */
+ finfo_array = proto_find_finfo(tree, hf_frame_number);
+ if (g_ptr_array_len(finfo_array) < 1) {
+ return;
+ }
+ num = fvalue_get_integer(&((field_info*)finfo_array->pdata[0])->value);
+ g_ptr_array_free(finfo_array, FALSE);
+
+ /* frame.pkt_len --> geninfo.len */
+ finfo_array = proto_find_finfo(tree, hf_frame_packet_len);
+ if (g_ptr_array_len(finfo_array) < 1) {
+ return;
+ }
+ len = fvalue_get_integer(&((field_info*)finfo_array->pdata[0])->value);
+ g_ptr_array_free(finfo_array, FALSE);
+
+ /* frame.cap_len --> geninfo.caplen */
+ finfo_array = proto_find_finfo(tree, hf_frame_capture_len);
+ if (g_ptr_array_len(finfo_array) < 1) {
+ return;
+ }
+ caplen = fvalue_get_integer(&((field_info*)finfo_array->pdata[0])->value);
+ g_ptr_array_free(finfo_array, FALSE);
+
+ /* frame.time --> geninfo.timestamp */
+ finfo_array = proto_find_finfo(tree, hf_frame_arrival_time);
+ if (g_ptr_array_len(finfo_array) < 1) {
+ return;
+ }
+ timestamp = fvalue_get(&((field_info*)finfo_array->pdata[0])->value);
+ g_ptr_array_free(finfo_array, FALSE);
+
+ /* Print geninfo start */
+ fprintf(fh,
+" <proto name=\"geninfo\" pos=\"0\" showname=\"General information\" size=\"%u\">\n",
+ frame_finfo->length);
+
+ /* Print geninfo.num */
+ fprintf(fh,
+" <field name=\"num\" pos=\"0\" show=\"%u\" showname=\"Number\" value=\"%x\" size=\"%u\"/>\n",
+ num, num, frame_finfo->length);
+
+ /* Print geninfo.len */
+ fprintf(fh,
+" <field name=\"len\" pos=\"0\" show=\"%u\" showname=\"Packet Length\" value=\"%x\" size=\"%u\"/>\n",
+ len, len, frame_finfo->length);
+
+ /* Print geninfo.caplen */
+ fprintf(fh,
+" <field name=\"caplen\" pos=\"0\" show=\"%u\" showname=\"Captured Length\" value=\"%x\" size=\"%u\"/>\n",
+ caplen, caplen, frame_finfo->length);
+
+ /* Print geninfo.timestamp */
+ fprintf(fh,
+" <field name=\"timestamp\" pos=\"0\" show=\"%s\" showname=\"Captured Time\" value=\"%d.%09d\" size=\"%u\"/>\n",
+ abs_time_to_str(timestamp), (int) timestamp->secs, timestamp->nsecs, frame_finfo->length);
+
+ /* Print geninfo end */
+ fprintf(fh,
+" </proto>\n");
+}
+
+void
+write_pdml_finale(FILE *fh)
+{
+ fputs("</pdml>\n", fh);
+}
+
+void
+write_psml_preamble(FILE *fh)
+{
+ fputs("<?xml version=\"1.0\"?>\n", fh);
+ fputs("<psml version=\"" PSML_VERSION "\" ", fh);
+ fprintf(fh, "creator=\"%s/%s\">\n", PACKAGE, VERSION);
+}
+
+void
+proto_tree_write_psml(epan_dissect_t *edt, FILE *fh)
+{
+ gint i;
+
+ /* if this is the first packet, we have to create the PSML structure output */
+ if(edt->pi.fd->num == 1) {
+ fprintf(fh, "<structure>\n");
+
+ for(i=0; i < edt->pi.cinfo->num_cols; i++) {
+ fprintf(fh, "<section>");
+ print_escaped_xml(fh, edt->pi.cinfo->col_title[i]);
+ fprintf(fh, "</section>\n");
+ }
+
+ fprintf(fh, "</structure>\n\n");
+ }
+
+ fprintf(fh, "<packet>\n");
+
+ for(i=0; i < edt->pi.cinfo->num_cols; i++) {
+ fprintf(fh, "<section>");
+ print_escaped_xml(fh, edt->pi.cinfo->col_data[i]);
+ fprintf(fh, "</section>\n");
+ }
+
+ fprintf(fh, "</packet>\n\n");
+}
+
+void
+write_psml_finale(FILE *fh)
+{
+ fputs("</psml>\n", fh);
+}
+
+void
+write_csv_preamble(FILE *fh _U_)
+{
+
+}
+
+void
+proto_tree_write_csv(epan_dissect_t *edt, FILE *fh)
+{
+ gint i;
+
+ /* if this is the first packet, we have to write the CSV header */
+ if(edt->pi.fd->num == 1) {
+ for(i=0; i < edt->pi.cinfo->num_cols - 1; i++)
+ fprintf(fh, "\"%s\", ", edt->pi.cinfo->col_title[i]);
+
+ fprintf(fh, "\"%s\"\n", edt->pi.cinfo->col_title[i]);
+ }
+
+ for(i=0; i < edt->pi.cinfo->num_cols - 1; i++)
+ fprintf(fh, "\"%s\", ", edt->pi.cinfo->col_data[i]);
+
+ fprintf(fh, "\"%s\"\n", edt->pi.cinfo->col_data[i]);
+}
+
+void
+write_csv_finale(FILE *fh _U_)
+{
+
+}
+
+/*
+ * Find the data source for a specified field, and return a pointer
+ * to the data in it. Returns NULL if the data is out of bounds.
+ */
+static const guint8 *
+get_field_data(GSList *src_list, field_info *fi)
+{
+ GSList *src_le;
+ data_source *src;
+ tvbuff_t *src_tvb;
+ gint length, tvbuff_length;
+
+ for (src_le = src_list; src_le != NULL; src_le = src_le->next) {
+ src = src_le->data;
+ src_tvb = src->tvb;
+ if (fi->ds_tvb == src_tvb) {
+ /*
+ * Found it.
+ *
+ * XXX - a field can have a length that runs past
+ * the end of the tvbuff. Ideally, that should
+ * be fixed when adding an item to the protocol
+ * tree, but checking the length when doing
+ * that could be expensive. Until we fix that,
+ * we'll do the check here.
+ */
+ tvbuff_length = tvb_length_remaining(src_tvb,
+ fi->start);
+ if (tvbuff_length < 0) {
+ return NULL;
+ }
+ length = fi->length;
+ if (length > tvbuff_length)
+ length = tvbuff_length;
+ return tvb_get_ptr(src_tvb, fi->start, length);
}
}
+ g_assert_not_reached();
+ return NULL; /* not found */
}
-void print_hex_data(FILE *fh, gint format, frame_data *fd)
+/* Print a string, escaping out certain characters that need to
+ * escaped out for XML. */
+static void
+print_escaped_xml(FILE *fh, const char *unescaped_string)
+{
+ const unsigned char *p;
+
+ for (p = unescaped_string; *p != '\0'; p++) {
+ switch (*p) {
+ case '&':
+ fputs("&", fh);
+ break;
+ case '<':
+ fputs("<", fh);
+ break;
+ case '>':
+ fputs(">", fh);
+ break;
+ case '"':
+ fputs(""", fh);
+ break;
+ case '\'':
+ fputs("'", fh);
+ break;
+ default:
+ fputc(*p, fh);
+ }
+ }
+}
+
+static void
+write_pdml_field_hex_value(write_pdml_data *pdata, field_info *fi)
+{
+ int i;
+ const guint8 *pd;
+
+ if (fi->length > tvb_length_remaining(fi->ds_tvb, fi->start)) {
+ fprintf(pdata->fh, "field length invalid!");
+ return;
+ }
+
+ /* Find the data for this field. */
+ pd = get_field_data(pdata->src_list, fi);
+
+ if (pd) {
+ /* Print a simple hex dump */
+ for (i = 0 ; i < fi->length; i++) {
+ fprintf(pdata->fh, "%02x", pd[i]);
+ }
+ }
+}
+
+gboolean
+print_hex_data(print_stream_t *stream, epan_dissect_t *edt)
{
gboolean multiple_sources;
- GSList *src;
+ GSList *src_le;
+ data_source *src;
tvbuff_t *tvb;
char *name;
char *line;
- const u_char *cp;
+ const guchar *cp;
guint length;
/*
* the data source before printing the data from the
* data source.
*/
- multiple_sources = (fd->data_src->next != NULL);
+ multiple_sources = (edt->pi.data_src->next != NULL);
- for (src = fd->data_src; src != NULL; src = src->next) {
- tvb = src->data;
+ for (src_le = edt->pi.data_src; src_le != NULL;
+ src_le = src_le->next) {
+ src = src_le->data;
+ tvb = src->tvb;
if (multiple_sources) {
- name = tvb_get_name(tvb);
- print_line(fh, format, "\n");
- line = g_malloc(strlen(name) + 3); /* <name>:\n\0 */
+ name = src->name;
+ print_line(stream, 0, "");
+ line = g_malloc(strlen(name) + 2); /* <name>:\0 */
strcpy(line, name);
- strcat(line, ":\n");
- print_line(fh, format, line);
+ strcat(line, ":");
+ print_line(stream, 0, line);
g_free(line);
}
length = tvb_length(tvb);
+ if (length == 0)
+ return TRUE;
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);
+ if (!print_hex_data_buffer(stream, cp, length,
+ edt->pi.fd->flags.encoding))
+ return FALSE;
}
+ return TRUE;
}
-/* 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 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;
-
-}
+/*
+ * This routine is based on a routine created by Dan Lasley
+ * <DLASLEY@PROMUS.com>.
+ *
+ * It was modified for Wireshark by Gilbert Ramirez and others.
+ */
-#define MAX_LINE_LENGTH 256
+#define MAX_OFFSET_LEN 8 /* max length of hex offset of bytes */
+#define BYTES_PER_LINE 16 /* max byte values printed on a line */
+#define HEX_DUMP_LEN (BYTES_PER_LINE*3)
+ /* max number of characters hex dump takes -
+ 2 digits plus trailing blank */
+#define DATA_DUMP_LEN (HEX_DUMP_LEN + 2 + BYTES_PER_LINE)
+ /* number of characters those bytes take;
+ 3 characters per byte of hex dump,
+ 2 blanks separating hex from ASCII,
+ 1 character per byte of ASCII dump */
+#define MAX_LINE_LEN (MAX_OFFSET_LEN + 2 + DATA_DUMP_LEN)
+ /* number of characters per line;
+ offset, 2 blanks separating offset
+ from data dump, data dump */
-/* Print a node's data, and any child nodes, in PostScript */
-static
-void proto_tree_print_node_ps(GNode *node, gpointer data)
+static gboolean
+print_hex_data_buffer(print_stream_t *stream, const guchar *cp,
+ guint length, char_enc encoding)
{
- 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! */
+ register unsigned int ad, i, j, k, l;
+ guchar c;
+ guchar line[MAX_LINE_LEN + 1];
+ unsigned int use_digits;
+ static guchar binhex[16] = {
+ '0', '1', '2', '3', '4', '5', '6', '7',
+ '8', '9', 'a', 'b', 'c', 'd', 'e', 'f'};
- if (!fi->visible)
- return;
+ if (!print_line(stream, 0, ""))
+ return FALSE;
- /* 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);
+ /*
+ * How many of the leading digits of the offset will we supply?
+ * We always supply at least 4 digits, but if the maximum offset
+ * won't fit in 4 digits, we use as many digits as will be needed.
+ */
+ if (((length - 1) & 0xF0000000) != 0)
+ use_digits = 8; /* need all 8 digits */
+ else if (((length - 1) & 0x0F000000) != 0)
+ use_digits = 7; /* need 7 digits */
+ else if (((length - 1) & 0x00F00000) != 0)
+ use_digits = 6; /* need 6 digits */
+ else if (((length - 1) & 0x000F0000) != 0)
+ use_digits = 5; /* need 5 digits */
+ else
+ use_digits = 4; /* we'll supply 4 digits */
- /* 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 source tvbuff for this field.
- */
- pd = find_data_source(pdata->src_list, fi->ds_name);
- print_hex_data_ps(pdata->fh, &pd[fi->start], fi->length,
- pdata->encoding);
- }
+ ad = 0;
+ i = 0;
+ j = 0;
+ k = 0;
+ while (i < length) {
+ if ((i & 15) == 0) {
+ /*
+ * Start of a new line.
+ */
+ j = 0;
+ k = 0;
+ l = use_digits;
+ do {
+ l--;
+ c = (ad >> (l*4)) & 0xF;
+ line[j++] = binhex[c];
+ } while (l != 0);
+ line[j++] = ' ';
+ line[j++] = ' ';
+ memset(line+j, ' ', DATA_DUMP_LEN);
- /* 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--;
+ /*
+ * Offset in line of ASCII dump.
+ */
+ k = j + HEX_DUMP_LEN + 2;
+ }
+ c = *cp++;
+ line[j++] = binhex[c>>4];
+ line[j++] = binhex[c&0xf];
+ j++;
+ if (encoding == CHAR_EBCDIC) {
+ c = EBCDIC_to_ASCII1(c);
+ }
+ line[k++] = c >= ' ' && c < 0x7f ? c : '.';
+ i++;
+ if ((i & 15) == 0 || i == length) {
+ /*
+ * We'll be starting a new line, or
+ * we're finished printing this buffer;
+ * dump out the line we've constructed,
+ * and advance the offset.
+ */
+ line[k] = '\0';
+ if (!print_line(stream, 0, line))
+ return FALSE;
+ ad += 16;
+ }
}
+ return TRUE;
}
static
}
}
-static
-void print_hex_data_ps(FILE *fh, register const u_char *cp,
- register u_int length, char_enc encoding)
+/* Some formats need stuff at the beginning of the output */
+gboolean
+print_preamble(print_stream_t *self, gchar *filename)
{
- register 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;
- }
- }
+ return (self->ops->print_preamble)(self, filename);
+}
- if (line[0] != ' ') {
- ps_clean_string(psline, line, MAX_LINE_LENGTH);
- fprintf (fh, "(%4x %s) hexdump\n", ad, psline);
+gboolean
+print_line(print_stream_t *self, int indent, const char *line)
+{
+ return (self->ops->print_line)(self, indent, line);
+}
+
+/* Insert bookmark */
+gboolean
+print_bookmark(print_stream_t *self, const gchar *name, const gchar *title)
+{
+ return (self->ops->print_bookmark)(self, name, title);
+}
+
+gboolean
+new_page(print_stream_t *self)
+{
+ return (self->ops->new_page)(self);
+}
+
+/* Some formats need stuff at the end of the output */
+gboolean
+print_finale(print_stream_t *self)
+{
+ return (self->ops->print_finale)(self);
+}
+
+gboolean
+destroy_print_stream(print_stream_t *self)
+{
+ return (self->ops->destroy)(self);
+}
+
+typedef struct {
+ int to_file;
+ FILE *fh;
+} output_text;
+
+static gboolean
+print_preamble_text(print_stream_t *self _U_, gchar *filename _U_)
+{
+ /* do nothing */
+ return TRUE; /* always succeeds */
+}
+
+static gboolean
+print_line_text(print_stream_t *self, int indent, const char *line)
+{
+ output_text *output = self->data;
+ char space[MAX_INDENT+1];
+ int i;
+ int num_spaces;
+
+ /* Prepare the tabs for printing, depending on tree level */
+ num_spaces = indent * 4;
+ if (num_spaces > MAX_INDENT) {
+ num_spaces = MAX_INDENT;
}
- return;
+ for (i = 0; i < num_spaces; i++) {
+ space[i] = ' ';
+ }
+ /* The string is NUL-terminated */
+ space[num_spaces] = '\0';
+
+ fputs(space, output->fh);
+ fputs(line, output->fh);
+ putc('\n', output->fh);
+ return !ferror(output->fh);
+}
+
+static gboolean
+print_bookmark_text(print_stream_t *self _U_, const gchar *name _U_,
+ const gchar *title _U_)
+{
+ /* do nothing */
+ return TRUE;
+}
+
+static gboolean
+new_page_text(print_stream_t *self)
+{
+ output_text *output = self->data;
+
+ fputs("\f", output->fh);
+ return !ferror(output->fh);
+}
+
+static gboolean
+print_finale_text(print_stream_t *self _U_)
+{
+ /* do nothing */
+ return TRUE; /* always succeeds */
+}
+
+static gboolean
+destroy_text(print_stream_t *self)
+{
+ output_text *output = self->data;
+ gboolean ret;
+
+ ret = close_print_dest(output->to_file, output->fh);
+ g_free(output);
+ g_free(self);
+ return ret;
+}
+
+static const print_stream_ops_t print_text_ops = {
+ print_preamble_text,
+ print_line_text,
+ print_bookmark_text,
+ new_page_text,
+ print_finale_text,
+ destroy_text
+};
+
+print_stream_t *
+print_stream_text_new(int to_file, const char *dest)
+{
+ FILE *fh;
+ print_stream_t *stream;
+ output_text *output;
+
+ fh = open_print_dest(to_file, dest);
+ if (fh == NULL)
+ return NULL;
+
+ output = g_malloc(sizeof *output);
+ output->to_file = to_file;
+ output->fh = fh;
+ stream = g_malloc(sizeof (print_stream_t));
+ stream->ops = &print_text_ops;
+ stream->data = output;
+
+ return stream;
+}
+
+print_stream_t *
+print_stream_text_stdio_new(FILE *fh)
+{
+ print_stream_t *stream;
+ output_text *output;
+
+ output = g_malloc(sizeof *output);
+ output->to_file = TRUE;
+ output->fh = fh;
+ stream = g_malloc(sizeof (print_stream_t));
+ stream->ops = &print_text_ops;
+ stream->data = output;
+ return stream;
}
-void print_line(FILE *fh, gint format, char *line)
+typedef struct {
+ int to_file;
+ FILE *fh;
+} output_ps;
+
+static gboolean
+print_preamble_ps(print_stream_t *self, gchar *filename)
{
- char psbuffer[MAX_LINE_LENGTH]; /* static sized buffer! */
+ output_ps *output = self->data;
+ char psbuffer[MAX_PS_LINE_LENGTH]; /* static sized buffer! */
+
+ print_ps_preamble(output->fh);
+
+ fputs("%% Set the font to 10 point\n", output->fh);
+ fputs("/Courier findfont 10 scalefont setfont\n", output->fh);
+ fputs("\n", output->fh);
+ fputs("%% the page title\n", output->fh);
+ ps_clean_string(psbuffer, filename, MAX_PS_LINE_LENGTH);
+ fprintf(output->fh, "/eth_pagetitle (%s - Ethereal) def\n", psbuffer);
+ fputs("\n", output->fh);
+ return !ferror(output->fh);
+}
+
+static gboolean
+print_line_ps(print_stream_t *self, int indent, const char *line)
+{
+ output_ps *output = self->data;
+ char psbuffer[MAX_PS_LINE_LENGTH]; /* static sized buffer! */
+
+ ps_clean_string(psbuffer, line, MAX_PS_LINE_LENGTH);
+ fprintf(output->fh, "%d (%s) putline\n", indent, psbuffer);
+ return !ferror(output->fh);
+}
+
+static gboolean
+print_bookmark_ps(print_stream_t *self, const gchar *name, const gchar *title)
+{
+ output_ps *output = self->data;
+ char psbuffer[MAX_PS_LINE_LENGTH]; /* static sized buffer! */
+
+ /*
+ * See the Adobe "pdfmark reference":
+ *
+ * http://partners.adobe.com/asn/acrobat/docs/pdfmark.pdf
+ *
+ * The pdfmark stuff tells code that turns PostScript into PDF
+ * things that it should do.
+ *
+ * The /OUT stuff creates a bookmark that goes to the
+ * destination with "name" as the name and "title" as the title.
+ *
+ * The "/DEST" creates the destination.
+ */
+ ps_clean_string(psbuffer, title, MAX_PS_LINE_LENGTH);
+ fprintf(output->fh, "[/Dest /%s /Title (%s) /OUT pdfmark\n", name,
+ psbuffer);
+ fputs("[/View [/XYZ -4 currentpoint matrix currentmatrix matrix defaultmatrix\n",
+ output->fh);
+ fputs("matrix invertmatrix matrix concatmatrix transform exch pop 20 add null]\n",
+ output->fh);
+ fprintf(output->fh, "/Dest /%s /DEST pdfmark\n", name);
+ return !ferror(output->fh);
+}
+
+static gboolean
+new_page_ps(print_stream_t *self)
+{
+ output_ps *output = self->data;
+
+ fputs("formfeed\n", output->fh);
+ return !ferror(output->fh);
+}
+
+static gboolean
+print_finale_ps(print_stream_t *self)
+{
+ output_ps *output = self->data;
+
+ print_ps_finale(output->fh);
+ return !ferror(output->fh);
+}
+
+static gboolean
+destroy_ps(print_stream_t *self)
+{
+ output_ps *output = self->data;
+ gboolean ret;
+
+ ret = close_print_dest(output->to_file, output->fh);
+ g_free(output);
+ g_free(self);
+ return ret;
+}
+
+static const print_stream_ops_t print_ps_ops = {
+ print_preamble_ps,
+ print_line_ps,
+ print_bookmark_ps,
+ new_page_ps,
+ print_finale_ps,
+ destroy_ps
+};
+
+print_stream_t *
+print_stream_ps_new(int to_file, const char *dest)
+{
+ FILE *fh;
+ print_stream_t *stream;
+ output_ps *output;
+
+ fh = open_print_dest(to_file, dest);
+ if (fh == NULL)
+ return NULL;
+
+ output = g_malloc(sizeof *output);
+ output->to_file = to_file;
+ output->fh = fh;
+ stream = g_malloc(sizeof (print_stream_t));
+ stream->ops = &print_ps_ops;
+ stream->data = output;
+
+ return stream;
+}
+
+print_stream_t *
+print_stream_ps_stdio_new(FILE *fh)
+{
+ print_stream_t *stream;
+ output_ps *output;
+
+ output = g_malloc(sizeof *output);
+ output->to_file = TRUE;
+ output->fh = fh;
+ stream = g_malloc(sizeof (print_stream_t));
+ stream->ops = &print_ps_ops;
+ stream->data = output;
- if (format == PR_FMT_PS) {
- ps_clean_string(psbuffer, line, MAX_LINE_LENGTH);
- fprintf(fh, "(%s) hexdump\n", psbuffer);
- } else
- fputs(line, fh);
+ return stream;
}
git.samba.org / obnox / wireshark / wip.git / blobdiff