2 * Routines for color filters
4 * Wireshark - Network traffic analyzer
5 * By Gerald Combs <gerald@wireshark.org>
6 * Copyright 1998 Gerald Combs
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.
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.
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.
23 * Updated 1 Dec 10 jjm
34 #include <wsutil/filesystem.h>
35 #include <wsutil/file_util.h>
36 #include <wsutil/ws_printf.h> /* ws_g_warning */
38 #include <epan/packet.h>
39 #include "color_filters.h"
41 #include <epan/dfilter/dfilter.h>
42 #include <epan/prefs.h>
43 #include <epan/epan_dissect.h>
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))
49 static int read_filters_file(const gchar *path, FILE *f, gpointer user_data, color_filter_add_cb_func add_cb);
51 /* the currently active filters */
52 static GSList *color_filter_list = NULL;
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;
59 /* Color Filters can en-/disabled. */
60 static gboolean filters_enabled = TRUE;
62 /* Remember if there are temporary coloring filters set to
63 * add sensitivity to the "Reset Coloring 1-10" menu item
65 static gboolean tmp_colors_set = FALSE;
67 /* Create a new filter */
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? */
75 color_filter_t *colorf;
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;
86 /* Add ten empty (temporary) colorfilters for easy coloring */
88 color_filters_add_tmp(GSList **cfl)
95 color_t bg_color, fg_color;
96 color_filter_t *colorf;
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);
103 for ( i=1 ; i<=10 ; i++ ) {
104 name = g_strdup_printf("%s%02d",CONVERSATION_COLOR_PREFIX,i);
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);
122 g_strfreev(fg_colors);
123 g_strfreev(bg_colors);
129 color_filters_find_by_name_cb(gconstpointer arg1, gconstpointer arg2)
131 const color_filter_t *colorf = (const color_filter_t *)arg1;
132 const gchar *name = (const gchar *)arg2;
134 return strcmp(colorf->filter_name, name);
138 /* Set the filter off a temporary colorfilters and enable it */
140 color_filters_set_tmp(guint8 filt_nr, const gchar *filter, gboolean disabled, gchar **err_msg)
143 const gchar *tmpfilter = NULL;
145 color_filter_t *colorf;
146 dfilter_t *compiled_filter;
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
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
156 if( i!=filt_nr && filter==NULL )
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;
163 /* Only change the filter rule if this is the rule to change or if
164 * a matching filter string has been found
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
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);
176 g_free(colorf->filter_text);
177 dfilter_free(colorf->c_colorfilter);
178 colorf->filter_text = g_strdup(tmpfilter);
179 colorf->c_colorfilter = compiled_filter;
180 colorf->disabled = ((i!=filt_nr) ? TRUE : disabled);
181 /* Remember that there are now temporary coloring filters set */
183 tmp_colors_set = TRUE;
191 const color_filter_t *
192 color_filters_tmp_color(guint8 filter_num) {
194 color_filter_t *colorf = NULL;
197 name = g_strdup_printf("%s%02d", CONVERSATION_COLOR_PREFIX, filter_num);
198 cfl = g_slist_find_custom(color_filter_list, name, color_filters_find_by_name_cb);
200 colorf = (color_filter_t *)cfl->data;
207 /* Reset the temporary colorfilters */
209 color_filters_reset_tmp(gchar **err_msg)
213 for ( i=1 ; i<=10 ; i++ ) {
214 if (!color_filters_set_tmp(i, NULL, TRUE, err_msg))
217 /* Remember that there are now *no* temporary coloring filters set */
218 tmp_colors_set = FALSE;
222 /* delete the specified filter */
224 color_filter_delete(color_filter_t *colorf)
226 g_free(colorf->filter_name);
227 g_free(colorf->filter_text);
228 dfilter_free(colorf->c_colorfilter);
232 /* delete the specified filter (called from g_slist_foreach) */
234 color_filter_delete_cb(gpointer filter_arg, gpointer unused _U_)
236 color_filter_t *colorf = (color_filter_t *)filter_arg;
238 color_filter_delete(colorf);
241 /* delete the specified list */
243 color_filter_list_delete(GSList **cfl)
245 g_slist_foreach(*cfl, color_filter_delete_cb, NULL);
250 /* clone a single list entries from normal to edit list */
251 static color_filter_t *
252 color_filter_clone(color_filter_t *colorf)
254 color_filter_t *new_colorf;
256 new_colorf = (color_filter_t *)g_malloc(sizeof (color_filter_t));
257 new_colorf->filter_name = g_strdup(colorf->filter_name);
258 new_colorf->filter_text = g_strdup(colorf->filter_text);
259 new_colorf->bg_color = colorf->bg_color;
260 new_colorf->fg_color = colorf->fg_color;
261 new_colorf->disabled = colorf->disabled;
262 new_colorf->c_colorfilter = NULL;
263 new_colorf->color_edit_dlg_info = NULL;
264 new_colorf->selected = FALSE;
270 color_filter_list_clone_cb(gpointer filter_arg, gpointer cfl_arg)
272 GSList **cfl = (GSList **)cfl_arg;
273 color_filter_t *new_colorf;
275 new_colorf = color_filter_clone((color_filter_t *)filter_arg);
276 *cfl = g_slist_append(*cfl, new_colorf);
279 /* clone the specified list */
281 color_filter_list_clone(GSList *cfl)
283 GSList *new_list = NULL;
285 g_slist_foreach(cfl, color_filter_list_clone_cb, &new_list);
291 color_filters_get(gchar** err_msg, color_filter_add_cb_func add_cb)
297 /* start the list with the temporary colorizing rules */
298 color_filters_add_tmp(&color_filter_list);
301 * Try to get the user's filters.
303 * Get the path for the file that would have their filters, and
306 path = get_persconffile_path("colorfilters", TRUE);
307 if ((f = ws_fopen(path, "r")) == NULL) {
308 if (errno != ENOENT) {
309 /* Error trying to open the file; give up. */
310 *err_msg = g_strdup_printf("Could not open filter file\n\"%s\": %s.", path,
315 /* They don't have any filters; try to read the global filters */
317 return color_filters_read_globals(&color_filter_list, err_msg, add_cb);
321 * We've opened it; try to read it.
323 ret = read_filters_file(path, f, &color_filter_list, add_cb);
325 *err_msg = g_strdup_printf("Error reading filter file\n\"%s\": %s.",
326 path, g_strerror(errno));
338 /* Initialize the filter structures (reading from file) for general running, including app startup */
340 color_filters_init(gchar** err_msg, color_filter_add_cb_func add_cb)
342 /* delete all currently existing filters */
343 color_filter_list_delete(&color_filter_list);
345 /* now try to construct the filters list */
346 return color_filters_get(err_msg, add_cb);
350 color_filters_reload(gchar** err_msg, color_filter_add_cb_func add_cb)
352 /* "move" old entries to the deleted list
353 * we must keep them until the dissection no longer needs them */
354 color_filter_deleted_list = g_slist_concat(color_filter_deleted_list, color_filter_list);
355 color_filter_list = NULL;
357 /* now try to construct the filters list */
358 return color_filters_get(err_msg, add_cb);
362 color_filters_cleanup(void)
364 /* delete the previously deleted filters */
365 color_filter_list_delete(&color_filter_deleted_list);
368 typedef struct _color_clone
371 color_filter_add_cb_func add_cb;
375 color_filters_clone_cb(gpointer filter_arg, gpointer user_data)
377 color_clone_t* clone_data = (color_clone_t*)user_data;
378 color_filter_t * new_colorf = color_filter_clone((color_filter_t *)filter_arg);
380 clone_data->add_cb (new_colorf, clone_data->user_data);
384 color_filters_clone(gpointer user_data, color_filter_add_cb_func add_cb)
386 color_clone_t clone_data;
388 clone_data.user_data = user_data;
389 clone_data.add_cb = add_cb;
390 g_slist_foreach(color_filter_list, color_filters_clone_cb, &clone_data);
395 color_filter_compile_cb(gpointer filter_arg, gpointer err)
397 color_filter_t *colorf = (color_filter_t *)filter_arg;
398 gchar **err_msg = (gchar**)err;
399 gchar *local_err_msg = NULL;
401 g_assert(colorf->c_colorfilter == NULL);
403 /* If the filter is disabled it doesn't matter if it compiles or not. */
404 if (colorf->disabled) return;
406 if (!dfilter_compile(colorf->filter_text, &colorf->c_colorfilter, &local_err_msg)) {
407 *err_msg = g_strdup_printf("Could not compile 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 /* this filter was compilable before, so this should never happen */
411 /* except if the OK button of the parent window has been clicked */
412 /* so don't use g_assert_not_reached() but check the filters again */
417 color_filter_validate_cb(gpointer filter_arg, gpointer err)
419 color_filter_t *colorf = (color_filter_t *)filter_arg;
420 gchar **err_msg = (gchar**)err;
421 gchar *local_err_msg;
423 g_assert(colorf->c_colorfilter == NULL);
425 /* If the filter is disabled it doesn't matter if it compiles or not. */
426 if (colorf->disabled) return;
428 if (!dfilter_compile(colorf->filter_text, &colorf->c_colorfilter, &local_err_msg)) {
429 *err_msg = g_strdup_printf("Removing color filter name: \"%s\" text: \"%s\".\n%s",
430 colorf->filter_name, colorf->filter_text, local_err_msg);
431 g_free(local_err_msg);
432 /* Delete the color filter from the list of color filters. */
433 color_filter_valid_list = g_slist_remove(color_filter_valid_list, colorf);
434 color_filter_delete(colorf);
438 /* apply changes from the edit list */
440 color_filters_apply(GSList *tmp_cfl, GSList *edit_cfl, gchar** err_msg)
446 /* "move" old entries to the deleted list
447 * we must keep them until the dissection no longer needs them */
448 color_filter_deleted_list = g_slist_concat(color_filter_deleted_list, color_filter_list);
449 color_filter_list = NULL;
451 /* clone all list entries from tmp/edit to normal list */
452 color_filter_valid_list = NULL;
453 color_filter_valid_list = color_filter_list_clone(tmp_cfl);
454 color_filter_valid_list = g_slist_concat(color_filter_valid_list,
455 color_filter_list_clone(edit_cfl) );
457 /* compile all filter */
458 g_slist_foreach(color_filter_valid_list, color_filter_validate_cb, err_msg);
459 if (*err_msg != NULL) {
463 /* clone all list entries from tmp/edit to normal list */
464 color_filter_list = color_filter_list_clone(color_filter_valid_list);
466 /* compile all filter */
467 g_slist_foreach(color_filter_list, color_filter_compile_cb, err_msg);
468 if (*err_msg != NULL) {
476 color_filters_used(void)
478 return color_filter_list != NULL && filters_enabled;
482 tmp_color_filters_used(void)
484 return tmp_colors_set;
487 /* prepare the epan_dissect_t for the filter */
489 prime_edt(gpointer data, gpointer user_data)
491 color_filter_t *colorf = (color_filter_t *)data;
492 epan_dissect_t *edt = (epan_dissect_t *)user_data;
494 if (colorf->c_colorfilter != NULL)
495 epan_dissect_prime_with_dfilter(edt, colorf->c_colorfilter);
498 /* Prime the epan_dissect_t with all the compiler
499 * color filters in 'color_filter_list'. */
501 color_filters_prime_edt(epan_dissect_t *edt)
503 if (color_filters_used())
504 g_slist_foreach(color_filter_list, prime_edt, edt);
507 /* * Return the color_t for later use */
508 const color_filter_t *
509 color_filters_colorize_packet(epan_dissect_t *edt)
512 color_filter_t *colorf;
514 /* If we have color filters, "search" for the matching one. */
515 if ((edt->tree != NULL) && (color_filters_used())) {
516 curr = color_filter_list;
518 while(curr != NULL) {
519 colorf = (color_filter_t *)curr->data;
520 if ( (!colorf->disabled) &&
521 (colorf->c_colorfilter != NULL) &&
522 dfilter_apply_edt(colorf->c_colorfilter, edt)) {
525 curr = g_slist_next(curr);
532 /* read filters from the given file */
533 /* XXX - Would it make more sense to use GStrings here instead of reallocing
536 read_filters_file(const gchar *path, FILE *f, gpointer user_data, color_filter_add_cb_func add_cb)
538 #define INIT_BUF_SIZE 128
540 gchar *filter_exp = NULL;
541 guint32 name_len = INIT_BUF_SIZE;
542 guint32 filter_exp_len = INIT_BUF_SIZE;
545 guint16 fg_r, fg_g, fg_b, bg_r, bg_g, bg_b;
546 gboolean disabled = FALSE;
547 gboolean skip_end_of_line = FALSE;
550 name = (gchar *)g_malloc(name_len + 1);
551 filter_exp = (gchar *)g_malloc(filter_exp_len + 1);
555 if (skip_end_of_line) {
557 c = ws_getc_unlocked(f);
558 } while (c != EOF && c != '\n');
562 skip_end_of_line = FALSE;
565 while ((c = ws_getc_unlocked(f)) != EOF && g_ascii_isspace(c)) {
579 /* skip # comments and invalid lines */
581 skip_end_of_line = TRUE;
585 /* we get the @ delimiter.
587 * @name@filter expression@[background r,g,b][foreground r,g,b]
593 c = ws_getc_unlocked(f);
594 if (c == EOF || c == '@')
597 /* buffer isn't long enough; double its length.*/
599 name = (gchar *)g_realloc(name, name_len + 1);
608 skip_end_of_line = TRUE;
612 /* retrieve filter expression */
615 c = ws_getc_unlocked(f);
616 if (c == EOF || c == '@')
618 if (i >= filter_exp_len) {
619 /* buffer isn't long enough; double its length.*/
621 filter_exp = (gchar *)g_realloc(filter_exp, filter_exp_len + 1);
625 filter_exp[i] = '\0';
630 skip_end_of_line = TRUE;
634 /* retrieve background and foreground colors */
635 if (fscanf(f,"[%hu,%hu,%hu][%hu,%hu,%hu]",
636 &bg_r, &bg_g, &bg_b, &fg_r, &fg_g, &fg_b) == 6) {
638 /* we got a complete color filter */
640 color_t bg_color, fg_color;
641 color_filter_t *colorf;
642 dfilter_t *temp_dfilter = NULL;
643 gchar *local_err_msg = NULL;
645 if (!disabled && !dfilter_compile(filter_exp, &temp_dfilter, &local_err_msg)) {
646 ws_g_warning("Could not compile \"%s\" in colorfilters file \"%s\".\n%s",
647 name, path, local_err_msg);
648 g_free(local_err_msg);
649 prefs.unknown_colorfilters = TRUE;
651 /* skip_end_of_line = TRUE; */
656 fg_color.green = fg_g;
657 fg_color.blue = fg_b;
660 bg_color.green = bg_g;
661 bg_color.blue = bg_b;
663 colorf = color_filter_new(name, filter_exp, &bg_color,
664 &fg_color, disabled);
665 if(user_data == &color_filter_list) {
666 GSList **cfl = (GSList **)user_data;
669 colorf->c_colorfilter = temp_dfilter;
670 *cfl = g_slist_append(*cfl, colorf);
673 /* just editing, don't need the compiled filter */
674 dfilter_free(temp_dfilter);
675 add_cb(colorf, user_data);
679 skip_end_of_line = TRUE;
690 /* read filters from the filter file */
692 color_filters_read_globals(gpointer user_data, gchar** err_msg, color_filter_add_cb_func add_cb)
699 * Try to get the global filters.
701 * Get the path for the file that would have the global filters, and
704 path = get_datafile_path("colorfilters");
705 if ((f = ws_fopen(path, "r")) == NULL) {
706 if (errno != ENOENT) {
707 /* Error trying to open the file; give up. */
708 *err_msg = g_strdup_printf("Could not open global filter file\n\"%s\": %s.", path,
715 * There is no global filter file; treat that as equivalent to
716 * that file existing bug being empty, and say we succeeded.
721 ret = read_filters_file(path, f, user_data, add_cb);
723 *err_msg = g_strdup_printf("Error reading global filter file\n\"%s\": %s.",
724 path, g_strerror(errno));
735 /* read filters from some other filter file (import) */
737 color_filters_import(const gchar *path, gpointer user_data, gchar **err_msg, color_filter_add_cb_func add_cb)
742 if ((f = ws_fopen(path, "r")) == NULL) {
743 *err_msg = g_strdup_printf("Could not open filter file\n%s\nfor reading: %s.",
744 path, g_strerror(errno));
748 ret = read_filters_file(path, f, user_data, add_cb);
750 *err_msg = g_strdup_printf("Error reading filter file\n\"%s\": %s.",
751 path, g_strerror(errno));
760 struct write_filter_data
763 gboolean only_selected;
766 /* save a single filter */
768 write_filter(gpointer filter_arg, gpointer data_arg)
770 struct write_filter_data *data = (struct write_filter_data *)data_arg;
771 color_filter_t *colorf = (color_filter_t *)filter_arg;
774 if ( (colorf->selected || !data->only_selected) &&
775 (strstr(colorf->filter_name,CONVERSATION_COLOR_PREFIX)==NULL) ) {
776 fprintf(f,"%s@%s@%s@[%u,%u,%u][%u,%u,%u]\n",
777 colorf->disabled ? "!" : "",
780 colorf->bg_color.red,
781 colorf->bg_color.green,
782 colorf->bg_color.blue,
783 colorf->fg_color.red,
784 colorf->fg_color.green,
785 colorf->fg_color.blue);
789 /* save filters in a filter file */
791 write_filters_file(GSList *cfl, FILE *f, gboolean only_selected)
793 struct write_filter_data data;
796 data.only_selected = only_selected;
798 fprintf(f,"# DO NOT EDIT THIS FILE! It was created by Wireshark\n");
799 g_slist_foreach(cfl, write_filter, &data);
803 /* save filters in users filter file */
805 color_filters_write(GSList *cfl, gchar** err_msg)
811 /* Create the directory that holds personal configuration files,
813 if (create_persconffile_dir(&pf_dir_path) == -1) {
814 *err_msg = g_strdup_printf("Can't create directory\n\"%s\"\nfor color files: %s.",
815 pf_dir_path, g_strerror(errno));
820 path = get_persconffile_path("colorfilters", TRUE);
821 if ((f = ws_fopen(path, "w+")) == NULL) {
822 *err_msg = g_strdup_printf("Could not open\n%s\nfor writing: %s.",
823 path, g_strerror(errno));
828 write_filters_file(cfl, f, FALSE);
833 /* save filters in some other filter file (export) */
835 color_filters_export(const gchar *path, GSList *cfl, gboolean only_marked, gchar** err_msg)
839 if ((f = ws_fopen(path, "w+")) == NULL) {
840 *err_msg = g_strdup_printf("Could not open\n%s\nfor writing: %s.",
841 path, g_strerror(errno));
844 write_filters_file(cfl, f, only_marked);
850 * Editor modelines - http://www.wireshark.org/tools/modelines.html
855 * indent-tabs-mode: nil
858 * vi: set shiftwidth=4 tabstop=8 expandtab:
859 * :indentSize=4:tabSize=8:noTabs=true: