prefs.c

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