2 * Routines for handling preferences
4 * $Id: prefs.c,v 1.95 2003/01/29 21:27:36 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, 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 == '_' ||
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);
436 * There isn't already one with that name, so add the
439 module->prefs = g_list_append(module->prefs, preference);
447 * Find a preference in a module's list of preferences, given the module
448 * and the preference's name.
451 preference_match(gconstpointer a, gconstpointer b)
453 const pref_t *pref = a;
454 const char *name = b;
456 return strcmp(name, pref->name);
459 static struct preference *
460 find_preference(module_t *module, const char *name)
464 list_entry = g_list_find_custom(module->prefs, (gpointer)name,
466 if (list_entry == NULL)
467 return NULL; /* no such preference */
468 return (struct preference *) list_entry->data;
472 * Returns TRUE if the given protocol has registered preferences
475 prefs_is_registered_protocol(char *name)
477 module_t *m = find_module(name);
479 return (m != NULL && !m->obsolete);
483 * Returns the module title of a registered protocol
486 prefs_get_title_by_name(char *name)
488 module_t *m = find_module(name);
490 return (m != NULL && !m->obsolete) ? m->title : NULL;
494 * Register a preference with an unsigned integral value.
497 prefs_register_uint_preference(module_t *module, const char *name,
498 const char *title, const char *description, guint base, guint *var)
502 preference = register_preference(module, name, title, description,
504 preference->varp.uint = var;
505 preference->info.base = base;
509 * Register a preference with an Boolean value.
512 prefs_register_bool_preference(module_t *module, const char *name,
513 const char *title, const char *description, gboolean *var)
517 preference = register_preference(module, name, title, description,
519 preference->varp.boolp = var;
523 * Register a preference with an enumerated value.
526 prefs_register_enum_preference(module_t *module, const char *name,
527 const char *title, const char *description, gint *var,
528 const enum_val_t *enumvals, gboolean radio_buttons)
532 preference = register_preference(module, name, title, description,
534 preference->varp.enump = var;
535 preference->info.enum_info.enumvals = enumvals;
536 preference->info.enum_info.radio_buttons = radio_buttons;
540 * Register a preference with a character-string value.
543 prefs_register_string_preference(module_t *module, const char *name,
544 const char *title, const char *description, char **var)
548 preference = register_preference(module, name, title, description,
550 preference->varp.string = var;
551 preference->saved_val.string = NULL;
555 * Register a preference that used to be supported but no longer is.
558 prefs_register_obsolete_preference(module_t *module, const char *name)
560 register_preference(module, name, NULL, NULL, PREF_OBSOLETE);
569 do_pref_callback(gpointer data, gpointer user_data)
572 pref_cb_arg_t *arg = user_data;
574 if (pref->type == PREF_OBSOLETE) {
576 * This preference is no longer supported; it's not a
577 * real preference, so we don't call the callback for
578 * it (i.e., we treat it as if it weren't found in the
579 * list of preferences, and we weren't called in the
585 (*arg->callback)(pref, arg->user_data);
589 * Call a callback function, with a specified argument, for each preference
593 prefs_pref_foreach(module_t *module, pref_cb callback, gpointer user_data)
597 arg.callback = callback;
598 arg.user_data = user_data;
599 g_list_foreach(module->prefs, do_pref_callback, &arg);
603 * Register all non-dissector modules' preferences.
606 prefs_register_modules(void)
610 /* Parse through a list of comma-separated, possibly quoted strings.
611 Return a list of the string data. */
613 get_string_list(gchar *str)
615 enum { PRE_STRING, IN_QUOT, NOT_IN_QUOT };
617 gint state = PRE_STRING, i = 0, j = 0;
618 gboolean backslash = FALSE;
623 /* Allocate a buffer for the first string. */
624 slstr = (gchar *) g_malloc(sizeof(gchar) * COL_MAX_LEN);
630 /* It's the end of the input, so it's the end of the string we
631 were working on, and there's no more input. */
632 if (state == IN_QUOT || backslash) {
633 /* We were in the middle of a quoted string or backslash escape,
634 and ran out of characters; that's an error. */
636 clear_string_list(sl);
640 sl = g_list_append(sl, slstr);
643 if (cur_c == '"' && ! backslash) {
646 /* We hadn't yet started processing a string; this starts the
647 string, and we're now quoting. */
651 /* We're in the middle of a quoted string, and we saw a quotation
652 mark; we're no longer quoting. */
656 /* We're working on a string, but haven't seen a quote; we're
663 } else if (cur_c == '\\' && ! backslash) {
664 /* We saw a backslash, and the previous character wasn't a
665 backslash; escape the next character.
667 This also means we've started a new string. */
669 if (state == PRE_STRING)
671 } else if (cur_c == ',' && state != IN_QUOT && ! backslash) {
672 /* We saw a comma, and we're not in the middle of a quoted string
673 and it wasn't preceded by a backslash; it's the end of
674 the string we were working on... */
676 sl = g_list_append(sl, slstr);
678 /* ...and the beginning of a new string. */
680 slstr = (gchar *) g_malloc(sizeof(gchar) * COL_MAX_LEN);
682 } else if (!isspace(cur_c) || state != PRE_STRING) {
683 /* Either this isn't a white-space character, or we've started a
684 string (i.e., already seen a non-white-space character for that
685 string and put it into the string).
687 The character is to be put into the string; do so if there's
689 if (j < COL_MAX_LEN) {
694 /* If it was backslash-escaped, we're done with the backslash escape. */
702 #define MAX_FMT_PREF_LEN 1024
703 #define MAX_FMT_PREF_LINE_LEN 60
705 put_string_list(GList *sl)
707 static gchar pref_str[MAX_FMT_PREF_LEN] = "";
708 GList *clp = g_list_first(sl);
710 int cur_pos = 0, cur_len = 0;
713 gchar *strp, *quoted_strp, c;
719 /* Allocate a buffer big enough to hold the entire string, with each
720 character quoted (that's the worst case). */
721 str_len = strlen(str);
722 quoted_str = g_malloc(str_len*2 + 1);
724 /* Now quote any " or \ characters in it. */
726 quoted_strp = quoted_str;
727 while ((c = *strp++) != '\0') {
728 if (c == '"' || c == '\\') {
729 /* It has to be backslash-quoted. */
730 *quoted_strp++ = '\\';
736 fmt_len = strlen(quoted_str) + 4;
737 if ((fmt_len + cur_len) < (MAX_FMT_PREF_LEN - 1)) {
738 if ((fmt_len + cur_pos) > MAX_FMT_PREF_LINE_LEN) {
742 pref_str[cur_len] = '\n'; cur_len++;
743 pref_str[cur_len] = '\t'; cur_len++;
745 sprintf(&pref_str[cur_len], "\"%s\", ", quoted_str);
753 /* If the string is at least two characters long, the last two characters
754 are ", ", and should be discarded, as there are no more items in the
757 pref_str[cur_len - 2] = '\0';
763 clear_string_list(GList *sl)
769 l = g_list_remove_link(l, l);
774 * Takes a string, a pointer to an array of "enum_val_t"s, and a default gint
776 * The array must be terminated by an entry with a null "name" string.
777 * If the string matches a "name" strings in an entry, the value from that
778 * entry is returned. Otherwise, the default value that was passed as the
779 * third argument is returned.
782 find_val_for_string(const char *needle, const enum_val_t *haystack,
787 while (haystack[i].name != NULL) {
788 if (strcasecmp(needle, haystack[i].name) == 0) {
789 return haystack[i].value;
793 return default_value;
796 /* Takes an string and a pointer to an array of strings, and a default int value.
797 * The array must be terminated by a NULL string. If the string is found in the array
798 * of strings, the index of that string in the array is returned. Otherwise, the
799 * default value that was passed as the third argument is returned.
802 find_index_from_string_array(char *needle, char **haystack, int default_value)
806 while (haystack[i] != NULL) {
807 if (strcmp(needle, haystack[i]) == 0) {
812 return default_value;
815 /* Preferences file format:
816 * - Configuration directives start at the beginning of the line, and
817 * are terminated with a colon.
818 * - Directives can be continued on the next line by preceding them with
823 # This is a comment line
825 print.file: /a/very/long/path/
830 #define MAX_VAR_LEN 48
831 #define MAX_VAL_LEN 1024
833 #define DEF_NUM_COLS 6
835 static void read_prefs_file(const char *pf_path, FILE *pf);
837 /* Read the preferences file, fill in "prefs", and return a pointer to it.
839 If we got an error (other than "it doesn't exist") trying to read
840 the global preferences file, stuff the errno into "*gpf_errno_return"
841 and a pointer to the path of the file into "*gpf_path_return", and
844 If we got an error (other than "it doesn't exist") trying to read
845 the user's preferences file, stuff the errno into "*pf_errno_return"
846 and a pointer to the path of the file into "*pf_path_return", and
849 read_prefs(int *gpf_errno_return, char **gpf_path_return,
850 int *pf_errno_return, char **pf_path_return)
856 gchar *col_fmt[] = {"No.", "%m", "Time", "%t",
857 "Source", "%s", "Destination", "%d",
858 "Protocol", "%p", "Info", "%i"};
861 /* Initialize preferences to wired-in default values.
862 They may be overridded by the global preferences file or the
863 user's preferences file. */
865 prefs.pr_format = PR_FMT_TEXT;
866 prefs.pr_dest = PR_DEST_CMD;
867 prefs.pr_file = g_strdup("ethereal.out");
868 prefs.pr_cmd = g_strdup("lpr");
869 prefs.col_list = NULL;
870 for (i = 0; i < DEF_NUM_COLS; i++) {
871 cfmt = (fmt_data *) g_malloc(sizeof(fmt_data));
872 cfmt->title = g_strdup(col_fmt[i * 2]);
873 cfmt->fmt = g_strdup(col_fmt[(i * 2) + 1]);
874 prefs.col_list = g_list_append(prefs.col_list, cfmt);
876 prefs.num_cols = DEF_NUM_COLS;
877 prefs.st_client_fg.pixel = 0;
878 prefs.st_client_fg.red = 32767;
879 prefs.st_client_fg.green = 0;
880 prefs.st_client_fg.blue = 0;
881 prefs.st_client_bg.pixel = 65535;
882 prefs.st_client_bg.red = 65535;
883 prefs.st_client_bg.green = 65535;
884 prefs.st_client_bg.blue = 65535;
885 prefs.st_server_fg.pixel = 0;
886 prefs.st_server_fg.red = 0;
887 prefs.st_server_fg.green = 0;
888 prefs.st_server_fg.blue = 32767;
889 prefs.st_server_bg.pixel = 65535;
890 prefs.st_server_bg.red = 65535;
891 prefs.st_server_bg.green = 65535;
892 prefs.st_server_bg.blue = 65535;
893 prefs.gui_scrollbar_on_right = TRUE;
894 prefs.gui_plist_sel_browse = FALSE;
895 prefs.gui_ptree_sel_browse = FALSE;
896 prefs.gui_altern_colors = FALSE;
897 prefs.gui_ptree_line_style = 0;
898 prefs.gui_ptree_expander_style = 1;
899 prefs.gui_hex_dump_highlight_style = 1;
901 prefs.gui_font_name = g_strdup("-*-lucida console-medium-r-*-*-*-100-*-*-*-*-*-*");
904 * XXX - for now, we make the initial font name a pattern that matches
905 * only ISO 8859/1 fonts, so that we don't match 2-byte fonts such
906 * as ISO 10646 fonts.
908 * Users in locales using other one-byte fonts will have to choose
909 * a different font from the preferences dialog - or put the font
910 * selection in the global preferences file to make that font the
911 * default for all users who don't explicitly specify a different
914 * Making this a font set rather than a font has two problems:
916 * 1) as far as I know, you can't select font sets with the
917 * font selection dialog;
919 * 2) if you use a font set, the text to be drawn must be a
920 * multi-byte string in the appropriate locale, but
921 * Ethereal does *NOT* guarantee that's the case - in
922 * the hex-dump window, each character in the text portion
923 * of the display must be a *single* byte, and in the
924 * packet-list and protocol-tree windows, text extracted
925 * from the packet is not necessarily in the right format.
927 * "Doing this right" may, for the packet-list and protocol-tree
928 * windows, require that dissectors know what the locale is
929 * *AND* know what locale and text representation is used in
930 * the packets they're dissecting, and may be impossible in
931 * the hex-dump window (except by punting and displaying only
934 * GTK+ 2.0 may simplify part of the problem, as it will, as I
935 * understand it, use UTF-8-encoded Unicode as its internal
936 * character set; however, we'd still have to know whatever
937 * character set and encoding is used in the packet (which
938 * may differ for different protocols, e.g. SMB might use
939 * PC code pages for some strings and Unicode for others, whilst
940 * NFS might use some UNIX character set encoding, e.g. ISO 8859/x,
941 * or one of the EUC character sets for Asian languages, or one
942 * of the other multi-byte character sets, or UTF-8, or...).
944 * I.e., as far as I can tell, "internationalizing" the packet-list,
945 * protocol-tree, and hex-dump windows involves a lot more than, say,
946 * just using font sets rather than fonts.
948 prefs.gui_font_name = g_strdup("-*-fixed-medium-r-semicondensed-*-*-120-*-*-*-*-iso8859-1");
950 prefs.gui_marked_fg.pixel = 65535;
951 prefs.gui_marked_fg.red = 65535;
952 prefs.gui_marked_fg.green = 65535;
953 prefs.gui_marked_fg.blue = 65535;
954 prefs.gui_marked_bg.pixel = 0;
955 prefs.gui_marked_bg.red = 0;
956 prefs.gui_marked_bg.green = 0;
957 prefs.gui_marked_bg.blue = 0;
958 prefs.gui_geometry_save_position = 0;
959 prefs.gui_geometry_save_size = 1;
960 prefs.gui_geometry_main_x = 20;
961 prefs.gui_geometry_main_y = 20;
962 prefs.gui_geometry_main_width = DEF_WIDTH;
963 prefs.gui_geometry_main_height = -1;
965 /* set the default values for the capture dialog box */
966 prefs.capture_device = NULL;
967 prefs.capture_prom_mode = TRUE;
968 prefs.capture_real_time = FALSE;
969 prefs.capture_auto_scroll = FALSE;
970 prefs.name_resolve = RESOLV_ALL ^ RESOLV_NETWORK;
973 /* Construct the pathname of the global preferences file. */
975 gpf_path = (gchar *) g_malloc(strlen(get_datafile_dir()) +
976 strlen(GPF_NAME) + 2);
977 sprintf(gpf_path, "%s" G_DIR_SEPARATOR_S "%s",
978 get_datafile_dir(), GPF_NAME);
981 /* Read the global preferences file, if it exists. */
982 *gpf_path_return = NULL;
983 if ((pf = fopen(gpf_path, "r")) != NULL) {
984 /* We succeeded in opening it; read it. */
985 read_prefs_file(gpf_path, pf);
988 /* We failed to open it. If we failed for some reason other than
989 "it doesn't exist", return the errno and the pathname, so our
990 caller can report the error. */
991 if (errno != ENOENT) {
992 *gpf_errno_return = errno;
993 *gpf_path_return = gpf_path;
997 /* Construct the pathname of the user's preferences file. */
998 pf_path = get_persconffile_path(PF_NAME, FALSE);
1000 /* Read the user's preferences file, if it exists. */
1001 *pf_path_return = NULL;
1002 if ((pf = fopen(pf_path, "r")) != NULL) {
1003 /* We succeeded in opening it; read it. */
1004 read_prefs_file(pf_path, pf);
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 *pf_errno_return = errno;
1014 *pf_path_return = pf_path;
1022 read_prefs_file(const char *pf_path, FILE *pf)
1024 enum { START, IN_VAR, PRE_VAL, IN_VAL, IN_SKIP };
1025 gchar cur_var[MAX_VAR_LEN], cur_val[MAX_VAL_LEN];
1026 int got_c, state = START;
1027 gboolean got_val = FALSE;
1028 gint var_len = 0, val_len = 0, fline = 1, pline = 1;
1031 * Start out the counters of "mgcp.{tcp,udp}.port" entries we've
1034 mgcp_tcp_port_count = 0;
1035 mgcp_udp_port_count = 0;
1037 while ((got_c = getc(pf)) != EOF) {
1038 if (got_c == '\n') {
1043 if (var_len >= MAX_VAR_LEN) {
1044 g_warning ("%s line %d: Variable too long", pf_path, fline);
1049 if (val_len >= MAX_VAL_LEN) {
1050 g_warning ("%s line %d: Value too long", pf_path, fline);
1058 if (isalnum(got_c)) {
1061 cur_var[var_len] = '\0';
1062 cur_val[val_len] = '\0';
1063 switch (set_pref(cur_var, cur_val)) {
1065 case PREFS_SET_SYNTAX_ERR:
1066 g_warning ("%s line %d: Syntax error", pf_path, pline);
1069 case PREFS_SET_NO_SUCH_PREF:
1070 g_warning ("%s line %d: No such preference \"%s\"", pf_path,
1074 case PREFS_SET_OBSOLETE:
1075 /* We silently ignore attempts to set these; it's
1076 probably not the user's fault that it's in there -
1077 they may have saved preferences with a release that
1082 g_warning ("%s line %d: Incomplete preference", pf_path, pline);
1090 } else if (isspace(got_c) && var_len > 0 && got_val) {
1092 } else if (got_c == '#') {
1095 g_warning ("%s line %d: Malformed line", pf_path, fline);
1100 cur_var[var_len] = got_c;
1109 if (!isspace(got_c)) {
1111 cur_val[val_len] = got_c;
1117 cur_val[val_len] = got_c;
1120 while (isspace((guchar)cur_val[val_len]) && val_len > 0)
1129 cur_var[var_len] = '\0';
1130 cur_val[val_len] = '\0';
1131 switch (set_pref(cur_var, cur_val)) {
1133 case PREFS_SET_SYNTAX_ERR:
1134 g_warning ("%s line %d: Syntax error", pf_path, pline);
1137 case PREFS_SET_NO_SUCH_PREF:
1138 g_warning ("%s line %d: No such preference \"%s\"", pf_path,
1142 case PREFS_SET_OBSOLETE:
1143 /* We silently ignore attempts to set these; it's probably not
1144 the user's fault that it's in there - they may have saved
1145 preferences with a release that supported it. */
1149 g_warning ("%s line %d: Incomplete preference", pf_path, pline);
1155 * Given a string of the form "<pref name>:<pref value>", as might appear
1156 * as an argument to a "-o" option, parse it and set the preference in
1157 * question. Return an indication of whether it succeeded or failed
1161 prefs_set_pref(char *prefarg)
1167 * Set the counters of "mgcp.{tcp,udp}.port" entries we've
1168 * seen to values that keep us from trying to interpret tham
1169 * as "mgcp.{tcp,udp}.gateway_port" or "mgcp.{tcp,udp}.callagent_port",
1170 * as, from the command line, we have no way of guessing which
1171 * the user had in mind.
1173 mgcp_tcp_port_count = -1;
1174 mgcp_udp_port_count = -1;
1176 colonp = strchr(prefarg, ':');
1178 return PREFS_SET_SYNTAX_ERR;
1184 * Skip over any white space (there probably won't be any, but
1185 * as we allow it in the preferences file, we might as well
1192 * Put the colon back, so if our caller uses, in an
1193 * error message, the string they passed us, the message
1197 return PREFS_SET_SYNTAX_ERR;
1200 ret = set_pref(prefarg, p);
1201 *colonp = ':'; /* put the colon back */
1205 #define PRS_PRINT_FMT "print.format"
1206 #define PRS_PRINT_DEST "print.destination"
1207 #define PRS_PRINT_FILE "print.file"
1208 #define PRS_PRINT_CMD "print.command"
1209 #define PRS_COL_FMT "column.format"
1210 #define PRS_STREAM_CL_FG "stream.client.fg"
1211 #define PRS_STREAM_CL_BG "stream.client.bg"
1212 #define PRS_STREAM_SR_FG "stream.server.fg"
1213 #define PRS_STREAM_SR_BG "stream.server.bg"
1214 #define PRS_GUI_SCROLLBAR_ON_RIGHT "gui.scrollbar_on_right"
1215 #define PRS_GUI_PLIST_SEL_BROWSE "gui.packet_list_sel_browse"
1216 #define PRS_GUI_PTREE_SEL_BROWSE "gui.protocol_tree_sel_browse"
1217 #define PRS_GUI_ALTERN_COLORS "gui.tree_view_altern_colors"
1218 #define PRS_GUI_PTREE_LINE_STYLE "gui.protocol_tree_line_style"
1219 #define PRS_GUI_PTREE_EXPANDER_STYLE "gui.protocol_tree_expander_style"
1220 #define PRS_GUI_HEX_DUMP_HIGHLIGHT_STYLE "gui.hex_dump_highlight_style"
1221 #define PRS_GUI_FONT_NAME "gui.font_name"
1222 #define PRS_GUI_MARKED_FG "gui.marked_frame.fg"
1223 #define PRS_GUI_MARKED_BG "gui.marked_frame.bg"
1224 #define PRS_GUI_GEOMETRY_SAVE_POSITION "gui.geometry.save.position"
1225 #define PRS_GUI_GEOMETRY_SAVE_SIZE "gui.geometry.save.size"
1226 #define PRS_GUI_GEOMETRY_MAIN_X "gui.geometry.main.x"
1227 #define PRS_GUI_GEOMETRY_MAIN_Y "gui.geometry.main.y"
1228 #define PRS_GUI_GEOMETRY_MAIN_WIDTH "gui.geometry.main.width"
1229 #define PRS_GUI_GEOMETRY_MAIN_HEIGHT "gui.geometry.main.height"
1232 * This applies to more than just captures, so it's not "capture.name_resolve";
1233 * "capture.name_resolve" is supported on input for backwards compatibility.
1235 * It's not a preference for a particular part of Ethereal, it's used all
1236 * over the place, so its name doesn't have two components.
1238 #define PRS_NAME_RESOLVE "name_resolve"
1239 #define PRS_CAP_NAME_RESOLVE "capture.name_resolve"
1241 /* values for the capture dialog box */
1242 #define PRS_CAP_DEVICE "capture.device"
1243 #define PRS_CAP_PROM_MODE "capture.prom_mode"
1244 #define PRS_CAP_REAL_TIME "capture.real_time_update"
1245 #define PRS_CAP_AUTO_SCROLL "capture.auto_scroll"
1247 #define RED_COMPONENT(x) ((((x) >> 16) & 0xff) * 65535 / 255)
1248 #define GREEN_COMPONENT(x) ((((x) >> 8) & 0xff) * 65535 / 255)
1249 #define BLUE_COMPONENT(x) (((x) & 0xff) * 65535 / 255)
1251 static gchar *pr_formats[] = { "text", "postscript" };
1252 static gchar *pr_dests[] = { "command", "file" };
1257 } name_resolve_opt_t;
1259 static name_resolve_opt_t name_resolve_opt[] = {
1260 { 'm', RESOLV_MAC },
1261 { 'n', RESOLV_NETWORK },
1262 { 't', RESOLV_TRANSPORT },
1265 #define N_NAME_RESOLVE_OPT (sizeof name_resolve_opt / sizeof name_resolve_opt[0])
1268 name_resolve_to_string(guint32 name_resolve)
1270 static char string[N_NAME_RESOLVE_OPT+1];
1273 gboolean all_opts_set = TRUE;
1275 if (name_resolve == RESOLV_NONE)
1278 for (i = 0; i < N_NAME_RESOLVE_OPT; i++) {
1279 if (name_resolve & name_resolve_opt[i].value)
1280 *p++ = name_resolve_opt[i].letter;
1282 all_opts_set = FALSE;
1291 string_to_name_resolve(char *string, guint32 *name_resolve)
1297 while ((c = *string++) != '\0') {
1298 for (i = 0; i < N_NAME_RESOLVE_OPT; i++) {
1299 if (c == name_resolve_opt[i].letter) {
1300 *name_resolve |= name_resolve_opt[i].value;
1304 if (i == N_NAME_RESOLVE_OPT) {
1306 * Unrecognized letter.
1315 set_pref(gchar *pref_name, gchar *value)
1317 GList *col_l, *col_l_elt;
1320 unsigned long int cval;
1325 gchar *dotp, *last_dotp;
1330 if (strcmp(pref_name, PRS_PRINT_FMT) == 0) {
1331 if (strcmp(value, pr_formats[PR_FMT_TEXT]) == 0) {
1332 prefs.pr_format = PR_FMT_TEXT;
1333 } else if (strcmp(value, pr_formats[PR_FMT_PS]) == 0) {
1334 prefs.pr_format = PR_FMT_PS;
1336 return PREFS_SET_SYNTAX_ERR;
1338 } else if (strcmp(pref_name, PRS_PRINT_DEST) == 0) {
1339 if (strcmp(value, pr_dests[PR_DEST_CMD]) == 0) {
1340 prefs.pr_dest = PR_DEST_CMD;
1341 } else if (strcmp(value, pr_dests[PR_DEST_FILE]) == 0) {
1342 prefs.pr_dest = PR_DEST_FILE;
1344 return PREFS_SET_SYNTAX_ERR;
1346 } else if (strcmp(pref_name, PRS_PRINT_FILE) == 0) {
1347 if (prefs.pr_file) g_free(prefs.pr_file);
1348 prefs.pr_file = g_strdup(value);
1349 } else if (strcmp(pref_name, PRS_PRINT_CMD) == 0) {
1350 if (prefs.pr_cmd) g_free(prefs.pr_cmd);
1351 prefs.pr_cmd = g_strdup(value);
1352 } else if (strcmp(pref_name, PRS_COL_FMT) == 0) {
1353 col_l = get_string_list(value);
1355 return PREFS_SET_SYNTAX_ERR;
1356 if ((g_list_length(col_l) % 2) != 0) {
1357 /* A title didn't have a matching format. */
1358 clear_string_list(col_l);
1359 return PREFS_SET_SYNTAX_ERR;
1361 /* Check to make sure all column formats are valid. */
1362 col_l_elt = g_list_first(col_l);
1364 /* Make sure the title isn't empty. */
1365 if (strcmp(col_l_elt->data, "") == 0) {
1367 clear_string_list(col_l);
1368 return PREFS_SET_SYNTAX_ERR;
1371 /* Go past the title. */
1372 col_l_elt = col_l_elt->next;
1374 /* Check the format. */
1375 if (get_column_format_from_str(col_l_elt->data) == -1) {
1376 /* It's not a valid column format. */
1377 clear_string_list(col_l);
1378 return PREFS_SET_SYNTAX_ERR;
1381 /* Go past the format. */
1382 col_l_elt = col_l_elt->next;
1384 free_col_info(&prefs);
1385 prefs.col_list = NULL;
1386 llen = g_list_length(col_l);
1387 prefs.num_cols = llen / 2;
1388 col_l_elt = g_list_first(col_l);
1390 cfmt = (fmt_data *) g_malloc(sizeof(fmt_data));
1391 cfmt->title = g_strdup(col_l_elt->data);
1392 col_l_elt = col_l_elt->next;
1393 cfmt->fmt = g_strdup(col_l_elt->data);
1394 col_l_elt = col_l_elt->next;
1395 prefs.col_list = g_list_append(prefs.col_list, cfmt);
1397 clear_string_list(col_l);
1398 } else if (strcmp(pref_name, PRS_STREAM_CL_FG) == 0) {
1399 cval = strtoul(value, NULL, 16);
1400 prefs.st_client_fg.pixel = 0;
1401 prefs.st_client_fg.red = RED_COMPONENT(cval);
1402 prefs.st_client_fg.green = GREEN_COMPONENT(cval);
1403 prefs.st_client_fg.blue = BLUE_COMPONENT(cval);
1404 } else if (strcmp(pref_name, PRS_STREAM_CL_BG) == 0) {
1405 cval = strtoul(value, NULL, 16);
1406 prefs.st_client_bg.pixel = 0;
1407 prefs.st_client_bg.red = RED_COMPONENT(cval);
1408 prefs.st_client_bg.green = GREEN_COMPONENT(cval);
1409 prefs.st_client_bg.blue = BLUE_COMPONENT(cval);
1410 } else if (strcmp(pref_name, PRS_STREAM_SR_FG) == 0) {
1411 cval = strtoul(value, NULL, 16);
1412 prefs.st_server_fg.pixel = 0;
1413 prefs.st_server_fg.red = RED_COMPONENT(cval);
1414 prefs.st_server_fg.green = GREEN_COMPONENT(cval);
1415 prefs.st_server_fg.blue = BLUE_COMPONENT(cval);
1416 } else if (strcmp(pref_name, PRS_STREAM_SR_BG) == 0) {
1417 cval = strtoul(value, NULL, 16);
1418 prefs.st_server_bg.pixel = 0;
1419 prefs.st_server_bg.red = RED_COMPONENT(cval);
1420 prefs.st_server_bg.green = GREEN_COMPONENT(cval);
1421 prefs.st_server_bg.blue = BLUE_COMPONENT(cval);
1422 } else if (strcmp(pref_name, PRS_GUI_SCROLLBAR_ON_RIGHT) == 0) {
1423 if (strcasecmp(value, "true") == 0) {
1424 prefs.gui_scrollbar_on_right = TRUE;
1427 prefs.gui_scrollbar_on_right = FALSE;
1429 } else if (strcmp(pref_name, PRS_GUI_PLIST_SEL_BROWSE) == 0) {
1430 if (strcasecmp(value, "true") == 0) {
1431 prefs.gui_plist_sel_browse = TRUE;
1434 prefs.gui_plist_sel_browse = FALSE;
1436 } else if (strcmp(pref_name, PRS_GUI_PTREE_SEL_BROWSE) == 0) {
1437 if (strcasecmp(value, "true") == 0) {
1438 prefs.gui_ptree_sel_browse = TRUE;
1441 prefs.gui_ptree_sel_browse = FALSE;
1443 } else if (strcmp(pref_name, PRS_GUI_ALTERN_COLORS) == 0) {
1444 if (strcasecmp(value, "true") == 0) {
1445 prefs.gui_altern_colors = TRUE;
1448 prefs.gui_altern_colors = FALSE;
1450 } else if (strcmp(pref_name, PRS_GUI_PTREE_LINE_STYLE) == 0) {
1451 prefs.gui_ptree_line_style =
1452 find_index_from_string_array(value, gui_ptree_line_style_text, 0);
1453 } else if (strcmp(pref_name, PRS_GUI_PTREE_EXPANDER_STYLE) == 0) {
1454 prefs.gui_ptree_expander_style =
1455 find_index_from_string_array(value, gui_ptree_expander_style_text, 1);
1456 } else if (strcmp(pref_name, PRS_GUI_HEX_DUMP_HIGHLIGHT_STYLE) == 0) {
1457 prefs.gui_hex_dump_highlight_style =
1458 find_index_from_string_array(value, gui_hex_dump_highlight_style_text, 1);
1459 } else if (strcmp(pref_name, PRS_GUI_FONT_NAME) == 0) {
1460 if (prefs.gui_font_name != NULL)
1461 g_free(prefs.gui_font_name);
1462 prefs.gui_font_name = g_strdup(value);
1463 } else if (strcmp(pref_name, PRS_GUI_MARKED_FG) == 0) {
1464 cval = strtoul(value, NULL, 16);
1465 prefs.gui_marked_fg.pixel = 0;
1466 prefs.gui_marked_fg.red = RED_COMPONENT(cval);
1467 prefs.gui_marked_fg.green = GREEN_COMPONENT(cval);
1468 prefs.gui_marked_fg.blue = BLUE_COMPONENT(cval);
1469 } else if (strcmp(pref_name, PRS_GUI_MARKED_BG) == 0) {
1470 cval = strtoul(value, NULL, 16);
1471 prefs.gui_marked_bg.pixel = 0;
1472 prefs.gui_marked_bg.red = RED_COMPONENT(cval);
1473 prefs.gui_marked_bg.green = GREEN_COMPONENT(cval);
1474 prefs.gui_marked_bg.blue = BLUE_COMPONENT(cval);
1475 } else if (strcmp(pref_name, PRS_GUI_GEOMETRY_SAVE_POSITION) == 0) {
1476 if (strcasecmp(value, "true") == 0) {
1477 prefs.gui_geometry_save_position = TRUE;
1480 prefs.gui_geometry_save_position = FALSE;
1482 } else if (strcmp(pref_name, PRS_GUI_GEOMETRY_SAVE_SIZE) == 0) {
1483 if (strcasecmp(value, "true") == 0) {
1484 prefs.gui_geometry_save_size = TRUE;
1487 prefs.gui_geometry_save_size = FALSE;
1489 } else if (strcmp(pref_name, PRS_GUI_GEOMETRY_MAIN_X) == 0) {
1490 prefs.gui_geometry_main_x = strtol(value, NULL, 10);
1491 } else if (strcmp(pref_name, PRS_GUI_GEOMETRY_MAIN_Y) == 0) {
1492 prefs.gui_geometry_main_y = strtol(value, NULL, 10);
1493 } else if (strcmp(pref_name, PRS_GUI_GEOMETRY_MAIN_WIDTH) == 0) {
1494 prefs.gui_geometry_main_width = strtol(value, NULL, 10);
1495 } else if (strcmp(pref_name, PRS_GUI_GEOMETRY_MAIN_HEIGHT) == 0) {
1496 prefs.gui_geometry_main_height = strtol(value, NULL, 10);
1498 /* handle the capture options */
1499 } else if (strcmp(pref_name, PRS_CAP_DEVICE) == 0) {
1500 if (prefs.capture_device != NULL)
1501 g_free(prefs.capture_device);
1502 prefs.capture_device = g_strdup(value);
1503 } else if (strcmp(pref_name, PRS_CAP_PROM_MODE) == 0) {
1504 prefs.capture_prom_mode = ((strcasecmp(value, "true") == 0)?TRUE:FALSE);
1505 } else if (strcmp(pref_name, PRS_CAP_REAL_TIME) == 0) {
1506 prefs.capture_real_time = ((strcasecmp(value, "true") == 0)?TRUE:FALSE);
1507 } else if (strcmp(pref_name, PRS_CAP_AUTO_SCROLL) == 0) {
1508 prefs.capture_auto_scroll = ((strcasecmp(value, "true") == 0)?TRUE:FALSE);
1510 /* handle the global options */
1511 } else if (strcmp(pref_name, PRS_NAME_RESOLVE) == 0 ||
1512 strcmp(pref_name, PRS_CAP_NAME_RESOLVE) == 0) {
1514 * "TRUE" and "FALSE", for backwards compatibility, are synonyms for
1515 * RESOLV_ALL and RESOLV_NONE.
1517 * Otherwise, we treat it as a list of name types we want to resolve.
1519 if (strcasecmp(value, "true") == 0)
1520 prefs.name_resolve = RESOLV_ALL;
1521 else if (strcasecmp(value, "false") == 0)
1522 prefs.name_resolve = RESOLV_NONE;
1524 prefs.name_resolve = RESOLV_NONE; /* start out with none set */
1525 if (string_to_name_resolve(value, &prefs.name_resolve) != '\0')
1526 return PREFS_SET_SYNTAX_ERR;
1529 /* To which module does this preference belong? */
1531 last_dotp = pref_name;
1534 dotp = strchr(last_dotp, '.');
1537 /* no such module */
1538 return PREFS_SET_NO_SUCH_PREF;
1541 /* no ".", so no module/name separator */
1542 return PREFS_SET_SYNTAX_ERR;
1548 *dotp = '\0'; /* separate module and preference name */
1549 module = find_module(pref_name);
1552 * XXX - "Diameter" rather than "diameter" was used in earlier
1553 * versions of Ethereal; if we didn't find the module, and its name
1554 * was "Diameter", look for "diameter" instead.
1556 * In addition, the BEEP protocol used to be the BXXP protocol,
1557 * so if we didn't find the module, and its name was "bxxp",
1558 * look for "beep" instead.
1560 * Also, the preferences for GTP v0 and v1 were combined under
1561 * a single "gtp" heading.
1563 if (module == NULL) {
1564 if (strcmp(pref_name, "Diameter") == 0)
1565 module = find_module("diameter");
1566 else if (strcmp(pref_name, "bxxp") == 0)
1567 module = find_module("beep");
1568 else if (strcmp(pref_name, "gtpv0") == 0 ||
1569 strcmp(pref_name, "gtpv1") == 0)
1570 module = find_module("gtp");
1572 *dotp = '.'; /* put the preference string back */
1573 dotp++; /* skip past separator to preference name */
1577 pref = find_preference(module, dotp);
1580 if (strncmp(pref_name, "mgcp.", 5) == 0) {
1582 * XXX - "mgcp.display raw text toggle" and "mgcp.display dissect tree"
1583 * rather than "mgcp.display_raw_text" and "mgcp.display_dissect_tree"
1584 * were used in earlier versions of Ethereal; if we didn't find the
1585 * preference, it was an MGCP preference, and its name was
1586 * "display raw text toggle" or "display dissect tree", look for
1587 * "display_raw_text" or "display_dissect_tree" instead.
1589 * "mgcp.tcp.port" and "mgcp.udp.port" are harder to handle, as both
1590 * the gateway and callagent ports were given those names; we interpret
1591 * the first as "mgcp.{tcp,udp}.gateway_port" and the second as
1592 * "mgcp.{tcp,udp}.callagent_port", as that's the order in which
1593 * they were registered by the MCCP dissector and thus that's the
1594 * order in which they were written to the preferences file. (If
1595 * we're not reading the preferences file, but are handling stuff
1596 * from a "-o" command-line option, we have no clue which the user
1597 * had in mind - they should have used "mgcp.{tcp,udp}.gateway_port"
1598 * or "mgcp.{tcp,udp}.callagent_port" instead.)
1600 if (strcmp(dotp, "display raw text toggle") == 0)
1601 pref = find_preference(module, "display_raw_text");
1602 else if (strcmp(dotp, "display dissect tree") == 0)
1603 pref = find_preference(module, "display_dissect_tree");
1604 else if (strcmp(dotp, "tcp.port") == 0) {
1605 mgcp_tcp_port_count++;
1606 if (mgcp_tcp_port_count == 1) {
1607 /* It's the first one */
1608 pref = find_preference(module, "tcp.gateway_port");
1609 } else if (mgcp_tcp_port_count == 2) {
1610 /* It's the second one */
1611 pref = find_preference(module, "tcp.callagent_port");
1613 /* Otherwise it's from the command line, and we don't bother
1615 } else if (strcmp(dotp, "udp.port") == 0) {
1616 mgcp_udp_port_count++;
1617 if (mgcp_udp_port_count == 1) {
1618 /* It's the first one */
1619 pref = find_preference(module, "udp.gateway_port");
1620 } else if (mgcp_udp_port_count == 2) {
1621 /* It's the second one */
1622 pref = find_preference(module, "udp.callagent_port");
1624 /* Otherwise it's from the command line, and we don't bother
1627 } else if (strncmp(pref_name, "smb.", 4) == 0) {
1628 /* Handle old names for SMB preferences. */
1629 if (strcmp(dotp, "smb.trans.reassembly") == 0)
1630 pref = find_preference(module, "trans_reassembly");
1631 else if (strcmp(dotp, "smb.dcerpc.reassembly") == 0)
1632 pref = find_preference(module, "dcerpc_reassembly");
1633 } else if (strncmp(pref_name, "ndmp.", 5) == 0) {
1634 /* Handle old names for NDMP preferences. */
1635 if (strcmp(dotp, "ndmp.desegment") == 0)
1636 pref = find_preference(module, "desegment");
1637 } else if (strncmp(pref_name, "diameter.", 9) == 0) {
1638 /* Handle old names for Diameter preferences. */
1639 if (strcmp(dotp, "diameter.desegment") == 0)
1640 pref = find_preference(module, "desegment");
1641 } else if (strncmp(pref_name, "pcli.", 5) == 0) {
1642 /* Handle old names for PCLI preferences. */
1643 if (strcmp(dotp, "pcli.udp_port") == 0)
1644 pref = find_preference(module, "udp_port");
1645 } else if (strncmp(pref_name, "mapi.", 5) == 0) {
1646 /* Handle old names for MAPI preferences. */
1647 if (strcmp(dotp, "mapi_decrypt") == 0)
1648 pref = find_preference(module, "decrypt");
1649 } else if (strncmp(pref_name, "fc.", 3) == 0) {
1650 /* Handle old names for Fibre Channel preferences. */
1651 if (strcmp(dotp, "reassemble_fc") == 0)
1652 pref = find_preference(module, "reassemble");
1653 else if (strcmp(dotp, "fc_max_frame_size") == 0)
1654 pref = find_preference(module, "max_frame_size");
1655 } else if (strncmp(pref_name, "fcip.", 5) == 0) {
1656 /* Handle old names for Fibre Channel-over-IP preferences. */
1657 if (strcmp(dotp, "desegment_fcip_messages") == 0)
1658 pref = find_preference(module, "desegment");
1659 else if (strcmp(dotp, "fcip_port") == 0)
1660 pref = find_preference(module, "target_port");
1661 } else if (strncmp(pref_name, "gtp.", 4) == 0) {
1662 /* Handle old names for GTP preferences. */
1663 if (strcmp(dotp, "gtpv0_port") == 0)
1664 pref = find_preference(module, "v0_port");
1665 else if (strcmp(dotp, "gtpv1c_port") == 0)
1666 pref = find_preference(module, "v1c_port");
1667 else if (strcmp(dotp, "gtpv1u_port") == 0)
1668 pref = find_preference(module, "v1u_port");
1669 else if (strcmp(dotp, "gtp_dissect_tpdu") == 0)
1670 pref = find_preference(module, "dissect_tpdu");
1671 else if (strcmp(dotp, "gtpv0_dissect_cdr_as") == 0)
1672 pref = find_preference(module, "v0_dissect_cdr_as");
1673 else if (strcmp(dotp, "gtpv0_check_etsi") == 0)
1674 pref = find_preference(module, "v0_check_etsi");
1675 else if (strcmp(dotp, "gtpv1_check_etsi") == 0)
1676 pref = find_preference(module, "v1_check_etsi");
1677 } else if (strncmp(pref_name, "ip.", 3) == 0) {
1678 /* Handle old names for IP preferences. */
1679 if (strcmp(dotp, "ip_summary_in_tree") == 0)
1680 pref = find_preference(module, "summary_in_tree");
1681 } else if (strncmp(pref_name, "iscsi.", 6) == 0) {
1682 /* Handle old names for iSCSI preferences. */
1683 if (strcmp(dotp, "iscsi_port") == 0)
1684 pref = find_preference(module, "target_port");
1685 } else if (strncmp(pref_name, "lmp.", 4) == 0) {
1686 /* Handle old names for LMP preferences. */
1687 if (strcmp(dotp, "lmp_version") == 0)
1688 pref = find_preference(module, "version");
1689 } else if (strncmp(pref_name, "mtp3.", 5) == 0) {
1690 /* Handle old names for MTP3 preferences. */
1691 if (strcmp(dotp, "mtp3_standard") == 0)
1692 pref = find_preference(module, "standard");
1693 } else if (strncmp(pref_name, "nlm.", 4) == 0) {
1694 /* Handle old names for NLM preferences. */
1695 if (strcmp(dotp, "nlm_msg_res_matching") == 0)
1696 pref = find_preference(module, "msg_res_matching");
1697 } else if (strncmp(pref_name, "ppp.", 4) == 0) {
1698 /* Handle old names for PP preferences. */
1699 if (strcmp(dotp, "ppp_fcs") == 0)
1700 pref = find_preference(module, "fcs_type");
1701 else if (strcmp(dotp, "ppp_vj") == 0)
1702 pref = find_preference(module, "decompress_vj");
1703 } else if (strncmp(pref_name, "rsvp.", 5) == 0) {
1704 /* Handle old names for RSVP preferences. */
1705 if (strcmp(dotp, "rsvp_process_bundle") == 0)
1706 pref = find_preference(module, "process_bundle");
1707 } else if (strncmp(pref_name, "tcp.", 4) == 0) {
1708 /* Handle old names for TCP preferences. */
1709 if (strcmp(dotp, "tcp_summary_in_tree") == 0)
1710 pref = find_preference(module, "summary_in_tree");
1711 else if (strcmp(dotp, "tcp_analyze_sequence_numbers") == 0)
1712 pref = find_preference(module, "analyze_sequence_numbers");
1713 else if (strcmp(dotp, "tcp_relative_sequence_numbers") == 0)
1714 pref = find_preference(module, "relative_sequence_numbers");
1715 } else if (strncmp(pref_name, "udp.", 4) == 0) {
1716 /* Handle old names for UDP preferences. */
1717 if (strcmp(dotp, "udp_summary_in_tree") == 0)
1718 pref = find_preference(module, "summary_in_tree");
1722 return PREFS_SET_NO_SUCH_PREF; /* no such preference */
1724 switch (pref->type) {
1727 uval = strtoul(value, &p, pref->info.base);
1728 if (p == value || *p != '\0')
1729 return PREFS_SET_SYNTAX_ERR; /* number was bad */
1730 if (*pref->varp.uint != uval) {
1731 module->prefs_changed = TRUE;
1732 *pref->varp.uint = uval;
1737 /* XXX - give an error if it's neither "true" nor "false"? */
1738 if (strcasecmp(value, "true") == 0)
1742 if (*pref->varp.boolp != bval) {
1743 module->prefs_changed = TRUE;
1744 *pref->varp.boolp = bval;
1749 /* XXX - give an error if it doesn't match? */
1750 enum_val = find_val_for_string(value,
1751 pref->info.enum_info.enumvals, 1);
1752 if (*pref->varp.enump != enum_val) {
1753 module->prefs_changed = TRUE;
1754 *pref->varp.enump = enum_val;
1759 if (*pref->varp.string == NULL || strcmp(*pref->varp.string, value) != 0) {
1760 module->prefs_changed = TRUE;
1761 if (*pref->varp.string != NULL)
1762 g_free(*pref->varp.string);
1763 *pref->varp.string = g_strdup(value);
1768 return PREFS_SET_OBSOLETE; /* no such preference any more */
1772 return PREFS_SET_OK;
1781 * Write out a single preference.
1784 write_pref(gpointer data, gpointer user_data)
1786 pref_t *pref = data;
1787 write_pref_arg_t *arg = user_data;
1788 const enum_val_t *enum_valp;
1789 const char *val_string;
1791 if (pref->type == PREF_OBSOLETE) {
1793 * This preference is no longer supported; it's not a
1794 * real preference, so we don't write it out (i.e., we
1795 * treat it as if it weren't found in the list of
1796 * preferences, and we weren't called in the first place).
1801 fprintf(arg->pf, "\n# %s\n", pref->description);
1803 switch (pref->type) {
1806 switch (pref->info.base) {
1809 fprintf(arg->pf, "# A decimal number.\n");
1810 fprintf(arg->pf, "%s.%s: %u\n", arg->module->name,
1811 pref->name, *pref->varp.uint);
1815 fprintf(arg->pf, "# An octal number.\n");
1816 fprintf(arg->pf, "%s.%s: %#o\n", arg->module->name,
1817 pref->name, *pref->varp.uint);
1821 fprintf(arg->pf, "# A hexadecimal number.\n");
1822 fprintf(arg->pf, "%s.%s: %#x\n", arg->module->name,
1823 pref->name, *pref->varp.uint);
1829 fprintf(arg->pf, "# TRUE or FALSE (case-insensitive).\n");
1830 fprintf(arg->pf, "%s.%s: %s\n", arg->module->name, pref->name,
1831 *pref->varp.boolp ? "TRUE" : "FALSE");
1835 fprintf(arg->pf, "# One of: ");
1836 enum_valp = pref->info.enum_info.enumvals;
1838 while (enum_valp->name != NULL) {
1839 if (enum_valp->value == *pref->varp.enump)
1840 val_string = enum_valp->name;
1841 fprintf(arg->pf, "%s", enum_valp->name);
1843 if (enum_valp->name == NULL)
1844 fprintf(arg->pf, "\n");
1846 fprintf(arg->pf, ", ");
1848 fprintf(arg->pf, "# (case-insensitive).\n");
1849 fprintf(arg->pf, "%s.%s: %s\n", arg->module->name, pref->name,
1854 fprintf(arg->pf, "# A string.\n");
1855 fprintf(arg->pf, "%s.%s: %s\n", arg->module->name, pref->name,
1856 *pref->varp.string);
1860 g_assert_not_reached();
1866 write_module_prefs(gpointer data, gpointer user_data)
1868 write_pref_arg_t arg;
1872 g_list_foreach(arg.module->prefs, write_pref, &arg);
1875 /* Write out "prefs" to the user's preferences file, and return 0.
1877 If we got an error, stuff a pointer to the path of the preferences file
1878 into "*pf_path_return", and return the errno. */
1880 write_prefs(char **pf_path_return)
1888 * - Split output lines longer than MAX_VAL_LEN
1889 * - Create a function for the preference directory check/creation
1890 * so that duplication can be avoided with filter.c
1893 pf_path = get_persconffile_path(PF_NAME, TRUE);
1894 if ((pf = fopen(pf_path, "w")) == NULL) {
1895 *pf_path_return = pf_path;
1899 fputs("# Configuration file for Ethereal " VERSION ".\n"
1901 "# This file is regenerated each time preferences are saved within\n"
1902 "# Ethereal. Making manual changes should be safe, however.\n"
1904 "######## Printing ########\n"
1907 fprintf (pf, "# Can be one of \"text\" or \"postscript\".\n"
1908 "print.format: %s\n\n", pr_formats[prefs.pr_format]);
1910 fprintf (pf, "# Can be one of \"command\" or \"file\".\n"
1911 "print.destination: %s\n\n", pr_dests[prefs.pr_dest]);
1913 fprintf (pf, "# This is the file that gets written to when the "
1914 "destination is set to \"file\"\n"
1915 "%s: %s\n\n", PRS_PRINT_FILE, prefs.pr_file);
1917 fprintf (pf, "# Output gets piped to this command when the destination "
1918 "is set to \"command\"\n"
1919 "%s: %s\n\n", PRS_PRINT_CMD, prefs.pr_cmd);
1921 clp = prefs.col_list;
1924 cfmt = (fmt_data *) clp->data;
1925 col_l = g_list_append(col_l, cfmt->title);
1926 col_l = g_list_append(col_l, cfmt->fmt);
1929 fprintf (pf, "# Packet list column format. Each pair of strings consists "
1930 "of a column title \n# and its format.\n"
1931 "%s: %s\n\n", PRS_COL_FMT, put_string_list(col_l));
1932 /* This frees the list of strings, but not the strings to which it
1933 refers; that's what we want, as we haven't copied those strings,
1934 we just referred to them. */
1937 fprintf (pf, "# TCP stream window color preferences. Each value is a six "
1938 "digit hexadecimal value in the form rrggbb.\n");
1939 fprintf (pf, "%s: %02x%02x%02x\n", PRS_STREAM_CL_FG,
1940 (prefs.st_client_fg.red * 255 / 65535),
1941 (prefs.st_client_fg.green * 255 / 65535),
1942 (prefs.st_client_fg.blue * 255 / 65535));
1943 fprintf (pf, "%s: %02x%02x%02x\n", PRS_STREAM_CL_BG,
1944 (prefs.st_client_bg.red * 255 / 65535),
1945 (prefs.st_client_bg.green * 255 / 65535),
1946 (prefs.st_client_bg.blue * 255 / 65535));
1947 fprintf (pf, "%s: %02x%02x%02x\n", PRS_STREAM_SR_FG,
1948 (prefs.st_server_fg.red * 255 / 65535),
1949 (prefs.st_server_fg.green * 255 / 65535),
1950 (prefs.st_server_fg.blue * 255 / 65535));
1951 fprintf (pf, "%s: %02x%02x%02x\n", PRS_STREAM_SR_BG,
1952 (prefs.st_server_bg.red * 255 / 65535),
1953 (prefs.st_server_bg.green * 255 / 65535),
1954 (prefs.st_server_bg.blue * 255 / 65535));
1956 fprintf(pf, "\n# Vertical scrollbars should be on right side? TRUE/FALSE\n");
1957 fprintf(pf, PRS_GUI_SCROLLBAR_ON_RIGHT ": %s\n",
1958 prefs.gui_scrollbar_on_right == TRUE ? "TRUE" : "FALSE");
1960 fprintf(pf, "\n# Packet-list selection bar can be used to browse w/o selecting? TRUE/FALSE\n");
1961 fprintf(pf, PRS_GUI_PLIST_SEL_BROWSE ": %s\n",
1962 prefs.gui_plist_sel_browse == TRUE ? "TRUE" : "FALSE");
1964 fprintf(pf, "\n# Protocol-tree selection bar can be used to browse w/o selecting? TRUE/FALSE\n");
1965 fprintf(pf, PRS_GUI_PTREE_SEL_BROWSE ": %s\n",
1966 prefs.gui_ptree_sel_browse == TRUE ? "TRUE" : "FALSE");
1968 fprintf(pf, "\n# Alternating colors in TreeViews\n");
1969 fprintf(pf, PRS_GUI_ALTERN_COLORS ": %s\n",
1970 prefs.gui_altern_colors == TRUE ? "TRUE" : "FALSE");
1972 fprintf(pf, "\n# Protocol-tree line style. One of: NONE, SOLID, DOTTED, TABBED\n");
1973 fprintf(pf, PRS_GUI_PTREE_LINE_STYLE ": %s\n",
1974 gui_ptree_line_style_text[prefs.gui_ptree_line_style]);
1976 fprintf(pf, "\n# Protocol-tree expander style. One of: NONE, SQUARE, TRIANGLE, CIRCULAR\n");
1977 fprintf(pf, PRS_GUI_PTREE_EXPANDER_STYLE ": %s\n",
1978 gui_ptree_expander_style_text[prefs.gui_ptree_expander_style]);
1980 fprintf(pf, "\n# Hex dump highlight style. One of: BOLD, INVERSE\n");
1981 fprintf(pf, PRS_GUI_HEX_DUMP_HIGHLIGHT_STYLE ": %s\n",
1982 gui_hex_dump_highlight_style_text[prefs.gui_hex_dump_highlight_style]);
1984 fprintf(pf, "\n# Font name for packet list, protocol tree, and hex dump panes.\n");
1985 fprintf(pf, PRS_GUI_FONT_NAME ": %s\n", prefs.gui_font_name);
1987 fprintf (pf, "\n# Color preferences for a marked frame. Each value is a six "
1988 "digit hexadecimal value in the form rrggbb.\n");
1989 fprintf (pf, "%s: %02x%02x%02x\n", PRS_GUI_MARKED_FG,
1990 (prefs.gui_marked_fg.red * 255 / 65535),
1991 (prefs.gui_marked_fg.green * 255 / 65535),
1992 (prefs.gui_marked_fg.blue * 255 / 65535));
1993 fprintf (pf, "%s: %02x%02x%02x\n", PRS_GUI_MARKED_BG,
1994 (prefs.gui_marked_bg.red * 255 / 65535),
1995 (prefs.gui_marked_bg.green * 255 / 65535),
1996 (prefs.gui_marked_bg.blue * 255 / 65535));
1998 fprintf(pf, "\n# Save window position at exit? TRUE/FALSE\n");
1999 fprintf(pf, PRS_GUI_GEOMETRY_SAVE_POSITION ": %s\n",
2000 prefs.gui_geometry_save_position == TRUE ? "TRUE" : "FALSE");
2002 fprintf(pf, "\n# Save window size at exit? TRUE/FALSE\n");
2003 fprintf(pf, PRS_GUI_GEOMETRY_SAVE_SIZE ": %s\n",
2004 prefs.gui_geometry_save_size == TRUE ? "TRUE" : "FALSE");
2006 fprintf(pf, "\n# Main window geometry. Decimal integers.\n");
2007 fprintf(pf, PRS_GUI_GEOMETRY_MAIN_X ": %d\n", prefs.gui_geometry_main_x);
2008 fprintf(pf, PRS_GUI_GEOMETRY_MAIN_Y ": %d\n", prefs.gui_geometry_main_y);
2009 fprintf(pf, PRS_GUI_GEOMETRY_MAIN_WIDTH ": %d\n",
2010 prefs.gui_geometry_main_width);
2011 fprintf(pf, PRS_GUI_GEOMETRY_MAIN_HEIGHT ": %d\n",
2012 prefs.gui_geometry_main_height);
2014 fprintf(pf, "\n# Resolve addresses to names? TRUE/FALSE/{list of address types to resolve}\n");
2015 fprintf(pf, PRS_NAME_RESOLVE ": %s\n",
2016 name_resolve_to_string(prefs.name_resolve));
2018 /* write the capture options */
2019 if (prefs.capture_device != NULL) {
2020 fprintf(pf, "\n# Default capture device\n");
2021 fprintf(pf, PRS_CAP_DEVICE ": %s\n", prefs.capture_device);
2024 fprintf(pf, "\n# Capture in promiscuous mode? TRUE/FALSE\n");
2025 fprintf(pf, PRS_CAP_PROM_MODE ": %s\n",
2026 prefs.capture_prom_mode == TRUE ? "TRUE" : "FALSE");
2028 fprintf(pf, "\n# Update packet list in real time during capture? TRUE/FALSE\n");
2029 fprintf(pf, PRS_CAP_REAL_TIME ": %s\n",
2030 prefs.capture_real_time == TRUE ? "TRUE" : "FALSE");
2032 fprintf(pf, "\n# scroll packet list during capture? TRUE/FALSE\n");
2033 fprintf(pf, PRS_CAP_AUTO_SCROLL ": %s\n",
2034 prefs.capture_auto_scroll == TRUE ? "TRUE" : "FALSE");
2036 g_list_foreach(modules, write_module_prefs, pf);
2040 /* XXX - catch I/O errors (e.g. "ran out of disk space") and return
2041 an error indication, or maybe write to a new preferences file and
2042 rename that file on top of the old one only if there are not I/O
2047 /* Copy a set of preferences. */
2049 copy_prefs(e_prefs *dest, e_prefs *src)
2051 fmt_data *src_cfmt, *dest_cfmt;
2054 dest->pr_format = src->pr_format;
2055 dest->pr_dest = src->pr_dest;
2056 dest->pr_file = g_strdup(src->pr_file);
2057 dest->pr_cmd = g_strdup(src->pr_cmd);
2058 dest->col_list = NULL;
2059 for (entry = src->col_list; entry != NULL; entry = g_list_next(entry)) {
2060 src_cfmt = entry->data;
2061 dest_cfmt = (fmt_data *) g_malloc(sizeof(fmt_data));
2062 dest_cfmt->title = g_strdup(src_cfmt->title);
2063 dest_cfmt->fmt = g_strdup(src_cfmt->fmt);
2064 dest->col_list = g_list_append(dest->col_list, dest_cfmt);
2066 dest->num_cols = src->num_cols;
2067 dest->st_client_fg = src->st_client_fg;
2068 dest->st_client_bg = src->st_client_bg;
2069 dest->st_server_fg = src->st_server_fg;
2070 dest->st_server_bg = src->st_server_bg;
2071 dest->gui_scrollbar_on_right = src->gui_scrollbar_on_right;
2072 dest->gui_plist_sel_browse = src->gui_plist_sel_browse;
2073 dest->gui_ptree_sel_browse = src->gui_ptree_sel_browse;
2074 dest->gui_altern_colors = src->gui_altern_colors;
2075 dest->gui_ptree_line_style = src->gui_ptree_line_style;
2076 dest->gui_ptree_expander_style = src->gui_ptree_expander_style;
2077 dest->gui_hex_dump_highlight_style = src->gui_hex_dump_highlight_style;
2078 dest->gui_font_name = g_strdup(src->gui_font_name);
2079 dest->gui_marked_fg = src->gui_marked_fg;
2080 dest->gui_marked_bg = src->gui_marked_bg;
2081 dest->gui_geometry_save_position = src->gui_geometry_save_position;
2082 dest->gui_geometry_save_size = src->gui_geometry_save_size;
2083 dest->gui_geometry_main_x = src->gui_geometry_main_x;
2084 dest->gui_geometry_main_y = src->gui_geometry_main_y;
2085 dest->gui_geometry_main_width = src->gui_geometry_main_width;
2086 dest->gui_geometry_main_height = src->gui_geometry_main_height;
2087 /* values for the capture dialog box */
2088 dest->capture_device = g_strdup(src->capture_device);
2089 dest->capture_prom_mode = src->capture_prom_mode;
2090 dest->capture_real_time = src->capture_real_time;
2091 dest->capture_auto_scroll = src->capture_auto_scroll;
2092 dest->name_resolve = src->name_resolve;
2096 /* Free a set of preferences. */
2098 free_prefs(e_prefs *pr)
2100 if (pr->pr_file != NULL) {
2101 g_free(pr->pr_file);
2104 if (pr->pr_cmd != NULL) {
2109 if (pr->gui_font_name != NULL) {
2110 g_free(pr->gui_font_name);
2111 pr->gui_font_name = NULL;
2113 if (pr->capture_device != NULL) {
2114 g_free(pr->capture_device);
2115 pr->capture_device = NULL;
2120 free_col_info(e_prefs *pr)
2124 while (pr->col_list != NULL) {
2125 cfmt = pr->col_list->data;
2126 g_free(cfmt->title);
2129 pr->col_list = g_list_remove_link(pr->col_list, pr->col_list);
2131 g_list_free(pr->col_list);
2132 pr->col_list = NULL;