4 * $Id: plugins.c,v 1.81 2004/05/20 13:48:25 ulfl Exp $
6 * Ethereal - Network traffic analyzer
7 * By Gerald Combs <gerald@ethereal.com>
8 * Copyright 1999 Gerald Combs
10 * This program is free software; you can redistribute it and/or
11 * modify it under the terms of the GNU General Public License
12 * as published by the Free Software Foundation; either version 2
13 * of the License, or (at your option) any later version.
15 * This program is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 * GNU General Public License for more details.
20 * You should have received a copy of the GNU General Public License
21 * along with this program; if not, write to the Free Software
22 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
29 #ifdef NEED_SNPRINTF_H
30 # include "snprintf.h"
51 #ifdef HAVE_SYS_STAT_H
59 #include "filesystem.h"
61 #ifdef PLUGINS_NEED_ADDRESS_TABLE
62 #include "conversation.h"
63 #include "reassemble.h"
65 #include "packet-giop.h"
66 #include "packet-tpkt.h"
67 #include "packet-tcp.h"
70 #include "packet-per.h"
71 #include "packet-ber.h"
73 #include "report_err.h"
74 #include "plugins/plugin_table.h"
75 static plugin_address_table_t patable = {
76 /* file generated by plugin_gen.py */
77 #include "plugins/Xass-list"
81 /* linked list of all plugins */
84 static gchar *user_plug_dir = NULL;
86 #define PLUGINS_DIR_NAME "plugins"
89 * add a new plugin to the list
92 * - ENOMEM : memory allocation problem
93 * - EEXIST : the same plugin (i.e. name/version) was already registered.
96 add_plugin(void *handle, gchar *name, gchar *version,
97 void (*reg_handoff)(void))
99 plugin *new_plug, *pt_plug;
101 pt_plug = plugin_list;
102 if (!pt_plug) /* the list is empty */
104 new_plug = (plugin *)g_malloc(sizeof(plugin));
105 if (new_plug == NULL) return ENOMEM;
106 plugin_list = new_plug;
112 /* check if the same name/version is already registered */
113 if (!strcmp(pt_plug->name, name) &&
114 !strcmp(pt_plug->version, version))
119 /* we found the last plugin in the list */
120 if (pt_plug->next == NULL) break;
122 pt_plug = pt_plug->next;
124 new_plug = (plugin *)g_malloc(sizeof(plugin));
125 if (new_plug == NULL) return ENOMEM;
126 pt_plug->next = new_plug;
129 new_plug->handle = handle;
130 new_plug->name = name;
131 new_plug->version = version;
132 new_plug->reg_handoff = reg_handoff;
133 new_plug->next = NULL;
138 * XXX - when we remove support for old-style plugins (which we should
139 * probably do eventually, as all plugins should be written as new-style
140 * ones), we may want to have "init_plugins()" merely save a pointer
141 * to the plugin's "init" routine, just as we save a pointer to its
142 * "reg_handoff" routine, and have a "register_all_plugins()" routine
143 * to go through the list of plugins and call all of them.
145 * Then we'd have "epan_init()", or perhaps even something higher up
146 * in the call tree, call "init_plugins()", and have "proto_init()"
147 * call "register_all_plugins()" right after calling "register_all_protocols()";
148 * this might be a bit cleaner.
151 plugins_scan_dir(const char *dirname)
153 #define FILENAME_LEN 1024
154 #if GLIB_MAJOR_VERSION < 2
155 gchar *hack_path; /* pathname used to construct lt_lib_ext */
156 gchar *lt_lib_ext; /* extension for loadable modules */
157 DIR *dir; /* scanned directory */
158 struct dirent *file; /* current file */
161 GDir *dir; /* scanned directory */
165 gchar filename[FILENAME_LEN]; /* current file name */
166 GModule *handle; /* handle returned by dlopen */
168 void (*init)(void *);
169 void (*reg_handoff)(void);
173 #if GLIB_MAJOR_VERSION < 2
175 * We find the extension used on this platform for loadable modules
176 * by the sneaky hack of calling "g_module_build_path" to build
177 * the pathname for a module with an empty directory name and
178 * empty module name, and then search for the last "." and use
179 * everything from the last "." on.
181 hack_path = g_module_build_path("", "");
182 lt_lib_ext = strrchr(hack_path, '.');
183 if (lt_lib_ext == NULL)
186 * Does this mean there *is* no extension? Assume so.
188 * XXX - the code below assumes that all loadable modules have
194 if ((dir = opendir(dirname)) != NULL)
196 while ((file = readdir(dir)) != NULL)
198 /* don't try to open "." and ".." */
199 if (!(strcmp(file->d_name, "..") &&
200 strcmp(file->d_name, "."))) continue;
202 /* skip anything but files with lt_lib_ext */
203 dot = strrchr(file->d_name, '.');
204 if (dot == NULL || strcmp(dot, lt_lib_ext) != 0) continue;
206 snprintf(filename, FILENAME_LEN, "%s" G_DIR_SEPARATOR_S "%s",
207 dirname, file->d_name);
208 name = (gchar *)file->d_name;
211 * GLib 2.x defines G_MODULE_SUFFIX as the extension used on this
212 * platform for loadable modules.
214 dummy = g_malloc(sizeof(GError *));
216 if ((dir = g_dir_open(dirname, 0, dummy)) != NULL)
218 while ((name = g_dir_read_name(dir)) != NULL)
220 /* skip anything but files with G_MODULE_SUFFIX */
221 dot = strrchr(name, '.');
222 if (dot == NULL || strcmp(dot+1, G_MODULE_SUFFIX) != 0) continue;
224 snprintf(filename, FILENAME_LEN, "%s" G_DIR_SEPARATOR_S "%s",
227 if ((handle = g_module_open(filename, 0)) == NULL)
229 g_warning("Couldn't load module %s: %s", filename,
233 if (g_module_symbol(handle, "version", (gpointer*)&version) == FALSE)
235 g_warning("The plugin %s has no version symbol", name);
236 g_module_close(handle);
241 * Old-style dissectors don't have a "plugin_reg_handoff()"
242 * routine; we no longer support them.
244 * New-style dissectors have one, because, otherwise, there's
245 * no way for them to arrange that they ever be called.
247 if (g_module_symbol(handle, "plugin_reg_handoff",
248 (gpointer*)®_handoff))
251 * We require it to have a "plugin_init()" routine.
253 if (!g_module_symbol(handle, "plugin_init", (gpointer*)&init))
255 g_warning("The plugin %s has a plugin_reg_handoff symbol but no plugin_init routine",
257 g_module_close(handle);
262 * We have a "plugin_reg_handoff()" routine, so we don't
263 * need the protocol, filter string, or dissector pointer.
265 if ((cr = add_plugin(handle, g_strdup(name), version,
269 fprintf(stderr, "The plugin %s, version %s\n"
270 "was found in multiple directories\n", name, version);
272 fprintf(stderr, "Memory allocation problem\n"
273 "when processing plugin %s, version %s\n",
275 g_module_close(handle);
280 * Call its init routine.
282 #ifdef PLUGINS_NEED_ADDRESS_TABLE
291 * This is an old-style dissector; warn that it won't
292 * be used, as those aren't supported.
295 "The plugin %s, version %s is an old-style plugin;\n"
296 "Those are no longer supported.\n", name, version);
299 #if GLIB_MAJOR_VERSION < 2
306 g_clear_error(dummy);
312 /* get the global plugin dir */
313 /* Return value is malloced so the caller should g_free() it. */
314 const char *get_plugins_global_dir(const char *plugin_dir)
317 char *install_plugin_dir;
323 * On Windows, the data file directory is the installation
324 * directory; the plugins are stored under it.
326 * Assume we're running the installed version of Ethereal;
327 * on Windows, the data file directory is the directory
328 * in which the Ethereal binary resides.
330 install_plugin_dir = g_strdup_printf("%s\\plugins\\%s", get_datafile_dir(), VERSION);
333 * Make sure that pathname refers to a directory.
335 if (test_for_directory(install_plugin_dir) != EISDIR) {
337 * Either it doesn't refer to a directory or it
338 * refers to something that doesn't exist.
340 * Assume that means we're running, for example,
341 * a version of Ethereal we've built in a source
342 * directory, and fall back on the default
343 * installation directory, so you can put the plugins
344 * somewhere so they can be used with this version
347 * XXX - should we, instead, have the Windows build
348 * procedure create a subdirectory of the "plugins"
349 * source directory, and copy the plugin DLLs there,
350 * so that you use the plugins from the build tree?
352 g_free(install_plugin_dir);
354 g_strdup("C:\\Program Files\\Ethereal\\plugins\\" VERSION);
357 return(install_plugin_dir);
360 * Scan the plugin directory.
362 return strdup(plugin_dir);
367 /* get the personal plugin dir */
368 /* Return value is malloced so the caller should g_free() it. */
369 const char *get_plugins_pers_dir(void)
371 return get_persconffile_path(PLUGINS_DIR_NAME, FALSE);
378 init_plugins(const char *plugin_dir)
381 const char *datafile_dir;
384 if (plugin_list == NULL) /* ensure init_plugins is only run once */
387 * Scan the global plugin directory.
389 datafile_dir = get_plugins_global_dir(plugin_dir);
390 plugins_scan_dir(datafile_dir);
391 g_free((char *) datafile_dir);
394 * Scan the users plugin directory.
396 datafile_dir = get_plugins_pers_dir();
397 plugins_scan_dir(datafile_dir);
398 g_free((char *) datafile_dir);
403 register_all_plugin_handoffs(void)
408 * For all new-style plugins, call the register-handoff routine.
409 * This is called from "proto_init()"; it must be called after
410 * "register_all_protocols()" and "init_plugins()" are called,
411 * in case one plugin registers itself either with a built-in
412 * dissector or with another plugin; we must first register all
413 * dissectors, whether built-in or plugin, so their dissector tables
414 * are initialized, and only then register all handoffs.
416 * We treat those protocols as always being enabled; they should
417 * use the standard mechanism for enabling/disabling protocols, not
418 * the plugin-specific mechanism.
420 for (pt_plug = plugin_list; pt_plug != NULL; pt_plug = pt_plug->next)
421 (pt_plug->reg_handoff)();