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.
35 #include <epan/prefs.h>
36 #include "capture-pcap-util.h"
37 #include "capture_ui_utils.h"
40 * Find user-specified capture device description that matches interface
44 capture_dev_user_descr_find(const gchar *if_name)
52 if (prefs.capture_devices_descr == NULL) {
53 /* There are no descriptions. */
57 if ((p = strstr(prefs.capture_devices_descr, if_name)) == NULL) {
58 /* There are, but there isn't one for this interface. */
63 /* error: ran into next interface description */
66 /* found left parenthesis, start of description */
70 /* skip over left parenthesis */
72 /* save pointer to beginning of description */
77 /* end of description */
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
90 descr = g_malloc(p - p2 + 1);
91 memcpy(descr, p2, p - p2);
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.
105 * The result must be g_free()'d when you're done with it.
107 * Note: given that this calls get_interface_list(), which attempts to
108 * open all adapters it finds in order to check whether they can be
109 * captured on, this is an expensive routine to call, so don't call it
113 get_interface_descriptive_name(const char *if_name)
121 /* Do we have a user-supplied description? */
122 descr = capture_dev_user_descr_find(if_name);
124 /* Yes - make a copy of that. */
125 descr = g_strdup(descr);
127 /* No, we don't have a user-supplied description; did we get
128 one from the OS or libpcap? */
130 if_list = get_interface_list(&err, NULL);
131 if (if_list != NULL && if_name != NULL) {
134 if_info = if_entry->data;
135 if (strcmp(if_info->name, if_name) == 0) {
136 if (if_info->description != NULL) {
137 /* Return a copy of that - when we free the interface
138 list, that'll also free up the strings to which
140 descr = g_strdup(if_info->description);
144 } while ((if_entry = g_list_next(if_entry)) != NULL);
146 free_interface_list(if_list);
149 /* The interface name is all we have, so just return a copy of that. */
150 descr = g_strdup(if_name);
158 /* search interface info by interface name */
160 search_info(GList *if_list, gchar *if_name)
166 for (if_entry = if_list; if_entry != NULL; if_entry = g_list_next(if_entry)) {
167 if_info = if_entry->data;
169 if(strcmp(if_name, if_info->name) == 0) {
178 /* build the string to display in the combo box for the given interface */
180 build_capture_combo_name(GList *if_list, gchar *if_name)
187 /* Do we have a user-supplied description? */
188 descr = capture_dev_user_descr_find(if_name);
190 /* Yes, we have a user-supplied description; use it. */
191 if_string = g_strdup_printf("%s: %s", descr, if_name);
194 /* No, we don't have a user-supplied description; did we get
195 one from the OS or libpcap? */
196 if_info = search_info(if_list, if_name);
197 if (if_info && if_info->description != NULL) {
199 if_string = g_strdup_printf("%s: %s", if_info->description,
203 if_string = g_strdup(if_name);
212 build_capture_combo_list(GList *if_list, gboolean do_hide)
221 if (if_list != NULL) {
222 /* Scan through the list and build a list of strings to display. */
223 for (if_entry = if_list; if_entry != NULL;
224 if_entry = g_list_next(if_entry)) {
225 if_info = if_entry->data;
227 /* Is this interface hidden and, if so, should we include it
229 if (!prefs_is_capture_device_hidden(if_info->name) || !do_hide) {
230 /* It's not hidden, or it is but we should include it in the list. */
232 /* Do we have a user-supplied description? */
233 descr = capture_dev_user_descr_find(if_info->name);
235 /* Yes, we have a user-supplied description; use it. */
236 if_string = g_strdup_printf("%s: %s", descr, if_info->name);
239 /* No, we don't have a user-supplied description; did we get
240 one from the OS or libpcap? */
241 if (if_info->description != NULL) {
243 if_string = g_strdup_printf("%s: %s", if_info->description,
247 if_string = g_strdup(if_info->name);
250 combo_list = g_list_append(combo_list, if_string);
258 free_if_string(gpointer data, gpointer user_data _U_)
264 free_capture_combo_list(GList *combo_list)
266 if (combo_list != NULL) {
267 g_list_foreach(combo_list, free_if_string, NULL);
268 g_list_free(combo_list);
273 * Given text that contains an interface name possibly prefixed by an
274 * interface description, extract the interface name.
277 get_if_name(const char *if_text)
283 * We cannot assume that the interface name doesn't contain a space;
284 * some names on Windows OT do.
286 * We also can't assume it begins with "\Device\", either, as, on
287 * Windows OT, WinPcap doesn't put "\Device\" in front of the name.
289 * As I remember, we can't assume that the interface description
290 * doesn't contain a colon, either; I think some do.
292 * We can probably assume that the interface *name* doesn't contain
293 * a colon, however; if any interface name does contain a colon on
294 * Windows, it'll be time to just get rid of the damn interface
295 * descriptions in the drop-down list, have just the names in the
296 * drop-down list, and have a "Browse..." button to browse for interfaces,
297 * with names, descriptions, IP addresses, blah blah blah available when
300 * So we search backwards for a colon. If we don't find it, just
301 * return the entire string; otherwise, skip the colon and any blanks
302 * after it, and return that string.
304 if_name = if_text + strlen(if_text);
306 if (if_name == if_text) {
307 /* We're at the beginning of the string; return it. */
311 if (*if_name == ':') {
313 * We've found a colon.
314 * Unfortunately, a colon is used in the string "rpcap://",
315 * which is used in case of a remote capture.
316 * So we'll check to make sure the colon isn't followed by "//";
317 * it'll be followed by a blank if it separates the description
318 * and the interface name. (We don't wire in "rpcap", in case we
319 * support other protocols in the same syntax.)
320 * Unfortunately, another colon can be used in "rpcap://host:port/"
321 * before port. Check if colon is followed by digit.
323 if ((strncmp(if_name, "://", 3) != 0) && !isdigit(if_name[1])) {
325 * OK, we've found a colon followed neither by "//" nor by digit.
326 * Skip blanks following it.
329 while (*if_name == ' ')
334 /* Keep looking for a colon not followed by "//". */
338 * There's a space between the interface description and name, and
339 * the interface name shouldn't have a space in it (it doesn't, on
340 * UNIX systems); look backwards in the string for a space.
342 * (An interface name might, however, contain a colon in it, which
343 * is why we don't use the colon search on UNIX.)
345 if_name = strrchr(if_text, ' ');
346 if (if_name == NULL) {
355 /* Return capture_opts->iface_descr (after setting it if it is not set)
356 * This is necessary because capture_opts.c can't set iface_descr (at least
357 * not without adding significant dependencies there).
360 get_iface_description(capture_options *capture_opts)
362 if (!capture_opts->iface_descr && capture_opts->iface)
363 capture_opts->iface_descr = get_interface_descriptive_name(capture_opts->iface);
365 return(capture_opts->iface_descr);
368 #endif /* HAVE_LIBPCAP */