2 * Utilities for capture user interfaces
6 * Wireshark - Network traffic analyzer
7 * By Gerald Combs <gerald@wireshark.org>
8 * Copyright 1998 Gerald Combs
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.
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.
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.
34 #include <epan/prefs.h>
35 #include "capture-pcap-util.h"
36 #include "capture_ui_utils.h"
39 * Find user-specified capture device description that matches interface
43 capture_dev_user_descr_find(const gchar *if_name)
51 if (prefs.capture_devices_descr == NULL) {
52 /* There are no descriptions. */
56 if ((p = strstr(prefs.capture_devices_descr, if_name)) == NULL) {
57 /* There are, but there isn't one for this interface. */
62 /* error: ran into next interface description */
65 /* found left parenthesis, start of description */
69 /* skip over left parenthesis */
71 /* save pointer to beginning of description */
76 /* end of description */
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
89 descr = g_malloc(p - p2 + 1);
90 memcpy(descr, p2, p - p2);
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.
104 * The result must be g_free()'d when you're done with it.
106 * Note: given that this calls get_interface_list(), which attempts to
107 * open all adapters it finds in order to check whether they can be
108 * captured on, this is an expensive routine to call, so don't call it
112 get_interface_descriptive_name(const char *if_name)
120 /* Do we have a user-supplied description? */
121 descr = capture_dev_user_descr_find(if_name);
123 /* Yes - make a copy of that. */
124 descr = g_strdup(descr);
126 /* No, we don't have a user-supplied description; did we get
127 one from the OS or libpcap? */
129 if_list = get_interface_list(&err, NULL);
130 if (if_list != NULL && if_name != NULL) {
133 if_info = if_entry->data;
134 if (strcmp(if_info->name, if_name) == 0) {
135 if (if_info->description != NULL) {
136 /* Return a copy of that - when we free the interface
137 list, that'll also free up the strings to which
139 descr = g_strdup(if_info->description);
143 } while ((if_entry = g_list_next(if_entry)) != NULL);
145 free_interface_list(if_list);
148 /* The interface name is all we have, so just return a copy of that. */
149 descr = g_strdup(if_name);
157 /* search interface info by interface name */
159 search_info(GList *if_list, gchar *if_name)
165 for (if_entry = if_list; if_entry != NULL; if_entry = g_list_next(if_entry)) {
166 if_info = if_entry->data;
168 if(strcmp(if_name, if_info->name) == 0) {
177 /* build the string to display in the combo box for the given interface */
179 build_capture_combo_name(GList *if_list, gchar *if_name)
186 /* Do we have a user-supplied description? */
187 descr = capture_dev_user_descr_find(if_name);
189 /* Yes, we have a user-supplied description; use it. */
190 if_string = g_strdup_printf("%s: %s", descr, if_name);
193 /* No, we don't have a user-supplied description; did we get
194 one from the OS or libpcap? */
195 if_info = search_info(if_list, if_name);
196 if (if_info && if_info->description != NULL) {
198 if_string = g_strdup_printf("%s: %s", if_info->description,
202 if_string = g_strdup(if_name);
211 build_capture_combo_list(GList *if_list, gboolean do_hide)
220 if (if_list != NULL) {
221 /* Scan through the list and build a list of strings to display. */
222 for (if_entry = if_list; if_entry != NULL;
223 if_entry = g_list_next(if_entry)) {
224 if_info = if_entry->data;
226 /* Is this interface hidden and, if so, should we include it
228 if (prefs.capture_devices_hide == NULL ||
229 strstr(prefs.capture_devices_hide, if_info->name) == NULL ||
231 /* It's not hidden, or it is but we should include it in the list. */
233 /* Do we have a user-supplied description? */
234 descr = capture_dev_user_descr_find(if_info->name);
236 /* Yes, we have a user-supplied description; use it. */
237 if_string = g_strdup_printf("%s: %s", descr, if_info->name);
240 /* No, we don't have a user-supplied description; did we get
241 one from the OS or libpcap? */
242 if (if_info->description != NULL) {
244 if_string = g_strdup_printf("%s: %s", if_info->description,
248 if_string = g_strdup(if_info->name);
251 combo_list = g_list_append(combo_list, if_string);
259 free_if_string(gpointer data, gpointer user_data _U_)
265 free_capture_combo_list(GList *combo_list)
267 if (combo_list != NULL) {
268 g_list_foreach(combo_list, free_if_string, NULL);
269 g_list_free(combo_list);
274 * Given text that contains an interface name possibly prefixed by an
275 * interface description, extract the interface name.
278 get_if_name(const char *if_text)
284 * We cannot assume that the interface name doesn't contain a space;
285 * some names on Windows OT do.
287 * We also can't assume it begins with "\Device\", either, as, on
288 * Windows OT, WinPcap doesn't put "\Device\" in front of the name.
290 * As I remember, we can't assume that the interface description
291 * doesn't contain a colon, either; I think some do.
293 * We can probably assume that the interface *name* doesn't contain
294 * a colon, however; if any interface name does contain a colon on
295 * Windows, it'll be time to just get rid of the damn interface
296 * descriptions in the drop-down list, have just the names in the
297 * drop-down list, and have a "Browse..." button to browse for interfaces,
298 * with names, descriptions, IP addresses, blah blah blah available when
301 * So we search backwards for a colon. If we don't find it, just
302 * return the entire string; otherwise, skip the colon and any blanks
303 * after it, and return that string.
305 if_name = if_text + strlen(if_text);
307 if (if_name == if_text) {
308 /* We're at the beginning of the string; return it. */
312 if (*if_name == ':') {
314 * We've found a colon.
315 * Unfortunately, a colon is used in the string "rpcap://",
316 * which is used in case of a remote capture.
317 * So we'll check to make sure the colon isn't followed by "//";
318 * it'll be followed by a blank if it separates the description
319 * and the interface name. (We don't wire in "rpcap", in case we
320 * support other protocols in the same syntax.)
322 if (strncmp(if_name, "://", 3) != 0) {
324 * OK, we've found a colon not followed by "//". Skip blanks
328 while (*if_name == ' ')
333 /* Keep looking for a colon not followed by "//". */
337 * There's a space between the interface description and name, and
338 * the interface name shouldn't have a space in it (it doesn't, on
339 * UNIX systems); look backwards in the string for a space.
341 * (An interface name might, however, contain a colon in it, which
342 * is why we don't use the colon search on UNIX.)
344 if_name = strrchr(if_text, ' ');
345 if (if_name == NULL) {
354 /* Return capture_opts->iface_descr (after setting it if it is not set)
355 * This is necessary because capture_opts.c can't set iface_descr (at least
356 * not without adding significant dependencies there).
359 get_iface_description(capture_options *capture_opts)
361 if (!capture_opts->iface_descr)
362 capture_opts->iface_descr = get_interface_descriptive_name(capture_opts->iface);
364 return(capture_opts->iface_descr);
367 #endif /* HAVE_LIBPCAP */