Include files from the "epan" directory and subdirectories thereof with
[obnox/wireshark/wip.git] / prefs.c
diff --git a/prefs.c b/prefs.c
index ae816380542f5c5d035e68400ce340dc51185ee3..c53092da5e0601b88e6cf720cb11437c19e4780d 100644 (file)
--- a/prefs.c
+++ b/prefs.c
@@ -1,7 +1,7 @@
 /* prefs.c
  * Routines for handling preferences
  *
- * $Id: prefs.c,v 1.68 2001/10/24 07:18:36 guy Exp $
+ * $Id: prefs.c,v 1.80 2002/01/21 07:36:48 guy Exp $
  *
  * Ethereal - Network traffic analyzer
  * By Gerald Combs <gerald@ethereal.com>
 
 #include <glib.h>
 
-#include <filesystem.h>
+#include <epan/filesystem.h>
 #include "globals.h"
-#include "packet.h"
+#include <epan/resolv.h>
+#include <epan/packet.h>
 #include "file.h"
 #include "prefs.h"
-#include "proto.h"
+#include <epan/proto.h>
 #include "column.h"
 #include "print.h"
 
 #include "prefs-int.h"
 
 /* Internal functions */
+static module_t *find_module(const char *name);
+static struct preference *find_preference(module_t *, const char *);
 static int    set_pref(gchar*, gchar*);
 static GList *get_string_list(gchar *);
 static gchar *put_string_list(GList *);
