Skip to content

Commit

Permalink
module.c: Add require directive for autoloading.
Browse files Browse the repository at this point in the history 
Add a require directive, which will cause BBS
startup to abort if a required module fails
to load.
  • Loading branch information
@InterLinked1
InterLinked1 committed Nov 13, 2023
1 parent 528bc53 commit 1056a4c
Show file tree
Hide file tree
Showing 3 changed files with 59 additions and 18 deletions.
67 changes: 51 additions & 16 deletions bbs/module.c
View file
Original file line number Diff line number Diff line change
Expand Up @@ -78,9 +78,10 @@ static int autoload_setting = DEFAULT_AUTOLOAD_SETTING;

static int really_register = 0;

struct stringlist modules_preload;
struct stringlist modules_load;
struct stringlist modules_noload;
struct stringlist modules_preload; /* Preload */
struct stringlist modules_required; /* Required, normal load (unless preloaded also) */
struct stringlist modules_load; /* Normal load */
struct stringlist modules_noload; /* Don't load */

/*! \brief Number of modules we plan to autoload */
static int autoload_planned = 0;
Expand Down Expand Up @@ -844,6 +845,10 @@ static int on_file_preload(const char *dir_name, const char *filename, void *obj

if (load_resource(filename, 0)) {
bbs_error("Failed to autoload %s\n", filename);
if (stringlist_contains(&modules_required, filename)) {
bbs_error("Aborting startup due to failing to load required module %s\n", filename);
return 1;
}
} else {
autoload_loaded++;
}
Expand All @@ -853,6 +858,7 @@ static int on_file_preload(const char *dir_name, const char *filename, void *obj

static int on_file_autoload(const char *dir_name, const char *filename, void *obj)
{
int required;
struct bbs_module *mod = find_resource(filename);

UNUSED(dir_name);
Expand All @@ -870,22 +876,30 @@ static int on_file_autoload(const char *dir_name, const char *filename, void *ob
bbs_debug(5, "Not loading dynamic module %s, since it's explicitly noloaded\n", filename);
autoload_planned--;
return 0;
} else if (!autoload_setting) {
if (!stringlist_contains(&modules_load, filename)) {
}

required = stringlist_contains(&modules_required, filename);
if (!autoload_setting) {
if (!required && !stringlist_contains(&modules_load, filename)) {
bbs_debug(5, "Not loading dynamic module %s, not explicitly loaded and autoload=no\n", filename);
autoload_planned--;
return 0;
}
bbs_debug(5, "Autoloading dynamic module %s, since explicitly loaded\n", filename);
bbs_debug(5, "Autoloading dynamic module %s, since explicitly %s\n", filename, required ? "required" : "loaded");
} else {
/* If autoload=yes and not in the noload list, then don't even bother checking the load list. Just load it. */
bbs_debug(5, "Autoloading dynamic module %s (autoload=yes)\n", filename);
}

if (load_resource(filename, 0)) {
bbs_error("Failed to autoload %s\n", filename);
if (required) {
bbs_error("Aborting startup due to failing to load required module %s\n", filename);
return 1;
}
} else {
autoload_loaded++;
stringlist_remove(&modules_required, filename);
}

return bbs_abort_startup() ? 1 : 0; /* Always return 0 or otherwise we'd abort the entire autoloading process */
Expand All @@ -907,6 +921,7 @@ static int load_config(void)
RWLIST_WRLOCK(&modules_load);
RWLIST_WRLOCK(&modules_noload);
RWLIST_WRLOCK(&modules_preload);
RWLIST_WRLOCK(&modules_required);
while ((section = bbs_config_walk(cfg, section))) {
if (!strcmp(bbs_config_section_name(section), "general")) {
continue; /* Skip general, already handled */
Expand All @@ -926,6 +941,9 @@ static int load_config(void)
} else if (!strcmp(key, "preload")) {
bbs_debug(7, "Explicitly planning to preload '%s'\n", value);
stringlist_push(&modules_preload, value);
} else if (!strcmp(key, "require")) {
bbs_debug(7, "Explicitly planning to require '%s'\n", value);
stringlist_push(&modules_required, value);
} else {
bbs_warning("Invalid directive %s=%s, ignoring\n", key, value);
}
Expand All @@ -934,12 +952,14 @@ static int load_config(void)
RWLIST_UNLOCK(&modules_load);
RWLIST_UNLOCK(&modules_noload);
RWLIST_UNLOCK(&modules_preload);
RWLIST_UNLOCK(&modules_required);
bbs_config_free(cfg); /* Destroy the config now, rather than waiting until shutdown, since it will NEVER be used again for anything. */
return 0;
}

static int autoload_modules(void)
{
int res = 0;
bbs_debug(1, "Autoloading modules\n");

/* Check config for load settings. */
Expand All @@ -953,8 +973,10 @@ static int autoload_modules(void)
really_register = 1;

/* Now, actually try to load them. */
bbs_dir_traverse(BBS_MODULE_DIR, on_file_preload, NULL, -1);
bbs_dir_traverse(BBS_MODULE_DIR, on_file_autoload, NULL, -1);
if (bbs_dir_traverse(BBS_MODULE_DIR, on_file_preload, NULL, -1) || bbs_dir_traverse(BBS_MODULE_DIR, on_file_autoload, NULL, -1)) {
res = -1;
goto cleanup;
}

if (autoload_planned != autoload_loaded) {
/* Some modules failed to autoload */
Expand All @@ -963,12 +985,27 @@ static int autoload_modules(void)
bbs_debug(1, "Successfully autoloaded %d module%s\n", autoload_planned, ESS(autoload_planned));
}

if (!RWLIST_EMPTY(&modules_required)) {
struct stringitem *i = NULL;
const char *s;
/* We remove a required module from the list when it loads.
* If we didn't already abort, that means we tried to require
* a module that doesn't even exist (hence the traversal didn't encounter it)
* Enumerate which modules and then abort. */
res = -1;
while ((s = stringlist_next(&modules_required, &i))) {
bbs_error("Required module '%s' failed to load\n", s);
}
}

cleanup:
stringlist_empty(&modules_load);
stringlist_empty(&modules_noload);
stringlist_empty(&modules_preload);
stringlist_empty(&modules_required);

RWLIST_UNLOCK(&modules);
return 0;
return res;
}

int bbs_module_load(const char *name)
Expand Down Expand Up @@ -1291,21 +1328,19 @@ int load_modules(void)

/* No modules should be registered on startup. */
RWLIST_WRLOCK(&modules);
RWLIST_TRAVERSE(&modules, mod, entry) {
bbs_assert(0);
}
bbs_assert(RWLIST_EMPTY(&modules));
RWLIST_UNLOCK(&modules);

res = autoload_modules();

RWLIST_WRLOCK(&modules);
RWLIST_TRAVERSE(&modules, mod, entry) {
c++;
}
c = RWLIST_SIZE(&modules, mod, entry);
RWLIST_UNLOCK(&modules);

bbs_assert(c == autoload_loaded);
bbs_cli_register_multiple(cli_commands_modules);
if (!res) {
bbs_cli_register_multiple(cli_commands_modules);
}
return res;
}

Expand Down
4 changes: 3 additions & 1 deletion configs/modules.conf
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,8 @@ autoload=yes ; By default, all modules are loaded automatically on startup.
; before dependent modules load.
; For all operations here, the order of preload, load, and noload does not matter
; (and should not be relied upon).
; require is equivalent to load, but will abort startup if the module fails to load.
; To preload and require a module, specify both directives.
preload = mod_mysql.so ; mod_auth_mysql.so and mod_chanserv.so depend on this module
preload = net_irc.so ; mod_discord.so, mod_chanserv.so, and mod_irc_relay.so depend on this module
preload = mod_irc_client.so ; mod_irc_relay.so depends on this module
Expand All @@ -17,7 +19,7 @@ preload = mod_irc_client.so ; mod_irc_relay.so depends on this module
; Modules can always be explicitly loaded from the sysop console
; using /load <modname>, even if they were not autoloaded.
noload = mod_auth_static.so ; Development module that should not be used for production systems. Conflicts with mod_auth_mysql.so.
load = mod_sysop.so ; You probably don't want to forget this one if autoload=no.
require = mod_sysop.so ; You probably don't want to forget this one if autoload=no. require will force the module to load or abort startup on failure.
load = net_ssh.so ; Always load SSH server
noload = net_finger.so ; This module exposes user information, so don't load by default.
;noload = net_rlogin.so ; Don't load RLogin server
6 changes: 5 additions & 1 deletion nets/net_imap/imap_client_status.c
View file
Original file line number Diff line number Diff line change
Expand Up @@ -202,7 +202,11 @@ static int status_size_fetch_incremental(struct imap_client *client, const char

/* Compare MESSAGES and UIDNEXT from the old and new responses */
if (parse_status_item(old, "UIDVALIDITY", &oldv) || parse_status_item(new, "UIDVALIDITY", &newv)) {
bbs_warning("UIDVALIDITY parsing error\n");
if (strlen_zero(old)) {
bbs_warning("Empty UIDVALIDITY in comparison, cannot rely on cache (%s / %s)\n", old, new);
} else {
bbs_warning("UIDVALIDITY parsing error, cannot rely on cache (%s / %s)\n", old, new);
}
return -1;
}
if (oldv != newv) {
Expand Down

0 comments on commit 1056a4c

Please sign in to comment.