#--depends-on commands
#--depends-on permissions
from src import ModuleManager, utils
ERR_NOTLOADED = "Module '%s' isn't loaded"
class Module(ModuleManager.BaseModule):
def _catch(self, name, func):
try:
return func()
except ModuleManager.ModuleNotFoundException:
raise utils.EventError("Module '%s' not found" % name)
except ModuleManager.ModuleNotLoadedException:
raise utils.EventError(ERR_NOTLOADED % name)
except ModuleManager.ModuleWarning as warning:
raise utils.EventError("Module '%s' not loaded: %s" % (
name, str(warning)))
except Exception as e:
raise utils.EventError("Failed to reload module '%s': %s" % (
name, str(e)))
@utils.hook("received.command.modinfo")
@utils.spec("!<module>word")
def info(self, event):
name = event["spec"][0]
if not name in self.bot.modules.modules:
raise utils.EventError(ERR_NOTLOADED % name)
module = self.bot.modules.modules[name]
event_calls = 0
for event_name, hooks in self.events.all_hooks().items():
for hook in hooks:
if hook.context == module.context:
event_calls += hook.call_count
event_str = "event" if event_calls == 1 else "events"
loaded_at = utils.datetime.format.datetime_human(module.loaded_at)
if module.commit:
loaded_at = "%s (git @%s)" % (loaded_at, module.commit)
event["stdout"].write("%s: '%s' was loaded at %s and has handled %d %s"
% (event["user"].nickname, module.name, loaded_at, event_calls,
event_str))
@utils.hook("received.command.loadmodule")
@utils.kwarg("help", "Load a module")
@utils.kwarg("permission", "loadmodule")
@utils.spec("!<name>wordlower")
def load(self, event):
name = event["spec"][0]
if name in self.bot.modules.modules:
raise utils.EventError("Module '%s' is already loaded" % name)
definition = self._catch(name,
lambda: self.bot.modules.find_module(name))
self._catch(name, lambda: self.bot.modules.load_module(self.bot, definition))
event["stdout"].write("Loaded '%s'" % name)
@utils.hook("received.command.unloadmodule")
@utils.kwarg("help", "Unload a module")
@utils.kwarg("permission", "unloadmodule")
@utils.spec("!<name>wordlower")
def unload(self, event):
name = event["spec"][0]
if not name in self.bot.modules.modules:
raise utils.EventError(ERR_NOTLOADED % name)
self._catch(name, lambda: self.bot.modules.unload_module(name))
event["stdout"].write("Unloaded '%s'" % name)
@utils.hook("received.command.reloadmodule")
@utils.kwarg("help", "Reload a module")
@utils.kwarg("permission", "reloadmodule")
@utils.spec("!<name>wordlower")
def reload(self, event):
name = event["spec"][0]
self._catch(name,
lambda: self.bot.modules.try_reload_module(self.bot, name))
event["stdout"].write("Reloaded '%s'" % name)
@utils.hook("received.command.reloadallmodules")
@utils.kwarg("help", "Reload all modules")
@utils.kwarg("permission", "reloadallmodules")
def reload_all(self, event):
result = self.bot.try_reload_modules()
if result.success:
event["stdout"].write(result.message)
else:
event["stderr"].write(result.message)
def _get_blacklist(self):
config = self.bot.get_config("modules")
return config, config.get_list("blacklist")
def _save_blacklist(self, config, modules):
config.set_list("blacklist", sorted(modules))
config.save()
@utils.hook("received.command.enablemodule")
@utils.kwarg("min_args", 1)
@utils.kwarg("help", "Remove a module from the module blacklist")
@utils.kwarg("usage", "<module>")
@utils.kwarg("permission", "enable-module")
def enable(self, event):
name = event["args_split"][0].lower()
config, blacklist = self._get_blacklist()
if not name in blacklist:
raise utils.EventError("Module '%s' isn't disabled" % name)
blacklist.remove(name)
self._save_blacklist(config, blacklist)
event["stdout"].write("Module '%s' has been enabled and can now "
"be loaded" % name)
@utils.hook("received.command.disablemodule")
@utils.kwarg("min_args", 1)
@utils.kwarg("help", "Add a module to the module blacklist")
@utils.kwarg("usage", "<module>")
@utils.kwarg("permission", "disable-module")
def disable(self, event):
name = event["args_split"][0].lower()
and_unloaded = ""
if name in self.bot.modules.modules:
self.bot.modules.unload_module(name)
and_unloaded = " and unloaded"
config, blacklist = self._get_blacklist()
if name in blacklist:
raise utils.EventError("Module '%s' is already disabled" % name)
blacklist.append(name)
self._save_blacklist(config, blacklist)
event["stdout"].write("Module '%s' has been disabled%s" % (
name, and_unloaded))