capture_ui_utils.c

   1 /* capture_ui_utils.c
   2  * Utilities for capture user interfaces
   3  *
   4  * $Id$
   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., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
  23  */
  24
  25 #ifdef HAVE_CONFIG_H
  26 # include "config.h"
  27 #endif
  28
  29 #ifdef HAVE_LIBPCAP
  30
  31 #include <string.h>
  32 #include <glib.h>
  33
  34 #include <epan/prefs.h>
  35 #include "capture-pcap-util.h"
  36 #include "capture_ui_utils.h"
  37
  38 /*
  39  * Find user-specified capture device description that matches interface
  40  * name, if any.
  41  */
  42 static char *
  43 capture_dev_user_descr_find(const gchar *if_name)
  44 {
  45         char    *p;
  46         char    *p2 = NULL;
  47         char    *descr = NULL;
  48         int     lp = 0;
  49         int     ct = 0;
  50
  51         if (prefs.capture_devices_descr == NULL) {
  52                 /* There are no descriptions. */
  53                 return NULL;
  54         }
  55
  56         if ((p = strstr(prefs.capture_devices_descr, if_name)) == NULL) {
  57                 /* There are, but there isn't one for this interface. */
  58                 return NULL;
  59         }
  60
  61         while (*p != '\0') {
  62                 /* error: ran into next interface description */
  63                 if (*p == ',')
  64                         return NULL;
  65                 /* found left parenthesis, start of description */
  66                 else if (*p == '(') {
  67                         ct = 0;
  68                         lp++;
  69                         /* skip over left parenthesis */
  70                         p++;
  71                         /* save pointer to beginning of description */
  72                         p2 = p;
  73                         continue;
  74                 }
  75                 else if (*p == ')') {
  76                         /* end of description */
  77                         break;
  78                 }
  79                 else {
  80                         p++;
  81                         ct++;
  82                 }
  83         }
  84
  85         if ((lp == 1) && (ct > 0) && (p2 != NULL)) {
  86                 /* Allocate enough space to return the string,
  87                    which runs from p2 to p, plus a terminating
  88                    '\0'. */
  89                 descr = g_malloc(p - p2 + 1);
  90                 memcpy(descr, p2, p - p2);
  91                 descr[p - p2] = '\0';
  92                 return descr;
  93         }
  94         else
  95                 return NULL;
  96 }
  97
  98 /*
  99  * Return as descriptive a name for an interface as we can get.
 100  * If the user has specified a comment, use that.  Otherwise,
 101  * if get_interface_list() supplies a description, use that,
 102  * otherwise use the interface name.
 103  */
 104 char *
 105 get_interface_descriptive_name(const char *if_name)
 106 {
 107   char *descr;
 108   GList *if_list;
 109   GList *if_entry;
 110   if_info_t *if_info;
 111   int err;
 112   char err_buf[CAPTURE_PCAP_ERRBUF_SIZE];
 113
 114   /* Do we have a user-supplied description? */
 115   descr = capture_dev_user_descr_find(if_name);
 116   if (descr != NULL) {
 117     /* Yes - make a copy of that. */
 118     descr = g_strdup(descr);
 119   } else {
 120     /* No, we don't have a user-supplied description; did we get
 121        one from the OS or libpcap? */
 122     descr = NULL;
 123     if_list = get_interface_list(&err, err_buf);
 124     if (if_list != NULL) {
 125       if_entry = if_list;
 126       do {
 127         if_info = if_entry->data;
 128         if (strcmp(if_info->name, if_name) == 0) {
 129           if (if_info->description != NULL) {
 130             /* Return a copy of that - when we free the interface
 131                list, that'll also free up the strings to which
 132                it refers. */
 133             descr = g_strdup(if_info->description);
 134           }
 135           break;
 136         }
 137       } while ((if_entry = g_list_next(if_entry)) != NULL);
 138     }
 139     free_interface_list(if_list);
 140
 141     if (descr == NULL) {
 142       /* The interface name is all we have, so just return a copy of that. */
 143       descr = g_strdup(if_name);
 144     }
 145   }
 146
 147   return descr;
 148 }
 149
 150
 151 /* search interface info by interface name */
 152 static if_info_t *
 153 search_info(GList *if_list, gchar *if_name)
 154 {
 155     GList *if_entry;
 156     if_info_t *if_info;
 157
 158
 159     for (if_entry = if_list; if_entry != NULL; if_entry = g_list_next(if_entry)) {
 160         if_info = if_entry->data;
 161
 162         if(strcmp(if_name, if_info->name) == 0) {
 163             return if_info;
 164         }
 165     }
 166
 167     return NULL;
 168 }
 169
 170
 171 /* build the string to display in the combo box for the given interface */
 172 char *
 173 build_capture_combo_name(GList *if_list, gchar *if_name)
 174 {
 175     gchar *descr;
 176     char *if_string;
 177     if_info_t *if_info;
 178
 179
 180         /* Do we have a user-supplied description? */
 181         descr = capture_dev_user_descr_find(if_name);
 182         if (descr != NULL) {
 183           /* Yes, we have a user-supplied description; use it. */
 184           if_string = g_strdup_printf("%s: %s", descr, if_name);
 185           g_free(descr);
 186         } else {
 187           /* No, we don't have a user-supplied description; did we get
 188              one from the OS or libpcap? */
 189       if_info = search_info(if_list, if_name);
 190           if (if_info && if_info->description != NULL) {
 191             /* Yes - use it. */
 192             if_string = g_strdup_printf("%s: %s", if_info->description,
 193                                         if_info->name);
 194           } else {
 195             /* No. */
 196             if_string = g_strdup(if_name);
 197           }
 198         }
 199
 200     return if_string;
 201 }
 202
 203
 204 GList *
 205 build_capture_combo_list(GList *if_list, gboolean do_hide)
 206 {
 207   GList *combo_list;
 208   GList *if_entry;
 209   if_info_t *if_info;
 210   char *if_string;
 211   gchar *descr;
 212
 213   combo_list = NULL;
 214   if (if_list != NULL) {
 215     /* Scan through the list and build a list of strings to display. */
 216     for (if_entry = if_list; if_entry != NULL;
 217          if_entry = g_list_next(if_entry)) {
 218       if_info = if_entry->data;
 219
 220       /* Is this interface hidden and, if so, should we include it
 221          anyway? */
 222       if (prefs.capture_devices_hide == NULL ||
 223           strstr(prefs.capture_devices_hide, if_info->name) == NULL ||
 224           !do_hide) {
 225         /* It's not hidden, or it is but we should include it in the list. */
 226
 227         /* Do we have a user-supplied description? */
 228         descr = capture_dev_user_descr_find(if_info->name);
 229         if (descr != NULL) {
 230           /* Yes, we have a user-supplied description; use it. */
 231           if_string = g_strdup_printf("%s: %s", descr, if_info->name);
 232           g_free(descr);
 233         } else {
 234           /* No, we don't have a user-supplied description; did we get
 235              one from the OS or libpcap? */
 236           if (if_info->description != NULL) {
 237             /* Yes - use it. */
 238             if_string = g_strdup_printf("%s: %s", if_info->description,
 239                                         if_info->name);
 240           } else {
 241             /* No. */
 242             if_string = g_strdup(if_info->name);
 243           }
 244         }
 245         combo_list = g_list_append(combo_list, if_string);
 246       }
 247     }
 248   }
 249   return combo_list;
 250 }
 251
 252 static void
 253 free_if_string(gpointer data, gpointer user_data _U_)
 254 {
 255   g_free(data);
 256 }
 257
 258 void
 259 free_capture_combo_list(GList *combo_list)
 260 {
 261   if (combo_list != NULL) {
 262     g_list_foreach(combo_list, free_if_string, NULL);
 263     g_list_free(combo_list);
 264   }
 265 }
 266
 267 /*
 268  * Given text that contains an interface name possibly prefixed by an
 269  * interface description, extract the interface name.
 270  */
 271 const char *
 272 get_if_name(const char *if_text)
 273 {
 274   const char *if_name;
 275
 276 #ifdef _WIN32
 277   /*
 278    * We cannot assume that the interface name doesn't contain a space;
 279    * some names on Windows OT do.
 280    *
 281    * We also can't assume it begins with "\Device\", either, as, on
 282    * Windows OT, WinPcap doesn't put "\Device\" in front of the name.
 283    *
 284    * As I remember, we can't assume that the interface description
 285    * doesn't contain a colon, either; I think some do.
 286    *
 287    * We can probably assume that the interface *name* doesn't contain
 288    * a colon, however; if any interface name does contain a colon on
 289    * Windows, it'll be time to just get rid of the damn interface
 290    * descriptions in the drop-down list, have just the names in the
 291    * drop-down list, and have a "Browse..." button to browse for interfaces,
 292    * with names, descriptions, IP addresses, blah blah blah available when
 293    * possible.
 294    *
 295    * So we search backwards for a colon.  If we don't find it, just
 296    * return the entire string; otherwise, skip the colon and any blanks
 297    * after it, and return that string.
 298    */
 299    if_name = if_text + strlen(if_text);
 300    for (;;) {
 301      if (if_name == if_text) {
 302        /* We're at the beginning of the string; return it. */
 303        break;
 304      }
 305      if_name--;
 306      if (*if_name == ':') {
 307        /*
 308         * We've found a colon.
 309         * Unfortunately, a colon is used in the string "rpcap://",
 310         * which is used in case of a remote capture.
 311         * So we'll check to make sure the colon isn't followed by "//";
 312         * it'll be followed by a blank if it separates the description
 313         * and the interface name.  (We don't wire in "rpcap", in case we
 314         * support other protocols in the same syntax.)
 315         */
 316        if (strncmp(if_name, "://", 3) != 0) {
 317          /*
 318           * OK, we've found a colon not followed by "//".  Skip blanks
 319           * following it.
 320           */
 321          if_name++;
 322          while (*if_name == ' ')
 323            if_name++;
 324          break;
 325        }
 326      }
 327      /* Keep looking for a colon not followed by "//". */
 328    }
 329 #else
 330   /*
 331    * There's a space between the interface description and name, and
 332    * the interface name shouldn't have a space in it (it doesn't, on
 333    * UNIX systems); look backwards in the string for a space.
 334    *
 335    * (An interface name might, however, contain a colon in it, which
 336    * is why we don't use the colon search on UNIX.)
 337    */
 338   if_name = strrchr(if_text, ' ');
 339   if (if_name == NULL) {
 340     if_name = if_text;
 341   } else {
 342     if_name++;
 343   }
 344 #endif
 345   return if_name;
 346 }
 347
 348 #endif /* HAVE_LIBPCAP */