As suggested by Anders: back out 37112.
[obnox/wireshark/wip.git] / color_filters.c
index 1cf34806f0aa9f6e40348aec358e64919184e60a..267a5ba6a548280bc28a38b1d2ecd494425cba1a 100644 (file)
 /*
  * Updated 1 Dec 10 jjm
  */
+
 #ifdef HAVE_CONFIG_H
 # include "config.h"
 #endif
 
 #include <glib.h>
+
+#include <stdio.h>
 #include <ctype.h>
 #include <string.h>
 
 #include <epan/filesystem.h>
-#include "file_util.h"
+#include <wsutil/file_util.h>
 
 #include <epan/packet.h>
 #include "color.h"
 #include <epan/dfilter/dfilter.h>
 #include "simple_dialog.h"
 #include "ui_util.h"
+#include <epan/prefs.h>
+
+#define RED_COMPONENT(x)   (guint16) (((((x) >> 16) & 0xff) * 65535 / 255))
+#define GREEN_COMPONENT(x) (guint16) (((((x) >>  8) & 0xff) * 65535 / 255))
+#define BLUE_COMPONENT(x)  (guint16) ( (((x)        & 0xff) * 65535 / 255))
 
 static gboolean read_users_filters(GSList **cfl);
 
 /* the currently active filters */
 static GSList *color_filter_list = NULL;
 
-/* keep "old" deleted filters in this list until 
+/* keep "old" deleted filters in this list until
  * the dissection no longer needs them (e.g. file is closed) */
 static GSList *color_filter_deleted_list = NULL;
+static GSList *color_filter_valid_list = NULL;
 
 /* Color Filters can en-/disabled. */
-gboolean filters_enabled = TRUE;
+static gboolean filters_enabled = TRUE;
 
+/* Remember if there are temporary coloring filters set to
+ * add sensitivity to the "Reset Coloring 1-10" menu item
+ */
+static gboolean tmp_colors_set = FALSE;
 
 /* Create a new filter */
 color_filter_t *
 color_filter_new(const gchar *name,    /* The name of the filter to create */
                  const gchar *filter_string, /* The string representing the filter */
                  color_t *bg_color,    /* The background color */
-                 color_t *fg_color)    /* The foreground color */
+                 color_t *fg_color,    /* The foreground color */
+                 gboolean disabled)     /* Is the filter disabled? */
 {
        color_filter_t *colorf;
 
-       colorf = g_malloc(sizeof (color_filter_t));
+       colorf = (color_filter_t *)g_malloc(sizeof (color_filter_t));
        colorf->filter_name = g_strdup(name);
        colorf->filter_text = g_strdup(filter_string);
        colorf->bg_color = *bg_color;
        colorf->fg_color = *fg_color;
+       colorf->disabled = disabled;
        colorf->c_colorfilter = NULL;
        colorf->edit_dialog = NULL;
        colorf->selected = FALSE;
         return colorf;
 }
 
+/* Add ten empty (temporary) colorfilters for easy coloring */
+static void
+color_filters_add_tmp(GSList **cfl)
+{
+       gchar  *name = NULL;
+       guint32 i;
+        gchar** bg_colors;
+        gchar** fg_colors;
+        unsigned long int cval;
+        color_t bg_color, fg_color;
+        color_filter_t *colorf;
+
+       g_assert(strlen(prefs.gui_colorized_fg)==69);
+       g_assert(strlen(prefs.gui_colorized_bg)==69);
+        fg_colors = g_strsplit(prefs.gui_colorized_fg, ",", -1);
+        bg_colors = g_strsplit(prefs.gui_colorized_bg, ",", -1);
+
+        for ( i=1 ; i<=10 ; i++ ) {
+                name = g_strdup_printf("%s%02d",TEMP_COLOR_PREFIX,i);
+
+               /* retrieve background and foreground colors */
+                cval = strtoul(fg_colors[i-1], NULL, 16);
+                initialize_color(&fg_color, RED_COMPONENT(cval),
+                                            GREEN_COMPONENT(cval),
+                                            BLUE_COMPONENT(cval) );
+                cval = strtoul(bg_colors[i-1], NULL, 16);
+                initialize_color(&bg_color, RED_COMPONENT(cval),
+                                            GREEN_COMPONENT(cval),
+                                            BLUE_COMPONENT(cval) );
+                colorf = color_filter_new(name, NULL, &bg_color, &fg_color, TRUE);
+                colorf->filter_text = g_strdup("frame");
+                colorf->c_colorfilter = NULL;
+                *cfl = g_slist_append(*cfl, colorf);
+
+                g_free(name);
+       }
+
+        g_strfreev(fg_colors);
+        g_strfreev(bg_colors);
+
+       return;
+}
+
+static gint
+color_filters_find_by_name_cb(gconstpointer arg1, gconstpointer arg2)
+{
+        const color_filter_t *colorf = (const color_filter_t *)arg1;
+        const gchar          *name   = (const gchar *)arg2;
+
+        return (strstr(colorf->filter_name, name)==NULL) ? -1 : 0 ;
+}
+
+
+/* Set the filter off a temporary colorfilters and enable it */
+void
+color_filters_set_tmp(guint8 filt_nr, gchar *filter, gboolean disabled)
+{
+       gchar          *name = NULL;
+       const gchar    *tmpfilter = NULL;
+        GSList         *cfl;
+        color_filter_t *colorf;
+        dfilter_t      *compiled_filter;
+       guint8         i;
+
+        /* Go through the tomporary filters and look for the same filter string.
+         * If found, clear it so that a filter can be "moved" up and down the list
+         */
+        for ( i=1 ; i<=10 ; i++ ) {
+                /* If we need to reset the temporary filter (filter==NULL), don't look
+                 * for other rules with the same filter string
+                 */
+                if( i!=filt_nr && filter==NULL )
+                        continue;
+
+                name = g_strdup_printf("%s%02d",TEMP_COLOR_PREFIX,i);
+                cfl = g_slist_find_custom(color_filter_list, name, color_filters_find_by_name_cb);
+                colorf = (color_filter_t *)cfl->data;
+
+                /* Only change the filter rule if this is the rule to change or if
+                 * a matching filter string has been found
+                 */
+                if(colorf && ( (i==filt_nr) || (strstr(filter,colorf->filter_text)!=NULL) ) ) {
+                        /* set filter string to "frame" if we are resetting the rules
+                         * or if we found a matching filter string which need to be cleared
+                         */
+                        tmpfilter = ( (filter==NULL) || (i!=filt_nr) ) ? "frame" : filter;
+                        if (!dfilter_compile(tmpfilter, &compiled_filter)) {
+                                simple_dialog(ESD_TYPE_ERROR, ESD_BTN_OK,
+                                    "Could not compile color filter name: \"%s\""
+                                    " text: \"%s\".\n%s", name, filter, dfilter_error_msg);
+                        } else {
+                                if (colorf->filter_text != NULL)
+                                        g_free(colorf->filter_text);
+                                if (colorf->c_colorfilter != NULL)
+                                        dfilter_free(colorf->c_colorfilter);
+                                colorf->filter_text = g_strdup(tmpfilter);
+                                colorf->c_colorfilter = compiled_filter;
+                                colorf->disabled = ((i!=filt_nr) ? TRUE : disabled);
+                                /* Remember that there are now temporary coloring filters set */
+                                if( filter )
+                                        tmp_colors_set = TRUE;
+                        }
+                }
+                g_free(name);
+        }
+        return;
+}
+
+/* Reset the temporary colorfilters */
+void
+color_filters_reset_tmp()
+{
+       guint8 i;
+
+        for ( i=1 ; i<=10 ; i++ ) {
+            color_filters_set_tmp(i, NULL, TRUE);
+        }
+        /* Remember that there are now *no* temporary coloring filters set */
+        tmp_colors_set = FALSE;
+       return;
+}
+
 /* delete the specified filter */
 void
 color_filter_delete(color_filter_t *colorf)
@@ -94,7 +230,7 @@ color_filter_delete(color_filter_t *colorf)
 static void
 color_filter_delete_cb(gpointer filter_arg, gpointer unused _U_)
 {
-       color_filter_t *colorf = filter_arg;
+       color_filter_t *colorf = (color_filter_t *)filter_arg;
 
        color_filter_delete(colorf);
 }
@@ -114,11 +250,12 @@ color_filter_clone(color_filter_t *colorf)
 {
        color_filter_t *new_colorf;
 
-       new_colorf = g_malloc(sizeof (color_filter_t));
+       new_colorf = (color_filter_t *)g_malloc(sizeof (color_filter_t));
        new_colorf->filter_name = g_strdup(colorf->filter_name);
        new_colorf->filter_text = g_strdup(colorf->filter_text);
        new_colorf->bg_color = colorf->bg_color;
        new_colorf->fg_color = colorf->fg_color;
+       new_colorf->disabled = colorf->disabled;
        new_colorf->c_colorfilter = NULL;
        new_colorf->edit_dialog = NULL;
        new_colorf->selected = FALSE;
@@ -127,12 +264,13 @@ color_filter_clone(color_filter_t *colorf)
 }
 
 static void
-color_filter_list_clone_cb(gpointer filter_arg, gpointer *cfl)
+color_filter_list_clone_cb(gpointer filter_arg, gpointer cfl_arg)
 {
-    color_filter_t *new_colorf;
+       GSList **cfl = (GSList **)cfl_arg;
+       color_filter_t *new_colorf;
 
-    new_colorf = color_filter_clone(filter_arg);
-    *cfl = g_slist_append(*cfl, new_colorf);
+       new_colorf = color_filter_clone((color_filter_t *)filter_arg);
+       *cfl = g_slist_append(*cfl, new_colorf);
 }
 
 /* clone the specified list */
@@ -153,6 +291,26 @@ color_filters_init(void)
        /* delete all currently existing filters */
        color_filter_list_delete(&color_filter_list);
 
