From Colin O'Flynn:
[obnox/wireshark/wip.git] / mergecap.c
index 047979b46ba381971b8c8922fd6e5419aa85c8b6..db3873ef869889cacfcec6f998b3967219956baf 100644 (file)
@@ -2,7 +2,25 @@
  *
  * $Id$
  *
- * Written by Scott Renfro <scott@renfro.org> based on
+ * 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.,
+ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+ *
+ * Mergecap written by Scott Renfro <scott@renfro.org> based on
  * editcap by Richard Sharpe and Guy Harris
  *
  */
 #include <string.h>
 #include "wtap.h"
 
-#ifdef NEED_GETOPT_H
-#include "getopt.h"
+#ifndef HAVE_GETOPT
+#include "wsutil/wsgetopt.h"
 #endif
 
 #include "svnversion.h"
 #include "merge.h"
-
-#ifdef HAVE_IO_H
-# include <io.h>
-#endif
+#include "wsutil/file_util.h"
 
 #ifdef HAVE_FCNTL_H
 #include <fcntl.h>
 #endif
 
-/* Win32 needs the O_BINARY flag for open() */
-#ifndef O_BINARY
-#define O_BINARY       0
-#endif
+#ifdef _WIN32
+#include <wsutil/unicode-utils.h>
+#endif /* _WIN32 */
+
+static int
+get_natural_int(const char *string, const char *name)
+{
+  int number;
+  char *p;
+
+  number = (int) strtol(string, &p, 10);
+  if (p == string || *p != '\0') {
+    fprintf(stderr, "mergecap: The specified %s \"%s\" isn't a decimal number\n",
+           name, string);
+    exit(1);
+  }
+  if (number < 0) {
+    fprintf(stderr, "mergecap: The specified %s is a negative number\n",
+           name);
+    exit(1);
+  }
+  if (number > INT_MAX) {
+    fprintf(stderr, "mergecap: The specified %s is too large (greater than %d)\n",
+           name, INT_MAX);
+    exit(1);
+  }
+  return number;
+}
+
+static int
+get_positive_int(const char *string, const char *name)
+{
+  int number;
+
+  number = get_natural_int(string, name);
+
+  if (number == 0) {
+    fprintf(stderr, "mergecap: The specified %s is zero\n",
+           name);
+    exit(1);
+  }
+
+  return number;
+}
 
 /*
  * Show the usage
 static void
 usage(void)
 {
+
+  fprintf(stderr, "Mergecap %s"
+#ifdef SVNVERSION
+         " (" SVNVERSION " from " SVNPATH ")"
+#endif
+         "\n", VERSION);
+  fprintf(stderr, "Merge two or more capture files into one.\n");
+  fprintf(stderr, "See http://www.wireshark.org for more information.\n");
+  fprintf(stderr, "\n");
+  fprintf(stderr, "Usage: mergecap [options] -w <outfile>|- <infile> [<infile> ...]\n");
+  fprintf(stderr, "\n");
+  fprintf(stderr, "Output:\n");
+  fprintf(stderr, "  -a                concatenate rather than merge files.\n");
+  fprintf(stderr, "                    default is to merge based on frame timestamps.\n");
+  fprintf(stderr, "  -s <snaplen>      truncate packets to <snaplen> bytes of data.\n");
+  fprintf(stderr, "  -w <outfile>|-    set the output filename to <outfile> or '-' for stdout.\n");
+  fprintf(stderr, "  -F <capture type> set the output file type; default is pcapng.\n");
+  fprintf(stderr, "                    an empty \"-F\" option will list the file types.\n");
+  fprintf(stderr, "  -T <encap type>   set the output file encapsulation type;\n");
+  fprintf(stderr, "                    default is the same as the first input file.\n");
+  fprintf(stderr, "                    an empty \"-T\" option will list the encapsulation types.\n");
+  fprintf(stderr, "\n");
+  fprintf(stderr, "Miscellaneous:\n");
+  fprintf(stderr, "  -h                display this help and exit.\n");
+  fprintf(stderr, "  -v                verbose output.\n");
+}
+
+struct string_elem {
+    const char *sstr;   /* The short string */
+    const char *lstr;   /* The long string */
+};
+
+static gint
+string_compare(gconstpointer a, gconstpointer b)
+{
+    return strcmp(((const struct string_elem *)a)->sstr,
+        ((const struct string_elem *)b)->sstr);
+}
+
+static void
+string_elem_print(gpointer data, gpointer not_used _U_)
+{
+    fprintf(stderr, "    %s - %s\n",
+        ((struct string_elem *)data)->sstr,
+        ((struct string_elem *)data)->lstr);
+}
+
+static void
+list_capture_types(void) {
   int i;
-  const char *string;
-
-  printf("Usage: mergecap [-hva] [-s <snaplen>] [-T <encap type>]\n");
-  printf("          [-F <capture type>] -w <outfile> <infile> [...]\n\n");
-  printf("  where\t-h produces this help listing.\n");
-  printf("       \t-v verbose operation, default is silent\n");
-  printf("       \t-a files should be concatenated, not merged\n");
-  printf("       \t     Default merges based on frame timestamps\n");
-  printf("       \t-s <snaplen>: truncate packets to <snaplen> bytes of data\n");
-  printf("       \t-w <outfile>: sets output filename to <outfile>\n");
-  printf("       \t-T <encap type> encapsulation type to use:\n");
-  for (i = 0; i < WTAP_NUM_ENCAP_TYPES; i++) {
-      string = wtap_encap_short_string(i);
-      if (string != NULL)
-        printf("       \t     %s - %s\n",
-          string, wtap_encap_string(i));
-  }
-  printf("       \t     default is the same as the first input file\n");
-  printf("       \t-F <capture type> capture file type to write:\n");
+  struct string_elem *captypes;
+  GSList *list = NULL;
+
+  captypes = g_malloc(sizeof(struct string_elem) * WTAP_NUM_FILE_TYPES);
+
+  fprintf(stderr, "mergecap: The available capture file types for the \"-F\" flag are:\n");
   for (i = 0; i < WTAP_NUM_FILE_TYPES; i++) {
-    if (wtap_dump_can_open(i))
-      printf("       \t     %s - %s\n",
-        wtap_file_type_short_string(i), wtap_file_type_string(i));
+    if (wtap_dump_can_open(i)) {
+      captypes[i].sstr = wtap_file_type_short_string(i);
+      captypes[i].lstr = wtap_file_type_string(i);
+      list = g_slist_insert_sorted(list, &captypes[i], string_compare);
+    }
   }
-  printf("       \t     default is libpcap\n");
+  g_slist_foreach(list, string_elem_print, NULL);
+  g_slist_free(list);
+  g_free(captypes);
 }
 
