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"
44 # error "Solanum requires loadable module support."
47 rb_dlink_list module_list
;
48 rb_dlink_list mod_paths
;
50 static const char *core_module_table
[] = {
69 #define MOD_WARN_DELTA (90 * 86400) /* time in seconds, 86400 seconds in a day */
76 ilog(L_MAIN
, "lt_dlinit failed");
80 /* Add the default paths we look in to the module system --nenolod */
81 mod_add_path(ircd_paths
[IRCD_PATH_MODULES
]);
82 mod_add_path(ircd_paths
[IRCD_PATH_AUTOLOAD_MODULES
]);
85 static unsigned int prev_caps
;
88 mod_remember_clicaps(void)
90 prev_caps
= capability_index_mask(cli_capindex
);
94 mod_notify_clicaps(void)
96 unsigned int cur_caps
= capability_index_mask(cli_capindex
);
97 unsigned int del
= prev_caps
& ~cur_caps
;
98 unsigned int new = cur_caps
& ~prev_caps
;
101 sendto_local_clients_with_capability(CLICAP_CAP_NOTIFY
, ":%s CAP * DEL :%s",
102 me
.name
, capability_index_list(cli_capindex
, del
));
104 sendto_local_clients_with_capability(CLICAP_CAP_NOTIFY
, ":%s CAP * NEW :%s",
105 me
.name
, capability_index_list(cli_capindex
, new));
112 * side effects - returns a module path from path
115 mod_find_path(const char *path
)
120 RB_DLINK_FOREACH(ptr
, mod_paths
.head
)
124 if(!strcmp(path
, mpath
))
135 * side effects - adds path to list
138 mod_add_path(const char *path
)
142 if(mod_find_path(path
))
145 pathst
= rb_strdup(path
);
146 rb_dlinkAddAlloc(pathst
, &mod_paths
);
153 * side effects - clear the lists of paths
156 mod_clear_paths(void)
158 rb_dlink_node
*ptr
, *next_ptr
;
160 RB_DLINK_FOREACH_SAFE(ptr
, next_ptr
, mod_paths
.head
)
163 rb_free_rb_dlink_node(ptr
);
166 mod_paths
.head
= mod_paths
.tail
= NULL
;
167 mod_paths
.length
= 0;
172 * input - module to load
173 * output - index of module on success, -1 on failure
174 * side effects - none
177 findmodule_byname(const char *name
)
180 char name_ext
[PATH_MAX
+ 1];
182 rb_strlcpy(name_ext
, name
, sizeof name_ext
);
183 rb_strlcat(name_ext
, LT_MODULE_EXT
, sizeof name_ext
);
185 RB_DLINK_FOREACH(ptr
, module_list
.head
)
187 struct module *mod
= ptr
->data
;
189 if(!irccmp(mod
->name
, name
))
192 if(!irccmp(mod
->name
, name_ext
))
199 /* load_all_modules()
206 load_all_modules(bool warn
)
208 DIR *system_module_dir
= NULL
;
209 struct dirent
*ldirent
= NULL
;
210 char module_fq_name
[PATH_MAX
+ 1];
211 size_t module_ext_len
= strlen(LT_MODULE_EXT
);
213 system_module_dir
= opendir(ircd_paths
[IRCD_PATH_AUTOLOAD_MODULES
]);
215 if(system_module_dir
== NULL
)
217 ilog(L_MAIN
, "Could not load modules from %s: %s", ircd_paths
[IRCD_PATH_AUTOLOAD_MODULES
], strerror(errno
));
221 while ((ldirent
= readdir(system_module_dir
)) != NULL
)
223 size_t len
= strlen(ldirent
->d_name
);
225 if(len
> module_ext_len
&&
226 rb_strncasecmp(ldirent
->d_name
+ (len
- module_ext_len
), LT_MODULE_EXT
, module_ext_len
) == 0)
228 (void) snprintf(module_fq_name
, sizeof(module_fq_name
), "%s/%s",
229 ircd_paths
[IRCD_PATH_AUTOLOAD_MODULES
], ldirent
->d_name
);
230 (void) load_a_module(module_fq_name
, warn
, MAPI_ORIGIN_CORE
, false);
234 (void) closedir(system_module_dir
);
237 /* load_core_modules()
241 * side effects - core modules are loaded, if any fail, kill ircd
244 load_core_modules(bool warn
)
246 char module_name
[PATH_MAX
];
250 for (i
= 0; core_module_table
[i
]; i
++)
252 snprintf(module_name
, sizeof(module_name
), "%s/%s", ircd_paths
[IRCD_PATH_MODULES
], core_module_table
[i
]);
254 if(load_a_module(module_name
, warn
, MAPI_ORIGIN_CORE
, true) == false)
257 "Error loading core module %s: terminating ircd",
258 core_module_table
[i
]);
271 load_one_module(const char *path
, int origin
, bool coremodule
)
273 char modpath
[PATH_MAX
];
274 rb_dlink_node
*pathst
;
276 if (server_state_foreground
)
277 inotice("loading module %s ...", path
);
280 origin
= MAPI_ORIGIN_CORE
;
282 RB_DLINK_FOREACH(pathst
, mod_paths
.head
)
285 const char *mpath
= pathst
->data
;
287 snprintf(modpath
, sizeof(modpath
), "%s/%s%s", mpath
, path
, LT_MODULE_EXT
);
288 if((strstr(modpath
, "../") == NULL
) && (strstr(modpath
, "/..") == NULL
))
290 if(stat(modpath
, &statbuf
) == 0 && S_ISREG(statbuf
.st_mode
))
292 /* Regular files only please */
293 return load_a_module(modpath
, true, origin
, coremodule
);
299 sendto_realops_snomask(SNO_GENERAL
, L_NETWIDE
, "Cannot locate module %s", path
);
301 if (server_state_foreground
)
302 ierror("cannot locate module %s", path
);
307 static char unknown_ver
[] = "<unknown>";
308 static char unknown_description
[] = "<none>";
310 /* unload_one_module()
312 * inputs - name of module to unload
313 * - true to say modules unloaded, false to not
314 * output - true if successful, false if error
315 * side effects - module is unloaded
318 unload_one_module(const char *name
, bool warn
)
322 if((mod
= findmodule_byname(name
)) == NULL
)
326 ** XXX - The type system in C does not allow direct conversion between
327 ** data and function pointers, but as it happens, most C compilers will
328 ** safely do this, however it is a theoretical overlow to cast as we
329 ** must do here. I have library functions to take care of this, but
330 ** despite being more "correct" for the C language, this is more
331 ** practical. Removing the abuse of the ability to cast ANY pointer
332 ** to and from an integer value here will break some compilers.
335 /* Left the comment in but the code isn't here any more -larne */
336 switch (mod
->mapi_version
)
340 struct mapi_mheader_av1
*mheader
= mod
->mapi_header
;
341 if(mheader
->mapi_command_list
)
344 for (m
= mheader
->mapi_command_list
; *m
; ++m
)
348 /* hook events are never removed, we simply lose the
349 * ability to call them --fl
351 if(mheader
->mapi_hfn_list
)
353 mapi_hfn_list_av1
*m
;
354 for (m
= mheader
->mapi_hfn_list
; m
->hapi_name
; ++m
)
355 remove_hook(m
->hapi_name
, m
->fn
);
358 if(mheader
->mapi_unregister
)
359 mheader
->mapi_unregister();
364 struct mapi_mheader_av2
*mheader
= mod
->mapi_header
;
366 /* XXX duplicate code :( */
367 if(mheader
->mapi_command_list
)
370 for (m
= mheader
->mapi_command_list
; *m
; ++m
)
374 /* hook events are never removed, we simply lose the
375 * ability to call them --fl
377 if(mheader
->mapi_hfn_list
)
379 mapi_hfn_list_av1
*m
;
380 for (m
= mheader
->mapi_hfn_list
; m
->hapi_name
; ++m
)
381 remove_hook(m
->hapi_name
, m
->fn
);
384 if(mheader
->mapi_unregister
)
385 mheader
->mapi_unregister();
387 if(mheader
->mapi_cap_list
)
389 mapi_cap_list_av2
*m
;
390 for (m
= mheader
->mapi_cap_list
; m
->cap_name
; ++m
)
392 struct CapabilityIndex
*idx
;
394 switch (m
->cap_index
)
396 case MAPI_CAP_CLIENT
:
399 case MAPI_CAP_SERVER
:
403 sendto_realops_snomask(SNO_GENERAL
, L_NETWIDE
,
404 "Unknown/unsupported CAP index found of type %d on capability %s when unloading %s",
405 m
->cap_index
, m
->cap_name
, mod
->name
);
407 "Unknown/unsupported CAP index found of type %d on capability %s when unloading %s",
408 m
->cap_index
, m
->cap_name
, mod
->name
);
412 capability_orphan(idx
, m
->cap_name
);
418 sendto_realops_snomask(SNO_GENERAL
, L_NETWIDE
,
419 "Unknown/unsupported MAPI version %d when unloading %s!",
420 mod
->mapi_version
, mod
->name
);
421 ilog(L_MAIN
, "Unknown/unsupported MAPI version %d when unloading %s!",
422 mod
->mapi_version
, mod
->name
);
426 lt_dlclose(mod
->address
);
428 rb_dlinkDelete(&mod
->node
, &module_list
);
435 ilog(L_MAIN
, "Module %s unloaded", name
);
436 sendto_realops_snomask(SNO_GENERAL
, L_NETWIDE
, "Module %s unloaded", name
);
445 * inputs - path name of module, bool to notice, int of origin, bool if core
446 * output - false if error true if success
447 * side effects - loads a module if successful
450 load_a_module(const char *path
, bool warn
, int origin
, bool core
)
454 char *mod_displayname
, *c
;
455 const char *ver
, *description
= NULL
;
459 mod_displayname
= rb_basename(path
);
461 /* Trim off the ending for the display name if we have to */
462 if((c
= rb_strcasestr(mod_displayname
, LT_MODULE_EXT
)) != NULL
)
465 tmpptr
= lt_dlopenext(path
);
469 const char *err
= lt_dlerror();
471 sendto_realops_snomask(SNO_GENERAL
, L_NETWIDE
,
472 "Error loading module %s: %s", mod_displayname
, err
);
473 ilog(L_MAIN
, "Error loading module %s: %s", mod_displayname
, err
);
474 rb_free(mod_displayname
);
479 * _mheader is actually a struct mapi_mheader_*, but mapi_version
480 * is always the first member of this structure, so we treate it
481 * as a single int in order to determine the API version.
484 mapi_version
= (int *) (uintptr_t) lt_dlsym(tmpptr
, "_mheader");
485 if((mapi_version
== NULL
486 && (mapi_version
= (int *) (uintptr_t) lt_dlsym(tmpptr
, "__mheader")) == NULL
)
487 || MAPI_MAGIC(*mapi_version
) != MAPI_MAGIC_HDR
)
489 sendto_realops_snomask(SNO_GENERAL
, L_NETWIDE
,
490 "Data format error: module %s has no MAPI header.",
492 ilog(L_MAIN
, "Data format error: module %s has no MAPI header.", mod_displayname
);
493 (void) lt_dlclose(tmpptr
);
494 rb_free(mod_displayname
);
498 switch (MAPI_VERSION(*mapi_version
))
502 struct mapi_mheader_av1
*mheader
= (struct mapi_mheader_av1
*)(void *)mapi_version
; /* see above */
503 if(mheader
->mapi_register
&& (mheader
->mapi_register() == -1))
505 ilog(L_MAIN
, "Module %s indicated failure during load.",
507 sendto_realops_snomask(SNO_GENERAL
, L_NETWIDE
,
508 "Module %s indicated failure during load.",
511 rb_free(mod_displayname
);
514 if(mheader
->mapi_command_list
)
517 for (m
= mheader
->mapi_command_list
; *m
; ++m
)
521 if(mheader
->mapi_hook_list
)
524 for (m
= mheader
->mapi_hook_list
; m
->hapi_name
; ++m
)
525 *m
->hapi_id
= register_hook(m
->hapi_name
);
528 if(mheader
->mapi_hfn_list
)
530 mapi_hfn_list_av1
*m
;
531 for (m
= mheader
->mapi_hfn_list
; m
->hapi_name
; ++m
)
532 add_hook(m
->hapi_name
, m
->fn
);
535 ver
= mheader
->mapi_module_version
;
540 struct mapi_mheader_av2
*mheader
= (struct mapi_mheader_av2
*)(void *)mapi_version
; /* see above */
542 if(mheader
->mapi_cap_list
)
544 mapi_cap_list_av2
*m
;
545 for (m
= mheader
->mapi_cap_list
; m
->cap_name
; ++m
)
547 struct CapabilityIndex
*idx
;
550 switch (m
->cap_index
)
552 case MAPI_CAP_CLIENT
:
555 case MAPI_CAP_SERVER
:
559 sendto_realops_snomask(SNO_GENERAL
, L_NETWIDE
,
560 "Unknown/unsupported CAP index found of type %d on capability %s when loading %s",
561 m
->cap_index
, m
->cap_name
, mod_displayname
);
563 "Unknown/unsupported CAP index found of type %d on capability %s when loading %s",
564 m
->cap_index
, m
->cap_name
, mod_displayname
);
568 result
= capability_put(idx
, m
->cap_name
, m
->cap_ownerdata
);
569 if (m
->cap_id
!= NULL
)
570 *(m
->cap_id
) = result
;
574 /* XXX duplicated code :( */
575 if(mheader
->mapi_register
&& (mheader
->mapi_register() == -1))
577 ilog(L_MAIN
, "Module %s indicated failure during load.",
579 sendto_realops_snomask(SNO_GENERAL
, L_NETWIDE
,
580 "Module %s indicated failure during load.",
582 if(mheader
->mapi_cap_list
)
584 mapi_cap_list_av2
*m
;
585 for (m
= mheader
->mapi_cap_list
; m
->cap_name
; ++m
)
587 struct CapabilityIndex
*idx
;
588 switch (m
->cap_index
)
590 case MAPI_CAP_CLIENT
:
593 case MAPI_CAP_SERVER
:
599 capability_orphan(idx
, m
->cap_name
);
603 rb_free(mod_displayname
);
607 /* Basic date code checks
609 * Don't make them fatal, but do complain about differences within a certain time frame.
610 * Later on if there are major API changes we can add fatal checks.
613 if(mheader
->mapi_datecode
!= datecode
&& mheader
->mapi_datecode
> 0)
615 long int delta
= datecode
- mheader
->mapi_datecode
;
616 if (delta
> MOD_WARN_DELTA
)
619 iwarn("Module %s build date is out of sync with ircd build date by %ld days, expect problems",
620 mod_displayname
, delta
);
621 sendto_realops_snomask(SNO_GENERAL
, L_NETWIDE
,
622 "Module %s build date is out of sync with ircd build date by %ld days, expect problems",
623 mod_displayname
, delta
);
627 if(mheader
->mapi_command_list
)
630 for (m
= mheader
->mapi_command_list
; *m
; ++m
)
634 if(mheader
->mapi_hook_list
)
637 for (m
= mheader
->mapi_hook_list
; m
->hapi_name
; ++m
)
638 *m
->hapi_id
= register_hook(m
->hapi_name
);
641 if(mheader
->mapi_hfn_list
)
643 mapi_hfn_list_av1
*m
;
644 for (m
= mheader
->mapi_hfn_list
; m
->hapi_name
; ++m
)
646 int priority
= m
->priority
;
648 priority
= HOOK_NORMAL
;
649 add_hook_prio(m
->hapi_name
, m
->fn
, priority
);
653 /* New in MAPI v2 - version replacement */
654 ver
= mheader
->mapi_module_version
? mheader
->mapi_module_version
: ircd_version
;
655 description
= mheader
->mapi_module_description
;
660 ilog(L_MAIN
, "Module %s has unknown/unsupported MAPI version %d.",
661 mod_displayname
, MAPI_VERSION(*mapi_version
));
662 sendto_realops_snomask(SNO_GENERAL
, L_NETWIDE
,
663 "Module %s has unknown/unsupported MAPI version %d.",
664 mod_displayname
, *mapi_version
);
666 rb_free(mod_displayname
);
673 if(description
== NULL
)
674 description
= unknown_description
;
676 mod
= rb_malloc(sizeof(struct module));
677 mod
->address
= tmpptr
;
679 mod
->description
= description
;
681 mod
->name
= rb_strdup(mod_displayname
);
682 mod
->mapi_header
= mapi_version
;
683 mod
->mapi_version
= MAPI_VERSION(*mapi_version
);
684 mod
->origin
= origin
;
685 mod
->path
= rb_strdup(path
);
686 rb_dlinkAdd(mod
, &mod
->node
, &module_list
);
694 case MAPI_ORIGIN_EXTENSION
:
697 case MAPI_ORIGIN_CORE
:
705 sendto_realops_snomask(SNO_GENERAL
, L_NETWIDE
,
706 "Module %s [version: %s; MAPI version: %d; origin: %s; description: \"%s\"] loaded at %p",
707 mod_displayname
, ver
, MAPI_VERSION(*mapi_version
), o
, description
,
709 ilog(L_MAIN
, "Module %s [version: %s; MAPI version: %d; origin: %s; description: \"%s\"] loaded at %p",
710 mod_displayname
, ver
, MAPI_VERSION(*mapi_version
), o
, description
, (void *) tmpptr
);
712 rb_free(mod_displayname
);
717 modules_do_reload(void *info_
)
719 struct modreload
*info
= info_
;
723 char *m_bn
= rb_basename(info
->module);
725 struct Client
*source_p
= find_id(info
->id
);
727 if((mod
= findmodule_byname(m_bn
)) == NULL
)
729 if (source_p
) sendto_one_notice(source_p
, ":Module %s is not loaded", m_bn
);
735 origin
= mod
->origin
;
736 check_core
= mod
->core
;
737 path
= rb_strdup(mod
->path
);
739 mod_remember_clicaps();
741 if(unload_one_module(m_bn
, true) == false)
743 if (source_p
) sendto_one_notice(source_p
, ":Module %s is not loaded", m_bn
);
750 if((load_a_module(path
, true, origin
, check_core
) == false) && check_core
)
752 sendto_realops_snomask(SNO_GENERAL
, L_NETWIDE
,
753 "Error reloading core module: %s: terminating ircd", m_bn
);
754 ilog(L_MAIN
, "Error loading core module %s: terminating ircd", m_bn
);
758 mod_notify_clicaps();
766 modules_do_restart(void *unused
)
768 unsigned int modnum
= 0;
769 rb_dlink_node
*ptr
, *nptr
;
771 mod_remember_clicaps();
773 RB_DLINK_FOREACH_SAFE(ptr
, nptr
, module_list
.head
)
775 struct module *mod
= ptr
->data
;
776 if(!unload_one_module(mod
->name
, false))
778 ilog(L_MAIN
, "Module Restart: %s was not unloaded %s",
780 mod
->core
? "(core module)" : "");
783 sendto_realops_snomask(SNO_GENERAL
, L_NETWIDE
,
784 "Module Restart: %s failed to unload",
792 load_all_modules(false);
793 load_core_modules(false);
796 mod_notify_clicaps();
798 sendto_realops_snomask(SNO_GENERAL
, L_NETWIDE
,
799 "Module Restart: %u modules unloaded, %lu modules loaded",
800 modnum
, rb_dlink_list_length(&module_list
));
801 ilog(L_MAIN
, "Module Restart: %u modules unloaded, %lu modules loaded", modnum
, rb_dlink_list_length(&module_list
));