capture_ui_utils.c

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