2 * Routines for handling preferences
4 * $Id: prefs.c,v 1.70 2001/11/04 02:50:19 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.
29 #ifdef HAVE_SYS_TYPES_H
30 #include <sys/types.h>
44 #include <filesystem.h>
53 #include "prefs-int.h"
55 /* Internal functions */
56 static module_t *find_module(const char *name);
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 modules with preference settings.
93 static GList *modules;
96 module_compare_name(gconstpointer p1_arg, gconstpointer p2_arg)
98 const module_t *p1 = p1_arg;
99 const module_t *p2 = p2_arg;
101 return g_strcasecmp(p1->name, p2->name);
105 * Register a module that will have preferences.
106 * Specify the name used for the module in the preferences file, the
107 * title used in the tab for it in a preferences dialog box, and a
108 * routine to call back when we apply the preferences.
111 prefs_register_module(const char *name, const char *title,
112 void (*apply_cb)(void))
117 module = g_malloc(sizeof (module_t));
119 module->title = title;
120 module->apply_cb = apply_cb;
121 module->prefs = NULL; /* no preferences, to start */
122 module->numprefs = 0;
123 module->prefs_changed = FALSE;
126 * Make sure that only lower-case ASCII letters, numbers, and
127 * underscores appear in the module name.
129 * Crash if there is, as that's an error in the code;
130 * you can make the title a nice string with capitalization,
131 * white space, punctuation, etc., but the name can be used
132 * on the command line, and shouldn't require quoting,
135 for (p = name; *p != '\0'; p++)
136 g_assert(isascii(*p) &&
137 (islower(*p) || isdigit(*p) || *p == '_'));
140 * Make sure there's not already a module with that
141 * name. Crash if there is, as that's an error in the
142 * code, and the code has to be fixed not to register
143 * more than one module with the same name.
145 g_assert(find_module(name) == NULL);
147 modules = g_list_insert_sorted(modules, module, module_compare_name);
153 * Register that a protocol has preferences.
156 prefs_register_protocol(int id, void (*apply_cb)(void))
158 return prefs_register_module(proto_get_protocol_filter_name(id),
159 proto_get_protocol_short_name(id),
164 * Find a module, given its name.
167 module_match(gconstpointer a, gconstpointer b)
169 const module_t *module = a;
170 const char *name = b;
172 return strcmp(name, module->name);
176 find_module(const char *name)
180 list_entry = g_list_find_custom(modules, (gpointer)name, module_match);
181 if (list_entry == NULL)
182 return NULL; /* no such module */
183 return (module_t *) list_entry->data;
192 do_module_callback(gpointer data, gpointer user_data)
194 module_t *module = data;
195 module_cb_arg_t *arg = user_data;
197 (*arg->callback)(module, arg->user_data);
201 * Call a callback function, with a specified argument, for each module.
204 prefs_module_foreach(module_cb callback, gpointer user_data)
208 arg.callback = callback;
209 arg.user_data = user_data;
210 g_list_foreach(modules, do_module_callback, &arg);
214 call_apply_cb(gpointer data, gpointer user_data)
216 module_t *module = data;
218 if (module->prefs_changed) {
219 if (module->apply_cb != NULL)
220 (*module->apply_cb)();
221 module->prefs_changed = FALSE;
226 * Call the "apply" callback function for each module if any of its
227 * preferences have changed, and then clear the flag saying its
228 * preferences have changed, as the module has been notified of that
232 prefs_apply_all(void)
234 g_list_foreach(modules, call_apply_cb, NULL);
238 * Register a preference in a module's list of preferences.
241 register_preference(module_t *module, const char *name, const char *title,
242 const char *description)
247 preference = g_malloc(sizeof (pref_t));
248 preference->name = name;
249 preference->title = title;
250 preference->description = description;
251 preference->ordinal = module->numprefs;
254 * Make sure that only lower-case ASCII letters, numbers,
255 * underscores, and dots appear in the preference name.
257 * Crash if there is, as that's an error in the code;
258 * you can make the title and description nice strings
259 * with capitalization, white space, punctuation, etc.,
260 * but the name can be used on the command line,
261 * and shouldn't require quoting, Shifting, etc.
263 for (p = name; *p != '\0'; p++)
264 g_assert(isascii(*p) &&
265 (islower(*p) || isdigit(*p) || *p == '_' || *p == '.'));
268 * Make sure there's not already a preference with that
269 * name. Crash if there is, as that's an error in the
270 * code, and the code has to be fixed not to register
271 * more than one preference with the same name.
273 g_assert(find_preference(module, name) == NULL);
276 * There isn't already one with that name, so add the
279 module->prefs = g_list_append(module->prefs, preference);
286 * Find a preference in a module's list of preferences, given the module
287 * and the preference's name.
290 preference_match(gconstpointer a, gconstpointer b)
292 const pref_t *pref = a;
293 const char *name = b;
295 return strcmp(name, pref->name);
298 static struct preference *
299 find_preference(module_t *module, const char *name)
303 list_entry = g_list_find_custom(module->prefs, (gpointer)name,
305 if (list_entry == NULL)
306 return NULL; /* no such preference */
307 return (struct preference *) list_entry->data;
311 * Returns TRUE if the given protocol has registered preferences
314 prefs_is_registered_protocol(char *name)
316 return (find_module(name) != NULL);
320 * Returns the module title of a registered protocol
323 prefs_get_title_by_name(char *name)
325 module_t *m = find_module(name);
326 return (m) ? m->title : NULL;
330 * Register a preference with an unsigned integral value.
333 prefs_register_uint_preference(module_t *module, const char *name,
334 const char *title, const char *description, guint base, guint *var)
338 preference = register_preference(module, name, title, description);
339 preference->type = PREF_UINT;
340 preference->varp.uint = var;
341 preference->info.base = base;
345 * Register a preference with an Boolean value.
348 prefs_register_bool_preference(module_t *module, const char *name,
349 const char *title, const char *description, gboolean *var)
353 preference = register_preference(module, name, title, description);
354 preference->type = PREF_BOOL;
355 preference->varp.bool = var;
359 * Register a preference with an enumerated value.
362 prefs_register_enum_preference(module_t *module, const char *name,
363 const char *title, const char *description, gint *var,
364 const enum_val_t *enumvals, gboolean radio_buttons)
368 preference = register_preference(module, name, title, description);
369 preference->type = PREF_ENUM;
370 preference->varp.enump = var;
371 preference->info.enum_info.enumvals = enumvals;
372 preference->info.enum_info.radio_buttons = radio_buttons;
376 * Register a preference with a character-string value.
379 prefs_register_string_preference(module_t *module, const char *name,
380 const char *title, const char *description, char **var)
384 preference = register_preference(module, name, title, description);
385 preference->type = PREF_STRING;
386 preference->varp.string = var;
387 preference->saved_val.string = NULL;
391 * Register a preference that used to be supported but no longer is.
394 prefs_register_obsolete_preference(module_t *module, const char *name)
398 preference = register_preference(module, name, NULL, NULL);
399 preference->type = PREF_OBSOLETE;
408 do_pref_callback(gpointer data, gpointer user_data)
411 pref_cb_arg_t *arg = user_data;
413 if (pref->type == PREF_OBSOLETE) {
415 * This preference is no longer supported; it's not a
416 * real preference, so we don't call the callback for
417 * it (i.e., we treat it as if it weren't found in the
418 * list of preferences, and we weren't called in the
424 (*arg->callback)(pref, arg->user_data);
428 * Call a callback function, with a specified argument, for each preference
432 prefs_pref_foreach(module_t *module, pref_cb callback, gpointer user_data)
436 arg.callback = callback;
437 arg.user_data = user_data;
438 g_list_foreach(module->prefs, do_pref_callback, &arg);
442 * Register all non-dissector modules' preferences.
445 prefs_register_modules(void)
449 /* Parse through a list of comma-separated, possibly quoted strings.
450 Return a list of the string data. */
452 get_string_list(gchar *str)
454 enum { PRE_STRING, IN_QUOT, NOT_IN_QUOT };
456 gint state = PRE_STRING, i = 0, j = 0;
457 gboolean backslash = FALSE;
462 /* Allocate a buffer for the first string. */
463 slstr = (gchar *) g_malloc(sizeof(gchar) * COL_MAX_LEN);
469 /* It's the end of the input, so it's the end of the string we
470 were working on, and there's no more input. */
471 if (state == IN_QUOT || backslash) {
472 /* We were in the middle of a quoted string or backslash escape,
473 and ran out of characters; that's an error. */
475 clear_string_list(sl);
479 sl = g_list_append(sl, slstr);
482 if (cur_c == '"' && ! backslash) {
485 /* We hadn't yet started processing a string; this starts the
486 string, and we're now quoting. */
490 /* We're in the middle of a quoted string, and we saw a quotation
491 mark; we're no longer quoting. */
495 /* We're working on a string, but haven't seen a quote; we're
502 } else if (cur_c == '\\' && ! backslash) {
503 /* We saw a backslash, and the previous character wasn't a
504 backslash; escape the next character.
506 This also means we've started a new string. */
508 if (state == PRE_STRING)
510 } else if (cur_c == ',' && state != IN_QUOT && ! backslash) {
511 /* We saw a comma, and we're not in the middle of a quoted string
512 and it wasn't preceded by a backslash; it's the end of
513 the string we were working on... */
515 sl = g_list_append(sl, slstr);
517 /* ...and the beginning of a new string. */
519 slstr = (gchar *) g_malloc(sizeof(gchar) * COL_MAX_LEN);
521 } else if (!isspace(cur_c) || state != PRE_STRING) {
522 /* Either this isn't a white-space character, or we've started a
523 string (i.e., already seen a non-white-space character for that
524 string and put it into the string).
526 The character is to be put into the string; do so if there's
528 if (j < COL_MAX_LEN) {
533 /* If it was backslash-escaped, we're done with the backslash escape. */
541 #define MAX_FMT_PREF_LEN 1024
542 #define MAX_FMT_PREF_LINE_LEN 60
544 put_string_list(GList *sl)
546 static gchar pref_str[MAX_FMT_PREF_LEN] = "";
547 GList *clp = g_list_first(sl);
549 int cur_pos = 0, cur_len = 0;
552 gchar *strp, *quoted_strp, c;
558 /* Allocate a buffer big enough to hold the entire string, with each
559 character quoted (that's the worst case). */
560 str_len = strlen(str);
561 quoted_str = g_malloc(str_len*2 + 1);
563 /* Now quote any " or \ characters in it. */
565 quoted_strp = quoted_str;
566 while ((c = *strp++) != '\0') {
567 if (c == '"' || c == '\\') {
568 /* It has to be backslash-quoted. */
569 *quoted_strp++ = '\\';
575 fmt_len = strlen(quoted_str) + 4;
576 if ((fmt_len + cur_len) < (MAX_FMT_PREF_LEN - 1)) {
577 if ((fmt_len + cur_pos) > MAX_FMT_PREF_LINE_LEN) {
581 pref_str[cur_len] = '\n'; cur_len++;
582 pref_str[cur_len] = '\t'; cur_len++;
584 sprintf(&pref_str[cur_len], "\"%s\", ", quoted_str);
592 /* If the string is at least two characters long, the last two characters
593 are ", ", and should be discarded, as there are no more items in the
596 pref_str[cur_len - 2] = '\0';
602 clear_string_list(GList *sl)
608 l = g_list_remove_link(l, l);
613 * Takes a string, a pointer to an array of "enum_val_t"s, and a default gint
615 * The array must be terminated by an entry with a null "name" string.
616 * If the string matches a "name" strings in an entry, the value from that
617 * entry is returned. Otherwise, the default value that was passed as the
618 * third argument is returned.
621 find_val_for_string(const char *needle, const enum_val_t *haystack,
626 while (haystack[i].name != NULL) {
627 if (strcasecmp(needle, haystack[i].name) == 0) {
628 return haystack[i].value;
632 return default_value;
635 /* Takes an string and a pointer to an array of strings, and a default int value.
636 * The array must be terminated by a NULL string. If the string is found in the array
637 * of strings, the index of that string in the array is returned. Otherwise, the
638 * default value that was passed as the third argument is returned.
641 find_index_from_string_array(char *needle, char **haystack, int default_value)
645 while (haystack[i] != NULL) {
646 if (strcmp(needle, haystack[i]) == 0) {
651 return default_value;
654 /* Preferences file format:
655 * - Configuration directives start at the beginning of the line, and
656 * are terminated with a colon.
657 * - Directives can be continued on the next line by preceding them with
662 # This is a comment line
664 print.file: /a/very/long/path/
669 #define MAX_VAR_LEN 48
670 #define MAX_VAL_LEN 1024
672 #define DEF_NUM_COLS 6
674 static void read_prefs_file(const char *pf_path, FILE *pf);
676 /* Read the preferences file, fill in "prefs", and return a pointer to it.
678 If we got an error (other than "it doesn't exist") trying to read
679 the global preferences file, stuff the errno into "*gpf_errno_return"
680 and a pointer to the path of the file into "*gpf_path_return", and
683 If we got an error (other than "it doesn't exist") trying to read
684 the user's preferences file, stuff the errno into "*pf_errno_return"
685 and a pointer to the path of the file into "*pf_path_return", and
688 read_prefs(int *gpf_errno_return, char **gpf_path_return,
689 int *pf_errno_return, const char **pf_path_return)
695 gchar *col_fmt[] = {"No.", "%m", "Time", "%t",
696 "Source", "%s", "Destination", "%d",
697 "Protocol", "%p", "Info", "%i"};
700 /* Initialize preferences to wired-in default values.
701 They may be overridded by the global preferences file or the
702 user's preferences file. */
704 prefs.pr_format = PR_FMT_TEXT;
705 prefs.pr_dest = PR_DEST_CMD;
706 prefs.pr_file = g_strdup("ethereal.out");
707 prefs.pr_cmd = g_strdup("lpr");
708 prefs.col_list = NULL;
709 for (i = 0; i < DEF_NUM_COLS; i++) {
710 cfmt = (fmt_data *) g_malloc(sizeof(fmt_data));
711 cfmt->title = g_strdup(col_fmt[i * 2]);
712 cfmt->fmt = g_strdup(col_fmt[(i * 2) + 1]);
713 prefs.col_list = g_list_append(prefs.col_list, cfmt);
715 prefs.num_cols = DEF_NUM_COLS;
716 prefs.st_client_fg.pixel = 0;
717 prefs.st_client_fg.red = 32767;
718 prefs.st_client_fg.green = 0;
719 prefs.st_client_fg.blue = 0;
720 prefs.st_client_bg.pixel = 65535;
721 prefs.st_client_bg.red = 65535;
722 prefs.st_client_bg.green = 65535;
723 prefs.st_client_bg.blue = 65535;
724 prefs.st_server_fg.pixel = 0;
725 prefs.st_server_fg.red = 0;
726 prefs.st_server_fg.green = 0;
727 prefs.st_server_fg.blue = 32767;
728 prefs.st_server_bg.pixel = 65535;
729 prefs.st_server_bg.red = 65535;
730 prefs.st_server_bg.green = 65535;
731 prefs.st_server_bg.blue = 65535;
732 prefs.gui_scrollbar_on_right = TRUE;
733 prefs.gui_plist_sel_browse = FALSE;
734 prefs.gui_ptree_sel_browse = FALSE;
735 prefs.gui_ptree_line_style = 0;
736 prefs.gui_ptree_expander_style = 1;
737 prefs.gui_hex_dump_highlight_style = 1;
739 prefs.gui_font_name = g_strdup("-*-lucida console-medium-r-*-*-*-100-*-*-*-*-*-*");
742 * XXX - for now, we make the initial font name a pattern that matches
743 * only ISO 8859/1 fonts, so that we don't match 2-byte fonts such
744 * as ISO 10646 fonts.
746 * Users in locales using other one-byte fonts will have to choose
747 * a different font from the preferences dialog - or put the font
748 * selection in the global preferences file to make that font the
749 * default for all users who don't explicitly specify a different
752 * Making this a font set rather than a font has two problems:
754 * 1) as far as I know, you can't select font sets with the
755 * font selection dialog;
757 * 2) if you use a font set, the text to be drawn must be a
758 * multi-byte string in the appropriate locale, but
759 * Ethereal does *NOT* guarantee that's the case - in
760 * the hex-dump window, each character in the text portion
761 * of the display must be a *single* byte, and in the
762 * packet-list and protocol-tree windows, text extracted
763 * from the packet is not necessarily in the right format.
765 * "Doing this right" may, for the packet-list and protocol-tree
766 * windows, require that dissectors know what the locale is
767 * *AND* know what locale and text representation is used in
768 * the packets they're dissecting, and may be impossible in
769 * the hex-dump window (except by punting and displaying only
772 * GTK+ 2.0 may simplify part of the problem, as it will, as I
773 * understand it, use UTF-8-encoded Unicode as its internal
774 * character set; however, we'd still have to know whatever
775 * character set and encoding is used in the packet (which
776 * may differ for different protocols, e.g. SMB might use
777 * PC code pages for some strings and Unicode for others, whilst
778 * NFS might use some UNIX character set encoding, e.g. ISO 8859/x,
779 * or one of the EUC character sets for Asian languages, or one
780 * of the other multi-byte character sets, or UTF-8, or...).
782 * I.e., as far as I can tell, "internationalizing" the packet-list,
783 * protocol-tree, and hex-dump windows involves a lot more than, say,
784 * just using font sets rather than fonts.
786 prefs.gui_font_name = g_strdup("-*-fixed-medium-r-semicondensed-*-*-120-*-*-*-*-iso8859-1");
788 prefs.gui_marked_fg.pixel = 65535;
789 prefs.gui_marked_fg.red = 65535;
790 prefs.gui_marked_fg.green = 65535;
791 prefs.gui_marked_fg.blue = 65535;
792 prefs.gui_marked_bg.pixel = 0;
793 prefs.gui_marked_bg.red = 0;
794 prefs.gui_marked_bg.green = 0;
795 prefs.gui_marked_bg.blue = 0;
797 /* set the default values for the capture dialog box */
798 prefs.capture_prom_mode = TRUE;
799 prefs.capture_real_time = FALSE;
800 prefs.capture_auto_scroll = FALSE;
801 prefs.name_resolve = PREFS_RESOLV_ALL;
804 /* Construct the pathname of the global preferences file. */
806 gpf_path = (gchar *) g_malloc(strlen(get_datafile_dir()) +
807 strlen(GPF_NAME) + 2);
808 sprintf(gpf_path, "%s" G_DIR_SEPARATOR_S "%s",
809 get_datafile_dir(), GPF_NAME);
812 /* Read the global preferences file, if it exists. */
813 *gpf_path_return = NULL;
814 if ((pf = fopen(gpf_path, "r")) != NULL) {
815 /* We succeeded in opening it; read it. */
816 read_prefs_file(gpf_path, pf);
819 /* We failed to open it. If we failed for some reason other than
820 "it doesn't exist", return the errno and the pathname, so our
821 caller can report the error. */
822 if (errno != ENOENT) {
823 *gpf_errno_return = errno;
824 *gpf_path_return = gpf_path;
828 /* Construct the pathname of the user's preferences file. */
829 pf_path = get_persconffile_path(PF_NAME, FALSE);
831 /* Read the user's preferences file, if it exists. */
832 *pf_path_return = NULL;
833 if ((pf = fopen(pf_path, "r")) != NULL) {
834 /* We succeeded in opening it; read it. */
835 read_prefs_file(pf_path, pf);
838 /* We failed to open it. If we failed for some reason other than
839 "it doesn't exist", return the errno and the pathname, so our
840 caller can report the error. */
841 if (errno != ENOENT) {
842 *pf_errno_return = errno;
843 *pf_path_return = pf_path;
851 read_prefs_file(const char *pf_path, FILE *pf)
853 enum { START, IN_VAR, PRE_VAL, IN_VAL, IN_SKIP };
854 gchar cur_var[MAX_VAR_LEN], cur_val[MAX_VAL_LEN];
855 int got_c, state = START;
856 gboolean got_val = FALSE;
857 gint var_len = 0, val_len = 0, fline = 1, pline = 1;
860 * Start out the counters of "mgcp.{tcp,udp}.port" entries we've
863 mgcp_tcp_port_count = 0;
864 mgcp_udp_port_count = 0;
866 while ((got_c = getc(pf)) != EOF) {
872 if (var_len >= MAX_VAR_LEN) {
873 g_warning ("%s line %d: Variable too long", pf_path, fline);
878 if (val_len >= MAX_VAL_LEN) {
879 g_warning ("%s line %d: Value too long", pf_path, fline);
887 if (isalnum(got_c)) {
890 cur_var[var_len] = '\0';
891 cur_val[val_len] = '\0';
892 switch (set_pref(cur_var, cur_val)) {
894 case PREFS_SET_SYNTAX_ERR:
895 g_warning ("%s line %d: Syntax error", pf_path, pline);
898 case PREFS_SET_NO_SUCH_PREF:
899 g_warning ("%s line %d: No such preference \"%s\"", pf_path,
903 case PREFS_SET_OBSOLETE:
904 /* We silently ignore attempts to set these; it's
905 probably not the user's fault that it's in there -
906 they may have saved preferences with a release that
911 g_warning ("%s line %d: Incomplete preference", pf_path, pline);
919 } else if (isspace(got_c) && var_len > 0 && got_val) {
921 } else if (got_c == '#') {
924 g_warning ("%s line %d: Malformed line", pf_path, fline);
929 cur_var[var_len] = got_c;
938 if (!isspace(got_c)) {
940 cur_val[val_len] = got_c;
946 cur_val[val_len] = got_c;
949 while (isspace((guchar)cur_val[val_len]) && val_len > 0)
958 cur_var[var_len] = '\0';
959 cur_val[val_len] = '\0';
960 switch (set_pref(cur_var, cur_val)) {
962 case PREFS_SET_SYNTAX_ERR:
963 g_warning ("%s line %d: Syntax error", pf_path, pline);
966 case PREFS_SET_NO_SUCH_PREF:
967 g_warning ("%s line %d: No such preference \"%s\"", pf_path,
971 case PREFS_SET_OBSOLETE:
972 /* We silently ignore attempts to set these; it's probably not
973 the user's fault that it's in there - they may have saved
974 preferences with a release that supported it. */
978 g_warning ("%s line %d: Incomplete preference", pf_path, pline);
984 * Given a string of the form "<pref name>:<pref value>", as might appear
985 * as an argument to a "-o" option, parse it and set the preference in
986 * question. Return an indication of whether it succeeded or failed
990 prefs_set_pref(char *prefarg)
996 * Set the counters of "mgcp.{tcp,udp}.port" entries we've
997 * seen to values that keep us from trying to interpret tham
998 * as "mgcp.{tcp,udp}.gateway_port" or "mgcp.{tcp,udp}.callagent_port",
999 * as, from the command line, we have no way of guessing which
1000 * the user had in mind.
1002 mgcp_tcp_port_count = -1;
1003 mgcp_udp_port_count = -1;
1005 colonp = strchr(prefarg, ':');
1007 return PREFS_SET_SYNTAX_ERR;
1013 * Skip over any white space (there probably won't be any, but
1014 * as we allow it in the preferences file, we might as well
1021 * Put the colon back, so if our caller uses, in an
1022 * error message, the string they passed us, the message
1026 return PREFS_SET_SYNTAX_ERR;
1029 ret = set_pref(prefarg, p);
1030 *colonp = ':'; /* put the colon back */
1034 #define PRS_PRINT_FMT "print.format"
1035 #define PRS_PRINT_DEST "print.destination"
1036 #define PRS_PRINT_FILE "print.file"
1037 #define PRS_PRINT_CMD "print.command"
1038 #define PRS_COL_FMT "column.format"
1039 #define PRS_STREAM_CL_FG "stream.client.fg"
1040 #define PRS_STREAM_CL_BG "stream.client.bg"
1041 #define PRS_STREAM_SR_FG "stream.server.fg"
1042 #define PRS_STREAM_SR_BG "stream.server.bg"
1043 #define PRS_GUI_SCROLLBAR_ON_RIGHT "gui.scrollbar_on_right"
1044 #define PRS_GUI_PLIST_SEL_BROWSE "gui.packet_list_sel_browse"
1045 #define PRS_GUI_PTREE_SEL_BROWSE "gui.protocol_tree_sel_browse"
1046 #define PRS_GUI_PTREE_LINE_STYLE "gui.protocol_tree_line_style"
1047 #define PRS_GUI_PTREE_EXPANDER_STYLE "gui.protocol_tree_expander_style"
1048 #define PRS_GUI_HEX_DUMP_HIGHLIGHT_STYLE "gui.hex_dump_highlight_style"
1049 #define PRS_GUI_FONT_NAME "gui.font_name"
1050 #define PRS_GUI_MARKED_FG "gui.marked_frame.fg"
1051 #define PRS_GUI_MARKED_BG "gui.marked_frame.bg"
1054 * This applies to more than just captures, so it's not "capture.name_resolve";
1055 * "capture.name_resolve" is supported on input for backwards compatibility.
1057 * It's not a preference for a particular part of Ethereal, it's used all
1058 * over the place, so its name doesn't have two components.
1060 #define PRS_NAME_RESOLVE "name_resolve"
1061 #define PRS_CAP_NAME_RESOLVE "capture.name_resolve"
1063 /* values for the capture dialog box */
1064 #define PRS_CAP_REAL_TIME "capture.real_time_update"
1065 #define PRS_CAP_PROM_MODE "capture.prom_mode"
1066 #define PRS_CAP_AUTO_SCROLL "capture.auto_scroll"
1068 #define RED_COMPONENT(x) ((((x) >> 16) & 0xff) * 65535 / 255)
1069 #define GREEN_COMPONENT(x) ((((x) >> 8) & 0xff) * 65535 / 255)
1070 #define BLUE_COMPONENT(x) (((x) & 0xff) * 65535 / 255)
1072 static gchar *pr_formats[] = { "text", "postscript" };
1073 static gchar *pr_dests[] = { "command", "file" };
1078 } name_resolve_opt_t;
1080 static name_resolve_opt_t name_resolve_opt[] = {
1081 { 'm', PREFS_RESOLV_MAC },
1082 { 'n', PREFS_RESOLV_NETWORK },
1083 { 't', PREFS_RESOLV_TRANSPORT },
1086 #define N_NAME_RESOLVE_OPT (sizeof name_resolve_opt / sizeof name_resolve_opt[0])
1089 name_resolve_to_string(guint32 name_resolve)
1091 static char string[N_NAME_RESOLVE_OPT+1];
1094 gboolean all_opts_set = TRUE;
1096 if (name_resolve == PREFS_RESOLV_NONE)
1099 for (i = 0; i < N_NAME_RESOLVE_OPT; i++) {
1100 if (name_resolve & name_resolve_opt[i].value)
1101 *p++ = name_resolve_opt[i].letter;
1103 all_opts_set = FALSE;
1112 string_to_name_resolve(char *string, guint32 *name_resolve)
1118 while ((c = *string++) != '\0') {
1119 for (i = 0; i < N_NAME_RESOLVE_OPT; i++) {
1120 if (c == name_resolve_opt[i].letter) {
1121 *name_resolve |= name_resolve_opt[i].value;
1125 if (i == N_NAME_RESOLVE_OPT) {
1127 * Unrecognized letter.
1136 set_pref(gchar *pref_name, gchar *value)
1138 GList *col_l, *col_l_elt;
1141 unsigned long int cval;
1150 if (strcmp(pref_name, PRS_PRINT_FMT) == 0) {
1151 if (strcmp(value, pr_formats[PR_FMT_TEXT]) == 0) {
1152 prefs.pr_format = PR_FMT_TEXT;
1153 } else if (strcmp(value, pr_formats[PR_FMT_PS]) == 0) {
1154 prefs.pr_format = PR_FMT_PS;
1156 return PREFS_SET_SYNTAX_ERR;
1158 } else if (strcmp(pref_name, PRS_PRINT_DEST) == 0) {
1159 if (strcmp(value, pr_dests[PR_DEST_CMD]) == 0) {
1160 prefs.pr_dest = PR_DEST_CMD;
1161 } else if (strcmp(value, pr_dests[PR_DEST_FILE]) == 0) {
1162 prefs.pr_dest = PR_DEST_FILE;
1164 return PREFS_SET_SYNTAX_ERR;
1166 } else if (strcmp(pref_name, PRS_PRINT_FILE) == 0) {
1167 if (prefs.pr_file) g_free(prefs.pr_file);
1168 prefs.pr_file = g_strdup(value);
1169 } else if (strcmp(pref_name, PRS_PRINT_CMD) == 0) {
1170 if (prefs.pr_cmd) g_free(prefs.pr_cmd);
1171 prefs.pr_cmd = g_strdup(value);
1172 } else if (strcmp(pref_name, PRS_COL_FMT) == 0) {
1173 col_l = get_string_list(value);
1175 return PREFS_SET_SYNTAX_ERR;
1176 if ((g_list_length(col_l) % 2) != 0) {
1177 /* A title didn't have a matching format. */
1178 clear_string_list(col_l);
1179 return PREFS_SET_SYNTAX_ERR;
1181 /* Check to make sure all column formats are valid. */
1182 col_l_elt = g_list_first(col_l);
1184 /* Make sure the title isn't empty. */
1185 if (strcmp(col_l_elt->data, "") == 0) {
1187 clear_string_list(col_l);
1188 return PREFS_SET_SYNTAX_ERR;
1191 /* Go past the title. */
1192 col_l_elt = col_l_elt->next;
1194 /* Check the format. */
1195 if (get_column_format_from_str(col_l_elt->data) == -1) {
1196 /* It's not a valid column format. */
1197 clear_string_list(col_l);
1198 return PREFS_SET_SYNTAX_ERR;
1201 /* Go past the format. */
1202 col_l_elt = col_l_elt->next;
1204 free_col_info(&prefs);
1205 prefs.col_list = NULL;
1206 llen = g_list_length(col_l);
1207 prefs.num_cols = llen / 2;
1208 col_l_elt = g_list_first(col_l);
1210 cfmt = (fmt_data *) g_malloc(sizeof(fmt_data));
1211 cfmt->title = g_strdup(col_l_elt->data);
1212 col_l_elt = col_l_elt->next;
1213 cfmt->fmt = g_strdup(col_l_elt->data);
1214 col_l_elt = col_l_elt->next;
1215 prefs.col_list = g_list_append(prefs.col_list, cfmt);
1217 clear_string_list(col_l);
1218 } else if (strcmp(pref_name, PRS_STREAM_CL_FG) == 0) {
1219 cval = strtoul(value, NULL, 16);
1220 prefs.st_client_fg.pixel = 0;
1221 prefs.st_client_fg.red = RED_COMPONENT(cval);
1222 prefs.st_client_fg.green = GREEN_COMPONENT(cval);
1223 prefs.st_client_fg.blue = BLUE_COMPONENT(cval);
1224 } else if (strcmp(pref_name, PRS_STREAM_CL_BG) == 0) {
1225 cval = strtoul(value, NULL, 16);
1226 prefs.st_client_bg.pixel = 0;
1227 prefs.st_client_bg.red = RED_COMPONENT(cval);
1228 prefs.st_client_bg.green = GREEN_COMPONENT(cval);
1229 prefs.st_client_bg.blue = BLUE_COMPONENT(cval);
1230 } else if (strcmp(pref_name, PRS_STREAM_SR_FG) == 0) {
1231 cval = strtoul(value, NULL, 16);
1232 prefs.st_server_fg.pixel = 0;
1233 prefs.st_server_fg.red = RED_COMPONENT(cval);
1234 prefs.st_server_fg.green = GREEN_COMPONENT(cval);
1235 prefs.st_server_fg.blue = BLUE_COMPONENT(cval);
1236 } else if (strcmp(pref_name, PRS_STREAM_SR_BG) == 0) {
1237 cval = strtoul(value, NULL, 16);
1238 prefs.st_server_bg.pixel = 0;
1239 prefs.st_server_bg.red = RED_COMPONENT(cval);
1240 prefs.st_server_bg.green = GREEN_COMPONENT(cval);
1241 prefs.st_server_bg.blue = BLUE_COMPONENT(cval);
1242 } else if (strcmp(pref_name, PRS_GUI_SCROLLBAR_ON_RIGHT) == 0) {
1243 if (strcasecmp(value, "true") == 0) {
1244 prefs.gui_scrollbar_on_right = TRUE;
1247 prefs.gui_scrollbar_on_right = FALSE;
1249 } else if (strcmp(pref_name, PRS_GUI_PLIST_SEL_BROWSE) == 0) {
1250 if (strcasecmp(value, "true") == 0) {
1251 prefs.gui_plist_sel_browse = TRUE;
1254 prefs.gui_plist_sel_browse = FALSE;
1256 } else if (strcmp(pref_name, PRS_GUI_PTREE_SEL_BROWSE) == 0) {
1257 if (strcasecmp(value, "true") == 0) {
1258 prefs.gui_ptree_sel_browse = TRUE;
1261 prefs.gui_ptree_sel_browse = FALSE;
1263 } else if (strcmp(pref_name, PRS_GUI_PTREE_LINE_STYLE) == 0) {
1264 prefs.gui_ptree_line_style =
1265 find_index_from_string_array(value, gui_ptree_line_style_text, 0);
1266 } else if (strcmp(pref_name, PRS_GUI_PTREE_EXPANDER_STYLE) == 0) {
1267 prefs.gui_ptree_expander_style =
1268 find_index_from_string_array(value, gui_ptree_expander_style_text, 1);
1269 } else if (strcmp(pref_name, PRS_GUI_HEX_DUMP_HIGHLIGHT_STYLE) == 0) {
1270 prefs.gui_hex_dump_highlight_style =
1271 find_index_from_string_array(value, gui_hex_dump_highlight_style_text, 1);
1272 } else if (strcmp(pref_name, PRS_GUI_FONT_NAME) == 0) {
1273 if (prefs.gui_font_name != NULL)
1274 g_free(prefs.gui_font_name);
1275 prefs.gui_font_name = g_strdup(value);
1276 } else if (strcmp(pref_name, PRS_GUI_MARKED_FG) == 0) {
1277 cval = strtoul(value, NULL, 16);
1278 prefs.gui_marked_fg.pixel = 0;
1279 prefs.gui_marked_fg.red = RED_COMPONENT(cval);
1280 prefs.gui_marked_fg.green = GREEN_COMPONENT(cval);
1281 prefs.gui_marked_fg.blue = BLUE_COMPONENT(cval);
1282 } else if (strcmp(pref_name, PRS_GUI_MARKED_BG) == 0) {
1283 cval = strtoul(value, NULL, 16);
1284 prefs.gui_marked_bg.pixel = 0;
1285 prefs.gui_marked_bg.red = RED_COMPONENT(cval);
1286 prefs.gui_marked_bg.green = GREEN_COMPONENT(cval);
1287 prefs.gui_marked_bg.blue = BLUE_COMPONENT(cval);
1289 /* handle the capture options */
1290 } else if (strcmp(pref_name, PRS_CAP_PROM_MODE) == 0) {
1291 prefs.capture_prom_mode = ((strcasecmp(value, "true") == 0)?TRUE:FALSE);
1293 } else if (strcmp(pref_name, PRS_CAP_REAL_TIME) == 0) {
1294 prefs.capture_real_time = ((strcasecmp(value, "true") == 0)?TRUE:FALSE);
1296 } else if (strcmp(pref_name, PRS_CAP_AUTO_SCROLL) == 0) {
1297 prefs.capture_auto_scroll = ((strcasecmp(value, "true") == 0)?TRUE:FALSE);
1299 /* handle the global options */
1300 } else if (strcmp(pref_name, PRS_NAME_RESOLVE) == 0 ||
1301 strcmp(pref_name, PRS_CAP_NAME_RESOLVE) == 0) {
1303 * "TRUE" and "FALSE", for backwards compatibility, are synonyms for
1304 * PREFS_RESOLV_ALL and PREFS_RESOLV_NONE.
1306 * Otherwise, we treat it as a list of name types we want to resolve.
1308 if (strcasecmp(value, "true") == 0)
1309 prefs.name_resolve = PREFS_RESOLV_ALL;
1310 else if (strcasecmp(value, "false") == 0)
1311 prefs.name_resolve = PREFS_RESOLV_NONE;
1313 prefs.name_resolve = PREFS_RESOLV_NONE; /* start out with none set */
1314 if (string_to_name_resolve(value, &prefs.name_resolve) != '\0')
1315 return PREFS_SET_SYNTAX_ERR;
1318 /* To which module does this preference belong? */
1319 dotp = strchr(pref_name, '.');
1321 return PREFS_SET_SYNTAX_ERR; /* no ".", so no module/name separator */
1322 *dotp = '\0'; /* separate module and preference name */
1323 module = find_module(pref_name);
1326 * XXX - "Diameter" rather than "diameter" was used in earlier
1327 * versions of Ethereal; if we didn't find the module, and its name
1328 * was "Diameter", look for "diameter" instead.
1330 if (module == NULL && strcmp(pref_name, "Diameter") == 0)
1331 module = find_module("diameter");
1332 *dotp = '.'; /* put the preference string back */
1334 return PREFS_SET_NO_SUCH_PREF; /* no such module */
1335 dotp++; /* skip past separator to preference name */
1336 pref = find_preference(module, dotp);
1339 if (strncmp(pref_name, "mgcp.", 5) == 0) {
1341 * XXX - "mgcp.display raw text toggle" and "mgcp.display dissect tree"
1342 * rather than "mgcp.display_raw_text" and "mgcp.display_dissect_tree"
1343 * were used in earlier versions of Ethereal; if we didn't find the
1344 * preference, it was an MGCP preference, and its name was
1345 * "display raw text toggle" or "display dissect tree", look for
1346 * "display_raw_text" or "display_dissect_tree" instead.
1348 * "mgcp.tcp.port" and "mgcp.udp.port" are harder to handle, as both
1349 * the gateway and callagent ports were given those names; we interpret
1350 * the first as "mgcp.{tcp,udp}.gateway_port" and the second as
1351 * "mgcp.{tcp,udp}.callagent_port", as that's the order in which
1352 * they were registered by the MCCP dissector and thus that's the
1353 * order in which they were written to the preferences file. (If
1354 * we're not reading the preferences file, but are handling stuff
1355 * from a "-o" command-line option, we have no clue which the user
1356 * had in mind - they should have used "mgcp.{tcp,udp}.gateway_port"
1357 * or "mgcp.{tcp,udp}.callagent_port" instead.)
1359 if (strcmp(dotp, "display raw text toggle") == 0)
1360 pref = find_preference(module, "display_raw_text");
1361 else if (strcmp(dotp, "display dissect tree") == 0)
1362 pref = find_preference(module, "display_dissect_tree");
1363 else if (strcmp(dotp, "tcp.port") == 0) {
1364 mgcp_tcp_port_count++;
1365 if (mgcp_tcp_port_count == 1) {
1366 /* It's the first one */
1367 pref = find_preference(module, "tcp.gateway_port");
1368 } else if (mgcp_tcp_port_count == 2) {
1369 /* It's the second one */
1370 pref = find_preference(module, "tcp.callagent_port");
1372 /* Otherwise it's from the command line, and we don't bother
1374 } else if (strcmp(dotp, "udp.port") == 0) {
1375 mgcp_udp_port_count++;
1376 if (mgcp_udp_port_count == 1) {
1377 /* It's the first one */
1378 pref = find_preference(module, "udp.gateway_port");
1379 } else if (mgcp_udp_port_count == 2) {
1380 /* It's the second one */
1381 pref = find_preference(module, "udp.callagent_port");
1383 /* Otherwise it's from the command line, and we don't bother
1389 return PREFS_SET_NO_SUCH_PREF; /* no such preference */
1391 switch (pref->type) {
1394 uval = strtoul(value, &p, pref->info.base);
1395 if (p == value || *p != '\0')
1396 return PREFS_SET_SYNTAX_ERR; /* number was bad */
1397 if (*pref->varp.uint != uval) {
1398 module->prefs_changed = TRUE;
1399 *pref->varp.uint = uval;
1404 /* XXX - give an error if it's neither "true" nor "false"? */
1405 if (strcasecmp(value, "true") == 0)
1409 if (*pref->varp.bool != bval) {
1410 module->prefs_changed = TRUE;
1411 *pref->varp.bool = bval;
1416 /* XXX - give an error if it doesn't match? */
1417 enum_val = find_val_for_string(value,
1418 pref->info.enum_info.enumvals, 1);
1419 if (*pref->varp.enump != enum_val) {
1420 module->prefs_changed = TRUE;
1421 *pref->varp.enump = enum_val;
1426 if (*pref->varp.string == NULL || strcmp(*pref->varp.string, value) != 0) {
1427 module->prefs_changed = TRUE;
1428 if (*pref->varp.string != NULL)
1429 g_free(*pref->varp.string);
1430 *pref->varp.string = g_strdup(value);
1435 return PREFS_SET_OBSOLETE; /* no such preference any more */
1439 return PREFS_SET_OK;
1448 * Write out a single preference.
1451 write_pref(gpointer data, gpointer user_data)
1453 pref_t *pref = data;
1454 write_pref_arg_t *arg = user_data;
1455 const enum_val_t *enum_valp;
1456 const char *val_string;
1458 if (pref->type == PREF_OBSOLETE) {
1460 * This preference is no longer supported; it's not a
1461 * real preference, so we don't write it out (i.e., we
1462 * treat it as if it weren't found in the list of
1463 * preferences, and we weren't called in the first place).
1468 fprintf(arg->pf, "\n# %s\n", pref->description);
1470 switch (pref->type) {
1473 switch (pref->info.base) {
1476 fprintf(arg->pf, "# A decimal number.\n");
1477 fprintf(arg->pf, "%s.%s: %u\n", arg->module->name,
1478 pref->name, *pref->varp.uint);
1482 fprintf(arg->pf, "# An octal number.\n");
1483 fprintf(arg->pf, "%s.%s: %#o\n", arg->module->name,
1484 pref->name, *pref->varp.uint);
1488 fprintf(arg->pf, "# A hexadecimal number.\n");
1489 fprintf(arg->pf, "%s.%s: %#x\n", arg->module->name,
1490 pref->name, *pref->varp.uint);
1496 fprintf(arg->pf, "# TRUE or FALSE (case-insensitive).\n");
1497 fprintf(arg->pf, "%s.%s: %s\n", arg->module->name, pref->name,
1498 *pref->varp.bool ? "TRUE" : "FALSE");
1502 fprintf(arg->pf, "# One of: ");
1503 enum_valp = pref->info.enum_info.enumvals;
1505 while (enum_valp->name != NULL) {
1506 if (enum_valp->value == *pref->varp.enump)
1507 val_string = enum_valp->name;
1508 fprintf(arg->pf, "%s", enum_valp->name);
1510 if (enum_valp->name == NULL)
1511 fprintf(arg->pf, "\n");
1513 fprintf(arg->pf, ", ");
1515 fprintf(arg->pf, "# (case-insensitive).\n");
1516 fprintf(arg->pf, "%s.%s: %s\n", arg->module->name, pref->name,
1521 fprintf(arg->pf, "# A string.\n");
1522 fprintf(arg->pf, "%s.%s: %s\n", arg->module->name, pref->name,
1523 *pref->varp.string);
1527 g_assert_not_reached();
1533 write_module_prefs(gpointer data, gpointer user_data)
1535 write_pref_arg_t arg;
1539 g_list_foreach(arg.module->prefs, write_pref, &arg);
1542 /* Write out "prefs" to the user's preferences file, and return 0.
1544 If we got an error, stuff a pointer to the path of the preferences file
1545 into "*pf_path_return", and return the errno. */
1547 write_prefs(const char **pf_path_return)
1549 const char *pf_path;
1555 * - Split output lines longer than MAX_VAL_LEN
1556 * - Create a function for the preference directory check/creation
1557 * so that duplication can be avoided with filter.c
1560 pf_path = get_persconffile_path(PF_NAME, TRUE);
1561 if ((pf = fopen(pf_path, "w")) == NULL) {
1562 *pf_path_return = pf_path;
1566 fputs("# Configuration file for Ethereal " VERSION ".\n"
1568 "# This file is regenerated each time preferences are saved within\n"
1569 "# Ethereal. Making manual changes should be safe, however.\n"
1571 "######## Printing ########\n"
1574 fprintf (pf, "# Can be one of \"text\" or \"postscript\".\n"
1575 "print.format: %s\n\n", pr_formats[prefs.pr_format]);
1577 fprintf (pf, "# Can be one of \"command\" or \"file\".\n"
1578 "print.destination: %s\n\n", pr_dests[prefs.pr_dest]);
1580 fprintf (pf, "# This is the file that gets written to when the "
1581 "destination is set to \"file\"\n"
1582 "%s: %s\n\n", PRS_PRINT_FILE, prefs.pr_file);
1584 fprintf (pf, "# Output gets piped to this command when the destination "
1585 "is set to \"command\"\n"
1586 "%s: %s\n\n", PRS_PRINT_CMD, prefs.pr_cmd);
1588 clp = prefs.col_list;
1591 cfmt = (fmt_data *) clp->data;
1592 col_l = g_list_append(col_l, cfmt->title);
1593 col_l = g_list_append(col_l, cfmt->fmt);
1596 fprintf (pf, "# Packet list column format. Each pair of strings consists "
1597 "of a column title \n# and its format.\n"
1598 "%s: %s\n\n", PRS_COL_FMT, put_string_list(col_l));
1599 /* This frees the list of strings, but not the strings to which it
1600 refers; that's what we want, as we haven't copied those strings,
1601 we just referred to them. */
1604 fprintf (pf, "# TCP stream window color preferences. Each value is a six "
1605 "digit hexadecimal value in the form rrggbb.\n");
1606 fprintf (pf, "%s: %02x%02x%02x\n", PRS_STREAM_CL_FG,
1607 (prefs.st_client_fg.red * 255 / 65535),
1608 (prefs.st_client_fg.green * 255 / 65535),
1609 (prefs.st_client_fg.blue * 255 / 65535));
1610 fprintf (pf, "%s: %02x%02x%02x\n", PRS_STREAM_CL_BG,
1611 (prefs.st_client_bg.red * 255 / 65535),
1612 (prefs.st_client_bg.green * 255 / 65535),
1613 (prefs.st_client_bg.blue * 255 / 65535));
1614 fprintf (pf, "%s: %02x%02x%02x\n", PRS_STREAM_SR_FG,
1615 (prefs.st_server_fg.red * 255 / 65535),
1616 (prefs.st_server_fg.green * 255 / 65535),
1617 (prefs.st_server_fg.blue * 255 / 65535));
1618 fprintf (pf, "%s: %02x%02x%02x\n", PRS_STREAM_SR_BG,
1619 (prefs.st_server_bg.red * 255 / 65535),
1620 (prefs.st_server_bg.green * 255 / 65535),
1621 (prefs.st_server_bg.blue * 255 / 65535));
1623 fprintf(pf, "\n# Vertical scrollbars should be on right side? TRUE/FALSE\n");
1624 fprintf(pf, PRS_GUI_SCROLLBAR_ON_RIGHT ": %s\n",
1625 prefs.gui_scrollbar_on_right == TRUE ? "TRUE" : "FALSE");
1627 fprintf(pf, "\n# Packet-list selection bar can be used to browse w/o selecting? TRUE/FALSE\n");
1628 fprintf(pf, PRS_GUI_PLIST_SEL_BROWSE ": %s\n",
1629 prefs.gui_plist_sel_browse == TRUE ? "TRUE" : "FALSE");
1631 fprintf(pf, "\n# Protocol-tree selection bar can be used to browse w/o selecting? TRUE/FALSE\n");
1632 fprintf(pf, PRS_GUI_PTREE_SEL_BROWSE ": %s\n",
1633 prefs.gui_ptree_sel_browse == TRUE ? "TRUE" : "FALSE");
1635 fprintf(pf, "\n# Protocol-tree line style. One of: NONE, SOLID, DOTTED, TABBED\n");
1636 fprintf(pf, PRS_GUI_PTREE_LINE_STYLE ": %s\n",
1637 gui_ptree_line_style_text[prefs.gui_ptree_line_style]);
1639 fprintf(pf, "\n# Protocol-tree expander style. One of: NONE, SQUARE, TRIANGLE, CIRCULAR\n");
1640 fprintf(pf, PRS_GUI_PTREE_EXPANDER_STYLE ": %s\n",
1641 gui_ptree_expander_style_text[prefs.gui_ptree_expander_style]);
1643 fprintf(pf, "\n# Hex dump highlight style. One of: BOLD, INVERSE\n");
1644 fprintf(pf, PRS_GUI_HEX_DUMP_HIGHLIGHT_STYLE ": %s\n",
1645 gui_hex_dump_highlight_style_text[prefs.gui_hex_dump_highlight_style]);
1647 fprintf(pf, "\n# Font name for packet list, protocol tree, and hex dump panes.\n");
1648 fprintf(pf, PRS_GUI_FONT_NAME ": %s\n", prefs.gui_font_name);
1650 fprintf (pf, "\n# Color preferences for a marked frame. Each value is a six "
1651 "digit hexadecimal value in the form rrggbb.\n");
1652 fprintf (pf, "%s: %02x%02x%02x\n", PRS_GUI_MARKED_FG,
1653 (prefs.gui_marked_fg.red * 255 / 65535),
1654 (prefs.gui_marked_fg.green * 255 / 65535),
1655 (prefs.gui_marked_fg.blue * 255 / 65535));
1656 fprintf (pf, "%s: %02x%02x%02x\n", PRS_GUI_MARKED_BG,
1657 (prefs.gui_marked_bg.red * 255 / 65535),
1658 (prefs.gui_marked_bg.green * 255 / 65535),
1659 (prefs.gui_marked_bg.blue * 255 / 65535));
1661 fprintf(pf, "\n# Resolve addresses to names? TRUE/FALSE/{list of address types to resolve}\n");
1662 fprintf(pf, PRS_NAME_RESOLVE ": %s\n",
1663 name_resolve_to_string(prefs.name_resolve));
1665 /* write the capture options */
1666 fprintf(pf, "\n# Capture in promiscuous mode? TRUE/FALSE\n");
1667 fprintf(pf, PRS_CAP_PROM_MODE ": %s\n",
1668 prefs.capture_prom_mode == TRUE ? "TRUE" : "FALSE");
1670 fprintf(pf, "\n# Update packet list in real time during capture? TRUE/FALSE\n");
1671 fprintf(pf, PRS_CAP_REAL_TIME ": %s\n",
1672 prefs.capture_real_time == TRUE ? "TRUE" : "FALSE");
1674 fprintf(pf, "\n# scroll packet list during capture? TRUE/FALSE\n");
1675 fprintf(pf, PRS_CAP_AUTO_SCROLL ": %s\n",
1676 prefs.capture_auto_scroll == TRUE ? "TRUE" : "FALSE");
1678 g_list_foreach(modules, write_module_prefs, pf);
1682 /* XXX - catch I/O errors (e.g. "ran out of disk space") and return
1683 an error indication, or maybe write to a new preferences file and
1684 rename that file on top of the old one only if there are not I/O
1689 /* Copy a set of preferences. */
1691 copy_prefs(e_prefs *dest, e_prefs *src)
1693 fmt_data *src_cfmt, *dest_cfmt;
1696 dest->pr_format = src->pr_format;
1697 dest->pr_dest = src->pr_dest;
1698 dest->pr_file = g_strdup(src->pr_file);
1699 dest->pr_cmd = g_strdup(src->pr_cmd);
1700 dest->col_list = NULL;
1701 for (entry = src->col_list; entry != NULL; entry = g_list_next(entry)) {
1702 src_cfmt = entry->data;
1703 dest_cfmt = (fmt_data *) g_malloc(sizeof(fmt_data));
1704 dest_cfmt->title = g_strdup(src_cfmt->title);
1705 dest_cfmt->fmt = g_strdup(src_cfmt->fmt);
1706 dest->col_list = g_list_append(dest->col_list, dest_cfmt);
1708 dest->num_cols = src->num_cols;
1709 dest->st_client_fg = src->st_client_fg;
1710 dest->st_client_bg = src->st_client_bg;
1711 dest->st_server_fg = src->st_server_fg;
1712 dest->st_server_bg = src->st_server_bg;
1713 dest->gui_scrollbar_on_right = src->gui_scrollbar_on_right;
1714 dest->gui_plist_sel_browse = src->gui_plist_sel_browse;
1715 dest->gui_ptree_sel_browse = src->gui_ptree_sel_browse;
1716 dest->gui_ptree_line_style = src->gui_ptree_line_style;
1717 dest->gui_ptree_expander_style = src->gui_ptree_expander_style;
1718 dest->gui_hex_dump_highlight_style = src->gui_hex_dump_highlight_style;
1719 dest->gui_font_name = g_strdup(src->gui_font_name);
1720 dest->gui_marked_fg = src->gui_marked_fg;
1721 dest->gui_marked_bg = src->gui_marked_bg;
1722 /* values for the capture dialog box */
1723 dest->capture_prom_mode = src->capture_prom_mode;
1724 dest->capture_real_time = src->capture_real_time;
1725 dest->capture_auto_scroll = src->capture_auto_scroll;
1726 dest->name_resolve = src->name_resolve;
1730 /* Free a set of preferences. */
1732 free_prefs(e_prefs *pr)
1734 if (pr->pr_file != NULL) {
1735 g_free(pr->pr_file);
1738 if (pr->pr_cmd != NULL) {
1743 if (pr->gui_font_name != NULL) {
1744 g_free(pr->gui_font_name);
1745 pr->gui_font_name = NULL;
1750 free_col_info(e_prefs *pr)
1754 while (pr->col_list != NULL) {
1755 cfmt = pr->col_list->data;
1756 g_free(cfmt->title);
1759 pr->col_list = g_list_remove_link(pr->col_list, pr->col_list);
1761 g_list_free(pr->col_list);
1762 pr->col_list = NULL;