fix doxygen generation
[obnox/wireshark/wip.git] / editcap.c
index 0d1edb971fc948043dd833799818dd94b85f3ad7..d6be0135fa42c68856211cc61fd4a93d5728391a 100644 (file)
--- a/editcap.c
+++ b/editcap.c
-/* Edit capture files.  We can delete records, or simply convert from one 
- * format to another format.
+/* Edit capture files.  We can delete records, adjust timestamps, or
+ * simply convert from one format to another format.
  *
- * $Id: editcap.c,v 1.4 1999/12/12 21:04:29 sharpe Exp $
+ * $Id$
  *
  * Originally written by Richard Sharpe.
  * Improved by Guy Harris.
+ * Further improved by Richard Sharpe.
  */
 
+#ifdef HAVE_CONFIG_H
+#include "config.h"
+#endif
+
 #include <stdio.h>
 #include <stdlib.h>
 #include <glib.h>
+
+#ifdef HAVE_UNISTD_H
 #include <unistd.h>
+#endif
+
+#ifdef HAVE_SYS_TIME_H
 #include <sys/time.h>
+#endif
+
+#include <string.h>
 #include "wtap.h"
 
+#ifdef NEED_GETOPT_H
+#include "getopt.h"
+#endif
+
 /*
  * Some globals so we can pass things to various routines
  */
 
-int selectfrm[100], max_selected = -1;
+struct select_item {
+
+  int inclusive;
+  int first, second;
+
+};
+
+#define ONE_MILLION 1000000
+
+struct time_adjustment {
+  struct timeval tv;
+  int is_negative;
+};
+
+static struct select_item selectfrm[100];
+static int max_selected = -1;
 static int count = 1;
 static int keep_em = 0;
 static int out_file_type = WTAP_FILE_PCAP;   /* default to "libpcap"   */
 static int out_frame_type = -2;              /* Leave frame type alone */
 static int verbose = 0;                      /* Not so verbose         */
+static unsigned int snaplen = 0;             /* No limit               */
+static struct time_adjustment time_adj = {{0, 0}, 0}; /* no adjustment */
+
+/* Add a selection item, a simple parser for now */
+
+static void add_selection(char *sel)
+{
+  char *locn;
+  char *next;
+
+  if (max_selected == (sizeof(selectfrm)/sizeof(struct select_item)) - 1)
+    return;
+
+  printf("Add_Selected: %s\n", sel);
+
+  if ((locn = strchr(sel, '-')) == NULL) { /* No dash, so a single number? */
+
+    printf("Not inclusive ...");
+
+    max_selected++;
+    selectfrm[max_selected].inclusive = 0;
+    selectfrm[max_selected].first = atoi(sel);
+
+    printf(" %i\n", selectfrm[max_selected].first);
+
+  }
+  else {
+
+    printf("Inclusive ...");
+
+    next = locn + 1;
+    max_selected++;
+    selectfrm[max_selected].inclusive = 1;
+    selectfrm[max_selected].first = atoi(sel);
+    selectfrm[max_selected].second = atoi(next);
+
+    printf(" %i, %i\n", selectfrm[max_selected].first, selectfrm[max_selected].second);
+
+  }
+
+
+}
 
 /* Was the record selected? */
 
