Glib docs recommend using the slice API if you know you won't need to realloc.
[metze/wireshark/wip.git] / capture_ui_utils.c
index a684e1680590654256b0cf71e481da6ff07a3f10..6f525f108edc2a0de29bdaef3257db95dbfd15cb 100644 (file)
  *
  * You should have received a copy of the GNU General Public License
  * along with this program; if not, write to the Free Software
- * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  */
 
-#ifdef HAVE_CONFIG_H
-# include "config.h"
-#endif
+#include "config.h"
 
 #ifdef HAVE_LIBPCAP
 
+#include <stdio.h>
+#include <stdlib.h>
 #include <string.h>
+#include <ctype.h>
 #include <glib.h>
 
-#include <epan/prefs.h>
-#include "capture-pcap-util.h"
+#include "epan/prefs.h"
+#include "epan/ex-opt.h"
+#include "capture_ifinfo.h"
 #include "capture_ui_utils.h"
+#include "ui/simple_dialog.h"
+#include "wiretap/wtap.h"
+#include "epan/to_str.h"
 
 /*
  * Find user-specified capture device description that matches interface
  * name, if any.
  */
-static char *
+char *
 capture_dev_user_descr_find(const gchar *if_name)
 {
-       char    *p;
-       char    *p2 = NULL;
-       char    *descr = NULL;
-       int     lp = 0;
-       int     ct = 0;
-
-       if (prefs.capture_devices_descr == NULL) {
-               /* There are no descriptions. */
-               return NULL;
-       }
-
-       if ((p = strstr(prefs.capture_devices_descr, if_name)) == NULL) {
-               /* There are, but there isn't one for this interface. */
-               return NULL;
-       }
-
-       while (*p != '\0') {
-               /* error: ran into next interface description */
-               if (*p == ',')
-                       return NULL;
-               /* found left parenthesis, start of description */
-               else if (*p == '(') {
-                       ct = 0;
-                       lp++;
-                       /* skip over left parenthesis */
-                       p++;
-                       /* save pointer to beginning of description */
-                       p2 = p;
-                       continue;
-               }
-               else if (*p == ')') {
-                       /* end of description */
-                       break;
-               }
-               else {
-                       p++;
-                       ct++;
-               }
-       }
-
-       if ((lp == 1) && (ct > 0) && (p2 != NULL)) {
-               /* Allocate enough space to return the string,
-                  which runs from p2 to p, plus a terminating
-                  '\0'. */
-               descr = g_malloc(p - p2 + 1);
-               memcpy(descr, p2, p - p2);
-               descr[p - p2] = '\0';
-               return descr;
-       }
-       else
-               return NULL;
+  char *p;
+  char *p2 = NULL;
+  char *descr = NULL;
+  int lp = 0;
+  int ct = 0;
+
+  if ((prefs.capture_devices_descr == NULL) ||
+      (*prefs.capture_devices_descr == '\0')) {
+    /* There are no descriptions. */
+    return NULL;
+  }
+
+  if ((p = strstr(prefs.capture_devices_descr, if_name)) == NULL) {
+    /* There are, but there isn't one for this interface. */
+    return NULL;
+  }
+
+  while (*p != '\0') {
+    /* error: ran into next interface description */
+    if (*p == ',')
+      return NULL;
+    /* found left parenthesis, start of description */
+    else if (*p == '(') {
+      ct = 0;
+      lp++;
+      /* skip over left parenthesis */
+      p++;
+      /* save pointer to beginning of description */
+      p2 = p;
+      continue;
+    }
+    else if (*p == ')') {
+      /* end of description */
+      break;
+    }
+    else {
+        p++;
+        ct++;
+    }
+  }
+
+  if ((lp == 1) && (ct > 0) && (p2 != NULL)) {
+    /* Allocate enough space to return the string,
+       which runs from p2 to p, plus a terminating
+       '\0'. */
+    descr = (char *)g_malloc(p - p2 + 1);
+    memcpy(descr, p2, p - p2);
+    descr[p - p2] = '\0';
+    return descr;
+  }
+  else
+    return NULL;
+}
+
+gint
+capture_dev_user_linktype_find(const gchar *if_name)
+{
+  gchar *p, *next;
+  long linktype;
+
+  if ((prefs.capture_devices_linktypes == NULL) ||
+      (*prefs.capture_devices_linktypes == '\0')) {
+    /* There are no link-layer header types */
+    return -1;
+  }
+
+  if ((p = strstr(prefs.capture_devices_linktypes, if_name)) == NULL) {
+    /* There are, but there isn't one for this interface. */
+    return -1;
+  }
+
+  p += strlen(if_name) + 1;
+  linktype = strtol(p, &next, 10);
+  if (next == p || *next != ')' || linktype < 0) {
+    /* Syntax error */
+    return -1;
+  }
+  if (linktype > G_MAXINT) {
+    /* Value doesn't fit in a gint */
+    return -1;
+  }
+
+  return (gint)linktype;
+}
+
+#if defined(_WIN32) || defined(HAVE_PCAP_CREATE)
+gint
+capture_dev_user_buffersize_find(const gchar *if_name)
+{
+  gchar *p, *next;
+  gint buffersize;
+
+  if ((prefs.capture_devices_buffersize == NULL) ||
+      (*prefs.capture_devices_buffersize == '\0')) {
+    /* There are no buffersizes defined */
+    return -1;
+  }
+
+  if ((p = strstr(prefs.capture_devices_buffersize, if_name)) == NULL) {
+    /* There are, but there isn't one for this interface. */
+    return -1;
+  }
+
+  p += strlen(if_name) + 1;
+  buffersize = (gint)strtol(p, &next, 10);
+  if (next == p || *next != ')' || buffersize < 0) {
+    /* Syntax error */
+    return -1;
+  }
+  if (buffersize > G_MAXINT) {
+    /* Value doesn't fit in a gint */
+    return -1;
+  }
+
+  return (gint)buffersize;
 }
