* Added patches from Laurent and Guy
[obnox/wireshark/wip.git] / prefs.c
1 /* prefs.c
2  * Routines for handling preferences
3  *
4  * $Id: prefs.c,v 1.11 1998/11/18 03:01:42 gerald Exp $
5  *
6  * Ethereal - Network traffic analyzer
7  * By Gerald Combs <gerald@zing.org>
8  * Copyright 1998 Gerald Combs
9  *
10  * 
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.
15  * 
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.
20  * 
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.
24  */
25
26 #ifdef HAVE_CONFIG_H
27 # include "config.h"
28 #endif
29
30 #ifdef HAVE_SYS_TYPES_H
31 #include <sys/types.h>
32 #endif
33
34 #include <gtk/gtk.h>
35
36 #include <ctype.h>
37 #include <errno.h>
38 #include <unistd.h>
39 #include <sys/stat.h>
40
41 #include "ethereal.h"
42 #include "packet.h"
43 #include "file.h"
44 #include "prefs.h"
45 #include "column.h"
46 #include "print.h"
47 #include "filter.h"
48 #include "util.h"
49
50 /* Internal functions */
51 static int    set_pref(gchar*, gchar*);
52 static void   write_prefs();
53 static void   prefs_main_ok_cb(GtkWidget *, gpointer);
54 static void   prefs_main_save_cb(GtkWidget *, gpointer);
55 static void   prefs_main_cancel_cb(GtkWidget *, gpointer);
56 static GList *get_string_list(gchar *);
57 static void   clear_string_list(GList *);
58
59 e_prefs prefs;
60 static int init_prefs = 1;
61
62 #define PF_NAME "preferences"
63
64 #define E_PRINT_PAGE_KEY  "printer_options_page"
65 #define E_FILTER_PAGE_KEY "filter_options_page"
66 #define E_COLUMN_PAGE_KEY "column_options_page"
67
68 static gchar *pf_path = NULL;
69
70 void
71 prefs_cb(GtkWidget *w, gpointer sp) {
72   GtkWidget *prefs_w, *main_vb, *top_hb, *bbox, *prefs_nb,
73             *ok_bt, *save_bt, *cancel_bt;
74   GtkWidget *print_pg, *filter_pg, *column_pg, *filter_te, *label;
75 /*  GtkWidget *nlabel; */
76   gint       start_page = (gint) sp;
77
78   prefs_w = gtk_window_new(GTK_WINDOW_TOPLEVEL);
79   gtk_window_set_title(GTK_WINDOW(prefs_w), "Ethereal: Preferences");
80   
81   /* Container for each row of widgets */
82   main_vb = gtk_vbox_new(FALSE, 5);
83   gtk_container_border_width(GTK_CONTAINER(main_vb), 5);
84   gtk_container_add(GTK_CONTAINER(prefs_w), main_vb);
85   gtk_widget_show(main_vb);
86   
87   /* Top row: Preferences notebook */
88   top_hb = gtk_hbox_new(FALSE, 1);
89   gtk_container_add(GTK_CONTAINER(main_vb), top_hb);
90   gtk_widget_show(top_hb);
91   
92   prefs_nb = gtk_notebook_new();
93   gtk_container_add(GTK_CONTAINER(main_vb), prefs_nb);
94   gtk_widget_show(prefs_nb);
95   
96   /* General prefs */
97 /*   nlabel = gtk_label_new("Nothing here yet...");
98   gtk_widget_show (nlabel);
99
100   label = gtk_label_new ("General");
101   gtk_notebook_append_page (GTK_NOTEBOOK(prefs_nb), nlabel, label);
102  */  
103   /* Printing prefs */
104   print_pg = printer_prefs_show();
105   gtk_object_set_data(GTK_OBJECT(prefs_w), E_PRINT_PAGE_KEY, print_pg);
106   label = gtk_label_new ("Printing");
107   gtk_notebook_append_page (GTK_NOTEBOOK(prefs_nb), print_pg, label);
108     
109   /* Filter prefs */
110   filter_te = gtk_object_get_data(GTK_OBJECT(w), E_FILT_TE_PTR_KEY);
111   filter_pg = filter_prefs_show(filter_te);
112   
113   /* Pass along the entry widget pointer from the calling widget */
114   gtk_object_set_data(GTK_OBJECT(filter_pg), E_FILT_TE_PTR_KEY, filter_te);
115   gtk_object_set_data(GTK_OBJECT(prefs_w), E_FILTER_PAGE_KEY, filter_pg);
116   label = gtk_label_new ("Filters");
117   gtk_notebook_append_page (GTK_NOTEBOOK(prefs_nb), filter_pg, label);
118
119   /* Column prefs */
120   column_pg = column_prefs_show();
121   gtk_object_set_data(GTK_OBJECT(prefs_w), E_COLUMN_PAGE_KEY, column_pg);
122   label = gtk_label_new ("Columns");
123   gtk_notebook_append_page (GTK_NOTEBOOK(prefs_nb), column_pg, label);
124   
125   /* Jump to the specified page, if it was supplied */
126   if (start_page > E_PR_PG_NONE)
127     gtk_notebook_set_page(GTK_NOTEBOOK(prefs_nb), start_page);
128     
129   /* Button row: OK and cancel buttons */
130   bbox = gtk_hbutton_box_new();
131   gtk_button_box_set_layout (GTK_BUTTON_BOX (bbox), GTK_BUTTONBOX_END);
132   gtk_button_box_set_spacing(GTK_BUTTON_BOX(bbox), 5);
133   gtk_container_add(GTK_CONTAINER(main_vb), bbox);
134   gtk_widget_show(bbox);
135   
136   ok_bt = gtk_button_new_with_label ("OK");
137   gtk_signal_connect_object(GTK_OBJECT(ok_bt), "clicked",
138     GTK_SIGNAL_FUNC(prefs_main_ok_cb), GTK_OBJECT(prefs_w));
139   GTK_WIDGET_SET_FLAGS(ok_bt, GTK_CAN_DEFAULT);
140   gtk_box_pack_start (GTK_BOX (bbox), ok_bt, TRUE, TRUE, 0);
141   gtk_widget_grab_default(ok_bt);
142   gtk_widget_show(ok_bt);
143
144   save_bt = gtk_button_new_with_label ("Save");
145   gtk_signal_connect_object(GTK_OBJECT(save_bt), "clicked",
146     GTK_SIGNAL_FUNC(prefs_main_save_cb), GTK_OBJECT(prefs_w));
147   GTK_WIDGET_SET_FLAGS(save_bt, GTK_CAN_DEFAULT);
148   gtk_box_pack_start (GTK_BOX (bbox), save_bt, TRUE, TRUE, 0);
149   gtk_widget_show(save_bt);
150   
151   cancel_bt = gtk_button_new_with_label ("Cancel");
152   gtk_signal_connect_object(GTK_OBJECT(cancel_bt), "clicked",
153     GTK_SIGNAL_FUNC(prefs_main_cancel_cb), GTK_OBJECT(prefs_w));
154   GTK_WIDGET_SET_FLAGS(cancel_bt, GTK_CAN_DEFAULT);
155   gtk_box_pack_start (GTK_BOX (bbox), cancel_bt, TRUE, TRUE, 0);
156   gtk_widget_show(cancel_bt);
157
158   gtk_widget_show(prefs_w);
159 }
160
161 void
162 prefs_main_ok_cb(GtkWidget *w, gpointer win) {
163   
164   printer_prefs_ok(gtk_object_get_data(GTK_OBJECT(win), E_PRINT_PAGE_KEY));
165   filter_prefs_ok(gtk_object_get_data(GTK_OBJECT(win), E_FILTER_PAGE_KEY));
166   column_prefs_ok(gtk_object_get_data(GTK_OBJECT(win), E_COLUMN_PAGE_KEY));
167   gtk_widget_destroy(GTK_WIDGET(win));
168 }
169
170 void
171 prefs_main_save_cb(GtkWidget *w, gpointer win) {
172   printer_prefs_save(gtk_object_get_data(GTK_OBJECT(win), E_PRINT_PAGE_KEY));
173   filter_prefs_save(gtk_object_get_data(GTK_OBJECT(win), E_FILTER_PAGE_KEY));
174   column_prefs_save(gtk_object_get_data(GTK_OBJECT(win), E_COLUMN_PAGE_KEY));
175   write_prefs();
176 }
177
178 void
179 prefs_main_cancel_cb(GtkWidget *w, gpointer win) {
180
181   printer_prefs_cancel(gtk_object_get_data(GTK_OBJECT(win), E_PRINT_PAGE_KEY));
182   filter_prefs_cancel(gtk_object_get_data(GTK_OBJECT(win), E_FILTER_PAGE_KEY));
183   column_prefs_cancel(gtk_object_get_data(GTK_OBJECT(win), E_COLUMN_PAGE_KEY));
184   gtk_widget_destroy(GTK_WIDGET(win));
185 }
186
187 /* Parse through a list of comma-separated, quoted strings.  Return a
188    list of the string data */
189 static GList *
190 get_string_list(gchar *str) {
191   enum { PRE_QUOT, IN_QUOT, POST_QUOT };
192
193   gint      state = PRE_QUOT, i = 0, j = 0;
194   gboolean  backslash = FALSE;
195   gchar     cur_c, *slstr = NULL;
196   GList    *sl = NULL;
197   
198   while ((cur_c = str[i]) != '\0') {
199     if (cur_c == '"' && ! backslash) {
200       switch (state) {
201         case PRE_QUOT:
202           state = IN_QUOT;
203           slstr = (gchar *) g_malloc(sizeof(gchar) * COL_MAX_LEN);
204           j = 0;
205           break;
206         case IN_QUOT:
207           state  = POST_QUOT;
208           slstr[j] = '\0';
209           sl = g_list_append(sl, slstr);
210           break;
211         case POST_QUOT:
212           clear_string_list(sl);
213           return NULL;
214           break;
215         default:
216           break;
217       }
218     } else if (cur_c == '\\' && ! backslash) {
219       backslash = TRUE;
220     } else if (cur_c == ',' && state == POST_QUOT) {
221       state = PRE_QUOT;
222     } else if (state == IN_QUOT && j < COL_MAX_LEN) {
223       slstr[j] = str[i];
224       j++;
225     }
226     i++;
227   }
228   if (state != POST_QUOT) {
229     clear_string_list(sl);
230   }
231   return(sl);
232 }
233
234 void
235 clear_string_list(GList *sl) {
236   GList *l = sl;
237   
238   while (l) {
239     g_free(l->data);
240     l = g_list_remove_link(l, l);
241   }
242 }
243
244 /* Preferences file format:
245  * - Configuration directives start at the beginning of the line, and 
246  *   are terminated with a colon.
247  * - Directives can be continued on the next line by preceding them with
248  *   whitespace.
249  *
250  * Example:
251
252 # This is a comment line
253 print.command: lpr
254 print.file: /a/very/long/path/
255         to/ethereal-out.ps
256  *
257  */
258
259 #define MAX_VAR_LEN    32
260 #define MAX_VAL_LEN  1024
261 #define DEF_NUM_COLS    6
262 e_prefs *
263 read_prefs() {
264   enum { START, IN_VAR, PRE_VAL, IN_VAL, IN_SKIP };
265   FILE     *pf;
266   gchar     cur_var[MAX_VAR_LEN], cur_val[MAX_VAL_LEN];
267   int       got_c, state = START, i;
268   gint      var_len = 0, val_len = 0, fline = 1, pline = 1;
269   gboolean  got_val = FALSE;
270   fmt_data *cfmt;
271   gchar    *col_fmt[] = {"No.",      "%m", "Time",        "%t",
272                          "Source",   "%s", "Destination", "%d",
273                          "Protocol", "%p", "Info",        "%i"};
274
275   
276   /* Initialize preferences.  With any luck, these values will be
277      overwritten below. */
278   if (init_prefs) {
279     init_prefs       = 0;
280     prefs.pr_format  = PR_FMT_TEXT;
281     prefs.pr_dest    = PR_DEST_CMD;
282     prefs.pr_file    = g_strdup("ethereal.out");
283     prefs.pr_cmd     = g_strdup("lpr");
284     prefs.col_list = NULL;
285     for (i = 0; i < DEF_NUM_COLS; i++) {
286       cfmt = (fmt_data *) g_malloc(sizeof(fmt_data));
287       cfmt->title = g_strdup(col_fmt[i * 2]);
288       cfmt->fmt   = g_strdup(col_fmt[(i * 2) + 1]);
289       prefs.col_list = g_list_append(prefs.col_list, cfmt);
290     }
291     prefs.num_cols  = DEF_NUM_COLS;
292   }
293
294   if (! pf_path) {
295     pf_path = (gchar *) g_malloc(strlen(getenv("HOME")) + strlen(PF_DIR) +
296       strlen(PF_NAME) + 4);
297     sprintf(pf_path, "%s/%s/%s", getenv("HOME"), PF_DIR, PF_NAME);
298   }
299     
300   if ((pf = fopen(pf_path, "r")) == NULL) {
301     if (errno != ENOENT) {
302       simple_dialog(ESD_TYPE_WARN, NULL,
303         "Can't open preferences file\n\"%s\".", pf_path);
304     }
305     return &prefs;
306   }
307     
308   while ((got_c = getc(pf)) != EOF) {
309     if (got_c == '\n') {
310       state = START;
311       fline++;
312       continue;
313     }
314     if (var_len >= MAX_VAR_LEN) {
315       g_warning ("%s line %d: Variable too long", pf_path, fline);
316       state = IN_SKIP;
317       var_len = 0;
318       continue;
319     }
320     if (val_len >= MAX_VAL_LEN) {
321       g_warning ("%s line %d: Value too long", pf_path, fline);
322       state = IN_SKIP;
323       var_len = 0;
324       continue;
325     }
326     
327     switch (state) {
328       case START:
329         if (isalnum(got_c)) {
330           if (var_len > 0) {
331             if (got_val) {
332               cur_var[var_len] = '\0';
333               cur_val[val_len] = '\0';
334               if (! set_pref(cur_var, cur_val))
335                 g_warning ("%s line %d: Bogus preference", pf_path, pline);
336             } else {
337               g_warning ("%s line %d: Incomplete preference", pf_path, pline);
338             }
339           }
340           state      = IN_VAR;
341           got_val    = FALSE;
342           cur_var[0] = got_c;
343           var_len    = 1;
344           pline = fline;
345         } else if (isspace(got_c) && var_len > 0 && got_val) {
346           state = PRE_VAL;
347         } else if (got_c == '#') {
348           state = IN_SKIP;
349         } else {
350           g_warning ("%s line %d: Malformed line", pf_path, fline);
351         }
352         break;
353       case IN_VAR:
354         if (got_c != ':') {
355           cur_var[var_len] = got_c;
356           var_len++;
357         } else {
358           state   = PRE_VAL;
359           val_len = 0;
360           got_val = TRUE;
361         }
362         break;
363       case PRE_VAL:
364         if (!isspace(got_c)) {
365           state = IN_VAL;
366           cur_val[val_len] = got_c;
367           val_len++;
368         }
369         break;
370       case IN_VAL:
371         if (got_c != '#')  {
372           cur_val[val_len] = got_c;
373           val_len++;
374         } else {
375           while (isspace(cur_val[val_len]) && val_len > 0)
376             val_len--;
377           state = IN_SKIP;
378         }
379         break;
380     }
381   }
382   if (var_len > 0) {
383     if (got_val) {
384       cur_var[var_len] = '\0';
385       cur_val[val_len] = '\0';
386       if (! set_pref(cur_var, cur_val))
387         g_warning ("%s line %d: Bogus preference", pf_path, pline);
388     } else {
389       g_warning ("%s line %d: Incomplete preference", pf_path, pline);
390     }
391   }
392   fclose(pf);
393   
394   return &prefs;
395 }
396
397 #define PRS_PRINT_FMT  "print.format"
398 #define PRS_PRINT_DEST "print.destination"
399 #define PRS_PRINT_FILE "print.file"
400 #define PRS_PRINT_CMD  "print.command"
401 #define PRS_COL_FMT    "column.format"
402
403 static gchar *pr_formats[] = { "text", "postscript" };
404 static gchar *pr_dests[]   = { "command", "file" };
405
406 int
407 set_pref(gchar *pref, gchar *value) {
408   GList    *col_l;
409   gint      llen;
410   fmt_data *cfmt;
411
412   if (strcmp(pref, PRS_PRINT_FMT) == 0) {
413     if (strcmp(value, pr_formats[PR_FMT_TEXT]) == 0) {
414       prefs.pr_format = PR_FMT_TEXT;
415     } else if (strcmp(value, pr_formats[PR_FMT_PS]) == 0) {
416       prefs.pr_format = PR_FMT_PS;
417     } else {
418       return 0;
419     }
420   } else if (strcmp(pref, PRS_PRINT_DEST) == 0) {
421     if (strcmp(value, pr_dests[PR_DEST_CMD]) == 0) {
422       prefs.pr_dest = PR_DEST_CMD;
423     } else if (strcmp(value, pr_dests[PR_DEST_FILE]) == 0) {
424       prefs.pr_dest = PR_DEST_FILE;
425     } else {
426       return 0;
427     }
428   } else if (strcmp(pref, PRS_PRINT_FILE) == 0) {
429     if (prefs.pr_file) g_free(prefs.pr_file);
430     prefs.pr_file = g_strdup(value);
431   } else if (strcmp(pref, PRS_PRINT_CMD) == 0) {
432     if (prefs.pr_cmd) g_free(prefs.pr_cmd);
433     prefs.pr_cmd = g_strdup(value);
434   } else if (strcmp(pref, PRS_COL_FMT) == 0) {
435     if ((col_l = get_string_list(value)) && (g_list_length(col_l) % 2) == 0) {
436       while (prefs.col_list) {
437         cfmt = prefs.col_list->data;
438         g_free(cfmt->title);
439         g_free(cfmt->fmt);
440         g_free(cfmt);
441         prefs.col_list = g_list_remove_link(prefs.col_list, prefs.col_list);
442       }
443       llen             = g_list_length(col_l);
444       prefs.num_cols   = llen / 2;
445       col_l = g_list_first(col_l);
446       while(col_l) {
447         cfmt = (fmt_data *) g_malloc(sizeof(fmt_data));
448         cfmt->title    = g_strdup(col_l->data);
449         col_l          = col_l->next;
450         cfmt->fmt      = g_strdup(col_l->data);
451         col_l          = col_l->next;
452         prefs.col_list = g_list_append(prefs.col_list, cfmt);
453       }
454       /* To do: else print some sort of error? */
455     }
456     clear_string_list(col_l);
457   } else {
458     return 0;
459   }
460   
461   return 1;
462 }
463
464 void
465 write_prefs() {
466   FILE        *pf;
467   struct stat  s_buf;
468   
469   /* To do:
470    * - Split output lines longer than MAX_VAL_LEN
471    * - Create a function for the preference directory check/creation
472    *   so that duplication can be avoided with filter.c
473    */
474
475   if (! pf_path) {
476     pf_path = (gchar *) g_malloc(strlen(getenv("HOME")) + strlen(PF_DIR) +
477       strlen(PF_NAME) + 4);
478   }
479
480   sprintf(pf_path, "%s/%s", getenv("HOME"), PF_DIR);
481   if (stat(pf_path, &s_buf) != 0)
482     mkdir(pf_path, 0755);
483
484   sprintf(pf_path, "%s/%s/%s", getenv("HOME"), PF_DIR, PF_NAME);
485   if ((pf = fopen(pf_path, "w")) == NULL) {
486      simple_dialog(ESD_TYPE_WARN, NULL,
487       "Can't open preferences file\n\"%s\".", pf_path);
488    return;
489  }
490     
491   fputs("# Configuration file for Ethereal " VERSION ".\n"
492     "#\n"
493     "# This file is regenerated each time preferences are saved within\n"
494     "# Ethereal.  Making manual changes should be safe, however.\n"
495     "\n"
496     "######## Printing ########\n"
497     "\n", pf);
498
499   fprintf (pf, "# Can be one of \"text\" or \"postscript\".\n"
500     "print.format: %s\n\n", pr_formats[prefs.pr_format]);
501
502   fprintf (pf, "# Can be one of \"command\" or \"file\".\n"
503     "print.destination: %s\n\n", pr_dests[prefs.pr_dest]);
504
505   fprintf (pf, "# This is the file that gets written to when the "
506     "destination is set to \"file\"\n"
507     "%s: %s\n\n", PRS_PRINT_FILE, prefs.pr_file);
508
509   fprintf (pf, "# Output gets piped to this command when the destination "
510     "is set to \"command\"\n"
511     "%s: %s\n\n", PRS_PRINT_CMD, prefs.pr_cmd);
512
513   fprintf (pf, "# Packet list column format.  Each pair of strings consists "
514     "of a column title \n# and its format.\n"
515     "%s: %s\n\n", PRS_COL_FMT, col_format_to_pref_str());
516
517   fclose(pf);
518 }