-int selected(int recno)
+static int selected(int recno)
 {
   int i = 0;
 
   for (i = 0; i<= max_selected; i++) {
 
-    if (recno == selectfrm[i]) return 1;
-
+    if (selectfrm[i].inclusive) {
+      if (selectfrm[i].first <= recno && selectfrm[i].second >= recno)
+       return 1;
+    }
+    else {
+      if (recno == selectfrm[i].first)
+       return 1;
+    }
   }
 
   return 0;
@@ -53,11 +133,12 @@ typedef struct {
  */
 
 static void
-edit_callback(u_char *user, const struct wtap_pkthdr *phdr, int offset,
-    const u_char *buf) 
+edit_callback(guchar *user, const struct wtap_pkthdr *phdr, long offset _U_,
+    union wtap_pseudo_header *pseudo_header, const guchar *buf)
 {
   callback_arg *argp = (callback_arg *)user;
   int err;
+  struct wtap_pkthdr snap_phdr;
 
   if ((!selected(count) && !keep_em) ||
       (selected(count) && keep_em)) {
@@ -65,9 +146,49 @@ edit_callback(u_char *user, const struct wtap_pkthdr *phdr, int offset,
     if (verbose)
       printf("Record: %u\n", count);
 
-    /* We simply write it, we could do other things, like modify it */
+    /* We simply write it, perhaps after truncating it; we could do other
+       things, like modify it. */
 
-    if (!wtap_dump(argp->pdh, phdr, buf, &err)) {
+    if (snaplen != 0 && phdr->caplen > snaplen) {
+      snap_phdr = *phdr;
+      snap_phdr.caplen = snaplen;
+      phdr = &snap_phdr;
+    }
+
+    /* assume that if the frame's tv_sec is 0, then
+     * the timestamp isn't supported */
+    if (phdr->ts.tv_sec > 0 && time_adj.tv.tv_sec != 0) {
+      snap_phdr = *phdr;
+      if (time_adj.is_negative)
+        snap_phdr.ts.tv_sec -= time_adj.tv.tv_sec;
+      else
+        snap_phdr.ts.tv_sec += time_adj.tv.tv_sec;
+      phdr = &snap_phdr;
+    }
+
+    /* assume that if the frame's tv_sec is 0, then
+     * the timestamp isn't supported */
+    if (phdr->ts.tv_sec > 0 && time_adj.tv.tv_usec != 0) {
+      snap_phdr = *phdr;
+      if (time_adj.is_negative) { /* subtract */
+        if (snap_phdr.ts.tv_usec < time_adj.tv.tv_usec) { /* borrow */
+          snap_phdr.ts.tv_sec--;
+          snap_phdr.ts.tv_usec += ONE_MILLION;
+        }
+        snap_phdr.ts.tv_usec -= time_adj.tv.tv_usec;
+      } else {                  /* add */
+        if (snap_phdr.ts.tv_usec + time_adj.tv.tv_usec > ONE_MILLION) {
+          /* carry */
+          snap_phdr.ts.tv_sec++;
+          snap_phdr.ts.tv_usec += time_adj.tv.tv_usec - ONE_MILLION;
+        } else {
+          snap_phdr.ts.tv_usec += time_adj.tv.tv_usec;
+        }
+      }
+      phdr = &snap_phdr;
+    }
+
+    if (!wtap_dump(argp->pdh, phdr, pseudo_header, buf, &err)) {
 
       fprintf(stderr, "editcap: Error writing to %s: %s\n", argp->filename,
         wtap_strerror(err));
@@ -81,13 +202,80 @@ edit_callback(u_char *user, const struct wtap_pkthdr *phdr, int offset,
 
 }
 
-void usage()
+static void
+set_time_adjustment(char *optarg)
+{
+  char *frac, *end;
+  long val;
+  int frac_digits;
+
+  if (!optarg)
+    return;
+
+  /* skip leading whitespace */
+  while (*optarg == ' ' || *optarg == '\t') {
+      optarg++;
+  }
+
+  /* check for a negative adjustment */
+  if (*optarg == '-') {
+      time_adj.is_negative = 1;
+      optarg++;
+  }
+
+  /* collect whole number of seconds, if any */
+  if (*optarg == '.') {         /* only fractional (i.e., .5 is ok) */
+      val  = 0;
+      frac = optarg;
+  } else {
+      val = strtol(optarg, &frac, 10);
+      if (frac == NULL || frac == optarg || val == LONG_MIN || val == LONG_MAX) {
+          fprintf(stderr, "editcap: \"%s\" is not a valid ime adjustment\n",
+                  optarg);
+          exit(1);
+      }
+      if (val < 0) {            /* implies '--' since we caught '-' above  */
+          fprintf(stderr, "editcap: \"%s\" is not a valid time adjustment\n",
+                  optarg);
+          exit(1);
+      }
+  }
+  time_adj.tv.tv_sec = val;
+
+  /* now collect the partial seconds, if any */
+  if (*frac != '\0') {             /* chars left, so get fractional part */
+    val = strtol(&(frac[1]), &end, 10);
+    if (*frac != '.' || end == NULL || end == frac
+        || val < 0 || val > ONE_MILLION || val == LONG_MIN || val == LONG_MAX) {
+      fprintf(stderr, "editcap: \"%s\" is not a valid time adjustment\n",
+              optarg);
+      exit(1);
+    }
+  }
+  else {
+    return;                     /* no fractional digits */
+  }
+
+  /* adjust fractional portion from fractional to numerator
+   * e.g., in "1.5" from 5 to 500000 since .5*10^6 = 500000 */
+  if (frac && end) {            /* both are valid */
+    frac_digits = end - frac - 1;   /* fractional digit count (remember '.') */
+    while(frac_digits < 6) {    /* this is frac of 10^6 */
+      val *= 10;
+      frac_digits++;
+    }
+  }
+  time_adj.tv.tv_usec = val;
+}
+
+static void usage(void)
 {
   int i;
   const char *string;
 
-  fprintf(stderr, "Usage: editcap [-r] [-h] [-v] [-T <encap type>] [-F <capture type>] <infile>\\\n"); 
-  fprintf(stderr, "                <outfile> [ <record#> ... ]\n");
+  fprintf(stderr, "Usage: editcap [-r] [-h] [-v] [-T <encap type>] [-F <capture type>]\n");
+  fprintf(stderr, "               [-s <snaplen>] [-t <time adjustment>]\n");
+  fprintf(stderr, "               <infile> <outfile> [ <record#>[-<record#>] ... ]\n");
   fprintf(stderr, "  where\t-r specifies that the records specified should be kept, not deleted, \n");
   fprintf(stderr, "                           default is to delete\n");
   fprintf(stderr, "       \t-v specifies verbose operation, default is silent\n");
@@ -107,6 +295,11 @@ void usage()
         wtap_file_type_short_string(i), wtap_file_type_string(i));
   }
   fprintf(stderr, "       \t    default is libpcap\n");
+  fprintf(stderr, "       \t-s <snaplen> specifies that packets should be truncated to\n");
+  fprintf(stderr, "       \t   <snaplen> bytes of data\n");
+  fprintf(stderr, "       \t-t <time adjustment> specifies the time adjustment\n");
+  fprintf(stderr, "       \t   to be applied to selected packets\n");
+  fprintf(stderr, "\n      \t    A range of records can be specified as well\n");
 }
 
 int main(int argc, char *argv[])
@@ -114,14 +307,17 @@ int main(int argc, char *argv[])
 {
   wtap *wth;
   int i, err;
+  gchar *err_info;
   callback_arg args;
   extern char *optarg;
-  extern int optind, opterr, optopt;
-  char opt;
+  extern int optind;
+  int opt;
+  char *p;
+  int snapshot_length;
 
   /* Process the options first */
 
-  while ((opt = getopt(argc, argv, "T:F:rv")) != EOF) {
+  while ((opt = getopt(argc, argv, "T:F:rvs:t:h")) !=-1) {
 
     switch (opt) {
 
@@ -133,7 +329,7 @@ int main(int argc, char *argv[])
        exit(1);
       }
       break;
-      
+
     case 'F':
       out_file_type = wtap_short_string_to_file_type(optarg);
       if (out_file_type < 0) {
@@ -151,6 +347,19 @@ int main(int argc, char *argv[])
       keep_em = !keep_em;  /* Just invert */
       break;
 
+    case 's':
+      snaplen = strtol(optarg, &p, 10);
+      if (p == optarg || *p != '\0') {
+       fprintf(stderr, "editcap: \"%s\" is not a valid snapshot length\n",
+           optarg);
+       exit(1);
+      }
+      break;
+
+    case 't':
+      set_time_adjustment(optarg);
+      break;
+
     case 'h':
       usage();
       exit(1);
@@ -176,12 +385,20 @@ int main(int argc, char *argv[])
 
   }
 
-  wth = wtap_open_offline(argv[optind], &err);
+  wth = wtap_open_offline(argv[optind], &err, &err_info, FALSE);
 
   if (!wth) {
-
     fprintf(stderr, "editcap: Can't open %s: %s\n", argv[optind],
         wtap_strerror(err));
+    switch (err) {
+
+    case WTAP_ERR_UNSUPPORTED:
+    case WTAP_ERR_UNSUPPORTED_ENCAP:
+    case WTAP_ERR_BAD_RECORD:
+      fprintf(stderr, "(%s)\n", err_info);
+      g_free(err_info);
+      break;
+    }
     exit(1);
 
   }
@@ -204,6 +421,11 @@ int main(int argc, char *argv[])
     if (out_frame_type == -2)
       out_frame_type = wtap_file_encap(wth);
 
+    snapshot_length = wtap_snapshot_length(wth);
+    if (snapshot_length == 0) {
+      /* Snapshot length of input file not known. */
+      snapshot_length = WTAP_MAX_PACKET_SIZE;
+    }
     args.pdh = wtap_dump_open(argv[optind + 1], out_file_type,
                              out_frame_type, wtap_snapshot_length(wth), &err);
     if (args.pdh == NULL) {
@@ -215,9 +437,22 @@ int main(int argc, char *argv[])
     }
 
     for (i = optind + 2; i < argc; i++)
-      selectfrm[++max_selected] = atoi(argv[i]);
-
-    wtap_loop(wth, 0, edit_callback, (char *)&args, &err);
+      add_selection(argv[i]);
+
+    if (!wtap_loop(wth, 0, edit_callback, (char *)&args, &err, &err_info)) {
+      /* Print a message noting that the read failed somewhere along the line. */
+      fprintf(stderr,
+              "editcap: An error occurred while reading \"%s\": %s.\n",
+             argv[optind], wtap_strerror(err));
+      switch (err) {
+
+      case WTAP_ERR_UNSUPPORTED:
+      case WTAP_ERR_UNSUPPORTED_ENCAP:
+      case WTAP_ERR_BAD_RECORD:
+       fprintf(stderr, "(%s)\n", err_info);
+       break;
+      }
+    }
 
     if (!wtap_dump_close(args.pdh, &err)) {
 
@@ -228,7 +463,6 @@ int main(int argc, char *argv[])
     }
   }
 
-  exit(0);
-  return 0;  /* Silence compiler warnings */
+  return 0;
 }
-  
+