epan/color_filters.c

   1 /* color_filters.c
   2  * Routines for color filters
   3  *
   4  * Wireshark - Network traffic analyzer
   5  * By Gerald Combs <gerald@wireshark.org>
   6  * Copyright 1998 Gerald Combs
   7  *
   8  * This program is free software; you can redistribute it and/or
   9  * modify it under the terms of the GNU General Public License
  10  * as published by the Free Software Foundation; either version 2
  11  * of the License, or (at your option) any later version.
  12  *
  13  * This program is distributed in the hope that it will be useful,
  14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16  * GNU General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU General Public License
  19  * along with this program; if not, write to the Free Software
  20  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  21  */
  22 /*
  23  * Updated 1 Dec 10 jjm
  24  */
  25
  26 #include <config.h>
  27
  28 #include <glib.h>
  29
  30 #include <stdio.h>
  31 #include <stdlib.h>
  32 #include <string.h>
  33
  34 #include <wsutil/filesystem.h>
  35 #include <wsutil/file_util.h>
  36 #include <wsutil/ws_printf.h> /* ws_g_warning */
  37
  38 #include <epan/packet.h>
  39 #include "color_filters.h"
  40 #include "file.h"
  41 #include <epan/dfilter/dfilter.h>
  42 #include <epan/prefs.h>
  43 #include <epan/epan_dissect.h>
  44
  45
  46 #define RED_COMPONENT(x)   (guint16) (((((x) >> 16) & 0xff) * 65535 / 255))
  47 #define GREEN_COMPONENT(x) (guint16) (((((x) >>  8) & 0xff) * 65535 / 255))
  48 #define BLUE_COMPONENT(x)  (guint16) ( (((x)        & 0xff) * 65535 / 255))
  49
  50 static gboolean read_users_filters(GSList **cfl, gchar** err_msg, color_filter_add_cb_func add_cb);
  51
  52 /* the currently active filters */
  53 static GSList *color_filter_list = NULL;
  54
  55 /* keep "old" deleted filters in this list until
  56  * the dissection no longer needs them (e.g. file is closed) */
  57 static GSList *color_filter_deleted_list = NULL;
  58 static GSList *color_filter_valid_list   = NULL;
  59
  60 /* Color Filters can en-/disabled. */
  61 static gboolean filters_enabled = TRUE;
  62
  63 /* Remember if there are temporary coloring filters set to
  64  * add sensitivity to the "Reset Coloring 1-10" menu item
  65  */
  66 static gboolean tmp_colors_set = FALSE;
  67
  68 /* Create a new filter */
  69 color_filter_t *
  70 color_filter_new(const gchar *name,          /* The name of the filter to create */
  71                  const gchar *filter_string, /* The string representing the filter */
  72                  color_t     *bg_color,      /* The background color */
  73                  color_t     *fg_color,      /* The foreground color */
  74                  gboolean     disabled)      /* Is the filter disabled? */
  75 {
  76     color_filter_t *colorf;
  77
  78     colorf                      = (color_filter_t *)g_malloc0(sizeof (color_filter_t));
  79     colorf->filter_name         = g_strdup(name);
  80     colorf->filter_text         = g_strdup(filter_string);
  81     colorf->bg_color            = *bg_color;
  82     colorf->fg_color            = *fg_color;
  83     colorf->disabled            = disabled;
  84     return colorf;
  85 }
  86
  87 /* Add ten empty (temporary) colorfilters for easy coloring */
  88 static void
  89 color_filters_add_tmp(GSList **cfl)
  90 {
  91     gchar          *name = NULL;
  92     guint32         i;
  93     gchar**         bg_colors;
  94     gchar**         fg_colors;
  95     gulong          cval;
  96     color_t         bg_color, fg_color;
  97     color_filter_t *colorf;
  98
  99     g_assert(strlen(prefs.gui_colorized_fg)==69);
 100     g_assert(strlen(prefs.gui_colorized_bg)==69);
 101     fg_colors = g_strsplit(prefs.gui_colorized_fg, ",", -1);
 102     bg_colors = g_strsplit(prefs.gui_colorized_bg, ",", -1);
 103
 104     for ( i=1 ; i<=10 ; i++ ) {
 105         name = g_strdup_printf("%s%02d",CONVERSATION_COLOR_PREFIX,i);
 106
 107         /* retrieve background and foreground colors */
 108         cval = strtoul(fg_colors[i-1], NULL, 16);
 109         fg_color.red = RED_COMPONENT(cval);
 110         fg_color.green = GREEN_COMPONENT(cval);
 111         fg_color.blue = BLUE_COMPONENT(cval);
 112         cval = strtoul(bg_colors[i-1], NULL, 16);
 113         bg_color.red = RED_COMPONENT(cval);
 114         bg_color.green = GREEN_COMPONENT(cval);
 115         bg_color.blue = BLUE_COMPONENT(cval);
 116         colorf = color_filter_new(name, NULL, &bg_color, &fg_color, TRUE);
 117         colorf->filter_text = g_strdup("frame");
 118         *cfl = g_slist_append(*cfl, colorf);
 119
 120         g_free(name);
 121     }
 122
 123     g_strfreev(fg_colors);
 124     g_strfreev(bg_colors);
 125
 126     return;
 127 }
 128
 129 static gint
 130 color_filters_find_by_name_cb(gconstpointer arg1, gconstpointer arg2)
 131 {
 132     const color_filter_t *colorf = (const color_filter_t *)arg1;
 133     const gchar          *name   = (const gchar *)arg2;
 134
 135     return strcmp(colorf->filter_name, name);
 136 }
 137
 138
 139 /* Set the filter off a temporary colorfilters and enable it */
 140 gboolean
 141 color_filters_set_tmp(guint8 filt_nr, const gchar *filter, gboolean disabled, gchar **err_msg)
 142 {
 143     gchar          *name = NULL;
 144     const gchar    *tmpfilter = NULL;
 145     GSList         *cfl;
 146     color_filter_t *colorf;
 147     dfilter_t      *compiled_filter;
 148     guint8         i;
 149     gchar          *local_err_msg = NULL;
 150     /* Go through the temporary filters and look for the same filter string.
 151      * If found, clear it so that a filter can be "moved" up and down the list
 152      */
 153     for ( i=1 ; i<=10 ; i++ ) {
 154         /* If we need to reset the temporary filter (filter==NULL), don't look
 155          * for other rules with the same filter string
 156          */
 157         if( i!=filt_nr && filter==NULL )
 158             continue;
 159
 160         name = g_strdup_printf("%s%02d",CONVERSATION_COLOR_PREFIX,i);
 161         cfl = g_slist_find_custom(color_filter_list, name, color_filters_find_by_name_cb);
 162         colorf = (color_filter_t *)cfl->data;
 163
 164         /* Only change the filter rule if this is the rule to change or if
 165          * a matching filter string has been found
 166          */
 167         if(colorf && ( (i==filt_nr) || (!strcmp(filter, colorf->filter_text)) ) ) {
 168             /* set filter string to "frame" if we are resetting the rules
 169              * or if we found a matching filter string which need to be cleared
 170              */
 171             tmpfilter = ( (filter==NULL) || (i!=filt_nr) ) ? "frame" : filter;
 172             if (!dfilter_compile(tmpfilter, &compiled_filter, &local_err_msg)) {
 173                 *err_msg = g_strdup_printf( "Could not compile color filter name: \"%s\" text: \"%s\".\n%s", name, filter, local_err_msg);
 174                 g_free(local_err_msg);
 175                 return FALSE;
 176             } else {
 177                 if (colorf->filter_text != NULL)
 178                     g_free(colorf->filter_text);
 179                 if (colorf->c_colorfilter != NULL)
 180                     dfilter_free(colorf->c_colorfilter);
 181                 colorf->filter_text = g_strdup(tmpfilter);
 182                 colorf->c_colorfilter = compiled_filter;
 183                 colorf->disabled = ((i!=filt_nr) ? TRUE : disabled);
 184                 /* Remember that there are now temporary coloring filters set */
 185                 if( filter )
 186                     tmp_colors_set = TRUE;
 187             }
 188         }
 189         g_free(name);
 190     }
 191     return TRUE;
 192 }
 193
 194 const color_filter_t *
 195 color_filters_tmp_color(guint8 filter_num) {
 196     gchar          *name;
 197     color_filter_t *colorf = NULL;
 198     GSList         *cfl;
 199
 200     name = g_strdup_printf("%s%02d", CONVERSATION_COLOR_PREFIX, filter_num);
 201     cfl = g_slist_find_custom(color_filter_list, name, color_filters_find_by_name_cb);
 202     if (cfl) {
 203         colorf = (color_filter_t *)cfl->data;
 204     }
 205     g_free(name);
 206
 207     return colorf;
 208 }
 209
 210 /* Reset the temporary colorfilters */
 211 gboolean
 212 color_filters_reset_tmp(gchar **err_msg)
 213 {
 214     guint8 i;
 215
 216     for ( i=1 ; i<=10 ; i++ ) {
 217         if (!color_filters_set_tmp(i, NULL, TRUE, err_msg))
 218             return FALSE;
 219     }
 220     /* Remember that there are now *no* temporary coloring filters set */
 221     tmp_colors_set = FALSE;
 222     return TRUE;
 223 }
 224
 225 /* delete the specified filter */
 226 void
 227 color_filter_delete(color_filter_t *colorf)
 228 {
 229     if (colorf->filter_name != NULL)
 230         g_free(colorf->filter_name);
 231     if (colorf->filter_text != NULL)
 232         g_free(colorf->filter_text);
 233     if (colorf->c_colorfilter != NULL)
 234         dfilter_free(colorf->c_colorfilter);
 235     g_free(colorf);
 236 }
 237
 238 /* delete the specified filter (called from g_slist_foreach) */
 239 static void
 240 color_filter_delete_cb(gpointer filter_arg, gpointer unused _U_)
 241 {
 242     color_filter_t *colorf = (color_filter_t *)filter_arg;
 243
 244     color_filter_delete(colorf);
 245 }
 246
 247 /* delete the specified list */
 248 void
 249 color_filter_list_delete(GSList **cfl)
 250 {
 251     g_slist_foreach(*cfl, color_filter_delete_cb, NULL);
 252     g_slist_free(*cfl);
 253     *cfl = NULL;
 254 }
 255
 256 /* clone a single list entries from normal to edit list */
 257 static color_filter_t *
 258 color_filter_clone(color_filter_t *colorf)
 259 {
 260     color_filter_t *new_colorf;
 261
 262     new_colorf                      = (color_filter_t *)g_malloc(sizeof (color_filter_t));
 263     new_colorf->filter_name         = g_strdup(colorf->filter_name);
 264     new_colorf->filter_text         = g_strdup(colorf->filter_text);
 265     new_colorf->bg_color            = colorf->bg_color;
 266     new_colorf->fg_color            = colorf->fg_color;
 267     new_colorf->disabled            = colorf->disabled;
 268     new_colorf->c_colorfilter       = NULL;
 269     new_colorf->color_edit_dlg_info = NULL;
 270     new_colorf->selected            = FALSE;
 271
 272     return new_colorf;
 273 }
 274
 275 static void
 276 color_filter_list_clone_cb(gpointer filter_arg, gpointer cfl_arg)
 277 {
 278     GSList **cfl = (GSList **)cfl_arg;
 279     color_filter_t *new_colorf;
 280
 281     new_colorf = color_filter_clone((color_filter_t *)filter_arg);
 282     *cfl = g_slist_append(*cfl, new_colorf);
 283 }
 284
 285 /* clone the specified list */
 286 static GSList *
 287 color_filter_list_clone(GSList *cfl)
 288 {
 289     GSList *new_list = NULL;
 290
 291     g_slist_foreach(cfl, color_filter_list_clone_cb, &new_list);
 292
 293     return new_list;
 294 }
 295
 296 /* Initialize the filter structures (reading from file) for general running, including app startup */
 297 gboolean
 298 color_filters_init(gchar** err_msg, color_filter_add_cb_func add_cb)
 299 {
 300     /* delete all currently existing filters */
 301     color_filter_list_delete(&color_filter_list);
 302
 303     /* start the list with the temporary colorizing rules */
 304     color_filters_add_tmp(&color_filter_list);
 305
 306     /* try to read the users filters */
 307     if (!read_users_filters(&color_filter_list, err_msg, add_cb)) {
 308         gchar* local_err_msg = NULL;
 309
 310         /* if that failed, try to read the global filters */
 311         if (!color_filters_read_globals(&color_filter_list, &local_err_msg, add_cb)) {
 312             /* Show the first error */
 313             g_free(local_err_msg);
 314         }
 315
 316         return (*err_msg == NULL);
 317     }
 318
 319     return TRUE;
 320 }
 321
 322 gboolean
 323 color_filters_reload(gchar** err_msg, color_filter_add_cb_func add_cb)
 324 {
 325     /* "move" old entries to the deleted list
 326      * we must keep them until the dissection no longer needs them */
 327     color_filter_deleted_list = g_slist_concat(color_filter_deleted_list, color_filter_list);
 328     color_filter_list = NULL;
 329
 330     /* start the list with the temporary colorizing rules */
 331     color_filters_add_tmp(&color_filter_list);
 332
 333     /* try to read the users filters */
 334     if (!read_users_filters(&color_filter_list, err_msg, add_cb)) {
 335         gchar* local_err_msg = NULL;
 336
 337         /* if that failed, try to read the global filters */
 338         if (!color_filters_read_globals(&color_filter_list, &local_err_msg, add_cb)) {
 339             /* Show the first error */
 340             g_free(local_err_msg);
 341         }
 342
 343         return (*err_msg == NULL);
 344     }
 345     return TRUE;
 346 }
 347
 348 void
 349 color_filters_cleanup(void)
 350 {
 351     /* delete the previously deleted filters */
 352     color_filter_list_delete(&color_filter_deleted_list);
 353 }
 354
 355 typedef struct _color_clone
 356 {
 357     gpointer user_data;
 358     color_filter_add_cb_func add_cb;
 359 } color_clone_t;
 360
 361 static void
 362 color_filters_clone_cb(gpointer filter_arg, gpointer user_data)
 363 {
 364     color_clone_t* clone_data = (color_clone_t*)user_data;
 365     color_filter_t * new_colorf = color_filter_clone((color_filter_t *)filter_arg);
 366
 367     clone_data->add_cb (new_colorf, clone_data->user_data);
 368 }
 369
 370 void
 371 color_filters_clone(gpointer user_data, color_filter_add_cb_func add_cb)
 372 {
 373     color_clone_t clone_data;
 374
 375     clone_data.user_data = user_data;
 376     clone_data.add_cb = add_cb;
 377     g_slist_foreach(color_filter_list, color_filters_clone_cb, &clone_data);
 378 }
 379
 380
 381 static void
 382 color_filter_compile_cb(gpointer filter_arg, gpointer err)
 383 {
 384     color_filter_t *colorf = (color_filter_t *)filter_arg;
 385     gchar **err_msg = (gchar**)err;
 386     gchar *local_err_msg = NULL;
 387
 388     g_assert(colorf->c_colorfilter == NULL);
 389
 390     /* If the filter is disabled it doesn't matter if it compiles or not. */
 391     if (colorf->disabled) return;
 392
 393     if (!dfilter_compile(colorf->filter_text, &colorf->c_colorfilter, &local_err_msg)) {
 394         *err_msg = g_strdup_printf("Could not compile color filter name: \"%s\" text: \"%s\".\n%s",
 395                       colorf->filter_name, colorf->filter_text, local_err_msg);
 396         g_free(local_err_msg);
 397         /* this filter was compilable before, so this should never happen */
 398         /* except if the OK button of the parent window has been clicked */
 399         /* so don't use g_assert_not_reached() but check the filters again */
 400     }
 401 }
 402
 403 static void
 404 color_filter_validate_cb(gpointer filter_arg, gpointer err)
 405 {
 406     color_filter_t *colorf = (color_filter_t *)filter_arg;
 407     gchar **err_msg = (gchar**)err;
 408     gchar *local_err_msg;
 409
 410     g_assert(colorf->c_colorfilter == NULL);
 411
 412     /* If the filter is disabled it doesn't matter if it compiles or not. */
 413     if (colorf->disabled) return;
 414
 415     if (!dfilter_compile(colorf->filter_text, &colorf->c_colorfilter, &local_err_msg)) {
 416         *err_msg = g_strdup_printf("Removing color filter name: \"%s\" text: \"%s\".\n%s",
 417                       colorf->filter_name, colorf->filter_text, local_err_msg);
 418         g_free(local_err_msg);
 419         /* Delete the color filter from the list of color filters. */
 420         color_filter_valid_list = g_slist_remove(color_filter_valid_list, colorf);
 421         color_filter_delete(colorf);
 422     }
 423 }
 424
 425 /* apply changes from the edit list */
 426 gboolean
 427 color_filters_apply(GSList *tmp_cfl, GSList *edit_cfl, gchar** err_msg)
 428 {
 429     gboolean ret = TRUE;
 430
 431     *err_msg = NULL;
 432
 433     /* "move" old entries to the deleted list
 434      * we must keep them until the dissection no longer needs them */
 435     color_filter_deleted_list = g_slist_concat(color_filter_deleted_list, color_filter_list);
 436     color_filter_list = NULL;
 437
 438     /* clone all list entries from tmp/edit to normal list */
 439     color_filter_valid_list = NULL;
 440     color_filter_valid_list = color_filter_list_clone(tmp_cfl);
 441     color_filter_valid_list = g_slist_concat(color_filter_valid_list,
 442                                              color_filter_list_clone(edit_cfl) );
 443
 444     /* compile all filter */
 445     g_slist_foreach(color_filter_valid_list, color_filter_validate_cb, err_msg);
 446     if (*err_msg != NULL) {
 447         ret = FALSE;
 448     }
 449
 450     /* clone all list entries from tmp/edit to normal list */
 451     color_filter_list = color_filter_list_clone(color_filter_valid_list);
 452
 453     /* compile all filter */
 454     g_slist_foreach(color_filter_list, color_filter_compile_cb, err_msg);
 455     if (*err_msg != NULL) {
 456         ret = FALSE;
 457     }
 458
 459     return ret;
 460 }
 461
 462 gboolean
 463 color_filters_used(void)
 464 {
 465     return color_filter_list != NULL && filters_enabled;
 466 }
 467
 468 gboolean
 469 tmp_color_filters_used(void)
 470 {
 471     return tmp_colors_set;
 472 }
 473
 474 /* prepare the epan_dissect_t for the filter */
 475 static void
 476 prime_edt(gpointer data, gpointer user_data)
 477 {
 478     color_filter_t *colorf = (color_filter_t *)data;
 479     epan_dissect_t *edt    = (epan_dissect_t *)user_data;
 480
 481     if (colorf->c_colorfilter != NULL)
 482         epan_dissect_prime_dfilter(edt, colorf->c_colorfilter);
 483 }
 484
 485 /* Prime the epan_dissect_t with all the compiler
 486  * color filters in 'color_filter_list'. */
 487 void
 488 color_filters_prime_edt(epan_dissect_t *edt)
 489 {
 490     if (color_filters_used())
 491         g_slist_foreach(color_filter_list, prime_edt, edt);
 492 }
 493
 494 /* * Return the color_t for later use */
 495 const color_filter_t *
 496 color_filters_colorize_packet(epan_dissect_t *edt)
 497 {
 498     GSList         *curr;
 499     color_filter_t *colorf;
 500
 501     /* If we have color filters, "search" for the matching one. */
 502     if ((edt->tree != NULL) && (color_filters_used())) {
 503         curr = color_filter_list;
 504
 505         while(curr != NULL) {
 506             colorf = (color_filter_t *)curr->data;
 507             if ( (!colorf->disabled) &&
 508                  (colorf->c_colorfilter != NULL) &&
 509                  dfilter_apply_edt(colorf->c_colorfilter, edt)) {
 510                 return colorf;
 511             }
 512             curr = g_slist_next(curr);
 513         }
 514     }
 515
 516     return NULL;
 517 }
 518
 519 /* read filters from the given file */
 520 /* XXX - Would it make more sense to use GStrings here instead of reallocing
 521    our buffers? */
 522 static int
 523 read_filters_file(const gchar *path, FILE *f, gpointer user_data, color_filter_add_cb_func add_cb)
 524 {
 525 #define INIT_BUF_SIZE 128
 526     gchar    *name             = NULL;
 527     gchar    *filter_exp       = NULL;
 528     guint32   name_len         = INIT_BUF_SIZE;
 529     guint32   filter_exp_len   = INIT_BUF_SIZE;
 530     guint32   i                = 0;
 531     int       c;
 532     guint16   fg_r, fg_g, fg_b, bg_r, bg_g, bg_b;
 533     gboolean  disabled         = FALSE;
 534     gboolean  skip_end_of_line = FALSE;
 535     int       ret = 0;
 536
 537     name = (gchar *)g_malloc(name_len + 1);
 538     filter_exp = (gchar *)g_malloc(filter_exp_len + 1);
 539
 540     while (1) {
 541
 542         if (skip_end_of_line) {
 543             do {
 544                 c = ws_getc_unlocked(f);
 545             } while (c != EOF && c != '\n');
 546             if (c == EOF)
 547                 break;
 548             disabled = FALSE;
 549             skip_end_of_line = FALSE;
 550         }
 551
 552         while ((c = ws_getc_unlocked(f)) != EOF && g_ascii_isspace(c)) {
 553             if (c == '\n') {
 554                 continue;
 555             }
 556         }
 557
 558         if (c == EOF)
 559             break;
 560
 561         if (c == '!') {
 562             disabled = TRUE;
 563             continue;
 564         }
 565
 566         /* skip # comments and invalid lines */
 567         if (c != '@') {
 568             skip_end_of_line = TRUE;
 569             continue;
 570         }
 571
 572         /* we get the @ delimiter.
 573          * Format is:
 574          * @name@filter expression@[background r,g,b][foreground r,g,b]
 575          */
 576
 577         /* retrieve name */
 578         i = 0;
 579         while (1) {
 580             c = ws_getc_unlocked(f);
 581             if (c == EOF || c == '@')
 582                 break;
 583             if (i >= name_len) {
 584                 /* buffer isn't long enough; double its length.*/
 585                 name_len *= 2;
 586                 name = (gchar *)g_realloc(name, name_len + 1);
 587             }
 588             name[i++] = c;
 589         }
 590         name[i] = '\0';
 591
 592         if (c == EOF) {
 593             break;
 594         } else if (i == 0) {
 595             skip_end_of_line = TRUE;
 596             continue;
 597         }
 598
 599         /* retrieve filter expression */
 600         i = 0;
 601         while (1) {
 602             c = ws_getc_unlocked(f);
 603             if (c == EOF || c == '@')
 604                 break;
 605             if (i >= filter_exp_len) {
 606                 /* buffer isn't long enough; double its length.*/
 607                 filter_exp_len *= 2;
 608                 filter_exp = (gchar *)g_realloc(filter_exp, filter_exp_len + 1);
 609             }
 610             filter_exp[i++] = c;
 611         }
 612         filter_exp[i] = '\0';
 613
 614         if (c == EOF) {
 615             break;
 616         } else if (i == 0) {
 617             skip_end_of_line = TRUE;
 618             continue;
 619         }
 620
 621         /* retrieve background and foreground colors */
 622         if (fscanf(f,"[%hu,%hu,%hu][%hu,%hu,%hu]",
 623                    &bg_r, &bg_g, &bg_b, &fg_r, &fg_g, &fg_b) == 6) {
 624
 625             /* we got a complete color filter */
 626
 627             color_t bg_color, fg_color;
 628             color_filter_t *colorf;
 629             dfilter_t *temp_dfilter = NULL;
 630             gchar *local_err_msg = NULL;
 631
 632             if (!disabled && !dfilter_compile(filter_exp, &temp_dfilter, &local_err_msg)) {
 633                 ws_g_warning("Could not compile \"%s\" in colorfilters file \"%s\".\n%s",
 634                           name, path, local_err_msg);
 635                 g_free(local_err_msg);
 636                 prefs.unknown_colorfilters = TRUE;
 637
 638                 /* skip_end_of_line = TRUE; */
 639                 disabled = TRUE;
 640             }
 641
 642             fg_color.red = fg_r;
 643             fg_color.green = fg_g;
 644             fg_color.blue = fg_b;
 645
 646             bg_color.red = bg_r;
 647             bg_color.green = bg_g;
 648             bg_color.blue = bg_b;
 649
 650             colorf = color_filter_new(name, filter_exp, &bg_color,
 651                                       &fg_color, disabled);
 652             if(user_data == &color_filter_list) {
 653                 GSList **cfl = (GSList **)user_data;
 654
 655                 /* internal call */
 656                 colorf->c_colorfilter = temp_dfilter;
 657                 *cfl = g_slist_append(*cfl, colorf);
 658             } else {
 659                 /* external call */
 660                 /* just editing, don't need the compiled filter */
 661                 dfilter_free(temp_dfilter);
 662                 add_cb(colorf, user_data);
 663             }
 664         }    /* if sscanf */
 665
 666         skip_end_of_line = TRUE;
 667     }
 668
 669     if (ferror(f))
 670         ret = errno;
 671
 672     g_free(name);
 673     g_free(filter_exp);
 674     return ret;
 675 }
 676
 677 /* read filters from the user's filter file */
 678 static gboolean
 679 read_users_filters(GSList **cfl, gchar** err_msg, color_filter_add_cb_func add_cb)
 680 {
 681     gchar    *path;
 682     FILE     *f;
 683     int       ret;
 684
 685     /* decide what file to open (from dfilter code) */
 686     path = get_persconffile_path("colorfilters", TRUE);
 687     if ((f = ws_fopen(path, "r")) == NULL) {
 688         if (errno != ENOENT) {
 689             *err_msg = g_strdup_printf("Could not open filter file\n\"%s\": %s.", path,
 690                           g_strerror(errno));
 691         }
 692         g_free(path);
 693         return FALSE;
 694     }
 695
 696     ret = read_filters_file(path, f, cfl, add_cb);
 697     if (ret != 0) {
 698         *err_msg = g_strdup_printf("Error reading filter file\n\"%s\": %s.",
 699                                    path, g_strerror(errno));
 700         fclose(f);
 701         g_free(path);
 702         return FALSE;
 703     }
 704
 705     fclose(f);
 706     g_free(path);
 707     return TRUE;
 708 }
 709
 710 /* read filters from the filter file */
 711 gboolean
 712 color_filters_read_globals(gpointer user_data, gchar** err_msg, color_filter_add_cb_func add_cb)
 713 {
 714     gchar    *path;
 715     FILE     *f;
 716     int       ret;
 717
 718     /* decide what file to open (from dfilter code) */
 719     path = get_datafile_path("colorfilters");
 720     if ((f = ws_fopen(path, "r")) == NULL) {
 721         if (errno != ENOENT) {
 722             *err_msg = g_strdup_printf("Could not open global filter file\n\"%s\": %s.", path,
 723                           g_strerror(errno));
 724         }
 725         g_free(path);
 726         return FALSE;
 727     }
 728
 729     ret = read_filters_file(path, f, user_data, add_cb);
 730     if (ret != 0) {
 731         *err_msg = g_strdup_printf("Error reading global filter file\n\"%s\": %s.",
 732                                    path, g_strerror(errno));
 733         fclose(f);
 734         g_free(path);
 735         return FALSE;
 736     }
 737
 738     fclose(f);
 739     g_free(path);
 740     return TRUE;
 741 }
 742
 743 /* read filters from some other filter file (import) */
 744 gboolean
 745 color_filters_import(const gchar *path, gpointer user_data, gchar **err_msg, color_filter_add_cb_func add_cb)
 746 {
 747     FILE     *f;
 748     int       ret;
 749
 750     if ((f = ws_fopen(path, "r")) == NULL) {
 751         *err_msg = g_strdup_printf("Could not open filter file\n%s\nfor reading: %s.",
 752                       path, g_strerror(errno));
 753         return FALSE;
 754     }
 755
 756     ret = read_filters_file(path, f, user_data, add_cb);
 757     if (ret != 0) {
 758         *err_msg = g_strdup_printf("Error reading filter file\n\"%s\": %s.",
 759                                    path, g_strerror(errno));
 760         fclose(f);
 761         return FALSE;
 762     }
 763
 764     fclose(f);
 765     return TRUE;
 766 }
 767
 768 struct write_filter_data
 769 {
 770     FILE     *f;
 771     gboolean  only_selected;
 772 };
 773
 774 /* save a single filter */
 775 static void
 776 write_filter(gpointer filter_arg, gpointer data_arg)
 777 {
 778     struct write_filter_data *data = (struct write_filter_data *)data_arg;
 779     color_filter_t *colorf = (color_filter_t *)filter_arg;
 780     FILE *f = data->f;
 781
 782     if ( (colorf->selected || !data->only_selected) &&
 783          (strstr(colorf->filter_name,CONVERSATION_COLOR_PREFIX)==NULL) ) {
 784         fprintf(f,"%s@%s@%s@[%u,%u,%u][%u,%u,%u]\n",
 785                 colorf->disabled ? "!" : "",
 786                 colorf->filter_name,
 787                 colorf->filter_text,
 788                 colorf->bg_color.red,
 789                 colorf->bg_color.green,
 790                 colorf->bg_color.blue,
 791                 colorf->fg_color.red,
 792                 colorf->fg_color.green,
 793                 colorf->fg_color.blue);
 794     }
 795 }
 796
 797 /* save filters in a filter file */
 798 static gboolean
 799 write_filters_file(GSList *cfl, FILE *f, gboolean only_selected)
 800 {
 801     struct write_filter_data data;
 802
 803     data.f = f;
 804     data.only_selected = only_selected;
 805
 806     fprintf(f,"# DO NOT EDIT THIS FILE!  It was created by Wireshark\n");
 807     g_slist_foreach(cfl, write_filter, &data);
 808     return TRUE;
 809 }
 810
 811 /* save filters in users filter file */
 812 gboolean
 813 color_filters_write(GSList *cfl, gchar** err_msg)
 814 {
 815     gchar *pf_dir_path;
 816     gchar *path;
 817     FILE  *f;
 818
 819     /* Create the directory that holds personal configuration files,
 820        if necessary.  */
 821     if (create_persconffile_dir(&pf_dir_path) == -1) {
 822         *err_msg = g_strdup_printf("Can't create directory\n\"%s\"\nfor color files: %s.",
 823                       pf_dir_path, g_strerror(errno));
 824         g_free(pf_dir_path);
 825         return FALSE;
 826     }
 827
 828     path = get_persconffile_path("colorfilters", TRUE);
 829     if ((f = ws_fopen(path, "w+")) == NULL) {
 830         *err_msg = g_strdup_printf("Could not open\n%s\nfor writing: %s.",
 831                       path, g_strerror(errno));
 832         g_free(path);
 833         return FALSE;
 834     }
 835     g_free(path);
 836     write_filters_file(cfl, f, FALSE);
 837     fclose(f);
 838     return TRUE;
 839 }
 840
 841 /* save filters in some other filter file (export) */
 842 gboolean
 843 color_filters_export(const gchar *path, GSList *cfl, gboolean only_marked, gchar** err_msg)
 844 {
 845     FILE *f;
 846
 847     if ((f = ws_fopen(path, "w+")) == NULL) {
 848         *err_msg = g_strdup_printf("Could not open\n%s\nfor writing: %s.",
 849                       path, g_strerror(errno));
 850         return FALSE;
 851     }
 852     write_filters_file(cfl, f, only_marked);
 853     fclose(f);
 854     return TRUE;
 855 }
 856
 857 /*
 858  * Editor modelines  -  http://www.wireshark.org/tools/modelines.html
 859  *
 860  * Local variables:
 861  * c-basic-offset: 4
 862  * tab-width: 8
 863  * indent-tabs-mode: nil
 864  * End:
 865  *
 866  * vi: set shiftwidth=4 tabstop=8 expandtab:
 867  * :indentSize=4:tabSize=8:noTabs=true:
 868  */