@@ -110,6 +113,7 @@ prefs_register_module(const char *name, const char *title,
     void (*apply_cb)(void))
 {
        module_t *module;
+       const guchar *p;
 
        module = g_malloc(sizeof (module_t));
        module->name = name;
@@ -119,6 +123,28 @@ prefs_register_module(const char *name, const char *title,
        module->numprefs = 0;
        module->prefs_changed = FALSE;
 
+       /*
+        * Make sure that only lower-case ASCII letters, numbers,
+        * underscores, and dots appear in the module name.
+        *
+        * Crash if there is, as that's an error in the code;
+        * you can make the title a nice string with capitalization,
+        * white space, punctuation, etc., but the name can be used
+        * on the command line, and shouldn't require quoting,
+        * shifting, etc.
+        */
+       for (p = name; *p != '\0'; p++)
+               g_assert(isascii(*p) &&
+                   (islower(*p) || isdigit(*p) || *p == '_' || *p == '.'));
+
+       /*
+        * Make sure there's not already a module with that
+        * name.  Crash if there is, as that's an error in the
+        * code, and the code has to be fixed not to register
+        * more than one module with the same name.
+        */
+       g_assert(find_module(name) == NULL);
+
        modules = g_list_insert_sorted(modules, module, module_compare_name);
 
        return module;
@@ -148,11 +174,11 @@ module_match(gconstpointer a, gconstpointer b)
 }
 
 static module_t *
-find_module(char *name)
+find_module(const char *name)
 {
        GList *list_entry;
 
-       list_entry = g_list_find_custom(modules, name, module_match);
+       list_entry = g_list_find_custom(modules, (gpointer)name, module_match);
        if (list_entry == NULL)
                return NULL;    /* no such module */
        return (module_t *) list_entry->data;
@@ -217,6 +243,7 @@ register_preference(module_t *module, const char *name, const char *title,
     const char *description)
 {
        pref_t *preference;
+       const guchar *p;
 
        preference = g_malloc(sizeof (pref_t));
        preference->name = name;
@@ -224,6 +251,32 @@ register_preference(module_t *module, const char *name, const char *title,
        preference->description = description;
        preference->ordinal = module->numprefs;
 
+       /*
+        * Make sure that only lower-case ASCII letters, numbers,
+        * underscores, and dots appear in the preference name.
+        *
+        * Crash if there is, as that's an error in the code;
+        * you can make the title and description nice strings
+        * with capitalization, white space, punctuation, etc.,
+        * but the name can be used on the command line,
+        * and shouldn't require quoting, shifting, etc.
+        */
+       for (p = name; *p != '\0'; p++)
+               g_assert(isascii(*p) &&
+                   (islower(*p) || isdigit(*p) || *p == '_' || *p == '.'));
+
+       /*
+        * Make sure there's not already a preference with that
+        * name.  Crash if there is, as that's an error in the
+        * code, and the code has to be fixed not to register
+        * more than one preference with the same name.
+        */
+       g_assert(find_preference(module, name) == NULL);
+
+       /*
+        * There isn't already one with that name, so add the
+        * preference.
+        */
        module->prefs = g_list_append(module->prefs, preference);
        module->numprefs++;
 
@@ -244,11 +297,12 @@ preference_match(gconstpointer a, gconstpointer b)
 }
 
 static struct preference *
-find_preference(module_t *module, char *name)
+find_preference(module_t *module, const char *name)
 {
        GList *list_entry;
 
-       list_entry = g_list_find_custom(module->prefs, name, preference_match);
+       list_entry = g_list_find_custom(module->prefs, (gpointer)name,
+           preference_match);
        if (list_entry == NULL)
                return NULL;    /* no such preference */
        return (struct preference *) list_entry->data;
@@ -334,6 +388,18 @@ prefs_register_string_preference(module_t *module, const char *name,
        preference->saved_val.string = NULL;
 }
 
+/*
+ * Register a preference that used to be supported but no longer is.
+ */
+void
+prefs_register_obsolete_preference(module_t *module, const char *name)
+{
+       pref_t *preference;
+
+       preference = register_preference(module, name, NULL, NULL);
+       preference->type = PREF_OBSOLETE;
+}
+
 typedef struct {
        pref_cb callback;
        gpointer user_data;
@@ -345,6 +411,17 @@ do_pref_callback(gpointer data, gpointer user_data)
        pref_t *pref = data;
        pref_cb_arg_t *arg = user_data;
 
+       if (pref->type == PREF_OBSOLETE) {
+               /*
+                * This preference is no longer supported; it's not a
+                * real preference, so we don't call the callback for
+                * it (i.e., we treat it as if it weren't found in the
+                * list of preferences, and we weren't called in the
+                * first place).
+                */
+               return;
+       }
+
        (*arg->callback)(pref, arg->user_data);
 }
 
@@ -709,20 +786,27 @@ read_prefs(int *gpf_errno_return, char **gpf_path_return,
      */
     prefs.gui_font_name = g_strdup("-*-fixed-medium-r-semicondensed-*-*-120-*-*-*-*-iso8859-1");
 #endif
-    prefs.gui_marked_fg.pixel = 65535;
-    prefs.gui_marked_fg.red   = 65535;
-    prefs.gui_marked_fg.green = 65535;
-    prefs.gui_marked_fg.blue  = 65535;
-    prefs.gui_marked_bg.pixel =     0;
-    prefs.gui_marked_bg.red   =     0;
-    prefs.gui_marked_bg.green =     0;
-    prefs.gui_marked_bg.blue  =     0;
+    prefs.gui_marked_fg.pixel        =     65535;
+    prefs.gui_marked_fg.red          =     65535;
+    prefs.gui_marked_fg.green        =     65535;
+    prefs.gui_marked_fg.blue         =     65535;
+    prefs.gui_marked_bg.pixel        =         0;
+    prefs.gui_marked_bg.red          =         0;
+    prefs.gui_marked_bg.green        =         0;
+    prefs.gui_marked_bg.blue         =         0;
+    prefs.gui_geometry_save_position =         0;
+    prefs.gui_geometry_save_size     =         1;
+    prefs.gui_geometry_main_x        =        20;
+    prefs.gui_geometry_main_y        =        20;
+    prefs.gui_geometry_main_width    = DEF_WIDTH;
+    prefs.gui_geometry_main_height   =        -1;
 
 /* set the default values for the capture dialog box */
-    prefs.capture_prom_mode   =  TRUE;
+    prefs.capture_device      = NULL;
+    prefs.capture_prom_mode   = TRUE;
     prefs.capture_real_time   = FALSE;
     prefs.capture_auto_scroll = FALSE;
-    prefs.name_resolve        = PREFS_RESOLV_ALL;
+    prefs.name_resolve        = RESOLV_ALL;
   }
 
   /* Construct the pathname of the global preferences file. */
@@ -823,6 +907,13 @@ read_prefs_file(const char *pf_path, FILE *pf)
                 g_warning ("%s line %d: No such preference \"%s\"", pf_path,
                                pline, cur_var);
                 break;
+
+             case PREFS_SET_OBSOLETE:
+               /* We silently ignore attempts to set these; it's
+                  probably not the user's fault that it's in there -
+                  they may have saved preferences with a release that
+                  supported them. */
+                break;
               }
             } else {
               g_warning ("%s line %d: Incomplete preference", pf_path, pline);
@@ -884,6 +975,12 @@ read_prefs_file(const char *pf_path, FILE *pf)
         g_warning ("%s line %d: No such preference \"%s\"", pf_path,
                        pline, cur_var);
         break;
+
+      case PREFS_SET_OBSOLETE:
+       /* We silently ignore attempts to set these; it's probably not
+          the user's fault that it's in there - they may have saved
+          preferences with a release that supported it. */
+        break;
       }
     } else {
       g_warning ("%s line %d: Incomplete preference", pf_path, pline);
@@ -960,6 +1057,12 @@ prefs_set_pref(char *prefarg)
 #define PRS_GUI_FONT_NAME "gui.font_name"
 #define PRS_GUI_MARKED_FG "gui.marked_frame.fg"
 #define PRS_GUI_MARKED_BG "gui.marked_frame.bg"
+#define PRS_GUI_GEOMETRY_SAVE_POSITION "gui.geometry.save.position"
+#define PRS_GUI_GEOMETRY_SAVE_SIZE     "gui.geometry.save.size"
+#define PRS_GUI_GEOMETRY_MAIN_X        "gui.geometry.main.x"
+#define PRS_GUI_GEOMETRY_MAIN_Y        "gui.geometry.main.y"
+#define PRS_GUI_GEOMETRY_MAIN_WIDTH    "gui.geometry.main.width"
+#define PRS_GUI_GEOMETRY_MAIN_HEIGHT   "gui.geometry.main.height"
 
 /*
  * This applies to more than just captures, so it's not "capture.name_resolve";
@@ -972,8 +1075,9 @@ prefs_set_pref(char *prefarg)
 #define PRS_CAP_NAME_RESOLVE "capture.name_resolve"
 
 /*  values for the capture dialog box */
-#define PRS_CAP_REAL_TIME "capture.real_time_update"
-#define PRS_CAP_PROM_MODE "capture.prom_mode"
+#define PRS_CAP_DEVICE      "capture.device"
+#define PRS_CAP_PROM_MODE   "capture.prom_mode"
+#define PRS_CAP_REAL_TIME   "capture.real_time_update"
 #define PRS_CAP_AUTO_SCROLL "capture.auto_scroll"
 
 #define RED_COMPONENT(x)   ((((x) >> 16) & 0xff) * 65535 / 255)
@@ -989,9 +1093,9 @@ typedef struct {
 } name_resolve_opt_t;
 
 static name_resolve_opt_t name_resolve_opt[] = {
-  { 'm', PREFS_RESOLV_MAC },
-  { 'n', PREFS_RESOLV_NETWORK },
-  { 't', PREFS_RESOLV_TRANSPORT },
+  { 'm', RESOLV_MAC },
+  { 'n', RESOLV_NETWORK },
+  { 't', RESOLV_TRANSPORT },
 };
 
 #define N_NAME_RESOLVE_OPT     (sizeof name_resolve_opt / sizeof name_resolve_opt[0])
@@ -1004,7 +1108,7 @@ name_resolve_to_string(guint32 name_resolve)
   unsigned int i;
   gboolean all_opts_set = TRUE;
 
-  if (name_resolve == PREFS_RESOLV_NONE)
+  if (name_resolve == RESOLV_NONE)
     return "FALSE";
   p = &string[0];
   for (i = 0; i < N_NAME_RESOLVE_OPT; i++) {
@@ -1054,9 +1158,10 @@ set_pref(gchar *pref_name, gchar *value)
   gboolean bval;
   gint     enum_val;
   char     *p;
-  gchar    *dotp;
+  gchar    *dotp, *last_dotp;
   module_t *module;
   pref_t   *pref;
+  gboolean had_a_dot;
 
   if (strcmp(pref_name, PRS_PRINT_FMT) == 0) {
     if (strcmp(value, pr_formats[PR_FMT_TEXT]) == 0) {
@@ -1196,14 +1301,38 @@ set_pref(gchar *pref_name, gchar *value)
     prefs.gui_marked_bg.red   = RED_COMPONENT(cval);
     prefs.gui_marked_bg.green = GREEN_COMPONENT(cval);
     prefs.gui_marked_bg.blue  = BLUE_COMPONENT(cval);
+  } else if (strcmp(pref_name, PRS_GUI_GEOMETRY_SAVE_POSITION) == 0) {
+    if (strcasecmp(value, "true") == 0) {
+           prefs.gui_geometry_save_position = TRUE;
+    }
+    else {
+           prefs.gui_geometry_save_position = FALSE;
+    }
+  } else if (strcmp(pref_name, PRS_GUI_GEOMETRY_SAVE_SIZE) == 0) {
+    if (strcasecmp(value, "true") == 0) {
+           prefs.gui_geometry_save_size = TRUE;
+    }
+    else {
+           prefs.gui_geometry_save_size = FALSE;
+    }
+  } else if (strcmp(pref_name, PRS_GUI_GEOMETRY_MAIN_X) == 0) {
+    prefs.gui_geometry_main_x = strtol(value, NULL, 10);
+  } else if (strcmp(pref_name, PRS_GUI_GEOMETRY_MAIN_Y) == 0) {
+    prefs.gui_geometry_main_y = strtol(value, NULL, 10);
+  } else if (strcmp(pref_name, PRS_GUI_GEOMETRY_MAIN_WIDTH) == 0) {
+    prefs.gui_geometry_main_width = strtol(value, NULL, 10);
+  } else if (strcmp(pref_name, PRS_GUI_GEOMETRY_MAIN_HEIGHT) == 0) {
+    prefs.gui_geometry_main_height = strtol(value, NULL, 10);
 
 /* handle the capture options */ 
+  } else if (strcmp(pref_name, PRS_CAP_DEVICE) == 0) {
+    if (prefs.capture_device != NULL)
+      g_free(prefs.capture_device);
+    prefs.capture_device = g_strdup(value);
   } else if (strcmp(pref_name, PRS_CAP_PROM_MODE) == 0) {
     prefs.capture_prom_mode = ((strcasecmp(value, "true") == 0)?TRUE:FALSE); 
   } else if (strcmp(pref_name, PRS_CAP_REAL_TIME) == 0) {
     prefs.capture_real_time = ((strcasecmp(value, "true") == 0)?TRUE:FALSE); 
-
   } else if (strcmp(pref_name, PRS_CAP_AUTO_SCROLL) == 0) {
     prefs.capture_auto_scroll = ((strcasecmp(value, "true") == 0)?TRUE:FALSE); 
  
@@ -1212,38 +1341,62 @@ set_pref(gchar *pref_name, gchar *value)
             strcmp(pref_name, PRS_CAP_NAME_RESOLVE) == 0) {
     /*
      * "TRUE" and "FALSE", for backwards compatibility, are synonyms for
-     * PREFS_RESOLV_ALL and PREFS_RESOLV_NONE.
+     * RESOLV_ALL and RESOLV_NONE.
      *
      * Otherwise, we treat it as a list of name types we want to resolve.
      */
     if (strcasecmp(value, "true") == 0)
-      prefs.name_resolve = PREFS_RESOLV_ALL;
+      prefs.name_resolve = RESOLV_ALL;
     else if (strcasecmp(value, "false") == 0)
-      prefs.name_resolve = PREFS_RESOLV_NONE;
+      prefs.name_resolve = RESOLV_NONE;
     else {
-      prefs.name_resolve = PREFS_RESOLV_NONE;  /* start out with none set */
+      prefs.name_resolve = RESOLV_NONE;        /* start out with none set */
       if (string_to_name_resolve(value, &prefs.name_resolve) != '\0')
         return PREFS_SET_SYNTAX_ERR;
     }
   } else {
     /* To which module does this preference belong? */
-    dotp = strchr(pref_name, '.');
-    if (dotp == NULL)
-      return PREFS_SET_SYNTAX_ERR;     /* no ".", so no module/name separator */
-    *dotp = '\0';              /* separate module and preference name */
-    module = find_module(pref_name);
+    module = NULL;
+    last_dotp = pref_name;
+    had_a_dot = FALSE;
+    while (!module) {
+        dotp = strchr(last_dotp, '.');
+        if (dotp == NULL) {
+            if (had_a_dot) {
+              /* no such module */
+              return PREFS_SET_NO_SUCH_PREF;
+            }
+            else {
+              /* no ".", so no module/name separator */
+              return PREFS_SET_SYNTAX_ERR;
+            }
+        }
+        else {
+            had_a_dot = TRUE;
+        }
+        *dotp = '\0';          /* separate module and preference name */
+        module = find_module(pref_name);
+
+        /*
+         * XXX - "Diameter" rather than "diameter" was used in earlier
+         * versions of Ethereal; if we didn't find the module, and its name
+         * was "Diameter", look for "diameter" instead.
+         *
+         * In addition, the BEEP protocol used to be the BXXP protocol,
+         * so if we didn't find the module, and its name was "bxxp",
+         * look for "beep" instead.
+         */
+        if (module == NULL) {
+          if (strcmp(pref_name, "Diameter") == 0)
+            module = find_module("diameter");
+          else if (strcmp(pref_name, "bxxp") == 0)
+            module = find_module("beep");
+        }
+        *dotp = '.';           /* put the preference string back */
+        dotp++;                        /* skip past separator to preference name */
+        last_dotp = dotp;
+    }
 
-    /*
-     * XXX - "Diameter" rather than "diameter" was used in earlier
-     * versions of Ethereal; if we didn't find the module, and its name
-     * was "Diameter", look for "diameter" instead.
-     */
-    if (module == NULL && strcmp(pref_name, "Diameter") == 0)
-      module = find_module("diameter");
-    *dotp = '.';               /* put the preference string back */
-    if (module == NULL)
-      return PREFS_SET_NO_SUCH_PREF;   /* no such module */
-    dotp++;                    /* skip past separator to preference name */
     pref = find_preference(module, dotp);
 
     if (pref == NULL) {
@@ -1294,6 +1447,20 @@ set_pref(gchar *pref_name, gchar *value)
           /* Otherwise it's from the command line, and we don't bother
              mapping it. */
        }
+      } else if (strncmp(pref_name, "smb.", 4) == 0) {
+        /* Handle old names for SMB preferences. */
+        if (strcmp(dotp, "smb.trans.reassembly") == 0)
+          pref = find_preference(module, "trans_reassembly");
+        else if (strcmp(dotp, "smb.dcerpc.reassembly") == 0)
+          pref = find_preference(module, "dcerpc_reassembly");
+      } else if (strncmp(pref_name, "ndmp.", 5) == 0) {
+        /* Handle old names for NDMP preferences. */
+        if (strcmp(dotp, "ndmp.desegment") == 0)
+          pref = find_preference(module, "desegment");
+      } else if (strncmp(pref_name, "diameter.", 9) == 0) {
+        /* Handle old names for Diameter preferences. */
+        if (strcmp(dotp, "diameter.desegment") == 0)
+          pref = find_preference(module, "desegment");
       }
     }
     if (pref == NULL)
@@ -1341,6 +1508,9 @@ set_pref(gchar *pref_name, gchar *value)
         *pref->varp.string = g_strdup(value);
       }
       break;
+
+    case PREF_OBSOLETE:
+      return PREFS_SET_OBSOLETE;       /* no such preference any more */
     }
   }
   
