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
 113   /* Do we have a user-supplied description? */
 114   descr = capture_dev_user_descr_find(if_name);
 115   if (descr != NULL) {
 116     /* Yes - make a copy of that. */
 117     descr = g_strdup(descr);
 118   } else {
 119     /* No, we don't have a user-supplied description; did we get
 120        one from the OS or libpcap? */
 121     descr = NULL;
 122     if_list = get_interface_list(&err, NULL);
 123     if (if_list != NULL) {
 124       if_entry = if_list;
 125       do {
 126         if_info = if_entry->data;
 127         if (strcmp(if_info->name, if_name) == 0) {
 128           if (if_info->description != NULL) {
 129             /* Return a copy of that - when we free the interface
 130                list, that'll also free up the strings to which
 131                it refers. */
 132             descr = g_strdup(if_info->description);
 133           }
 134           break;
 135         }
 136       } while ((if_entry = g_list_next(if_entry)) != NULL);
 137     }
 138     free_interface_list(if_list);
 139
 140     if (descr == NULL) {
 141       /* The interface name is all we have, so just return a copy of that. */
 142       descr = g_strdup(if_name);
 143     }
 144   }
 145
 146   return descr;
 147 }
 148
 149
 150 /* search interface info by interface name */
 151 static if_info_t *
 152 search_info(GList *if_list, gchar *if_name)
 153 {
 154     GList *if_entry;
 155     if_info_t *if_info;
 156
 157
 158     for (if_entry = if_list; if_entry != NULL; if_entry = g_list_next(if_entry)) {
 159         if_info = if_entry->data;
 160
 161         if(strcmp(if_name, if_info->name) == 0) {
 162             return if_info;
 163         }
 164     }
 165
 166     return NULL;
 167 }
 168
 169
 170 /* build the string to display in the combo box for the given interface */
 171 char *
 172 build_capture_combo_name(GList *if_list, gchar *if_name)
 173 {
 174     gchar *descr;
 175     char *if_string;
 176     if_info_t *if_info;
 177
 178
 179         /* Do we have a user-supplied description? */
 180         descr = capture_dev_user_descr_find(if_name);
 181         if (descr != NULL) {
 182           /* Yes, we have a user-supplied description; use it. */
 183           if_string = g_strdup_printf("%s: %s", descr, if_name);
 184           g_free(descr);
 185         } else {
 186           /* No, we don't have a user-supplied description; did we get
 187              one from the OS or libpcap? */
 188       if_info = search_info(if_list, if_name);
 189           if (if_info && if_info->description != NULL) {
 190             /* Yes - use it. */
 191             if_string = g_strdup_printf("%s: %s", if_info->description,
 192                                         if_info->name);
 193           } else {
 194             /* No. */
 195             if_string = g_strdup(if_name);
 196           }
 197         }
 198
 199     return if_string;
 200 }
 201
 202
 203 GList *
 204 build_capture_combo_list(GList *if_list, gboolean do_hide)
 205 {
 206   GList *combo_list;
 207   GList *if_entry;
 208   if_info_t *if_info;
 209   char *if_string;
 210   gchar *descr;
 211
 212   combo_list = NULL;
 213   if (if_list != NULL) {
 214     /* Scan through the list and build a list of strings to display. */
 215     for (if_entry = if_list; if_entry != NULL;
 216          if_entry = g_list_next(if_entry)) {
 217       if_info = if_entry->data;
 218
 219       /* Is this interface hidden and, if so, should we include it
 220          anyway? */
 221       if (prefs.capture_devices_hide == NULL ||
 222           strstr(prefs.capture_devices_hide, if_info->name) == NULL ||
 223           !do_hide) {
 224         /* It's not hidden, or it is but we should include it in the list. */
 225
 226         /* Do we have a user-supplied description? */
 227         descr = capture_dev_user_descr_find(if_info->name);
 228         if (descr != NULL) {
 229           /* Yes, we have a user-supplied description; use it. */
 230           if_string = g_strdup_printf("%s: %s", descr, if_info->name);
 231           g_free(descr);
 232         } else {
 233           /* No, we don't have a user-supplied description; did we get
 234              one from the OS or libpcap? */
 235           if (if_info->description != NULL) {
 236             /* Yes - use it. */
 237             if_string = g_strdup_printf("%s: %s", if_info->description,
 238                                         if_info->name);
 239           } else {
 240             /* No. */
 241             if_string = g_strdup(if_info->name);
 242           }
 243         }
 244         combo_list = g_list_append(combo_list, if_string);
 245       }
 246     }
 247   }
 248   return combo_list;
 249 }
 250
 251 static void
 252 free_if_string(gpointer data, gpointer user_data _U_)
 253 {
 254   g_free(data);
 255 }
 256
 257 void
 258 free_capture_combo_list(GList *combo_list)
 259 {
 260   if (combo_list != NULL) {
 261     g_list_foreach(combo_list, free_if_string, NULL);
 262     g_list_free(combo_list);
 263   }
 264 }
 265
 266 /*
 267  * Given text that contains an interface name possibly prefixed by an
 268  * interface description, extract the interface name.
 269  */
 270 const char *
 271 get_if_name(const char *if_text)
 272 {
 273   const char *if_name;
 274
 275 #ifdef _WIN32
 276   /*
 277    * We cannot assume that the interface name doesn't contain a space;
 278    * some names on Windows OT do.
 279    *
 280    * We also can't assume it begins with "\Device\", either, as, on
 281    * Windows OT, WinPcap doesn't put "\Device\" in front of the name.
 282    *
 283    * As I remember, we can't assume that the interface description
 284    * doesn't contain a colon, either; I think some do.
 285    *
 286    * We can probably assume that the interface *name* doesn't contain
 287    * a colon, however; if any interface name does contain a colon on
 288    * Windows, it'll be time to just get rid of the damn interface
 289    * descriptions in the drop-down list, have just the names in the
 290    * drop-down list, and have a "Browse..." button to browse for interfaces,
 291    * with names, descriptions, IP addresses, blah blah blah available when
 292    * possible.
 293    *
 294    * So we search backwards for a colon.  If we don't find it, just
 295    * return the entire string; otherwise, skip the colon and any blanks
 296    * after it, and return that string.
 297    */
 298    if_name = if_text + strlen(if_text);
 299    for (;;) {
 300      if (if_name == if_text) {
 301        /* We're at the beginning of the string; return it. */
 302        break;
 303      }
 304      if_name--;
 305      if (*if_name == ':') {
 306        /*
 307         * We've found a colon.
 308         * Unfortunately, a colon is used in the string "rpcap://",
 309         * which is used in case of a remote capture.
 310         * So we'll check to make sure the colon isn't followed by "//";
 311         * it'll be followed by a blank if it separates the description
 312         * and the interface name.  (We don't wire in "rpcap", in case we
 313         * support other protocols in the same syntax.)
 314         */
 315        if (strncmp(if_name, "://", 3) != 0) {
 316          /*
 317           * OK, we've found a colon not followed by "//".  Skip blanks
 318           * following it.
 319           */
 320          if_name++;
 321          while (*if_name == ' ')
 322            if_name++;
 323          break;
 324        }
 325      }
 326      /* Keep looking for a colon not followed by "//". */
 327    }
 328 #else
 329   /*
 330    * There's a space between the interface description and name, and
 331    * the interface name shouldn't have a space in it (it doesn't, on
 332    * UNIX systems); look backwards in the string for a space.
 333    *
 334    * (An interface name might, however, contain a colon in it, which
 335    * is why we don't use the colon search on UNIX.)
 336    */
 337   if_name = strrchr(if_text, ' ');
 338   if (if_name == NULL) {
 339     if_name = if_text;
 340   } else {
 341     if_name++;
 342   }
 343 #endif
 344   return if_name;
 345 }
 346
 347 #endif /* HAVE_LIBPCAP */