capinfos: Add -K option and report capture comments last
[metze/wireshark/wip.git] / capinfos.c
1 /* capinfos.c
2  * Reports capture file information including # of packets, duration, others
3  *
4  * Copyright 2004 Ian Schorr
5  *
6  * Wireshark - Network traffic analyzer
7  * By Gerald Combs <gerald@wireshark.org>
8  * Copyright 1998 Gerald Combs
9  *
10  * This program is free software; you can redistribute it and/or
11  * modify it under the terms of the GNU General Public License
12  * as published by the Free Software Foundation; either version 2
13  * of the License, or (at your option) any later version.
14  *
15  * This program is distributed in the hope that it will be useful,
16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18  * GNU General Public License for more details.
19  *
20  * You should have received a copy of the GNU General Public License
21  * along with this program; if not, write to the Free Software
22  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
23  */
24
25 /*
26  * 2009-09-19: jyoung
27  *
28  * New capinfos features
29  *
30  * Continue processing additional files after
31  * a wiretap open failure.  The new -C option
32  * reverts to capinfos' original behavior which
33  * is to cancel any further file processing at
34  * first file open failure.
35  *
36  * Change the behavior of how the default display
37  * of all infos is initiated.  This gets rid of a
38  * special post getopt() argument count test.
39  *
40  * Add new table output format (with related options)
41  * This feature allows outputting the various infos
42  * into a tab delimited text file, or to a comma
43  * separated variables file (*.csv) instead of the
44  * original "long" format.
45  *
46  * 2011-04-05: wmeier
47  * behaviour changed: Upon exit capinfos will return
48  *  an error status if an error occurred at any
49  *  point during "continuous" file processing.
50  *  (Previously a success status was always
51  *   returned if the -C option was not used).
52  *
53
54  */
55
56
57 #include <config.h>
58
59 #include <stdio.h>
60 #include <stdlib.h>
61 #include <string.h>
62 #include <stdarg.h>
63 #include <locale.h>
64 #include <errno.h>
65
66 #ifdef HAVE_GETOPT_H
67 #include <getopt.h>
68 #endif
69
70 #include <glib.h>
71
72 #include <wiretap/wtap.h>
73
74 #include <wsutil/crash_info.h>
75 #include <wsutil/filesystem.h>
76 #include <wsutil/privileges.h>
77 #include <ws_version_info.h>
78 #include <wiretap/wtap_opttypes.h>
79
80 #ifdef HAVE_PLUGINS
81 #include <wsutil/plugins.h>
82 #endif
83
84 #include <wsutil/report_err.h>
85 #include <wsutil/str_util.h>
86 #include <wsutil/file_util.h>
87
88 #include <wsutil/wsgcrypt.h>
89
90 #ifndef HAVE_GETOPT_LONG
91 #include "wsutil/wsgetopt.h"
92 #endif
93
94 #ifdef _WIN32
95 #include <wsutil/unicode-utils.h>
96 #endif /* _WIN32 */
97
98 #define INVALID_OPTION 1
99 #define BAD_FLAG 1
100
101 /*
102  * By default capinfos now continues processing
103  * the next filename if and when wiretap detects
104  * a problem opening a file.
105  * Use the '-C' option to revert back to original
106  * capinfos behavior which is to abort any
107  * additional file processing at first open file
108  * failure.
109  */
110
111 static gboolean continue_after_wtap_open_offline_failure = TRUE;
112
113 /*
114  * table report variables
115  */
116
117 static gboolean long_report        = TRUE;  /* By default generate long report       */
118 static gchar table_report_header   = TRUE;  /* Generate column header by default     */
119 static gchar field_separator       = '\t';  /* Use TAB as field separator by default */
120 static gchar quote_char            = '\0';  /* Do NOT quote fields by default        */
121 static gboolean machine_readable   = FALSE; /* Display machine-readable numbers      */
122
123 /*
124  * capinfos has the ability to report on a number of
125  * various characteristics ("infos") for each input file.
126  *
127  * By default reporting of all info fields is enabled.
128  *
129  * Optionally the reporting of any specific info field
130  * or combination of info fields can be enabled with
131  * individual options.
132  */
133
134 static gboolean report_all_infos   = TRUE;  /* Report all infos           */
135
136 static gboolean cap_file_type      = TRUE;  /* Report capture type        */
137 static gboolean cap_file_encap     = TRUE;  /* Report encapsulation       */
138 static gboolean cap_snaplen        = TRUE;  /* Packet size limit (snaplen)*/
139 static gboolean cap_packet_count   = TRUE;  /* Report packet count        */
140 static gboolean cap_file_size      = TRUE;  /* Report file size           */
141 static gboolean cap_comment        = TRUE;  /* Display the capture comment */
142 static gboolean cap_file_more_info = TRUE;  /* Report more file info      */
143 static gboolean cap_file_idb       = TRUE;  /* Report Interface info      */
144
145 static gboolean cap_data_size      = TRUE;  /* Report packet byte size    */
146 static gboolean cap_duration       = TRUE;  /* Report capture duration    */
147 static gboolean cap_start_time     = TRUE;  /* Report capture start time  */
148 static gboolean cap_end_time       = TRUE;  /* Report capture end time    */
149 static gboolean time_as_secs       = FALSE; /* Report time values as raw seconds */
150
151 static gboolean cap_data_rate_byte = TRUE;  /* Report data rate bytes/sec */
152 static gboolean cap_data_rate_bit  = TRUE;  /* Report data rate bites/sec */
153 static gboolean cap_packet_size    = TRUE;  /* Report average packet size */
154 static gboolean cap_packet_rate    = TRUE;  /* Report average packet rate */
155 static gboolean cap_order          = TRUE;  /* Report if packets are in chronological order (True/False) */
156
157 static gboolean cap_file_hashes    = TRUE;  /* Calculate file hashes */
158
159 #define HASH_SIZE_SHA1   20
160 #define HASH_SIZE_RMD160 20
161 #define HASH_SIZE_MD5    16
162
163 #define HASH_STR_SIZE (41) /* Max hash size * 2 + '\0' */
164 #define HASH_BUF_SIZE (1024 * 1024)
165
166
167 static gchar file_sha1[HASH_STR_SIZE];
168 static gchar file_rmd160[HASH_STR_SIZE];
169 static gchar file_md5[HASH_STR_SIZE];
170
171 /*
172  * If we have at least two packets with time stamps, and they're not in
173  * order - i.e., the later packet has a time stamp older than the earlier
174  * packet - the time stamps are known not to be in order.
175  *
176  * If every packet has a time stamp, and they're all in order, the time
177  * stamp is known to be in order.
178  *
179  * Otherwise, we have no idea.
180  */
181 typedef enum {
182   IN_ORDER,
183   NOT_IN_ORDER,
184   ORDER_UNKNOWN
185 } order_t;
186
187 typedef struct _capture_info {
188   const char    *filename;
189   guint16        file_type;
190   gboolean       iscompressed;
191   int            file_encap;
192   int            file_tsprec;
193   gint64         filesize;
194   wtap_block_t   shb;
195   guint64        packet_bytes;
196   gboolean       times_known;
197   nstime_t       start_time;
198   int            start_time_tsprec;
199   nstime_t       stop_time;
200   int            stop_time_tsprec;
201   guint32        packet_count;
202   gboolean       snap_set;                /* If set in capture file header      */
203   guint32        snaplen;                 /* value from the capture file header */
204   guint32        snaplen_min_inferred;    /* If caplen < len for 1 or more rcds */
205   guint32        snaplen_max_inferred;    /*  ...                               */
206   gboolean       drops_known;
207   guint32        drop_count;
208
209   nstime_t       duration;
210   int            duration_tsprec;
211   double         packet_rate;
212   double         packet_size;
213   double         data_rate;              /* in bytes */
214   gboolean       know_order;
215   order_t        order;
216
217   int           *encap_counts;           /* array of per_packet encap counts; array has one entry per wtap_encap type */
218
219   guint          num_interfaces;         /* number of IDBs, and thus size of interface_packet_counts array */
220   GArray        *interface_packet_counts;  /* array of per_packet interface_id counts; one entry per file IDB */
221   guint32        pkt_interface_id_unknown; /* counts if packet interface_id didn't match a known one */
222   GArray        *idb_info_strings;       /* array of IDB info strings */
223 } capture_info;
224
225 static char *decimal_point;
226
227 static void
228 enable_all_infos(void)
229 {
230   report_all_infos   = TRUE;
231
232   cap_file_type      = TRUE;
233   cap_file_encap     = TRUE;
234   cap_snaplen        = TRUE;
235   cap_packet_count   = TRUE;
236   cap_file_size      = TRUE;
237   cap_comment        = TRUE;
238   cap_file_more_info = TRUE;
239   cap_file_idb       = TRUE;
240
241   cap_data_size      = TRUE;
242   cap_duration       = TRUE;
243   cap_start_time     = TRUE;
244   cap_end_time       = TRUE;
245   cap_order          = TRUE;
246
247   cap_data_rate_byte = TRUE;
248   cap_data_rate_bit  = TRUE;
249   cap_packet_size    = TRUE;
250   cap_packet_rate    = TRUE;
251
252   cap_file_hashes    = TRUE;
253 }
254
255 static void
256 disable_all_infos(void)
257 {
258   report_all_infos   = FALSE;
259
260   cap_file_type      = FALSE;
261   cap_file_encap     = FALSE;
262   cap_snaplen        = FALSE;
263   cap_packet_count   = FALSE;
264   cap_file_size      = FALSE;
265   cap_comment        = FALSE;
266   cap_file_more_info = FALSE;
267   cap_file_idb       = FALSE;
268
269   cap_data_size      = FALSE;
270   cap_duration       = FALSE;
271   cap_start_time     = FALSE;
272   cap_end_time       = FALSE;
273   cap_order          = FALSE;
274
275   cap_data_rate_byte = FALSE;
276   cap_data_rate_bit  = FALSE;
277   cap_packet_size    = FALSE;
278   cap_packet_rate    = FALSE;
279
280   cap_file_hashes    = FALSE;
281 }
282
283 static const gchar *
284 order_string(order_t order)
285 {
286   switch (order) {
287
288     case IN_ORDER:
289       return "True";
290
291     case NOT_IN_ORDER:
292       return "False";
293
294     case ORDER_UNKNOWN:
295       return "Unknown";
296
297     default:
298       return "???";  /* "cannot happen" (the next step is "Profit!") */
299   }
300 }
301
302 static gchar *
303 absolute_time_string(nstime_t *timer, int tsprecision, capture_info *cf_info)
304 {
305   static gchar  time_string_buf[4+1+2+1+2+1+2+1+2+1+2+1+9+1+1];
306   struct tm *ti_tm;
307
308   if (cf_info->times_known && cf_info->packet_count > 0) {
309     if (time_as_secs) {
310       switch (tsprecision) {
311
312       case WTAP_TSPREC_SEC:
313         g_snprintf(time_string_buf, sizeof time_string_buf,
314                    "%lu",
315                    (unsigned long)timer->secs);
316         break;
317
318       case WTAP_TSPREC_DSEC:
319         g_snprintf(time_string_buf, sizeof time_string_buf,
320                    "%lu%s%01d",
321                    (unsigned long)timer->secs,
322                    decimal_point,
323                    timer->nsecs / 100000000);
324         break;
325
326       case WTAP_TSPREC_CSEC:
327         g_snprintf(time_string_buf, sizeof time_string_buf,
328                    "%lu%s%02d",
329                    (unsigned long)timer->secs,
330                    decimal_point,
331                    timer->nsecs / 10000000);
332         break;
333
334       case WTAP_TSPREC_MSEC:
335         g_snprintf(time_string_buf, sizeof time_string_buf,
336                    "%lu%s%03d",
337                    (unsigned long)timer->secs,
338                    decimal_point,
339                    timer->nsecs / 1000000);
340         break;
341
342       case WTAP_TSPREC_USEC:
343         g_snprintf(time_string_buf, sizeof time_string_buf,
344                    "%lu%s%06d",
345                    (unsigned long)timer->secs,
346                    decimal_point,
347                    timer->nsecs / 1000);
348         break;
349
350       case WTAP_TSPREC_NSEC:
351         g_snprintf(time_string_buf, sizeof time_string_buf,
352                    "%lu%s%09d",
353                    (unsigned long)timer->secs,
354                    decimal_point,
355                    timer->nsecs);
356         break;
357
358       default:
359         g_snprintf(time_string_buf, sizeof time_string_buf,
360                    "Unknown precision %d",
361                    tsprecision);
362         break;
363       }
364       return time_string_buf;
365     } else {
366       ti_tm = localtime(&timer->secs);
367       if (ti_tm == NULL) {
368         g_snprintf(time_string_buf, sizeof time_string_buf, "Not representable");
369         return time_string_buf;
370       }
371       switch (tsprecision) {
372
373       case WTAP_TSPREC_SEC:
374         g_snprintf(time_string_buf, sizeof time_string_buf,
375                    "%04d-%02d-%02d %02d:%02d:%02d",
376                    ti_tm->tm_year + 1900,
377                    ti_tm->tm_mon + 1,
378                    ti_tm->tm_mday,
379                    ti_tm->tm_hour,
380                    ti_tm->tm_min,
381                    ti_tm->tm_sec);
382         break;
383
384       case WTAP_TSPREC_DSEC:
385         g_snprintf(time_string_buf, sizeof time_string_buf,
386                    "%04d-%02d-%02d %02d:%02d:%02d%s%01d",
387                    ti_tm->tm_year + 1900,
388                    ti_tm->tm_mon + 1,
389                    ti_tm->tm_mday,
390                    ti_tm->tm_hour,
391                    ti_tm->tm_min,
392                    ti_tm->tm_sec,
393                    decimal_point,
394                    timer->nsecs / 100000000);
395         break;
396
397       case WTAP_TSPREC_CSEC:
398         g_snprintf(time_string_buf, sizeof time_string_buf,
399                    "%04d-%02d-%02d %02d:%02d:%02d%s%02d",
400                    ti_tm->tm_year + 1900,
401                    ti_tm->tm_mon + 1,
402                    ti_tm->tm_mday,
403                    ti_tm->tm_hour,
404                    ti_tm->tm_min,
405                    ti_tm->tm_sec,
406                    decimal_point,
407                    timer->nsecs / 10000000);
408         break;
409
410       case WTAP_TSPREC_MSEC:
411         g_snprintf(time_string_buf, sizeof time_string_buf,
412                    "%04d-%02d-%02d %02d:%02d:%02d%s%03d",
413                    ti_tm->tm_year + 1900,
414                    ti_tm->tm_mon + 1,
415                    ti_tm->tm_mday,
416                    ti_tm->tm_hour,
417                    ti_tm->tm_min,
418                    ti_tm->tm_sec,
419                    decimal_point,
420                    timer->nsecs / 1000000);
421         break;
422
423       case WTAP_TSPREC_USEC:
424         g_snprintf(time_string_buf, sizeof time_string_buf,
425                    "%04d-%02d-%02d %02d:%02d:%02d%s%06d",
426                    ti_tm->tm_year + 1900,
427                    ti_tm->tm_mon + 1,
428                    ti_tm->tm_mday,
429                    ti_tm->tm_hour,
430                    ti_tm->tm_min,
431                    ti_tm->tm_sec,
432                    decimal_point,
433                    timer->nsecs / 1000);
434         break;
435
436       case WTAP_TSPREC_NSEC:
437         g_snprintf(time_string_buf, sizeof time_string_buf,
438                    "%04d-%02d-%02d %02d:%02d:%02d%s%09d",
439                    ti_tm->tm_year + 1900,
440                    ti_tm->tm_mon + 1,
441                    ti_tm->tm_mday,
442                    ti_tm->tm_hour,
443                    ti_tm->tm_min,
444                    ti_tm->tm_sec,
445                    decimal_point,
446                    timer->nsecs);
447         break;
448
449       default:
450         g_snprintf(time_string_buf, sizeof time_string_buf,
451                    "Unknown precision %d",
452                    tsprecision);
453         break;
454       }
455       return time_string_buf;
456     }
457   }
458
459   g_snprintf(time_string_buf, sizeof time_string_buf, "n/a");
460   return time_string_buf;
461 }
462
463 static gchar *
464 relative_time_string(nstime_t *timer, int tsprecision, capture_info *cf_info, gboolean want_seconds)
465 {
466   const gchar  *second = want_seconds ? " second" : "";
467   const gchar  *plural = want_seconds ? "s" : "";
468   static gchar  time_string_buf[4+1+2+1+2+1+2+1+2+1+2+1+1];
469
470   if (cf_info->times_known && cf_info->packet_count > 0) {
471     switch (tsprecision) {
472
473     case WTAP_TSPREC_SEC:
474       g_snprintf(time_string_buf, sizeof time_string_buf,
475                  "%lu%s%s",
476                  (unsigned long)timer->secs,
477                  second,
478                  timer->secs == 1 ? "" : plural);
479       break;
480
481     case WTAP_TSPREC_DSEC:
482       g_snprintf(time_string_buf, sizeof time_string_buf,
483                  "%lu%s%01d%s%s",
484                  (unsigned long)timer->secs,
485                  decimal_point,
486                  timer->nsecs / 100000000,
487                  second,
488                  (timer->secs == 1 && timer->nsecs == 0) ? "" : plural);
489       break;
490
491     case WTAP_TSPREC_CSEC:
492       g_snprintf(time_string_buf, sizeof time_string_buf,
493                  "%lu%s%02d%s%s",
494                  (unsigned long)timer->secs,
495                  decimal_point,
496                  timer->nsecs / 10000000,
497                  second,
498                  (timer->secs == 1 && timer->nsecs == 0) ? "" : plural);
499       break;
500
501     case WTAP_TSPREC_MSEC:
502       g_snprintf(time_string_buf, sizeof time_string_buf,
503                  "%lu%s%03d%s%s",
504                  (unsigned long)timer->secs,
505                  decimal_point,
506                  timer->nsecs / 1000000,
507                  second,
508                  (timer->secs == 1 && timer->nsecs == 0) ? "" : plural);
509       break;
510
511     case WTAP_TSPREC_USEC:
512       g_snprintf(time_string_buf, sizeof time_string_buf,
513                  "%lu%s%06d%s%s",
514                  (unsigned long)timer->secs,
515                  decimal_point,
516                  timer->nsecs / 1000,
517                  second,
518                  (timer->secs == 1 && timer->nsecs == 0) ? "" : plural);
519       break;
520
521     case WTAP_TSPREC_NSEC:
522       g_snprintf(time_string_buf, sizeof time_string_buf,
523                  "%lu%s%09d%s%s",
524                  (unsigned long)timer->secs,
525                  decimal_point,
526                  timer->nsecs,
527                  second,
528                  (timer->secs == 1 && timer->nsecs == 0) ? "" : plural);
529       break;
530
531     default:
532       g_snprintf(time_string_buf, sizeof time_string_buf,
533                  "Unknown precision %d",
534                  tsprecision);
535       break;
536     }
537     return time_string_buf;
538   }
539
540   g_snprintf(time_string_buf, sizeof time_string_buf, "n/a");
541   return time_string_buf;
542 }
543
544 static void print_value(const gchar *text_p1, gint width, const gchar *text_p2, double value) {
545   if (value > 0.0)
546     printf("%s%.*f%s\n", text_p1, width, value, text_p2);
547   else
548     printf("%sn/a\n", text_p1);
549 }
550
551 /* multi-line comments would conflict with the formatting that capinfos uses
552    we replace linefeeds with spaces */
553 static void
554 string_replace_newlines(gchar *str)
555 {
556   gchar *p;
557
558   if (str) {
559     p = str;
560     while (*p != '\0') {
561       if (*p == '\n')
562         *p = ' ';
563       if (*p == '\r')
564         *p = ' ';
565       p++;
566     }
567   }
568 }
569
570 static void
571 show_option_string(const char *prefix, const char *option_str)
572 {
573   char *str;
574
575   if (option_str != NULL && option_str[0] != '\0') {
576     str = g_strdup(option_str);
577     string_replace_newlines(str);
578     printf("%s%s\n", prefix, str);
579     g_free(str);
580   }
581 }
582
583 static void
584 print_stats(const gchar *filename, capture_info *cf_info)
585 {
586   const gchar           *file_type_string, *file_encap_string;
587   gchar                 *size_string;
588
589   /* Build printable strings for various stats */
590   file_type_string = wtap_file_type_subtype_string(cf_info->file_type);
591   file_encap_string = wtap_encap_string(cf_info->file_encap);
592
593   if (filename)           printf     ("File name:           %s\n", filename);
594   if (cap_file_type)      printf     ("File type:           %s%s\n",
595       file_type_string,
596       cf_info->iscompressed ? " (gzip compressed)" : "");
597
598   if (cap_file_encap) {
599     printf      ("File encapsulation:  %s\n", file_encap_string);
600     if (cf_info->file_encap == WTAP_ENCAP_PER_PACKET) {
601       int i;
602       printf    ("Encapsulation in use by packets (# of pkts):\n");
603       for (i=0; i<WTAP_NUM_ENCAP_TYPES; i++) {
604         if (cf_info->encap_counts[i] > 0)
605           printf("                     %s (%d)\n",
606                  wtap_encap_string(i), cf_info->encap_counts[i]);
607       }
608     }
609   }
610   if (cap_file_more_info) {
611     printf      ("File timestamp precision:  %s (%d)\n",
612       wtap_tsprec_string(cf_info->file_tsprec), cf_info->file_tsprec);
613   }
614
615   if (cap_snaplen && cf_info->snap_set)
616     printf     ("Packet size limit:   file hdr: %u bytes\n", cf_info->snaplen);
617   else if (cap_snaplen && !cf_info->snap_set)
618     printf     ("Packet size limit:   file hdr: (not set)\n");
619   if (cf_info->snaplen_max_inferred > 0) {
620     if (cf_info->snaplen_min_inferred == cf_info->snaplen_max_inferred)
621       printf     ("Packet size limit:   inferred: %u bytes\n", cf_info->snaplen_min_inferred);
622     else
623       printf     ("Packet size limit:   inferred: %u bytes - %u bytes (range)\n",
624           cf_info->snaplen_min_inferred, cf_info->snaplen_max_inferred);
625   }
626   if (cap_packet_count) {
627     printf     ("Number of packets:   ");
628     if (machine_readable) {
629       printf ("%u\n", cf_info->packet_count);
630     } else {
631       size_string = format_size(cf_info->packet_count, format_size_unit_none);
632       printf ("%s\n", size_string);
633       g_free(size_string);
634     }
635   }
636   if (cap_file_size) {
637     printf     ("File size:           ");
638     if (machine_readable) {
639       printf     ("%" G_GINT64_MODIFIER "d bytes\n", cf_info->filesize);
640     } else {
641       size_string = format_size(cf_info->filesize, format_size_unit_bytes);
642       printf ("%s\n", size_string);
643       g_free(size_string);
644     }
645   }
646   if (cap_data_size) {
647     printf     ("Data size:           ");
648     if (machine_readable) {
649       printf     ("%" G_GINT64_MODIFIER "u bytes\n", cf_info->packet_bytes);
650     } else {
651       size_string = format_size(cf_info->packet_bytes, format_size_unit_bytes);
652       printf ("%s\n", size_string);
653       g_free(size_string);
654     }
655   }
656   if (cf_info->times_known) {
657     if (cap_duration) /* XXX - shorten to hh:mm:ss */
658                           printf("Capture duration:    %s\n", relative_time_string(&cf_info->duration, cf_info->duration_tsprec, cf_info, TRUE));
659     if (cap_start_time)
660                           printf("First packet time:   %s\n", absolute_time_string(&cf_info->start_time, cf_info->start_time_tsprec, cf_info));
661     if (cap_end_time)
662                           printf("Last packet time:    %s\n", absolute_time_string(&cf_info->stop_time, cf_info->stop_time_tsprec, cf_info));
663     if (cap_data_rate_byte) {
664                           printf("Data byte rate:      ");
665       if (machine_readable) {
666         print_value("", 2, " bytes/sec",   cf_info->data_rate);
667       } else {
668         size_string = format_size((gint64)cf_info->data_rate, format_size_unit_bytes_s);
669         printf ("%s\n", size_string);
670         g_free(size_string);
671       }
672     }
673     if (cap_data_rate_bit) {
674                           printf("Data bit rate:       ");
675       if (machine_readable) {
676         print_value("", 2, " bits/sec",    cf_info->data_rate*8);
677       } else {
678         size_string = format_size((gint64)(cf_info->data_rate*8), format_size_unit_bits_s);
679         printf ("%s\n", size_string);
680         g_free(size_string);
681       }
682     }
683   }
684   if (cap_packet_size)    printf("Average packet size: %.2f bytes\n",        cf_info->packet_size);
685   if (cf_info->times_known) {
686     if (cap_packet_rate) {
687                           printf("Average packet rate: ");
688       if (machine_readable) {
689         print_value("", 2, " packets/sec", cf_info->packet_rate);
690       } else {
691         size_string = format_size((gint64)cf_info->packet_rate, format_size_unit_packets_s);
692         printf ("%s\n", size_string);
693         g_free(size_string);
694       }
695     }
696   }
697   if (cap_file_hashes) {
698     printf     ("SHA1:                %s\n", file_sha1);
699     printf     ("RIPEMD160:           %s\n", file_rmd160);
700     printf     ("MD5:                 %s\n", file_md5);
701   }
702   if (cap_order)          printf     ("Strict time order:   %s\n", order_string(cf_info->order));
703
704   if (cf_info->shb != NULL) {
705     if (cap_file_more_info) {
706       char *str;
707
708       if (wtap_block_get_string_option_value(cf_info->shb, OPT_SHB_HARDWARE, &str) == WTAP_OPTTYPE_SUCCESS)
709         show_option_string("Capture hardware:    ", str);
710       if (wtap_block_get_string_option_value(cf_info->shb, OPT_SHB_OS, &str) == WTAP_OPTTYPE_SUCCESS)
711         show_option_string("Capture oper-sys:    ", str);
712       if (wtap_block_get_string_option_value(cf_info->shb, OPT_SHB_USERAPPL, &str) == WTAP_OPTTYPE_SUCCESS)
713         show_option_string("Capture application: ", str);
714     }
715     if (cap_comment) {
716       unsigned int i;
717       char *str;
718
719       for (i = 0; wtap_block_get_nth_string_option_value(cf_info->shb, OPT_COMMENT, i, &str) == WTAP_OPTTYPE_SUCCESS; i++) {
720         show_option_string("Capture comment:     ", str);
721       }
722     }
723
724     if (cap_file_idb && cf_info->num_interfaces != 0) {
725       guint i;
726       g_assert(cf_info->num_interfaces == cf_info->idb_info_strings->len);
727       printf     ("Number of interfaces in file: %u\n", cf_info->num_interfaces);
728       for (i = 0; i < cf_info->idb_info_strings->len; i++) {
729         gchar *s = g_array_index(cf_info->idb_info_strings, gchar*, i);
730         guint32 packet_count = 0;
731         if (i < cf_info->interface_packet_counts->len)
732           packet_count = g_array_index(cf_info->interface_packet_counts, guint32, i);
733         printf   ("Interface #%u info:\n", i);
734         printf   ("%s", s);
735         printf   ("                     Number of packets = %u\n", packet_count);
736       }
737     }
738   }
739 }
740
741 static void
742 putsep(void)
743 {
744   if (field_separator) putchar(field_separator);
745 }
746
747 static void
748 putquote(void)
749 {
750   if (quote_char) putchar(quote_char);
751 }
752
753 static void
754 print_stats_table_header_label(const gchar *label)
755 {
756   putsep();
757   putquote();
758   printf("%s", label);
759   putquote();
760 }
761
762 static void
763 print_stats_table_header(void)
764 {
765   putquote();
766   printf("File name");
767   putquote();
768
769   if (cap_file_type)      print_stats_table_header_label("File type");
770   if (cap_file_encap)     print_stats_table_header_label("File encapsulation");
771   if (cap_file_more_info) print_stats_table_header_label("File time precision");
772   if (cap_snaplen)        print_stats_table_header_label("Packet size limit");
773   if (cap_snaplen)        print_stats_table_header_label("Packet size limit min (inferred)");
774   if (cap_snaplen)        print_stats_table_header_label("Packet size limit max (inferred)");
775   if (cap_packet_count)   print_stats_table_header_label("Number of packets");
776   if (cap_file_size)      print_stats_table_header_label("File size (bytes)");
777   if (cap_data_size)      print_stats_table_header_label("Data size (bytes)");
778   if (cap_duration)       print_stats_table_header_label("Capture duration (seconds)");
779   if (cap_start_time)     print_stats_table_header_label("Start time");
780   if (cap_end_time)       print_stats_table_header_label("End time");
781   if (cap_data_rate_byte) print_stats_table_header_label("Data byte rate (bytes/sec)");
782   if (cap_data_rate_bit)  print_stats_table_header_label("Data bit rate (bits/sec)");
783   if (cap_packet_size)    print_stats_table_header_label("Average packet size (bytes)");
784   if (cap_packet_rate)    print_stats_table_header_label("Average packet rate (packets/sec)");
785   if (cap_file_hashes) {
786     print_stats_table_header_label("SHA1");
787     print_stats_table_header_label("RIPEMD160");
788     print_stats_table_header_label("MD5");
789   }
790   if (cap_order)          print_stats_table_header_label("Strict time order");
791   if (cap_file_more_info) {
792     print_stats_table_header_label("Capture hardware");
793     print_stats_table_header_label("Capture oper-sys");
794     print_stats_table_header_label("Capture application");
795   }
796   if (cap_comment)        print_stats_table_header_label("Capture comment");
797
798   printf("\n");
799 }
800
801 static void
802 print_stats_table(const gchar *filename, capture_info *cf_info)
803 {
804   const gchar           *file_type_string, *file_encap_string;
805
806   /* Build printable strings for various stats */
807   file_type_string = wtap_file_type_subtype_string(cf_info->file_type);
808   file_encap_string = wtap_encap_string(cf_info->file_encap);
809
810   if (filename) {
811     putquote();
812     printf("%s", filename);
813     putquote();
814   }
815
816   if (cap_file_type) {
817     putsep();
818     putquote();
819     printf("%s", file_type_string);
820     putquote();
821   }
822
823   /* ToDo: If WTAP_ENCAP_PER_PACKET, show the list of encapsulations encountered;
824    *       Output a line for each different encap with all fields repeated except
825    *        the encapsulation field which has "Per Packet: ..." for each
826    *        encapsulation type seen ?
827    */
828   if (cap_file_encap) {
829     putsep();
830     putquote();
831     printf("%s", file_encap_string);
832     putquote();
833   }
834
835   if (cap_file_more_info) {
836     putsep();
837     putquote();
838     printf("%s", wtap_tsprec_string(cf_info->file_tsprec));
839     putquote();
840   }
841
842   if (cap_snaplen) {
843     putsep();
844     putquote();
845     if (cf_info->snap_set)
846       printf("%u", cf_info->snaplen);
847     else
848       printf("(not set)");
849     putquote();
850     if (cf_info->snaplen_max_inferred > 0) {
851       putsep();
852       putquote();
853       printf("%u", cf_info->snaplen_min_inferred);
854       putquote();
855       putsep();
856       putquote();
857       printf("%u", cf_info->snaplen_max_inferred);
858       putquote();
859     }
860     else {
861       putsep();
862       putquote();
863       printf("n/a");
864       putquote();
865       putsep();
866       putquote();
867       printf("n/a");
868       putquote();
869     }
870   }
871
872   if (cap_packet_count) {
873     putsep();
874     putquote();
875     printf("%u", cf_info->packet_count);
876     putquote();
877   }
878
879   if (cap_file_size) {
880     putsep();
881     putquote();
882     printf("%" G_GINT64_MODIFIER "d", cf_info->filesize);
883     putquote();
884   }
885
886   if (cap_data_size) {
887     putsep();
888     putquote();
889     printf("%" G_GINT64_MODIFIER "u", cf_info->packet_bytes);
890     putquote();
891   }
892
893   if (cap_duration) {
894     putsep();
895     putquote();
896     printf("%s", relative_time_string(&cf_info->duration, cf_info->duration_tsprec, cf_info, FALSE));
897     putquote();
898   }
899
900   if (cap_start_time) {
901     putsep();
902     putquote();
903     printf("%s", absolute_time_string(&cf_info->start_time, cf_info->start_time_tsprec, cf_info));
904     putquote();
905   }
906
907   if (cap_end_time) {
908     putsep();
909     putquote();
910     printf("%s", absolute_time_string(&cf_info->stop_time, cf_info->stop_time_tsprec, cf_info));
911     putquote();
912   }
913
914   if (cap_data_rate_byte) {
915     putsep();
916     putquote();
917     if (cf_info->times_known)
918       printf("%.2f", cf_info->data_rate);
919     else
920       printf("n/a");
921     putquote();
922   }
923
924   if (cap_data_rate_bit) {
925     putsep();
926     putquote();
927     if (cf_info->times_known)
928       printf("%.2f", cf_info->data_rate*8);
929     else
930       printf("n/a");
931     putquote();
932   }
933
934   if (cap_packet_size) {
935     putsep();
936     putquote();
937     printf("%.2f", cf_info->packet_size);
938     putquote();
939   }
940
941   if (cap_packet_rate) {
942     putsep();
943     putquote();
944     if (cf_info->times_known)
945       printf("%.2f", cf_info->packet_rate);
946     else
947       printf("n/a");
948     putquote();
949   }
950
951   if (cap_file_hashes) {
952     putsep();
953     putquote();
954     printf("%s", file_sha1);
955     putquote();
956
957     putsep();
958     putquote();
959     printf("%s", file_rmd160);
960     putquote();
961
962     putsep();
963     putquote();
964     printf("%s", file_md5);
965     putquote();
966   }
967
968   if (cap_order) {
969     putsep();
970     putquote();
971     printf("%s", order_string(cf_info->order));
972     putquote();
973   }
974
975   if (cf_info->shb != NULL) {
976     if (cap_file_more_info) {
977       char *str;
978
979       putsep();
980       putquote();
981       if (wtap_block_get_string_option_value(cf_info->shb, OPT_SHB_HARDWARE, &str) == WTAP_OPTTYPE_SUCCESS) {
982         printf("%s", str);
983       }
984       putquote();
985
986       putsep();
987       putquote();
988       if (wtap_block_get_string_option_value(cf_info->shb, OPT_SHB_OS, &str) == WTAP_OPTTYPE_SUCCESS) {
989         printf("%s", str);
990       }
991       putquote();
992
993       putsep();
994       putquote();
995       if (wtap_block_get_string_option_value(cf_info->shb, OPT_SHB_USERAPPL, &str) == WTAP_OPTTYPE_SUCCESS) {
996         printf("%s", str);
997       }
998       putquote();
999     }
1000
1001     /*
1002      * One might argue that the following is silly to put into a table format,
1003      * but oh well note that there may be *more than one* of each of these types
1004      * of options.  To mitigate some of the potential silliness the if(cap_comment)
1005      * block is moved AFTER the if(cap_file_more_info) block.  This will make any
1006      * comments the last item(s) in each row.  We now have a new -K option to
1007      * disable cap_comment to more easily manage the potential silliness.
1008      * Potential silliness includes multiple comments (therefore resulting in
1009      * more than one additional column and/or comments with embeded newlines
1010      * and/or possible delimiters).
1011      */
1012     if (cap_comment) {
1013       unsigned int i;
1014       char *opt_comment;
1015       gboolean have_cap = FALSE;
1016
1017       for (i = 0; wtap_block_get_nth_string_option_value(cf_info->shb, OPT_COMMENT, i, &opt_comment) == WTAP_OPTTYPE_SUCCESS; i++) {
1018         have_cap = TRUE;
1019         putsep();
1020         putquote();
1021         printf("%s", opt_comment);
1022         putquote();
1023       }
1024       if(!have_cap) {
1025         /* Maintain column alignment when we have no OPT_COMMENT */
1026         putsep();
1027         putquote();
1028         putquote();
1029       }
1030     }
1031
1032   }
1033
1034   printf("\n");
1035 }
1036
1037 static void
1038 cleanup_capture_info(capture_info *cf_info)
1039 {
1040   guint i;
1041   g_assert(cf_info != NULL);
1042
1043   g_free(cf_info->encap_counts);
1044   cf_info->encap_counts = NULL;
1045
1046   g_array_free(cf_info->interface_packet_counts, TRUE);
1047   cf_info->interface_packet_counts = NULL;
1048
1049   if (cf_info->idb_info_strings) {
1050     for (i = 0; i < cf_info->idb_info_strings->len; i++) {
1051       gchar *s = g_array_index(cf_info->idb_info_strings, gchar*, i);
1052       g_free(s);
1053     }
1054     g_array_free(cf_info->idb_info_strings, TRUE);
1055   }
1056   cf_info->idb_info_strings = NULL;
1057 }
1058
1059 static int
1060 process_cap_file(wtap *wth, const char *filename)
1061 {
1062   int                   status = 0;
1063   int                   err;
1064   gchar                *err_info;
1065   gint64                size;
1066   gint64                data_offset;
1067
1068   guint32               packet = 0;
1069   gint64                bytes  = 0;
1070   guint32               snaplen_min_inferred = 0xffffffff;
1071   guint32               snaplen_max_inferred =          0;
1072   const struct wtap_pkthdr *phdr;
1073   capture_info          cf_info;
1074   gboolean              have_times = TRUE;
1075   nstime_t              start_time;
1076   int                   start_time_tsprec;
1077   nstime_t              stop_time;
1078   int                   stop_time_tsprec;
1079   nstime_t              cur_time;
1080   nstime_t              prev_time;
1081   gboolean              know_order = FALSE;
1082   order_t               order = IN_ORDER;
1083   guint                 i;
1084   wtapng_iface_descriptions_t *idb_info;
1085
1086   g_assert(wth != NULL);
1087   g_assert(filename != NULL);
1088
1089   nstime_set_zero(&start_time);
1090   start_time_tsprec = WTAP_TSPREC_UNKNOWN;
1091   nstime_set_zero(&stop_time);
1092   stop_time_tsprec = WTAP_TSPREC_UNKNOWN;
1093   nstime_set_zero(&cur_time);
1094   nstime_set_zero(&prev_time);
1095
1096   cf_info.shb = wtap_file_get_shb(wth);
1097
1098   cf_info.encap_counts = g_new0(int,WTAP_NUM_ENCAP_TYPES);
1099
1100   idb_info = wtap_file_get_idb_info(wth);
1101
1102   g_assert(idb_info->interface_data != NULL);
1103
1104   cf_info.num_interfaces = idb_info->interface_data->len;
1105   cf_info.interface_packet_counts  = g_array_sized_new(FALSE, TRUE, sizeof(guint32), cf_info.num_interfaces);
1106   g_array_set_size(cf_info.interface_packet_counts, cf_info.num_interfaces);
1107   cf_info.pkt_interface_id_unknown = 0;
1108
1109   g_free(idb_info);
1110   idb_info = NULL;
1111
1112   /* Tally up data that we need to parse through the file to find */
1113   while (wtap_read(wth, &err, &err_info, &data_offset))  {
1114     phdr = wtap_phdr(wth);
1115     if (phdr->presence_flags & WTAP_HAS_TS) {
1116       prev_time = cur_time;
1117       cur_time = phdr->ts;
1118       if (packet == 0) {
1119         start_time = phdr->ts;
1120         start_time_tsprec = phdr->pkt_tsprec;
1121         stop_time  = phdr->ts;
1122         stop_time_tsprec = phdr->pkt_tsprec;
1123         prev_time  = phdr->ts;
1124       }
1125       if (nstime_cmp(&cur_time, &prev_time) < 0) {
1126         order = NOT_IN_ORDER;
1127       }
1128       if (nstime_cmp(&cur_time, &start_time) < 0) {
1129         start_time = cur_time;
1130         start_time_tsprec = phdr->pkt_tsprec;
1131       }
1132       if (nstime_cmp(&cur_time, &stop_time) > 0) {
1133         stop_time = cur_time;
1134         stop_time_tsprec = phdr->pkt_tsprec;
1135       }
1136     } else {
1137       have_times = FALSE; /* at least one packet has no time stamp */
1138       if (order != NOT_IN_ORDER)
1139         order = ORDER_UNKNOWN;
1140     }
1141
1142     if (phdr->rec_type == REC_TYPE_PACKET) {
1143       bytes+=phdr->len;
1144       packet++;
1145
1146       /* If caplen < len for a rcd, then presumably           */
1147       /* 'Limit packet capture length' was done for this rcd. */
1148       /* Keep track as to the min/max actual snapshot lengths */
1149       /*  seen for this file.                                 */
1150       if (phdr->caplen < phdr->len) {
1151         if (phdr->caplen < snaplen_min_inferred)
1152           snaplen_min_inferred = phdr->caplen;
1153         if (phdr->caplen > snaplen_max_inferred)
1154           snaplen_max_inferred = phdr->caplen;
1155       }
1156
1157       if ((phdr->pkt_encap > 0) && (phdr->pkt_encap < WTAP_NUM_ENCAP_TYPES)) {
1158         cf_info.encap_counts[phdr->pkt_encap] += 1;
1159       } else {
1160         fprintf(stderr, "capinfos: Unknown packet encapsulation %d in frame %u of file \"%s\"\n",
1161                 phdr->pkt_encap, packet, filename);
1162       }
1163
1164       /* Packet interface_id info */
1165       if (phdr->presence_flags & WTAP_HAS_INTERFACE_ID) {
1166         /* cf_info.num_interfaces is size, not index, so it's one more than max index */
1167         if (phdr->interface_id >= cf_info.num_interfaces) {
1168           /*
1169            * OK, re-fetch the number of interfaces, as there might have
1170            * been an interface that was in the middle of packets, and
1171            * grow the array to be big enough for the new number of
1172            * interfaces.
1173            */
1174           idb_info = wtap_file_get_idb_info(wth);
1175
1176           cf_info.num_interfaces = idb_info->interface_data->len;
1177           g_array_set_size(cf_info.interface_packet_counts, cf_info.num_interfaces);
1178
1179           g_free(idb_info);
1180           idb_info = NULL;
1181         }
1182         if (phdr->interface_id < cf_info.num_interfaces) {
1183           g_array_index(cf_info.interface_packet_counts, guint32, phdr->interface_id) += 1;
1184         }
1185         else {
1186           cf_info.pkt_interface_id_unknown += 1;
1187         }
1188       }
1189       else {
1190         /* it's for interface_id 0 */
1191         if (cf_info.num_interfaces != 0) {
1192           g_array_index(cf_info.interface_packet_counts, guint32, 0) += 1;
1193         }
1194         else {
1195           cf_info.pkt_interface_id_unknown += 1;
1196         }
1197       }
1198     }
1199
1200   } /* while */
1201
1202   /*
1203    * Get IDB info strings.
1204    * We do this at the end, so we can get information for all IDBs in
1205    * the file, even those that come after packet records.
1206    */
1207   idb_info = wtap_file_get_idb_info(wth);
1208
1209   cf_info.idb_info_strings = g_array_sized_new(FALSE, FALSE, sizeof(gchar*), cf_info.num_interfaces);
1210   cf_info.num_interfaces = idb_info->interface_data->len;
1211   for (i = 0; i < cf_info.num_interfaces; i++) {
1212     const wtap_block_t if_descr = g_array_index(idb_info->interface_data, wtap_block_t, i);
1213     gchar *s = wtap_get_debug_if_descr(if_descr, 21, "\n");
1214     g_array_append_val(cf_info.idb_info_strings, s);
1215   }
1216
1217   g_free(idb_info);
1218   idb_info = NULL;
1219
1220   if (err != 0) {
1221     fprintf(stderr,
1222         "capinfos: An error occurred after reading %u packets from \"%s\": %s.\n",
1223         packet, filename, wtap_strerror(err));
1224     if (err == WTAP_ERR_SHORT_READ) {
1225         /* Don't give up completely with this one. */
1226         status = 1;
1227         fprintf(stderr,
1228           "  (will continue anyway, checksums might be incorrect)\n");
1229     } else {
1230         if (err_info != NULL) {
1231             fprintf(stderr, "(%s)\n", err_info);
1232             g_free(err_info);
1233         }
1234
1235         cleanup_capture_info(&cf_info);
1236         return 1;
1237     }
1238   }
1239
1240   /* File size */
1241   size = wtap_file_size(wth, &err);
1242   if (size == -1) {
1243     fprintf(stderr,
1244         "capinfos: Can't get size of \"%s\": %s.\n",
1245         filename, g_strerror(err));
1246     cleanup_capture_info(&cf_info);
1247     return 1;
1248   }
1249
1250   cf_info.filesize = size;
1251
1252   /* File Type */
1253   cf_info.file_type = wtap_file_type_subtype(wth);
1254   cf_info.iscompressed = wtap_iscompressed(wth);
1255
1256   /* File Encapsulation */
1257   cf_info.file_encap = wtap_file_encap(wth);
1258
1259   cf_info.file_tsprec = wtap_file_tsprec(wth);
1260
1261   /* Packet size limit (snaplen) */
1262   cf_info.snaplen = wtap_snapshot_length(wth);
1263   if (cf_info.snaplen > 0)
1264     cf_info.snap_set = TRUE;
1265   else
1266     cf_info.snap_set = FALSE;
1267
1268   cf_info.snaplen_min_inferred = snaplen_min_inferred;
1269   cf_info.snaplen_max_inferred = snaplen_max_inferred;
1270
1271   /* # of packets */
1272   cf_info.packet_count = packet;
1273
1274   /* File Times */
1275   cf_info.times_known = have_times;
1276   cf_info.start_time = start_time;
1277   cf_info.start_time_tsprec = start_time_tsprec;
1278   cf_info.stop_time = stop_time;
1279   cf_info.stop_time_tsprec = stop_time_tsprec;
1280   nstime_delta(&cf_info.duration, &stop_time, &start_time);
1281   /* Duration precision is the higher of the start and stop time precisions. */
1282   if (cf_info.stop_time_tsprec > cf_info.start_time_tsprec)
1283     cf_info.duration_tsprec = cf_info.stop_time_tsprec;
1284   else
1285     cf_info.duration_tsprec = cf_info.start_time_tsprec;
1286   cf_info.know_order = know_order;
1287   cf_info.order = order;
1288
1289   /* Number of packet bytes */
1290   cf_info.packet_bytes = bytes;
1291
1292   cf_info.data_rate   = 0.0;
1293   cf_info.packet_rate = 0.0;
1294   cf_info.packet_size = 0.0;
1295
1296   if (packet > 0) {
1297     double delta_time = nstime_to_sec(&stop_time) - nstime_to_sec(&start_time);
1298     if (delta_time > 0.0) {
1299       cf_info.data_rate   = (double)bytes  / delta_time; /* Data rate per second */
1300       cf_info.packet_rate = (double)packet / delta_time; /* packet rate per second */
1301     }
1302     cf_info.packet_size = (double)bytes / packet;                  /* Avg packet size      */
1303   }
1304
1305   if (long_report) {
1306     print_stats(filename, &cf_info);
1307   } else {
1308     print_stats_table(filename, &cf_info);
1309   }
1310
1311   cleanup_capture_info(&cf_info);
1312
1313   return status;
1314 }
1315
1316 static void
1317 print_usage(FILE *output)
1318 {
1319   fprintf(output, "\n");
1320   fprintf(output, "Usage: capinfos [options] <infile> ...\n");
1321   fprintf(output, "\n");
1322   fprintf(output, "General infos:\n");
1323   fprintf(output, "  -t display the capture file type\n");
1324   fprintf(output, "  -E display the capture file encapsulation\n");
1325   fprintf(output, "  -I display the capture file interface information\n");
1326   fprintf(output, "  -F display additional capture file information\n");
1327   fprintf(output, "  -H display the SHA1, RMD160, and MD5 hashes of the file\n");
1328   fprintf(output, "  -k display the capture comment\n");
1329   fprintf(output, "\n");
1330   fprintf(output, "Size infos:\n");
1331   fprintf(output, "  -c display the number of packets\n");
1332   fprintf(output, "  -s display the size of the file (in bytes)\n");
1333   fprintf(output, "  -d display the total length of all packets (in bytes)\n");
1334   fprintf(output, "  -l display the packet size limit (snapshot length)\n");
1335   fprintf(output, "\n");
1336   fprintf(output, "Time infos:\n");
1337   fprintf(output, "  -u display the capture duration (in seconds)\n");
1338   fprintf(output, "  -a display the capture start time\n");
1339   fprintf(output, "  -e display the capture end time\n");
1340   fprintf(output, "  -o display the capture file chronological status (True/False)\n");
1341   fprintf(output, "  -S display start and end times as seconds\n");
1342   fprintf(output, "\n");
1343   fprintf(output, "Statistic infos:\n");
1344   fprintf(output, "  -y display average data rate (in bytes/sec)\n");
1345   fprintf(output, "  -i display average data rate (in bits/sec)\n");
1346   fprintf(output, "  -z display average packet size (in bytes)\n");
1347   fprintf(output, "  -x display average packet rate (in packets/sec)\n");
1348   fprintf(output, "\n");
1349   fprintf(output, "Output format:\n");
1350   fprintf(output, "  -L generate long report (default)\n");
1351   fprintf(output, "  -T generate table report\n");
1352   fprintf(output, "  -M display machine-readable values in long reports\n");
1353   fprintf(output, "\n");
1354   fprintf(output, "Table report options:\n");
1355   fprintf(output, "  -R generate header record (default)\n");
1356   fprintf(output, "  -r do not generate header record\n");
1357   fprintf(output, "\n");
1358   fprintf(output, "  -B separate infos with TAB character (default)\n");
1359   fprintf(output, "  -m separate infos with comma (,) character\n");
1360   fprintf(output, "  -b separate infos with SPACE character\n");
1361   fprintf(output, "\n");
1362   fprintf(output, "  -N do not quote infos (default)\n");
1363   fprintf(output, "  -q quote infos with single quotes (')\n");
1364   fprintf(output, "  -Q quote infos with double quotes (\")\n");
1365   fprintf(output, "\n");
1366   fprintf(output, "Miscellaneous:\n");
1367   fprintf(output, "  -h display this help and exit\n");
1368   fprintf(output, "  -C cancel processing if file open fails (default is to continue)\n");
1369   fprintf(output, "  -A generate all infos (default)\n");
1370   fprintf(output, "  -K disable displaying the capture comment\n");
1371   fprintf(output, "\n");
1372   fprintf(output, "Options are processed from left to right order with later options superceding\n");
1373   fprintf(output, "or adding to earlier options.\n");
1374   fprintf(output, "\n");
1375   fprintf(output, "If no options are given the default is to display all infos in long report\n");
1376   fprintf(output, "output format.\n");
1377 }
1378
1379 #ifdef HAVE_PLUGINS
1380 /*
1381  * General errors are reported with an console message in capinfos.
1382  */
1383 static void
1384 failure_message(const char *msg_format, va_list ap)
1385 {
1386   fprintf(stderr, "capinfos: ");
1387   vfprintf(stderr, msg_format, ap);
1388   fprintf(stderr, "\n");
1389 }
1390 #endif
1391
1392 static void
1393 hash_to_str(const unsigned char *hash, size_t length, char *str) {
1394   int i;
1395
1396   for (i = 0; i < (int) length; i++) {
1397     g_snprintf(str+(i*2), 3, "%02x", hash[i]);
1398   }
1399 }
1400
1401 int
1402 main(int argc, char *argv[])
1403 {
1404   GString *comp_info_str;
1405   GString *runtime_info_str;
1406   char  *init_progfile_dir_error;
1407   wtap  *wth;
1408   int    err;
1409   gchar *err_info;
1410   int    opt;
1411   int    overall_error_status = EXIT_SUCCESS;
1412   static const struct option long_options[] = {
1413       {"help", no_argument, NULL, 'h'},
1414       {"version", no_argument, NULL, 'v'},
1415       {0, 0, 0, 0 }
1416   };
1417
1418   int status = 0;
1419   FILE  *fh;
1420   char  *hash_buf = NULL;
1421   gcry_md_hd_t hd = NULL;
1422   size_t hash_bytes;
1423
1424   /* Set the C-language locale to the native environment. */
1425   setlocale(LC_ALL, "");
1426
1427   /* Get the decimal point. */
1428   decimal_point = g_strdup(localeconv()->decimal_point);
1429
1430   /* Get the compile-time version information string */
1431   comp_info_str = get_compiled_version_info(NULL, NULL);
1432
1433   /* Get the run-time version information string */
1434   runtime_info_str = get_runtime_version_info(NULL);
1435
1436   /* Add it to the information to be reported on a crash. */
1437   ws_add_crash_info("Capinfos (Wireshark) %s\n"
1438          "\n"
1439          "%s"
1440          "\n"
1441          "%s",
1442       get_ws_vcs_version_info(), comp_info_str->str, runtime_info_str->str);
1443   g_string_free(comp_info_str, TRUE);
1444   g_string_free(runtime_info_str, TRUE);
1445
1446 #ifdef _WIN32
1447   arg_list_utf_16to8(argc, argv);
1448   create_app_running_mutex();
1449 #endif /* _WIN32 */
1450
1451   /*
1452    * Get credential information for later use.
1453    */
1454   init_process_policies();
1455
1456   /*
1457    * Attempt to get the pathname of the directory containing the
1458    * executable file.
1459    */
1460   init_progfile_dir_error = init_progfile_dir(argv[0], main);
1461   if (init_progfile_dir_error != NULL) {
1462     fprintf(stderr,
1463             "capinfos: Can't get pathname of directory containing the capinfos program: %s.\n",
1464             init_progfile_dir_error);
1465     g_free(init_progfile_dir_error);
1466   }
1467
1468   wtap_init();
1469
1470 #ifdef HAVE_PLUGINS
1471   init_report_err(failure_message, NULL, NULL, NULL);
1472
1473   /* Scan for plugins.  This does *not* call their registration routines;
1474      that's done later.
1475
1476      Don't report failures to load plugins because most (non-wiretap)
1477      plugins *should* fail to load (because we're not linked against
1478      libwireshark and dissector plugins need libwireshark). */
1479   scan_plugins(DONT_REPORT_LOAD_FAILURE);
1480
1481   /* Register all libwiretap plugin modules. */
1482   register_all_wiretap_modules();
1483 #endif
1484
1485   /* Process the options */
1486   while ((opt = getopt_long(argc, argv, "abcdehiklmoqrstuvxyzABCEFHIKLMNQRST", long_options, NULL)) !=-1) {
1487
1488     switch (opt) {
1489
1490       case 't':
1491         if (report_all_infos) disable_all_infos();
1492         cap_file_type = TRUE;
1493         break;
1494
1495       case 'E':
1496         if (report_all_infos) disable_all_infos();
1497         cap_file_encap = TRUE;
1498         break;
1499
1500       case 'l':
1501         if (report_all_infos) disable_all_infos();
1502         cap_snaplen = TRUE;
1503         break;
1504
1505       case 'c':
1506         if (report_all_infos) disable_all_infos();
1507         cap_packet_count = TRUE;
1508         break;
1509
1510       case 's':
1511         if (report_all_infos) disable_all_infos();
1512         cap_file_size = TRUE;
1513         break;
1514
1515       case 'd':
1516         if (report_all_infos) disable_all_infos();
1517         cap_data_size = TRUE;
1518         break;
1519
1520       case 'u':
1521         if (report_all_infos) disable_all_infos();
1522         cap_duration = TRUE;
1523         break;
1524
1525       case 'a':
1526         if (report_all_infos) disable_all_infos();
1527         cap_start_time = TRUE;
1528         break;
1529
1530       case 'e':
1531         if (report_all_infos) disable_all_infos();
1532         cap_end_time = TRUE;
1533         break;
1534
1535       case 'S':
1536         time_as_secs = TRUE;
1537         break;
1538
1539       case 'y':
1540         if (report_all_infos) disable_all_infos();
1541         cap_data_rate_byte = TRUE;
1542         break;
1543
1544       case 'i':
1545         if (report_all_infos) disable_all_infos();
1546         cap_data_rate_bit = TRUE;
1547         break;
1548
1549       case 'z':
1550         if (report_all_infos) disable_all_infos();
1551         cap_packet_size = TRUE;
1552         break;
1553
1554       case 'x':
1555         if (report_all_infos) disable_all_infos();
1556         cap_packet_rate = TRUE;
1557         break;
1558
1559       case 'H':
1560         if (report_all_infos) disable_all_infos();
1561         cap_file_hashes = TRUE;
1562         break;
1563
1564       case 'o':
1565         if (report_all_infos) disable_all_infos();
1566         cap_order = TRUE;
1567         break;
1568
1569       case 'k':
1570         if (report_all_infos) disable_all_infos();
1571         cap_comment = TRUE;
1572         break;
1573
1574       case 'K':
1575         cap_comment = FALSE;
1576         break;
1577
1578       case 'F':
1579         if (report_all_infos) disable_all_infos();
1580         cap_file_more_info = TRUE;
1581         break;
1582
1583       case 'I':
1584         if (report_all_infos) disable_all_infos();
1585         cap_file_idb = TRUE;
1586         break;
1587
1588       case 'C':
1589         continue_after_wtap_open_offline_failure = FALSE;
1590         break;
1591
1592       case 'A':
1593         enable_all_infos();
1594         break;
1595
1596       case 'L':
1597         long_report = TRUE;
1598         break;
1599
1600       case 'T':
1601         long_report = FALSE;
1602         break;
1603
1604       case 'M':
1605         machine_readable = TRUE;
1606         break;
1607
1608       case 'R':
1609         table_report_header = TRUE;
1610         break;
1611
1612       case 'r':
1613         table_report_header = FALSE;
1614         break;
1615
1616       case 'N':
1617         quote_char = '\0';
1618         break;
1619
1620       case 'q':
1621         quote_char = '\'';
1622         break;
1623
1624       case 'Q':
1625         quote_char = '"';
1626         break;
1627
1628       case 'B':
1629         field_separator = '\t';
1630         break;
1631
1632       case 'm':
1633         field_separator = ',';
1634         break;
1635
1636       case 'b':
1637         field_separator = ' ';
1638         break;
1639
1640       case 'h':
1641         printf("Capinfos (Wireshark) %s\n"
1642                "Print various information (infos) about capture files.\n"
1643                "See https://www.wireshark.org for more information.\n",
1644                get_ws_vcs_version_info());
1645         print_usage(stdout);
1646         goto exit;
1647         break;
1648
1649       case 'v':
1650         comp_info_str = get_compiled_version_info(NULL, NULL);
1651         runtime_info_str = get_runtime_version_info(NULL);
1652         show_version("Capinfos (Wireshark)", comp_info_str, runtime_info_str);
1653         g_string_free(comp_info_str, TRUE);
1654         g_string_free(runtime_info_str, TRUE);
1655         goto exit;
1656         break;
1657
1658       case '?':              /* Bad flag - print usage message */
1659         print_usage(stderr);
1660         overall_error_status = BAD_FLAG;
1661         goto exit;
1662         break;
1663     }
1664   }
1665
1666   if ((argc - optind) < 1) {
1667     print_usage(stderr);
1668     overall_error_status = INVALID_OPTION;
1669     goto exit;
1670   }
1671
1672   if (!long_report && table_report_header) {
1673     print_stats_table_header();
1674   }
1675
1676   if (cap_file_hashes) {
1677     gcry_check_version(NULL);
1678     gcry_md_open(&hd, GCRY_MD_SHA1, 0);
1679     if (hd) {
1680       gcry_md_enable(hd, GCRY_MD_RMD160);
1681       gcry_md_enable(hd, GCRY_MD_MD5);
1682     }
1683     hash_buf = (char *)g_malloc(HASH_BUF_SIZE);
1684   }
1685
1686   overall_error_status = 0;
1687
1688   for (opt = optind; opt < argc; opt++) {
1689
1690     g_strlcpy(file_sha1, "<unknown>", HASH_STR_SIZE);
1691     g_strlcpy(file_rmd160, "<unknown>", HASH_STR_SIZE);
1692     g_strlcpy(file_md5, "<unknown>", HASH_STR_SIZE);
1693
1694     if (cap_file_hashes) {
1695       fh = ws_fopen(argv[opt], "rb");
1696       if (fh && hd) {
1697         while((hash_bytes = fread(hash_buf, 1, HASH_BUF_SIZE, fh)) > 0) {
1698           gcry_md_write(hd, hash_buf, hash_bytes);
1699         }
1700         gcry_md_final(hd);
1701         hash_to_str(gcry_md_read(hd, GCRY_MD_SHA1), HASH_SIZE_SHA1, file_sha1);
1702         hash_to_str(gcry_md_read(hd, GCRY_MD_RMD160), HASH_SIZE_RMD160, file_rmd160);
1703         hash_to_str(gcry_md_read(hd, GCRY_MD_MD5), HASH_SIZE_MD5, file_md5);
1704       }
1705       if (fh) fclose(fh);
1706       if (hd) gcry_md_reset(hd);
1707     }
1708
1709     wth = wtap_open_offline(argv[opt], WTAP_TYPE_AUTO, &err, &err_info, FALSE);
1710
1711     if (!wth) {
1712       fprintf(stderr, "capinfos: Can't open %s: %s\n", argv[opt],
1713           wtap_strerror(err));
1714       if (err_info != NULL) {
1715         fprintf(stderr, "(%s)\n", err_info);
1716         g_free(err_info);
1717       }
1718       overall_error_status = 2; /* remember that an error has occurred */
1719       if (!continue_after_wtap_open_offline_failure)
1720         goto exit;
1721     }
1722
1723     if (wth) {
1724       if ((opt > optind) && (long_report))
1725         printf("\n");
1726       status = process_cap_file(wth, argv[opt]);
1727
1728       wtap_close(wth);
1729       if (status) {
1730         overall_error_status = status;
1731         goto exit;
1732       }
1733     }
1734   }
1735
1736 exit:
1737   g_free(hash_buf);
1738   wtap_cleanup();
1739   free_progdirs();
1740 #ifdef HAVE_PLUGINS
1741   plugins_cleanup();
1742 #endif
1743   return overall_error_status;
1744 }
1745
1746 /*
1747  * Editor modelines  -  http://www.wireshark.org/tools/modelines.html
1748  *
1749  * Local variables:
1750  * c-basic-offset: 2
1751  * tab-width: 8
1752  * indent-tabs-mode: nil
1753  * End:
1754  *
1755  * vi: set shiftwidth=2 tabstop=8 expandtab:
1756  * :indentSize=2:tabSize=8:noTabs=true:
1757  */