Fix The left operand of '!=' is a garbage value issue found by Clang Analyzer
[metze/wireshark/wip.git] / mergecap.c
index 3a84aeb74b8df34709a20aa8cde4837bc59a1b97..c483e8feefa6614b4bb9f4ec7596055d5ae8bef6 100644 (file)
@@ -1,6 +1,4 @@
 /* Combine dump files, either by appending or by merging by timestamp
- *
- * $Id$
  *
  * Wireshark - Network traffic analyzer
  * By Gerald Combs <gerald@wireshark.org>
@@ -25,7 +23,7 @@
  *
  */
 
-#include "config.h"
+#include <config.h>
 
 #include <stdio.h>
 #include <stdlib.h>
 #include <unistd.h>
 #endif
 
+#ifdef HAVE_GETOPT_H
+#include <getopt.h>
+#endif
+
 #ifdef HAVE_SYS_TIME_H
 #include <sys/time.h>
 #endif
 
+#ifdef HAVE_LIBZ
+#include <zlib.h>      /* to get the libz version number */
+#endif
+
 #include <string.h>
 #include "wtap.h"
 
 #include <wsutil/wsgetopt.h>
 #endif
 
+#include <wsutil/clopts_common.h>
 #include <wsutil/strnatcmp.h>
 #include <wsutil/file_util.h>
+#include <wsutil/cmdarg_err.h>
+#include <wsutil/crash_info.h>
+#include <wsutil/copyright_info.h>
+#include <wsutil/os_version_info.h>
+#include <wsutil/ws_version_info.h>
 
 #include <wiretap/merge.h>
 
-#include "svnversion.h"
+#include "version_info.h"
 
 #ifdef HAVE_FCNTL_H
 #include <fcntl.h>
 #include <wsutil/unicode-utils.h>
 #endif /* _WIN32 */
 
-static int
-get_natural_int(const char *string, const char *name)
+static void
+show_version(GString *comp_info_str, GString *runtime_info_str)
 {
-  long number;
-  char *p;
-
-  number = 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 (int)number;
+    printf("Mergecap (Wireshark) %s\n"
+           "\n"
+           "%s"
+           "\n"
+           "%s"
+           "\n"
+           "%s",
+           get_ws_vcs_version_info(), get_copyright_info(),
+           comp_info_str->str, runtime_info_str->str);
 }
 
-static int
-get_positive_int(const char *string, const char *name)
+/*
+ * Show the usage
+ */
+static void
+print_usage(FILE *output)
 {
-  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;
+  fprintf(output, "\n");
+  fprintf(output, "Usage: mergecap [options] -w <outfile>|- <infile> [<infile> ...]\n");
+  fprintf(output, "\n");
+  fprintf(output, "Output:\n");
+  fprintf(output, "  -a                concatenate rather than merge files.\n");
+  fprintf(output, "                    default is to merge based on frame timestamps.\n");
+  fprintf(output, "  -s <snaplen>      truncate packets to <snaplen> bytes of data.\n");
+  fprintf(output, "  -w <outfile>|-    set the output filename to <outfile> or '-' for stdout.\n");
+  fprintf(output, "  -F <capture type> set the output file type; default is pcapng.\n");
+  fprintf(output, "                    an empty \"-F\" option will list the file types.\n");
+  fprintf(output, "  -T <encap type>   set the output file encapsulation type;\n");
+  fprintf(output, "                    default is the same as the first input file.\n");
+  fprintf(output, "                    an empty \"-T\" option will list the encapsulation types.\n");
+  fprintf(output, "\n");
+  fprintf(output, "Miscellaneous:\n");
+  fprintf(output, "  -h                display this help and exit.\n");
+  fprintf(output, "  -v                verbose output.\n");
 }
 
 /*
- * Show the usage
+ * Report an error in command-line arguments.
  */
 static void
-usage(void)
+mergecap_cmdarg_err(const char *fmt, va_list ap)
 {
-  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, "mergecap: ");
+  vfprintf(stderr, fmt, ap);
   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");
