Combine Decode As and port preferences for tcp.port dissector table.

This patch introduces new APIs to allow dissectors to have a preference for
a (TCP) port, but the underlying data is actually part of Decode As functionality.
For now the APIs are intentionally separate from the regular APIs that register a
dissector within a dissector table.  It may be possible to eventually combine the
two so that all dissectors that register with a dissector table have an opportunity
to "automatically" have a preference to adjust the "table value" through the
preferences dialog.

The tcp.port dissector table was used as the guinea pig.  This will eventually be
expanded to other dissector tables as well (most notably UDP ports).  Some
dissectors that "shared" a TCP/UDP port preference were also converted. It also
removed the need for some preference callback functions (mostly when the callback
function was the proto_reg_handoff function) so there is cleanup around that.

Dissectors that has a port preference whose default was 0 were switched to using
the dissector_add_for_decode_as_with_preference API rather than dissector_add_uint_with_preference

Also added comments for TCP ports used that aren't IANA registered.

Change-Id: I99604f95d426ad345f4b494598d94178b886eb67
Reviewed-on: https://code.wireshark.org/review/17724
Reviewed-by: Michael Mann <mmann78@netscape.net>

1 files changed, 0 insertions, 306 deletions

diff --git a/ui/decode_as_utils.c b/ui/decode_as_utils.c
index aec14d5f8d..173d82fe0b 100644
--- a/ui/decode_as_utils.c
+++ b/ui/decode_as_utils.c
@@ -30,8 +30,6 @@
 #include "epan/prefs.h"
 #include "epan/prefs-int.h"
 
-#include "epan/dissectors/packet-dcerpc.h"
-
 #include "ui/decode_as_utils.h"
 #include "ui/simple_dialog.h"
 
@@ -42,310 +40,6 @@
 
 /* XXX - We might want to switch this to a UAT */
 
