Qt/ByteViewTab: document potential pitfall
[metze/wireshark/wip.git] / extcap.c
index 061d4535e23320ee475e8dd41946a74fe50417df..1744655685cc53fcab51df8600129685484c7b09 100644 (file)
--- a/extcap.c
+++ b/extcap.c
@@ -25,9 +25,7 @@
 #include <unistd.h>
 #endif
 
-#ifdef HAVE_SYS_TYPES_H
 #include <sys/types.h>
-#endif
 #ifdef HAVE_SYS_WAIT_H
 #include <sys/wait.h>
 #endif
@@ -39,7 +37,6 @@
 
 #include "ui/iface_toolbar.h"
 
-#include <wsutil/glib-compat.h>
 #include <wsutil/file_util.h>
 #include <wsutil/filesystem.h>
 #include <wsutil/ws_pipe.h>
@@ -50,6 +47,8 @@
 #include "extcap.h"
 #include "extcap_parser.h"
 
+#include "version_info.h"
+
 #ifdef _WIN32
 static HANDLE pipe_h = INVALID_HANDLE_VALUE;
 #endif
@@ -224,8 +223,7 @@ extcap_free_toolbar_control(iface_toolbar_control *control)
     if (control->ctrl_type == INTERFACE_TYPE_STRING) {
         g_free(control->default_value.string);
     }
-    g_list_foreach(control->values, (GFunc)extcap_free_toolbar_value, NULL);
-    g_list_free(control->values);
+    g_list_free_full(control->values, (GDestroyNotify)extcap_free_toolbar_value);
     g_free(control);
 }
 
@@ -242,8 +240,7 @@ extcap_free_toolbar(gpointer data)
     g_free(toolbar->menu_title);
     g_free(toolbar->help);
     g_list_free_full(toolbar->ifnames, g_free);
-    g_list_foreach(toolbar->controls, (GFunc)extcap_free_toolbar_control, NULL);
-    g_list_free(toolbar->controls);
+    g_list_free_full(toolbar->controls, (GDestroyNotify)extcap_free_toolbar_control);
     g_free(toolbar);
 }
 
@@ -287,9 +284,39 @@ extcap_iface_toolbar_add(const gchar *extcap, iface_toolbar *toolbar_entry)
     g_free(toolname);
 }
 
+static gchar **
+extcap_convert_arguments_to_array(GList * arguments)
+{
+    gchar ** result = NULL;
+    if ( arguments )
+    {
+        GList * walker = g_list_first(arguments);
+        int cnt = 0;
+
+        result = (gchar **) g_malloc0(sizeof(gchar *) * (g_list_length(arguments)));
+
+        while(walker)
+        {
+            result[cnt] = g_strdup((const gchar *)walker->data);
+            walker = g_list_next(walker);
+            cnt++;
+        }
+    }
+    return result;
+}
+
+static void extcap_free_array(gchar ** args, int argc)
+{
+    int cnt = 0;
+
+    for ( cnt = 0; cnt < argc; cnt++ )
+        g_free(args[cnt]);
+    g_free(args);
+}
+
 /* Note: args does not need to be NULL-terminated. */
 static gboolean extcap_foreach(GList * arguments,
-                                      extcap_cb_t cb, extcap_callback_info_t cb_info)
+                                      extcap_cb_t cb, extcap_callback_info_t cb_info, GList * fallback_arguments)
 {
     GDir *dir;
     gboolean keep_going;
@@ -301,20 +328,13 @@ static gboolean extcap_foreach(GList * arguments,
     {
         GString *extcap_path = NULL;
         const gchar *file;
+        gchar ** args = extcap_convert_arguments_to_array(arguments);
+        int cnt = g_list_length(arguments);
 
         extcap_path = g_string_new("");
         while (keep_going && (file = g_dir_read_name(dir)) != NULL)
         {
             gchar *command_output = NULL;
-            gchar ** args = (gchar **) g_malloc0(sizeof(gchar *) * (g_list_length(arguments)));
-            GList * walker = g_list_first(arguments);
-            int cnt = 0;
-            while(walker)
-            {
-                args[cnt] = g_strdup((const gchar *)walker->data);
-                walker = g_list_next(walker);
-                cnt++;
-            }
 
             /* full path to extcap binary */
             g_string_printf(extcap_path, "%s" G_DIR_SEPARATOR_S "%s", dirname, file);
@@ -334,10 +354,24 @@ static gboolean extcap_foreach(GList * arguments,
 
                     keep_going = cb(cb_info);
                 }
+                else if ( fallback_arguments )
+                {
+                    gchar ** fb_args = extcap_convert_arguments_to_array(fallback_arguments);
+
+                    if (ws_pipe_spawn_sync((gchar *) dirname, extcap_path->str, g_list_length(fallback_arguments), fb_args, &command_output))
+                    {
+                        cb_info.output = command_output;
+                        cb_info.extcap = extcap_path->str;
+
+                        keep_going = cb(cb_info);
+                    }
+                }
 
                 g_free(command_output);
             }
+
         }
+        extcap_free_array(args, cnt);
 
         g_dir_close(dir);
         g_string_free(extcap_path, TRUE);
@@ -438,16 +472,16 @@ extcap_get_if_dlts(const gchar *ifname, char **err_str)
 
     if (extcap_if_exists(ifname))
     {
-        arguments = g_list_append(arguments, g_strdup(EXTCAP_ARGUMENT_LIST_DLTS) );
-        arguments = g_list_append(arguments, g_strdup(EXTCAP_ARGUMENT_INTERFACE) );
-        arguments = g_list_append(arguments, g_strdup(ifname) );
+        arguments = g_list_append(arguments, g_strdup(EXTCAP_ARGUMENT_LIST_DLTS));
+        arguments = g_list_append(arguments, g_strdup(EXTCAP_ARGUMENT_INTERFACE));
+        arguments = g_list_append(arguments, g_strdup(ifname));
 
         extcap_callback_info_t cb_info;
         cb_info.data = &caps;
         cb_info.err_str = err_str;
         cb_info.ifname = ifname;
 
-        extcap_foreach(arguments, cb_dlt, cb_info);
+        extcap_foreach(arguments, cb_dlt, cb_info, NULL);
 
         g_list_free_full(arguments, g_free);
     }
@@ -480,8 +514,7 @@ static void extcap_free_interfaces(GList *interfaces)
         return;
     }
 
-    g_list_foreach(interfaces, (GFunc)extcap_free_interface, NULL);
-    g_list_free(interfaces);
+    g_list_free_full(interfaces, extcap_free_interface);
 }
 
 static gint