+#endif
+
+gint
+capture_dev_user_snaplen_find(const gchar *if_name)
+{
+  gchar *p, *next;
+  gint snaplen;
+
+  if ((prefs.capture_devices_snaplen == NULL) ||
+      (*prefs.capture_devices_snaplen == '\0')) {
+    /* There is no snap length defined */
+    return -1;
+  }
+
+  if ((p = strstr(prefs.capture_devices_snaplen, if_name)) == NULL) {
+    /* There are, but there isn't one for this interface. */
+    return -1;
+  }
+
+  p += strlen(if_name) + 3;
+  snaplen = (gint)strtol(p, &next, 10);
+  if (next == p || *next != ')' || snaplen < 0) {
+    /* Syntax error */
+    return -1;
+  }
+  if (snaplen > WTAP_MAX_PACKET_SIZE) {
+    /* Value doesn't fit in a gint */
+    return -1;
+  }
+
+  return (gint)snaplen;
+}
+
+gboolean
+capture_dev_user_hassnap_find(const gchar *if_name)
+{
+  gchar *p, *next;
+  gboolean hassnap;
+
+  if ((prefs.capture_devices_snaplen == NULL) ||
+      (*prefs.capture_devices_snaplen == '\0')) {
+    /* There is no snap length defined */
+    return -1;
+  }
+
+  if ((p = strstr(prefs.capture_devices_snaplen, if_name)) == NULL) {
+    /* There are, but there isn't one for this interface. */
+    return -1;
+  }
+
+  p += strlen(if_name) + 1;
+  hassnap = (gboolean)strtol(p, &next, 10);
+  if (next == p || *next != '(') {
+    /* Syntax error */
+    return -1;
+  }
+
+  return (gboolean)hassnap;
+}
+
 
 /*
  * Return as descriptive a name for an interface as we can get.
  * If the user has specified a comment, use that.  Otherwise,
- * if get_interface_list() supplies a description, use that,
+ * if capture_interface_list() supplies a description, use that,
  * otherwise use the interface name.
+ *
+ * The result must be g_free()'d when you're done with it.
+ *
+ * Note: given that this calls capture_interface_list(), which attempts to
+ * open all adapters it finds in order to check whether they can be
+ * captured on, this is an expensive routine to call, so don't call it
+ * frequently.
  */
 char *
 get_interface_descriptive_name(const char *if_name)
@@ -109,28 +245,45 @@ get_interface_descriptive_name(const char *if_name)
   GList *if_entry;
   if_info_t *if_info;
   int err;