-
+static void
+list_encap_types(void) {
+    int i;
+    struct string_elem *encaps;
+    GSList *list = NULL;
+
+    encaps = g_malloc(sizeof(struct string_elem) * WTAP_NUM_ENCAP_TYPES);
+    fprintf(stderr, "mergecap: The available encapsulation types for the \"-T\" flag are:\n");
+    for (i = 0; i < WTAP_NUM_ENCAP_TYPES; i++) {
+        encaps[i].sstr = wtap_encap_short_string(i);
+        if (encaps[i].sstr != NULL) {
+            encaps[i].lstr = wtap_encap_string(i);
+            list = g_slist_insert_sorted(list, &encaps[i], string_compare);
+        }
+    }
+    g_slist_foreach(list, string_elem_print, NULL);
+    g_slist_free(list);
+    g_free(encaps);
+}
 
 int
 main(int argc, char *argv[])
 {
-  extern char *optarg;
-  extern int   optind;
   int          opt;
-  char        *p;
+
   gboolean     do_append     = FALSE;
+  gboolean     verbose       = FALSE;
   int          in_file_count = 0;
-  merge_in_file_t   *in_files      = NULL;
-  merge_out_file_t   out_file;
-  int          err;
+  guint        snaplen = 0;
+#ifdef PCAP_NG_DEFAULT
+  int          file_type = WTAP_FILE_PCAPNG;   /* default to pcap format */
+#else
+  int          file_type = WTAP_FILE_PCAP;     /* default to pcapng format */
+#endif
+  int          frame_type = -2;
+  int          out_fd;
+  merge_in_file_t   *in_files      = NULL, *in_file;
+  int          i;
+  struct wtap_pkthdr *phdr, snap_phdr;
+  wtap_dumper *pdh;
+  int          open_err, read_err=0, write_err, close_err;
+  gchar       *err_info;
+  int          err_fileno;
   char        *out_filename = NULL;
+  gboolean     got_read_error = FALSE, got_write_error = FALSE;
+  int          count;
 
-  /* initialize out_file */
-  out_file.fd         = 0;
-  out_file.pdh        = NULL;              /* wiretap dumpfile */
-  out_file.file_type  = WTAP_FILE_PCAP;    /* default to "libpcap" */
-  out_file.frame_type = -2;                /* leave type alone */
-  out_file.snaplen    = 0;                 /* no limit */
-  out_file.count      = 1;                 /* frames output */
-
-  merge_verbose = VERBOSE_ERRORS;
+#ifdef _WIN32
+  arg_list_utf_16to8(argc, argv);
+#endif /* _WIN32 */
 
   /* Process the options first */
   while ((opt = getopt(argc, argv, "hvas:T:F:w:")) != -1) {
@@ -120,48 +240,49 @@ main(int argc, char *argv[])
       break;
 
     case 'T':
-      out_file.frame_type = wtap_short_string_to_encap(optarg);
-      if (out_file.frame_type < 0) {
-       fprintf(stderr, "mergecap: \"%s\" is not a valid encapsulation type\n",
+      frame_type = wtap_short_string_to_encap(optarg);
+      if (frame_type < 0) {
+       fprintf(stderr, "mergecap: \"%s\" isn't a valid encapsulation type\n",
            optarg);
+        list_encap_types();
        exit(1);
       }
       break;
 
     case 'F':
-      out_file.file_type = wtap_short_string_to_file_type(optarg);
-      if (out_file.file_type < 0) {
-       fprintf(stderr, "mergecap: \"%s\" is not a valid capture file type\n",
+      file_type = wtap_short_string_to_file_type(optarg);
+      if (file_type < 0) {
+       fprintf(stderr, "mergecap: \"%s\" isn't a valid capture file type\n",
            optarg);
+        list_capture_types();
        exit(1);
       }
       break;
 
     case 'v':
-      merge_verbose = VERBOSE_ALL;
+      verbose = TRUE;
       break;
 
     case 's':
-      out_file.snaplen = strtol(optarg, &p, 10);
-      if (p == optarg || *p != '\0') {
-       fprintf(stderr, "mergecap: \"%s\" is not a valid snapshot length\n",
-           optarg);
-       exit(1);
-      }
+      snaplen = get_positive_int(optarg, "snapshot length");
       break;
 
     case 'h':
-      printf("mergecap version %s"
-#ifdef SVNVERSION
-         " (" SVNVERSION ")"
-#endif
-         "\n", VERSION);
       usage();
       exit(0);
       break;
 
     case '?':              /* Bad options if GNU getopt */
-      usage();
+      switch(optopt) {
+      case'F':
+        list_capture_types();
+        break;
+      case'T':
+        list_encap_types();
+        break;
+      default:
+        usage();
+      }
       exit(1);
       break;
 
@@ -176,54 +297,192 @@ main(int argc, char *argv[])
   if (!out_filename) {
     fprintf(stderr, "mergecap: an output filename must be set with -w\n");
     fprintf(stderr, "          run with -h for help\n");
-    exit(1);
+    return 1;
   }
   if (in_file_count < 1) {
     fprintf(stderr, "mergecap: No input files were specified\n");
-    exit(1);
+    return 1;
   }
 
   /* open the input files */
-  in_file_count = merge_open_in_files(in_file_count, &argv[optind], &in_files, &err);
-  if (in_file_count < 1) {
-    fprintf(stderr, "mergecap: No valid input files\n");
-    exit(1);
+  if (!merge_open_in_files(in_file_count, &argv[optind], &in_files,
+                           &open_err, &err_info, &err_fileno)) {
+    fprintf(stderr, "mergecap: Can't open %s: %s\n", argv[optind + err_fileno],
+        wtap_strerror(open_err));
+    switch (open_err) {
+
+    case WTAP_ERR_UNSUPPORTED:
+    case WTAP_ERR_UNSUPPORTED_ENCAP:
+    case WTAP_ERR_BAD_FILE:
+      fprintf(stderr, "(%s)\n", err_info);
+      g_free(err_info);
+      break;
+    }
+    return 2;
+  }
+
+  if (verbose) {
+    for (i = 0; i < in_file_count; i++)
+      fprintf(stderr, "mergecap: %s is type %s.\n", argv[optind + i],
+              wtap_file_type_string(wtap_file_type(in_files[i].wth)));
+  }
+
+  if (snaplen == 0) {
+    /*
+     * Snapshot length not specified - default to the maximum of the
+     * snapshot lengths of the input files.
+     */
+    snaplen = merge_max_snapshot_length(in_file_count, in_files);
   }
 
   /* set the outfile frame type */
-  if (out_file.frame_type == -2)
-    out_file.frame_type = merge_select_frame_type(in_file_count, in_files);
+  if (frame_type == -2) {
+    /*
+     * Default to the appropriate frame type for the input files.
+     */
+    frame_type = merge_select_frame_type(in_file_count, in_files);
+    if (verbose) {
+      if (frame_type == WTAP_ENCAP_PER_PACKET) {
+        /*
+         * Find out why we had to choose WTAP_ENCAP_PER_PACKET.
+         */
+        int first_frame_type, this_frame_type;
+
+        first_frame_type = wtap_file_encap(in_files[0].wth);
+        for (i = 1; i < in_file_count; i++) {
+          this_frame_type = wtap_file_encap(in_files[i].wth);
+          if (first_frame_type != this_frame_type) {
+            fprintf(stderr, "mergecap: multiple frame encapsulation types detected\n");
+            fprintf(stderr, "          defaulting to WTAP_ENCAP_PER_PACKET\n");
+            fprintf(stderr, "          %s had type %s (%s)\n",
+                    in_files[0].filename,
+                    wtap_encap_string(first_frame_type),
+                    wtap_encap_short_string(first_frame_type));
+            fprintf(stderr, "          %s had type %s (%s)\n",
+                    in_files[i].filename,
+                    wtap_encap_string(this_frame_type),
+                    wtap_encap_short_string(this_frame_type));
+            break;
+          }
+        }
+      }
+      fprintf(stderr, "mergecap: selected frame_type %s (%s)\n",
+              wtap_encap_string(frame_type),
+              wtap_encap_short_string(frame_type));
+    }
+  }
 
   /* open the outfile */
-  if (strncmp(out_filename, "-", 2) == 0) {  
+  if (strncmp(out_filename, "-", 2) == 0) {
     /* use stdout as the outfile */
-    out_file.fd = 1 /*stdout*/;
+    out_fd = 1 /*stdout*/;
   } else {
     /* open the outfile */
-    out_file.fd = open(out_filename, O_WRONLY | O_CREAT | O_TRUNC | O_BINARY, 0644);
+    out_fd = ws_open(out_filename, O_WRONLY | O_CREAT | O_TRUNC | O_BINARY, 0644);
+    if (out_fd == -1) {
+      fprintf(stderr, "mergecap: Couldn't open output file %s: %s\n",
+              out_filename, g_strerror(errno));
+      exit(1);
+    }
   }
-  if (out_file.fd == -1) {
-    fprintf(stderr, "mergecap: Couldn't open output file %s: %s\n",
-            out_filename, strerror(errno));
-    exit(1);
-  }  
-    
+
   /* prepare the outfile */
-  if (!merge_open_outfile(&out_file, merge_max_snapshot_length(in_file_count, in_files), &err)) {
+  pdh = wtap_dump_fdopen(out_fd, file_type, frame_type, snaplen, FALSE /* compressed */, &open_err);
+  if (pdh == NULL) {
     merge_close_in_files(in_file_count, in_files);
+    g_free(in_files);
+    fprintf(stderr, "mergecap: Can't open or create %s: %s\n", out_filename,
+            wtap_strerror(open_err));
     exit(1);
   }
 
   /* do the merge (or append) */
-  if (do_append)
-    merge_append_files(in_file_count, in_files, &out_file, &err);
-  else
-    merge_files(in_file_count, in_files, &out_file, &err);
+  count = 1;
+  for (;;) {
+    if (do_append)
+      in_file = merge_append_read_packet(in_file_count, in_files, &read_err,
+                                         &err_info);
+    else
+      in_file = merge_read_packet(in_file_count, in_files, &read_err,
+                                  &err_info);
+    if (in_file == NULL) {
+      /* EOF */
+      break;
+    }
+
+    if (read_err != 0) {
+      /* I/O error reading from in_file */
+      got_read_error = TRUE;
+      break;
+    }
+
+    if (verbose)
+      fprintf(stderr, "Record: %u\n", count++);
+
+    /* We simply write it, perhaps after truncating it; we could do other
+     * things, like modify it. */
+    phdr = wtap_phdr(in_file->wth);
+    if (snaplen != 0 && phdr->caplen > snaplen) {
+      snap_phdr = *phdr;
+      snap_phdr.caplen = snaplen;
+      phdr = &snap_phdr;
+    }
+
+    if (!wtap_dump(pdh, phdr, wtap_pseudoheader(in_file->wth),
+         wtap_buf_ptr(in_file->wth), &write_err)) {
+      got_write_error = TRUE;
+      break;
+    }
+  }
 
   merge_close_in_files(in_file_count, in_files);
-  merge_close_outfile(&out_file);
+  if (!got_read_error && !got_write_error) {
+    if (!wtap_dump_close(pdh, &write_err))
+      got_write_error = TRUE;
+  } else
+    wtap_dump_close(pdh, &close_err);
+
+  if (got_read_error) {
+    /*
+     * Find the file on which we got the error, and report the error.
+     */
+    for (i = 0; i < in_file_count; i++) {
+      if (in_files[i].state == GOT_ERROR) {
+        fprintf(stderr, "mergecap: Error reading %s: %s\n",
+                in_files[i].filename, wtap_strerror(read_err));
+        switch (read_err) {
+
+        case WTAP_ERR_UNSUPPORTED:
+        case WTAP_ERR_UNSUPPORTED_ENCAP:
+        case WTAP_ERR_BAD_FILE:
+          fprintf(stderr, "(%s)\n", err_info);
+          g_free(err_info);
+          break;
+        }
+      }
+    }
+  }
+
+  if (got_write_error) {
+    switch (write_err) {
+
+    case WTAP_ERR_UNSUPPORTED_ENCAP:
+      /*
+       * This is a problem with the particular frame we're writing;
+       * note that, and give the frame number.
+       */
+      fprintf(stderr, "mergecap: Frame %u of \"%s\" has a network type that can't be saved in a file with that format\n.",
+              in_file->packet_num, in_file->filename);
+      break;
+
+    default:
+      fprintf(stderr, "mergecap: Error writing to outfile: %s\n",
+              wtap_strerror(write_err));
+      break;
+    }
+  }
 
-  free(in_files);
+  g_free(in_files);
 
-  return 0;
+  return (!got_read_error && !got_write_error) ? 0 : 2;
 }