@@ -1363,6 +1533,16 @@ write_pref(gpointer data, gpointer user_data)
        const enum_val_t *enum_valp;
        const char *val_string;
 
+       if (pref->type == PREF_OBSOLETE) {
+               /*
+                * This preference is no longer supported; it's not a
+                * real preference, so we don't write it out (i.e., we
+                * treat it as if it weren't found in the list of
+                * preferences, and we weren't called in the first place).
+                */
+               return;
+       }
+
        fprintf(arg->pf, "\n# %s\n", pref->description);
 
        switch (pref->type) {
@@ -1420,6 +1600,10 @@ write_pref(gpointer data, gpointer user_data)
                fprintf(arg->pf, "%s.%s: %s\n", arg->module->name, pref->name,
                    *pref->varp.string);
                break;
+
+       case PREF_OBSOLETE:
+               g_assert_not_reached();
+               break;
        }
 }
 
@@ -1552,11 +1736,32 @@ write_prefs(const char **pf_path_return)
     (prefs.gui_marked_bg.green * 255 / 65535),
     (prefs.gui_marked_bg.blue * 255 / 65535));
 
+  fprintf(pf, "\n# Save window position at exit? TRUE/FALSE\n");
+  fprintf(pf, PRS_GUI_GEOMETRY_SAVE_POSITION ": %s\n",
+                 prefs.gui_geometry_save_position == TRUE ? "TRUE" : "FALSE");
+
+  fprintf(pf, "\n# Save window size at exit? TRUE/FALSE\n");
+  fprintf(pf, PRS_GUI_GEOMETRY_SAVE_SIZE ": %s\n",
+                 prefs.gui_geometry_save_size == TRUE ? "TRUE" : "FALSE");
+
+  fprintf(pf, "\n# Main window geometry. Decimal integers.\n");
+  fprintf(pf, PRS_GUI_GEOMETRY_MAIN_X ": %d\n", prefs.gui_geometry_main_x);
+  fprintf(pf, PRS_GUI_GEOMETRY_MAIN_Y ": %d\n", prefs.gui_geometry_main_y);
+  fprintf(pf, PRS_GUI_GEOMETRY_MAIN_WIDTH ": %d\n",
+                 prefs.gui_geometry_main_width);
+  fprintf(pf, PRS_GUI_GEOMETRY_MAIN_HEIGHT ": %d\n",
+                 prefs.gui_geometry_main_height);
+
   fprintf(pf, "\n# Resolve addresses to names? TRUE/FALSE/{list of address types to resolve}\n");
   fprintf(pf, PRS_NAME_RESOLVE ": %s\n",
                  name_resolve_to_string(prefs.name_resolve));
 
 /* write the capture options */
