Put the value(s) of a parameter into the top-level item for that
[obnox/wireshark/wip.git] / filters.c
index 2aeacbf1d60b1041098d3af5b98150595dbdf41c..aa58bcad4cd63725e19b71b9c5da9cf302b66994 100644 (file)
--- a/filters.c
+++ b/filters.c
@@ -1,23 +1,22 @@
 /* filters.c
  * Code for reading and writing the filters file.
  *
- * $Id: filters.c,v 1.3 2001/01/28 09:13:07 guy Exp $
+ * $Id: filters.c,v 1.16 2003/12/04 00:45:37 guy Exp $
  *
  * Ethereal - Network traffic analyzer
- * By Gerald Combs <gerald@zing.org>
+ * By Gerald Combs <gerald@ethereal.com>
  * Copyright 1998 Gerald Combs
  *
- * 
  * This program is free software; you can redistribute it and/or
  * modify it under the terms of the GNU General Public License
  * as published by the Free Software Foundation; either version 2
  * of the License, or (at your option) any later version.
- * 
+ *
  * This program is distributed in the hope that it will be useful,
  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  * GNU General Public License for more details.
- * 
+ *
  * You should have received a copy of the GNU General Public License
  * along with this program; if not, write to the Free Software
  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 #include <ctype.h>
 #include <errno.h>
 
-#ifdef HAVE_SYS_STAT_H
-#include <sys/stat.h>
-#endif
-
 #ifdef HAVE_UNISTD_H
 #include <unistd.h>
 #endif
 
 #include <glib.h>
 
-#include <epan.h>
+#include <epan/filesystem.h>
 
 #include "filters.h"
-#include "util.h"
 
 /*
  * Old filter file name.
@@ -62,8 +56,6 @@
  */
 #define DFILTER_FILE_NAME      "dfilters"
 
-#define        FILTER_LINE_SIZE        2048
-
 /*
  * List of capture filters.
  */
@@ -82,18 +74,23 @@ static GList *display_filters = NULL;
  * the file we tried to read - it should be freed by our caller -
  * and "*errno_return" is set to the error.
  */
