2 * Routines for handling preferences
4 * $Id: prefs.c,v 1.19 1999/07/13 02:52:57 gram Exp $
6 * Ethereal - Network traffic analyzer
7 * By Gerald Combs <gerald@zing.org>
8 * Copyright 1998 Gerald Combs
11 * This program is free software; you can redistribute it and/or
12 * modify it under the terms of the GNU General Public License
13 * as published by the Free Software Foundation; either version 2
14 * of the License, or (at your option) any later version.
16 * This program is distributed in the hope that it will be useful,
17 * but WITHOUT ANY WARRANTY; without even the implied warranty of
18 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 * GNU General Public License for more details.
21 * You should have received a copy of the GNU General Public License
22 * along with this program; if not, write to the Free Software
23 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
30 #ifdef HAVE_SYS_TYPES_H
31 #include <sys/types.h>
59 /* Internal functions */
60 static int set_pref(gchar*, gchar*);
61 static void write_prefs();
62 static void prefs_main_ok_cb(GtkWidget *, gpointer);
63 static void prefs_main_save_cb(GtkWidget *, gpointer);
64 static void prefs_main_cancel_cb(GtkWidget *, gpointer);
65 static GList *get_string_list(gchar *);
66 static void clear_string_list(GList *);
69 static int init_prefs = 1;
71 #define PF_NAME "preferences"
73 #define E_PRINT_PAGE_KEY "printer_options_page"
74 #define E_FILTER_PAGE_KEY "filter_options_page"
75 #define E_COLUMN_PAGE_KEY "column_options_page"
77 static gchar *pf_path = NULL;
80 prefs_cb(GtkWidget *w, gpointer sp) {
81 GtkWidget *prefs_w, *main_vb, *top_hb, *bbox, *prefs_nb,
82 *ok_bt, *save_bt, *cancel_bt;
83 GtkWidget *print_pg, *filter_pg, *column_pg, *filter_te, *label;
85 /* GtkWidget *nlabel; */
86 gint start_page = (gint) sp;
91 prefs_w = gtk_window_new(GTK_WINDOW_TOPLEVEL);
92 gtk_window_set_title(GTK_WINDOW(prefs_w), "Ethereal: Preferences");
94 /* Container for each row of widgets */
95 main_vb = gtk_vbox_new(FALSE, 5);
96 gtk_container_border_width(GTK_CONTAINER(main_vb), 5);
97 gtk_container_add(GTK_CONTAINER(prefs_w), main_vb);
98 gtk_widget_show(main_vb);
100 /* Top row: Preferences notebook */
101 top_hb = gtk_hbox_new(FALSE, 1);
102 gtk_container_add(GTK_CONTAINER(main_vb), top_hb);
103 gtk_widget_show(top_hb);
105 prefs_nb = gtk_notebook_new();
106 gtk_container_add(GTK_CONTAINER(main_vb), prefs_nb);
107 gtk_widget_show(prefs_nb);
110 /* nlabel = gtk_label_new("Nothing here yet...");
111 gtk_widget_show (nlabel);
113 label = gtk_label_new ("General");
114 gtk_notebook_append_page (GTK_NOTEBOOK(prefs_nb), nlabel, label);
117 print_pg = printer_prefs_show();
118 gtk_object_set_data(GTK_OBJECT(prefs_w), E_PRINT_PAGE_KEY, print_pg);
119 label = gtk_label_new ("Printing");
120 gtk_notebook_append_page (GTK_NOTEBOOK(prefs_nb), print_pg, label);
124 filter_te = gtk_object_get_data(GTK_OBJECT(w), E_FILT_TE_PTR_KEY);
125 filter_pg = filter_prefs_show(filter_te);
127 /* Pass along the entry widget pointer from the calling widget */
128 gtk_object_set_data(GTK_OBJECT(filter_pg), E_FILT_TE_PTR_KEY, filter_te);
129 gtk_object_set_data(GTK_OBJECT(prefs_w), E_FILTER_PAGE_KEY, filter_pg);
130 label = gtk_label_new ("Filters");
131 gtk_notebook_append_page (GTK_NOTEBOOK(prefs_nb), filter_pg, label);
133 column_pg = column_prefs_show();
134 gtk_object_set_data(GTK_OBJECT(prefs_w), E_COLUMN_PAGE_KEY, column_pg);
135 label = gtk_label_new ("Columns");
136 gtk_notebook_append_page (GTK_NOTEBOOK(prefs_nb), column_pg, label);
138 /* Jump to the specified page, if it was supplied */
139 if (start_page > E_PR_PG_NONE)
140 gtk_notebook_set_page(GTK_NOTEBOOK(prefs_nb), start_page);
142 /* Button row: OK and cancel buttons */
143 bbox = gtk_hbutton_box_new();
144 gtk_button_box_set_layout (GTK_BUTTON_BOX (bbox), GTK_BUTTONBOX_END);
145 gtk_button_box_set_spacing(GTK_BUTTON_BOX(bbox), 5);
146 gtk_container_add(GTK_CONTAINER(main_vb), bbox);
147 gtk_widget_show(bbox);
149 ok_bt = gtk_button_new_with_label ("OK");
150 gtk_signal_connect(GTK_OBJECT(ok_bt), "clicked",
151 GTK_SIGNAL_FUNC(prefs_main_ok_cb), GTK_OBJECT(prefs_w));
152 GTK_WIDGET_SET_FLAGS(ok_bt, GTK_CAN_DEFAULT);
153 gtk_box_pack_start (GTK_BOX (bbox), ok_bt, TRUE, TRUE, 0);
154 gtk_widget_grab_default(ok_bt);
155 gtk_widget_show(ok_bt);
157 save_bt = gtk_button_new_with_label ("Save");
158 gtk_signal_connect(GTK_OBJECT(save_bt), "clicked",
159 GTK_SIGNAL_FUNC(prefs_main_save_cb), GTK_OBJECT(prefs_w));
160 GTK_WIDGET_SET_FLAGS(save_bt, GTK_CAN_DEFAULT);
161 gtk_box_pack_start (GTK_BOX (bbox), save_bt, TRUE, TRUE, 0);
162 gtk_widget_show(save_bt);
164 cancel_bt = gtk_button_new_with_label ("Cancel");
165 gtk_signal_connect(GTK_OBJECT(cancel_bt), "clicked",
166 GTK_SIGNAL_FUNC(prefs_main_cancel_cb), GTK_OBJECT(prefs_w));
167 GTK_WIDGET_SET_FLAGS(cancel_bt, GTK_CAN_DEFAULT);
168 gtk_box_pack_start (GTK_BOX (bbox), cancel_bt, TRUE, TRUE, 0);
169 gtk_widget_show(cancel_bt);
171 gtk_widget_show(prefs_w);
175 prefs_main_ok_cb(GtkWidget *ok_bt, gpointer parent_w)
177 printer_prefs_ok(gtk_object_get_data(GTK_OBJECT(parent_w), E_PRINT_PAGE_KEY));
178 filter_prefs_ok(gtk_object_get_data(GTK_OBJECT(parent_w), E_FILTER_PAGE_KEY));
179 column_prefs_ok(gtk_object_get_data(GTK_OBJECT(parent_w), E_COLUMN_PAGE_KEY));
180 gtk_widget_destroy(GTK_WIDGET(parent_w));
184 prefs_main_save_cb(GtkWidget *save_bt, gpointer parent_w)
186 printer_prefs_save(gtk_object_get_data(GTK_OBJECT(parent_w), E_PRINT_PAGE_KEY));
187 filter_prefs_save(gtk_object_get_data(GTK_OBJECT(parent_w), E_FILTER_PAGE_KEY));
188 column_prefs_save(gtk_object_get_data(GTK_OBJECT(parent_w), E_COLUMN_PAGE_KEY));
193 prefs_main_cancel_cb(GtkWidget *cancel_bt, gpointer parent_w)
195 printer_prefs_cancel(gtk_object_get_data(GTK_OBJECT(parent_w), E_PRINT_PAGE_KEY));
196 filter_prefs_cancel(gtk_object_get_data(GTK_OBJECT(parent_w), E_FILTER_PAGE_KEY));
197 column_prefs_cancel(gtk_object_get_data(GTK_OBJECT(parent_w), E_COLUMN_PAGE_KEY));
198 gtk_widget_destroy(GTK_WIDGET(parent_w));
201 /* Parse through a list of comma-separated, quoted strings. Return a
202 list of the string data */
204 get_string_list(gchar *str) {
205 enum { PRE_QUOT, IN_QUOT, POST_QUOT };
207 gint state = PRE_QUOT, i = 0, j = 0;
208 gboolean backslash = FALSE;
209 gchar cur_c, *slstr = NULL;
212 while ((cur_c = str[i]) != '\0') {
213 if (cur_c == '"' && ! backslash) {
217 slstr = (gchar *) g_malloc(sizeof(gchar) * COL_MAX_LEN);
223 sl = g_list_append(sl, slstr);
226 clear_string_list(sl);
232 } else if (cur_c == '\\' && ! backslash) {
234 } else if (cur_c == ',' && state == POST_QUOT) {
236 } else if (state == IN_QUOT && j < COL_MAX_LEN) {
242 if (state != POST_QUOT) {
243 clear_string_list(sl);
249 clear_string_list(GList *sl) {
254 l = g_list_remove_link(l, l);
258 /* Preferences file format:
259 * - Configuration directives start at the beginning of the line, and
260 * are terminated with a colon.
261 * - Directives can be continued on the next line by preceding them with
266 # This is a comment line
268 print.file: /a/very/long/path/
273 #define MAX_VAR_LEN 32
274 #define MAX_VAL_LEN 1024
275 #define DEF_NUM_COLS 6
277 read_prefs(char **pf_path_return) {
278 enum { START, IN_VAR, PRE_VAL, IN_VAL, IN_SKIP };
280 gchar cur_var[MAX_VAR_LEN], cur_val[MAX_VAL_LEN];
281 int got_c, state = START, i;
282 gint var_len = 0, val_len = 0, fline = 1, pline = 1;
283 gboolean got_val = FALSE;
285 gchar *col_fmt[] = {"No.", "%m", "Time", "%t",
286 "Source", "%s", "Destination", "%d",
287 "Protocol", "%p", "Info", "%i"};
290 /* Initialize preferences. With any luck, these values will be
291 overwritten below. */
294 prefs.pr_format = PR_FMT_TEXT;
295 prefs.pr_dest = PR_DEST_CMD;
296 prefs.pr_file = g_strdup("ethereal.out");
297 prefs.pr_cmd = g_strdup("lpr");
298 prefs.col_list = NULL;
299 for (i = 0; i < DEF_NUM_COLS; i++) {
300 cfmt = (fmt_data *) g_malloc(sizeof(fmt_data));
301 cfmt->title = g_strdup(col_fmt[i * 2]);
302 cfmt->fmt = g_strdup(col_fmt[(i * 2) + 1]);
303 prefs.col_list = g_list_append(prefs.col_list, cfmt);
305 prefs.num_cols = DEF_NUM_COLS;
309 pf_path = (gchar *) g_malloc(strlen(getenv("HOME")) + strlen(PF_DIR) +
310 strlen(PF_NAME) + 4);
311 sprintf(pf_path, "%s/%s/%s", getenv("HOME"), PF_DIR, PF_NAME);
314 *pf_path_return = NULL;
315 if ((pf = fopen(pf_path, "r")) == NULL) {
317 *pf_path_return = pf_path;
321 while ((got_c = getc(pf)) != EOF) {
327 if (var_len >= MAX_VAR_LEN) {
328 g_warning ("%s line %d: Variable too long", pf_path, fline);
333 if (val_len >= MAX_VAL_LEN) {
334 g_warning ("%s line %d: Value too long", pf_path, fline);
342 if (isalnum(got_c)) {
345 cur_var[var_len] = '\0';
346 cur_val[val_len] = '\0';
347 if (! set_pref(cur_var, cur_val))
348 g_warning ("%s line %d: Bogus preference", pf_path, pline);
350 g_warning ("%s line %d: Incomplete preference", pf_path, pline);
358 } else if (isspace(got_c) && var_len > 0 && got_val) {
360 } else if (got_c == '#') {
363 g_warning ("%s line %d: Malformed line", pf_path, fline);
368 cur_var[var_len] = got_c;
377 if (!isspace(got_c)) {
379 cur_val[val_len] = got_c;
385 cur_val[val_len] = got_c;
388 while (isspace(cur_val[val_len]) && val_len > 0)
397 cur_var[var_len] = '\0';
398 cur_val[val_len] = '\0';
399 if (! set_pref(cur_var, cur_val))
400 g_warning ("%s line %d: Bogus preference", pf_path, pline);
402 g_warning ("%s line %d: Incomplete preference", pf_path, pline);
410 #define PRS_PRINT_FMT "print.format"
411 #define PRS_PRINT_DEST "print.destination"
412 #define PRS_PRINT_FILE "print.file"
413 #define PRS_PRINT_CMD "print.command"
414 #define PRS_COL_FMT "column.format"
416 static gchar *pr_formats[] = { "text", "postscript" };
417 static gchar *pr_dests[] = { "command", "file" };
420 set_pref(gchar *pref, gchar *value) {
425 if (strcmp(pref, PRS_PRINT_FMT) == 0) {
426 if (strcmp(value, pr_formats[PR_FMT_TEXT]) == 0) {
427 prefs.pr_format = PR_FMT_TEXT;
428 } else if (strcmp(value, pr_formats[PR_FMT_PS]) == 0) {
429 prefs.pr_format = PR_FMT_PS;
433 } else if (strcmp(pref, PRS_PRINT_DEST) == 0) {
434 if (strcmp(value, pr_dests[PR_DEST_CMD]) == 0) {
435 prefs.pr_dest = PR_DEST_CMD;
436 } else if (strcmp(value, pr_dests[PR_DEST_FILE]) == 0) {
437 prefs.pr_dest = PR_DEST_FILE;
441 } else if (strcmp(pref, PRS_PRINT_FILE) == 0) {
442 if (prefs.pr_file) g_free(prefs.pr_file);
443 prefs.pr_file = g_strdup(value);
444 } else if (strcmp(pref, PRS_PRINT_CMD) == 0) {
445 if (prefs.pr_cmd) g_free(prefs.pr_cmd);
446 prefs.pr_cmd = g_strdup(value);
447 } else if (strcmp(pref, PRS_COL_FMT) == 0) {
448 if ((col_l = get_string_list(value)) && (g_list_length(col_l) % 2) == 0) {
449 while (prefs.col_list) {
450 cfmt = prefs.col_list->data;
454 prefs.col_list = g_list_remove_link(prefs.col_list, prefs.col_list);
456 llen = g_list_length(col_l);
457 prefs.num_cols = llen / 2;
458 col_l = g_list_first(col_l);
460 cfmt = (fmt_data *) g_malloc(sizeof(fmt_data));
461 cfmt->title = g_strdup(col_l->data);
463 cfmt->fmt = g_strdup(col_l->data);
465 prefs.col_list = g_list_append(prefs.col_list, cfmt);
467 /* To do: else print some sort of error? */
469 clear_string_list(col_l);
483 * - Split output lines longer than MAX_VAL_LEN
484 * - Create a function for the preference directory check/creation
485 * so that duplication can be avoided with filter.c
489 pf_path = (gchar *) g_malloc(strlen(getenv("HOME")) + strlen(PF_DIR) +
490 strlen(PF_NAME) + 4);
493 sprintf(pf_path, "%s/%s", getenv("HOME"), PF_DIR);
494 if (stat(pf_path, &s_buf) != 0)
498 mkdir(pf_path, 0755);
501 sprintf(pf_path, "%s/%s/%s", getenv("HOME"), PF_DIR, PF_NAME);
502 if ((pf = fopen(pf_path, "w")) == NULL) {
503 simple_dialog(ESD_TYPE_WARN, NULL,
504 "Can't open preferences file\n\"%s\".", pf_path);
508 fputs("# Configuration file for Ethereal " VERSION ".\n"
510 "# This file is regenerated each time preferences are saved within\n"
511 "# Ethereal. Making manual changes should be safe, however.\n"
513 "######## Printing ########\n"
516 fprintf (pf, "# Can be one of \"text\" or \"postscript\".\n"
517 "print.format: %s\n\n", pr_formats[prefs.pr_format]);
519 fprintf (pf, "# Can be one of \"command\" or \"file\".\n"
520 "print.destination: %s\n\n", pr_dests[prefs.pr_dest]);
522 fprintf (pf, "# This is the file that gets written to when the "
523 "destination is set to \"file\"\n"
524 "%s: %s\n\n", PRS_PRINT_FILE, prefs.pr_file);
526 fprintf (pf, "# Output gets piped to this command when the destination "
527 "is set to \"command\"\n"
528 "%s: %s\n\n", PRS_PRINT_CMD, prefs.pr_cmd);
530 fprintf (pf, "# Packet list column format. Each pair of strings consists "
531 "of a column title \n# and its format.\n"
532 "%s: %s\n\n", PRS_COL_FMT, col_format_to_pref_str());