f1fd26201b4f70013123310e2d6f5c2bd41c8b62
[metze/wireshark/wip.git] / epan / plugins.c
1 /* plugins.c
2  * plugin routines
3  *
4  * $Id: plugins.c,v 1.50 2002/02/23 02:16:12 guy Exp $
5  *
6  * Ethereal - Network traffic analyzer
7  * By Gerald Combs <gerald@ethereal.com>
8  * Copyright 1999 Gerald Combs
9  * 
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.
14  * 
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.
19  * 
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.
23  */
24
25 #ifdef HAVE_CONFIG_H
26 # include "config.h"
27 #endif
28
29 #include "plugins.h"
30
31 #ifdef HAVE_PLUGINS
32
33 #include <time.h>
34
35 #ifdef HAVE_DIRENT_H
36 #include <dirent.h>
37 #endif
38
39 #ifdef HAVE_DIRECT_H
40 #include <direct.h>
41 #endif
42
43 #include <string.h>
44 #include <stdlib.h>
45 #include <errno.h> 
46
47 #ifdef HAVE_SYS_STAT_H
48 #include <sys/stat.h>
49 #endif
50
51 #ifdef HAVE_SYS_TYPES_H
52 #include <sys/types.h>
53 #endif
54
55 #ifdef HAVE_UNISTD_H
56 #include <unistd.h>
57 #endif
58
59 #include "filesystem.h"
60
61 #include "prefs.h"
62
63 #ifdef PLUGINS_NEED_ADDRESS_TABLE
64 #include "conversation.h"
65 #include "packet-giop.h"
66 #include "packet-tpkt.h"
67 #include "plugins/plugin_table.h"
68 static plugin_address_table_t   patable;
69 #endif
70
71 /* linked list of all plugins */
72 plugin *plugin_list;
73
74 #ifndef WIN32
75 static gchar std_plug_dir[] = "/usr/lib/ethereal/plugins/" VERSION;
76 static gchar local_plug_dir[] = "/usr/local/lib/ethereal/plugins/" VERSION;
77 #endif
78 static gchar *user_plug_dir = NULL;
79
80 #define PLUGINS_DIR_NAME        "plugins"
81
82 /*
83  * add a new plugin to the list
84  * returns :
85  * - 0 : OK
86  * - ENOMEM : memory allocation problem
87  * - EEXIST : the same plugin (i.e. name/version) was already registered.
88  */
89 static int
90 add_plugin(void *handle, gchar *name, gchar *version,
91            void (*reg_handoff)(void))
92 {
93     plugin *new_plug, *pt_plug;
94
95     pt_plug = plugin_list;
96     if (!pt_plug) /* the list is empty */
97     {
98         new_plug = (plugin *)g_malloc(sizeof(plugin));
99         if (new_plug == NULL) return ENOMEM;
100         plugin_list = new_plug;
101     }
102     else
103     {
104         while (1)
105         {
106             /* check if the same name/version is already registered */
107             if (!strcmp(pt_plug->name, name) &&
108                 !strcmp(pt_plug->version, version))
109             {
110                 return EEXIST;
111             }
112
113             /* we found the last plugin in the list */
114             if (pt_plug->next == NULL) break;
115
116             pt_plug = pt_plug->next;
117         }
118         new_plug = (plugin *)g_malloc(sizeof(plugin));
119         if (new_plug == NULL) return ENOMEM;
120         pt_plug->next = new_plug;
121     }
122
123     new_plug->handle = handle;
124     new_plug->name = name;
125     new_plug->version = version;
126     new_plug->reg_handoff = reg_handoff;
127     new_plug->next = NULL;
128     return 0;
129 }
130
131 /*
132  * XXX - when we remove support for old-style plugins (which we should
133  * probably do eventually, as all plugins should be written as new-style
134  * ones), we may want to have "init_plugins()" merely save a pointer
135  * to the plugin's "init" routine, just as we save a pointer to its
136  * "reg_handoff" routine, and have a "register_all_plugins()" routine
137  * to go through the list of plugins and call all of them.
138  *
139  * Then we'd have "epan_init()", or perhaps even something higher up
140  * in the call tree, call "init_plugins()", and have "proto_init()"
141  * call "register_all_plugins()" right after calling "register_all_protocols()";
142  * this might be a bit cleaner.
143  */
144 static void
145 plugins_scan_dir(const char *dirname)
146 {
147 #define FILENAME_LEN    1024
148     gchar         *hack_path;       /* pathname used to construct lt_lib_ext */
149     gchar         *lt_lib_ext;      /* extension for loadable modules */
150     DIR           *dir;             /* scanned directory */
151     struct dirent *file;            /* current file */
152     gchar          filename[FILENAME_LEN];   /* current file name */
153     GModule       *handle;          /* handle returned by dlopen */
154     gchar         *name;
155     gchar         *version;
156     void         (*init)(void *);
157     void         (*reg_handoff)(void);
158     gchar         *dot;
159     int            cr;
160
161     /*
162      * We find the extension used on this platform for loadable modules
163      * by the sneaky hack of calling "g_module_build_path" to build
164      * the pathname for a module with an empty directory name and
165      * empty module name, and then search for the last "." and use
166      * everything from the last "." on.
167      *
168      * GLib 2.0 will probably define G_MODULE_SUFFIX as the extension
169      * to use, but that's not checked into the GLib CVS tree yet,
170      * and we can't use it on systems that don't have GLib 2.0.
171      */
172     hack_path = g_module_build_path("", "");
173     lt_lib_ext = strrchr(hack_path, '.');
174     if (lt_lib_ext == NULL)
175     {
176         /*
177          * Does this mean there *is* no extension?  Assume so.
178          *
179          * XXX - the code below assumes that all loadable modules have
180          * an extension....
181          */
182         lt_lib_ext = "";
183     }
184
185     if ((dir = opendir(dirname)) != NULL)
186     {
187         while ((file = readdir(dir)) != NULL)
188         {
189             /* don't try to open "." and ".." */
190             if (!(strcmp(file->d_name, "..") &&
191                   strcmp(file->d_name, "."))) continue;
192
193             /* skip anything but files with lt_lib_ext */
194             dot = strrchr(file->d_name, '.');
195             if (dot == NULL || strcmp(dot, lt_lib_ext) != 0) continue;
196
197             snprintf(filename, FILENAME_LEN, "%s" G_DIR_SEPARATOR_S "%s",
198                 dirname, file->d_name);
199             if ((handle = g_module_open(filename, 0)) == NULL) continue;
200             name = (gchar *)file->d_name;
201             if (g_module_symbol(handle, "version", (gpointer*)&version) == FALSE)
202             {
203                 g_warning("The plugin %s has no version symbol", name);
204                 g_module_close(handle);
205                 continue;
206             }
207
208             /*
209              * Old-style dissectors don't have a "plugin_reg_handoff()"
210              * routine; we no longer support them.
211              *
212              * New-style dissectors have one, because, otherwise, there's
213              * no way for them to arrange that they ever be called.
214              */
215             if (g_module_symbol(handle, "plugin_reg_handoff",
216                                          (gpointer*)&reg_handoff))
217             {
218                 /*
219                  * We require it to have a "plugin_init()" routine.
220                  */
221                 if (!g_module_symbol(handle, "plugin_init", (gpointer*)&init))
222                 {
223                     g_warning("The plugin %s has a plugin_reg_handoff symbol but no plugin_init routine", name);
224                     g_module_close(handle);
225                     continue;
226                 }
227
228                 /*
229                  * We have a "plugin_reg_handoff()" routine, so we don't
230                  * need the protocol, filter string, or dissector pointer.
231                  */
232                 if ((cr = add_plugin(handle, g_strdup(file->d_name), version,
233                                      reg_handoff)))
234                 {
235                     if (cr == EEXIST)
236                         fprintf(stderr, "The plugin %s, version %s\n"
237                             "was found in multiple directories\n", name, version);
238                     else
239                         fprintf(stderr, "Memory allocation problem\n"
240                             "when processing plugin %s, version %s\n",
241                             name, version);
242                     g_module_close(handle);
243                     continue;
244                 }
245
246                 /*
247                  * Call its init routine.
248                  */
249 #ifdef PLUGINS_NEED_ADDRESS_TABLE
250                 init(&patable);
251 #else
252                 init(NULL);
253 #endif
254             }
255             else
256             {
257                 /*
258                  * This is an old-style dissector; warn that it won't
259                  * be used, as those aren't supported.
260                  */
261                 fprintf(stderr,
262                     "The plugin %s, version %s is an old-style plugin;\n"
263                     "Those are no longer supported.\n", name, version);
264             }
265         }
266         closedir(dir);
267     }
268     g_free(hack_path);
269 }
270
271 /*
272  * init plugins
273  */
274 void
275 init_plugins(const char *plugin_dir)
276 {
277 #ifdef WIN32
278     const char *datafile_dir;
279     char *install_plugin_dir;
280 #else
281     struct stat std_dir_stat, local_dir_stat, plugin_dir_stat;
282 #endif
283
284     if (plugin_list == NULL)      /* ensure init_plugins is only run once */
285     {
286 #ifdef PLUGINS_NEED_ADDRESS_TABLE
287         /* Intialize address table */
288         patable.p_check_col                     = check_col;
289         patable.p_col_clear                     = col_clear;
290         patable.p_col_add_fstr                  = col_add_fstr;
291         patable.p_col_append_fstr               = col_append_fstr;
292         patable.p_col_prepend_fstr              = col_prepend_fstr;
293         patable.p_col_add_str                   = col_add_str;
294         patable.p_col_append_str                = col_append_str;
295         patable.p_col_set_str                   = col_set_str;
296
297         patable.p_register_init_routine         = register_init_routine;
298         patable.p_register_postseq_cleanup_routine      = register_postseq_cleanup_routine;
299
300         patable.p_match_strval                  = match_strval;
301         patable.p_val_to_str                    = val_to_str;
302
303         patable.p_conversation_new              = conversation_new;
304         patable.p_find_conversation             = find_conversation;
305         patable.p_conversation_set_dissector    = conversation_set_dissector;
306
307         patable.p_proto_register_protocol       = proto_register_protocol;
308         patable.p_proto_register_field_array    = proto_register_field_array;
309         patable.p_proto_register_subtree_array  = proto_register_subtree_array;
310
311         patable.p_dissector_add                 = dissector_add;
312         patable.p_dissector_delete              = dissector_delete;
313         patable.p_dissector_add_handle          = dissector_add_handle;
314
315         patable.p_heur_dissector_add            = heur_dissector_add;
316
317         patable.p_register_dissector            = register_dissector;
318         patable.p_find_dissector                = find_dissector;
319         patable.p_create_dissector_handle       = create_dissector_handle;
320         patable.p_call_dissector                = call_dissector;
321
322         patable.p_proto_is_protocol_enabled     = proto_is_protocol_enabled;
323
324         patable.p_proto_item_get_len            = proto_item_get_len;
325         patable.p_proto_item_set_len            = proto_item_set_len;
326         patable.p_proto_item_set_text           = proto_item_set_text;
327         patable.p_proto_item_append_text        = proto_item_append_text;
328         patable.p_proto_item_add_subtree        = proto_item_add_subtree;
329         patable.p_proto_tree_add_item           = proto_tree_add_item;
330         patable.p_proto_tree_add_item_hidden    = proto_tree_add_item_hidden;
331         patable.p_proto_tree_add_protocol_format = proto_tree_add_protocol_format;
332         patable.p_proto_tree_add_bytes          = proto_tree_add_bytes;
333         patable.p_proto_tree_add_bytes_hidden   = proto_tree_add_bytes_hidden;
334         patable.p_proto_tree_add_bytes_format   = proto_tree_add_bytes_format;
335         patable.p_proto_tree_add_time           = proto_tree_add_time;
336         patable.p_proto_tree_add_time_hidden    = proto_tree_add_time_hidden;
337         patable.p_proto_tree_add_time_format    = proto_tree_add_time_format;
338         patable.p_proto_tree_add_ipxnet         = proto_tree_add_ipxnet;
339         patable.p_proto_tree_add_ipxnet_hidden  = proto_tree_add_ipxnet_hidden;
340         patable.p_proto_tree_add_ipxnet_format  = proto_tree_add_ipxnet_format;
341         patable.p_proto_tree_add_ipv4           = proto_tree_add_ipv4;
342         patable.p_proto_tree_add_ipv4_hidden    = proto_tree_add_ipv4_hidden;
343         patable.p_proto_tree_add_ipv4_format    = proto_tree_add_ipv4_format;
344         patable.p_proto_tree_add_ipv6           = proto_tree_add_ipv6;
345         patable.p_proto_tree_add_ipv6_hidden    = proto_tree_add_ipv6_hidden;
346         patable.p_proto_tree_add_ipv6_format    = proto_tree_add_ipv6_format;
347         patable.p_proto_tree_add_ether          = proto_tree_add_ether;
348         patable.p_proto_tree_add_ether_hidden   = proto_tree_add_ether_hidden;
349         patable.p_proto_tree_add_ether_format   = proto_tree_add_ether_format;
350         patable.p_proto_tree_add_string         = proto_tree_add_string;
351         patable.p_proto_tree_add_string_hidden  = proto_tree_add_string_hidden;
352         patable.p_proto_tree_add_string_format  = proto_tree_add_string_format;
353         patable.p_proto_tree_add_boolean        = proto_tree_add_boolean;
354         patable.p_proto_tree_add_boolean_hidden = proto_tree_add_boolean_hidden;
355         patable.p_proto_tree_add_boolean_format = proto_tree_add_boolean_format;
356         patable.p_proto_tree_add_double         = proto_tree_add_double;
357         patable.p_proto_tree_add_double_hidden  = proto_tree_add_double_hidden;
358         patable.p_proto_tree_add_double_format  = proto_tree_add_double_format;
359         patable.p_proto_tree_add_uint           = proto_tree_add_uint;
360         patable.p_proto_tree_add_uint_hidden    = proto_tree_add_uint_hidden;
361         patable.p_proto_tree_add_uint_format    = proto_tree_add_uint_format;
362         patable.p_proto_tree_add_int            = proto_tree_add_int;
363         patable.p_proto_tree_add_int_hidden     = proto_tree_add_int_hidden;
364         patable.p_proto_tree_add_int_format     = proto_tree_add_int_format;
365         patable.p_proto_tree_add_text           = proto_tree_add_text;
366
367         patable.p_tvb_new_subset                = tvb_new_subset;
368         patable.p_tvb_set_free_cb               = tvb_set_free_cb;
369         patable.p_tvb_set_child_real_data_tvbuff = tvb_set_child_real_data_tvbuff;
370         patable.p_tvb_new_real_data             = tvb_new_real_data;
371
372         patable.p_tvb_length                    = tvb_length;
373         patable.p_tvb_length_remaining          = tvb_length_remaining;
374         patable.p_tvb_bytes_exist               = tvb_bytes_exist;
375         patable.p_tvb_offset_exists             = tvb_offset_exists;
376         patable.p_tvb_reported_length           = tvb_reported_length;
377         patable.p_tvb_reported_length_remaining = tvb_reported_length_remaining;
378
379         patable.p_tvb_get_guint8                = tvb_get_guint8;
380
381         patable.p_tvb_get_ntohs                 = tvb_get_ntohs;
382         patable.p_tvb_get_ntoh24                = tvb_get_ntoh24;
383         patable.p_tvb_get_ntohl                 = tvb_get_ntohl;
384
385         patable.p_tvb_get_letohs                = tvb_get_letohs;
386         patable.p_tvb_get_letoh24               = tvb_get_letoh24;
387         patable.p_tvb_get_letohl                = tvb_get_letohl;
388
389         patable.p_tvb_memcpy                    = tvb_memcpy;
390         patable.p_tvb_memdup                    = tvb_memdup;
391
392         patable.p_tvb_get_ptr                   = tvb_get_ptr;
393
394         patable.p_tvb_find_guint8               = tvb_find_guint8;
395         patable.p_tvb_pbrk_guint8               = tvb_pbrk_guint8;
396
397         patable.p_tvb_strnlen                   = tvb_strnlen;
398
399         patable.p_tvb_format_text               = tvb_format_text;
400
401         patable.p_tvb_get_nstringz              = tvb_get_nstringz;
402         patable.p_tvb_get_nstringz0             = tvb_get_nstringz0;
403
404         patable.p_tvb_find_line_end             = tvb_find_line_end;
405         patable.p_tvb_find_line_end_unquoted    = tvb_find_line_end_unquoted;
406
407         patable.p_tvb_strneql                   = tvb_strneql;
408         patable.p_tvb_strncaseeql               = tvb_strncaseeql;
409
410         patable.p_tvb_bytes_to_str              = tvb_bytes_to_str;
411
412         patable.p_prefs_register_protocol       = prefs_register_protocol;
413         patable.p_prefs_register_uint_preference = prefs_register_uint_preference;
414         patable.p_prefs_register_bool_preference = prefs_register_bool_preference;
415         patable.p_prefs_register_enum_preference = prefs_register_enum_preference;
416         patable.p_prefs_register_string_preference = prefs_register_string_preference;
417
418         patable.p_register_giop_user            = register_giop_user;
419         patable.p_is_big_endian                 = is_big_endian;
420         patable.p_get_CDR_encap_info            = get_CDR_encap_info;
421
422         patable.p_get_CDR_any                   = get_CDR_any;
423         patable.p_get_CDR_boolean               = get_CDR_boolean;
424         patable.p_get_CDR_char                  = get_CDR_char;
425         patable.p_get_CDR_double                = get_CDR_double;
426         patable.p_get_CDR_enum                  = get_CDR_enum;
427         patable.p_get_CDR_fixed                 = get_CDR_fixed;
428         patable.p_get_CDR_float                 = get_CDR_float;
429         patable.p_get_CDR_interface             = get_CDR_interface;
430         patable.p_get_CDR_long                  = get_CDR_long;
431         patable.p_get_CDR_object                = get_CDR_object;
432         patable.p_get_CDR_octet                 = get_CDR_octet;
433         patable.p_get_CDR_octet_seq             = get_CDR_octet_seq;
434         patable.p_get_CDR_short                 = get_CDR_short;
435         patable.p_get_CDR_string                = get_CDR_string;
436         patable.p_get_CDR_typeCode              = get_CDR_typeCode;
437         patable.p_get_CDR_ulong                 = get_CDR_ulong;
438         patable.p_get_CDR_ushort                = get_CDR_ushort;
439         patable.p_get_CDR_wchar                 = get_CDR_wchar;
440         patable.p_get_CDR_wstring               = get_CDR_wstring;
441
442         patable.p_is_tpkt                       = is_tpkt;
443         patable.p_dissect_tpkt_encap            = dissect_tpkt_encap;
444 #endif
445
446 #ifdef WIN32
447         /*
448          * On Windows, the data file directory is the installation
449          * directory; the plugins are stored under it.
450          *
451          * Assume we're running the installed version of Ethereal;
452          * on Windows, the data file directory is the directory
453          * in which the Ethereal binary resides.
454          */
455         datafile_dir = get_datafile_dir();
456         install_plugin_dir = g_malloc(strlen(datafile_dir) + strlen("plugins") +
457             strlen(VERSION) + 3);
458         sprintf(install_plugin_dir, "%s\\plugins\\%s", datafile_dir, VERSION);
459
460         /*
461          * Make sure that pathname refers to a directory.
462          */
463         if (test_for_directory(install_plugin_dir) != EISDIR) {
464                 /*
465                  * Either it doesn't refer to a directory or it
466                  * refers to something that doesn't exist.
467                  *
468                  * Assume that means we're running, for example,
469                  * a version of Ethereal we've built in a source
470                  * directory, and fall back on the default
471                  * installation directory, so you can put the plugins
472                  * somewhere so they can be used with this version
473                  * of Ethereal.
474                  *
475                  * XXX - should we, instead, have the Windows build
476                  * procedure create a subdirectory of the "plugins"
477                  * source directory, and copy the plugin DLLs there,
478                  * so that you use the plugins from the build tree?
479                  */
480                 install_plugin_dir =
481                     g_strdup("C:\\Program Files\\Ethereal\\plugins\\" VERSION);
482         }
483
484         /*
485          * Scan that directory.
486          */
487         plugins_scan_dir(install_plugin_dir);
488         g_free(install_plugin_dir);
489 #else
490         /*
491          * XXX - why not just scan "plugin_dir"?  That's where we
492          * installed the plugins; if Ethereal isn't installed under
493          * "/usr" or "/usr/local", why should we search for its plugins
494          * there?
495          */
496         plugins_scan_dir(std_plug_dir);
497         plugins_scan_dir(local_plug_dir);
498         if ((strcmp(std_plug_dir, plugin_dir) != 0) &&
499                 (strcmp(local_plug_dir, plugin_dir) != 0))
500         {
501             if (stat(plugin_dir, &plugin_dir_stat) == 0)
502             {
503                 /* check if plugin_dir is really different from std_dir and
504                  * local_dir if they exist ! */
505                 if (stat(std_plug_dir, &std_dir_stat) == 0)
506                 {
507                     if (stat(local_plug_dir, &local_dir_stat) == 0)
508                     {
509                         if ((plugin_dir_stat.st_dev != std_dir_stat.st_dev ||
510                                     plugin_dir_stat.st_ino != std_dir_stat.st_ino) &&
511                                 (plugin_dir_stat.st_dev != local_dir_stat.st_dev ||
512                                  plugin_dir_stat.st_ino != local_dir_stat.st_ino))
513                             plugins_scan_dir(plugin_dir);
514                     }
515                     else
516                     {
517                         if ((plugin_dir_stat.st_dev != std_dir_stat.st_dev ||
518                                     plugin_dir_stat.st_ino != std_dir_stat.st_ino))
519                             plugins_scan_dir(plugin_dir);
520                     }
521                 }
522                 else if (stat(local_plug_dir, &local_dir_stat) == 0)
523                 {
524                     if ((plugin_dir_stat.st_dev != local_dir_stat.st_dev ||
525                                 plugin_dir_stat.st_ino != local_dir_stat.st_ino))
526                         plugins_scan_dir(plugin_dir);
527                 }
528                 else plugins_scan_dir(plugin_dir);
529             }
530         }
531 #endif
532         if (!user_plug_dir)
533             user_plug_dir = get_persconffile_path(PLUGINS_DIR_NAME, FALSE);
534         plugins_scan_dir(user_plug_dir);
535     }
536 }
537
538 void
539 register_all_plugin_handoffs(void)
540 {
541   plugin *pt_plug;
542
543   /*
544    * For all new-style plugins, call the register-handoff routine.
545    * This is called from "proto_init()"; it must be called after
546    * "register_all_protocols()" and "init_plugins()" are called,
547    * in case one plugin registers itself either with a built-in
548    * dissector or with another plugin; we must first register all
549    * dissectors, whether built-in or plugin, so their dissector tables
550    * are initialized, and only then register all handoffs.
551    *
552    * We treat those protocols as always being enabled; they should
553    * use the standard mechanism for enabling/disabling protocols, not
554    * the plugin-specific mechanism.
555    */
556   for (pt_plug = plugin_list; pt_plug != NULL; pt_plug = pt_plug->next)
557     (pt_plug->reg_handoff)();
558 }
559 #endif