2 * ircd-ratbox: A slightly useful ircd.
3 * modules.c: A module loader.
5 * Copyright (C) 1990 Jarkko Oikarinen and University of Oulu, Co Center
6 * Copyright (C) 1996-2002 Hybrid Development Team
7 * Copyright (C) 2002-2005 ircd-ratbox development team
9 * This program is free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License as published by
11 * the Free Software Foundation; either version 2 of the License, or
12 * (at your option) any later version.
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU General Public License for more details.
19 * You should have received a copy of the GNU General Public License
20 * along with this program; if not, write to the Free Software
21 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
32 #include "s_newconf.h"
35 #include "ircd_defs.h"
38 #include "capability.h"
43 # error "Charybdis requires loadable module support."
46 struct module **modlist
= NULL
;
48 static const char *core_module_table
[] = {
66 #define MOD_WARN_DELTA (90 * 86400) /* time in seconds, 86400 seconds in a day */
68 #define MODS_INCREMENT 10
70 int max_mods
= MODS_INCREMENT
;
72 static rb_dlink_list mod_paths
;
79 ilog(L_MAIN
, "lt_dlinit failed");
83 /* Add the default paths we look in to the module system --nenolod */
84 mod_add_path(ircd_paths
[IRCD_PATH_MODULES
]);
85 mod_add_path(ircd_paths
[IRCD_PATH_AUTOLOAD_MODULES
]);
92 * side effects - returns a module path from path
95 mod_find_path(const char *path
)
100 RB_DLINK_FOREACH(ptr
, mod_paths
.head
)
104 if(!strcmp(path
, mpath
))
115 * side effects - adds path to list
118 mod_add_path(const char *path
)
122 if(mod_find_path(path
))
125 pathst
= rb_strdup(path
);
126 rb_dlinkAddAlloc(pathst
, &mod_paths
);
133 * side effects - clear the lists of paths
136 mod_clear_paths(void)
138 rb_dlink_node
*ptr
, *next_ptr
;
140 RB_DLINK_FOREACH_SAFE(ptr
, next_ptr
, mod_paths
.head
)
143 rb_free_rb_dlink_node(ptr
);
146 mod_paths
.head
= mod_paths
.tail
= NULL
;
147 mod_paths
.length
= 0;
152 * input - module to load
153 * output - index of module on success, -1 on failure
154 * side effects - none
157 findmodule_byname(const char *name
)
160 char name_ext
[PATH_MAX
+ 1];
162 rb_strlcpy(name_ext
, name
, sizeof name_ext
);
163 rb_strlcat(name_ext
, LT_MODULE_EXT
, sizeof name_ext
);
165 for (i
= 0; i
< num_mods
; i
++)
167 if(!irccmp(modlist
[i
]->name
, name
))
170 if(!irccmp(modlist
[i
]->name
, name_ext
))
177 /* load_all_modules()
184 load_all_modules(bool warn
)
186 DIR *system_module_dir
= NULL
;
187 struct dirent
*ldirent
= NULL
;
188 char module_fq_name
[PATH_MAX
+ 1];
189 size_t module_ext_len
= strlen(LT_MODULE_EXT
);
193 modlist
= (struct module **) rb_malloc(sizeof(struct module *) * (MODS_INCREMENT
));
195 max_mods
= MODS_INCREMENT
;
197 system_module_dir
= opendir(ircd_paths
[IRCD_PATH_AUTOLOAD_MODULES
]);
199 if(system_module_dir
== NULL
)
201 ilog(L_MAIN
, "Could not load modules from %s: %s", ircd_paths
[IRCD_PATH_AUTOLOAD_MODULES
], strerror(errno
));
205 while ((ldirent
= readdir(system_module_dir
)) != NULL
)
207 size_t len
= strlen(ldirent
->d_name
);
209 if(len
> module_ext_len
&&
210 rb_strncasecmp(ldirent
->d_name
+ (len
- module_ext_len
), LT_MODULE_EXT
, module_ext_len
) == 0)
212 (void) snprintf(module_fq_name
, sizeof(module_fq_name
), "%s%c%s",
213 ircd_paths
[IRCD_PATH_AUTOLOAD_MODULES
], RB_PATH_SEPARATOR
, ldirent
->d_name
);
214 (void) load_a_module(module_fq_name
, warn
, MAPI_ORIGIN_CORE
, false);
218 (void) closedir(system_module_dir
);
221 /* load_core_modules()
225 * side effects - core modules are loaded, if any fail, kill ircd
228 load_core_modules(bool warn
)
230 char module_name
[PATH_MAX
];
234 for (i
= 0; core_module_table
[i
]; i
++)
236 snprintf(module_name
, sizeof(module_name
), "%s%c%s", ircd_paths
[IRCD_PATH_MODULES
], RB_PATH_SEPARATOR
,
237 core_module_table
[i
]);
239 if(load_a_module(module_name
, warn
, MAPI_ORIGIN_CORE
, true) == false)
242 "Error loading core module %s: terminating ircd",
243 core_module_table
[i
]);
256 load_one_module(const char *path
, int origin
, bool coremodule
)
258 char modpath
[PATH_MAX
];
259 rb_dlink_node
*pathst
;
261 if (server_state_foreground
)
262 inotice("loading module %s ...", path
);
265 origin
= MAPI_ORIGIN_CORE
;
267 RB_DLINK_FOREACH(pathst
, mod_paths
.head
)
270 const char *mpath
= pathst
->data
;
272 snprintf(modpath
, sizeof(modpath
), "%s%c%s%s", mpath
, RB_PATH_SEPARATOR
, path
, LT_MODULE_EXT
);
273 if((strstr(modpath
, "../") == NULL
) && (strstr(modpath
, "/..") == NULL
))
275 if(stat(modpath
, &statbuf
) == 0 && S_ISREG(statbuf
.st_mode
))
277 /* Regular files only please */
278 return load_a_module(modpath
, true, origin
, coremodule
);
284 sendto_realops_snomask(SNO_GENERAL
, L_ALL
, "Cannot locate module %s", path
);
288 static void increase_modlist(void);
290 static char unknown_ver
[] = "<unknown>";
291 static char unknown_description
[] = "<none>";
293 /* unload_one_module()
295 * inputs - name of module to unload
296 * - true to say modules unloaded, false to not
297 * output - true if successful, false if error
298 * side effects - module is unloaded
301 unload_one_module(const char *name
, bool warn
)
305 if((modindex
= findmodule_byname(name
)) == -1)
309 ** XXX - The type system in C does not allow direct conversion between
310 ** data and function pointers, but as it happens, most C compilers will
311 ** safely do this, however it is a theoretical overlow to cast as we
312 ** must do here. I have library functions to take care of this, but
313 ** despite being more "correct" for the C language, this is more
314 ** practical. Removing the abuse of the ability to cast ANY pointer
315 ** to and from an integer value here will break some compilers.
318 /* Left the comment in but the code isn't here any more -larne */
319 switch (modlist
[modindex
]->mapi_version
)
323 struct mapi_mheader_av1
*mheader
= modlist
[modindex
]->mapi_header
;
324 if(mheader
->mapi_command_list
)
327 for (m
= mheader
->mapi_command_list
; *m
; ++m
)
331 /* hook events are never removed, we simply lose the
332 * ability to call them --fl
334 if(mheader
->mapi_hfn_list
)
336 mapi_hfn_list_av1
*m
;
337 for (m
= mheader
->mapi_hfn_list
; m
->hapi_name
; ++m
)
338 remove_hook(m
->hapi_name
, m
->fn
);
341 if(mheader
->mapi_unregister
)
342 mheader
->mapi_unregister();
347 struct mapi_mheader_av2
*mheader
= modlist
[modindex
]->mapi_header
;
349 /* XXX duplicate code :( */
350 if(mheader
->mapi_command_list
)
353 for (m
= mheader
->mapi_command_list
; *m
; ++m
)
357 /* hook events are never removed, we simply lose the
358 * ability to call them --fl
360 if(mheader
->mapi_hfn_list
)
362 mapi_hfn_list_av1
*m
;
363 for (m
= mheader
->mapi_hfn_list
; m
->hapi_name
; ++m
)
364 remove_hook(m
->hapi_name
, m
->fn
);
367 if(mheader
->mapi_unregister
)
368 mheader
->mapi_unregister();
370 if(mheader
->mapi_cap_list
)
372 mapi_cap_list_av2
*m
;
373 for (m
= mheader
->mapi_cap_list
; m
->cap_name
; ++m
)
375 struct CapabilityIndex
*idx
;
377 switch (m
->cap_index
)
379 case MAPI_CAP_CLIENT
:
382 case MAPI_CAP_SERVER
:
386 sendto_realops_snomask(SNO_GENERAL
, L_ALL
,
387 "Unknown/unsupported CAP index found of type %d on capability %s when unloading %s",
388 m
->cap_index
, m
->cap_name
, modlist
[modindex
]->name
);
390 "Unknown/unsupported CAP index found of type %d on capability %s when unloading %s",
391 m
->cap_index
, m
->cap_name
, modlist
[modindex
]->name
);
395 if (m
->cap_id
!= NULL
)
397 capability_orphan(idx
, m
->cap_name
);
398 sendto_local_clients_with_capability(CLICAP_CAP_NOTIFY
, ":%s CAP * DEL :%s", me
.name
, m
->cap_name
);
405 sendto_realops_snomask(SNO_GENERAL
, L_ALL
,
406 "Unknown/unsupported MAPI version %d when unloading %s!",
407 modlist
[modindex
]->mapi_version
, modlist
[modindex
]->name
);
408 ilog(L_MAIN
, "Unknown/unsupported MAPI version %d when unloading %s!",
409 modlist
[modindex
]->mapi_version
, modlist
[modindex
]->name
);
413 lt_dlclose(modlist
[modindex
]->address
);
415 rb_free(modlist
[modindex
]->name
);
416 rb_free(modlist
[modindex
]);
417 memmove(&modlist
[modindex
], &modlist
[modindex
+ 1],
418 sizeof(struct module *) * ((num_mods
- 1) - modindex
));
425 ilog(L_MAIN
, "Module %s unloaded", name
);
426 sendto_realops_snomask(SNO_GENERAL
, L_ALL
, "Module %s unloaded", name
);
435 * inputs - path name of module, bool to notice, int of origin, bool if core
436 * output - false if error true if success
437 * side effects - loads a module if successful
440 load_a_module(const char *path
, bool warn
, int origin
, bool core
)
443 char *mod_displayname
, *c
;
444 const char *ver
, *description
= NULL
;
445 size_t module_ext_len
= strlen(LT_MODULE_EXT
);
449 mod_displayname
= rb_basename(path
);
451 /* Trim off the ending for the display name if we have to */
452 if((c
= rb_strcasestr(mod_displayname
, LT_MODULE_EXT
)) != NULL
)
455 tmpptr
= lt_dlopenext(path
);
459 const char *err
= lt_dlerror();
461 sendto_realops_snomask(SNO_GENERAL
, L_ALL
,
462 "Error loading module %s: %s", mod_displayname
, err
);
463 ilog(L_MAIN
, "Error loading module %s: %s", mod_displayname
, err
);
464 rb_free(mod_displayname
);
469 * _mheader is actually a struct mapi_mheader_*, but mapi_version
470 * is always the first member of this structure, so we treate it
471 * as a single int in order to determine the API version.
474 mapi_version
= (int *) (uintptr_t) lt_dlsym(tmpptr
, "_mheader");
475 if((mapi_version
== NULL
476 && (mapi_version
= (int *) (uintptr_t) lt_dlsym(tmpptr
, "__mheader")) == NULL
)
477 || MAPI_MAGIC(*mapi_version
) != MAPI_MAGIC_HDR
)
479 sendto_realops_snomask(SNO_GENERAL
, L_ALL
,
480 "Data format error: module %s has no MAPI header.",
482 ilog(L_MAIN
, "Data format error: module %s has no MAPI header.", mod_displayname
);
483 (void) lt_dlclose(tmpptr
);
484 rb_free(mod_displayname
);
488 switch (MAPI_VERSION(*mapi_version
))
492 struct mapi_mheader_av1
*mheader
= (struct mapi_mheader_av1
*)(void *)mapi_version
; /* see above */
493 if(mheader
->mapi_register
&& (mheader
->mapi_register() == -1))
495 ilog(L_MAIN
, "Module %s indicated failure during load.",
497 sendto_realops_snomask(SNO_GENERAL
, L_ALL
,
498 "Module %s indicated failure during load.",
501 rb_free(mod_displayname
);
504 if(mheader
->mapi_command_list
)
507 for (m
= mheader
->mapi_command_list
; *m
; ++m
)
511 if(mheader
->mapi_hook_list
)
514 for (m
= mheader
->mapi_hook_list
; m
->hapi_name
; ++m
)
515 *m
->hapi_id
= register_hook(m
->hapi_name
);
518 if(mheader
->mapi_hfn_list
)
520 mapi_hfn_list_av1
*m
;
521 for (m
= mheader
->mapi_hfn_list
; m
->hapi_name
; ++m
)
522 add_hook(m
->hapi_name
, m
->fn
);
525 ver
= mheader
->mapi_module_version
;
530 struct mapi_mheader_av2
*mheader
= (struct mapi_mheader_av2
*)(void *)mapi_version
; /* see above */
532 /* XXX duplicated code :( */
533 if(mheader
->mapi_register
&& (mheader
->mapi_register() == -1))
535 ilog(L_MAIN
, "Module %s indicated failure during load.",
537 sendto_realops_snomask(SNO_GENERAL
, L_ALL
,
538 "Module %s indicated failure during load.",
541 rb_free(mod_displayname
);
545 /* Basic date code checks
547 * Don't make them fatal, but do complain about differences within a certain time frame.
548 * Later on if there are major API changes we can add fatal checks.
551 if(mheader
->mapi_datecode
!= datecode
&& mheader
->mapi_datecode
> 0)
553 long int delta
= datecode
- mheader
->mapi_datecode
;
554 if (delta
> MOD_WARN_DELTA
)
557 iwarn("Module %s build date is out of sync with ircd build date by %ld days, expect problems",
558 mod_displayname
, delta
);
559 sendto_realops_snomask(SNO_GENERAL
, L_ALL
,
560 "Module %s build date is out of sync with ircd build date by %ld days, expect problems",
561 mod_displayname
, delta
);
565 if(mheader
->mapi_command_list
)
568 for (m
= mheader
->mapi_command_list
; *m
; ++m
)
572 if(mheader
->mapi_hook_list
)
575 for (m
= mheader
->mapi_hook_list
; m
->hapi_name
; ++m
)
576 *m
->hapi_id
= register_hook(m
->hapi_name
);
579 if(mheader
->mapi_hfn_list
)
581 mapi_hfn_list_av1
*m
;
582 for (m
= mheader
->mapi_hfn_list
; m
->hapi_name
; ++m
)
583 add_hook(m
->hapi_name
, m
->fn
);
586 /* New in MAPI v2 - version replacement */
587 ver
= mheader
->mapi_module_version
? mheader
->mapi_module_version
: ircd_version
;
588 description
= mheader
->mapi_module_description
;
590 if(mheader
->mapi_cap_list
)
592 mapi_cap_list_av2
*m
;
593 for (m
= mheader
->mapi_cap_list
; m
->cap_name
; ++m
)
595 struct CapabilityIndex
*idx
;
598 switch (m
->cap_index
)
600 case MAPI_CAP_CLIENT
:
603 case MAPI_CAP_SERVER
:
607 sendto_realops_snomask(SNO_GENERAL
, L_ALL
,
608 "Unknown/unsupported CAP index found of type %d on capability %s when loading %s",
609 m
->cap_index
, m
->cap_name
, mod_displayname
);
611 "Unknown/unsupported CAP index found of type %d on capability %s when loading %s",
612 m
->cap_index
, m
->cap_name
, mod_displayname
);
616 result
= capability_put(idx
, m
->cap_name
, m
->cap_ownerdata
);
617 if (m
->cap_id
!= NULL
)
619 *(m
->cap_id
) = result
;
620 sendto_local_clients_with_capability(CLICAP_CAP_NOTIFY
, ":%s CAP * ADD :%s", me
.name
, m
->cap_name
);
628 ilog(L_MAIN
, "Module %s has unknown/unsupported MAPI version %d.",
629 mod_displayname
, MAPI_VERSION(*mapi_version
));
630 sendto_realops_snomask(SNO_GENERAL
, L_ALL
,
631 "Module %s has unknown/unsupported MAPI version %d.",
632 mod_displayname
, *mapi_version
);
634 rb_free(mod_displayname
);
641 if(description
== NULL
)
642 description
= unknown_description
;
646 modlist
[num_mods
] = rb_malloc(sizeof(struct module));
647 modlist
[num_mods
]->address
= tmpptr
;
648 modlist
[num_mods
]->version
= ver
;
649 modlist
[num_mods
]->description
= description
;
650 modlist
[num_mods
]->core
= core
;
651 modlist
[num_mods
]->name
= rb_strdup(mod_displayname
);
652 modlist
[num_mods
]->mapi_header
= mapi_version
;
653 modlist
[num_mods
]->mapi_version
= MAPI_VERSION(*mapi_version
);
654 modlist
[num_mods
]->origin
= origin
;
663 case MAPI_ORIGIN_EXTENSION
:
666 case MAPI_ORIGIN_CORE
:
674 sendto_realops_snomask(SNO_GENERAL
, L_ALL
,
675 "Module %s [version: %s; MAPI version: %d; origin: %s; description: \"%s\"] loaded at %p",
676 mod_displayname
, ver
, MAPI_VERSION(*mapi_version
), o
, description
,
678 ilog(L_MAIN
, "Module %s [version: %s; MAPI version: %d; origin: %s; description: \"%s\"] loaded at %p",
679 mod_displayname
, ver
, MAPI_VERSION(*mapi_version
), o
, description
, (void *) tmpptr
);
681 rb_free(mod_displayname
);
690 * side effects - expand the size of modlist if necessary
693 increase_modlist(void)
695 struct module **new_modlist
= NULL
;
697 if((num_mods
+ 1) < max_mods
)
700 new_modlist
= (struct module **) rb_malloc(sizeof(struct module *) *
701 (max_mods
+ MODS_INCREMENT
));
702 memcpy((void *) new_modlist
, (void *) modlist
, sizeof(struct module *) * num_mods
);
705 modlist
= new_modlist
;
706 max_mods
+= MODS_INCREMENT
;