+  if (prefs.capture_device != NULL) {
+    fprintf(pf, "\n# Default capture device\n");
+    fprintf(pf, PRS_CAP_DEVICE ": %s\n", prefs.capture_device);
+  }
+
   fprintf(pf, "\n# Capture in promiscuous mode? TRUE/FALSE\n");
   fprintf(pf, PRS_CAP_PROM_MODE ": %s\n",
                  prefs.capture_prom_mode == TRUE ? "TRUE" : "FALSE");
@@ -1613,7 +1818,14 @@ copy_prefs(e_prefs *dest, e_prefs *src)
   dest->gui_font_name = g_strdup(src->gui_font_name);
   dest->gui_marked_fg = src->gui_marked_fg;
   dest->gui_marked_bg = src->gui_marked_bg;
+  dest->gui_geometry_save_position = src->gui_geometry_save_position;
+  dest->gui_geometry_save_size = src->gui_geometry_save_size;
+  dest->gui_geometry_main_x = src->gui_geometry_main_x;
+  dest->gui_geometry_main_y = src->gui_geometry_main_y;
+  dest->gui_geometry_main_width = src->gui_geometry_main_width;
+  dest->gui_geometry_main_height = src->gui_geometry_main_height;
 /*  values for the capture dialog box */
+  dest->capture_device = g_strdup(src->capture_device);
   dest->capture_prom_mode = src->capture_prom_mode;
   dest->capture_real_time = src->capture_real_time;
   dest->capture_auto_scroll = src->capture_auto_scroll;
@@ -1638,6 +1850,10 @@ free_prefs(e_prefs *pr)
     g_free(pr->gui_font_name);
     pr->gui_font_name = NULL;
   }
+  if (pr->capture_device != NULL) {
+    g_free(pr->capture_device);
+    pr->capture_device = NULL;
+  }
 }
 
 static void