aboutsummaryrefslogtreecommitdiff
path: root/src/core_modules/modules.py
blob: d4c40729a3a5e3d122c07f8bc444b9ed03d2c44b (about) (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
#--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))