aboutsummaryrefslogtreecommitdiff
path: root/modules/commands.py
blob: a58d07481686319c568acc31a2f42b470c00d5f0 (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
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
import re
from src import EventManager, Utils

STR_MORE = "%s (more...)" % Utils.FONT_RESET
STR_CONTINUED = "(...continued) "

OUT_CUTOFF = 400

REGEX_CUTOFF = re.compile("^.{1,%d}(?:\s|$)" % OUT_CUTOFF)

class Out(object):
    def __init__(self, module_name, target):
        self.module_name = module_name
        self.target = target
        self._text = ""
        self.written = False
    def write(self, text):
        self._text += text
        self.written = True
        return self
    def send(self):
        if self.has_text():
            text = self._text
            text_encoded = text.encode("utf8")
            if len(text_encoded) > OUT_CUTOFF:
                text = "%s%s" % (text_encoded[:OUT_CUTOFF].decode("utf8"
                    ).rstrip(), STR_MORE)
                self._text = "%s%s" % (STR_CONTINUED, text_encoded[OUT_CUTOFF:
                    ].decode("utf8").lstrip())
            else:
                self._text = ""
            self.target.send_message(text, prefix=Utils.FONT_RESET + "[%s] " %
                                                         self.prefix())
    def set_prefix(self, prefix):
        self.module_name = prefix
    def has_text(self):
        return bool(self._text)

class StdOut(Out):
    def prefix(self):
        return Utils.color(Utils.bold(self.module_name), Utils.COLOR_GREEN)
class StdErr(Out):
    def prefix(self):
        return Utils.color(Utils.bold(self.module_name), Utils.COLOR_RED)

class Module(object):
    def __init__(self, bot, events, exports):
        self.bot = bot
        self.events = events
        events.on("received.message.channel").hook(self.channel_message,
            priority=EventManager.PRIORITY_LOW)
        events.on("received.message.private").hook(self.private_message,
            priority=EventManager.PRIORITY_LOW)

        events.on("received.command.help").hook(self.help,
            help="Show help for commands", usage="<command>")
        events.on("received.command.usage").hook(self.usage, min_args=1,
            help="Show usage help for commands", usage="<command>")
        events.on("received.command.more").hook(self.more, skip_out=True,
            help="Get more output from the last command")
        events.on("received.command.ignore").hook(self.ignore, min_args=1,
            help="Ignore commands from a given user", usage="<nickname>",
            permission="ignore")
        events.on("received.command.unignore").hook(self.unignore, min_args=1,
            help="Unignore commands from a given user", usage="<nickname>",
            permission="unignore")

        events.on("new").on("user", "channel").hook(self.new)
        events.on("send.stdout").hook(self.send_stdout)
        events.on("send.stderr").hook(self.send_stderr)

        exports.add("channelset", {"setting": "command-prefix",
            "help": "Set the command prefix used in this channel"})
        exports.add("serverset", {"setting": "command-prefix",
            "help": "Set the command prefix used on this server"})
        exports.add("serverset", {"setting": "identity-mechanism",
            "help": "Set the identity mechanism for this server"})

    def new(self, event):
        if "user" in event:
            target = event["user"]
        else:
            target = event["channel"]
        target.last_stdout = None
        target.last_stderr = None

    def has_command(self, command):
        return command.lower() in self.events.on("received").on(
            "command").get_children()
    def get_hook(self, command):
        return self.events.on("received.command").on(command
            ).get_hooks()[0]

    def is_highlight(self, server, s):
        if s and s[-1] in [":", ","]:
            s = s[:-1]
        return server.is_own_nickname(s)

    def message(self, event, command, args_index=1):
        if self.has_command(command):
            ignore = event["user"].get_setting("ignore", False)
            if ignore:
                return

            hook = self.get_hook(command)
            is_channel = False

            if "channel" in event:
                target = event["channel"]
                is_channel = True
            else:
                target = event["user"]
            if not is_channel and hook.kwargs.get("channel_only"):
                return
            if is_channel and hook.kwargs.get("private_only"):
                return

            buffer = target.buffer

            module_name = hook.function.__self__._name
            stdout, stderr = StdOut(module_name, target), StdErr(module_name,
                target)

            returns = self.events.on("preprocess.command"
                ).call(hook=hook, user=event["user"], server=event["server"],
                target=target, is_channel=is_channel, tags=event["tags"])
            for returned in returns:
                if returned:
                    stderr.write(returned).send()
                    buffer.skip_next()
                    return
            args_split = event["message_split"][args_index:]
            min_args = hook.kwargs.get("min_args")
            if min_args and len(args_split) < min_args:
                if "usage" in hook.kwargs:
                    stderr.write("Not enough arguments, usage: %s %s" % (
                        command, hook.kwargs["usage"])).send()
                else:
                    stderr.write("Not enough arguments (minimum: %d)" % min_args
                       ).send()
            else:
                args = " ".join(args_split)
                server = event["server"]
                user = event["user"]
                self.events.on("received.command").on(command
                    ).call_limited(1, user=user, server=server,
                    target=target, buffer=buffer, args=args,
                    args_split=args_split, stdout=stdout, stderr=stderr,
                    command=command.lower(), is_channel=is_channel,
                    tags=event["tags"])
                if not hook.kwargs.get("skip_out", False):
                    stdout.send()
                    stderr.send()
                    target.last_stdout = stdout
                    target.last_stderr = stderr
            buffer.skip_next()
        event.eat()

    def channel_message(self, event):
        command_prefix = event["channel"].get_setting("command-prefix",
            event["server"].get_setting("command-prefix", "!"))
        if event["message_split"][0].startswith(command_prefix):
            command = event["message_split"][0].replace(
                command_prefix, "", 1).lower()
            self.message(event, command)
        elif len(event["message_split"]) > 1 and self.is_highlight(
                event["server"], event["message_split"][0]):
            command = event["message_split"][1].lower()
            self.message(event, command, 2)

    def private_message(self, event):
        if event["message_split"]:
            command = event["message_split"][0].lower()
            self.message(event, command)

    def _get_help(self, hook):
        return hook.kwargs.get("help", None) or hook.function.__doc__

    def help(self, event):
        if event["args"]:
            command = event["args_split"][0].lower()
            if command in self.events.on("received").on(
                    "command").get_children():
                hooks = self.events.on("received.command").on(command).get_hooks()
                help = self._get_help(hooks[0])

                if help:
                    event["stdout"].write("%s: %s" % (command, help.strip()))
                else:
                    event["stderr"].write("No help available for %s" % command)
            else:
                event["stderr"].write("Unknown command '%s'" % command)
        else:
            help_available = []
            for child in self.events.on("received.command").get_children():
                hooks = self.events.on("received.command").on(child).get_hooks()

                if hooks and self._get_help(hooks[0]):
                    help_available.append(child)
            help_available = sorted(help_available)
            event["stdout"].write("Commands: %s" % ", ".join(help_available))

    def usage(self, event):
        command_prefix = ""
        if event["is_channel"]:
            command_prefix = event["target"].get_setting("command-prefix",
                event["server"].get_setting("command-prefix", "!"))

        command = event["args_split"][0].lower()
        if command in self.events.on("received").on(
                "command").get_children():
            hooks = self.events.on("received.command").on(command).get_hooks()
            if hooks and "usage" in hooks[0].kwargs:
                event["stdout"].write("Usage: %s%s %s" % (command_prefix,
                    command, hooks[0].kwargs["usage"]))
            else:
                event["stderr"].write("No usage help available for %s" % command)
        else:
            event["stderr"].write("Unknown command '%s'" % command)

    def more(self, event):
        if event["target"].last_stdout and event["target"].last_stdout.has_text():
            event["target"].last_stdout.send()

    def ignore(self, event):
        user = event["server"].get_user(event["args_split"][0])
        if user.get_setting("ignore", False):
            event["stderr"].write("I'm already ignoring '%s'" %
                user.nickname)
        else:
            user.set_setting("ignore", True)
            event["stdout"].write("Now ignoring '%s'" % user.nickname)

    def unignore(self, event):
        user = event["server"].get_user(event["args_split"][0])
        if not user.get_setting("ignore", False):
            event["stderr"].write("I'm not ignoring '%s'" % user.nickname)
        else:
            user.set_setting("ignore", False)
            event["stdout"].write("Removed ignore for '%s'" % user.nickname)

    def send_stdout(self, event):
        stdout = StdOut(event["module_name"], event["target"])
        stdout.write(event["message"]).send()
        if stdout.has_text():
            event["target"].last_stdout = stdout
    def send_stderr(self, event):
        stderr = StdErr(event["module_name"], event["target"])
        stderr.write(event["message"]).send()
        if stderr.has_text():
            event["target"].last_stderr = stderr