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