-/*
- * A list of dissectors that need to be reset.
- */
-static GSList *dissector_reset_list = NULL;
-
-/*
- * Data structure used as user data when iterating dissector handles
- */
-typedef struct lookup_entry {
-    gchar*             dissector_short_name;
-    dissector_handle_t handle;
-} lookup_entry_t;
-
-/*
- * Data structure for tracking which dissector need to be reset.  This
- * structure is necessary as a hash table entry cannot be removed
- * while a g_hash_table_foreach walk is in progress.
- */
-typedef struct dissector_delete_item {
-    /* The name of the dissector table */
-    gchar *ddi_table_name;
-    /* The type of the selector in that dissector table */
-    ftenum_t ddi_selector_type;
-    /* The selector in the dissector table */
-    union {
-        guint   sel_uint;
-        char    *sel_string;
-    } ddi_selector;
-} dissector_delete_item_t;
-
-/*
- * A callback function to changed a dissector_handle if matched
- * This is used when iterating a dissector table
- */
-static void
-change_dissector_if_matched(gpointer item, gpointer user_data)
-{
-    dissector_handle_t handle = (dissector_handle_t)item;
-    lookup_entry_t * lookup = (lookup_entry_t *)user_data;
-    const gchar *proto_short_name = dissector_handle_get_short_name(handle);
-    if (proto_short_name && strcmp(lookup->dissector_short_name, proto_short_name) == 0) {
-        lookup->handle = handle;
-    }
-}
-
-/*
- * A callback function to parse each "decode as" entry in the file and apply the change
- */
-static prefs_set_pref_e
-read_set_decode_as_entries(gchar *key, const gchar *value,
-                           void *user_data _U_,
-                           gboolean return_range_errors _U_)
-{
-    gchar *values[4] = {NULL, NULL, NULL, NULL};
-    gchar delimiter[4] = {',', ',', ',','\0'};
-    gchar *pch;
-    guint i, j;
-    dissector_table_t sub_dissectors;
-    prefs_set_pref_e retval = PREFS_SET_OK;
-    gboolean is_valid = FALSE;
-
-    if (strcmp(key, DECODE_AS_ENTRY) == 0) {
-        /* Parse csv into table, selector, initial, current */
-        for (i = 0; i < 4; i++) {
-            pch = strchr(value, delimiter[i]);
-            if (pch == NULL) {
-                for (j = 0; j < i; j++) {
-                    g_free(values[j]);
-                }
-                return PREFS_SET_SYNTAX_ERR;
-            }
-            values[i] = g_strndup(value, pch - value);
-            value = pch + 1;
-        }
-        sub_dissectors = find_dissector_table(values[0]);
-        if (sub_dissectors != NULL) {
-            lookup_entry_t lookup;
-            ftenum_t selector_type;
-
-            lookup.dissector_short_name = values[3];
-            lookup.handle = NULL;
-            selector_type = dissector_table_get_type(sub_dissectors);
-
-            g_slist_foreach(dissector_table_get_dissector_handles(sub_dissectors),
-                    change_dissector_if_matched, &lookup);
-            if (lookup.handle != NULL || g_ascii_strcasecmp(values[3], DECODE_AS_NONE) == 0) {
-                is_valid = TRUE;
-            }
-
-            if (is_valid) {
-                if (IS_FT_STRING(selector_type)) {
-                    dissector_change_string(values[0], values[1], lookup.handle);
-                } else {
-                    char *p;
-                    long long_value;
-
-                    long_value = strtol(values[1], &p, 0);
-                    if (p == values[0] || *p != '\0' || long_value < 0 ||
-                          (unsigned long)long_value > UINT_MAX) {
-                        retval = PREFS_SET_SYNTAX_ERR;
-                        is_valid = FALSE;
-                    } else
-                        dissector_change_uint(values[0], (guint)long_value, lookup.handle);
-                }
-            }
-            if (is_valid) {
-                decode_build_reset_list(values[0], selector_type, values[1], NULL, NULL);
-            }
-        } else {
-            retval = PREFS_SET_SYNTAX_ERR;
-        }
-
-    } else {
-        retval = PREFS_SET_NO_SUCH_PREF;
-    }
-
-    for (i = 0; i < 4; i++) {
-        g_free(values[i]);
-    }
-    return retval;
-}
-
-void
-load_decode_as_entries(void)
-{
-    char   *daf_path;
-    FILE   *daf;
-
-    if (dissector_reset_list) {
-        decode_clear_all();
-    }
-
-    daf_path = get_persconffile_path(DECODE_AS_ENTRIES_FILE_NAME, TRUE);
-    if ((daf = ws_fopen(daf_path, "r")) != NULL) {
-        read_prefs_file(daf_path, daf, read_set_decode_as_entries, NULL);
-        fclose(daf);
-    }
-    g_free(daf_path);
-}
-
-void
-decode_build_reset_list (const gchar *table_name, ftenum_t selector_type,
-                         gpointer key, gpointer value _U_,
-                         gpointer user_data _U_)
-{
-    dissector_delete_item_t *item;
-
-    item = g_new(dissector_delete_item_t,1);
-    item->ddi_table_name = g_strdup(table_name);
-    item->ddi_selector_type = selector_type;
-    switch (selector_type) {
-
-    case FT_UINT8:
-    case FT_UINT16:
-    case FT_UINT24:
-    case FT_UINT32:
-        item->ddi_selector.sel_uint = GPOINTER_TO_UINT(key);
-        break;
-
-    case FT_STRING:
-    case FT_STRINGZ:
-    case FT_UINT_STRING:
-    case FT_STRINGZPAD:
-        item->ddi_selector.sel_string = g_strdup((char *)key);
-        break;
-
-    default:
-        g_assert_not_reached();
-    }
-    dissector_reset_list = g_slist_prepend(dissector_reset_list, item);
-}
-
-/* clear all settings */
-void
-decode_clear_all(void)
-{
-    dissector_delete_item_t *item;
-    GSList *tmp;
-
-    dissector_all_tables_foreach_changed(decode_build_reset_list, NULL);
-
-    for (tmp = dissector_reset_list; tmp; tmp = g_slist_next(tmp)) {
-        item = (dissector_delete_item_t *)tmp->data;
-        switch (item->ddi_selector_type) {
-
-        case FT_UINT8:
-        case FT_UINT16:
-        case FT_UINT24:
-        case FT_UINT32:
-            dissector_reset_uint(item->ddi_table_name,
-                                 item->ddi_selector.sel_uint);
-            break;
-
-        case FT_STRING:
-        case FT_STRINGZ:
-        case FT_UINT_STRING:
-        case FT_STRINGZPAD:
-            dissector_reset_string(item->ddi_table_name,
-                                   item->ddi_selector.sel_string);
-            g_free(item->ddi_selector.sel_string);
-            break;
-
-        default:
-            g_assert_not_reached();
-        }
-        g_free(item->ddi_table_name);
-        g_free(item);
-    }
-    g_slist_free(dissector_reset_list);
-    dissector_reset_list = NULL;
-
-    decode_dcerpc_reset_all();
-}
-
-static void
-decode_as_write_entry (const gchar *table_name, ftenum_t selector_type,
-                       gpointer key, gpointer value, gpointer user_data)
-{
-    FILE *da_file = (FILE *)user_data;
-    dissector_handle_t current, initial;
-    const gchar *current_proto_name, *initial_proto_name;
-
-    current = dtbl_entry_get_handle((dtbl_entry_t *)value);
-    if (current == NULL)
-        current_proto_name = DECODE_AS_NONE;
-    else
-        current_proto_name = dissector_handle_get_short_name(current);
-    initial = dtbl_entry_get_initial_handle((dtbl_entry_t *)value);
-    if (initial == NULL)
-        initial_proto_name = DECODE_AS_NONE;
-    else
-        initial_proto_name = dissector_handle_get_short_name(initial);
-
-    switch (selector_type) {
-
-    case FT_UINT8:
-    case FT_UINT16:
-    case FT_UINT24:
-    case FT_UINT32:
-        /*
-         * XXX - write these in decimal, regardless of the base of
-         * the dissector table's selector, as older versions of
-         * Wireshark used atoi() when reading this file, and
-         * failed to handle hex or octal numbers.
-         *
-         * That will be fixed in future 1.10 and 1.12 releases,
-         * but pre-1.10 releases are at end-of-life and won't
-         * be fixed.
-         */
-        fprintf (da_file,
-                 DECODE_AS_ENTRY ": %s,%u,%s,%s\n",
-                 table_name, GPOINTER_TO_UINT(key), initial_proto_name,
-                 current_proto_name);
-        break;
-
-    case FT_STRING:
-    case FT_STRINGZ:
-    case FT_UINT_STRING:
-    case FT_STRINGZPAD:
-        fprintf (da_file,
-                 DECODE_AS_ENTRY ": %s,%s,%s,%s\n",
-                 table_name, (gchar *)key, initial_proto_name,
-                 current_proto_name);
-        break;
-
-    default:
-        g_assert_not_reached();
-        break;
-    }
-}
-
-int
-save_decode_as_entries(gchar** err)
-{
-    char *pf_dir_path;
-    char *daf_path;
-    FILE *da_file;
-
-    if (create_persconffile_dir(&pf_dir_path) == -1) {
-        *err = g_strdup_printf("Can't create directory\n\"%s\"\nfor recent file: %s.",
-                                pf_dir_path, g_strerror(errno));
-        g_free(pf_dir_path);
-        return -1;
-    }
-
-    daf_path = get_persconffile_path(DECODE_AS_ENTRIES_FILE_NAME, TRUE);
-    if ((da_file = ws_fopen(daf_path, "w")) == NULL) {
-        *err = g_strdup_printf("Can't open decode_as_entries file\n\"%s\": %s.",
-                                daf_path, g_strerror(errno));
-        g_free(daf_path);
-        return -1;
-    }
-
-    fputs("# \"Decode As\" entries file for Wireshark " VERSION ".\n"
-        "#\n"
-        "# This file is regenerated each time \"Decode As\" preferences\n"
-        "# are saved within Wireshark. Making manual changes should be safe,\n"
-        "# however.\n", da_file);
-
-    dissector_all_tables_foreach_changed(decode_as_write_entry, da_file);
-    fclose(da_file);
-    return 0;
-}
-
 static const char* prev_display_dissector_name = NULL;
 
 /*