+       /* start the list with the temporary colorizing rules */
+       color_filters_add_tmp(&color_filter_list);
+
+       /* try to read the users filters */
+       if (!read_users_filters(&color_filter_list))
+               /* if that failed, try to read the global filters */
+               color_filters_read_globals(&color_filter_list);
+}
+
+void
+color_filters_reload(void)
+{
+        /* "move" old entries to the deleted list
+         * we must keep them until the dissection no longer needs them */
+        color_filter_deleted_list = g_slist_concat(color_filter_deleted_list, color_filter_list);
+        color_filter_list = NULL;
+
+        /* start the list with the temporary colorizing rules */
+        color_filters_add_tmp(&color_filter_list);
+
        /* try to read the users filters */
        if (!read_users_filters(&color_filter_list))
                /* if that failed, try to read the global filters */
@@ -169,59 +327,90 @@ color_filters_cleanup(void)
 static void
 color_filters_clone_cb(gpointer filter_arg, gpointer user_data)
 {
-       color_filter_t * new_colorf = color_filter_clone(filter_arg);
-
-       color_filter_add_cb (new_colorf, user_data);
+       color_filter_t * new_colorf = color_filter_clone((color_filter_t *)filter_arg);
+        color_filter_add_cb (new_colorf, user_data);
 }
 
 void
 color_filters_clone(gpointer user_data)
 {
-    g_slist_foreach(color_filter_list, color_filters_clone_cb, user_data);
+       g_slist_foreach(color_filter_list, color_filters_clone_cb, user_data);
 }
 
 
 static void
-color_filter_compile_cb(gpointer filter_arg, gpointer *cfl)
+color_filter_compile_cb(gpointer filter_arg, gpointer unused _U_)
 {
-       color_filter_t *colorf = filter_arg;
+       color_filter_t *colorf = (color_filter_t *)filter_arg;
 
-        g_assert(colorf->c_colorfilter == NULL);
+       g_assert(colorf->c_colorfilter == NULL);
        if (!dfilter_compile(colorf->filter_text, &colorf->c_colorfilter)) {
                simple_dialog(ESD_TYPE_ERROR, ESD_BTN_OK,
                "Could not compile color filter name: \"%s\" text: \"%s\".\n%s",
                              colorf->filter_name, colorf->filter_text, dfilter_error_msg);
                /* this filter was compilable before, so this should never happen */
-               g_assert_not_reached();
+               /* except if the OK button of the parent window has been clicked */
+               /* so don't use g_assert_not_reached() but check the filters again */
+       }
+}
+
+static void
+color_filter_validate_cb(gpointer filter_arg, gpointer unused _U_)
+{
+       color_filter_t *colorf = (color_filter_t *)filter_arg;
+
+       g_assert(colorf->c_colorfilter == NULL);
+       if (!dfilter_compile(colorf->filter_text, &colorf->c_colorfilter)) {
+               simple_dialog(ESD_TYPE_ERROR, ESD_BTN_OK,
+               "Removing color filter name: \"%s\" text: \"%s\".\n%s",
+                             colorf->filter_name, colorf->filter_text, dfilter_error_msg);
+               /* Delete the color filter from the list of color filters. */
+               color_filter_valid_list = g_slist_remove(color_filter_valid_list, colorf);
+               color_filter_delete(colorf);
        }
 }
 
 /* apply changes from the edit list */
 void
-color_filters_apply(GSList *cfl)
+color_filters_apply(GSList *tmp_cfl, GSList *edit_cfl)
 {
         /* "move" old entries to the deleted list
          * we must keep them until the dissection no longer needs them */
         color_filter_deleted_list = g_slist_concat(color_filter_deleted_list, color_filter_list);
         color_filter_list = NULL;
 
-        /* clone all list entries from edit to normal list */
-        color_filter_list = color_filter_list_clone(cfl);
+        /* clone all list entries from tmp/edit to normal list */
+        color_filter_valid_list = NULL;
+        color_filter_valid_list = color_filter_list_clone(tmp_cfl);
+        color_filter_valid_list = g_slist_concat(color_filter_valid_list,
+                                                 color_filter_list_clone(edit_cfl) );
+
+        /* compile all filter */
+        g_slist_foreach(color_filter_valid_list, color_filter_validate_cb, NULL);
+
+        /* clone all list entries from tmp/edit to normal list */
+        color_filter_list = color_filter_list_clone(color_filter_valid_list);
 
         /* compile all filter */
         g_slist_foreach(color_filter_list, color_filter_compile_cb, NULL);
 }
 
-gboolean 
+gboolean
 color_filters_used(void)
 {
         return color_filter_list != NULL && filters_enabled;
 }
 
+gboolean
+tmp_color_filters_used(void)
+{
+        return tmp_colors_set;
+}
+
 void
 color_filters_enable(gboolean enable)
 {
-        filters_enabled = enable;
+       new_packet_list_enable_color(enable);
 }
 
 
@@ -229,8 +418,8 @@ color_filters_enable(gboolean enable)
 static void
 prime_edt(gpointer data, gpointer user_data)
 {
-       color_filter_t  *colorf = data;
-       epan_dissect_t   *edt = user_data;
+       color_filter_t  *colorf = (color_filter_t *)data;
+       epan_dissect_t   *edt = (epan_dissect_t *)user_data;
 
        if (colorf->c_colorfilter != NULL)
                epan_dissect_prime_dfilter(edt, colorf->c_colorfilter);
@@ -241,32 +430,33 @@ prime_edt(gpointer data, gpointer user_data)
 void
 color_filters_prime_edt(epan_dissect_t *edt)
 {
-       g_slist_foreach(color_filter_list, prime_edt, edt);
+       if (color_filters_used())
+               g_slist_foreach(color_filter_list, prime_edt, edt);
 }
 
-/* Colorize a single packet of the packet list */
-color_filter_t *
-color_filters_colorize_packet(gint row, epan_dissect_t *edt)
-{
-    GSList *curr;
-    color_filter_t *colorf;
-
-    /* If we have color filters, "search" for the matching one. */
-    if (color_filters_used()) {
-        curr = color_filter_list;
-
-        while( (curr = g_slist_next(curr)) != NULL) {
-            colorf = curr->data;
-            if ((colorf->c_colorfilter != NULL) &&
-                 dfilter_apply_edt(colorf->c_colorfilter, edt)) {
-                    /* this is the filter to use, apply it to the packet list */
-                    packet_list_set_colors(row, &(colorf->fg_color), &(colorf->bg_color));
-                    return colorf;
-            }
-        }
-    }
+/* * Return the color_t for later use */
+const color_filter_t *
+color_filters_colorize_packet(epan_dissect_t *edt)
+{
+       GSList *curr;
+       color_filter_t *colorf;
+
+       /* If we have color filters, "search" for the matching one. */
+       if (color_filters_used()) {
+               curr = color_filter_list;
 
-    return NULL;
+               while(curr != NULL) {
+                       colorf = (color_filter_t *)curr->data;
+                       if ( (!colorf->disabled) &&
+                            (colorf->c_colorfilter != NULL) &&
+                            dfilter_apply_edt(colorf->c_colorfilter, edt)) {
+                               return colorf;
+                       }
+                       curr = g_slist_next(curr);
+               }
+       }
+
+       return NULL;
 }
 
 /* read filters from the given file */
@@ -283,10 +473,11 @@ read_filters_file(FILE *f, gpointer user_data)
        guint32 i = 0;
        gint32  c;
        guint16 fg_r, fg_g, fg_b, bg_r, bg_g, bg_b;
+       gboolean disabled = FALSE;
        gboolean skip_end_of_line = FALSE;
 
-       name = g_malloc(name_len + 1);
-       filter_exp = g_malloc(filter_exp_len + 1);
+       name = (gchar *)g_malloc(name_len + 1);
+       filter_exp = (gchar *)g_malloc(filter_exp_len + 1);
 
        while (1) {
 
@@ -296,6 +487,7 @@ read_filters_file(FILE *f, gpointer user_data)
                        } while (c != EOF && c != '\n');
                        if (c == EOF)
                                break;
+                       disabled = FALSE;
                        skip_end_of_line = FALSE;
                }
 
@@ -308,8 +500,13 @@ read_filters_file(FILE *f, gpointer user_data)
                if (c == EOF)
                        break;
 
+               if (c == '!') {
+                       disabled = TRUE;
+                       continue;
+               }
+
                /* skip # comments and invalid lines */
-               if (c != '@') { 
+               if (c != '@') {
                        skip_end_of_line = TRUE;
                        continue;
                }
@@ -328,9 +525,9 @@ read_filters_file(FILE *f, gpointer user_data)
                        if (i >= name_len) {
                                /* buffer isn't long enough; double its length.*/
                                name_len *= 2;
-                               name = g_realloc(name, name_len + 1);
+                               name = (gchar *)g_realloc(name, name_len + 1);
                        }
-                       name[i++] = c;            
+                       name[i++] = c;
                }
                name[i] = '\0';
 
@@ -350,7 +547,7 @@ read_filters_file(FILE *f, gpointer user_data)
                        if (i >= filter_exp_len) {
                                /* buffer isn't long enough; double its length.*/
                                filter_exp_len *= 2;
-                               filter_exp = g_realloc(filter_exp, filter_exp_len + 1);
+                               filter_exp = (gchar *)g_realloc(filter_exp, filter_exp_len + 1);
                        }
                        filter_exp[i++] = c;
                }
@@ -374,9 +571,8 @@ read_filters_file(FILE *f, gpointer user_data)
                        dfilter_t *temp_dfilter;
 
                        if (!dfilter_compile(filter_exp, &temp_dfilter)) {
-                               simple_dialog(ESD_TYPE_ERROR, ESD_BTN_OK,
-                               "Could not compile color filter %s from saved filters.\n%s",
-                                             name, dfilter_error_msg);
+                               g_warning("Could not compile color filter \"%s\" from saved filters: %s",
+                                       name, dfilter_error_msg);
                                skip_end_of_line = TRUE;
                                continue;
                        }
@@ -401,7 +597,7 @@ read_filters_file(FILE *f, gpointer user_data)
                        }
 
                        colorf = color_filter_new(name, filter_exp, &bg_color,
-                           &fg_color);
+                           &fg_color, disabled);
                         if(user_data == &color_filter_list) {
                                 GSList **cfl = (GSList **)user_data;
 
@@ -433,8 +629,8 @@ read_users_filters(GSList **cfl)
        gboolean ret;
 
        /* decide what file to open (from dfilter code) */
-       path = get_persconffile_path("colorfilters", FALSE);
-       if ((f = eth_fopen(path, "r")) == NULL) {
+       path = get_persconffile_path("colorfilters", TRUE, FALSE);
+       if ((f = ws_fopen(path, "r")) == NULL) {
                if (errno != ENOENT) {
                        simple_dialog(ESD_TYPE_ERROR, ESD_BTN_OK,
                            "Could not open filter file\n\"%s\": %s.", path,
@@ -461,7 +657,7 @@ color_filters_read_globals(gpointer user_data)
 
        /* decide what file to open (from dfilter code) */
        path = get_datafile_path("colorfilters");
-       if ((f = eth_fopen(path, "r")) == NULL) {
+       if ((f = ws_fopen(path, "r")) == NULL) {
                if (errno != ENOENT) {
                        simple_dialog(ESD_TYPE_ERROR, ESD_BTN_OK,
                            "Could not open global filter file\n\"%s\": %s.", path,
@@ -485,7 +681,7 @@ color_filters_import(gchar *path, gpointer user_data)
        FILE *f;
        gboolean ret;
 
-       if ((f = eth_fopen(path, "r")) == NULL) {
+       if ((f = ws_fopen(path, "r")) == NULL) {
                simple_dialog(ESD_TYPE_ERROR, ESD_BTN_OK,
                    "Could not open\n%s\nfor reading: %s.",
                    path, strerror(errno));
@@ -499,20 +695,22 @@ color_filters_import(gchar *path, gpointer user_data)
 
 struct write_filter_data
 {
-  FILE * f;
-  gboolean only_selected;
+       FILE * f;
+       gboolean only_selected;
 };
 
 /* save a single filter */
 static void
 write_filter(gpointer filter_arg, gpointer data_arg)
 {
-       struct write_filter_data *data = data_arg;
-       color_filter_t *colorf = filter_arg;
+       struct write_filter_data *data = (struct write_filter_data *)data_arg;
+       color_filter_t *colorf = (color_filter_t *)filter_arg;
        FILE *f = data->f;
 
-       if (colorf->selected || !data->only_selected) {
-               fprintf(f,"@%s@%s@[%d,%d,%d][%d,%d,%d]\n",
+       if ( (colorf->selected || !data->only_selected) &&
+             (strstr(colorf->filter_name,TEMP_COLOR_PREFIX)==NULL) ) {
+               fprintf(f,"%s@%s@%s@[%d,%d,%d][%d,%d,%d]\n",
+                   colorf->disabled ? "!" : "",
                    colorf->filter_name,
                    colorf->filter_text,
                    colorf->bg_color.red,
@@ -532,7 +730,7 @@ write_filters_file(GSList *cfl, FILE *f, gboolean only_selected)
 
        data.f = f;
        data.only_selected = only_selected;
-  
+
        fprintf(f,"# DO NOT EDIT THIS FILE!  It was created by Wireshark\n");
         g_slist_foreach(cfl, write_filter, &data);
        return TRUE;
@@ -543,7 +741,7 @@ gboolean
 color_filters_write(GSList *cfl)
 {
        gchar *pf_dir_path;
-       const gchar *path;
+       gchar *path;
        FILE *f;
 
        /* Create the directory that holds personal configuration files,
@@ -556,13 +754,15 @@ color_filters_write(GSList *cfl)
                return FALSE;
        }
 
-       path = get_persconffile_path("colorfilters", TRUE);
-       if ((f = eth_fopen(path, "w+")) == NULL) {
+       path = get_persconffile_path("colorfilters", TRUE, TRUE);
+       if ((f = ws_fopen(path, "w+")) == NULL) {
                simple_dialog(ESD_TYPE_ERROR, ESD_BTN_OK,
                    "Could not open\n%s\nfor writing: %s.",
                    path, strerror(errno));
+               g_free(path);
                return FALSE;
        }
+       g_free(path);
        write_filters_file(cfl, f, FALSE);
        fclose(f);
        return TRUE;
@@ -574,7 +774,7 @@ color_filters_export(gchar *path, GSList *cfl, gboolean only_marked)
 {
        FILE *f;
 
-       if ((f = eth_fopen(path, "w+")) == NULL) {
+       if ((f = ws_fopen(path, "w+")) == NULL) {
                simple_dialog(ESD_TYPE_ERROR, ESD_BTN_OK,
                    "Could not open\n%s\nfor writing: %s.",
                    path, strerror(errno));