@@ -788,16 +821,16 @@ extcap_get_if_configuration(const char *ifname)
         g_log(LOG_DOMAIN_CAPTURE, G_LOG_LEVEL_DEBUG, "Extcap path %s",
               get_extcap_dir());
 
-        arguments = g_list_append(arguments, g_strdup(EXTCAP_ARGUMENT_CONFIG) );
-        arguments = g_list_append(arguments, g_strdup(EXTCAP_ARGUMENT_INTERFACE) );
-        arguments = g_list_append(arguments, g_strdup(ifname) );
+        arguments = g_list_append(arguments, g_strdup(EXTCAP_ARGUMENT_CONFIG));
+        arguments = g_list_append(arguments, g_strdup(EXTCAP_ARGUMENT_INTERFACE));
+        arguments = g_list_append(arguments, g_strdup(ifname));
 
         extcap_callback_info_t cb_info;
         cb_info.data = &ret;
         cb_info.err_str = err_str;
         cb_info.ifname = ifname;
 
-        extcap_foreach(arguments, cb_preference, cb_info);
+        extcap_foreach(arguments, cb_preference, cb_info, NULL);
 
         g_list_free_full(arguments, g_free);
     }
@@ -805,6 +838,69 @@ extcap_get_if_configuration(const char *ifname)
     return ret;
 }
 