-  char err_buf[CAPTURE_PCAP_ERRBUF_SIZE];
 
   /* Do we have a user-supplied description? */
   descr = capture_dev_user_descr_find(if_name);
   if (descr != NULL) {
     /* Yes - make a copy of that. */
     descr = g_strdup(descr);
+  } else if (strcmp(if_name, "-") == 0) {
+    /*
+     * Strictly speaking, -X (extension) options are for modules, e.g. Lua
+     * and using one here stretches that definition. However, this doesn't
+     * waste a single-letter option on something that might be rarely used
+     * and is backward-compatible to 1.0.
+     */
+    descr = g_strdup(ex_opt_get_nth("stdin_descr", 0));
+    if (!descr) {
+      descr = g_strdup("Standard input");
+    }
   } else {
     /* No, we don't have a user-supplied description; did we get
        one from the OS or libpcap? */
     descr = NULL;
-    if_list = get_interface_list(&err, err_buf);
+    if_list = capture_interface_list(&err, NULL);
     if (if_list != NULL) {
       if_entry = if_list;
       do {
-        if_info = if_entry->data;
+        if_info = (if_info_t *)if_entry->data;
         if (strcmp(if_info->name, if_name) == 0) {
-          if (if_info->description != NULL) {
-            /* Return a copy of that - when we free the interface
-               list, that'll also free up the strings to which
-               it refers. */
-            descr = g_strdup(if_info->description);
+          if (if_info->friendly_name != NULL) {
+              /* We have a "friendly name"; return a copy of that
+                 as the description - when we free the interface
+                 list, that'll also free up the strings to which
+                 it refers. */
+              descr = g_strdup(if_info->friendly_name);
+          } else if (if_info->vendor_description != NULL) {
+            /* We have no "friendly name", but we have a vendor
+               description; return a copy of that - when we free
+               the interface list, that'll also free up the strings
+               to which it refers. */
+            descr = g_strdup(if_info->vendor_description);
           }
           break;
         }
@@ -152,19 +305,19 @@ get_interface_descriptive_name(const char *if_name)
 static if_info_t *
 search_info(GList *if_list, gchar *if_name)
 {
-    GList *if_entry;
-    if_info_t *if_info;
+  GList *if_entry;
+  if_info_t *if_info;
 
 
-    for (if_entry = if_list; if_entry != NULL; if_entry = g_list_next(if_entry)) {
-        if_info = if_entry->data;
+  for (if_entry = if_list; if_entry != NULL; if_entry = g_list_next(if_entry)) {
+    if_info = (if_info_t *)if_entry->data;
 
-        if(strcmp(if_name, if_info->name) == 0) {
-            return if_info;
-        }
+    if(strcmp(if_name, if_info->name) == 0) {
+      return if_info;
     }
+  }
 
-    return NULL;
+  return NULL;
 }
 
 
@@ -172,32 +325,31 @@ search_info(GList *if_list, gchar *if_name)
 char *
 build_capture_combo_name(GList *if_list, gchar *if_name)
 {
-    gchar *descr;
-    char *if_string;
-    if_info_t *if_info;
-
-
-       /* Do we have a user-supplied description? */
-       descr = capture_dev_user_descr_find(if_name);
-       if (descr != NULL) {
-         /* Yes, we have a user-supplied description; use it. */
-         if_string = g_strdup_printf("%s: %s", descr, if_name);
-         g_free(descr);
-       } else {
-         /* No, we don't have a user-supplied description; did we get
-            one from the OS or libpcap? */
-      if_info = search_info(if_list, if_name);
-         if (if_info && if_info->description != NULL) {
-           /* Yes - use it. */
-           if_string = g_strdup_printf("%s: %s", if_info->description,
-                                       if_info->name);
-         } else {
-           /* No. */
-           if_string = g_strdup(if_name);
-         }
-       }
-
-    return if_string;
+  gchar *descr;
+  char *if_string;
+  if_info_t *if_info;
+
+  /* Do we have a user-supplied description? */
+  descr = capture_dev_user_descr_find(if_name);
+  if (descr != NULL) {
+    /* Yes, we have a user-supplied description; use it. */
+    if_string = g_strdup_printf("%s: %s", descr, if_name);
+    g_free(descr);
+  } else {
+    /* No, we don't have a user-supplied description; did we get
+     one from the OS or libpcap? */
+    if_info = search_info(if_list, if_name);
+    if (if_info != NULL && if_info->vendor_description != NULL) {
+      /* Yes - use it. */
+      if_string = g_strdup_printf("%s: %s", if_info->vendor_description,
+                                  if_info->name);
+    } else {
+      /* No. */
+      if_string = g_strdup(if_name);
+    }
+  }
+
+  return if_string;
 }
 
 
@@ -214,37 +366,36 @@ build_capture_combo_list(GList *if_list, gboolean do_hide)
   if (if_list != NULL) {
     /* Scan through the list and build a list of strings to display. */
     for (if_entry = if_list; if_entry != NULL;
-        if_entry = g_list_next(if_entry)) {
-      if_info = if_entry->data;
+         if_entry = g_list_next(if_entry)) {
+      if_info = (if_info_t *)if_entry->data;
 
       /* Is this interface hidden and, if so, should we include it
          anyway? */
-      if (prefs.capture_devices_hide == NULL ||
-         strstr(prefs.capture_devices_hide, if_info->name) == NULL ||
-         !do_hide) {
-       /* It's not hidden, or it is but we should include it in the list. */
-
-       /* Do we have a user-supplied description? */
-       descr = capture_dev_user_descr_find(if_info->name);
-       if (descr != NULL) {
-         /* Yes, we have a user-supplied description; use it. */
-         if_string = g_strdup_printf("%s: %s", descr, if_info->name);
-         g_free(descr);
-       } else {
-         /* No, we don't have a user-supplied description; did we get
-            one from the OS or libpcap? */
-         if (if_info->description != NULL) {
-           /* Yes - use it. */
-           if_string = g_strdup_printf("%s: %s", if_info->description,
-                                       if_info->name);
-         } else {
-           /* No. */
-           if_string = g_strdup(if_info->name);
-         }
-       }
-       combo_list = g_list_append(combo_list, if_string);
+      if (!prefs_is_capture_device_hidden(if_info->name) || !do_hide) {
+        /* It's not hidden, or it is but we should include it in the list. */
+
+        /* Do we have a user-supplied description? */
+        descr = capture_dev_user_descr_find(if_info->name);
+        if (descr != NULL) {
+          /* Yes, we have a user-supplied description; use it. */
+          if_string = g_strdup_printf("%s: %s", descr, if_info->name);
+          g_free(descr);
+        } else {
+          /* No, we don't have a user-supplied description; did we get
+             one from the OS or libpcap? */
+          if (if_info->vendor_description != NULL) {
+            /* Yes - use it. */
+            if_string = g_strdup_printf("%s: %s",
+                                        if_info->vendor_description,
+                                        if_info->name);
+          } else {
+            /* No. */
+            if_string = g_strdup(if_info->name);
+          }
+        }
+        combo_list = g_list_append(combo_list, if_string);
       }
-    }
+    }/*for*/
   }
   return combo_list;
 }
@@ -312,11 +463,13 @@ get_if_name(const char *if_text)
         * it'll be followed by a blank if it separates the description
         * and the interface name.  (We don't wire in "rpcap", in case we
         * support other protocols in the same syntax.)
+        * Unfortunately, another colon can be used in "rpcap://host:port/"
+        * before port. Check if colon is followed by digit.
         */
-       if (strncmp(if_name, "://", 3) != 0) {
+       if ((strncmp(if_name, "://", 3) != 0) && !isdigit(if_name[1])) {
          /*
-          * OK, we've found a colon not followed by "//".  Skip blanks
-          * following it.
+          * OK, we've found a colon followed neither by "//" nor by digit.  
+          * Skip blanks following it.
           */
          if_name++;
          while (*if_name == ' ')
@@ -345,4 +498,26 @@ get_if_name(const char *if_text)
   return if_name;
 }
 
+/*  Return interface_opts->descr (after setting it if it is not set)
+ *  This is necessary because capture_opts.c can't set descr (at least
+ *  not without adding significant dependencies there).
+ */
+const char *
+get_iface_description_for_interface(capture_options *capture_opts, guint i)
+{
+  interface_options interface_opts;
+
+  if (i < capture_opts->ifaces->len) {
+    interface_opts = g_array_index(capture_opts->ifaces, interface_options, i);
+    if (!interface_opts.descr && interface_opts.name) {
+      interface_opts.descr = get_interface_descriptive_name(interface_opts.name);
+      capture_opts->ifaces = g_array_remove_index(capture_opts->ifaces, i);
+      g_array_insert_val(capture_opts->ifaces, i, interface_opts);
+    }
+    return (interface_opts.descr);
+  } else {
+    return (NULL);
+  }
+}
+
 #endif /* HAVE_LIBPCAP */