Clean up handling of enabled/disabled protocols/heuristic dissectors.
[metze/wireshark/wip.git] / mergecap.c
1 /* Combine dump files, either by appending or by merging by timestamp
2  *
3  * Wireshark - Network traffic analyzer
4  * By Gerald Combs <gerald@wireshark.org>
5  * Copyright 1998 Gerald Combs
6  *
7  * This program is free software; you can redistribute it and/or modify
8  * it under the terms of the GNU General Public License as published by
9  * the Free Software Foundation; either version 2 of the License, or
10  * (at your option) any later version.
11  *
12  * This program is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15  * GNU General Public License for more details.
16  *
17  * You should have received a copy of the GNU General Public License along
18  * with this program; if not, write to the Free Software Foundation, Inc.,
19  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
20  *
21  * Mergecap written by Scott Renfro <scott@renfro.org> based on
22  * editcap by Richard Sharpe and Guy Harris
23  *
24  */
25
26 #include <config.h>
27
28 #include <stdio.h>
29 #include <stdlib.h>
30 #include <errno.h>
31 #include <glib.h>
32
33 #ifdef HAVE_GETOPT_H
34 #include <getopt.h>
35 #endif
36
37 #include <string.h>
38
39 #include <wiretap/wtap.h>
40
41 #ifndef HAVE_GETOPT_LONG
42 #include <wsutil/wsgetopt.h>
43 #endif
44
45 #include <wsutil/clopts_common.h>
46 #include <wsutil/cmdarg_err.h>
47 #include <wsutil/crash_info.h>
48 #include <wsutil/filesystem.h>
49 #include <wsutil/file_util.h>
50 #include <wsutil/privileges.h>
51 #include <wsutil/strnatcmp.h>
52 #include <ws_version_info.h>
53
54 #ifdef HAVE_PLUGINS
55 #include <wsutil/plugins.h>
56 #endif
57
58 #include <wsutil/report_message.h>
59
60 #include <wiretap/merge.h>
61
62 #ifdef _WIN32
63 #include <wsutil/unicode-utils.h>
64 #endif /* _WIN32 */
65
66 /*
67  * Show the usage
68  */
69 static void
70 print_usage(FILE *output)
71 {
72   fprintf(output, "\n");
73   fprintf(output, "Usage: mergecap [options] -w <outfile>|- <infile> [<infile> ...]\n");
74   fprintf(output, "\n");
75   fprintf(output, "Output:\n");
76   fprintf(output, "  -a                concatenate rather than merge files.\n");
77   fprintf(output, "                    default is to merge based on frame timestamps.\n");
78   fprintf(output, "  -s <snaplen>      truncate packets to <snaplen> bytes of data.\n");
79   fprintf(output, "  -w <outfile>|-    set the output filename to <outfile> or '-' for stdout.\n");
80   fprintf(output, "  -F <capture type> set the output file type; default is pcapng.\n");
81   fprintf(output, "                    an empty \"-F\" option will list the file types.\n");
82   fprintf(output, "  -I <IDB merge mode> set the merge mode for Interface Description Blocks; default is 'all'.\n");
83   fprintf(output, "                    an empty \"-I\" option will list the merge modes.\n");
84   fprintf(output, "\n");
85   fprintf(output, "Miscellaneous:\n");
86   fprintf(output, "  -h                display this help and exit.\n");
87   fprintf(output, "  -v                verbose output.\n");
88 }
89
90 /*
91  * Report an error in command-line arguments.
92  */
93 static void
94 mergecap_cmdarg_err(const char *fmt, va_list ap)
95 {
96   fprintf(stderr, "mergecap: ");
97   vfprintf(stderr, fmt, ap);
98   fprintf(stderr, "\n");
99 }
100
101 /*
102  * Report additional information for an error in command-line arguments.
103  */
104 static void
105 mergecap_cmdarg_err_cont(const char *fmt, va_list ap)
106 {
107   vfprintf(stderr, fmt, ap);
108   fprintf(stderr, "\n");
109 }
110
111 struct string_elem {
112   const char *sstr;     /* The short string */
113   const char *lstr;     /* The long string */
114 };
115
116 static gint
117 string_compare(gconstpointer a, gconstpointer b)
118 {
119   return strcmp(((const struct string_elem *)a)->sstr,
120                 ((const struct string_elem *)b)->sstr);
121 }
122
123 static void
124 string_elem_print(gpointer data, gpointer not_used _U_)
125 {
126   fprintf(stderr, "    %s - %s\n", ((struct string_elem *)data)->sstr,
127           ((struct string_elem *)data)->lstr);
128 }
129
130 #ifdef HAVE_PLUGINS
131 /*
132  * General errors and warnings are reported with an console message
133  * in mergecap.
134  */
135 static void
136 failure_warning_message(const char *msg_format, va_list ap)
137 {
138   fprintf(stderr, "mergecap: ");
139   vfprintf(stderr, msg_format, ap);
140   fprintf(stderr, "\n");
141 }
142 #endif
143
144 static void
145 list_capture_types(void) {
146   int i;
147   struct string_elem *captypes;
148   GSList *list = NULL;
149
150   captypes = g_new(struct string_elem,WTAP_NUM_FILE_TYPES_SUBTYPES);
151
152   fprintf(stderr, "mergecap: The available capture file types for the \"-F\" flag are:\n");
153   for (i = 0; i < WTAP_NUM_FILE_TYPES_SUBTYPES; i++) {
154     if (wtap_dump_can_open(i)) {
155       captypes[i].sstr = wtap_file_type_subtype_short_string(i);
156       captypes[i].lstr = wtap_file_type_subtype_string(i);
157       list = g_slist_insert_sorted(list, &captypes[i], string_compare);
158     }
159   }
160   g_slist_foreach(list, string_elem_print, NULL);
161   g_slist_free(list);
162   g_free(captypes);
163 }
164
165 static void
166 list_idb_merge_modes(void) {
167   int i;
168
169   fprintf(stderr, "mergecap: The available IDB merge modes for the \"-I\" flag are:\n");
170   for (i = 0; i < IDB_MERGE_MODE_MAX; i++) {
171     fprintf(stderr, "    %s\n", merge_idb_merge_mode_to_string(i));
172   }
173 }
174
175 static gboolean
176 merge_callback(merge_event event, int num,
177                const merge_in_file_t in_files[], const guint in_file_count,
178                void *data _U_)
179 {
180   guint i;
181
182   switch (event) {
183
184     case MERGE_EVENT_INPUT_FILES_OPENED:
185       for (i = 0; i < in_file_count; i++) {
186         fprintf(stderr, "mergecap: %s is type %s.\n", in_files[i].filename,
187                 wtap_file_type_subtype_string(wtap_file_type_subtype(in_files[i].wth)));
188       }
189       break;
190
191     case MERGE_EVENT_FRAME_TYPE_SELECTED:
192       /* for this event, num = frame_type */
193       if (num == WTAP_ENCAP_PER_PACKET) {
194         /*
195          * Find out why we had to choose WTAP_ENCAP_PER_PACKET.
196          */
197         int first_frame_type, this_frame_type;
198
199         first_frame_type = wtap_file_encap(in_files[0].wth);
200         for (i = 1; i < in_file_count; i++) {
201           this_frame_type = wtap_file_encap(in_files[i].wth);
202           if (first_frame_type != this_frame_type) {
203             fprintf(stderr, "mergecap: multiple frame encapsulation types detected\n");
204             fprintf(stderr, "          defaulting to WTAP_ENCAP_PER_PACKET\n");
205             fprintf(stderr, "          %s had type %s (%s)\n",
206                     in_files[0].filename,
207                     wtap_encap_string(first_frame_type),
208                     wtap_encap_short_string(first_frame_type));
209             fprintf(stderr, "          %s had type %s (%s)\n",
210                     in_files[i].filename,
211                     wtap_encap_string(this_frame_type),
212                     wtap_encap_short_string(this_frame_type));
213             break;
214           }
215         }
216       }
217       fprintf(stderr, "mergecap: selected frame_type %s (%s)\n",
218               wtap_encap_string(num),
219               wtap_encap_short_string(num));
220       break;
221
222     case MERGE_EVENT_READY_TO_MERGE:
223       fprintf(stderr, "mergecap: ready to merge records\n");
224       break;
225
226     case MERGE_EVENT_PACKET_WAS_READ:
227       /* for this event, num = count */
228       fprintf(stderr, "Record: %d\n", num);
229       break;
230
231     case MERGE_EVENT_DONE:
232       fprintf(stderr, "mergecap: merging complete\n");
233       break;
234   }
235
236   /* false = do not stop merging */
237   return FALSE;
238 }
239
240
241 int
242 main(int argc, char *argv[])
243 {
244   GString            *comp_info_str;
245   GString            *runtime_info_str;
246   char               *init_progfile_dir_error;
247   int                 opt;
248   static const struct option long_options[] = {
249       {"help", no_argument, NULL, 'h'},
250       {"version", no_argument, NULL, 'V'},
251       {0, 0, 0, 0 }
252   };
253   gboolean            do_append          = FALSE;
254   gboolean            verbose            = FALSE;
255   int                 in_file_count      = 0;
256   guint32             snaplen            = 0;
257 #ifdef PCAP_NG_DEFAULT
258   int                 file_type          = WTAP_FILE_TYPE_SUBTYPE_PCAPNG; /* default to pcap format */
259 #else
260   int                 file_type          = WTAP_FILE_TYPE_SUBTYPE_PCAP; /* default to pcapng format */
261 #endif
262   int                 err                = 0;
263   gchar              *err_info           = NULL;
264   int                 err_fileno;
265   char               *out_filename       = NULL;
266   merge_result        status             = MERGE_OK;
267   idb_merge_mode      mode               = IDB_MERGE_MODE_MAX;
268   gboolean            use_stdout         = FALSE;
269   merge_progress_callback_t cb;
270
271   cmdarg_err_init(mergecap_cmdarg_err, mergecap_cmdarg_err_cont);
272
273 #ifdef _WIN32
274   arg_list_utf_16to8(argc, argv);
275   create_app_running_mutex();
276 #endif /* _WIN32 */
277
278   /* Get the compile-time version information string */
279   comp_info_str = get_compiled_version_info(NULL, NULL);
280
281   /* Get the run-time version information string */
282   runtime_info_str = get_runtime_version_info(NULL);
283
284   /* Add it to the information to be reported on a crash. */
285   ws_add_crash_info("Mergecap (Wireshark) %s\n"
286        "\n"
287        "%s"
288        "\n"
289        "%s",
290     get_ws_vcs_version_info(), comp_info_str->str, runtime_info_str->str);
291   g_string_free(comp_info_str, TRUE);
292   g_string_free(runtime_info_str, TRUE);
293
294   /*
295    * Get credential information for later use.
296    */
297   init_process_policies();
298
299   /*
300    * Attempt to get the pathname of the directory containing the
301    * executable file.
302    */
303   init_progfile_dir_error = init_progfile_dir(argv[0], main);
304   if (init_progfile_dir_error != NULL) {
305     fprintf(stderr,
306             "mergecap: Can't get pathname of directory containing the mergecap program: %s.\n",
307             init_progfile_dir_error);
308     g_free(init_progfile_dir_error);
309   }
310
311   wtap_init();
312
313 #ifdef HAVE_PLUGINS
314   init_report_message(failure_warning_message, failure_warning_message,
315                       NULL, NULL, NULL);
316
317   /* Scan for plugins.  This does *not* call their registration routines;
318      that's done later.
319
320      Don't report failures to load plugins because most (non-wiretap)
321      plugins *should* fail to load (because we're not linked against
322      libwireshark and dissector plugins need libwireshark).*/
323   scan_plugins(DONT_REPORT_LOAD_FAILURE);
324
325   /* Register all libwiretap plugin modules. */
326   register_all_wiretap_modules();
327 #endif
328
329   /* Process the options first */
330   while ((opt = getopt_long(argc, argv, "aF:hI:s:vVw:", long_options, NULL)) != -1) {
331
332     switch (opt) {
333     case 'a':
334       do_append = !do_append;
335       break;
336
337     case 'F':
338       file_type = wtap_short_string_to_file_type_subtype(optarg);
339       if (file_type < 0) {
340         fprintf(stderr, "mergecap: \"%s\" isn't a valid capture file type\n",
341                 optarg);
342         list_capture_types();
343         status = MERGE_ERR_INVALID_OPTION;
344         goto clean_exit;
345       }
346       break;
347
348     case 'h':
349       printf("Mergecap (Wireshark) %s\n"
350              "Merge two or more capture files into one.\n"
351              "See https://www.wireshark.org for more information.\n",
352              get_ws_vcs_version_info());
353       print_usage(stdout);
354       goto clean_exit;
355       break;
356
357     case 'I':
358       mode = merge_string_to_idb_merge_mode(optarg);
359       if (mode == IDB_MERGE_MODE_MAX) {
360         fprintf(stderr, "mergecap: \"%s\" isn't a valid IDB merge mode\n",
361                 optarg);
362         list_idb_merge_modes();
363         status = MERGE_ERR_INVALID_OPTION;
364         goto clean_exit;
365       }
366       break;
367
368     case 's':
369       snaplen = get_nonzero_guint32(optarg, "snapshot length");
370       break;
371
372     case 'v':
373       verbose = TRUE;
374       break;
375
376     case 'V':
377       comp_info_str = get_compiled_version_info(NULL, NULL);
378       runtime_info_str = get_runtime_version_info(NULL);
379       show_version("Mergecap (Wireshark)", comp_info_str, runtime_info_str);
380       g_string_free(comp_info_str, TRUE);
381       g_string_free(runtime_info_str, TRUE);
382       goto clean_exit;
383       break;
384
385     case 'w':
386       out_filename = optarg;
387       break;
388
389     case '?':              /* Bad options if GNU getopt */
390       switch(optopt) {
391       case'F':
392         list_capture_types();
393         break;
394       case'I':
395         list_idb_merge_modes();
396         break;
397       default:
398         print_usage(stderr);
399       }
400       status = MERGE_ERR_INVALID_OPTION;
401       goto clean_exit;
402       break;
403     }
404   }
405
406   cb.callback_func = merge_callback;
407   cb.data = NULL;
408
409   /* check for proper args; at a minimum, must have an output
410    * filename and one input file
411    */
412   in_file_count = argc - optind;
413   if (!out_filename) {
414     fprintf(stderr, "mergecap: an output filename must be set with -w\n");
415     fprintf(stderr, "          run with -h for help\n");
416     status = MERGE_ERR_INVALID_OPTION;
417     goto clean_exit;
418   }
419   if (in_file_count < 1) {
420     fprintf(stderr, "mergecap: No input files were specified\n");
421     return 1;
422   }
423
424   /* setting IDB merge mode must use PCAPNG output */
425   if (mode != IDB_MERGE_MODE_MAX && file_type != WTAP_FILE_TYPE_SUBTYPE_PCAPNG) {
426     fprintf(stderr, "The IDB merge mode can only be used with PCAPNG output format\n");
427     status = MERGE_ERR_INVALID_OPTION;
428     goto clean_exit;
429   }
430
431   /* if they didn't set IDB merge mode, set it to our default */
432   if (mode == IDB_MERGE_MODE_MAX) {
433     mode = IDB_MERGE_MODE_ALL_SAME;
434   }
435
436   /* open the outfile */
437   if (strcmp(out_filename, "-") == 0) {
438     /* merge the files to the standard output */
439     use_stdout = TRUE;
440     status = merge_files_to_stdout(file_type,
441                                    (const char *const *) &argv[optind],
442                                    in_file_count, do_append, mode, snaplen,
443                                    "mergecap", verbose ? &cb : NULL,
444                                    &err, &err_info, &err_fileno);
445   } else {
446     /* merge the files to the outfile */
447     status = merge_files(out_filename, file_type,
448                          (const char *const *) &argv[optind], in_file_count,
449                          do_append, mode, snaplen, "mergecap", verbose ? &cb : NULL,
450                          &err, &err_info, &err_fileno);
451   }
452
453   switch (status) {
454     case MERGE_OK:
455       break;
456
457     case MERGE_USER_ABORTED:
458       /* we don't catch SIGINT/SIGTERM (yet?), so we couldn't have aborted */
459       g_assert(FALSE);
460       break;
461
462     case MERGE_ERR_CANT_OPEN_INFILE:
463       fprintf(stderr, "mergecap: Can't open %s: %s (%s)\n", argv[optind + err_fileno],
464               wtap_strerror(err), err_info ? err_info : "no more information");
465       break;
466
467     case MERGE_ERR_CANT_OPEN_OUTFILE:
468       if (use_stdout) {
469         fprintf(stderr, "mergecap: Can't set up the standard output: %s\n",
470                     wtap_strerror(err));
471       } else {
472         fprintf(stderr, "mergecap: Can't open or create %s: %s\n", out_filename,
473                     wtap_strerror(err));
474       }
475       break;
476
477     case MERGE_ERR_CANT_READ_INFILE:      /* fall through */
478     case MERGE_ERR_BAD_PHDR_INTERFACE_ID:
479     case MERGE_ERR_CANT_WRITE_OUTFILE:
480     case MERGE_ERR_CANT_CLOSE_OUTFILE:
481     default:
482       fprintf(stderr, "mergecap: %s\n", err_info ? err_info : "unknown error");
483       break;
484   }
485
486   g_free(err_info);
487
488 clean_exit:
489   wtap_cleanup();
490   free_progdirs();
491 #ifdef HAVE_PLUGINS
492   plugins_cleanup();
493 #endif
494   return (status == MERGE_OK) ? 0 : 2;
495 }
496
497 /*
498  * Editor modelines  -  http://www.wireshark.org/tools/modelines.html
499  *
500  * Local variables:
501  * c-basic-offset: 2
502  * tab-width: 8
503  * indent-tabs-mode: nil
504  * End:
505  *
506  * vi: set shiftwidth=2 tabstop=8 expandtab:
507  * :indentSize=2:tabSize=8:noTabs=true:
508  */
509