forked from osmocom/wireshark
82bb9ebc01
Change-Id: I63e46285b4c6676d4ae57196b85fbad89964898c Reviewed-on: https://code.wireshark.org/review/13933 Petri-Dish: João Valverde <j@v6e.pt> Tested-by: Petri Dish Buildbot <buildbot-no-reply@wireshark.org> Reviewed-by: João Valverde <j@v6e.pt>
311 lines
9.4 KiB
C
311 lines
9.4 KiB
C
/* plugin_if.c
|
|
* An API for Wireshark plugins
|
|
*
|
|
* This enables wireshark dissectors, especially those implemented by plugins
|
|
* to register menubar entries, which then will call a pre-defined callback
|
|
* function for the dissector or plugin.
|
|
*
|
|
* Also it implements additional methods, which allow plugins to interoperate
|
|
* with the main GUI.
|
|
*
|
|
* Wireshark - Network traffic analyzer
|
|
* By Gerald Combs <gerald@wireshark.org>
|
|
* Copyright 1998 Gerald Combs
|
|
*
|
|
* This program is free software; you can redistribute it and/or
|
|
* modify it under the terms of the GNU General Public License
|
|
* as published by the Free Software Foundation; either version 2
|
|
* of the License, or (at your option) any later version.
|
|
*
|
|
* This program is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
* GNU General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU General Public License
|
|
* along with this program; if not, write to the Free Software
|
|
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
|
|
*/
|
|
|
|
#include "config.h"
|
|
|
|
#include <glib.h>
|
|
#include <epan/epan.h>
|
|
#include <epan/proto.h>
|
|
|
|
#include "plugin_if.h"
|
|
|
|
static GList * menubar_entries = NULL;
|
|
static GList * menubar_menunames = NULL;
|
|
|
|
|
|
extern GList * ext_menubar_get_entries(void)
|
|
{
|
|
return menubar_entries;
|
|
}
|
|
|
|
extern ext_menu_t * ext_menubar_register_menu(int proto_id, const gchar * menulabel,
|
|
gboolean is_plugin)
|
|
{
|
|
ext_menubar_t * entry = NULL;
|
|
gchar * name = NULL;
|
|
|
|
/* A name for the entry must be provided */
|
|
g_assert(menulabel != NULL && strlen ( menulabel ) > 0 );
|
|
|
|
/* A protocol must exist for the given id */
|
|
g_assert(find_protocol_by_id(proto_id) != NULL);
|
|
|
|
/* Create unique name, which is used by GTK to provide the menu */
|
|
name = g_strconcat(proto_get_protocol_filter_name(proto_id), "Menu", NULL);
|
|
|
|
/* For now, a protocol may only register one main menu */
|
|
g_assert(g_list_find(menubar_menunames, name) == NULL);
|
|
|
|
entry = (ext_menubar_t *)g_malloc0(sizeof(ext_menubar_t));
|
|
entry->type = EXT_MENUBAR_MENU;
|
|
entry->proto = proto_id;
|
|
entry->is_plugin = is_plugin;
|
|
|
|
entry->parent_menu = 0;
|
|
|
|
/* Create a name for this submenu */
|
|
entry->name = name;
|
|
entry->label = g_strdup(menulabel);
|
|
entry->tooltip = g_strdup(menulabel);
|
|
|
|
entry->submenu_cnt = 0;
|
|
entry->item_cnt = 0;
|
|
|
|
menubar_entries = g_list_append(menubar_entries, entry);
|
|
menubar_menunames = g_list_append(menubar_menunames, name);
|
|
|
|
return entry;
|
|
}
|
|
|
|
extern ext_menu_t * ext_menubar_set_parentmenu(ext_menu_t * menu, const gchar * parentmenu)
|
|
{
|
|
g_assert(menu != NULL && menu->parent == NULL);
|
|
|
|
g_assert(parentmenu != 0);
|
|
|
|
menu->parent_menu = g_strdup(parentmenu);
|
|
|
|
return menu;
|
|
}
|
|
|
|
extern ext_menu_t * ext_menubar_add_submenu(ext_menu_t * parent, const gchar *menulabel)
|
|
{
|
|
ext_menubar_t * entry = NULL;
|
|
|
|
/* A name for the entry must be provided */
|
|
g_assert(menulabel != NULL && strlen ( menulabel ) > 0 );
|
|
|
|
/* Parent must be a valid parent */
|
|
g_assert(parent != NULL && parent->type == EXT_MENUBAR_MENU);
|
|
|
|
parent->submenu_cnt++;
|
|
|
|
/* Create submenu entry */
|
|
entry = (ext_menubar_t *)g_malloc0(sizeof(ext_menubar_t));
|
|
entry->type = EXT_MENUBAR_MENU;
|
|
entry->parent = parent;
|
|
/* Just a convenience */
|
|
entry->proto = parent->proto;
|
|
entry->is_plugin = parent->is_plugin;
|
|
/* Create unique name, which is used by GTK to provide the menu */
|
|
entry->name = g_strdup_printf("%sS%02d", parent->name, parent->submenu_cnt);
|
|
entry->label = g_strdup(menulabel);
|
|
entry->tooltip = g_strdup(menulabel);
|
|
|
|
parent->children = g_list_append(parent->children, entry);
|
|
|
|
return entry;
|
|
}
|
|
|
|
static void ext_menubar_add_generic_entry (
|
|
ext_menubar_entry_t type, ext_menu_t * parent, const gchar * label,
|
|
const gchar * tooltip, ext_menubar_action_cb callback, gpointer user_data )
|
|
{
|
|
ext_menubar_t * entry = NULL;
|
|
|
|
/* A valid parent must exist */
|
|
g_assert(parent != NULL && parent->type == EXT_MENUBAR_MENU);
|
|
/* A label for the entry must be provided */
|
|
g_assert(label != NULL && strlen ( label ) > 0 );
|
|
|
|
parent->item_cnt++;
|
|
|
|
/* Create menu entry */
|
|
entry = (ext_menubar_t*)g_malloc0(sizeof(ext_menubar_t));
|
|
entry->type = type;
|
|
/* Create unique name, which is used by GTK to provide the menu */
|
|
entry->name = g_strdup_printf("%sI%02d", parent->name, parent->item_cnt);
|
|
entry->label = g_strdup(label);
|
|
|
|
if ( tooltip != NULL && strlen(tooltip) > 0 )
|
|
entry->tooltip = g_strdup(tooltip);
|
|
|
|
entry->callback = callback;
|
|
entry->user_data = user_data;
|
|
|
|
parent->children = g_list_append(parent->children, entry);
|
|
}
|
|
|
|
extern void ext_menubar_add_entry(ext_menu_t * parent, const gchar *label,
|
|
const gchar *tooltip, ext_menubar_action_cb callback, gpointer user_data)
|
|
{
|
|
/* A callback must be provided */
|
|
g_assert(callback != NULL);
|
|
|
|
ext_menubar_add_generic_entry ( EXT_MENUBAR_ITEM, parent, label, tooltip, callback, user_data );
|
|
}
|
|
|
|
extern void ext_menubar_add_website(ext_menu_t * parent, const gchar *label,
|
|
const gchar *tooltip, const gchar *url)
|
|
{
|
|
/* An url for the entry must be provided */
|
|
g_assert(url != NULL && strlen ( url ) > 0 );
|
|
|
|
ext_menubar_add_generic_entry ( EXT_MENUBAR_URL, parent, label, tooltip, NULL, (gpointer) g_strdup(url) );
|
|
}
|
|
|
|
extern void ext_menubar_add_separator(ext_menu_t *parent)
|
|
{
|
|
ext_menubar_add_generic_entry ( EXT_MENUBAR_SEPARATOR, parent, g_strdup("-"), NULL, NULL, NULL );
|
|
}
|
|
|
|
/* Implementation of GUI callback methods follows.
|
|
* This is a necessity, as using modern UI systems, gui interfaces often operate
|
|
* in different threads then the calling application. Even more so, if the calling
|
|
* application is implemented using a separate plugin. Therefore the external menubars
|
|
* cannot call gui functionality directly, the gui has to perform the function within
|
|
* it' own scope. */
|
|
|
|
static GHashTable * plugin_if_callback_functions;
|
|
|
|
static void
|
|
plugin_if_init_hashtable(void)
|
|
{
|
|
if ( plugin_if_callback_functions == 0 )
|
|
plugin_if_callback_functions = g_hash_table_new(g_int_hash, g_int_equal);
|
|
}
|
|
|
|
static void plugin_if_call_gui_cb(plugin_if_callback_t actionType, GHashTable * dataSet)
|
|
{
|
|
plugin_if_gui_cb action;
|
|
gint * key = 0;
|
|
|
|
key = (gint *)g_malloc0(sizeof(gint));
|
|
*key = (gint) actionType;
|
|
|
|
plugin_if_init_hashtable();
|
|
|
|
if ( g_hash_table_size(plugin_if_callback_functions) != 0 )
|
|
{
|
|
if ( g_hash_table_lookup_extended(plugin_if_callback_functions, key, NULL, (gpointer*)&action) )
|
|
{
|
|
if ( action != NULL )
|
|
action(dataSet);
|
|
}
|
|
}
|
|
}
|
|
|
|
extern void plugin_if_apply_filter(const char * filter_string, gboolean force)
|
|
{
|
|
plugin_if_callback_t actionType;
|
|
GHashTable * dataSet = NULL;
|
|
|
|
actionType = ( force == TRUE ) ? PLUGIN_IF_FILTER_ACTION_APPLY : PLUGIN_IF_FILTER_ACTION_PREPARE;
|
|
dataSet = g_hash_table_new(g_str_hash, g_str_equal);
|
|
|
|
g_hash_table_insert( dataSet, g_strdup("action_type"), (gpointer) &actionType );
|
|
g_hash_table_insert( dataSet, g_strdup("filter_string"), g_strdup(filter_string) );
|
|
g_hash_table_insert( dataSet, g_strdup("force"), (gpointer) &force );
|
|
|
|
plugin_if_call_gui_cb(actionType, dataSet);
|
|
}
|
|
|
|
extern void plugin_if_goto_frame(guint32 framenr)
|
|
{
|
|
GHashTable * dataSet = NULL;
|
|
|
|
dataSet = g_hash_table_new(g_str_hash, g_str_equal);
|
|
|
|
g_hash_table_insert( dataSet, g_strdup("frame_nr"), GUINT_TO_POINTER(framenr) );
|
|
|
|
plugin_if_call_gui_cb(PLUGIN_IF_GOTO_FRAME, dataSet);
|
|
}
|
|
|
|
extern void plugin_if_save_preference(const char * pref_module, const char * pref_key, const char * pref_value)
|
|
{
|
|
GHashTable * dataSet = NULL;
|
|
|
|
dataSet = g_hash_table_new(g_str_hash, g_str_equal);
|
|
|
|
g_hash_table_insert( dataSet, g_strdup("pref_module"), g_strdup(pref_module) );
|
|
g_hash_table_insert( dataSet, g_strdup("pref_key"), g_strdup(pref_key) );
|
|
g_hash_table_insert( dataSet, g_strdup("pref_value"), g_strdup(pref_value) );
|
|
|
|
plugin_if_call_gui_cb(PLUGIN_IF_PREFERENCE_SAVE, dataSet);
|
|
}
|
|
|
|
extern void plugin_if_get_ws_info(ws_info_t **ws_info_ptr)
|
|
{
|
|
static ws_info_t ws_info = { FALSE, FILE_CLOSED, NULL, 0, 0, FALSE };
|
|
#ifdef HAVE_LIBPCAP
|
|
|
|
GHashTable * dataSet;
|
|
gchar * pluginKey = g_strdup("ws_info");
|
|
|
|
dataSet = g_hash_table_new(g_str_hash, g_str_equal);
|
|
|
|
g_hash_table_insert(dataSet, pluginKey, &ws_info);
|
|
|
|
plugin_if_call_gui_cb(PLUGIN_IF_GET_WS_INFO, dataSet);
|
|
|
|
g_hash_table_destroy(dataSet);
|
|
g_free(pluginKey);
|
|
|
|
#else
|
|
|
|
/* Initialise the ws_info structure */
|
|
|
|
ws_info.ws_info_supported = FALSE;
|
|
ws_info.cf_count = 0;
|
|
ws_info.cf_filename = NULL;
|
|
ws_info.cf_framenr = 0;
|
|
ws_info.frame_passed_dfilter = FALSE;
|
|
ws_info.cf_state = FILE_CLOSED;
|
|
|
|
#endif /* HAVE_LIBPCAP */
|
|
|
|
*ws_info_ptr = &ws_info;
|
|
}
|
|
|
|
extern void plugin_if_register_gui_cb(plugin_if_callback_t actionType, plugin_if_gui_cb callback)
|
|
{
|
|
gint * key = 0;
|
|
|
|
key = (gint *)g_malloc0(sizeof(gint));
|
|
*key = actionType;
|
|
|
|
plugin_if_init_hashtable();
|
|
|
|
if ( ! g_hash_table_lookup_extended(plugin_if_callback_functions, key, NULL, NULL ) )
|
|
g_hash_table_insert(plugin_if_callback_functions, key, (gpointer)callback);
|
|
}
|
|
|
|
/*
|
|
* Editor modelines
|
|
*
|
|
* Local Variables:
|
|
* c-basic-offset: 4
|
|
* tab-width: 8
|
|
* indent-tabs-mode: nil
|
|
* End:
|
|
*
|
|
* ex: set shiftwidth=4 tabstop=8 expandtab:
|
|
* :indentSize=4:tabSize=8:noTabs=true:
|
|
*/
|