extcap:Replace self-organized lists with glib ones
[metze/wireshark/wip.git] / extcap.c
1 /* extcap.h
2  *
3  * Routines for extcap external capture
4  * Copyright 2013, Mike Ryan <mikeryan@lacklustre.net>
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 #include <config.h>
26
27 #include <stdio.h>
28 #include <stdlib.h>
29 #include <string.h>
30
31 #ifdef _WIN32
32 #include <windows.h>
33 #include <process.h>
34 #include <time.h>
35 #else
36 /* Include for unlink */
37 #include <unistd.h>
38 #endif
39
40 #ifdef HAVE_SYS_TYPES_H
41 #include <sys/types.h>
42 #endif
43 #ifdef HAVE_SYS_WAIT_H
44 #include <sys/wait.h>
45 #endif
46
47 #include <glib.h>
48 #include <log.h>
49
50 #include <epan/prefs.h>
51 #include <epan/prefs-int.h>
52
53 #include <wsutil/file_util.h>
54 #include <wsutil/filesystem.h>
55 #include <wsutil/tempfile.h>
56
57 #include "capture_opts.h"
58
59 #include "extcap.h"
60 #include "extcap_parser.h"
61 #include "extcap_spawn.h"
62
63 #ifdef _WIN32
64 static HANDLE pipe_h = NULL;
65 #endif
66
67 #define EXTCAP_PREF_SIZE 256
68 static void extcap_child_watch_cb(GPid pid, gint status _U_, gpointer user_data);
69
70 /* internal container, for all the extcap interfaces that have been found.
71  * will be resetted by every call to extcap_interface_list() and is being
72  * used in extcap_get_if_* as well as extcap_init_interfaces to ensure,
73  * that only extcap interfaces are being given to underlying extcap programs
74  */
75 static GHashTable *ifaces = NULL;
76
77 /* internal container, for all the extcap executables that have been found.
78  * will be resetted by every call to extcap_interface_list() and is being
79  * used for printing information about all extcap interfaces found
80  */
81 static GHashTable *tools = NULL;
82
83 /* internal container, to map preferences for extcap utilities to dynamic
84  * memory content, which survives extcap if garbage collection, and does
85  * not lead to dangling pointers
86  */
87 static GHashTable *extcap_prefs_dynamic_vals = NULL;
88
89 /* Callback definition for extcap_foreach */
90 typedef gboolean (*extcap_cb_t)(const gchar *extcap, const gchar *ifname, gchar *output, void *data,
91         gchar **err_str);
92
93 static gboolean
94 extcap_if_exists(const gchar *ifname)
95 {
96     if ( !ifname || !ifaces )
97         return FALSE;
98
99     if ( g_hash_table_lookup(ifaces, ifname) )
100         return TRUE;
101
102     return FALSE;
103 }
104
105 static gboolean
106 extcap_if_exists_for_extcap(const gchar *ifname, const gchar *extcap)
107 {
108     gchar *entry = (gchar *)g_hash_table_lookup(ifaces, ifname);
109
110     if ( entry && strcmp(entry, extcap) == 0 )
111         return TRUE;
112
113     return FALSE;
114 }
115
116 static gchar *
117 extcap_if_executable(const gchar *ifname)
118 {
119     return (gchar *)g_hash_table_lookup(ifaces, ifname);
120 }
121
122 static void
123 extcap_if_add(const gchar *ifname, const gchar *extcap)
124 {
125     if ( !g_hash_table_lookup(ifaces, ifname) )
126         g_hash_table_insert(ifaces, g_strdup(ifname), g_strdup(extcap));
127 }
128
129 static void
130 extcap_free_info (gpointer data) {
131     extcap_info * info = (extcap_info *)data;
132
133     g_free (info->basename);
134     g_free (info->full_path);
135     g_free (info->version);
136     g_free (info);
137 }
138
139 static void
140 extcap_tool_add(const gchar *extcap, const extcap_interface *interface)
141 {
142     char *toolname;
143
144     if ( !extcap || !interface )
145         return;
146
147     toolname = g_path_get_basename(extcap);
148
149     if ( !g_hash_table_lookup(tools, toolname) ) {
150         extcap_info * store = (extcap_info *)g_new0(extcap_info, 1);
151         store->version = g_strdup(interface->version);
152         store->full_path = g_strdup(extcap);
153         store->basename = g_strdup(toolname);
154
155         g_hash_table_insert(tools, g_strdup(toolname), store);
156     }
157
158     g_free(toolname);
159 }
160
161 /* Note: args does not need to be NULL-terminated. */
162 static void extcap_foreach(gint argc, gchar **args, extcap_cb_t cb,
163         void *cb_data, char **err_str, const char * ifname _U_) {
164     const char *dirname = get_extcap_dir();
165     GDir *dir;
166     const gchar *file;
167     gboolean keep_going;
168
169     keep_going = TRUE;
170
171     if ((dir = g_dir_open(dirname, 0, NULL)) != NULL) {
172         GString *extcap_path = NULL;
173
174         extcap_path = g_string_new("");
175         while (keep_going && (file = g_dir_read_name(dir)) != NULL ) {
176             gchar *command_output = NULL;
177
178             /* full path to extcap binary */
179 #ifdef _WIN32
180             g_string_printf(extcap_path, "%s\\%s", dirname, file);
181 #else
182             g_string_printf(extcap_path, "%s/%s", dirname, file);
183 #endif
184             if ( extcap_if_exists(ifname) && !extcap_if_exists_for_extcap(ifname, extcap_path->str ) )
185                 continue;
186
187             if ( extcap_spawn_sync ( (gchar *) dirname, extcap_path->str, argc, args, &command_output ) )
188                 keep_going = cb(extcap_path->str, ifname, command_output, cb_data, err_str);
189
190             g_free(command_output);
191         }
192
193         g_dir_close(dir);
194         g_string_free(extcap_path, TRUE);
195     }
196
197 }
198
199 static void extcap_free_dlt(gpointer d, gpointer user_data _U_) {
200     if (d == NULL)
201         return;
202
203     g_free(((extcap_dlt *)d)->name);
204     g_free(((extcap_dlt *)d)->display);
205 }
206
207 static gboolean dlt_cb(const gchar *extcap _U_, const gchar *ifname _U_, gchar *output, void *data,
208         char **err_str) {
209     GList *dlts = NULL, *temp = NULL;
210
211     if_capabilities_t *caps;
212     GList *linktype_list = NULL;
213     data_link_info_t *data_link_info;
214     extcap_dlt * dlt_item;
215
216     dlts = extcap_parse_dlts(output);
217     temp = dlts;
218
219     g_log(LOG_DOMAIN_CAPTURE, G_LOG_LEVEL_DEBUG, "Extcap pipe %s ", extcap);
220
221     /*
222      * Allocate the interface capabilities structure.
223      */
224     caps = (if_capabilities_t *) g_malloc(sizeof *caps);
225     caps->can_set_rfmon = FALSE;
226
227     while (dlts) {
228         dlt_item = (extcap_dlt *)dlts->data;
229         if (dlt_item) {
230             g_log(LOG_DOMAIN_CAPTURE, G_LOG_LEVEL_DEBUG,
231                 "  DLT %d name=\"%s\" display=\"%s\" ", dlt_item->number,
232                 dlt_item->name, dlt_item->display);
233
234             data_link_info = g_new(data_link_info_t, 1);
235             data_link_info->dlt = dlt_item->number;
236             data_link_info->name = g_strdup(dlt_item->name);
237             data_link_info->description = g_strdup(dlt_item->display);
238             linktype_list = g_list_append(linktype_list, data_link_info);
239         }
240
241         dlts = g_list_next(dlts);
242     }
243
244     /* Check to see if we built a list */
245     if (linktype_list != NULL && data != NULL) {
246         caps->data_link_types = linktype_list;
247         *(if_capabilities_t **) data = caps;
248     } else {
249         if (err_str) {
250             g_log(LOG_DOMAIN_CAPTURE, G_LOG_LEVEL_DEBUG, "  returned no DLTs");
251             *err_str = g_strdup("Extcap returned no DLTs");
252         }
253         g_free(caps);
254     }
255
256     g_list_foreach(temp, extcap_free_dlt, NULL);
257
258     return FALSE;
259 }
260
261 if_capabilities_t *
262 extcap_get_if_dlts(const gchar *ifname, char **err_str) {
263     gchar *argv[3];
264     gint i;
265     if_capabilities_t *caps = NULL;
266
267     if (err_str != NULL)
268         *err_str = NULL;
269
270     if ( extcap_if_exists(ifname) )
271     {
272         argv[0] = g_strdup(EXTCAP_ARGUMENT_LIST_DLTS);
273         argv[1] = g_strdup(EXTCAP_ARGUMENT_INTERFACE);
274         argv[2] = g_strdup(ifname);
275
276         extcap_foreach(3, argv, dlt_cb, &caps, err_str, ifname);
277
278         for (i = 0; i < 3; ++i)
279             g_free(argv[i]);
280     }
281
282     return caps;
283 }
284
285 static void extcap_free_interface(gpointer i, gpointer user_data _U_) {
286
287     extcap_interface * interface = (extcap_interface *)i;
288
289     if ( i == NULL )
290         return;
291
292     g_free(interface->call);
293     g_free(interface->display);
294     g_free(interface->version);
295 }
296
297 static gboolean interfaces_cb(const gchar *extcap, const gchar *ifname _U_, gchar *output, void *data,
298         char **err_str _U_) {
299     GList **il = (GList **) data;
300     GList *interfaces = NULL, *walker = NULL;
301     extcap_interface *int_iter = NULL;
302     if_info_t *if_info = NULL;
303
304     interfaces = extcap_parse_interfaces(output);
305
306     g_log(LOG_DOMAIN_CAPTURE, G_LOG_LEVEL_DEBUG, "Extcap pipe %s ", extcap);
307
308     walker = interfaces;
309     while (walker != NULL ) {
310         int_iter = (extcap_interface *)walker->data;
311         if ( int_iter->if_type == EXTCAP_SENTENCE_INTERFACE && extcap_if_exists(int_iter->call) )
312         {
313             g_log(LOG_DOMAIN_CAPTURE, G_LOG_LEVEL_WARNING, "Extcap interface \"%s\" is already provided by \"%s\" ",
314                     int_iter->call, (gchar *)extcap_if_executable(int_iter->call) );
315             walker = g_list_next(walker);
316             continue;
317         }
318
319         if ( int_iter->if_type == EXTCAP_SENTENCE_INTERFACE )
320             g_log(LOG_DOMAIN_CAPTURE, G_LOG_LEVEL_DEBUG, "  Interface [%s] \"%s\" ",
321                     int_iter->call, int_iter->display);
322         else if ( int_iter->if_type == EXTCAP_SENTENCE_EXTCAP )
323             g_log(LOG_DOMAIN_CAPTURE, G_LOG_LEVEL_DEBUG, "  Extcap [%s] ", int_iter->call);
324
325         if ( int_iter->if_type == EXTCAP_SENTENCE_INTERFACE ) {
326             if (il != NULL) {
327                 if_info = g_new0(if_info_t, 1);
328                 if_info->name = g_strdup(int_iter->call);
329                 if_info->friendly_name = g_strdup(int_iter->display);
330
331                 if_info->type = IF_EXTCAP;
332
333                 if_info->extcap = g_strdup(extcap);
334                 *il = g_list_append(*il, if_info);
335             }
336
337             extcap_if_add(int_iter->call, extcap);
338         }
339
340         /* Call for interfaces and tools alike. Multiple calls (because a tool has multiple
341          * interfaces) are handled internally */
342         extcap_tool_add(extcap, int_iter);
343
344         walker = g_list_next(walker);
345     }
346
347     g_list_foreach(interfaces, extcap_free_interface, NULL);
348
349     return TRUE;
350 }
351
352 static gint
353 if_info_compare(gconstpointer a, gconstpointer b)
354 {
355     gint comp = 0;
356     const if_info_t * if_a = (const if_info_t *)a;
357     const if_info_t * if_b = (const if_info_t *)b;
358
359     if ( (comp = g_strcmp0(if_a->name, if_b->name)) == 0 )
360         return g_strcmp0(if_a->friendly_name, if_b->friendly_name);
361
362     return comp;
363 }
364
365 static void
366 extcap_reload_interface_list(GList **retp, char **err_str) {
367     gchar *argv;
368
369     if (err_str != NULL)
370         *err_str = NULL;
371
372     /* ifaces is used as cache, do not destroy its contents when
373      * returning or no extcap interfaces can be queried for options */
374     if (ifaces == NULL)
375         ifaces = g_hash_table_new_full(g_str_hash, g_str_equal, g_free, g_free);
376     else
377         g_hash_table_remove_all(ifaces);
378
379     if (tools == NULL)
380         tools = g_hash_table_new_full(g_str_hash, g_str_equal, g_free, extcap_free_info);
381     else
382         g_hash_table_remove_all(tools);
383
384     argv = g_strdup(EXTCAP_ARGUMENT_LIST_INTERFACES);
385
386     extcap_foreach(1, &argv, interfaces_cb, retp, err_str, NULL);
387
388     g_free(argv);
389 }
390
391 GHashTable *
392 extcap_tools_list(void) {
393     if ( tools == NULL || g_hash_table_size(tools) == 0 )
394         extcap_reload_interface_list(NULL, NULL);
395
396     return tools;
397 }
398
399 GList *
400 append_extcap_interface_list(GList *list, char **err_str) {
401     GList *ret = NULL;
402     GList *entry;
403     void *data;
404
405     /* Update the extcap interfaces and get a list of their if_infos */
406     extcap_reload_interface_list(&ret, err_str);
407
408     /* Sort that list */
409     ret = g_list_sort(ret, if_info_compare);
410
411     /* Append the interfaces in that list to the list we're handed. */
412     while (ret != NULL) {
413         entry = g_list_first(ret);
414         data = entry->data;
415         ret = g_list_delete_link(ret, entry);
416         list = g_list_append(list, data);
417     }
418     return list;
419 }
420
421 static void extcap_free_arg_elem(gpointer data, gpointer user_data _U_) {
422     extcap_free_arg((extcap_arg *) data);
423     g_free(data);
424 }
425
426 void extcap_register_preferences(void)
427 {
428     GList * interfaces = NULL;
429
430     module_t * dev_module = prefs_find_module("extcap");
431
432     if ( !dev_module )
433         return;
434
435     if ( ! ifaces || g_hash_table_size(ifaces) == 0 )
436         extcap_reload_interface_list(NULL, NULL);
437
438     interfaces = g_hash_table_get_keys(ifaces);
439
440     while ( interfaces ) {
441         extcap_get_if_configuration((gchar *)interfaces->data);
442
443         interfaces = g_list_next(interfaces);
444     }
445 }
446
447 void extcap_cleanup(void)
448 {
449     if (extcap_prefs_dynamic_vals) {
450         g_hash_table_destroy(extcap_prefs_dynamic_vals);
451     }
452 }
453
454 void extcap_pref_store(extcap_arg * arg, const char * newval)
455 {
456     if (arg && arg->storeval != NULL)
457     {
458         memset(arg->storeval, 0, EXTCAP_PREF_SIZE * sizeof(char));
459         if ( newval )
460             g_snprintf(arg->storeval, EXTCAP_PREF_SIZE, "%s", newval);
461     }
462
463 }
464
465 static gchar * extcap_prefs_dynamic_valptr(const char *name)
466 {
467     gchar *valp;
468     if (!extcap_prefs_dynamic_vals) {
469         /* Initialize table only as needed, most preferences are not dynamic */
470         extcap_prefs_dynamic_vals = g_hash_table_new_full(g_str_hash, g_str_equal,
471                 g_free, g_free);
472     }
473     valp = (gchar *)g_hash_table_lookup(extcap_prefs_dynamic_vals, name);
474     if (!valp) {
475         /* New dynamic pref, allocate, initialize and store. */
476         valp = g_new0(gchar, EXTCAP_PREF_SIZE);
477         g_hash_table_insert(extcap_prefs_dynamic_vals, g_strdup(name), valp);
478     }
479     return valp;
480 }
481
482 static void extcap_free_if_configuration(GList *list)
483 {
484     GList *elem, *sl;
485
486     for (elem = g_list_first(list); elem; elem = elem->next)
487     {
488         if (elem->data != NULL) {
489             /* g_list_free_full() only exists since 2.28. */
490             sl = g_list_first((GList *)elem->data);
491             g_list_foreach(sl, (GFunc)extcap_free_arg_elem, NULL);
492             g_list_free(sl);
493         }
494     }
495     g_list_free(list);
496 }
497
498 struct preference *
499 extcap_pref_for_argument(const gchar *ifname, struct _extcap_arg * arg) {
500     struct preference * pref = NULL;
501
502     GRegex * regex_name = g_regex_new ("[-]+", (GRegexCompileFlags) 0, (GRegexMatchFlags) 0, NULL );
503     GRegex * regex_ifname = g_regex_new ("(?![a-zA-Z1-9_]).", (GRegexCompileFlags) 0, (GRegexMatchFlags) 0, NULL );
504     if (regex_name && regex_ifname) {
505         if ( prefs_find_module("extcap") ) {
506             gchar * pref_name = g_regex_replace(regex_name, arg->call, strlen(arg->call), 0, "", (GRegexMatchFlags) 0, NULL );
507             gchar * ifname_underscore = g_regex_replace(regex_ifname, ifname, strlen(ifname), 0, "_", (GRegexMatchFlags) 0, NULL );
508             gchar * ifname_lowercase = g_ascii_strdown(ifname_underscore, -1);
509             gchar * pref_ifname = g_strconcat(ifname_lowercase, ".", pref_name, NULL);
510
511             pref = prefs_find_preference(prefs_find_module("extcap"), pref_ifname);
512
513             g_free(pref_name);
514             g_free(ifname_underscore);
515             g_free(ifname_lowercase);
516             g_free(pref_ifname);
517         }
518     }
519     if (regex_name) {
520         g_regex_unref(regex_name);
521     }
522     if (regex_ifname) {
523         g_regex_unref(regex_ifname);
524     }
525
526     return pref;
527 }
528
529 static gboolean search_cb(const gchar *extcap _U_, const gchar *ifname _U_, gchar *output, void *data,
530         char **err_str _U_) {
531     GList *arguments = NULL;
532     GList **il = (GList **) data;
533     module_t * dev_module = NULL;
534
535     arguments = extcap_parse_args(output);
536
537     dev_module = prefs_find_module("extcap");
538
539     if ( dev_module ) {
540         GList * walker = arguments;
541
542         GRegex * regex_name = g_regex_new ("[-]+", (GRegexCompileFlags) 0, (GRegexMatchFlags) 0, NULL );
543         GRegex * regex_ifname = g_regex_new ("(?![a-zA-Z1-9_]).", (GRegexCompileFlags) 0, (GRegexMatchFlags) 0, NULL );
544         if (regex_name && regex_ifname) {
545             while ( walker != NULL ) {
546                 extcap_arg * arg = (extcap_arg *)walker->data;
547                 arg->device_name = g_strdup(ifname);
548
549                 if ( arg->save ) {
550                     struct preference * pref = NULL;
551
552                     gchar * pref_name = g_regex_replace(regex_name, arg->call, strlen(arg->call), 0, "", (GRegexMatchFlags) 0, NULL );
553                     gchar * ifname_underscore = g_regex_replace(regex_ifname, ifname, strlen(ifname), 0, "_", (GRegexMatchFlags) 0, NULL );
554                     gchar * ifname_lowercase = g_ascii_strdown(ifname_underscore, -1);
555                     gchar * pref_ifname = g_strconcat(ifname_lowercase, ".", pref_name, NULL);
556
557                     if ( ( pref = prefs_find_preference(dev_module, pref_ifname) ) == NULL ) {
558                         /* Set an initial value */
559                         if ( ! arg->storeval && arg->default_complex )
560                         {
561                             arg->storeval = extcap_prefs_dynamic_valptr(pref_ifname);
562                             g_snprintf(arg->storeval, EXTCAP_PREF_SIZE, "%s", arg->default_complex->_val);
563                         }
564
565                         prefs_register_string_preference(dev_module, g_strdup(pref_ifname),
566                                 arg->display, arg->display, (const gchar **)&(arg->storeval));
567                     } else {
568                         /* Been here before, restore stored value */
569                         if (! arg->storeval && pref->varp.string)
570                         {
571                             arg->storeval = extcap_prefs_dynamic_valptr(pref_ifname);
572                             g_snprintf(arg->storeval, EXTCAP_PREF_SIZE, "%s", *(pref->varp.string));
573                         }
574                     }
575
576                     g_free(pref_name);
577                     g_free(ifname_underscore);
578                     g_free(ifname_lowercase);
579                     g_free(pref_ifname);
580                 }
581
582                 walker = g_list_next(walker);
583             }
584         }
585         if (regex_name) {
586             g_regex_unref(regex_name);
587         }
588         if (regex_ifname) {
589             g_regex_unref(regex_ifname);
590         }
591     }
592
593     *il = g_list_append(*il, arguments);
594
595     /* By returning false, extcap_foreach will break on first found */
596     return TRUE;
597 }
598
599 GList *
600 extcap_get_if_configuration(const char * ifname) {
601     gchar *argv[3];
602     GList *ret = NULL;
603     gchar **err_str = NULL;
604     int i;
605
606     if ( extcap_if_exists(ifname) )
607     {
608         g_log(LOG_DOMAIN_CAPTURE, G_LOG_LEVEL_DEBUG, "Extcap path %s",
609                 get_extcap_dir());
610
611         argv[0] = g_strdup(EXTCAP_ARGUMENT_CONFIG);
612         argv[1] = g_strdup(EXTCAP_ARGUMENT_INTERFACE);
613         argv[2] = g_strdup(ifname);
614
615         extcap_foreach(3, argv, search_cb, &ret, err_str, ifname);
616
617         for (i = 0; i < 3; i++)
618             g_free(argv[i]);
619     }
620
621     return ret;
622 }
623
624 gboolean
625 extcap_has_configuration(const char * ifname, gboolean is_required) {
626     GList * arguments = 0;
627     GList * walker = 0, * item = 0;
628
629     gboolean found = FALSE;
630
631     arguments = extcap_get_if_configuration((const char *)( ifname ) );
632     walker = g_list_first(arguments);
633
634     while ( walker != NULL && ! found ) {
635         item = g_list_first((GList *)(walker->data));
636         while ( item != NULL && ! found ) {
637             if ( (extcap_arg *)(item->data) != NULL ) {
638                 extcap_arg * arg = (extcap_arg *)(item->data);
639                 /* Should required options be present, or any kind of options */
640                 if ( ! is_required )
641                     found = TRUE;
642                 else if ( arg->is_required ) {
643                     gchar * stored = NULL;
644                     gchar * defval = NULL;
645
646                     if ( arg->storeval != NULL )
647                         stored = arg->storeval;
648
649                     if ( arg->default_complex != NULL && arg->default_complex->_val != NULL )
650                         defval = arg->default_complex->_val;
651
652                     if ( arg->is_required ) {
653                         /* If stored and defval is identical and the argument is required,
654                          * configuration is needed */
655                         if ( defval && stored && g_strcmp0(stored, defval) == 0 )
656                             found = TRUE;
657                         else if ( ! defval && (!stored || strlen(g_strchomp(stored)) <= (size_t)0) )
658                             found = TRUE;
659                     }
660
661                     if ( arg->arg_type == EXTCAP_ARG_FILESELECT ) {
662                         if ( arg->fileexists && ! ( file_exists(defval) || file_exists(stored) ) )
663                             found = TRUE;
664                     }
665                 }
666             }
667
668             item = item->next;
669         }
670         walker = walker->next;
671     }
672     extcap_free_if_configuration(arguments);
673
674     return found;
675 }
676
677 /* taken from capchild/capture_sync.c */
678 static gboolean pipe_data_available(int pipe_fd) {
679 #ifdef _WIN32 /* PeekNamedPipe */
680     HANDLE hPipe = (HANDLE) _get_osfhandle(pipe_fd);
681     DWORD bytes_avail;
682
683     if (hPipe == INVALID_HANDLE_VALUE)
684         return FALSE;
685
686     if (! PeekNamedPipe(hPipe, NULL, 0, NULL, &bytes_avail, NULL))
687         return FALSE;
688
689     if (bytes_avail > 0)
690         return TRUE;
691     return FALSE;
692 #else /* select */
693     fd_set rfds;
694     struct timeval timeout;
695
696     FD_ZERO(&rfds);
697     FD_SET(pipe_fd, &rfds);
698     timeout.tv_sec = 0;
699     timeout.tv_usec = 0;
700
701     if (select(pipe_fd+1, &rfds, NULL, NULL, &timeout) > 0)
702         return TRUE;
703
704     return FALSE;
705 #endif
706 }
707
708 void extcap_if_cleanup(capture_options * capture_opts, gchar ** errormsg) {
709     interface_options interface_opts;
710     extcap_userdata * userdata;
711     guint icnt = 0;
712     gboolean overwrite_exitcode;
713     gchar * buffer;
714 #define STDERR_BUFFER_SIZE 1024
715
716     for (icnt = 0; icnt < capture_opts->ifaces->len; icnt++) {
717         interface_opts = g_array_index(capture_opts->ifaces, interface_options,
718                 icnt);
719
720         /* skip native interfaces */
721         if (interface_opts.if_type != IF_EXTCAP)
722             continue;
723
724         overwrite_exitcode = FALSE;
725
726         g_log(LOG_DOMAIN_CAPTURE, G_LOG_LEVEL_DEBUG,
727                 "Extcap [%s] - Cleaning up fifo: %s; PID: %d", interface_opts.name,
728                 interface_opts.extcap_fifo, interface_opts.extcap_pid);
729 #ifdef _WIN32
730         if (pipe_h)
731         {
732             g_log(LOG_DOMAIN_CAPTURE, G_LOG_LEVEL_DEBUG,
733                 "Extcap [%s] - Closing pipe", interface_opts.name);
734             FlushFileBuffers(pipe_h);
735             DisconnectNamedPipe(pipe_h);
736             CloseHandle(pipe_h);
737         }
738 #else
739         if (interface_opts.extcap_fifo != NULL && file_exists(interface_opts.extcap_fifo))
740         {
741             /* the fifo will not be freed here, but with the other capture_opts in capture_sync */
742             ws_unlink(interface_opts.extcap_fifo);
743             interface_opts.extcap_fifo = NULL;
744         }
745 #endif
746         /* Maybe the client closed and removed fifo, but ws should check if
747          * pid should be closed */
748         g_log(LOG_DOMAIN_CAPTURE, G_LOG_LEVEL_DEBUG,
749                 "Extcap [%s] - Closing spawned PID: %d", interface_opts.name,
750                 interface_opts.extcap_pid);
751
752         userdata = (extcap_userdata *) interface_opts.extcap_userdata;
753         if ( userdata )
754         {
755             if (userdata->extcap_stderr_rd > 0 && pipe_data_available(userdata->extcap_stderr_rd) )
756             {
757                 buffer = (gchar * )g_malloc0(sizeof(gchar) * STDERR_BUFFER_SIZE + 1);
758 #ifdef _WIN32
759                 win32_readfrompipe((HANDLE)_get_osfhandle(userdata->extcap_stderr_rd), STDERR_BUFFER_SIZE, buffer);
760 #else
761                 if (read(userdata->extcap_stderr_rd, buffer, sizeof(gchar) * STDERR_BUFFER_SIZE) <= 0 )
762                     buffer[0] = '\0';
763 #endif
764                 if ( strlen ( buffer) > 0 )
765                 {
766                     userdata->extcap_stderr = g_strdup_printf("%s", buffer);
767                     userdata->exitcode = 1;
768                 }
769                 g_free(buffer);
770             }
771
772 #ifndef _WIN32
773             /* Final child watch may not have been called */
774             if ( interface_opts.extcap_child_watch != 0 )
775             {
776                 extcap_child_watch_cb(userdata->pid, 0, capture_opts);
777                 /* it will have changed in extcap_child_watch_cb */
778                 interface_opts = g_array_index(capture_opts->ifaces, interface_options,
779                                 icnt);
780             }
781 #endif
782
783             if ( userdata->extcap_stderr != NULL )
784                 overwrite_exitcode = TRUE;
785
786             if ( overwrite_exitcode || userdata->exitcode != 0 )
787             {
788                 if ( userdata->extcap_stderr != 0 )
789                 {
790                     if ( *errormsg == NULL )
791                         *errormsg = g_strdup_printf("Error by extcap pipe: %s", userdata->extcap_stderr);
792                     else
793                     {
794                         gchar * temp = g_strconcat ( *errormsg, "\nError by extcap pipe: " ,userdata->extcap_stderr, NULL );
795                         g_free(*errormsg);
796                         *errormsg = temp;
797                     }
798                     g_free (userdata->extcap_stderr );
799                 }
800
801                 userdata->extcap_stderr = NULL;
802                 userdata->exitcode = 0;
803             }
804         }
805
806         if (interface_opts.extcap_child_watch > 0)
807         {
808             g_source_remove(interface_opts.extcap_child_watch);
809             interface_opts.extcap_child_watch = 0;
810         }
811
812         if (interface_opts.extcap_pid != INVALID_EXTCAP_PID)
813         {
814 #ifdef _WIN32
815             TerminateProcess(interface_opts.extcap_pid, 0);
816 #endif
817             g_spawn_close_pid(interface_opts.extcap_pid);
818             interface_opts.extcap_pid = INVALID_EXTCAP_PID;
819
820             g_free(interface_opts.extcap_userdata);
821             interface_opts.extcap_userdata = NULL;
822         }
823
824         /* Make sure modified interface_opts is saved in capture_opts. */
825         capture_opts->ifaces = g_array_remove_index(capture_opts->ifaces, icnt);
826         g_array_insert_val(capture_opts->ifaces, icnt, interface_opts);
827     }
828 }
829
830 static gboolean
831 extcap_add_arg_and_remove_cb(gpointer key, gpointer value, gpointer data) {
832     GPtrArray *args = (GPtrArray *)data;
833
834     if ( key != NULL )
835     {
836         g_ptr_array_add(args, g_strdup((const gchar*)key));
837
838         if ( value != NULL )
839             g_ptr_array_add(args, g_strdup((const gchar*)value));
840
841         return TRUE;
842     }
843
844     return FALSE;
845 }
846
847 void extcap_child_watch_cb(GPid pid, gint status _U_, gpointer user_data)
848 {
849     guint i;
850     interface_options interface_opts;
851     extcap_userdata * userdata = NULL;
852     capture_options * capture_opts = (capture_options *)(user_data);
853
854     if ( capture_opts == NULL || capture_opts->ifaces == NULL || capture_opts->ifaces->len == 0 )
855         return;
856
857     /* Close handle to child process. */
858     g_spawn_close_pid(pid);
859
860     /* Update extcap_pid in interface options structure. */
861     for (i = 0; i < capture_opts->ifaces->len; i++)
862     {
863         interface_opts = g_array_index(capture_opts->ifaces, interface_options, i);
864         if (interface_opts.extcap_pid == pid)
865         {
866             userdata = (extcap_userdata *)interface_opts.extcap_userdata;
867             if ( userdata != NULL )
868             {
869                 interface_opts.extcap_pid = INVALID_EXTCAP_PID;
870                 userdata->exitcode = 0;
871 #ifndef _WIN32
872                 if ( WIFEXITED(status) )
873                 {
874                     if ( WEXITSTATUS(status) != 0 )
875                         userdata->exitcode = WEXITSTATUS(status);
876                 }
877                 else
878                     userdata->exitcode = G_SPAWN_ERROR_FAILED;
879 #else
880                 if (status != 0)
881                     userdata->exitcode = status;
882 #endif
883                 if ( status == 0 && userdata->extcap_stderr != NULL )
884                     userdata->exitcode = 1;
885             }
886             g_source_remove(interface_opts.extcap_child_watch);
887             interface_opts.extcap_child_watch = 0;
888
889             capture_opts->ifaces = g_array_remove_index(capture_opts->ifaces, i);
890             g_array_insert_val(capture_opts->ifaces, i, interface_opts);
891             break;
892         }
893     }
894 }
895
896 static
897 GPtrArray * extcap_prepare_arguments(interface_options interface_opts)
898 {
899     GPtrArray *result = NULL;
900
901     if (interface_opts.if_type == IF_EXTCAP )
902     {
903         result = g_ptr_array_new();
904
905 #define add_arg(X) g_ptr_array_add(result, g_strdup(X))
906
907         add_arg(interface_opts.extcap);
908         add_arg(EXTCAP_ARGUMENT_RUN_CAPTURE);
909         add_arg(EXTCAP_ARGUMENT_INTERFACE);
910         add_arg(interface_opts.name);
911         if (interface_opts.cfilter && strlen(interface_opts.cfilter) > 0) {
912             add_arg(EXTCAP_ARGUMENT_CAPTURE_FILTER);
913             add_arg(interface_opts.cfilter);
914         }
915         add_arg(EXTCAP_ARGUMENT_RUN_PIPE);
916         add_arg(interface_opts.extcap_fifo);
917         if (interface_opts.extcap_args == NULL || g_hash_table_size(interface_opts.extcap_args) == 0)
918         {
919             /* User did not perform interface configuration.
920              *
921              * Check if there are any boolean flags that are set by default
922              * and hence their argument should be added.
923              */
924             GList *arglist;
925             GList *elem;
926
927             arglist = extcap_get_if_configuration(interface_opts.name);
928             for (elem = g_list_first(arglist); elem; elem = elem->next)
929             {
930                 GList * arg_list;
931                 extcap_arg *arg_iter;
932
933                 if (elem->data == NULL)
934                 {
935                     continue;
936                 }
937
938                 arg_list = g_list_first((GList *)elem->data);
939                 while (arg_list != NULL) {
940                     gchar * stored = NULL, * defval = NULL;
941                     /* In case of boolflags only first element in arg_list is relevant. */
942                     arg_iter = (extcap_arg*) (arg_list->data);
943                     if ( arg_iter->storeval != NULL )
944                         stored = arg_iter->storeval;
945
946                     if ( arg_iter->default_complex != NULL && arg_iter->default_complex->_val != NULL )
947                         defval = arg_iter->default_complex->_val;
948
949                     /* Different data in storage then set for default */
950                     if ( g_strcmp0(stored, defval) != 0 ) {
951                         if ( arg_iter->arg_type == EXTCAP_ARG_BOOLFLAG ) {
952                             if ( g_strcmp0(stored, "true") == 0 )
953                                 add_arg(arg_iter->call);
954                         } else {
955                             gchar * call = g_strconcat(arg_iter->call, " ", stored, NULL);
956                             add_arg(call);
957                             g_free(call);
958                         }
959                     } else if  (arg_iter->arg_type == EXTCAP_ARG_BOOLFLAG) {
960                         if (extcap_complex_get_bool(arg_iter->default_complex))
961                             add_arg(arg_iter->call);
962                     }
963
964                     arg_list = arg_list->next;
965                 }
966             }
967
968             extcap_free_if_configuration(arglist);
969         }
970         else
971         {
972             g_hash_table_foreach_remove(interface_opts.extcap_args, extcap_add_arg_and_remove_cb, result);
973         }
974         add_arg(NULL);
975 #undef add_arg
976
977     }
978
979     return result;
980 }
981
982 /* call mkfifo for each extcap,
983  * returns FALSE if there's an error creating a FIFO */
984 gboolean
985 extcap_init_interfaces(capture_options *capture_opts)
986 {
987     guint i;
988     interface_options interface_opts;
989     extcap_userdata * userdata;
990
991     for (i = 0; i < capture_opts->ifaces->len; i++)
992     {
993         GPtrArray *args = NULL;
994         GPid pid = INVALID_EXTCAP_PID;
995
996         interface_opts = g_array_index(capture_opts->ifaces, interface_options, i);
997
998         /* skip native interfaces */
999         if (interface_opts.if_type != IF_EXTCAP )
1000             continue;
1001
1002         /* create pipe for fifo */
1003         if ( ! extcap_create_pipe ( &interface_opts.extcap_fifo ) )
1004             return FALSE;
1005
1006         /* Create extcap call */
1007         args = extcap_prepare_arguments(interface_opts);
1008
1009         userdata = g_new0(extcap_userdata, 1);
1010
1011         pid = extcap_spawn_async(userdata, args );
1012
1013         g_ptr_array_foreach(args, (GFunc)g_free, NULL);
1014         g_ptr_array_free(args, TRUE);
1015
1016         if ( pid == INVALID_EXTCAP_PID )
1017         {
1018             g_free(userdata);
1019             continue;
1020         }
1021
1022         interface_opts.extcap_pid = pid;
1023
1024         interface_opts.extcap_child_watch =
1025             g_child_watch_add(pid, extcap_child_watch_cb, (gpointer)capture_opts);
1026
1027 #ifdef _WIN32
1028         /* On Windows, wait for extcap to connect to named pipe.
1029          * Some extcaps will present UAC screen to user.
1030          * 30 second timeout should be reasonable timeout for extcap to
1031          * connect to named pipe (including user interaction).
1032          * Wait on multiple object in case of extcap termination
1033          * without opening pipe.
1034          *
1035          * Minimum supported version of Windows: XP / Server 2003.
1036          */
1037         if (pid != INVALID_EXTCAP_PID)
1038         {
1039             extcap_wait_for_pipe(pipe_h, pid);
1040         }
1041
1042 #endif
1043
1044         interface_opts.extcap_userdata = (gpointer) userdata;
1045
1046         capture_opts->ifaces = g_array_remove_index(capture_opts->ifaces, i);
1047         g_array_insert_val(capture_opts->ifaces, i, interface_opts);
1048     }
1049
1050     return TRUE;
1051 }
1052
1053 #ifdef _WIN32
1054 /* called by capture_sync to get the CreatNamedPipe handle*/
1055 HANDLE
1056 extcap_get_win32_handle()
1057 {
1058     return pipe_h;
1059 }
1060 #endif
1061
1062 gboolean extcap_create_pipe(char ** fifo)
1063 {
1064 #ifdef _WIN32
1065     gchar timestr[ 14+1 ];
1066     time_t current_time;
1067
1068     gchar *pipename = NULL;
1069
1070     SECURITY_ATTRIBUTES security;
1071     /* create pipename */
1072     current_time = time(NULL);
1073     strftime(timestr, sizeof(timestr), "%Y%m%d%H%M%S", localtime(&current_time));
1074     pipename = g_strconcat ( "\\\\.\\pipe\\", EXTCAP_PIPE_PREFIX, "_", timestr, NULL );
1075
1076     /* Security struct to enable Inheritable HANDLE */
1077     memset(&security, 0, sizeof(SECURITY_ATTRIBUTES));
1078     security.nLength = sizeof(SECURITY_ATTRIBUTES);
1079     security.bInheritHandle = TRUE;
1080     security.lpSecurityDescriptor = NULL;
1081
1082     /* create a namedPipe*/
1083     pipe_h = CreateNamedPipe(
1084                 utf_8to16(pipename),
1085                 PIPE_ACCESS_DUPLEX | FILE_FLAG_OVERLAPPED,
1086                 PIPE_TYPE_MESSAGE| PIPE_READMODE_MESSAGE | PIPE_WAIT,
1087                 5, 65536, 65536,
1088                 300,
1089                 &security);
1090
1091     if (pipe_h == INVALID_HANDLE_VALUE)
1092     {
1093         g_log(LOG_DOMAIN_CAPTURE, G_LOG_LEVEL_DEBUG,"\nError creating pipe => (%d)", GetLastError());
1094         return FALSE;
1095     }
1096     else
1097     {
1098         g_log(LOG_DOMAIN_CAPTURE, G_LOG_LEVEL_DEBUG,"\nWireshark Created pipe =>(%s)",pipename);
1099         *fifo = g_strdup(pipename);
1100     }
1101 #else
1102     gchar *temp_name = NULL;
1103     int fd = 0;
1104
1105     if ((fd = create_tempfile(&temp_name, EXTCAP_PIPE_PREFIX, NULL)) < 0 )
1106         return FALSE;
1107
1108     ws_close(fd);
1109
1110     g_log(LOG_DOMAIN_CAPTURE, G_LOG_LEVEL_DEBUG,
1111             "Extcap - Creating fifo: %s", temp_name);
1112
1113     if ( file_exists(temp_name) )
1114         ws_unlink(temp_name);
1115
1116     if (mkfifo(temp_name, 0600) == 0)
1117         *fifo = g_strdup(temp_name);
1118 #endif
1119
1120     return TRUE;
1121 }
1122
1123 /*
1124  * Editor modelines  -  http://www.wireshark.org/tools/modelines.html
1125  *
1126  * Local variables:
1127  * c-basic-offset: 4
1128  * tab-width: 8
1129  * indent-tabs-mode: nil
1130  * End:
1131  *
1132  * vi: set shiftwidth=4 tabstop=8 expandtab:
1133  * :indentSize=4:tabSize=8:noTabs=true:
1134  */