+static gboolean cb_reload_preference(extcap_callback_info_t cb_info)
+{
+    GList *arguments = NULL, * walker = NULL;
+    GList **il = (GList **) cb_info.data;
+
+    arguments = extcap_parse_values(cb_info.output);
+
+    walker = g_list_first((GList *)(arguments));
+    while (walker != NULL)
+    {
+        extcap_value * val = (extcap_value *)walker->data;
+        *il = g_list_append(*il, val);
+        walker = g_list_next(walker);
+    }
+    g_list_free(arguments);
+
+    /* By returning false, extcap_foreach will break on first found */
+    return FALSE;
+}
+
+GList *
+extcap_get_if_configuration_values(const char * ifname, const char * argname, GHashTable *arguments)
+{
+    GList * args = NULL;
+    GList *ret = NULL;
+    gchar **err_str = NULL;
+
+    if (extcap_if_exists(ifname))
+    {
+        g_log(LOG_DOMAIN_CAPTURE, G_LOG_LEVEL_DEBUG, "Extcap path %s",
+              get_extcap_dir());
+
+        args = g_list_append(args, g_strdup(EXTCAP_ARGUMENT_CONFIG));
+        args = g_list_append(args, g_strdup(EXTCAP_ARGUMENT_INTERFACE));
+        args = g_list_append(args, g_strdup(ifname));
+        args = g_list_append(args, g_strdup(EXTCAP_ARGUMENT_RELOAD_OPTION));
+        args = g_list_append(args, g_strdup(argname));
+
+        if ( arguments )
+        {
+            GList * keys = g_hash_table_get_keys(arguments);
+            while ( keys )
+            {
+                const gchar * key_data = (const gchar *)keys->data;
+                args = g_list_append(args, g_strdup(key_data));
+                args = g_list_append(args, g_strdup((const gchar *)g_hash_table_lookup(arguments, key_data)));
+                keys = g_list_next(keys);
+            }
+        }
+
+        extcap_callback_info_t cb_info;
+        cb_info.data = &ret;
+        cb_info.err_str = err_str;
+        cb_info.ifname = ifname;
+
+        extcap_foreach(args, cb_reload_preference, cb_info, NULL);
+
+        g_list_free_full(args, g_free);
+    }
+
+    return ret;
+}
+
 /**
  * If is_required is FALSE: returns TRUE if the extcap interface has
  * configurable options.
@@ -917,9 +1013,9 @@ extcap_verify_capture_filter(const char *ifname, const char *filter, gchar **err
         g_log(LOG_DOMAIN_CAPTURE, G_LOG_LEVEL_DEBUG, "Extcap path %s",
               get_extcap_dir());
 
-        arguments = g_list_append(arguments, EXTCAP_ARGUMENT_CAPTURE_FILTER);
+        arguments = g_list_append(arguments, g_strdup(EXTCAP_ARGUMENT_CAPTURE_FILTER));
         arguments = g_list_append(arguments, g_strdup(filter));
-        arguments = g_list_append(arguments, EXTCAP_ARGUMENT_INTERFACE);
+        arguments = g_list_append(arguments, g_strdup(EXTCAP_ARGUMENT_INTERFACE));
         arguments = g_list_append(arguments, g_strdup(ifname));
 
         extcap_callback_info_t cb_info;
@@ -927,7 +1023,7 @@ extcap_verify_capture_filter(const char *ifname, const char *filter, gchar **err
         cb_info.err_str = err_str;
         cb_info.ifname = ifname;
 
-        extcap_foreach(arguments, cb_verify_filter, cb_info);
+        extcap_foreach(arguments, cb_verify_filter, cb_info, NULL);
         g_list_free_full(arguments, g_free);
     }
 
@@ -1282,6 +1378,11 @@ GPtrArray *extcap_prepare_arguments(interface_options *interface_opts)
     return result;
 }
 
+static void ptr_array_free(gpointer data, gpointer user_data _U_)
+{
+    g_free(data);
+}
+
 /* call mkfifo for each extcap,
  * returns FALSE if there's an error creating a FIFO */
 gboolean
@@ -1308,12 +1409,12 @@ extcap_init_interfaces(capture_options *capture_opts)
         if (extcap_has_toolbar(interface_opts->name))
         {
             extcap_create_pipe(interface_opts->name, &interface_opts->extcap_control_in,
-                               EXTCAP_CONTROL_IN_PREFIX, FALSE);
+                               EXTCAP_CONTROL_IN_PREFIX);
 #ifdef _WIN32
             interface_opts->extcap_control_in_h = pipe_h;
 #endif
             extcap_create_pipe(interface_opts->name, &interface_opts->extcap_control_out,
-                               EXTCAP_CONTROL_OUT_PREFIX, FALSE);
+                               EXTCAP_CONTROL_OUT_PREFIX);
 #ifdef _WIN32
             interface_opts->extcap_control_out_h = pipe_h;
 #endif
@@ -1321,7 +1422,7 @@ extcap_init_interfaces(capture_options *capture_opts)
 
         /* create pipe for fifo */
         if (!extcap_create_pipe(interface_opts->name, &interface_opts->extcap_fifo,
-                                EXTCAP_PIPE_PREFIX, TRUE))
+                                EXTCAP_PIPE_PREFIX))
         {
             return FALSE;
         }
@@ -1336,7 +1437,7 @@ extcap_init_interfaces(capture_options *capture_opts)
 
         pid = ws_pipe_spawn_async(pipedata, args);
 
-        g_ptr_array_foreach(args, (GFunc)g_free, NULL);
+        g_ptr_array_foreach(args, ptr_array_free, NULL);
         g_ptr_array_free(args, TRUE);
 
         if (pid == WS_INVALID_PID)