+}
+
+/*
+ * Report additional information for an error in command-line arguments.
+ */
+static void
+mergecap_cmdarg_err_cont(const char *fmt, va_list ap)
+{
+  vfprintf(stderr, fmt, ap);
   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 {
@@ -148,8 +149,8 @@ string_compare(gconstpointer a, gconstpointer b)
 static gint
 string_nat_compare(gconstpointer a, gconstpointer b)
 {
-  return strnatcmp(((const struct string_elem *)a)->sstr,
-                   ((const struct string_elem *)b)->sstr);
+  return ws_ascii_strnatcmp(((const struct string_elem *)a)->sstr,
+                            ((const struct string_elem *)b)->sstr);
 }
 
 static void
@@ -165,13 +166,13 @@ list_capture_types(void) {
   struct string_elem *captypes;
   GSList *list = NULL;
 
-  captypes = g_new(struct string_elem,WTAP_NUM_FILE_TYPES);
+  captypes = g_new(struct string_elem,WTAP_NUM_FILE_TYPES_SUBTYPES);
 
   fprintf(stderr, "mergecap: The available capture file types for the \"-F\" flag are:\n");
-  for (i = 0; i < WTAP_NUM_FILE_TYPES; i++) {
+  for (i = 0; i < WTAP_NUM_FILE_TYPES_SUBTYPES; i++) {
     if (wtap_dump_can_open(i)) {
-      captypes[i].sstr = wtap_file_type_short_string(i);
-      captypes[i].lstr = wtap_file_type_string(i);
+      captypes[i].sstr = wtap_file_type_subtype_short_string(i);
+      captypes[i].lstr = wtap_file_type_subtype_string(i);
       list = g_slist_insert_sorted(list, &captypes[i], string_compare);
     }
   }
@@ -200,39 +201,90 @@ list_encap_types(void) {
   g_free(encaps);
 }
 
+static void
+get_mergecap_compiled_info(GString *str)
+{
+  /* LIBZ */
+  g_string_append(str, ", ");
+#ifdef HAVE_LIBZ
+  g_string_append(str, "with libz ");
+#ifdef ZLIB_VERSION
+  g_string_append(str, ZLIB_VERSION);
+#else /* ZLIB_VERSION */
+  g_string_append(str, "(version unknown)");
+#endif /* ZLIB_VERSION */
+#else /* HAVE_LIBZ */
+  g_string_append(str, "without libz");
+#endif /* HAVE_LIBZ */
+}
+
+static void
+get_mergecap_runtime_info(GString *str)
+{
+  /* zlib */
+#if defined(HAVE_LIBZ) && !defined(_WIN32)
+  g_string_append_printf(str, ", with libz %s", zlibVersion());
+#endif
+}
+
 int
 main(int argc, char *argv[])
 {
-  int          opt;
-  gboolean     do_append = FALSE;
-  gboolean     verbose = FALSE;
-  int          in_file_count = 0;
-  guint        snaplen = 0;
+  GString            *comp_info_str;
+  GString            *runtime_info_str;
+  int                 opt;
+  static const struct option long_options[] = {
+      {(char *)"help", no_argument, NULL, 'h'},
+      {(char *)"version", no_argument, NULL, 'V'},
+      {0, 0, 0, 0 }
+  };
+  gboolean            do_append          = FALSE;
+  gboolean            verbose            = FALSE;
+  int                 in_file_count      = 0;
+  guint               snaplen            = 0;
 #ifdef PCAP_NG_DEFAULT
-  int          file_type = WTAP_FILE_PCAPNG;    /* default to pcap format */
+  int                 file_type          = WTAP_FILE_TYPE_SUBTYPE_PCAPNG; /* default to pcap format */
 #else
-  int          file_type = WTAP_FILE_PCAP;      /* default to pcapng format */
+  int                 file_type          = WTAP_FILE_TYPE_SUBTYPE_PCAP; /* default to pcapng format */
 #endif
-  int          frame_type = -2;
-  int          out_fd;
-  merge_in_file_t   *in_files = NULL, *in_file;
-  int          i;
+  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;
+  wtap_dumper        *pdh;
+  int                 open_err, read_err = 0, write_err, close_err;
+  gchar              *err_info, *write_err_info = NULL;
+  int                 err_fileno;
+  char               *out_filename       = NULL;
+  gboolean            got_read_error     = FALSE, got_write_error = FALSE;
+  int                 count;
+
+  cmdarg_err_init(mergecap_cmdarg_err, mergecap_cmdarg_err_cont);
 
 #ifdef _WIN32
   arg_list_utf_16to8(argc, argv);
   create_app_running_mutex();
 #endif /* _WIN32 */
 
+  /* Assemble the compile-time version information string */
+  comp_info_str = g_string_new("Compiled ");
+  get_compiled_version_info(comp_info_str, NULL, get_mergecap_compiled_info);
+
+  /* Assemble the run-time version information string */
+  runtime_info_str = g_string_new("Running ");
+  get_runtime_version_info(runtime_info_str, get_mergecap_runtime_info);
+
+  /* Add it to the information to be reported on a crash. */
+  ws_add_crash_info("Mergecap (Wireshark) %s\n"
+       "\n"
+       "%s"
+       "\n"
+       "%s",
+    get_ws_vcs_version_info(), comp_info_str->str, runtime_info_str->str);
+
   /* Process the options first */
-  while ((opt = getopt(argc, argv, "aF:hs:T:vw:")) != -1) {
+  while ((opt = getopt_long(argc, argv, "aF:hs:T:vVw:", long_options, NULL)) != -1) {
 
     switch (opt) {
     case 'a':
@@ -240,7 +292,7 @@ main(int argc, char *argv[])
       break;
 
     case 'F':
-      file_type = wtap_short_string_to_file_type(optarg);
+      file_type = wtap_short_string_to_file_type_subtype(optarg);
       if (file_type < 0) {
         fprintf(stderr, "mergecap: \"%s\" isn't a valid capture file type\n",
                 optarg);
@@ -250,7 +302,11 @@ main(int argc, char *argv[])
       break;
 
     case 'h':
-      usage();
+      printf("Mergecap (Wireshark) %s\n"
+             "Merge two or more capture files into one.\n"
+             "See http://www.wireshark.org for more information.\n",
+             get_ws_vcs_version_info());
+      print_usage(stdout);
       exit(0);
       break;
 
@@ -272,6 +328,13 @@ main(int argc, char *argv[])
       verbose = TRUE;
       break;
 
+    case 'V':
+      show_version(comp_info_str, runtime_info_str);
+      g_string_free(comp_info_str, TRUE);
+      g_string_free(runtime_info_str, TRUE);
+      exit(0);
+      break;
+
     case 'w':
       out_filename = optarg;
       break;
@@ -285,7 +348,7 @@ main(int argc, char *argv[])
         list_encap_types();
         break;
       default:
-        usage();
+        print_usage(stderr);
       }
       exit(1);
       break;
@@ -311,14 +374,9 @@ main(int argc, char *argv[])
                            &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:
+    if (err_info != NULL) {
       fprintf(stderr, "(%s)\n", err_info);
       g_free(err_info);
-      break;
     }
     return 2;
   }
@@ -326,7 +384,7 @@ main(int argc, char *argv[])
   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)));
+              wtap_file_type_subtype_string(wtap_file_type_subtype(in_files[i].wth)));
   }
 
   if (snaplen == 0) {
@@ -389,7 +447,7 @@ main(int argc, char *argv[])
   }
 
   /* prepare the outfile */
-  if(file_type == WTAP_FILE_PCAPNG ){
+  if(file_type == WTAP_FILE_TYPE_SUBTYPE_PCAPNG ){
     wtapng_section_t *shb_hdr;
     GString *comment_gstr;
 
@@ -404,7 +462,7 @@ main(int argc, char *argv[])
     shb_hdr->opt_comment   = comment_gstr->str; /* NULL if not available */
     shb_hdr->shb_hardware  = NULL;              /* NULL if not available, UTF-8 string containing the description of the hardware used to create this section. */
     shb_hdr->shb_os        = NULL;              /* NULL if not available, UTF-8 string containing the name of the operating system used to create this section. */
-    shb_hdr->shb_user_appl = "mergecap";        /* NULL if not available, UTF-8 string containing the name of the application used to create this section. */
+    shb_hdr->shb_user_appl = g_strdup("mergecap"); /* NULL if not available, UTF-8 string containing the name of the application used to create this section. */
 
     pdh = wtap_dump_fdopen_ng(out_fd, file_type, frame_type, snaplen,
                               FALSE /* compressed */, shb_hdr, NULL /* wtapng_iface_descriptions_t *idb_inf */, &open_err);
@@ -452,18 +510,25 @@ main(int argc, char *argv[])
       phdr = &snap_phdr;
     }
 
-    if (!wtap_dump(pdh, phdr, wtap_buf_ptr(in_file->wth), &write_err)) {
+    if (!wtap_dump(pdh, phdr, wtap_buf_ptr(in_file->wth), &write_err, &write_err_info)) {
       got_write_error = TRUE;
       break;
     }
   }
 
   merge_close_in_files(in_file_count, in_files);
-  if (!got_read_error && !got_write_error) {
+  if (!got_write_error) {
     if (!wtap_dump_close(pdh, &write_err))
       got_write_error = TRUE;
-  } else
-    wtap_dump_close(pdh, &close_err);
+  } else {
+    /*
+     * We already got a write error; no need to report another
+     * write error on close.
+     *
+     * Don't overwrite the earlier write error.
+     */
+    (void)wtap_dump_close(pdh, &close_err);
+  }
 
   if (got_read_error) {
     /*
@@ -473,14 +538,9 @@ main(int argc, char *argv[])
       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:
+        if (err_info != NULL) {
           fprintf(stderr, "(%s)\n", err_info);
           g_free(err_info);
-          break;
         }
       }
     }
@@ -489,13 +549,50 @@ main(int argc, char *argv[])
   if (got_write_error) {
     switch (write_err) {
 
-    case WTAP_ERR_UNSUPPORTED_ENCAP:
+    case WTAP_ERR_UNWRITABLE_ENCAP:
+      /*
+       * This is a problem with the particular frame we're writing and
+       * the file type and subtype we're wwriting; note that, and
+       * report the frame number and file type/subtype.
+       */
+      fprintf(stderr, "mergecap: Frame %u of \"%s\" has a network type that can't be saved in a \"%s\" file.\n",
+              in_file ? in_file->packet_num : 0, in_file ? in_file->filename : "UNKNOWN",
+              wtap_file_type_subtype_string(file_type));
+      break;
+
+    case WTAP_ERR_PACKET_TOO_LARGE:
+      /*
+       * This is a problem with the particular frame we're writing and
+       * the file type and subtype we're wwriting; note that, and
+       * report the frame number and file type/subtype.
+       */
+      fprintf(stderr, "mergecap: Frame %u of \"%s\" is too large for a \"%s\" file.\n",
+              in_file ? in_file->packet_num : 0, in_file ? in_file->filename : "UNKNOWN",
+              wtap_file_type_subtype_string(file_type));
+      break;
+
+    case WTAP_ERR_UNWRITABLE_REC_TYPE:
+      /*
+       * This is a problem with the particular record we're writing and
+       * the file type and subtype we're wwriting; note that, and
+       * report the record number and file type/subtype.
+       */
+      fprintf(stderr, "mergecap: Record %u of \"%s\" has a record type that can't be saved in a \"%s\" file.\n",
+              in_file ? in_file->packet_num : 0, in_file ? in_file->filename : "UNKNOWN",
+              wtap_file_type_subtype_string(file_type));
+      break;
+
+    case WTAP_ERR_UNWRITABLE_REC_DATA:
       /*
-       * This is a problem with the particular frame we're writing;
-       * note that, and give the frame number.
+       * This is a problem with the particular record we're writing and
+       * the file type and subtype we're wwriting; note that, and
+       * report the record number and file type/subtype.
        */
-      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);
+      fprintf(stderr, "mergecap: Record %u of \"%s\" has data that can't be saved in a \"%s\" file.\n(%s)\n",
+              in_file ? in_file->packet_num : 0, in_file ? in_file->filename : "UNKNOWN",
+              wtap_file_type_subtype_string(file_type),
+              write_err_info != NULL ? write_err_info : "no information supplied");
+      g_free(write_err_info);
       break;
 
     default:
@@ -515,11 +612,11 @@ main(int argc, char *argv[])
  *
  * Local variables:
  * c-basic-offset: 2
- * tab-width: 2
+ * tab-width: 8
  * indent-tabs-mode: nil
  * End:
  *
- * vi: set shiftwidth=2 tabstop=2 expandtab:
- * :indentSize=2:tabSize=2:noTabs=true:
+ * vi: set shiftwidth=2 tabstop=8 expandtab:
+ * :indentSize=2:tabSize=8:noTabs=true:
  */