+
+#define INIT_BUF_SIZE  128
+
 void
 read_filter_list(filter_list_type_t list, char **pref_path_return,
     int *errno_return)
 {
-  char       *ff_path, *ff_dir = PF_DIR, *ff_name;
+  char       *ff_path, *ff_name;
   FILE       *ff;
   GList      **flp;
   GList      *fl_ent;
   filter_def *filt;
-  char       f_buf[FILTER_LINE_SIZE];
-  char       *name_begin, *name_end, *filt_begin;
-  int         len, line = 0;
+  int         c;
+  char       *filt_name, *filt_expr;
+  int         filt_name_len, filt_expr_len;
+  int         filt_name_index, filt_expr_index;
+  int         line = 1;
 
   *pref_path_return = NULL;    /* assume no error */
 
@@ -115,10 +112,7 @@ read_filter_list(filter_list_type_t list, char **pref_path_return,
   }
 
   /* To do: generalize this */
-  ff_path = (gchar *) g_malloc(strlen(get_home_dir()) + strlen(ff_dir) +  
-    strlen(ff_name) + 4);
-  sprintf(ff_path, "%s/%s/%s", get_home_dir(), ff_dir, ff_name);
-
+  ff_path = get_persconffile_path(ff_name, FALSE);
   if ((ff = fopen(ff_path, "r")) == NULL) {
     /*
      * Did that fail because we the file didn't exist?
@@ -140,7 +134,8 @@ read_filter_list(filter_list_type_t list, char **pref_path_return,
      * the filter lists, and delete the ones that don't belong in
      * a particular list.
      */
-    sprintf(ff_path, "%s/%s/%s", get_home_dir(), ff_dir, FILTER_FILE_NAME);
+    g_free(ff_path);
+    ff_path = get_persconffile_path(FILTER_FILE_NAME, FALSE);
     if ((ff = fopen(ff_path, "r")) == NULL) {
       /*
        * Well, that didn't work, either.  Just give up.
@@ -168,35 +163,153 @@ read_filter_list(filter_list_type_t list, char **pref_path_return,
     *flp = NULL;
   }
 
-  while (fgets(f_buf, FILTER_LINE_SIZE, ff)) {
-    line++;
-    len = strlen(f_buf);
-    if (f_buf[len - 1] == '\n') {
-      len--;
-      f_buf[len] = '\0';
+  /* Allocate the filter name buffer. */
+  filt_name_len = INIT_BUF_SIZE;
+  filt_name = g_malloc(filt_name_len + 1);
+  filt_expr_len = INIT_BUF_SIZE;
+  filt_expr = g_malloc(filt_expr_len + 1);
+
+  for (line = 1; ; line++) {
+    /* Lines in a filter file are of the form
+
+       "name" expression
+
+       where "name" is a name, in quotes - backslashes in the name
+       escape the next character, so quotes and backslashes can appear
+       in the name - and "expression" is a filter expression, not in
+       quotes, running to the end of the line. */
+
+    /* Skip over leading white space, if any. */
+    while ((c = getc(ff)) != EOF && isspace(c)) {
+      if (c == '\n') {
+       /* Blank line. */
+       continue;
+      }
     }
-    name_begin = strchr(f_buf, '"');
-    /* Empty line */
-    if (name_begin == NULL)
+
+    if (c == EOF)
+      break;   /* Nothing more to read */
+
+    /* "c" is the first non-white-space character.
+       If it's not a quote, it's an error. */
+    if (c != '"') {
+      g_warning("'%s' line %d doesn't have a quoted filter name.", ff_path,
+               line);
+      while (c != '\n')
+       c = getc(ff);   /* skip to the end of the line */
       continue;
-    name_end = strchr(name_begin + 1, '"');
-    /* No terminating quote */
-    if (name_end == NULL) {
-      g_warning("Malformed filter in '%s' line %d.", ff_path, line);
+    }
+
+    /* Get the name of the filter. */
+    filt_name_index = 0;
+    for (;;) {
+      c = getc(ff);
+      if (c == EOF || c == '\n')
+       break;  /* End of line - or end of file */
+      if (c == '"') {
+       /* Closing quote. */
+       if (filt_name_index >= filt_name_len) {
+         /* Filter name buffer isn't long enough; double its length. */
+         filt_name_len *= 2;
+         filt_name = g_realloc(filt_name, filt_name_len + 1);
+       }
+       filt_name[filt_name_index] = '\0';
+       break;
+      }
+      if (c == '\\') {
+       /* Next character is escaped */
+       c = getc(ff);
+       if (c == EOF || c == '\n')
+         break;        /* End of line - or end of file */
+      }
+      /* Add this character to the filter name string. */
+      if (filt_name_index >= filt_name_len) {
+       /* Filter name buffer isn't long enough; double its length. */
+       filt_name_len *= 2;
+       filt_name = g_realloc(filt_name, filt_name_len + 1);
+      }
+      filt_name[filt_name_index] = c;
+      filt_name_index++;
+    }
+
+    if (c == EOF) {
+      if (!ferror(ff)) {
+       /* EOF, not error; no newline seen before EOF */
+       g_warning("'%s' line %d doesn't have a newline.", ff_path,
+                 line);
+      }
+      break;   /* nothing more to read */
+    }
+
+    if (c != '"') {
+      /* No newline seen before end-of-line */
+      g_warning("'%s' line %d doesn't have a closing quote.", ff_path,
+               line);
       continue;
     }
-    name_begin++;
-    name_end[0] = '\0';
-    filt_begin  = name_end + 1;
-    while(isspace((guchar)filt_begin[0])) filt_begin++;
-    /* No filter string */
-    if (filt_begin[0] == '\0') {
-      g_warning("Malformed filter in '%s' line %d.", ff_path, line);
+
+    /* Skip over separating white space, if any. */
+    while ((c = getc(ff)) != EOF && isspace(c)) {
+      if (c == '\n')
+       break;
+    }
+
+    if (c == EOF) {
+      if (!ferror(ff)) {
+       /* EOF, not error; no newline seen before EOF */
+       g_warning("'%s' line %d doesn't have a newline.", ff_path,
+                 line);
+      }
+      break;   /* nothing more to read */
+    }
+
+    if (c == '\n') {
+      /* No filter expression */
+      g_warning("'%s' line %d doesn't have a filter expression.", ff_path,
+               line);
       continue;
     }
+
+    /* "c" is the first non-white-space character; it's the first
+       character of the filter expression. */
+    filt_expr_index = 0;
+    for (;;) {
+      /* Add this character to the filter expression string. */
+      if (filt_expr_index >= filt_expr_len) {
+       /* Filter expressioin buffer isn't long enough; double its length. */
+       filt_expr_len *= 2;
+       filt_expr = g_realloc(filt_expr, filt_expr_len + 1);
+      }
+      filt_expr[filt_expr_index] = c;
+      filt_expr_index++;
+
+      /* Get the next character. */
+      c = getc(ff);
+      if (c == EOF || c == '\n')
+       break;
+    }
+
+    if (c == EOF) {
+      if (!ferror(ff)) {
+       /* EOF, not error; no newline seen before EOF */
+       g_warning("'%s' line %d doesn't have a newline.", ff_path,
+                 line);
+      }
+      break;   /* nothing more to read */
+    }
+
+    /* We saw the ending newline; terminate the filter expression string */
+    if (filt_expr_index >= filt_expr_len) {
+      /* Filter expressioin buffer isn't long enough; double its length. */
+      filt_expr_len *= 2;
+      filt_expr = g_realloc(filt_expr, filt_expr_len + 1);
+    }
+    filt_expr[filt_expr_index] = '\0';
+
+    /* Add the new filter to the list of filters */
     filt         = (filter_def *) g_malloc(sizeof(filter_def));
-    filt->name   = g_strdup(name_begin);
-    filt->strval = g_strdup(filt_begin);
+    filt->name   = g_strdup(filt_name);
+    filt->strval = g_strdup(filt_expr);
     *flp = g_list_append(*flp, filt);
   }
   if (ferror(ff)) {
@@ -205,6 +318,8 @@ read_filter_list(filter_list_type_t list, char **pref_path_return,
   } else
     g_free(ff_path);
   fclose(ff);
+  g_free(filt_name);
+  g_free(filt_expr);
 }
 
 /*
@@ -239,7 +354,7 @@ GList *
 get_filter_list_first(filter_list_type_t list)
 {
   GList      **flp;
-  
+
   flp = get_filter_list(list);
   return g_list_first(*flp);
 }
@@ -249,11 +364,12 @@ get_filter_list_first(filter_list_type_t list)
  * Returns a pointer to the newly-added entry.
  */
 GList *
-add_to_filter_list(filter_list_type_t list, char *name, char *expression)
+add_to_filter_list(filter_list_type_t list, const char *name,
+    const char *expression)
 {
   GList      **flp;
   filter_def *filt;
-  
+
   flp = get_filter_list(list);
   filt = (filter_def *) g_malloc(sizeof(filter_def));
   filt->name = g_strdup(name);
@@ -270,7 +386,7 @@ remove_from_filter_list(filter_list_type_t list, GList *fl_entry)
 {
   GList      **flp;
   filter_def *filt;
-  
+
   flp = get_filter_list(list);
   filt = (filter_def *) fl_entry->data;
   g_free(filt->name);
@@ -291,14 +407,13 @@ void
 save_filter_list(filter_list_type_t list, char **pref_path_return,
     int *errno_return)
 {
-  gchar      *ff_path, *ff_path_new, *ff_dir = PF_DIR, *ff_name;
-  int         path_length;
+  gchar      *ff_path, *ff_path_new, *ff_name;
   GList      *fl;
   GList      *flp;
   filter_def *filt;
   FILE       *ff;
-  struct stat s_buf;
-  
+  guchar     *p, c;
+
   *pref_path_return = NULL;    /* assume no error */
 
   switch (list) {
@@ -318,25 +433,13 @@ save_filter_list(filter_list_type_t list, char **pref_path_return,
     return;
   }
 
-  path_length = strlen(get_home_dir()) + strlen(ff_dir) + strlen(ff_name)
-               + 4 + 4;
-  ff_path = (gchar *) g_malloc(path_length);
-  sprintf(ff_path, "%s/%s", get_home_dir(), ff_dir);
-
-  if (stat(ff_path, &s_buf) != 0)
-#ifdef WIN32
-    mkdir(ff_path);
-#else
-    mkdir(ff_path, 0755);
-#endif
-    
-  sprintf(ff_path, "%s/%s/%s", get_home_dir(), ff_dir, ff_name);
+  ff_path = get_persconffile_path(ff_name, TRUE);
 
   /* Write to "XXX.new", and rename if that succeeds.
      That means we don't trash the file if we fail to write it out
      completely. */
-  ff_path_new = (gchar *) g_malloc(path_length);
-  sprintf(ff_path_new, "%s/%s/%s.new", get_home_dir(), ff_dir, ff_name);
+  ff_path_new = (gchar *) g_malloc(strlen(ff_path) + 5);
+  sprintf(ff_path_new, "%s.new", ff_path);
 
   if ((ff = fopen(ff_path_new, "w")) == NULL) {
     *pref_path_return = ff_path;
@@ -347,7 +450,22 @@ save_filter_list(filter_list_type_t list, char **pref_path_return,
   flp = g_list_first(fl);
   while (flp) {
     filt = (filter_def *) flp->data;
-    fprintf(ff, "\"%s\" %s\n", filt->name, filt->strval);
+
+    /* Write out the filter name as a quoted string; escape any quotes
+       or backslashes. */
+    putc('"', ff);
+    for (p = (guchar *)filt->name; (c = *p) != '\0'; p++) {
+      if (c == '"' || c == '\\')
+        putc('\\', ff);
+      putc(c, ff);
+    }
+    putc('"', ff);
+
+    /* Separate the filter name and value with a space. */
+    putc(' ', ff);
+
+    /* Write out the filter expression and a newline. */
+    fprintf(ff, "%s\n", filt->strval);
     if (ferror(ff)) {
       *pref_path_return = ff_path;
       *errno_return = errno;
@@ -366,13 +484,27 @@ save_filter_list(filter_list_type_t list, char **pref_path_return,
     return;
   }
 
-  /* XXX - does "rename()" exist on Win32?  If so, does it remove the
-     target first?  If so, does that mean it's not atomic? */
+#ifdef WIN32
+  /* ANSI C doesn't say whether "rename()" removes the target if it
+     exists; the Win32 call to rename files doesn't do so, which I
+     infer is the reason why the MSVC++ "rename()" doesn't do so.
+     We must therefore remove the target file first, on Windows. */
+  if (remove(ff_path) < 0 && errno != ENOENT) {
+    /* It failed for some reason other than "it's not there"; if
+       it's not there, we don't need to remove it, so we just
+       drive on. */
+    *pref_path_return = ff_path;
+    *errno_return = errno;
+    unlink(ff_path_new);
+    g_free(ff_path_new);
+    return;
+  }
+#endif
+
   if (rename(ff_path_new, ff_path) < 0) {
     *pref_path_return = ff_path;
     *errno_return = errno;
     unlink(ff_path_new);
-    g_free(ff_path);
     g_free(ff_path_new);
     return;
   }