2 * Routines for handling preferences
4 * $Id: prefs.c,v 1.105 2003/08/26 05:56:43 guy Exp $
6 * Ethereal - Network traffic analyzer
7 * By Gerald Combs <gerald@ethereal.com>
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.
40 #include <epan/filesystem.h>
42 #include <epan/resolv.h>
43 #include <epan/packet.h>
46 #include <epan/proto.h>
50 #include "prefs-int.h"
52 /* Internal functions */
53 static module_t *find_module(const char *name);
54 static module_t *prefs_register_module_or_subtree(module_t *parent,
55 const char *name, const char *title, gboolean is_subtree,
56 void (*apply_cb)(void));
57 static struct preference *find_preference(module_t *, const char *);
58 static int set_pref(gchar*, gchar*);
59 static GList *get_string_list(gchar *);
60 static gchar *put_string_list(GList *);
61 static void clear_string_list(GList *);
62 static void free_col_info(e_prefs *);
64 #define GPF_NAME "ethereal.conf"
65 #define PF_NAME "preferences"
67 static gboolean init_prefs = TRUE;
68 static gchar *gpf_path = NULL;
71 * XXX - variables to allow us to attempt to interpret the first
72 * "mgcp.{tcp,udp}.port" in a preferences file as
73 * "mgcp.{tcp,udp}.gateway_port" and the second as
74 * "mgcp.{tcp,udp}.callagent_port".
76 static int mgcp_tcp_port_count;
77 static int mgcp_udp_port_count;
81 gchar *gui_ptree_line_style_text[] =
82 { "NONE", "SOLID", "DOTTED", "TABBED", NULL };
84 gchar *gui_ptree_expander_style_text[] =
85 { "NONE", "SQUARE", "TRIANGLE", "CIRCULAR", NULL };
87 gchar *gui_hex_dump_highlight_style_text[] =
88 { "BOLD", "INVERSE", NULL };
91 * List of all modules with preference settings.
93 static GList *modules;
96 * List of all modules that should show up at the top level of the
97 * tree in the preference dialog box.
99 static GList *top_level_modules;
102 module_compare_name(gconstpointer p1_arg, gconstpointer p2_arg)
104 const module_t *p1 = p1_arg;
105 const module_t *p2 = p2_arg;
107 return g_strcasecmp(p1->name, p2->name);
111 module_compare_title(gconstpointer p1_arg, gconstpointer p2_arg)
113 const module_t *p1 = p1_arg;
114 const module_t *p2 = p2_arg;
116 return g_strcasecmp(p1->title, p2->title);
120 * Register a module that will have preferences.
121 * Specify the module under which to register it or NULL to register it
122 * at the top level, the name used for the module in the preferences file,
123 * the title used in the tab for it in a preferences dialog box, and a
124 * routine to call back when we apply the preferences.
127 prefs_register_module(module_t *parent, const char *name, const char *title,
128 void (*apply_cb)(void))
130 return prefs_register_module_or_subtree(parent, name, title, FALSE,
135 * Register a subtree that will have modules under it.
136 * Specify the module under which to register it or NULL to register it
137 * at the top level and the title used in the tab for it in a preferences
141 prefs_register_subtree(module_t *parent, const char *title)
143 return prefs_register_module_or_subtree(parent, NULL, title, TRUE,
148 prefs_register_module_or_subtree(module_t *parent, const char *name,
149 const char *title, gboolean is_subtree, void (*apply_cb)(void))
154 module = g_malloc(sizeof (module_t));
156 module->title = title;
157 module->is_subtree = is_subtree;
158 module->apply_cb = apply_cb;
159 module->prefs = NULL; /* no preferences, to start */
160 module->numprefs = 0;
161 module->prefs_changed = FALSE;
162 module->obsolete = FALSE;
165 * Do we have a module name?
170 * Make sure that only lower-case ASCII letters, numbers,
171 * underscores, hyphens, and dots appear in the name.
173 * Crash if there is, as that's an error in the code;
174 * you can make the title a nice string with capitalization,
175 * white space, punctuation, etc., but the name can be used
176 * on the command line, and shouldn't require quoting,
179 for (p = name; *p != '\0'; p++)
180 g_assert(isascii(*p) &&
181 (islower(*p) || isdigit(*p) || *p == '_' ||
182 *p == '-' || *p == '.'));
185 * Make sure there's not already a module with that
186 * name. Crash if there is, as that's an error in the
187 * code, and the code has to be fixed not to register
188 * more than one module with the same name.
190 * We search the list of all modules; the subtree stuff
191 * doesn't require preferences in subtrees to have names
192 * that reflect the subtree they're in (that would require
193 * protocol preferences to have a bogus "protocol.", or
194 * something such as that, to be added to all their names).
196 g_assert(find_module(name) == NULL);
199 * Insert this module in the list of all modules.
201 modules = g_list_insert_sorted(modules, module,
202 module_compare_name);
205 * This has no name, just a title; check to make sure it's a
206 * subtree, and crash if it's not.
208 g_assert(is_subtree);
212 * Insert this module into the appropriate place in the display
215 if (parent == NULL) {
217 * It goes at the top.
219 top_level_modules = g_list_insert_sorted(top_level_modules,
220 module, module_compare_title);
223 * It goes into the list for this module.
225 parent->prefs = g_list_insert_sorted(parent->prefs, module,
226 module_compare_title);
233 * Register that a protocol has preferences.
235 module_t *protocols_module;
238 prefs_register_protocol(int id, void (*apply_cb)(void))
241 * Have we yet created the "Protocols" subtree?
243 if (protocols_module == NULL) {
247 protocols_module = prefs_register_subtree(NULL, "Protocols");
249 return prefs_register_module(protocols_module,
250 proto_get_protocol_filter_name(id),
251 proto_get_protocol_short_name(id), apply_cb);
255 * Register that a protocol used to have preferences but no longer does,
256 * by creating an "obsolete" module for it.
259 prefs_register_protocol_obsolete(int id)
264 * Have we yet created the "Protocols" subtree?
266 if (protocols_module == NULL) {
270 protocols_module = prefs_register_subtree(NULL, "Protocols");
272 module = prefs_register_module(protocols_module,
273 proto_get_protocol_filter_name(id),
274 proto_get_protocol_short_name(id), NULL);
275 module->obsolete = TRUE;
280 * Find a module, given its name.
283 module_match(gconstpointer a, gconstpointer b)
285 const module_t *module = a;
286 const char *name = b;
288 return strcmp(name, module->name);
292 find_module(const char *name)
296 list_entry = g_list_find_custom(modules, (gpointer)name, module_match);
297 if (list_entry == NULL)
298 return NULL; /* no such module */
299 return (module_t *) list_entry->data;
308 do_module_callback(gpointer data, gpointer user_data)
310 module_t *module = data;
311 module_cb_arg_t *arg = user_data;
313 if (!module->obsolete)
314 (*arg->callback)(module, arg->user_data);
318 * Call a callback function, with a specified argument, for each module
319 * in a list of modules. If the list is NULL, searches the top-level
320 * list in the display tree of modules.
322 * Ignores "obsolete" modules; their sole purpose is to allow old
323 * preferences for dissectors that no longer have preferences to be
324 * silently ignored in preference files. Does not ignore subtrees,
325 * as this can be used when walking the display tree of modules.
328 prefs_module_list_foreach(GList *module_list, module_cb callback,
333 if (module_list == NULL)
334 module_list = top_level_modules;
336 arg.callback = callback;
337 arg.user_data = user_data;
338 g_list_foreach(module_list, do_module_callback, &arg);
342 * Call a callback function, with a specified argument, for each module
343 * in the list of all modules. (This list does not include subtrees.)
345 * Ignores "obsolete" modules; their sole purpose is to allow old
346 * preferences for dissectors that no longer have preferences to be
347 * silently ignored in preference files.
350 prefs_modules_foreach(module_cb callback, gpointer user_data)
352 prefs_module_list_foreach(modules, callback, user_data);
356 call_apply_cb(gpointer data, gpointer user_data _U_)
358 module_t *module = data;
360 if (module->obsolete)
362 if (module->prefs_changed) {
363 if (module->apply_cb != NULL)
364 (*module->apply_cb)();
365 module->prefs_changed = FALSE;
370 * Call the "apply" callback function for each module if any of its
371 * preferences have changed, and then clear the flag saying its
372 * preferences have changed, as the module has been notified of that
376 prefs_apply_all(void)
378 g_list_foreach(modules, call_apply_cb, NULL);
382 * Register a preference in a module's list of preferences.
383 * If it has a title, give it an ordinal number; otherwise, it's a
384 * preference that won't show up in the UI, so it shouldn't get an
385 * ordinal number (the ordinal should be the ordinal in the set of
386 * *visible* preferences).
389 register_preference(module_t *module, const char *name, const char *title,
390 const char *description, pref_type_t type)
395 preference = g_malloc(sizeof (pref_t));
396 preference->name = name;
397 preference->title = title;
398 preference->description = description;
399 preference->type = type;
401 preference->ordinal = module->numprefs;
403 preference->ordinal = -1; /* no ordinal for you */
406 * Make sure that only lower-case ASCII letters, numbers,
407 * underscores, and dots appear in the preference name.
409 * Crash if there is, as that's an error in the code;
410 * you can make the title and description nice strings
411 * with capitalization, white space, punctuation, etc.,
412 * but the name can be used on the command line,
413 * and shouldn't require quoting, shifting, etc.
415 for (p = name; *p != '\0'; p++)
416 g_assert(isascii(*p) &&
417 (islower(*p) || isdigit(*p) || *p == '_' || *p == '.'));
420 * Make sure there's not already a preference with that
421 * name. Crash if there is, as that's an error in the
422 * code, and the code has to be fixed not to register
423 * more than one preference with the same name.
425 g_assert(find_preference(module, name) == NULL);
427 if (type != PREF_OBSOLETE) {
429 * Make sure the preference name doesn't begin with the
430 * module name, as that's redundant and Just Silly.
432 g_assert((strncmp(name, module->name, strlen(module->name)) != 0) ||
433 (((name[strlen(module->name)]) != '.') && ((name[strlen(module->name)]) != '_')));
437 * There isn't already one with that name, so add the
440 module->prefs = g_list_append(module->prefs, preference);
448 * Find a preference in a module's list of preferences, given the module
449 * and the preference's name.
452 preference_match(gconstpointer a, gconstpointer b)
454 const pref_t *pref = a;
455 const char *name = b;
457 return strcmp(name, pref->name);
460 static struct preference *
461 find_preference(module_t *module, const char *name)
465 list_entry = g_list_find_custom(module->prefs, (gpointer)name,
467 if (list_entry == NULL)
468 return NULL; /* no such preference */
469 return (struct preference *) list_entry->data;
473 * Returns TRUE if the given protocol has registered preferences
476 prefs_is_registered_protocol(char *name)
478 module_t *m = find_module(name);
480 return (m != NULL && !m->obsolete);
484 * Returns the module title of a registered protocol
487 prefs_get_title_by_name(char *name)
489 module_t *m = find_module(name);
491 return (m != NULL && !m->obsolete) ? m->title : NULL;
495 * Register a preference with an unsigned integral value.
498 prefs_register_uint_preference(module_t *module, const char *name,
499 const char *title, const char *description, guint base, guint *var)
503 preference = register_preference(module, name, title, description,
505 preference->varp.uint = var;
506 preference->info.base = base;
510 * Register a preference with an Boolean value.
513 prefs_register_bool_preference(module_t *module, const char *name,
514 const char *title, const char *description, gboolean *var)
518 preference = register_preference(module, name, title, description,
520 preference->varp.boolp = var;
524 * Register a preference with an enumerated value.
527 prefs_register_enum_preference(module_t *module, const char *name,
528 const char *title, const char *description, gint *var,
529 const enum_val_t *enumvals, gboolean radio_buttons)
533 preference = register_preference(module, name, title, description,
535 preference->varp.enump = var;
536 preference->info.enum_info.enumvals = enumvals;
537 preference->info.enum_info.radio_buttons = radio_buttons;
541 * Register a preference with a character-string value.
544 prefs_register_string_preference(module_t *module, const char *name,
545 const char *title, const char *description, char **var)
549 preference = register_preference(module, name, title, description,
553 * String preference values should be non-null (as you can't
554 * keep them null after using the preferences GUI, you can at best
555 * have them be null strings) and freeable (as we free them
558 * If the value is a null pointer, make it a copy of a null
559 * string, otherwise make it a copy of the value.
564 *var = g_strdup(*var);
565 preference->varp.string = var;
566 preference->saved_val.string = NULL;
570 * Register a preference that used to be supported but no longer is.
573 prefs_register_obsolete_preference(module_t *module, const char *name)
575 register_preference(module, name, NULL, NULL, PREF_OBSOLETE);
584 do_pref_callback(gpointer data, gpointer user_data)
587 pref_cb_arg_t *arg = user_data;
589 if (pref->type == PREF_OBSOLETE) {
591 * This preference is no longer supported; it's not a
592 * real preference, so we don't call the callback for
593 * it (i.e., we treat it as if it weren't found in the
594 * list of preferences, and we weren't called in the
600 (*arg->callback)(pref, arg->user_data);
604 * Call a callback function, with a specified argument, for each preference
608 prefs_pref_foreach(module_t *module, pref_cb callback, gpointer user_data)
612 arg.callback = callback;
613 arg.user_data = user_data;
614 g_list_foreach(module->prefs, do_pref_callback, &arg);
618 * Register all non-dissector modules' preferences.
621 prefs_register_modules(void)
625 /* Parse through a list of comma-separated, possibly quoted strings.
626 Return a list of the string data. */
628 get_string_list(gchar *str)
630 enum { PRE_STRING, IN_QUOT, NOT_IN_QUOT };
632 gint state = PRE_STRING, i = 0, j = 0;
633 gboolean backslash = FALSE;
638 /* Allocate a buffer for the first string. */
639 slstr = (gchar *) g_malloc(sizeof(gchar) * COL_MAX_LEN);
645 /* It's the end of the input, so it's the end of the string we
646 were working on, and there's no more input. */
647 if (state == IN_QUOT || backslash) {
648 /* We were in the middle of a quoted string or backslash escape,
649 and ran out of characters; that's an error. */
651 clear_string_list(sl);
655 sl = g_list_append(sl, slstr);
658 if (cur_c == '"' && ! backslash) {
661 /* We hadn't yet started processing a string; this starts the
662 string, and we're now quoting. */
666 /* We're in the middle of a quoted string, and we saw a quotation
667 mark; we're no longer quoting. */
671 /* We're working on a string, but haven't seen a quote; we're
678 } else if (cur_c == '\\' && ! backslash) {
679 /* We saw a backslash, and the previous character wasn't a
680 backslash; escape the next character.
682 This also means we've started a new string. */
684 if (state == PRE_STRING)
686 } else if (cur_c == ',' && state != IN_QUOT && ! backslash) {
687 /* We saw a comma, and we're not in the middle of a quoted string
688 and it wasn't preceded by a backslash; it's the end of
689 the string we were working on... */
691 sl = g_list_append(sl, slstr);
693 /* ...and the beginning of a new string. */
695 slstr = (gchar *) g_malloc(sizeof(gchar) * COL_MAX_LEN);
697 } else if (!isspace(cur_c) || state != PRE_STRING) {
698 /* Either this isn't a white-space character, or we've started a
699 string (i.e., already seen a non-white-space character for that
700 string and put it into the string).
702 The character is to be put into the string; do so if there's
704 if (j < COL_MAX_LEN) {
709 /* If it was backslash-escaped, we're done with the backslash escape. */
717 #define MAX_FMT_PREF_LEN 1024
718 #define MAX_FMT_PREF_LINE_LEN 60
720 put_string_list(GList *sl)
722 static gchar pref_str[MAX_FMT_PREF_LEN] = "";
723 GList *clp = g_list_first(sl);
725 int cur_pos = 0, cur_len = 0;
728 gchar *strp, *quoted_strp, c;
734 /* Allocate a buffer big enough to hold the entire string, with each
735 character quoted (that's the worst case). */
736 str_len = strlen(str);
737 quoted_str = g_malloc(str_len*2 + 1);
739 /* Now quote any " or \ characters in it. */
741 quoted_strp = quoted_str;
742 while ((c = *strp++) != '\0') {
743 if (c == '"' || c == '\\') {
744 /* It has to be backslash-quoted. */
745 *quoted_strp++ = '\\';
751 fmt_len = strlen(quoted_str) + 4;
752 if ((fmt_len + cur_len) < (MAX_FMT_PREF_LEN - 1)) {
753 if ((fmt_len + cur_pos) > MAX_FMT_PREF_LINE_LEN) {
757 pref_str[cur_len] = '\n'; cur_len++;
758 pref_str[cur_len] = '\t'; cur_len++;
760 sprintf(&pref_str[cur_len], "\"%s\", ", quoted_str);
768 /* If the string is at least two characters long, the last two characters
769 are ", ", and should be discarded, as there are no more items in the
772 pref_str[cur_len - 2] = '\0';
778 clear_string_list(GList *sl)
784 l = g_list_remove_link(l, l);
789 * Takes a string, a pointer to an array of "enum_val_t"s, and a default gint
791 * The array must be terminated by an entry with a null "name" string.
792 * If the string matches a "name" strings in an entry, the value from that
793 * entry is returned. Otherwise, the default value that was passed as the
794 * third argument is returned.
797 find_val_for_string(const char *needle, const enum_val_t *haystack,
802 while (haystack[i].name != NULL) {
803 if (strcasecmp(needle, haystack[i].name) == 0) {
804 return haystack[i].value;
808 return default_value;
811 /* Takes an string and a pointer to an array of strings, and a default int value.
812 * The array must be terminated by a NULL string. If the string is found in the array
813 * of strings, the index of that string in the array is returned. Otherwise, the
814 * default value that was passed as the third argument is returned.
817 find_index_from_string_array(char *needle, char **haystack, int default_value)
821 while (haystack[i] != NULL) {
822 if (strcmp(needle, haystack[i]) == 0) {
827 return default_value;
830 /* Preferences file format:
831 * - Configuration directives start at the beginning of the line, and
832 * are terminated with a colon.
833 * - Directives can be continued on the next line by preceding them with
838 # This is a comment line
840 print.file: /a/very/long/path/
845 #define MAX_VAR_LEN 48
846 #define MAX_VAL_LEN 1024
848 #define DEF_NUM_COLS 6
850 static int read_prefs_file(const char *pf_path, FILE *pf);
852 /* Read the preferences file, fill in "prefs", and return a pointer to it.
854 If we got an error (other than "it doesn't exist") trying to read
855 the global preferences file, stuff the errno into "*gpf_errno_return"
856 and a pointer to the path of the file into "*gpf_path_return", and
859 If we got an error (other than "it doesn't exist") trying to read
860 the user's preferences file, stuff the errno into "*pf_errno_return"
861 and a pointer to the path of the file into "*pf_path_return", and
864 read_prefs(int *gpf_errno_return, int *gpf_read_errno_return,
865 char **gpf_path_return, int *pf_errno_return,
866 int *pf_read_errno_return, char **pf_path_return)
873 gchar *col_fmt[] = {"No.", "%m", "Time", "%t",
874 "Source", "%s", "Destination", "%d",
875 "Protocol", "%p", "Info", "%i"};
878 /* Initialize preferences to wired-in default values.
879 They may be overridded by the global preferences file or the
880 user's preferences file. */
882 prefs.pr_format = PR_FMT_TEXT;
883 prefs.pr_dest = PR_DEST_CMD;
884 prefs.pr_file = g_strdup("ethereal.out");
885 prefs.pr_cmd = g_strdup("lpr");
886 prefs.col_list = NULL;
887 for (i = 0; i < DEF_NUM_COLS; i++) {
888 cfmt = (fmt_data *) g_malloc(sizeof(fmt_data));
889 cfmt->title = g_strdup(col_fmt[i * 2]);
890 cfmt->fmt = g_strdup(col_fmt[(i * 2) + 1]);
891 prefs.col_list = g_list_append(prefs.col_list, cfmt);
893 prefs.num_cols = DEF_NUM_COLS;
894 prefs.st_client_fg.pixel = 0;
895 prefs.st_client_fg.red = 32767;
896 prefs.st_client_fg.green = 0;
897 prefs.st_client_fg.blue = 0;
898 prefs.st_client_bg.pixel = 65535;
899 prefs.st_client_bg.red = 65535;
900 prefs.st_client_bg.green = 65535;
901 prefs.st_client_bg.blue = 65535;
902 prefs.st_server_fg.pixel = 0;
903 prefs.st_server_fg.red = 0;
904 prefs.st_server_fg.green = 0;
905 prefs.st_server_fg.blue = 32767;
906 prefs.st_server_bg.pixel = 65535;
907 prefs.st_server_bg.red = 65535;
908 prefs.st_server_bg.green = 65535;
909 prefs.st_server_bg.blue = 65535;
910 prefs.gui_scrollbar_on_right = TRUE;
911 prefs.gui_plist_sel_browse = FALSE;
912 prefs.gui_ptree_sel_browse = FALSE;
913 prefs.gui_altern_colors = FALSE;
914 prefs.gui_ptree_line_style = 0;
915 prefs.gui_ptree_expander_style = 1;
916 prefs.gui_hex_dump_highlight_style = 1;
918 prefs.gui_font_name = g_strdup("-*-lucida console-medium-r-*-*-*-100-*-*-*-*-*-*");
921 * XXX - for now, we make the initial font name a pattern that matches
922 * only ISO 8859/1 fonts, so that we don't match 2-byte fonts such
923 * as ISO 10646 fonts.
925 * Users in locales using other one-byte fonts will have to choose
926 * a different font from the preferences dialog - or put the font
927 * selection in the global preferences file to make that font the
928 * default for all users who don't explicitly specify a different
931 * Making this a font set rather than a font has two problems:
933 * 1) as far as I know, you can't select font sets with the
934 * font selection dialog;
936 * 2) if you use a font set, the text to be drawn must be a
937 * multi-byte string in the appropriate locale, but
938 * Ethereal does *NOT* guarantee that's the case - in
939 * the hex-dump window, each character in the text portion
940 * of the display must be a *single* byte, and in the
941 * packet-list and protocol-tree windows, text extracted
942 * from the packet is not necessarily in the right format.
944 * "Doing this right" may, for the packet-list and protocol-tree
945 * windows, require that dissectors know what the locale is
946 * *AND* know what locale and text representation is used in
947 * the packets they're dissecting, and may be impossible in
948 * the hex-dump window (except by punting and displaying only
951 * GTK+ 2.0 may simplify part of the problem, as it will, as I
952 * understand it, use UTF-8-encoded Unicode as its internal
953 * character set; however, we'd still have to know whatever
954 * character set and encoding is used in the packet (which
955 * may differ for different protocols, e.g. SMB might use
956 * PC code pages for some strings and Unicode for others, whilst
957 * NFS might use some UNIX character set encoding, e.g. ISO 8859/x,
958 * or one of the EUC character sets for Asian languages, or one
959 * of the other multi-byte character sets, or UTF-8, or...).
961 * I.e., as far as I can tell, "internationalizing" the packet-list,
962 * protocol-tree, and hex-dump windows involves a lot more than, say,
963 * just using font sets rather than fonts.
965 prefs.gui_font_name = g_strdup("-*-fixed-medium-r-semicondensed-*-*-120-*-*-*-*-iso8859-1");
967 prefs.gui_marked_fg.pixel = 65535;
968 prefs.gui_marked_fg.red = 65535;
969 prefs.gui_marked_fg.green = 65535;
970 prefs.gui_marked_fg.blue = 65535;
971 prefs.gui_marked_bg.pixel = 0;
972 prefs.gui_marked_bg.red = 0;
973 prefs.gui_marked_bg.green = 0;
974 prefs.gui_marked_bg.blue = 0;
975 prefs.gui_geometry_save_position = 0;
976 prefs.gui_geometry_save_size = 1;
977 prefs.gui_geometry_main_x = 20;
978 prefs.gui_geometry_main_y = 20;
979 prefs.gui_geometry_main_width = DEF_WIDTH;
980 prefs.gui_geometry_main_height = -1;
982 /* set the default values for the capture dialog box */
983 prefs.capture_device = NULL;
984 prefs.capture_prom_mode = TRUE;
985 prefs.capture_real_time = FALSE;
986 prefs.capture_auto_scroll = FALSE;
987 prefs.name_resolve = RESOLV_ALL ^ RESOLV_NETWORK;
988 prefs.name_resolve_concurrency = 500;
991 /* Construct the pathname of the global preferences file. */
993 gpf_path = get_datafile_path(GPF_NAME);
995 /* Read the global preferences file, if it exists. */
996 *gpf_path_return = NULL;
997 if ((pf = fopen(gpf_path, "r")) != NULL) {
998 /* We succeeded in opening it; read it. */
999 err = read_prefs_file(gpf_path, pf);
1001 /* We had an error reading the file; return the errno and the
1002 pathname, so our caller can report the error. */
1003 *gpf_errno_return = 0;
1004 *gpf_read_errno_return = err;
1005 *gpf_path_return = gpf_path;
1009 /* We failed to open it. If we failed for some reason other than
1010 "it doesn't exist", return the errno and the pathname, so our
1011 caller can report the error. */
1012 if (errno != ENOENT) {
1013 *gpf_errno_return = errno;
1014 *gpf_read_errno_return = 0;
1015 *gpf_path_return = gpf_path;
1019 /* Construct the pathname of the user's preferences file. */
1020 pf_path = get_persconffile_path(PF_NAME, FALSE);
1022 /* Read the user's preferences file, if it exists. */
1023 *pf_path_return = NULL;
1024 if ((pf = fopen(pf_path, "r")) != NULL) {
1025 /* We succeeded in opening it; read it. */
1026 err = read_prefs_file(pf_path, pf);
1028 /* We had an error reading the file; return the errno and the
1029 pathname, so our caller can report the error. */
1030 *pf_errno_return = 0;
1031 *pf_read_errno_return = err;
1032 *pf_path_return = pf_path;
1037 /* We failed to open it. If we failed for some reason other than
1038 "it doesn't exist", return the errno and the pathname, so our
1039 caller can report the error. */
1040 if (errno != ENOENT) {
1041 *pf_errno_return = errno;
1042 *pf_read_errno_return = 0;
1043 *pf_path_return = pf_path;
1051 read_prefs_file(const char *pf_path, FILE *pf)
1053 enum { START, IN_VAR, PRE_VAL, IN_VAL, IN_SKIP };
1054 gchar cur_var[MAX_VAR_LEN], cur_val[MAX_VAL_LEN];
1055 int got_c, state = START;
1056 gboolean got_val = FALSE;
1057 gint var_len = 0, val_len = 0, fline = 1, pline = 1;
1060 * Start out the counters of "mgcp.{tcp,udp}.port" entries we've
1063 mgcp_tcp_port_count = 0;
1064 mgcp_udp_port_count = 0;
1066 while ((got_c = getc(pf)) != EOF) {
1067 if (got_c == '\n') {
1072 if (var_len >= MAX_VAR_LEN) {
1073 g_warning ("%s line %d: Variable too long", pf_path, fline);
1078 if (val_len >= MAX_VAL_LEN) {
1079 g_warning ("%s line %d: Value too long", pf_path, fline);
1087 if (isalnum(got_c)) {
1090 cur_var[var_len] = '\0';
1091 cur_val[val_len] = '\0';
1092 switch (set_pref(cur_var, cur_val)) {
1094 case PREFS_SET_SYNTAX_ERR:
1095 g_warning ("%s line %d: Syntax error", pf_path, pline);
1098 case PREFS_SET_NO_SUCH_PREF:
1099 g_warning ("%s line %d: No such preference \"%s\"", pf_path,
1103 case PREFS_SET_OBSOLETE:
1104 /* We silently ignore attempts to set these; it's
1105 probably not the user's fault that it's in there -
1106 they may have saved preferences with a release that
1111 g_warning ("%s line %d: Incomplete preference", pf_path, pline);
1119 } else if (isspace(got_c) && var_len > 0 && got_val) {
1121 } else if (got_c == '#') {
1124 g_warning ("%s line %d: Malformed line", pf_path, fline);
1129 cur_var[var_len] = got_c;
1138 if (!isspace(got_c)) {
1140 cur_val[val_len] = got_c;
1146 cur_val[val_len] = got_c;
1149 while (isspace((guchar)cur_val[val_len]) && val_len > 0)
1158 cur_var[var_len] = '\0';
1159 cur_val[val_len] = '\0';
1160 switch (set_pref(cur_var, cur_val)) {
1162 case PREFS_SET_SYNTAX_ERR:
1163 g_warning ("%s line %d: Syntax error", pf_path, pline);
1166 case PREFS_SET_NO_SUCH_PREF:
1167 g_warning ("%s line %d: No such preference \"%s\"", pf_path,
1171 case PREFS_SET_OBSOLETE:
1172 /* We silently ignore attempts to set these; it's probably not
1173 the user's fault that it's in there - they may have saved
1174 preferences with a release that supported it. */
1178 g_warning ("%s line %d: Incomplete preference", pf_path, pline);
1188 * Given a string of the form "<pref name>:<pref value>", as might appear
1189 * as an argument to a "-o" option, parse it and set the preference in
1190 * question. Return an indication of whether it succeeded or failed
1194 prefs_set_pref(char *prefarg)
1200 * Set the counters of "mgcp.{tcp,udp}.port" entries we've
1201 * seen to values that keep us from trying to interpret tham
1202 * as "mgcp.{tcp,udp}.gateway_port" or "mgcp.{tcp,udp}.callagent_port",
1203 * as, from the command line, we have no way of guessing which
1204 * the user had in mind.
1206 mgcp_tcp_port_count = -1;
1207 mgcp_udp_port_count = -1;
1209 colonp = strchr(prefarg, ':');
1211 return PREFS_SET_SYNTAX_ERR;
1217 * Skip over any white space (there probably won't be any, but
1218 * as we allow it in the preferences file, we might as well
1225 * Put the colon back, so if our caller uses, in an
1226 * error message, the string they passed us, the message
1230 return PREFS_SET_SYNTAX_ERR;
1233 ret = set_pref(prefarg, p);
1234 *colonp = ':'; /* put the colon back */
1238 #define PRS_PRINT_FMT "print.format"
1239 #define PRS_PRINT_DEST "print.destination"
1240 #define PRS_PRINT_FILE "print.file"
1241 #define PRS_PRINT_CMD "print.command"
1242 #define PRS_COL_FMT "column.format"
1243 #define PRS_STREAM_CL_FG "stream.client.fg"
1244 #define PRS_STREAM_CL_BG "stream.client.bg"
1245 #define PRS_STREAM_SR_FG "stream.server.fg"
1246 #define PRS_STREAM_SR_BG "stream.server.bg"
1247 #define PRS_GUI_SCROLLBAR_ON_RIGHT "gui.scrollbar_on_right"
1248 #define PRS_GUI_PLIST_SEL_BROWSE "gui.packet_list_sel_browse"
1249 #define PRS_GUI_PTREE_SEL_BROWSE "gui.protocol_tree_sel_browse"
1250 #define PRS_GUI_ALTERN_COLORS "gui.tree_view_altern_colors"
1251 #define PRS_GUI_PTREE_LINE_STYLE "gui.protocol_tree_line_style"
1252 #define PRS_GUI_PTREE_EXPANDER_STYLE "gui.protocol_tree_expander_style"
1253 #define PRS_GUI_HEX_DUMP_HIGHLIGHT_STYLE "gui.hex_dump_highlight_style"
1254 #define PRS_GUI_FONT_NAME "gui.font_name"
1255 #define PRS_GUI_MARKED_FG "gui.marked_frame.fg"
1256 #define PRS_GUI_MARKED_BG "gui.marked_frame.bg"
1257 #define PRS_GUI_GEOMETRY_SAVE_POSITION "gui.geometry.save.position"
1258 #define PRS_GUI_GEOMETRY_SAVE_SIZE "gui.geometry.save.size"
1259 #define PRS_GUI_GEOMETRY_MAIN_X "gui.geometry.main.x"
1260 #define PRS_GUI_GEOMETRY_MAIN_Y "gui.geometry.main.y"
1261 #define PRS_GUI_GEOMETRY_MAIN_WIDTH "gui.geometry.main.width"
1262 #define PRS_GUI_GEOMETRY_MAIN_HEIGHT "gui.geometry.main.height"
1265 * This applies to more than just captures, so it's not "capture.name_resolve";
1266 * "capture.name_resolve" is supported on input for backwards compatibility.
1268 * It's not a preference for a particular part of Ethereal, it's used all
1269 * over the place, so its name doesn't have two components.
1271 #define PRS_NAME_RESOLVE "name_resolve"
1272 #define PRS_NAME_RESOLVE_CONCURRENCY "name_resolve_concurrency"
1273 #define PRS_CAP_NAME_RESOLVE "capture.name_resolve"
1275 /* values for the capture dialog box */
1276 #define PRS_CAP_DEVICE "capture.device"
1277 #define PRS_CAP_PROM_MODE "capture.prom_mode"
1278 #define PRS_CAP_REAL_TIME "capture.real_time_update"
1279 #define PRS_CAP_AUTO_SCROLL "capture.auto_scroll"
1281 #define RED_COMPONENT(x) ((((x) >> 16) & 0xff) * 65535 / 255)
1282 #define GREEN_COMPONENT(x) ((((x) >> 8) & 0xff) * 65535 / 255)
1283 #define BLUE_COMPONENT(x) (((x) & 0xff) * 65535 / 255)
1285 static gchar *pr_formats[] = { "text", "postscript" };
1286 static gchar *pr_dests[] = { "command", "file" };
1291 } name_resolve_opt_t;
1293 static name_resolve_opt_t name_resolve_opt[] = {
1294 { 'm', RESOLV_MAC },
1295 { 'n', RESOLV_NETWORK },
1296 { 't', RESOLV_TRANSPORT },
1297 { 'C', RESOLV_CONCURRENT },
1300 #define N_NAME_RESOLVE_OPT (sizeof name_resolve_opt / sizeof name_resolve_opt[0])
1303 name_resolve_to_string(guint32 name_resolve)
1305 static char string[N_NAME_RESOLVE_OPT+1];
1308 gboolean all_opts_set = TRUE;
1310 if (name_resolve == RESOLV_NONE)
1313 for (i = 0; i < N_NAME_RESOLVE_OPT; i++) {
1314 if (name_resolve & name_resolve_opt[i].value)
1315 *p++ = name_resolve_opt[i].letter;
1317 all_opts_set = FALSE;
1326 string_to_name_resolve(char *string, guint32 *name_resolve)
1332 while ((c = *string++) != '\0') {
1333 for (i = 0; i < N_NAME_RESOLVE_OPT; i++) {
1334 if (c == name_resolve_opt[i].letter) {
1335 *name_resolve |= name_resolve_opt[i].value;
1339 if (i == N_NAME_RESOLVE_OPT) {
1341 * Unrecognized letter.
1350 set_pref(gchar *pref_name, gchar *value)
1352 GList *col_l, *col_l_elt;
1355 unsigned long int cval;
1360 gchar *dotp, *last_dotp;
1365 if (strcmp(pref_name, PRS_PRINT_FMT) == 0) {
1366 if (strcmp(value, pr_formats[PR_FMT_TEXT]) == 0) {
1367 prefs.pr_format = PR_FMT_TEXT;
1368 } else if (strcmp(value, pr_formats[PR_FMT_PS]) == 0) {
1369 prefs.pr_format = PR_FMT_PS;
1371 return PREFS_SET_SYNTAX_ERR;
1373 } else if (strcmp(pref_name, PRS_PRINT_DEST) == 0) {
1374 if (strcmp(value, pr_dests[PR_DEST_CMD]) == 0) {
1375 prefs.pr_dest = PR_DEST_CMD;
1376 } else if (strcmp(value, pr_dests[PR_DEST_FILE]) == 0) {
1377 prefs.pr_dest = PR_DEST_FILE;
1379 return PREFS_SET_SYNTAX_ERR;
1381 } else if (strcmp(pref_name, PRS_PRINT_FILE) == 0) {
1382 if (prefs.pr_file) g_free(prefs.pr_file);
1383 prefs.pr_file = g_strdup(value);
1384 } else if (strcmp(pref_name, PRS_PRINT_CMD) == 0) {
1385 if (prefs.pr_cmd) g_free(prefs.pr_cmd);
1386 prefs.pr_cmd = g_strdup(value);
1387 } else if (strcmp(pref_name, PRS_COL_FMT) == 0) {
1388 col_l = get_string_list(value);
1390 return PREFS_SET_SYNTAX_ERR;
1391 if ((g_list_length(col_l) % 2) != 0) {
1392 /* A title didn't have a matching format. */
1393 clear_string_list(col_l);
1394 return PREFS_SET_SYNTAX_ERR;
1396 /* Check to make sure all column formats are valid. */
1397 col_l_elt = g_list_first(col_l);
1399 /* Make sure the title isn't empty. */
1400 if (strcmp(col_l_elt->data, "") == 0) {
1402 clear_string_list(col_l);
1403 return PREFS_SET_SYNTAX_ERR;
1406 /* Go past the title. */
1407 col_l_elt = col_l_elt->next;
1409 /* Check the format. */
1410 if (get_column_format_from_str(col_l_elt->data) == -1) {
1411 /* It's not a valid column format. */
1412 clear_string_list(col_l);
1413 return PREFS_SET_SYNTAX_ERR;
1416 /* Go past the format. */
1417 col_l_elt = col_l_elt->next;
1419 free_col_info(&prefs);
1420 prefs.col_list = NULL;
1421 llen = g_list_length(col_l);
1422 prefs.num_cols = llen / 2;
1423 col_l_elt = g_list_first(col_l);
1425 cfmt = (fmt_data *) g_malloc(sizeof(fmt_data));
1426 cfmt->title = g_strdup(col_l_elt->data);
1427 col_l_elt = col_l_elt->next;
1428 cfmt->fmt = g_strdup(col_l_elt->data);
1429 col_l_elt = col_l_elt->next;
1430 prefs.col_list = g_list_append(prefs.col_list, cfmt);
1432 clear_string_list(col_l);
1433 } else if (strcmp(pref_name, PRS_STREAM_CL_FG) == 0) {
1434 cval = strtoul(value, NULL, 16);
1435 prefs.st_client_fg.pixel = 0;
1436 prefs.st_client_fg.red = RED_COMPONENT(cval);
1437 prefs.st_client_fg.green = GREEN_COMPONENT(cval);
1438 prefs.st_client_fg.blue = BLUE_COMPONENT(cval);
1439 } else if (strcmp(pref_name, PRS_STREAM_CL_BG) == 0) {
1440 cval = strtoul(value, NULL, 16);
1441 prefs.st_client_bg.pixel = 0;
1442 prefs.st_client_bg.red = RED_COMPONENT(cval);
1443 prefs.st_client_bg.green = GREEN_COMPONENT(cval);
1444 prefs.st_client_bg.blue = BLUE_COMPONENT(cval);
1445 } else if (strcmp(pref_name, PRS_STREAM_SR_FG) == 0) {
1446 cval = strtoul(value, NULL, 16);
1447 prefs.st_server_fg.pixel = 0;
1448 prefs.st_server_fg.red = RED_COMPONENT(cval);
1449 prefs.st_server_fg.green = GREEN_COMPONENT(cval);
1450 prefs.st_server_fg.blue = BLUE_COMPONENT(cval);
1451 } else if (strcmp(pref_name, PRS_STREAM_SR_BG) == 0) {
1452 cval = strtoul(value, NULL, 16);
1453 prefs.st_server_bg.pixel = 0;
1454 prefs.st_server_bg.red = RED_COMPONENT(cval);
1455 prefs.st_server_bg.green = GREEN_COMPONENT(cval);
1456 prefs.st_server_bg.blue = BLUE_COMPONENT(cval);
1457 } else if (strcmp(pref_name, PRS_GUI_SCROLLBAR_ON_RIGHT) == 0) {
1458 if (strcasecmp(value, "true") == 0) {
1459 prefs.gui_scrollbar_on_right = TRUE;
1462 prefs.gui_scrollbar_on_right = FALSE;
1464 } else if (strcmp(pref_name, PRS_GUI_PLIST_SEL_BROWSE) == 0) {
1465 if (strcasecmp(value, "true") == 0) {
1466 prefs.gui_plist_sel_browse = TRUE;
1469 prefs.gui_plist_sel_browse = FALSE;
1471 } else if (strcmp(pref_name, PRS_GUI_PTREE_SEL_BROWSE) == 0) {
1472 if (strcasecmp(value, "true") == 0) {
1473 prefs.gui_ptree_sel_browse = TRUE;
1476 prefs.gui_ptree_sel_browse = FALSE;
1478 } else if (strcmp(pref_name, PRS_GUI_ALTERN_COLORS) == 0) {
1479 if (strcasecmp(value, "true") == 0) {
1480 prefs.gui_altern_colors = TRUE;
1483 prefs.gui_altern_colors = FALSE;
1485 } else if (strcmp(pref_name, PRS_GUI_PTREE_LINE_STYLE) == 0) {
1486 prefs.gui_ptree_line_style =
1487 find_index_from_string_array(value, gui_ptree_line_style_text, 0);
1488 } else if (strcmp(pref_name, PRS_GUI_PTREE_EXPANDER_STYLE) == 0) {
1489 prefs.gui_ptree_expander_style =
1490 find_index_from_string_array(value, gui_ptree_expander_style_text, 1);
1491 } else if (strcmp(pref_name, PRS_GUI_HEX_DUMP_HIGHLIGHT_STYLE) == 0) {
1492 prefs.gui_hex_dump_highlight_style =
1493 find_index_from_string_array(value, gui_hex_dump_highlight_style_text, 1);
1494 } else if (strcmp(pref_name, PRS_GUI_FONT_NAME) == 0) {
1495 if (prefs.gui_font_name != NULL)
1496 g_free(prefs.gui_font_name);
1497 prefs.gui_font_name = g_strdup(value);
1498 } else if (strcmp(pref_name, PRS_GUI_MARKED_FG) == 0) {
1499 cval = strtoul(value, NULL, 16);
1500 prefs.gui_marked_fg.pixel = 0;
1501 prefs.gui_marked_fg.red = RED_COMPONENT(cval);
1502 prefs.gui_marked_fg.green = GREEN_COMPONENT(cval);
1503 prefs.gui_marked_fg.blue = BLUE_COMPONENT(cval);
1504 } else if (strcmp(pref_name, PRS_GUI_MARKED_BG) == 0) {
1505 cval = strtoul(value, NULL, 16);
1506 prefs.gui_marked_bg.pixel = 0;
1507 prefs.gui_marked_bg.red = RED_COMPONENT(cval);
1508 prefs.gui_marked_bg.green = GREEN_COMPONENT(cval);
1509 prefs.gui_marked_bg.blue = BLUE_COMPONENT(cval);
1510 } else if (strcmp(pref_name, PRS_GUI_GEOMETRY_SAVE_POSITION) == 0) {
1511 if (strcasecmp(value, "true") == 0) {
1512 prefs.gui_geometry_save_position = TRUE;
1515 prefs.gui_geometry_save_position = FALSE;
1517 } else if (strcmp(pref_name, PRS_GUI_GEOMETRY_SAVE_SIZE) == 0) {
1518 if (strcasecmp(value, "true") == 0) {
1519 prefs.gui_geometry_save_size = TRUE;
1522 prefs.gui_geometry_save_size = FALSE;
1524 } else if (strcmp(pref_name, PRS_GUI_GEOMETRY_MAIN_X) == 0) {
1525 prefs.gui_geometry_main_x = strtol(value, NULL, 10);
1526 } else if (strcmp(pref_name, PRS_GUI_GEOMETRY_MAIN_Y) == 0) {
1527 prefs.gui_geometry_main_y = strtol(value, NULL, 10);
1528 } else if (strcmp(pref_name, PRS_GUI_GEOMETRY_MAIN_WIDTH) == 0) {
1529 prefs.gui_geometry_main_width = strtol(value, NULL, 10);
1530 } else if (strcmp(pref_name, PRS_GUI_GEOMETRY_MAIN_HEIGHT) == 0) {
1531 prefs.gui_geometry_main_height = strtol(value, NULL, 10);
1533 /* handle the capture options */
1534 } else if (strcmp(pref_name, PRS_CAP_DEVICE) == 0) {
1535 if (prefs.capture_device != NULL)
1536 g_free(prefs.capture_device);
1537 prefs.capture_device = g_strdup(value);
1538 } else if (strcmp(pref_name, PRS_CAP_PROM_MODE) == 0) {
1539 prefs.capture_prom_mode = ((strcasecmp(value, "true") == 0)?TRUE:FALSE);
1540 } else if (strcmp(pref_name, PRS_CAP_REAL_TIME) == 0) {
1541 prefs.capture_real_time = ((strcasecmp(value, "true") == 0)?TRUE:FALSE);
1542 } else if (strcmp(pref_name, PRS_CAP_AUTO_SCROLL) == 0) {
1543 prefs.capture_auto_scroll = ((strcasecmp(value, "true") == 0)?TRUE:FALSE);
1545 /* handle the global options */
1546 } else if (strcmp(pref_name, PRS_NAME_RESOLVE) == 0 ||
1547 strcmp(pref_name, PRS_CAP_NAME_RESOLVE) == 0) {
1549 * "TRUE" and "FALSE", for backwards compatibility, are synonyms for
1550 * RESOLV_ALL and RESOLV_NONE.
1552 * Otherwise, we treat it as a list of name types we want to resolve.
1554 if (strcasecmp(value, "true") == 0)
1555 prefs.name_resolve = RESOLV_ALL;
1556 else if (strcasecmp(value, "false") == 0)
1557 prefs.name_resolve = RESOLV_NONE;
1559 prefs.name_resolve = RESOLV_NONE; /* start out with none set */
1560 if (string_to_name_resolve(value, &prefs.name_resolve) != '\0')
1561 return PREFS_SET_SYNTAX_ERR;
1563 } else if (strcmp(pref_name, PRS_NAME_RESOLVE_CONCURRENCY) == 0) {
1564 prefs.name_resolve_concurrency = strtol(value, NULL, 10);
1566 /* To which module does this preference belong? */
1568 last_dotp = pref_name;
1571 dotp = strchr(last_dotp, '.');
1574 /* no such module */
1575 return PREFS_SET_NO_SUCH_PREF;
1578 /* no ".", so no module/name separator */
1579 return PREFS_SET_SYNTAX_ERR;
1585 *dotp = '\0'; /* separate module and preference name */
1586 module = find_module(pref_name);
1589 * XXX - "Diameter" rather than "diameter" was used in earlier
1590 * versions of Ethereal; if we didn't find the module, and its name
1591 * was "Diameter", look for "diameter" instead.
1593 * In addition, the BEEP protocol used to be the BXXP protocol,
1594 * so if we didn't find the module, and its name was "bxxp",
1595 * look for "beep" instead.
1597 * Also, the preferences for GTP v0 and v1 were combined under
1598 * a single "gtp" heading.
1600 if (module == NULL) {
1601 if (strcmp(pref_name, "Diameter") == 0)
1602 module = find_module("diameter");
1603 else if (strcmp(pref_name, "bxxp") == 0)
1604 module = find_module("beep");
1605 else if (strcmp(pref_name, "gtpv0") == 0 ||
1606 strcmp(pref_name, "gtpv1") == 0)
1607 module = find_module("gtp");
1609 *dotp = '.'; /* put the preference string back */
1610 dotp++; /* skip past separator to preference name */
1614 pref = find_preference(module, dotp);
1617 if (strcmp(module->name, "mgcp") == 0) {
1619 * XXX - "mgcp.display raw text toggle" and "mgcp.display dissect tree"
1620 * rather than "mgcp.display_raw_text" and "mgcp.display_dissect_tree"
1621 * were used in earlier versions of Ethereal; if we didn't find the
1622 * preference, it was an MGCP preference, and its name was
1623 * "display raw text toggle" or "display dissect tree", look for
1624 * "display_raw_text" or "display_dissect_tree" instead.
1626 * "mgcp.tcp.port" and "mgcp.udp.port" are harder to handle, as both
1627 * the gateway and callagent ports were given those names; we interpret
1628 * the first as "mgcp.{tcp,udp}.gateway_port" and the second as
1629 * "mgcp.{tcp,udp}.callagent_port", as that's the order in which
1630 * they were registered by the MCCP dissector and thus that's the
1631 * order in which they were written to the preferences file. (If
1632 * we're not reading the preferences file, but are handling stuff
1633 * from a "-o" command-line option, we have no clue which the user
1634 * had in mind - they should have used "mgcp.{tcp,udp}.gateway_port"
1635 * or "mgcp.{tcp,udp}.callagent_port" instead.)
1637 if (strcmp(dotp, "display raw text toggle") == 0)
1638 pref = find_preference(module, "display_raw_text");
1639 else if (strcmp(dotp, "display dissect tree") == 0)
1640 pref = find_preference(module, "display_dissect_tree");
1641 else if (strcmp(dotp, "tcp.port") == 0) {
1642 mgcp_tcp_port_count++;
1643 if (mgcp_tcp_port_count == 1) {
1644 /* It's the first one */
1645 pref = find_preference(module, "tcp.gateway_port");
1646 } else if (mgcp_tcp_port_count == 2) {
1647 /* It's the second one */
1648 pref = find_preference(module, "tcp.callagent_port");
1650 /* Otherwise it's from the command line, and we don't bother
1652 } else if (strcmp(dotp, "udp.port") == 0) {
1653 mgcp_udp_port_count++;
1654 if (mgcp_udp_port_count == 1) {
1655 /* It's the first one */
1656 pref = find_preference(module, "udp.gateway_port");
1657 } else if (mgcp_udp_port_count == 2) {
1658 /* It's the second one */
1659 pref = find_preference(module, "udp.callagent_port");
1661 /* Otherwise it's from the command line, and we don't bother
1664 } else if (strcmp(module->name, "smb") == 0) {
1665 /* Handle old names for SMB preferences. */
1666 if (strcmp(dotp, "smb.trans.reassembly") == 0)
1667 pref = find_preference(module, "trans_reassembly");
1668 else if (strcmp(dotp, "smb.dcerpc.reassembly") == 0)
1669 pref = find_preference(module, "dcerpc_reassembly");
1670 } else if (strcmp(module->name, "ndmp") == 0) {
1671 /* Handle old names for NDMP preferences. */
1672 if (strcmp(dotp, "ndmp.desegment") == 0)
1673 pref = find_preference(module, "desegment");
1674 } else if (strcmp(module->name, "diameter") == 0) {
1675 /* Handle old names for Diameter preferences. */
1676 if (strcmp(dotp, "diameter.desegment") == 0)
1677 pref = find_preference(module, "desegment");
1678 } else if (strcmp(module->name, "pcli") == 0) {
1679 /* Handle old names for PCLI preferences. */
1680 if (strcmp(dotp, "pcli.udp_port") == 0)
1681 pref = find_preference(module, "udp_port");
1682 } else if (strcmp(module->name, "artnet") == 0) {
1683 /* Handle old names for ARTNET preferences. */
1684 if (strcmp(dotp, "artnet.udp_port") == 0)
1685 pref = find_preference(module, "udp_port");
1686 } else if (strcmp(module->name, "mapi") == 0) {
1687 /* Handle old names for MAPI preferences. */
1688 if (strcmp(dotp, "mapi_decrypt") == 0)
1689 pref = find_preference(module, "decrypt");
1690 } else if (strcmp(module->name, "fc") == 0) {
1691 /* Handle old names for Fibre Channel preferences. */
1692 if (strcmp(dotp, "reassemble_fc") == 0)
1693 pref = find_preference(module, "reassemble");
1694 else if (strcmp(dotp, "fc_max_frame_size") == 0)
1695 pref = find_preference(module, "max_frame_size");
1696 } else if (strcmp(module->name, "fcip") == 0) {
1697 /* Handle old names for Fibre Channel-over-IP preferences. */
1698 if (strcmp(dotp, "desegment_fcip_messages") == 0)
1699 pref = find_preference(module, "desegment");
1700 else if (strcmp(dotp, "fcip_port") == 0)
1701 pref = find_preference(module, "target_port");
1702 } else if (strcmp(module->name, "gtp") == 0) {
1703 /* Handle old names for GTP preferences. */
1704 if (strcmp(dotp, "gtpv0_port") == 0)
1705 pref = find_preference(module, "v0_port");
1706 else if (strcmp(dotp, "gtpv1c_port") == 0)
1707 pref = find_preference(module, "v1c_port");
1708 else if (strcmp(dotp, "gtpv1u_port") == 0)
1709 pref = find_preference(module, "v1u_port");
1710 else if (strcmp(dotp, "gtp_dissect_tpdu") == 0)
1711 pref = find_preference(module, "dissect_tpdu");
1712 else if (strcmp(dotp, "gtpv0_dissect_cdr_as") == 0)
1713 pref = find_preference(module, "v0_dissect_cdr_as");
1714 else if (strcmp(dotp, "gtpv0_check_etsi") == 0)
1715 pref = find_preference(module, "v0_check_etsi");
1716 else if (strcmp(dotp, "gtpv1_check_etsi") == 0)
1717 pref = find_preference(module, "v1_check_etsi");
1718 } else if (strcmp(module->name, "ip") == 0) {
1719 /* Handle old names for IP preferences. */
1720 if (strcmp(dotp, "ip_summary_in_tree") == 0)
1721 pref = find_preference(module, "summary_in_tree");
1722 } else if (strcmp(module->name, "iscsi") == 0) {
1723 /* Handle old names for iSCSI preferences. */
1724 if (strcmp(dotp, "iscsi_port") == 0)
1725 pref = find_preference(module, "target_port");
1726 } else if (strcmp(module->name, "lmp") == 0) {
1727 /* Handle old names for LMP preferences. */
1728 if (strcmp(dotp, "lmp_version") == 0)
1729 pref = find_preference(module, "version");
1730 } else if (strcmp(module->name, "mtp3") == 0) {
1731 /* Handle old names for MTP3 preferences. */
1732 if (strcmp(dotp, "mtp3_standard") == 0)
1733 pref = find_preference(module, "standard");
1734 } else if (strcmp(module->name, "nlm") == 0) {
1735 /* Handle old names for NLM preferences. */
1736 if (strcmp(dotp, "nlm_msg_res_matching") == 0)
1737 pref = find_preference(module, "msg_res_matching");
1738 } else if (strcmp(module->name, "ppp") == 0) {
1739 /* Handle old names for PPP preferences. */
1740 if (strcmp(dotp, "ppp_fcs") == 0)
1741 pref = find_preference(module, "fcs_type");
1742 else if (strcmp(dotp, "ppp_vj") == 0)
1743 pref = find_preference(module, "decompress_vj");
1744 } else if (strcmp(module->name, "rsvp") == 0) {
1745 /* Handle old names for RSVP preferences. */
1746 if (strcmp(dotp, "rsvp_process_bundle") == 0)
1747 pref = find_preference(module, "process_bundle");
1748 } else if (strcmp(module->name, "tcp") == 0) {
1749 /* Handle old names for TCP preferences. */
1750 if (strcmp(dotp, "tcp_summary_in_tree") == 0)
1751 pref = find_preference(module, "summary_in_tree");
1752 else if (strcmp(dotp, "tcp_analyze_sequence_numbers") == 0)
1753 pref = find_preference(module, "analyze_sequence_numbers");
1754 else if (strcmp(dotp, "tcp_relative_sequence_numbers") == 0)
1755 pref = find_preference(module, "relative_sequence_numbers");
1756 } else if (strcmp(module->name, "udp") == 0) {
1757 /* Handle old names for UDP preferences. */
1758 if (strcmp(dotp, "udp_summary_in_tree") == 0)
1759 pref = find_preference(module, "summary_in_tree");
1760 } else if (strcmp(module->name, "ndps") == 0) {
1761 /* Handle old names for NDPS preferences. */
1762 if (strcmp(dotp, "desegment_ndps") == 0)
1763 pref = find_preference(module, "desegment_tcp");
1767 return PREFS_SET_NO_SUCH_PREF; /* no such preference */
1769 switch (pref->type) {
1772 uval = strtoul(value, &p, pref->info.base);
1773 if (p == value || *p != '\0')
1774 return PREFS_SET_SYNTAX_ERR; /* number was bad */
1775 if (*pref->varp.uint != uval) {
1776 module->prefs_changed = TRUE;
1777 *pref->varp.uint = uval;
1782 /* XXX - give an error if it's neither "true" nor "false"? */
1783 if (strcasecmp(value, "true") == 0)
1787 if (*pref->varp.boolp != bval) {
1788 module->prefs_changed = TRUE;
1789 *pref->varp.boolp = bval;
1794 /* XXX - give an error if it doesn't match? */
1795 enum_val = find_val_for_string(value,
1796 pref->info.enum_info.enumvals, 1);
1797 if (*pref->varp.enump != enum_val) {
1798 module->prefs_changed = TRUE;
1799 *pref->varp.enump = enum_val;
1804 if (strcmp(*pref->varp.string, value) != 0) {
1805 module->prefs_changed = TRUE;
1806 g_free(*pref->varp.string);
1807 *pref->varp.string = g_strdup(value);
1812 return PREFS_SET_OBSOLETE; /* no such preference any more */
1816 return PREFS_SET_OK;
1825 * Write out a single preference.
1828 write_pref(gpointer data, gpointer user_data)
1830 pref_t *pref = data;
1831 write_pref_arg_t *arg = user_data;
1832 const enum_val_t *enum_valp;
1833 const char *val_string;
1835 if (pref->type == PREF_OBSOLETE) {
1837 * This preference is no longer supported; it's not a
1838 * real preference, so we don't write it out (i.e., we
1839 * treat it as if it weren't found in the list of
1840 * preferences, and we weren't called in the first place).
1845 fprintf(arg->pf, "\n# %s\n", pref->description);
1847 switch (pref->type) {
1850 switch (pref->info.base) {
1853 fprintf(arg->pf, "# A decimal number.\n");
1854 fprintf(arg->pf, "%s.%s: %u\n", arg->module->name,
1855 pref->name, *pref->varp.uint);
1859 fprintf(arg->pf, "# An octal number.\n");
1860 fprintf(arg->pf, "%s.%s: %#o\n", arg->module->name,
1861 pref->name, *pref->varp.uint);
1865 fprintf(arg->pf, "# A hexadecimal number.\n");
1866 fprintf(arg->pf, "%s.%s: %#x\n", arg->module->name,
1867 pref->name, *pref->varp.uint);
1873 fprintf(arg->pf, "# TRUE or FALSE (case-insensitive).\n");
1874 fprintf(arg->pf, "%s.%s: %s\n", arg->module->name, pref->name,
1875 *pref->varp.boolp ? "TRUE" : "FALSE");
1879 fprintf(arg->pf, "# One of: ");
1880 enum_valp = pref->info.enum_info.enumvals;
1882 while (enum_valp->name != NULL) {
1883 if (enum_valp->value == *pref->varp.enump)
1884 val_string = enum_valp->name;
1885 fprintf(arg->pf, "%s", enum_valp->name);
1887 if (enum_valp->name == NULL)
1888 fprintf(arg->pf, "\n");
1890 fprintf(arg->pf, ", ");
1892 fprintf(arg->pf, "# (case-insensitive).\n");
1893 fprintf(arg->pf, "%s.%s: %s\n", arg->module->name, pref->name,
1898 fprintf(arg->pf, "# A string.\n");
1899 fprintf(arg->pf, "%s.%s: %s\n", arg->module->name, pref->name,
1900 *pref->varp.string);
1904 g_assert_not_reached();
1910 write_module_prefs(gpointer data, gpointer user_data)
1912 write_pref_arg_t arg;
1916 g_list_foreach(arg.module->prefs, write_pref, &arg);
1919 /* Write out "prefs" to the user's preferences file, and return 0.
1921 If we got an error, stuff a pointer to the path of the preferences file
1922 into "*pf_path_return", and return the errno. */
1924 write_prefs(char **pf_path_return)
1932 * - Split output lines longer than MAX_VAL_LEN
1933 * - Create a function for the preference directory check/creation
1934 * so that duplication can be avoided with filter.c
1937 pf_path = get_persconffile_path(PF_NAME, TRUE);
1938 if ((pf = fopen(pf_path, "w")) == NULL) {
1939 *pf_path_return = pf_path;
1943 fputs("# Configuration file for Ethereal " VERSION ".\n"
1945 "# This file is regenerated each time preferences are saved within\n"
1946 "# Ethereal. Making manual changes should be safe, however.\n"
1948 "######## Printing ########\n"
1951 fprintf (pf, "# Can be one of \"text\" or \"postscript\".\n"
1952 "print.format: %s\n\n", pr_formats[prefs.pr_format]);
1954 fprintf (pf, "# Can be one of \"command\" or \"file\".\n"
1955 "print.destination: %s\n\n", pr_dests[prefs.pr_dest]);
1957 fprintf (pf, "# This is the file that gets written to when the "
1958 "destination is set to \"file\"\n"
1959 "%s: %s\n\n", PRS_PRINT_FILE, prefs.pr_file);
1961 fprintf (pf, "# Output gets piped to this command when the destination "
1962 "is set to \"command\"\n"
1963 "%s: %s\n\n", PRS_PRINT_CMD, prefs.pr_cmd);
1965 clp = prefs.col_list;
1968 cfmt = (fmt_data *) clp->data;
1969 col_l = g_list_append(col_l, cfmt->title);
1970 col_l = g_list_append(col_l, cfmt->fmt);
1973 fprintf (pf, "# Packet list column format. Each pair of strings consists "
1974 "of a column title \n# and its format.\n"
1975 "%s: %s\n\n", PRS_COL_FMT, put_string_list(col_l));
1976 /* This frees the list of strings, but not the strings to which it
1977 refers; that's what we want, as we haven't copied those strings,
1978 we just referred to them. */
1981 fprintf (pf, "# TCP stream window color preferences. Each value is a six "
1982 "digit hexadecimal value in the form rrggbb.\n");
1983 fprintf (pf, "%s: %02x%02x%02x\n", PRS_STREAM_CL_FG,
1984 (prefs.st_client_fg.red * 255 / 65535),
1985 (prefs.st_client_fg.green * 255 / 65535),
1986 (prefs.st_client_fg.blue * 255 / 65535));
1987 fprintf (pf, "%s: %02x%02x%02x\n", PRS_STREAM_CL_BG,
1988 (prefs.st_client_bg.red * 255 / 65535),
1989 (prefs.st_client_bg.green * 255 / 65535),
1990 (prefs.st_client_bg.blue * 255 / 65535));
1991 fprintf (pf, "%s: %02x%02x%02x\n", PRS_STREAM_SR_FG,
1992 (prefs.st_server_fg.red * 255 / 65535),
1993 (prefs.st_server_fg.green * 255 / 65535),
1994 (prefs.st_server_fg.blue * 255 / 65535));
1995 fprintf (pf, "%s: %02x%02x%02x\n", PRS_STREAM_SR_BG,
1996 (prefs.st_server_bg.red * 255 / 65535),
1997 (prefs.st_server_bg.green * 255 / 65535),
1998 (prefs.st_server_bg.blue * 255 / 65535));
2000 fprintf(pf, "\n# Vertical scrollbars should be on right side? TRUE/FALSE\n");
2001 fprintf(pf, PRS_GUI_SCROLLBAR_ON_RIGHT ": %s\n",
2002 prefs.gui_scrollbar_on_right == TRUE ? "TRUE" : "FALSE");
2004 fprintf(pf, "\n# Packet-list selection bar can be used to browse w/o selecting? TRUE/FALSE\n");
2005 fprintf(pf, PRS_GUI_PLIST_SEL_BROWSE ": %s\n",
2006 prefs.gui_plist_sel_browse == TRUE ? "TRUE" : "FALSE");
2008 fprintf(pf, "\n# Protocol-tree selection bar can be used to browse w/o selecting? TRUE/FALSE\n");
2009 fprintf(pf, PRS_GUI_PTREE_SEL_BROWSE ": %s\n",
2010 prefs.gui_ptree_sel_browse == TRUE ? "TRUE" : "FALSE");
2012 fprintf(pf, "\n# Alternating colors in TreeViews\n");
2013 fprintf(pf, PRS_GUI_ALTERN_COLORS ": %s\n",
2014 prefs.gui_altern_colors == TRUE ? "TRUE" : "FALSE");
2016 fprintf(pf, "\n# Protocol-tree line style. One of: NONE, SOLID, DOTTED, TABBED\n");
2017 fprintf(pf, PRS_GUI_PTREE_LINE_STYLE ": %s\n",
2018 gui_ptree_line_style_text[prefs.gui_ptree_line_style]);
2020 fprintf(pf, "\n# Protocol-tree expander style. One of: NONE, SQUARE, TRIANGLE, CIRCULAR\n");
2021 fprintf(pf, PRS_GUI_PTREE_EXPANDER_STYLE ": %s\n",
2022 gui_ptree_expander_style_text[prefs.gui_ptree_expander_style]);
2024 fprintf(pf, "\n# Hex dump highlight style. One of: BOLD, INVERSE\n");
2025 fprintf(pf, PRS_GUI_HEX_DUMP_HIGHLIGHT_STYLE ": %s\n",
2026 gui_hex_dump_highlight_style_text[prefs.gui_hex_dump_highlight_style]);
2028 fprintf(pf, "\n# Font name for packet list, protocol tree, and hex dump panes.\n");
2029 fprintf(pf, PRS_GUI_FONT_NAME ": %s\n", prefs.gui_font_name);
2031 fprintf (pf, "\n# Color preferences for a marked frame. Each value is a six "
2032 "digit hexadecimal value in the form rrggbb.\n");
2033 fprintf (pf, "%s: %02x%02x%02x\n", PRS_GUI_MARKED_FG,
2034 (prefs.gui_marked_fg.red * 255 / 65535),
2035 (prefs.gui_marked_fg.green * 255 / 65535),
2036 (prefs.gui_marked_fg.blue * 255 / 65535));
2037 fprintf (pf, "%s: %02x%02x%02x\n", PRS_GUI_MARKED_BG,
2038 (prefs.gui_marked_bg.red * 255 / 65535),
2039 (prefs.gui_marked_bg.green * 255 / 65535),
2040 (prefs.gui_marked_bg.blue * 255 / 65535));
2042 fprintf(pf, "\n# Save window position at exit? TRUE/FALSE\n");
2043 fprintf(pf, PRS_GUI_GEOMETRY_SAVE_POSITION ": %s\n",
2044 prefs.gui_geometry_save_position == TRUE ? "TRUE" : "FALSE");
2046 fprintf(pf, "\n# Save window size at exit? TRUE/FALSE\n");
2047 fprintf(pf, PRS_GUI_GEOMETRY_SAVE_SIZE ": %s\n",
2048 prefs.gui_geometry_save_size == TRUE ? "TRUE" : "FALSE");
2050 fprintf(pf, "\n# Main window geometry. Decimal integers.\n");
2051 fprintf(pf, PRS_GUI_GEOMETRY_MAIN_X ": %d\n", prefs.gui_geometry_main_x);
2052 fprintf(pf, PRS_GUI_GEOMETRY_MAIN_Y ": %d\n", prefs.gui_geometry_main_y);
2053 fprintf(pf, PRS_GUI_GEOMETRY_MAIN_WIDTH ": %d\n",
2054 prefs.gui_geometry_main_width);
2055 fprintf(pf, PRS_GUI_GEOMETRY_MAIN_HEIGHT ": %d\n",
2056 prefs.gui_geometry_main_height);
2058 fprintf(pf, "\n# Resolve addresses to names? TRUE/FALSE/{list of address types to resolve}\n");
2059 fprintf(pf, PRS_NAME_RESOLVE ": %s\n",
2060 name_resolve_to_string(prefs.name_resolve));
2061 fprintf(pf, "\n# Name resolution concurrency Decimal integer.\n");
2062 fprintf(pf, PRS_NAME_RESOLVE_CONCURRENCY ": %d\n",
2063 prefs.name_resolve_concurrency);
2065 /* write the capture options */
2066 if (prefs.capture_device != NULL) {
2067 fprintf(pf, "\n# Default capture device\n");
2068 fprintf(pf, PRS_CAP_DEVICE ": %s\n", prefs.capture_device);
2071 fprintf(pf, "\n# Capture in promiscuous mode? TRUE/FALSE\n");
2072 fprintf(pf, PRS_CAP_PROM_MODE ": %s\n",
2073 prefs.capture_prom_mode == TRUE ? "TRUE" : "FALSE");
2075 fprintf(pf, "\n# Update packet list in real time during capture? TRUE/FALSE\n");
2076 fprintf(pf, PRS_CAP_REAL_TIME ": %s\n",
2077 prefs.capture_real_time == TRUE ? "TRUE" : "FALSE");
2079 fprintf(pf, "\n# scroll packet list during capture? TRUE/FALSE\n");
2080 fprintf(pf, PRS_CAP_AUTO_SCROLL ": %s\n",
2081 prefs.capture_auto_scroll == TRUE ? "TRUE" : "FALSE");
2083 g_list_foreach(modules, write_module_prefs, pf);
2087 /* XXX - catch I/O errors (e.g. "ran out of disk space") and return
2088 an error indication, or maybe write to a new preferences file and
2089 rename that file on top of the old one only if there are not I/O
2094 /* Copy a set of preferences. */
2096 copy_prefs(e_prefs *dest, e_prefs *src)
2098 fmt_data *src_cfmt, *dest_cfmt;
2101 dest->pr_format = src->pr_format;
2102 dest->pr_dest = src->pr_dest;
2103 dest->pr_file = g_strdup(src->pr_file);
2104 dest->pr_cmd = g_strdup(src->pr_cmd);
2105 dest->col_list = NULL;
2106 for (entry = src->col_list; entry != NULL; entry = g_list_next(entry)) {
2107 src_cfmt = entry->data;
2108 dest_cfmt = (fmt_data *) g_malloc(sizeof(fmt_data));
2109 dest_cfmt->title = g_strdup(src_cfmt->title);
2110 dest_cfmt->fmt = g_strdup(src_cfmt->fmt);
2111 dest->col_list = g_list_append(dest->col_list, dest_cfmt);
2113 dest->num_cols = src->num_cols;
2114 dest->st_client_fg = src->st_client_fg;
2115 dest->st_client_bg = src->st_client_bg;
2116 dest->st_server_fg = src->st_server_fg;
2117 dest->st_server_bg = src->st_server_bg;
2118 dest->gui_scrollbar_on_right = src->gui_scrollbar_on_right;
2119 dest->gui_plist_sel_browse = src->gui_plist_sel_browse;
2120 dest->gui_ptree_sel_browse = src->gui_ptree_sel_browse;
2121 dest->gui_altern_colors = src->gui_altern_colors;
2122 dest->gui_ptree_line_style = src->gui_ptree_line_style;
2123 dest->gui_ptree_expander_style = src->gui_ptree_expander_style;
2124 dest->gui_hex_dump_highlight_style = src->gui_hex_dump_highlight_style;
2125 dest->gui_font_name = g_strdup(src->gui_font_name);
2126 dest->gui_marked_fg = src->gui_marked_fg;
2127 dest->gui_marked_bg = src->gui_marked_bg;
2128 dest->gui_geometry_save_position = src->gui_geometry_save_position;
2129 dest->gui_geometry_save_size = src->gui_geometry_save_size;
2130 dest->gui_geometry_main_x = src->gui_geometry_main_x;
2131 dest->gui_geometry_main_y = src->gui_geometry_main_y;
2132 dest->gui_geometry_main_width = src->gui_geometry_main_width;
2133 dest->gui_geometry_main_height = src->gui_geometry_main_height;
2134 /* values for the capture dialog box */
2135 dest->capture_device = g_strdup(src->capture_device);
2136 dest->capture_prom_mode = src->capture_prom_mode;
2137 dest->capture_real_time = src->capture_real_time;
2138 dest->capture_auto_scroll = src->capture_auto_scroll;
2139 dest->name_resolve = src->name_resolve;
2140 dest->name_resolve_concurrency = src->name_resolve_concurrency;
2144 /* Free a set of preferences. */
2146 free_prefs(e_prefs *pr)
2148 if (pr->pr_file != NULL) {
2149 g_free(pr->pr_file);
2152 if (pr->pr_cmd != NULL) {
2157 if (pr->gui_font_name != NULL) {
2158 g_free(pr->gui_font_name);
2159 pr->gui_font_name = NULL;
2161 if (pr->capture_device != NULL) {
2162 g_free(pr->capture_device);
2163 pr->capture_device = NULL;
2168 free_col_info(e_prefs *pr)
2172 while (pr->col_list != NULL) {
2173 cfmt = pr->col_list->data;
2174 g_free(cfmt->title);
2177 pr->col_list = g_list_remove_link(pr->col_list, pr->col_list);
2179 g_list_free(pr->col_list);
2180 pr->col_list = NULL;