@@ -1383,7 +1484,7 @@ extcap_init_interfaces(capture_options *capture_opts)
 }
 
 #ifdef _WIN32
-gboolean extcap_create_pipe(const gchar *ifname, gchar **fifo, const gchar *pipe_prefix, gboolean byte_mode)
+gboolean extcap_create_pipe(const gchar *ifname, gchar **fifo, const gchar *pipe_prefix)
 {
     gchar timestr[ 14 + 1 ];
     time_t current_time;
@@ -1409,8 +1510,7 @@ gboolean extcap_create_pipe(const gchar *ifname, gchar **fifo, const gchar *pipe
     pipe_h = CreateNamedPipe(
                  utf_8to16(pipename),
                  PIPE_ACCESS_DUPLEX | FILE_FLAG_OVERLAPPED,
-                 (byte_mode ? (PIPE_TYPE_BYTE | PIPE_READMODE_BYTE | PIPE_WAIT) :
-                              (PIPE_TYPE_MESSAGE | PIPE_READMODE_MESSAGE | PIPE_WAIT)),
+                 PIPE_TYPE_BYTE | PIPE_READMODE_BYTE | PIPE_WAIT,
                  1, 65536, 65536,
                  300,
                  &security);
@@ -1430,7 +1530,7 @@ gboolean extcap_create_pipe(const gchar *ifname, gchar **fifo, const gchar *pipe
     return TRUE;
 }
 #else
-gboolean extcap_create_pipe(const gchar *ifname, gchar **fifo, const gchar *pipe_prefix, gboolean byte_mode _U_)
+gboolean extcap_create_pipe(const gchar *ifname, gchar **fifo, const gchar *pipe_prefix)
 {
     gchar *temp_name = NULL;
     int fd = 0;
@@ -1548,12 +1648,6 @@ static gboolean cb_load_interfaces(extcap_callback_info_t cb_info)
     /* Load interfaces from utility */
     interfaces = extcap_parse_interfaces(cb_info.output, &control_items);
 
-    if (control_items)
-    {
-        toolbar_entry = g_new0(iface_toolbar, 1);
-        toolbar_entry->controls = control_items;
-    }
-
     g_log(LOG_DOMAIN_CAPTURE, G_LOG_LEVEL_DEBUG, "Loading interface list for %s ", cb_info.extcap);
 
     /* Seems, that there where no interfaces to be loaded */
@@ -1580,6 +1674,12 @@ static gboolean cb_load_interfaces(extcap_callback_info_t cb_info)
         return FALSE;
     }
 
+    if (control_items)
+    {
+        toolbar_entry = g_new0(iface_toolbar, 1);
+        toolbar_entry->controls = control_items;
+    }
+
     walker = interfaces;
     gchar* help = NULL;
     while (walker != NULL)
@@ -1676,7 +1776,7 @@ static gboolean cb_load_interfaces(extcap_callback_info_t cb_info)
 static void
 extcap_load_interface_list(void)
 {
-    gchar *error;
+    gchar *error = NULL;
 
     if (prefs.capture_no_extcap)
         return;
@@ -1699,6 +1799,9 @@ extcap_load_interface_list(void)
     if (_loaded_interfaces == NULL)
     {
         GList * arguments = NULL;
+        GList * fallback = NULL;
+        int major = 0;
+        int minor = 0;
 
         _loaded_interfaces = g_hash_table_new_full(g_str_hash, g_str_equal, g_free, extcap_free_interface_info);
         /* Cleanup lookup table */
@@ -1711,14 +1814,19 @@ extcap_load_interface_list(void)
         }
 
         arguments = g_list_append(arguments, g_strdup(EXTCAP_ARGUMENT_LIST_INTERFACES));
+        fallback = g_list_append(fallback, g_strdup(EXTCAP_ARGUMENT_LIST_INTERFACES));
+
+        get_ws_version_number(&major, &minor, NULL);
+        arguments = g_list_append(arguments, g_strdup_printf("%s=%d.%d", EXTCAP_ARGUMENT_VERSION, major, minor));
 
         extcap_callback_info_t cb_info;
         cb_info.data = NULL;
         cb_info.ifname = NULL;
         cb_info.err_str = &error;
 
-        extcap_foreach(arguments, cb_load_interfaces, cb_info);
+        extcap_foreach(arguments, cb_load_interfaces, cb_info, fallback);
 
+        g_list_free_full(fallback, g_free);
         g_list_free_full(arguments, g_free);
     }
 }