]>
Commit | Line | Data |
---|---|---|
931c88a4 | 1 | # Erebus IRC bot - Author: John Runyon |
4477123d | 2 | # vim: fileencoding=utf-8 |
931c88a4 | 3 | # module helper functions, see modules/modtest.py for usage |
4 | # This file is released into the public domain; see http://unlicense.org/ | |
5 | ||
a28e2ae9 | 6 | import sys |
9d44d267 | 7 | import socket |
4f8abd95 | 8 | from functools import wraps |
a28e2ae9 | 9 | |
10 | if sys.version_info.major < 3: | |
11 | stringbase = basestring | |
12 | else: | |
13 | stringbase = str | |
14 | ||
43151ead | 15 | """Used to return an error to the bot core.""" |
e4255e70 | 16 | class error(object): |
17 | def __init__(self, desc): | |
18 | self.errormsg = desc | |
19 | def __nonzero__(self): | |
20 | return False #object will test to False | |
71ef8273 | 21 | __bool__ = __nonzero__ #py3 compat |
e4255e70 | 22 | def __repr__(self): |
23 | return '<modlib.error %r>' % self.errormsg | |
24 | def __str__(self): | |
e3878612 | 25 | return str(self.errormsg) |
e4255e70 | 26 | |
6c70d82c | 27 | class modlib(object): |
839d2b35 | 28 | # default (global) access levels |
69071d33 | 29 | OWNER = 100 |
30 | MANAGER = 99 | |
31 | ADMIN = 75 | |
32 | STAFF = 50 | |
25bf8fc5 | 33 | KNOWN = 1 |
43151ead JR |
34 | AUTHED = 0 # Users which have are known to be authed |
35 | ANYONE = -1 # non-authed users have glevel set to -1 | |
36 | IGNORED = -2 # The default reqglevel is ANYONE, so any commands will be ignored from IGNORED users unless the command reglevel=-2 | |
25bf8fc5 JR |
37 | glevs = { |
38 | 'OWNER': OWNER, | |
39 | 'MANAGER': MANAGER, | |
40 | 'ADMIN': ADMIN, | |
41 | 'STAFF': STAFF, | |
42 | 'KNOWN': KNOWN, | |
43 | 'AUTHED': AUTHED, | |
44 | 'ANYONE': ANYONE, | |
45 | 'IGNORED': IGNORED, | |
46 | } | |
931c88a4 | 47 | |
839d2b35 | 48 | # (channel) access levels |
a290635a | 49 | COWNER = 5 |
69071d33 | 50 | MASTER = 4 |
51 | OP = 3 | |
52 | VOICE = 2 | |
f6386fa7 | 53 | FRIEND = 1 |
43151ead JR |
54 | PUBLIC = 0 # Anyone (use glevel to control whether auth is needed) |
55 | BANNED = -1 # The default reqclevel is PUBLIC, so any commands which needchan will be ignored from BANNED users unless the command reqclevel=-1 | |
f164fd1c | 56 | # [ 0 1 2 3 4 5 -1] |
f6386fa7 | 57 | clevs = [None, 'Friend', 'Voice', 'Op', 'Master', 'Owner', 'Banned'] |
839d2b35 | 58 | |
d431e543 | 59 | # messages |
60 | WRONGARGS = "Wrong number of arguments." | |
61 | ||
6c70d82c | 62 | def __init__(self, name): |
9d44d267 JR |
63 | self.hooks = {} # {command:handler} |
64 | self.chanhooks = {} # {channel:handler} | |
65 | self.exceptionhooks = [] # [(exception,handler)] | |
66 | self.numhooks = {} # {numeric:handler} | |
67 | self.sockhooks = [] # [(af,ty,address,handler_class)] | |
68 | self.sockets = [] # [(sock,obj)] | |
0f8352dd | 69 | self.helps = [] |
db50981b | 70 | self.parent = None |
71 | ||
a8553c45 | 72 | self.name = (name.split("."))[-1] |
6c70d82c | 73 | |
74 | def modstart(self, parent): | |
a62d0d18 | 75 | #modstart can return a few things... |
76 | # None: unspecified success | |
77 | # False: unspecified error | |
78 | # modlib.error (or anything else False-y): specified error | |
79 | # True: unspecified success | |
80 | # non-empty string (or anything else True-y): specified success | |
81 | #"specified" values will be printed. unspecified values will result in "OK" or "failed" | |
6c70d82c | 82 | self.parent = parent |
a28e2ae9 | 83 | for cmd, func in self.hooks.items(): |
e8885384 JR |
84 | parent.hook(cmd, func) |
85 | parent.hook("%s.%s" % (self.name, cmd), func) | |
a28e2ae9 | 86 | for chan, func in self.chanhooks.items(): |
e8885384 JR |
87 | parent.hookchan(chan, func) |
88 | for exc, func in self.exceptionhooks: | |
89 | parent.hookexception(exc, func) | |
438f7326 JR |
90 | for num, func in self.numhooks.items(): |
91 | parent.hooknum(num, func) | |
9d44d267 JR |
92 | for hookdata in self.sockhooks: |
93 | self._create_socket(*hookdata) | |
0f8352dd | 94 | |
95 | for func, args, kwargs in self.helps: | |
96 | try: | |
97 | self.mod('help').reghelp(func, *args, **kwargs) | |
98 | except: | |
99 | pass | |
d431e543 | 100 | return True |
db50981b | 101 | def modstop(self, parent): |
a28e2ae9 | 102 | for cmd, func in self.hooks.items(): |
1bdecfcd | 103 | parent.unhook(cmd, func) |
104 | parent.unhook("%s.%s" % (self.name, cmd), func) | |
a28e2ae9 | 105 | for chan, func in self.chanhooks.items(): |
1bdecfcd | 106 | parent.unhookchan(chan, func) |
e8885384 JR |
107 | for exc, func in self.exceptionhooks: |
108 | parent.unhookexception(exc, func) | |
438f7326 JR |
109 | for num, func in self.numhooks.items(): |
110 | parent.unhooknum(num, func) | |
9d44d267 JR |
111 | for sock, obj in self.sockets: |
112 | self._destroy_socket(sock, obj) | |
0f8352dd | 113 | |
114 | for func, args, kwargs in self.helps: | |
115 | try: | |
116 | self.mod('help').dereghelp(func, *args, **kwargs) | |
117 | except: | |
118 | pass | |
d431e543 | 119 | return True |
6c70d82c | 120 | |
827ec8f0 | 121 | def hook(self, cmd=None, needchan=True, glevel=ANYONE, clevel=PUBLIC, wantchan=None): |
122 | if wantchan is None: wantchan = needchan | |
3a8b7b5f | 123 | _cmd = cmd #save this since it gets wiped out... |
6c70d82c | 124 | def realhook(func): |
3a8b7b5f | 125 | cmd = _cmd #...and restore it |
126 | if cmd is None: | |
127 | cmd = func.__name__ # default to function name | |
a28e2ae9 | 128 | if isinstance(cmd, stringbase): |
0f8352dd | 129 | cmd = (cmd,) |
3a8b7b5f | 130 | |
68dff4aa JR |
131 | if clevel > self.PUBLIC and not needchan: |
132 | raise Exception('clevel must be left at default if needchan is False') | |
133 | ||
839d2b35 | 134 | func.needchan = needchan |
827ec8f0 | 135 | func.wantchan = wantchan |
839d2b35 | 136 | func.reqglevel = glevel |
137 | func.reqclevel = clevel | |
0f8352dd | 138 | func.cmd = cmd |
179c06a9 | 139 | func.module = func.__module__.split('.')[1] |
839d2b35 | 140 | |
9ea2be43 | 141 | for c in cmd: |
142 | self.hooks[c] = func | |
143 | if self.parent is not None: | |
144 | self.parent.hook(c, func) | |
a290635a | 145 | self.parent.hook("%s.%s" % (self.name, c), func) |
6c70d82c | 146 | return func |
147 | return realhook | |
d431e543 | 148 | |
438f7326 JR |
149 | def hookchan(self, chan, glevel=ANYONE, clevel=PUBLIC): |
150 | def realhook(func): | |
151 | self.chanhooks[chan] = func | |
152 | if self.parent is not None: | |
153 | self.parent.hookchan(chan, func) | |
154 | return func | |
155 | return realhook | |
156 | ||
157 | def hookexception(self, exc): | |
158 | def realhook(func): | |
159 | self.exceptionhooks.append((exc, func)) | |
160 | if self.parent is not None: | |
161 | self.parent.hookexception(exc, func) | |
162 | return func | |
163 | return realhook | |
164 | ||
165 | def hooknum(self, num): | |
166 | def realhook(func): | |
167 | self.numhooks[str(num)] = func | |
168 | if self.parent is not None: | |
169 | self.parent.hooknum(str(num), func) | |
170 | return func | |
171 | return realhook | |
172 | ||
9d44d267 JR |
173 | def bind_tcp(self, host, port): |
174 | return self._hooksocket(socket.AF_INET, socket.SOCK_STREAM, (host, port)) | |
175 | def bind_udp(self, host, port): | |
176 | return self._hooksocket(socket.AF_INET, socket.SOCK_DGRAM, (host, port)) | |
177 | def bind_unix(self, path): | |
178 | return self._hooksocket(socket.AF_UNIX, socket.SOCK_STREAM, path) | |
179 | def _hooksocket(self, af, ty, address): | |
180 | def realhook(cls): | |
181 | if not (hasattr(cls, 'getdata') and callable(cls.getdata)): | |
182 | # Check early that the object implements getdata. | |
183 | # If getdata ever returns a non-empty list, then a parse method must also exist, but we don't check that. | |
184 | raise Exception('Attempted to hook a socket without a class to process data') | |
185 | self.sockhooks.append((af, ty, address, cls)) | |
186 | if self.parent is not None: | |
187 | self._create_socket(af, ty, address, cls) | |
188 | return cls | |
189 | return realhook | |
190 | def _create_socket(self, af, ty, address, cls): | |
191 | ty = ty | socket.SOCK_NONBLOCK | |
192 | sock = socket.socket(af, ty) | |
193 | sock.setsockopt(socket.SOL_SOCKET, socket.SO_REUSEADDR, 1) | |
194 | sock.bind(address) | |
195 | obj = _ListenSocket(self, sock, cls) | |
196 | self.sockets.append((sock,obj)) | |
197 | sock.listen(5) | |
198 | self.parent.newfd(obj, sock.fileno()) | |
199 | self.parent.log(repr(obj), '?', 'Socket ready to accept new connections') | |
200 | def _destroy_socket(self, sock, obj): | |
201 | obj.close() | |
202 | ||
36411de9 | 203 | def mod(self, modname): |
204 | if self.parent is not None: | |
205 | return self.parent.module(modname) | |
206 | else: | |
207 | return error('unknown parent') | |
208 | ||
d431e543 | 209 | def argsEQ(self, num): |
210 | def realhook(func): | |
4f8abd95 | 211 | @wraps(func) |
d431e543 | 212 | def checkargs(bot, user, chan, realtarget, *args): |
213 | if len(args) == num: | |
214 | return func(bot, user, chan, realtarget, *args) | |
215 | else: | |
216 | bot.msg(user, self.WRONGARGS) | |
217 | return checkargs | |
218 | return realhook | |
219 | ||
220 | def argsGE(self, num): | |
221 | def realhook(func): | |
4f8abd95 | 222 | @wraps(func) |
d431e543 | 223 | def checkargs(bot, user, chan, realtarget, *args): |
224 | if len(args) >= num: | |
225 | return func(bot, user, chan, realtarget, *args) | |
226 | else: | |
227 | bot.msg(user, self.WRONGARGS) | |
228 | return checkargs | |
229 | return realhook | |
b670c2f4 | 230 | |
984fc310 | 231 | def help(self, *args, **kwargs): |
0f8352dd | 232 | """help(syntax, shorthelp, longhelp?, more lines longhelp?, cmd=...?) |
b670c2f4 | 233 | Example: |
234 | help("<user> <pass>", "login") | |
235 | ^ Help will only be one line. Command name determined based on function name. | |
236 | help("<user> <level>", "add a user", cmd=("adduser", "useradd")) | |
237 | ^ Help will be listed under ADDUSER; USERADD will say "alias for adduser" | |
238 | help(None, "do stuff", "This command is really complicated.") | |
239 | ^ Command takes no args. Short description (in overall HELP listing) is "do stuff". | |
240 | Long description (HELP <command>) will say "<command> - do stuff", newline, "This command is really complicated." | |
241 | """ | |
0f8352dd | 242 | def realhook(func): |
243 | if self.parent is not None: | |
244 | try: | |
245 | self.mod('help').reghelp(func, *args, **kwargs) | |
246 | except: | |
247 | pass | |
71ef8273 | 248 | self.helps.append((func, args, kwargs)) |
0f8352dd | 249 | return func |
250 | return realhook | |
9d44d267 JR |
251 | |
252 | class _ListenSocket(object): | |
253 | def __init__(self, lib, sock, cls): | |
254 | self.clients = [] | |
255 | self.lib = lib | |
256 | self.sock = sock | |
257 | self.cls = cls | |
258 | ||
259 | def _make_closer(self, obj, client): | |
260 | def close(): | |
867df393 | 261 | self.lib.parent.log(repr(self), '?', 'Closing child socket #%d' % (client.fileno())) |
9d44d267 JR |
262 | try: |
263 | obj.closing() | |
264 | except AttributeError: | |
265 | pass | |
266 | self.lib.parent.delfd(client.fileno()) | |
267 | client.shutdown(socket.SHUT_RDWR) | |
268 | client.close() | |
269 | self.clients.remove((client,obj)) | |
270 | return close | |
271 | ||
272 | def getdata(self): | |
273 | client, addr = self.sock.accept() | |
274 | obj = self.cls(client) | |
275 | obj.close = self._make_closer(obj, client) | |
867df393 | 276 | self.lib.parent.log(repr(self), '?', 'New connection #%d from %s' % (client.fileno(), addr)) |
9d44d267 JR |
277 | self.clients.append((client,obj)) |
278 | self.lib.parent.newfd(obj, client.fileno()) | |
279 | return [] | |
280 | ||
281 | def close(self): | |
282 | self.lib.parent.log(repr(self), '?', 'Socket closing') | |
283 | if self.sock.fileno() != -1: | |
284 | self.lib.parent.delfd(self.sock.fileno()) | |
285 | self.sock.shutdown(socket.SHUT_RDWR) | |
286 | self.sock.close() | |
287 | for client, obj in self.clients: | |
288 | obj.close() | |
289 | ||
290 | def __repr__(self): return '<_ListenSocket #%d>' % (self.sock.fileno()) |