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