Qt: Add support to verify extcap capture filter
[metze/wireshark/wip.git] / extcap.c
1 /* extcap.c
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
52 #include "ui/iface_toolbar.h"
53
54 #include <wsutil/glib-compat.h>
55 #include <wsutil/file_util.h>
56 #include <wsutil/filesystem.h>
57 #include <wsutil/tempfile.h>
58
59 #include "capture_opts.h"
60
61 #include "extcap.h"
62 #include "extcap_parser.h"
63 #include "extcap_spawn.h"
64
65 #ifdef _WIN32
66 static HANDLE pipe_h = NULL;
67 #endif
68
69 static void extcap_child_watch_cb(GPid pid, gint status, gpointer user_data);
70
71 /* internal container, for all the extcap executables that have been found.
72  * Will be resetted if extcap_clear_interfaces() is being explicitly called
73  * and is being used for printing information about all extcap interfaces found,
74  * as well as storing all sub-interfaces
75  */
76 static GHashTable * _loaded_interfaces = NULL;
77
78 /* Internal container, which maps each ifname to the tool providing it, for faster
79  * lookup.
80  */
81 static GHashTable * _tool_for_ifname = NULL;
82
83 /* internal container, for all the extcap executables that have been found
84  * and that provides a toolbar with controls to be added to a Interface Toolbar
85  */
86 static GHashTable *_toolbars = NULL;
87
88 /* internal container, to map preference names to pointers that hold preference
89  * values. These ensure that preferences can survive extcap if garbage
90  * collection, and does not lead to dangling pointers in the prefs subsystem.
91  */
92 static GHashTable *extcap_prefs_dynamic_vals = NULL;
93
94 typedef struct _extcap_callback_info_t
95 {
96     const gchar * extcap;
97     const gchar * ifname;
98     gchar * output;
99     void * data;
100     gchar ** err_str;
101 } extcap_callback_info_t;
102
103 /* Callback definition for extcap_foreach */
104 typedef gboolean(*extcap_cb_t)(extcap_callback_info_t info_structure);
105
106 static void extcap_load_interface_list(void);
107
108 GHashTable *
109 extcap_loaded_interfaces(void)
110 {
111     if ( !_loaded_interfaces || g_hash_table_size(_loaded_interfaces) == 0 )
112         extcap_load_interface_list();
113
114     return _loaded_interfaces;
115 }
116
117 void
118 extcap_clear_interfaces(void)
119 {
120     if ( _loaded_interfaces )
121         g_hash_table_destroy(_loaded_interfaces);
122     _loaded_interfaces = NULL;
123
124     if ( _tool_for_ifname )
125         g_hash_table_destroy(_tool_for_ifname);
126     _tool_for_ifname = NULL;
127 }
128
129 guint extcap_count(void)
130 {
131     const char *dirname = get_extcap_dir();
132     GDir *dir;
133     guint count;
134
135     count = 0;
136
137     if ((dir = g_dir_open(dirname, 0, NULL)) != NULL)
138     {
139         GString *extcap_path = NULL;
140         const gchar *file;
141
142         extcap_path = g_string_new("");
143         while ((file = g_dir_read_name(dir)) != NULL)
144         {
145             /* full path to extcap binary */
146             g_string_printf(extcap_path, "%s" G_DIR_SEPARATOR_S "%s", dirname, file);
147             /* treat anything executable as an extcap binary */
148             if (g_file_test(extcap_path->str, G_FILE_TEST_IS_REGULAR) &&
149                 g_file_test(extcap_path->str, G_FILE_TEST_IS_EXECUTABLE))
150             {
151                 count++;
152             }
153         }
154
155         g_dir_close(dir);
156         g_string_free(extcap_path, TRUE);
157     }
158     return count;
159 }
160
161 static gboolean
162 extcap_if_exists(const gchar *ifname)
163 {
164     if (!ifname || !_tool_for_ifname)
165     {
166         return FALSE;
167     }
168
169     if (g_hash_table_lookup(_tool_for_ifname, ifname))
170     {
171         return TRUE;
172     }
173
174     return FALSE;
175 }
176
177 static extcap_interface *
178 extcap_find_interface_for_ifname(const gchar *ifname)
179 {
180     extcap_interface * result = NULL;
181
182     if ( !ifname || ! _tool_for_ifname || ! _loaded_interfaces )
183         return result;
184
185     gchar * extcap_util = (gchar *)g_hash_table_lookup(_tool_for_ifname, ifname);
186     if ( ! extcap_util )
187         return result;
188
189     extcap_info * element = (extcap_info *)g_hash_table_lookup(_loaded_interfaces, extcap_util);
190     if ( ! element )
191         return result;
192
193     GList * walker = element->interfaces;
194     while ( walker && walker->data && ! result )
195     {
196         extcap_interface * interface = (extcap_interface *)walker->data;
197         if ( g_strcmp0(interface->call, ifname) == 0 )
198         {
199             result = interface;
200             break;
201         }
202
203         walker = g_list_next ( walker );
204     }
205
206     return result;
207 }
208
209 static void
210 extcap_free_toolbar_value(iface_toolbar_value *value)
211 {
212     if (!value)
213     {
214         return;
215     }
216
217     g_free(value->value);
218     g_free(value->display);
219     g_free(value);
220 }
221
222 static void
223 extcap_free_toolbar_control(iface_toolbar_control *control)
224 {
225     if (!control)
226     {
227         return;
228     }
229
230     g_free(control->display);
231     g_free(control->validation);
232     g_free(control->tooltip);
233     if (control->ctrl_type == INTERFACE_TYPE_STRING) {
234         g_free(control->default_value.string);
235     }
236     g_list_foreach(control->values, (GFunc)extcap_free_toolbar_value, NULL);
237     g_list_free(control->values);
238     g_free(control);
239 }
240
241 static void
242 extcap_free_toolbar(gpointer data)
243 {
244     if (!data)
245     {
246         return;
247     }
248
249     iface_toolbar *toolbar = (iface_toolbar *)data;
250
251     g_free(toolbar->menu_title);
252     g_free(toolbar->help);
253     g_list_free_full(toolbar->ifnames, g_free);
254     g_list_foreach(toolbar->controls, (GFunc)extcap_free_toolbar_control, NULL);
255     g_list_free(toolbar->controls);
256     g_free(toolbar);
257 }
258
259 static gboolean
260 extcap_if_exists_for_extcap(const gchar *ifname, const gchar *extcap)
261 {
262     extcap_interface *entry = extcap_find_interface_for_ifname(ifname);
263
264     if (entry && strcmp(entry->extcap_path, extcap) == 0)
265     {
266         return TRUE;
267     }
268
269     return FALSE;
270 }
271
272 static gchar *
273 extcap_if_executable(const gchar *ifname)
274 {
275     extcap_interface *interface = extcap_find_interface_for_ifname(ifname);
276     return interface != NULL ? interface->extcap_path : NULL;
277 }
278
279 static void
280 extcap_iface_toolbar_add(const gchar *extcap, iface_toolbar *toolbar_entry)
281 {
282     char *toolname;
283
284     if (!extcap || !toolbar_entry)
285     {
286         return;
287     }
288
289     toolname = g_path_get_basename(extcap);
290
291     if (!g_hash_table_lookup(_toolbars, toolname))
292     {
293         g_hash_table_insert(_toolbars, g_strdup(toolname), toolbar_entry);
294     }
295
296     g_free(toolname);
297 }
298
299 /* Note: args does not need to be NULL-terminated. */
300 static gboolean extcap_foreach(gint argc, gchar **args,
301                                       extcap_cb_t cb, extcap_callback_info_t cb_info)
302 {
303     GDir *dir;
304     gboolean keep_going;
305     const char *dirname = get_extcap_dir();
306
307     keep_going = TRUE;
308
309     if ((dir = g_dir_open(dirname, 0, NULL)) != NULL)
310     {
311         GString *extcap_path = NULL;
312         const gchar *file;
313
314         extcap_path = g_string_new("");
315         while (keep_going && (file = g_dir_read_name(dir)) != NULL)
316         {
317             gchar *command_output = NULL;
318
319             /* full path to extcap binary */
320             g_string_printf(extcap_path, "%s" G_DIR_SEPARATOR_S "%s", dirname, file);
321             /* treat anything executable as an extcap binary */
322             if (g_file_test(extcap_path->str, G_FILE_TEST_IS_REGULAR) &&
323                 g_file_test(extcap_path->str, G_FILE_TEST_IS_EXECUTABLE))
324             {
325                 if (extcap_if_exists(cb_info.ifname) && !extcap_if_exists_for_extcap(cb_info.ifname, extcap_path->str))
326                 {
327                     continue;
328                 }
329
330                 if (extcap_spawn_sync((gchar *) dirname, extcap_path->str, argc, args, &command_output))
331                 {
332                     cb_info.output = command_output;
333                     cb_info.extcap = extcap_path->str;
334
335                     keep_going = cb(cb_info);
336                 }
337
338                 g_free(command_output);
339             }
340         }
341
342         g_dir_close(dir);
343         g_string_free(extcap_path, TRUE);
344     }
345
346     return keep_going;
347 }
348
349 static void extcap_free_dlt(gpointer d, gpointer user_data _U_)
350 {
351     if (d == NULL)
352     {
353         return;
354     }
355
356     g_free(((extcap_dlt *)d)->name);
357     g_free(((extcap_dlt *)d)->display);
358     g_free(d);
359 }
360
361 static void extcap_free_dlts(GList *dlts)
362 {
363     g_list_foreach(dlts, extcap_free_dlt, NULL);
364     g_list_free(dlts);
365 }
366
367 static gboolean cb_dlt(extcap_callback_info_t cb_info)
368 {
369     GList *dlts = NULL, *temp = NULL;
370
371     if_capabilities_t *caps;
372     GList *linktype_list = NULL;
373     data_link_info_t *data_link_info;
374     extcap_dlt *dlt_item;
375
376     dlts = extcap_parse_dlts(cb_info.output);
377     temp = dlts;
378
379     g_log(LOG_DOMAIN_CAPTURE, G_LOG_LEVEL_DEBUG, "Extcap pipe %s ", cb_info.extcap);
380
381     /*
382      * Allocate the interface capabilities structure.
383      */
384     caps = (if_capabilities_t *) g_malloc(sizeof * caps);
385     caps->can_set_rfmon = FALSE;
386
387     while (dlts)
388     {
389         dlt_item = (extcap_dlt *)dlts->data;
390         if (dlt_item)
391         {
392             g_log(LOG_DOMAIN_CAPTURE, G_LOG_LEVEL_DEBUG,
393                   "  DLT %d name=\"%s\" display=\"%s\" ", dlt_item->number,
394                   dlt_item->name, dlt_item->display);
395
396             data_link_info = g_new(data_link_info_t, 1);
397             data_link_info->dlt = dlt_item->number;
398             data_link_info->name = g_strdup(dlt_item->name);
399             data_link_info->description = g_strdup(dlt_item->display);
400             linktype_list = g_list_append(linktype_list, data_link_info);
401         }
402
403         dlts = g_list_next(dlts);
404     }
405
406     /* Check to see if we built a list */
407     if (linktype_list != NULL && cb_info.data != NULL)
408     {
409         caps->data_link_types = linktype_list;
410         *(if_capabilities_t **) cb_info.data = caps;
411     }
412     else
413     {
414         if (cb_info.err_str)
415         {
416             g_log(LOG_DOMAIN_CAPTURE, G_LOG_LEVEL_DEBUG, "  returned no DLTs");
417             *(cb_info.err_str) = g_strdup("Extcap returned no DLTs");
418         }
419         g_free(caps);
420     }
421
422     extcap_free_dlts(temp);
423
424     return FALSE;
425 }
426
427 if_capabilities_t *
428 extcap_get_if_dlts(const gchar *ifname, char **err_str)
429 {
430     gchar *argv[3];
431     gint i;
432     if_capabilities_t *caps = NULL;
433
434     if (err_str != NULL)
435     {
436         *err_str = NULL;
437     }
438
439     if (extcap_if_exists(ifname))
440     {
441         argv[0] = g_strdup(EXTCAP_ARGUMENT_LIST_DLTS);
442         argv[1] = g_strdup(EXTCAP_ARGUMENT_INTERFACE);
443         argv[2] = g_strdup(ifname);
444
445         extcap_callback_info_t cb_info;
446         cb_info.data = &caps;
447         cb_info.err_str = err_str;
448         cb_info.ifname = ifname;
449
450         extcap_foreach(3, argv, cb_dlt, cb_info);
451
452         for (i = 0; i < 3; ++i)
453         {
454             g_free(argv[i]);
455         }
456     }
457
458     return caps;
459 }
460
461 static void extcap_free_interface(gpointer i)
462 {
463
464     extcap_interface *interface = (extcap_interface *)i;
465
466     if (i == NULL)
467     {
468         return;
469     }
470
471     g_free(interface->call);
472     g_free(interface->display);
473     g_free(interface->version);
474     g_free(interface->help);
475     g_free(interface->extcap_path);
476     g_free(interface);
477 }
478
479 static void extcap_free_interfaces(GList *interfaces)
480 {
481     if (interfaces == NULL)
482     {
483         return;
484     }
485
486     g_list_foreach(interfaces, (GFunc)extcap_free_interface, NULL);
487     g_list_free(interfaces);
488 }
489
490 static gint
491 if_info_compare(gconstpointer a, gconstpointer b)
492 {
493     gint comp = 0;
494     const if_info_t *if_a = (const if_info_t *)a;
495     const if_info_t *if_b = (const if_info_t *)b;
496
497     if ((comp = g_strcmp0(if_a->name, if_b->name)) == 0)
498     {
499         return g_strcmp0(if_a->friendly_name, if_b->friendly_name);
500     }
501
502     return comp;
503 }
504
505 gchar *
506 extcap_get_help_for_ifname(const char *ifname)
507 {
508     extcap_interface *interface = extcap_find_interface_for_ifname(ifname);
509     return interface != NULL ? interface->help : NULL;
510 }
511
512 GList *
513 append_extcap_interface_list(GList *list, char **err_str _U_)
514 {
515     GList *interface_list = NULL;
516     extcap_interface *data = NULL;
517     GList * ifutilkeys = NULL;
518
519     /* Update the extcap interfaces and get a list of their if_infos */
520     if ( !_loaded_interfaces || g_hash_table_size(_loaded_interfaces) == 0 )
521         extcap_load_interface_list();
522
523     ifutilkeys = g_hash_table_get_keys(_loaded_interfaces);
524     while ( ifutilkeys && ifutilkeys->data )
525     {
526         extcap_info * extinfo =
527                 (extcap_info *) g_hash_table_lookup(_loaded_interfaces, (gchar *)ifutilkeys->data);
528         GList * walker = extinfo->interfaces;
529         while ( walker && walker->data )
530         {
531             interface_list = g_list_append(interface_list, walker->data);
532             walker = g_list_next(walker);
533         }
534
535         ifutilkeys = g_list_next(ifutilkeys);
536     }
537
538     /* Sort that list */
539     interface_list = g_list_sort(interface_list, if_info_compare);
540
541     /* Append the interfaces in that list to the list we're handed. */
542     while (interface_list != NULL)
543     {
544         GList *entry = g_list_first(interface_list);
545         data = (extcap_interface *)entry->data;
546         interface_list = g_list_delete_link(interface_list, entry);
547
548         if_info_t * if_info = g_new0(if_info_t, 1);
549         if_info->name = g_strdup(data->call);
550         if_info->friendly_name = g_strdup(data->display);
551
552         if_info->type = IF_EXTCAP;
553
554         if_info->extcap = g_strdup(data->extcap_path);
555
556         list = g_list_append(list, if_info);
557     }
558
559     return list;
560 }
561
562 static void
563 extcap_register_preferences_callback(gpointer key, gpointer value _U_, gpointer user_data _U_)
564 {
565     GList *arguments;
566
567     arguments = extcap_get_if_configuration((gchar *)key);
568     /* Memory for prefs are external to an interface, they are part of
569      * extcap core, so the parsed arguments can be freed. */
570     extcap_free_if_configuration(arguments, TRUE);
571 }
572
573 void extcap_register_preferences(void)
574 {
575     module_t *dev_module = prefs_find_module("extcap");
576
577     if (!dev_module)
578     {
579         return;
580     }
581
582     if ( !_loaded_interfaces || g_hash_table_size(_loaded_interfaces) == 0 )
583         extcap_load_interface_list();
584
585
586     g_hash_table_foreach(_tool_for_ifname, extcap_register_preferences_callback, NULL);
587 }
588
589 /**
590  * Releases the dynamic preference value pointers. Must not be called before
591  * prefs_cleanup since these pointers could still be in use.
592  */
593 void extcap_cleanup(void)
594 {
595     if (extcap_prefs_dynamic_vals)
596         g_hash_table_destroy(extcap_prefs_dynamic_vals);
597
598     if (_loaded_interfaces)
599         g_hash_table_destroy(_loaded_interfaces);
600
601     if (_tool_for_ifname)
602         g_hash_table_destroy(_tool_for_ifname);
603 }
604
605 void extcap_pref_store(extcap_arg *arg, const char *newval)
606 {
607     if (arg && arg->pref_valptr != NULL)
608     {
609         g_free(*arg->pref_valptr);
610         *arg->pref_valptr = g_strdup(newval);
611     }
612
613 }
614
615 /**
616  * Obtains a pointer which can store a value for the given preference name.
617  * The preference name that can be passed to the prefs API is stored into
618  * 'prefs_name'.
619  *
620  * Extcap interfaces (and their preferences) are dynamic, they can be created
621  * and destroyed at will. Thus their data structures are insufficient to pass to
622  * the preferences APIs which require pointers which are valid until the
623  * preferences are removed (at exit).
624  */
625 static gchar **extcap_prefs_dynamic_valptr(const char *name, char **pref_name)
626 {
627     gchar **valp;
628     if (!extcap_prefs_dynamic_vals)
629     {
630         /* Initialize table only as needed, most preferences are not dynamic */
631         extcap_prefs_dynamic_vals = g_hash_table_new_full(g_str_hash, g_str_equal,
632                                     g_free, g_free);
633     }
634     if (!g_hash_table_lookup_extended(extcap_prefs_dynamic_vals, name,
635                                       (gpointer *)pref_name, (gpointer *)&valp))
636     {
637         /* New dynamic pref, allocate, initialize and store. */
638         valp = g_new0(gchar *, 1);
639         *pref_name = g_strdup(name);
640         g_hash_table_insert(extcap_prefs_dynamic_vals, *pref_name, valp);
641     }
642     return valp;
643 }
644
645 void extcap_free_if_configuration(GList *list, gboolean free_args)
646 {
647     GList *elem, *sl;
648
649     for (elem = g_list_first(list); elem; elem = elem->next)
650     {
651         if (elem->data != NULL)
652         {
653             sl = g_list_first((GList *)elem->data);
654             if (free_args)
655             {
656                 extcap_free_arg_list(sl);
657             }
658             else
659             {
660                 g_list_free(sl);
661             }
662         }
663     }
664     g_list_free(list);
665 }
666
667 struct preference *
668 extcap_pref_for_argument(const gchar *ifname, struct _extcap_arg *arg)
669 {
670     struct preference *pref = NULL;
671
672     GRegex *regex_name = g_regex_new("[-]+", (GRegexCompileFlags) 0, (GRegexMatchFlags) 0, NULL);
673     GRegex *regex_ifname = g_regex_new("(?![a-zA-Z1-9_]).", (GRegexCompileFlags) 0, (GRegexMatchFlags) 0, NULL);
674     if (regex_name && regex_ifname)
675     {
676         if (prefs_find_module("extcap"))
677         {
678             gchar *pref_name = g_regex_replace(regex_name, arg->call, strlen(arg->call), 0, "", (GRegexMatchFlags) 0, NULL);
679             gchar *ifname_underscore = g_regex_replace(regex_ifname, ifname, strlen(ifname), 0, "_", (GRegexMatchFlags) 0, NULL);
680             gchar *ifname_lowercase = g_ascii_strdown(ifname_underscore, -1);
681             gchar *pref_ifname = g_strconcat(ifname_lowercase, ".", pref_name, NULL);
682
683             pref = prefs_find_preference(prefs_find_module("extcap"), pref_ifname);
684
685             g_free(pref_name);
686             g_free(ifname_underscore);
687             g_free(ifname_lowercase);
688             g_free(pref_ifname);
689         }
690     }
691     if (regex_name)
692     {
693         g_regex_unref(regex_name);
694     }
695     if (regex_ifname)
696     {
697         g_regex_unref(regex_ifname);
698     }
699
700     return pref;
701 }
702
703 static gboolean cb_preference(extcap_callback_info_t cb_info)
704 {
705     GList *arguments = NULL;
706     GList **il = (GList **) cb_info.data;
707     module_t *dev_module = NULL;
708
709     arguments = extcap_parse_args(cb_info.output);
710
711     dev_module = prefs_find_module("extcap");
712
713     if (dev_module)
714     {
715         GList *walker = arguments;
716
717         GRegex *regex_name = g_regex_new("[-]+", (GRegexCompileFlags) 0, (GRegexMatchFlags) 0, NULL);
718         GRegex *regex_ifname = g_regex_new("(?![a-zA-Z1-9_]).", (GRegexCompileFlags) 0, (GRegexMatchFlags) 0, NULL);
719         if (regex_name && regex_ifname)
720         {
721             while (walker != NULL)
722             {
723                 extcap_arg *arg = (extcap_arg *)walker->data;
724                 arg->device_name = g_strdup(cb_info.ifname);
725
726                 if (arg->save)
727                 {
728                     struct preference *pref = NULL;
729
730                     gchar *pref_name = g_regex_replace(regex_name, arg->call, strlen(arg->call), 0, "", (GRegexMatchFlags) 0, NULL);
731                     gchar *ifname_underscore = g_regex_replace(regex_ifname, cb_info.ifname, strlen(cb_info.ifname), 0, "_", (GRegexMatchFlags) 0, NULL);
732                     gchar *ifname_lowercase = g_ascii_strdown(ifname_underscore, -1);
733                     gchar *pref_ifname = g_strconcat(ifname_lowercase, ".", pref_name, NULL);
734
735                     if ((pref = prefs_find_preference(dev_module, pref_ifname)) == NULL)
736                     {
737                         char *pref_name_for_prefs;
738                         char *pref_title = wmem_strdup(wmem_epan_scope(), arg->display);
739
740                         arg->pref_valptr = extcap_prefs_dynamic_valptr(pref_ifname, &pref_name_for_prefs);
741                         /* Set an initial value if any (the string will be copied at registration) */
742                         if (arg->default_complex)
743                         {
744                             *arg->pref_valptr = arg->default_complex->_val;
745                         }
746
747                         prefs_register_string_preference(dev_module, pref_name_for_prefs,
748                                                          pref_title, pref_title, (const char **)arg->pref_valptr);
749                     }
750                     else
751                     {
752                         /* Been here before, restore stored value */
753                         if (arg->pref_valptr == NULL)
754                         {
755                             arg->pref_valptr = (gchar**)g_hash_table_lookup(extcap_prefs_dynamic_vals, pref_ifname);
756                         }
757                     }
758
759                     g_free(pref_name);
760                     g_free(ifname_underscore);
761                     g_free(ifname_lowercase);
762                     g_free(pref_ifname);
763                 }
764
765                 walker = g_list_next(walker);
766             }
767         }
768         if (regex_name)
769         {
770             g_regex_unref(regex_name);
771         }
772         if (regex_ifname)
773         {
774             g_regex_unref(regex_ifname);
775         }
776     }
777
778     *il = g_list_append(*il, arguments);
779
780     /* By returning false, extcap_foreach will break on first found */
781     return TRUE;
782 }
783
784 GList *
785 extcap_get_if_configuration(const char *ifname)
786 {
787     gchar *argv[3];
788     GList *ret = NULL;
789     gchar **err_str = NULL;
790     int i;
791
792     if (extcap_if_exists(ifname))
793     {
794         g_log(LOG_DOMAIN_CAPTURE, G_LOG_LEVEL_DEBUG, "Extcap path %s",
795               get_extcap_dir());
796
797         argv[0] = g_strdup(EXTCAP_ARGUMENT_CONFIG);
798         argv[1] = g_strdup(EXTCAP_ARGUMENT_INTERFACE);
799         argv[2] = g_strdup(ifname);
800
801         extcap_callback_info_t cb_info;
802         cb_info.data = &ret;
803         cb_info.err_str = err_str;
804         cb_info.ifname = ifname;
805
806         extcap_foreach(3, argv, cb_preference, cb_info);
807
808         for (i = 0; i < 3; i++)
809         {
810             g_free(argv[i]);
811         }
812     }
813
814     return ret;
815 }
816
817 /**
818  * If is_required is FALSE: returns TRUE if the extcap interface has
819  * configurable options.
820  * If is_required is TRUE: returns TRUE when the extcap interface has
821  * configurable options that required modification. (For example, when an
822  * argument is required but empty.)
823  */
824 gboolean
825 extcap_has_configuration(const char *ifname, gboolean is_required)
826 {
827     GList *arguments = 0;
828     GList *walker = 0, * item = 0;
829
830     gboolean found = FALSE;
831
832     arguments = extcap_get_if_configuration((const char *)(ifname));
833     walker = g_list_first(arguments);
834
835     while (walker != NULL && !found)
836     {
837         item = g_list_first((GList *)(walker->data));
838         while (item != NULL && !found)
839         {
840             if ((extcap_arg *)(item->data) != NULL)
841             {
842                 extcap_arg *arg = (extcap_arg *)(item->data);
843                 /* Should required options be present, or any kind of options */
844                 if (!is_required)
845                 {
846                     found = TRUE;
847                 }
848                 else if (arg->is_required)
849                 {
850                     const gchar *stored = NULL;
851                     const gchar *defval = NULL;
852
853                     if (arg->pref_valptr != NULL)
854                     {
855                         stored = *arg->pref_valptr;
856                     }
857
858                     if (arg->default_complex != NULL && arg->default_complex->_val != NULL)
859                     {
860                         defval = arg->default_complex->_val;
861                     }
862
863                     if (arg->is_required)
864                     {
865                         /* If stored and defval is identical and the argument is required,
866                          * configuration is needed */
867                         if (defval && stored && g_strcmp0(stored, defval) == 0)
868                         {
869                             found = TRUE;
870                         }
871                         else if (!defval && (!stored || !*stored))
872                         {
873                             found = TRUE;
874                         }
875                     }
876
877                     if (arg->arg_type == EXTCAP_ARG_FILESELECT)
878                     {
879                         if (arg->fileexists && !(file_exists(defval) || file_exists(stored)))
880                         {
881                             found = TRUE;
882                         }
883                     }
884                 }
885             }
886
887             item = item->next;
888         }
889         walker = walker->next;
890     }
891     extcap_free_if_configuration(arguments, TRUE);
892
893     return found;
894 }
895
896 static gboolean cb_verify_filter(extcap_callback_info_t cb_info)
897 {
898     extcap_filter_status *status = (extcap_filter_status *)cb_info.data;
899     size_t output_size, i;
900
901     output_size = strlen(cb_info.output);
902     if (output_size == 0) {
903         *status = EXTCAP_FILTER_VALID;
904     } else {
905         *status = EXTCAP_FILTER_INVALID;
906         for (i = 0; i < output_size; i++) {
907             if (cb_info.output[i] == '\n' || cb_info.output[i] == '\r') {
908                 cb_info.output[i] = '\0';
909                 break;
910             }
911         }
912         *cb_info.err_str = g_strdup(cb_info.output);
913     }
914
915     return TRUE;
916 }
917
918 extcap_filter_status
919 extcap_verify_capture_filter(const char *ifname, const char *filter, gchar **err_str)
920 {
921     gchar *argv[4];
922     extcap_filter_status status = EXTCAP_FILTER_UNKNOWN;
923
924     if (extcap_if_exists(ifname))
925     {
926         g_log(LOG_DOMAIN_CAPTURE, G_LOG_LEVEL_DEBUG, "Extcap path %s",
927               get_extcap_dir());
928
929         argv[0] = EXTCAP_ARGUMENT_CAPTURE_FILTER;
930         argv[1] = (gchar*)filter;
931         argv[2] = EXTCAP_ARGUMENT_INTERFACE;
932         argv[3] = (gchar*)ifname;
933
934         extcap_callback_info_t cb_info;
935         cb_info.data = &status;
936         cb_info.err_str = err_str;
937         cb_info.ifname = ifname;
938
939         extcap_foreach(4, argv, cb_verify_filter, cb_info);
940     }
941
942     return status;
943 }
944
945 gboolean
946 extcap_has_toolbar(const char *ifname)
947 {
948     if (!iface_toolbar_use())
949     {
950         return FALSE;
951     }
952
953     GList *toolbar_list = g_hash_table_get_values (_toolbars);
954     for (GList *walker = toolbar_list; walker; walker = walker->next)
955     {
956         iface_toolbar *toolbar = (iface_toolbar *) walker->data;
957         if (g_list_find_custom(toolbar->ifnames, ifname, (GCompareFunc) strcmp))
958         {
959             return TRUE;
960         }
961     }
962
963     return FALSE;
964 }
965
966 /* taken from capchild/capture_sync.c */
967 static gboolean pipe_data_available(int pipe_fd)
968 {
969 #ifdef _WIN32 /* PeekNamedPipe */
970     HANDLE hPipe = (HANDLE) _get_osfhandle(pipe_fd);
971     DWORD bytes_avail;
972
973     if (hPipe == INVALID_HANDLE_VALUE)
974     {
975         return FALSE;
976     }
977
978     if (! PeekNamedPipe(hPipe, NULL, 0, NULL, &bytes_avail, NULL))
979     {
980         return FALSE;
981     }
982
983     if (bytes_avail > 0)
984     {
985         return TRUE;
986     }
987     return FALSE;
988 #else /* select */
989     fd_set rfds;
990     struct timeval timeout;
991
992     FD_ZERO(&rfds);
993     FD_SET(pipe_fd, &rfds);
994     timeout.tv_sec = 0;
995     timeout.tv_usec = 0;
996
997     if (select(pipe_fd + 1, &rfds, NULL, NULL, &timeout) > 0)
998     {
999         return TRUE;
1000     }
1001
1002     return FALSE;
1003 #endif
1004 }
1005
1006 void extcap_if_cleanup(capture_options *capture_opts, gchar **errormsg)
1007 {
1008     interface_options interface_opts;
1009     extcap_userdata *userdata;
1010     guint icnt = 0;
1011     gboolean overwrite_exitcode;
1012     gchar *buffer;
1013 #define STDERR_BUFFER_SIZE 1024
1014
1015     for (icnt = 0; icnt < capture_opts->ifaces->len; icnt++)
1016     {
1017         interface_opts = g_array_index(capture_opts->ifaces, interface_options,
1018                                        icnt);
1019
1020         /* skip native interfaces */
1021         if (interface_opts.if_type != IF_EXTCAP)
1022         {
1023             continue;
1024         }
1025
1026         overwrite_exitcode = FALSE;
1027
1028         g_log(LOG_DOMAIN_CAPTURE, G_LOG_LEVEL_DEBUG,
1029               "Extcap [%s] - Cleaning up fifo: %s; PID: %d", interface_opts.name,
1030               interface_opts.extcap_fifo, interface_opts.extcap_pid);
1031 #ifdef _WIN32
1032         if (pipe_h)
1033         {
1034             g_log(LOG_DOMAIN_CAPTURE, G_LOG_LEVEL_DEBUG,
1035                   "Extcap [%s] - Closing pipe", interface_opts.name);
1036             FlushFileBuffers(pipe_h);
1037             DisconnectNamedPipe(pipe_h);
1038             CloseHandle(pipe_h);
1039         }
1040 #else
1041         if (interface_opts.extcap_fifo != NULL && file_exists(interface_opts.extcap_fifo))
1042         {
1043             /* the fifo will not be freed here, but with the other capture_opts in capture_sync */
1044             ws_unlink(interface_opts.extcap_fifo);
1045             interface_opts.extcap_fifo = NULL;
1046         }
1047         if (interface_opts.extcap_control_in && file_exists(interface_opts.extcap_control_in))
1048         {
1049             ws_unlink(interface_opts.extcap_control_in);
1050             interface_opts.extcap_control_in = NULL;
1051         }
1052         if (interface_opts.extcap_control_out && file_exists(interface_opts.extcap_control_out))
1053         {
1054             ws_unlink(interface_opts.extcap_control_out);
1055             interface_opts.extcap_control_out = NULL;
1056         }
1057 #endif
1058         /* Maybe the client closed and removed fifo, but ws should check if
1059          * pid should be closed */
1060         g_log(LOG_DOMAIN_CAPTURE, G_LOG_LEVEL_DEBUG,
1061               "Extcap [%s] - Closing spawned PID: %d", interface_opts.name,
1062               interface_opts.extcap_pid);
1063
1064         userdata = (extcap_userdata *) interface_opts.extcap_userdata;
1065         if (userdata)
1066         {
1067             if (userdata->extcap_stderr_rd > 0 && pipe_data_available(userdata->extcap_stderr_rd))
1068             {
1069                 buffer = (gchar *)g_malloc0(sizeof(gchar) * STDERR_BUFFER_SIZE + 1);
1070 #ifdef _WIN32
1071                 win32_readfrompipe((HANDLE)_get_osfhandle(userdata->extcap_stderr_rd), STDERR_BUFFER_SIZE, buffer);
1072 #else
1073                 if (read(userdata->extcap_stderr_rd, buffer, sizeof(gchar) * STDERR_BUFFER_SIZE) <= 0)
1074                 {
1075                     buffer[0] = '\0';
1076                 }
1077 #endif
1078                 if (strlen(buffer) > 0)
1079                 {
1080                     userdata->extcap_stderr = g_strdup_printf("%s", buffer);
1081                     userdata->exitcode = 1;
1082                 }
1083                 g_free(buffer);
1084             }
1085
1086 #ifndef _WIN32
1087             /* Final child watch may not have been called */
1088             if (interface_opts.extcap_child_watch != 0)
1089             {
1090                 extcap_child_watch_cb(userdata->pid, 0, capture_opts);
1091                 /* it will have changed in extcap_child_watch_cb */
1092                 interface_opts = g_array_index(capture_opts->ifaces, interface_options,
1093                                                icnt);
1094             }
1095 #endif
1096
1097             if (userdata->extcap_stderr != NULL)
1098             {
1099                 overwrite_exitcode = TRUE;
1100             }
1101
1102             if (overwrite_exitcode || userdata->exitcode != 0)
1103             {
1104                 if (userdata->extcap_stderr != 0)
1105                 {
1106                     if (*errormsg == NULL)
1107                     {
1108                         *errormsg = g_strdup_printf("Error by extcap pipe: %s", userdata->extcap_stderr);
1109                     }
1110                     else
1111                     {
1112                         gchar *temp = g_strconcat(*errormsg, "\nError by extcap pipe: " , userdata->extcap_stderr, NULL);
1113                         g_free(*errormsg);
1114                         *errormsg = temp;
1115                     }
1116                     g_free(userdata->extcap_stderr);
1117                 }
1118
1119                 userdata->extcap_stderr = NULL;
1120                 userdata->exitcode = 0;
1121             }
1122         }
1123
1124         if (interface_opts.extcap_child_watch > 0)
1125         {
1126             g_source_remove(interface_opts.extcap_child_watch);
1127             interface_opts.extcap_child_watch = 0;
1128         }
1129
1130         if (interface_opts.extcap_pid != INVALID_EXTCAP_PID)
1131         {
1132 #ifdef _WIN32
1133             TerminateProcess(interface_opts.extcap_pid, 0);
1134 #endif
1135             g_spawn_close_pid(interface_opts.extcap_pid);
1136             interface_opts.extcap_pid = INVALID_EXTCAP_PID;
1137
1138             g_free(interface_opts.extcap_userdata);
1139             interface_opts.extcap_userdata = NULL;
1140         }
1141
1142         /* Make sure modified interface_opts is saved in capture_opts. */
1143         capture_opts->ifaces = g_array_remove_index(capture_opts->ifaces, icnt);
1144         g_array_insert_val(capture_opts->ifaces, icnt, interface_opts);
1145     }
1146 }
1147
1148 static gboolean
1149 extcap_add_arg_and_remove_cb(gpointer key, gpointer value, gpointer data)
1150 {
1151     GPtrArray *args = (GPtrArray *)data;
1152
1153     if (key != NULL)
1154     {
1155         g_ptr_array_add(args, g_strdup((const gchar *)key));
1156
1157         if (value != NULL)
1158         {
1159             g_ptr_array_add(args, g_strdup((const gchar *)value));
1160         }
1161
1162         return TRUE;
1163     }
1164
1165     return FALSE;
1166 }
1167
1168 void extcap_child_watch_cb(GPid pid, gint status, gpointer user_data)
1169 {
1170     guint i;
1171     interface_options interface_opts;
1172     extcap_userdata *userdata = NULL;
1173     capture_options *capture_opts = (capture_options *)(user_data);
1174
1175     if (capture_opts == NULL || capture_opts->ifaces == NULL || capture_opts->ifaces->len == 0)
1176     {
1177         return;
1178     }
1179
1180     /* Close handle to child process. */
1181     g_spawn_close_pid(pid);
1182
1183     /* Update extcap_pid in interface options structure. */
1184     for (i = 0; i < capture_opts->ifaces->len; i++)
1185     {
1186         interface_opts = g_array_index(capture_opts->ifaces, interface_options, i);
1187         if (interface_opts.extcap_pid == pid)
1188         {
1189             userdata = (extcap_userdata *)interface_opts.extcap_userdata;
1190             if (userdata != NULL)
1191             {
1192                 interface_opts.extcap_pid = INVALID_EXTCAP_PID;
1193                 userdata->exitcode = 0;
1194 #ifndef _WIN32
1195                 if (WIFEXITED(status))
1196                 {
1197                     if (WEXITSTATUS(status) != 0)
1198                     {
1199                         userdata->exitcode = WEXITSTATUS(status);
1200                     }
1201                 }
1202                 else
1203                 {
1204                     userdata->exitcode = G_SPAWN_ERROR_FAILED;
1205                 }
1206 #else
1207                 if (status != 0)
1208                 {
1209                     userdata->exitcode = status;
1210                 }
1211 #endif
1212                 if (status == 0 && userdata->extcap_stderr != NULL)
1213                 {
1214                     userdata->exitcode = 1;
1215                 }
1216             }
1217             g_source_remove(interface_opts.extcap_child_watch);
1218             interface_opts.extcap_child_watch = 0;
1219
1220             capture_opts->ifaces = g_array_remove_index(capture_opts->ifaces, i);
1221             g_array_insert_val(capture_opts->ifaces, i, interface_opts);
1222             break;
1223         }
1224     }
1225 }
1226
1227 static
1228 GPtrArray *extcap_prepare_arguments(interface_options interface_opts)
1229 {
1230     GPtrArray *result = NULL;
1231
1232     if (interface_opts.if_type == IF_EXTCAP)
1233     {
1234         result = g_ptr_array_new();
1235
1236 #define add_arg(X) g_ptr_array_add(result, g_strdup(X))
1237
1238         add_arg(interface_opts.extcap);
1239         add_arg(EXTCAP_ARGUMENT_RUN_CAPTURE);
1240         add_arg(EXTCAP_ARGUMENT_INTERFACE);
1241         add_arg(interface_opts.name);
1242         if (interface_opts.cfilter && strlen(interface_opts.cfilter) > 0)
1243         {
1244             add_arg(EXTCAP_ARGUMENT_CAPTURE_FILTER);
1245             add_arg(interface_opts.cfilter);
1246         }
1247         add_arg(EXTCAP_ARGUMENT_RUN_PIPE);
1248         add_arg(interface_opts.extcap_fifo);
1249         if (interface_opts.extcap_control_in)
1250         {
1251             add_arg(EXTCAP_ARGUMENT_CONTROL_OUT);
1252             add_arg(interface_opts.extcap_control_in);
1253         }
1254         if (interface_opts.extcap_control_out)
1255         {
1256             add_arg(EXTCAP_ARGUMENT_CONTROL_IN);
1257             add_arg(interface_opts.extcap_control_out);
1258         }
1259         if (interface_opts.extcap_args == NULL || g_hash_table_size(interface_opts.extcap_args) == 0)
1260         {
1261             /* User did not perform interface configuration.
1262              *
1263              * Check if there are any boolean flags that are set by default
1264              * and hence their argument should be added.
1265              */
1266             GList *arglist;
1267             GList *elem;
1268
1269             arglist = extcap_get_if_configuration(interface_opts.name);
1270             for (elem = g_list_first(arglist); elem; elem = elem->next)
1271             {
1272                 GList *arg_list;
1273                 extcap_arg *arg_iter;
1274
1275                 if (elem->data == NULL)
1276                 {
1277                     continue;
1278                 }
1279
1280                 arg_list = g_list_first((GList *)elem->data);
1281                 while (arg_list != NULL)
1282                 {
1283                     const gchar *stored = NULL, * defval = NULL;
1284                     /* In case of boolflags only first element in arg_list is relevant. */
1285                     arg_iter = (extcap_arg *)(arg_list->data);
1286                     if (arg_iter->pref_valptr != NULL)
1287                     {
1288                         stored = *arg_iter->pref_valptr;
1289                     }
1290
1291                     if (arg_iter->default_complex != NULL && arg_iter->default_complex->_val != NULL)
1292                     {
1293                         defval = arg_iter->default_complex->_val;
1294                     }
1295
1296                     /* Different data in storage then set for default */
1297                     if (g_strcmp0(stored, defval) != 0)
1298                     {
1299                         if (arg_iter->arg_type == EXTCAP_ARG_BOOLFLAG)
1300                         {
1301                             if (g_strcmp0(stored, "true") == 0)
1302                             {
1303                                 add_arg(arg_iter->call);
1304                             }
1305                         }
1306                         else
1307                         {
1308                             add_arg(arg_iter->call);
1309                             add_arg(stored);
1310                         }
1311                     }
1312                     else if (arg_iter->arg_type == EXTCAP_ARG_BOOLFLAG)
1313                     {
1314                         if (extcap_complex_get_bool(arg_iter->default_complex))
1315                         {
1316                             add_arg(arg_iter->call);
1317                         }
1318                     }
1319
1320                     arg_list = arg_list->next;
1321                 }
1322             }
1323
1324             extcap_free_if_configuration(arglist, TRUE);
1325         }
1326         else
1327         {
1328             g_hash_table_foreach_remove(interface_opts.extcap_args, extcap_add_arg_and_remove_cb, result);
1329         }
1330         add_arg(NULL);
1331 #undef add_arg
1332
1333     }
1334
1335     return result;
1336 }
1337
1338 /* call mkfifo for each extcap,
1339  * returns FALSE if there's an error creating a FIFO */
1340 gboolean
1341 extcap_init_interfaces(capture_options *capture_opts)
1342 {
1343     guint i;
1344     interface_options interface_opts;
1345     extcap_userdata *userdata;
1346
1347     for (i = 0; i < capture_opts->ifaces->len; i++)
1348     {
1349         GPtrArray *args = NULL;
1350         GPid pid = INVALID_EXTCAP_PID;
1351
1352         interface_opts = g_array_index(capture_opts->ifaces, interface_options, i);
1353
1354         /* skip native interfaces */
1355         if (interface_opts.if_type != IF_EXTCAP)
1356         {
1357             continue;
1358         }
1359
1360         /* create control pipes if having toolbar */
1361         if (extcap_has_toolbar(interface_opts.name))
1362         {
1363             extcap_create_pipe(&interface_opts.extcap_control_in);
1364             extcap_create_pipe(&interface_opts.extcap_control_out);
1365         }
1366
1367         /* create pipe for fifo */
1368         if (!extcap_create_pipe(&interface_opts.extcap_fifo))
1369         {
1370             return FALSE;
1371         }
1372
1373         /* Create extcap call */
1374         args = extcap_prepare_arguments(interface_opts);
1375
1376         userdata = g_new0(extcap_userdata, 1);
1377
1378         pid = extcap_spawn_async(userdata, args);
1379
1380         g_ptr_array_foreach(args, (GFunc)g_free, NULL);
1381         g_ptr_array_free(args, TRUE);
1382
1383         if (pid == INVALID_EXTCAP_PID)
1384         {
1385             g_free(userdata);
1386             continue;
1387         }
1388
1389         interface_opts.extcap_pid = pid;
1390
1391         interface_opts.extcap_child_watch =
1392             g_child_watch_add(pid, extcap_child_watch_cb, (gpointer)capture_opts);
1393
1394 #ifdef _WIN32
1395         /* On Windows, wait for extcap to connect to named pipe.
1396          * Some extcaps will present UAC screen to user.
1397          * 30 second timeout should be reasonable timeout for extcap to
1398          * connect to named pipe (including user interaction).
1399          * Wait on multiple object in case of extcap termination
1400          * without opening pipe.
1401          *
1402          * Minimum supported version of Windows: XP / Server 2003.
1403          */
1404         if (pid != INVALID_EXTCAP_PID)
1405         {
1406             extcap_wait_for_pipe(pipe_h, pid);
1407         }
1408
1409 #endif
1410
1411         interface_opts.extcap_userdata = (gpointer) userdata;
1412
1413         capture_opts->ifaces = g_array_remove_index(capture_opts->ifaces, i);
1414         g_array_insert_val(capture_opts->ifaces, i, interface_opts);
1415     }
1416
1417     return TRUE;
1418 }
1419
1420 #ifdef _WIN32
1421 /* called by capture_sync to get the CreatNamedPipe handle*/
1422 HANDLE
1423 extcap_get_win32_handle()
1424 {
1425     return pipe_h;
1426 }
1427 #endif
1428
1429 gboolean extcap_create_pipe(char **fifo)
1430 {
1431 #ifdef _WIN32
1432     gchar timestr[ 14 + 1 ];
1433     time_t current_time;
1434
1435     gchar *pipename = NULL;
1436
1437     SECURITY_ATTRIBUTES security;
1438     /* create pipename */
1439     current_time = time(NULL);
1440     /*
1441      * XXX - we trust Windows not to return a time before the Epoch here,
1442      * so we won't get a null pointer back from localtime().
1443      */
1444     strftime(timestr, sizeof(timestr), "%Y%m%d%H%M%S", localtime(&current_time));
1445     pipename = g_strconcat("\\\\.\\pipe\\", EXTCAP_PIPE_PREFIX, "_", timestr, NULL);
1446
1447     /* Security struct to enable Inheritable HANDLE */
1448     memset(&security, 0, sizeof(SECURITY_ATTRIBUTES));
1449     security.nLength = sizeof(SECURITY_ATTRIBUTES);
1450     security.bInheritHandle = TRUE;
1451     security.lpSecurityDescriptor = NULL;
1452
1453     /* create a namedPipe*/
1454     pipe_h = CreateNamedPipe(
1455                  utf_8to16(pipename),
1456                  PIPE_ACCESS_DUPLEX | FILE_FLAG_OVERLAPPED,
1457                  PIPE_TYPE_MESSAGE | PIPE_READMODE_MESSAGE | PIPE_WAIT,
1458                  5, 65536, 65536,
1459                  300,
1460                  &security);
1461
1462     if (pipe_h == INVALID_HANDLE_VALUE)
1463     {
1464         g_log(LOG_DOMAIN_CAPTURE, G_LOG_LEVEL_DEBUG, "\nError creating pipe => (%d)", GetLastError());
1465         return FALSE;
1466     }
1467     else
1468     {
1469         g_log(LOG_DOMAIN_CAPTURE, G_LOG_LEVEL_DEBUG, "\nWireshark Created pipe =>(%s)", pipename);
1470         *fifo = g_strdup(pipename);
1471     }
1472 #else
1473     gchar *temp_name = NULL;
1474     int fd = 0;
1475
1476     if ((fd = create_tempfile(&temp_name, EXTCAP_PIPE_PREFIX, NULL)) < 0)
1477     {
1478         return FALSE;
1479     }
1480
1481     ws_close(fd);
1482
1483     g_log(LOG_DOMAIN_CAPTURE, G_LOG_LEVEL_DEBUG,
1484           "Extcap - Creating fifo: %s", temp_name);
1485
1486     if (file_exists(temp_name))
1487     {
1488         ws_unlink(temp_name);
1489     }
1490
1491     if (mkfifo(temp_name, 0600) == 0)
1492     {
1493         *fifo = g_strdup(temp_name);
1494     }
1495 #endif
1496
1497     return TRUE;
1498 }
1499
1500 /************* EXTCAP LOAD INTERFACE LIST ***************
1501  *
1502  * The following code handles loading and reloading the interface list. It is explicitly
1503  * kept separate from the rest
1504  */
1505
1506
1507 static void
1508 extcap_free_interface_info(gpointer data)
1509 {
1510     extcap_info *info = (extcap_info *)data;
1511
1512     g_free(info->basename);
1513     g_free(info->full_path);
1514     g_free(info->version);
1515
1516     extcap_free_interfaces(info->interfaces);
1517
1518     g_free(info);
1519 }
1520
1521 static extcap_info *
1522 extcap_ensure_interface(const gchar * toolname, gboolean create_if_nonexist)
1523 {
1524     extcap_info * element = 0;
1525
1526     if ( ! toolname )
1527         return element;
1528
1529     if ( ! _loaded_interfaces )
1530         _loaded_interfaces = g_hash_table_new_full(g_str_hash, g_str_equal, g_free, extcap_free_interface);
1531
1532     element = (extcap_info *) g_hash_table_lookup(_loaded_interfaces, toolname );
1533     if ( ! element && create_if_nonexist )
1534     {
1535         g_hash_table_insert(_loaded_interfaces, g_strdup(toolname), g_new0(extcap_info, 1));
1536         element = (extcap_info *) g_hash_table_lookup(_loaded_interfaces, toolname );
1537     }
1538
1539     return element;
1540 }
1541
1542 extcap_info *
1543 extcap_get_tool_by_ifname(const gchar *ifname)
1544 {
1545     if ( ifname && _tool_for_ifname )
1546     {
1547         gchar * toolname = (gchar *)g_hash_table_lookup(_tool_for_ifname, ifname);
1548         if ( toolname )
1549             return extcap_ensure_interface(toolname, FALSE);
1550     }
1551
1552     return NULL;
1553 }
1554
1555 extcap_info *
1556 extcap_get_tool_info(const gchar * toolname)
1557 {
1558     return extcap_ensure_interface(toolname, FALSE);
1559 }
1560
1561 static void remove_extcap_entry(gpointer entry, gpointer data _U_)
1562 {
1563     extcap_interface *int_iter = (extcap_interface*)entry;
1564
1565     if (int_iter->if_type == EXTCAP_SENTENCE_EXTCAP)
1566         extcap_free_interface(entry);
1567 }
1568
1569 static gboolean cb_load_interfaces(extcap_callback_info_t cb_info)
1570 {
1571     GList * interfaces = NULL, * control_items = NULL, * walker = NULL;
1572     extcap_interface * int_iter = NULL;
1573     extcap_info * element = NULL;
1574     iface_toolbar * toolbar_entry = NULL;
1575     gchar * toolname = g_path_get_basename(cb_info.extcap);
1576
1577     GList * interface_keys = g_hash_table_get_keys(_loaded_interfaces);
1578
1579     /* Load interfaces from utility */
1580     interfaces = extcap_parse_interfaces(cb_info.output, &control_items);
1581
1582     if (control_items)
1583     {
1584         toolbar_entry = g_new0(iface_toolbar, 1);
1585         toolbar_entry->controls = control_items;
1586     }
1587
1588     g_log(LOG_DOMAIN_CAPTURE, G_LOG_LEVEL_DEBUG, "Loading interface list for %s ", cb_info.extcap);
1589
1590     /* Seems, that there where no interfaces to be loaded */
1591     if ( ! interfaces || g_list_length(interfaces) == 0 )
1592     {
1593         g_log(LOG_DOMAIN_CAPTURE, G_LOG_LEVEL_DEBUG, "Cannot load interfaces for %s", cb_info.extcap );
1594         /* Some utilities, androiddump for example, may actually don't present any interfaces, even
1595          * if the utility itself is present. In such a case, we return here, but do not return
1596          * FALSE, or otherwise further loading of other utilities will be stopped */
1597         return TRUE;
1598     }
1599
1600     /* Load or create the storage element for the tool */
1601     element = extcap_ensure_interface(toolname, TRUE);
1602     if ( element == NULL )
1603     {
1604         g_log(LOG_DOMAIN_CAPTURE, G_LOG_LEVEL_ERROR, "Cannot store interface %s, maybe duplicate?", cb_info.extcap );
1605         return FALSE;
1606     }
1607
1608     walker = interfaces;
1609     gchar* help = NULL;
1610     while (walker != NULL)
1611     {
1612         int_iter = (extcap_interface *)walker->data;
1613
1614         g_log(LOG_DOMAIN_CAPTURE, G_LOG_LEVEL_DEBUG, "Interface found %s\n", int_iter->call);
1615
1616         /* Help is not necessarily stored with the interface, but rather with the version string.
1617          * As the version string allways comes in front of the interfaces, this ensures, that it get's
1618          * properly stored with the interface */
1619         if (int_iter->if_type == EXTCAP_SENTENCE_EXTCAP)
1620         {
1621             g_log(LOG_DOMAIN_CAPTURE, G_LOG_LEVEL_DEBUG, "  Extcap [%s] ", int_iter->call);
1622             /* Only initialize values if none are set. Need to check only one element here */
1623             if ( ! element->version )
1624             {
1625                 element->version = g_strdup(int_iter->version);
1626                 element->basename = g_strdup(toolname);
1627                 element->full_path = g_strdup(cb_info.extcap);
1628                 element->help = g_strdup(int_iter->help);
1629             }
1630
1631             help = int_iter->help;
1632             if (toolbar_entry)
1633             {
1634                 toolbar_entry->menu_title = g_strdup(int_iter->display);
1635                 toolbar_entry->help = g_strdup(int_iter->help);
1636             }
1637
1638             walker = g_list_next(walker);
1639             continue;
1640         }
1641
1642         /* Only interface definitions will be parsed here. help is already set by the extcap element,
1643          * which makes it necessary to have version in the list before the interfaces. This is normally
1644          * the case by design, but could be changed by separating the information in extcap-base. */
1645         if ( int_iter->if_type == EXTCAP_SENTENCE_INTERFACE )
1646         {
1647             if ( g_list_find(interface_keys, int_iter->call) )
1648             {
1649                 g_log(LOG_DOMAIN_CAPTURE, G_LOG_LEVEL_WARNING, "Extcap interface \"%s\" is already provided by \"%s\" ",
1650                       int_iter->call, (gchar *)extcap_if_executable(int_iter->call));
1651                 walker = g_list_next(walker);
1652                 continue;
1653             }
1654
1655             g_log(LOG_DOMAIN_CAPTURE, G_LOG_LEVEL_DEBUG, "  Interface [%s] \"%s\" ",
1656                   int_iter->call, int_iter->display);
1657
1658             int_iter->extcap_path = g_strdup(cb_info.extcap);
1659
1660             /* Only set the help, if it exists and no parsed help information is present */
1661             if ( ! int_iter->help && help )
1662                 int_iter->help = g_strdup(help);
1663
1664             element->interfaces = g_list_append(element->interfaces, int_iter);
1665             g_hash_table_insert(_tool_for_ifname, g_strdup(int_iter->call), g_strdup(toolname));
1666
1667             if (toolbar_entry)
1668             {
1669                 if (!toolbar_entry->menu_title)
1670                 {
1671                     toolbar_entry->menu_title = g_strdup(int_iter->display);
1672                 }
1673                 toolbar_entry->ifnames = g_list_append(toolbar_entry->ifnames, g_strdup(int_iter->call));
1674             }
1675         }
1676
1677         walker = g_list_next(walker);
1678     }
1679
1680     if (toolbar_entry && toolbar_entry->menu_title)
1681     {
1682         iface_toolbar_add(toolbar_entry);
1683         extcap_iface_toolbar_add(cb_info.extcap, toolbar_entry);
1684     }
1685
1686     g_list_foreach(interfaces, remove_extcap_entry, NULL);
1687     g_list_free(interfaces);
1688     g_list_free(interface_keys);
1689     g_free(toolname);
1690     return TRUE;
1691 }
1692
1693
1694 /* Handles loading of the interfaces.
1695  *
1696  * A list of interfaces can be obtained by calling \ref extcap_loaded_interfaces
1697  */
1698 static void
1699 extcap_load_interface_list(void)
1700 {
1701     gchar *argv;
1702     gchar *error;
1703
1704     if (_toolbars)
1705     {
1706         // Remove existing interface toolbars here instead of in extcap_clear_interfaces()
1707         // to avoid flicker in shown toolbars when refreshing interfaces.
1708         GList *toolbar_list = g_hash_table_get_values (_toolbars);
1709         for (GList *walker = toolbar_list; walker; walker = walker->next)
1710         {
1711             iface_toolbar *toolbar = (iface_toolbar *) walker->data;
1712             iface_toolbar_remove(toolbar->menu_title);
1713         }
1714         g_hash_table_remove_all(_toolbars);
1715     } else {
1716         _toolbars = g_hash_table_new_full(g_str_hash, g_str_equal, g_free, extcap_free_toolbar);
1717     }
1718
1719     if (_loaded_interfaces == NULL)
1720     {
1721         _loaded_interfaces = g_hash_table_new_full(g_str_hash, g_str_equal, g_free, extcap_free_interface_info);
1722         /* Cleanup lookup table */
1723         if ( _tool_for_ifname )
1724         {
1725             g_hash_table_remove_all(_tool_for_ifname);
1726             _tool_for_ifname = 0;
1727         }
1728         _tool_for_ifname = g_hash_table_new(g_str_hash, g_str_equal);
1729
1730         argv = g_strdup(EXTCAP_ARGUMENT_LIST_INTERFACES);
1731
1732         extcap_callback_info_t cb_info;
1733         cb_info.data = NULL;
1734         cb_info.ifname = NULL;
1735         cb_info.err_str = &error;
1736
1737         extcap_foreach(1, &argv, cb_load_interfaces, cb_info);
1738
1739         g_free(argv);
1740     }
1741 }
1742
1743 /*
1744  * Editor modelines  -  http://www.wireshark.org/tools/modelines.html
1745  *
1746  * Local variables:
1747  * c-basic-offset: 4
1748  * tab-width: 8
1749  * indent-tabs-mode: nil
1750  * End:
1751  *
1752  * vi: set shiftwidth=4 tabstop=8 expandtab:
1753  * :indentSize=4:tabSize=8:noTabs=true:
1754  */