]> jfr.im git - erebus.git/blob - bot.py
admin_channel -> channel_admin, add fclevel alias
[erebus.git] / bot.py
1 #!/usr/bin/python
2 # vim: fileencoding=utf-8
3
4 # Erebus IRC bot - Author: John Runyon
5 # "Bot" and "BotConnection" classes (handling a specific "arm")
6
7 import os, random, socket, struct, sys, threading, time, traceback
8 from collections import deque
9
10 if sys.version_info.major < 3:
11 timerbase = threading._Timer
12 stringbase = basestring
13 else:
14 timerbase = threading.Timer
15 stringbase = str
16
17 class MyTimer(timerbase):
18 def __init__(self, *args, **kwargs):
19 timerbase.__init__(self, *args, **kwargs)
20 self.daemon = True
21
22 if sys.version_info.major < 3:
23 stringbase = basestring
24 else:
25 stringbase = str
26
27 #bots = {'erebus': bot.Bot(nick='Erebus', user='erebus', bind='', server='irc.quakenet.org', port=6667, realname='Erebus')}
28 class Bot(object):
29 def __init__(self, parent, nick, user, bind, authname, authpass, server, port, realname):
30 self.maxlen = 510
31
32 self.parent = parent
33 self.nick = nick
34 self.permnick = nick
35 self.user = user
36 self.realname = realname
37
38 self.authname = authname
39 self.authpass = authpass
40
41 self.connecttime = 0 # time at which we received numeric 001
42 self.server = server # the address we try to (re-)connect to
43 self.port = port
44 self.servername = server # the name of the server we got connected to
45
46 curs = self.parent.query("SELECT chname FROM chans WHERE bot = %s AND active = 1", (self.permnick,))
47 if curs:
48 chansres = curs.fetchall()
49 curs.close()
50 self.chans = [self.parent.newchannel(self, row['chname']) for row in chansres]
51 else:
52 self.chans = []
53
54 self.conn = BotConnection(self, bind, server, port)
55
56 self.lastreceived = time.time() #time we last received a line from the server
57 self.watchdog()
58
59 self.msgqueue = deque()
60 self.slowmsgqueue = deque()
61 self._makemsgtimer()
62 self._msgtimer.start()
63 self.joined_chans = False
64
65 def __del__(self):
66 try:
67 curs = self.parent.query("UPDATE bots SET connected = 0 WHERE nick = %s", (self.permnick,))
68 curs.close()
69 except: pass
70
71 def watchdog(self):
72 if time.time() > int(self.parent.cfg.get('watchdog', 'maxtime', default=300))+self.lastreceived:
73 self.parse("ERROR :Fake-error from watchdog timer.")
74 return
75 if self.conn.registered():
76 self.conn.send("PING :%s" % (time.time()))
77 self._checknick()
78 watchdogtimer = MyTimer(int(self.parent.cfg.get('watchdog', 'interval', default=30)), self.watchdog)
79 watchdogtimer.start()
80
81 def log(self, *args, **kwargs):
82 self.parent.log(self.nick, *args, **kwargs)
83
84 def connect(self):
85 self.log('!', "Connecting")
86 if self.conn.connect():
87 self.log('!', "Connected")
88 self.parent.newfd(self, self.conn.socket.fileno())
89
90 def getdata(self):
91 try:
92 recvd = self.conn.read()
93 self.lastreceived = time.time()
94 return recvd
95 except EOFError as e:
96 return [":%s ERROR :%s%r" % (self.nick, e.__class__.__name__, e.args)]
97
98 def _checknick(self): # check if we're using the right nick, try changing
99 if self.nick != self.permnick and self.conn.registered():
100 self.conn.send("NICK %s" % (self.permnick))
101
102 def parse(self, line):
103 pieces = line.split()
104
105 if pieces[0][0] == ":":
106 numeric = pieces[1]
107 else:
108 numeric = pieces[0]
109
110 # dispatch dict
111 dispatch = {
112 'NOTICE': self._gotconnected,
113 '001': self._got001,
114 '004': self._got004,
115 '376': self._gotRegistered,
116 '422': self._gotRegistered,
117 'PRIVMSG': self._gotprivmsg,
118 '353': self._got353, #NAMES
119 '354': self._got354, #WHO
120 '396': self._gotHiddenHost, # hidden host has been set
121 '433': self._got433, #nick in use
122 'JOIN': self._gotjoin,
123 'PART': self._gotpart,
124 'KICK': self._gotkick,
125 'QUIT': self._gotquit,
126 'NICK': self._gotnick,
127 'MODE': self._gotmode,
128 'PING': self._gotping,
129 'ERROR': self._goterror,
130 }
131
132 if self.parent.hasnumhook(numeric):
133 hooks = self.parent.getnumhook(numeric)
134 for callback in hooks:
135 try:
136 callback(self, line)
137 except Exception:
138 self._cbexception("numhook", line)
139
140 if numeric in dispatch:
141 dispatch[numeric](pieces)
142
143 def _gotconnected(self, pieces):
144 if not self.conn.registered():
145 self.conn.register()
146 def _gotping(self, pieces):
147 self.conn.send("PONG %s" % (pieces[1]))
148 self._checknick()
149 def _goterror(self, pieces):
150 # TODO: better handling, just reconnect that single bot
151 error = ' '.join(pieces)
152 try:
153 raise Exception(error)
154 except Exception as e:
155 self.parent.mustquit = e
156 try:
157 self.quit("Error detected: %s" % (error))
158 except: pass
159 try:
160 curs = self.parent.query("UPDATE bots SET connected = 0")
161 curs.close()
162 except: pass
163 self.log('!', 'Bot exiting due to: %s' % (error))
164 def _got001(self, pieces):
165 # We wait until the end of MOTD instead to consider ourselves registered, but consider uptime as of 001
166 self.connecttime = time.time()
167 def _got004(self, pieces):
168 self.servername = pieces[3]
169 def _gotRegistered(self, pieces):
170 self.conn.registered(True)
171
172 curs = self.parent.query("UPDATE bots SET connected = 1 WHERE nick = %s", (self.permnick,))
173 if curs: curs.close()
174
175 self.conn.send("MODE %s +x" % (pieces[2]))
176 if self.authname is not None and self.authpass is not None:
177 self.conn.send(self.parent.cfg.get('erebus', 'auth_command', "AUTH %s %s") % (self.authname, self.authpass))
178 if not self.parent.cfg.getboolean('erebus', 'wait_for_hidden_host'):
179 for c in self.chans:
180 self.join(c.name)
181 self.joined_chans = True
182 def _gotHiddenHost(self, pieces):
183 if not self.joined_chans and self.parent.cfg.getboolean('erebus', 'wait_for_hidden_host'):
184 for c in self.chans:
185 self.join(c.name)
186 self.joined_chans = True
187 def _gotprivmsg(self, pieces):
188 nick = pieces[0].split('!')[0][1:]
189 user = self.parent.user(nick)
190 target = pieces[2]
191 msg = ' '.join(pieces[3:])[1:]
192 self.parsemsg(user, target, msg)
193 def _got353(self, pieces):
194 prefixes = {'@': 'op', '+': 'voice'}
195 chan = self.parent.channel(pieces[4])
196 names = pieces[5:]
197 names[0] = names[0][1:] #remove colon
198 for n in names:
199 if n[0] in prefixes:
200 user = self.parent.user(n[1:])
201 chan.userjoin(user, prefixes[n[0]])
202 else:
203 user = self.parent.user(n)
204 chan.userjoin(user)
205 user.join(chan)
206 def _got354(self, pieces):
207 qt = int(pieces[3])
208 if qt < 3:
209 nick, auth = pieces[4:6]
210 chan = None
211 else:
212 chan, nick, auth = pieces[4:7]
213 chan = self.parent.channel(chan)
214 user = self.parent.user(nick)
215 user.authed(auth)
216
217 if chan is not None:
218 user.join(chan)
219 chan.userjoin(user)
220
221 if qt == 2: # triggered by !auth
222 if user.isauthed():
223 if user.glevel > 0:
224 self.msg(nick, "You are now known as #%s (access level: %s)" % (auth, user.glevel))
225 else:
226 self.msg(nick, "You are now known as #%s (not staff)" % (auth))
227 else:
228 self.msg(nick, "I tried, but you're not authed!")
229 def _got433(self, pieces):
230 if not self.conn.registered(): #we're trying to connect
231 newnick = "%s%d" % (self.nick, random.randint(111, 999))
232 self.conn.send("NICK %s" % (newnick))
233 self.nick = newnick
234 def _gotjoin(self, pieces):
235 nick = pieces[0].split('!')[0][1:]
236 chan = self.parent.channel(pieces[2])
237
238 if nick == self.nick:
239 self.conn.send("WHO %s c%%cant,3" % (chan))
240 else:
241 user = self.parent.user(nick, send_who=True)
242 chan.userjoin(user)
243 user.join(chan)
244 def _clientLeft(self, nick, chan):
245 if nick == self.nick:
246 for u in chan.users:
247 if u.nick != self.nick:
248 self._clientLeft(u.nick, chan)
249 else:
250 user = self.parent.user(nick)
251 gone = user.part(chan)
252 chan.userpart(user)
253 if gone:
254 user.quit()
255 del self.parent.users[nick.lower()]
256 def _gotpart(self, pieces):
257 nick = pieces[0].split('!')[0][1:]
258 chan = self.parent.channel(pieces[2])
259 self._clientLeft(nick, chan)
260 def _gotkick(self, pieces):
261 nick = pieces[3]
262 chan = self.parent.channel(pieces[2])
263 self._clientLeft(nick, chan)
264 def _gotquit(self, pieces):
265 nick = pieces[0].split('!')[0][1:]
266 if nick != self.nick:
267 for chan in self.parent.user(nick).chans:
268 chan.userpart(self.parent.user(nick))
269 self.parent.user(nick).quit()
270 del self.parent.users[nick.lower()]
271 def _gotnick(self, pieces):
272 oldnick = pieces[0].split('!')[0][1:]
273 newnick = pieces[2][1:]
274 if oldnick == self.nick:
275 self.nick = newnick
276 else:
277 if newnick.lower() != oldnick.lower():
278 self.parent.users[newnick.lower()] = self.parent.users[oldnick.lower()]
279 del self.parent.users[oldnick.lower()]
280 self.parent.users[newnick.lower()].nickchange(newnick)
281 def _gotmode(self, pieces):
282 source = pieces[0].split('!')[0][1:]
283 chan = pieces[2]
284 if not chan.startswith("#"): return
285 chan = self.parent.channel(pieces[2])
286 mode = pieces[3]
287 args = pieces[4:]
288
289 adding = True
290 for c in mode:
291 if c == '+':
292 adding = True
293 elif c == '-':
294 adding = False
295 elif c == 'o':
296 if adding:
297 chan.userop(self.parent.user(args.pop(0)))
298 else:
299 chan.userdeop(self.parent.user(args.pop(0)))
300 elif c == 'v':
301 if adding:
302 chan.uservoice(self.parent.user(args.pop(0)))
303 else:
304 chan.userdevoice(self.parent.user(args.pop(0)))
305 else:
306 pass # don't care about other modes
307
308 def _cbexception(self, source, *args, chained=False, **kwargs):
309 if not chained: # skip hooks if we were caused by a hook
310 exc = sys.exception()
311 if self.parent.hasexceptionhook(exc):
312 for callback in self.parent.getexceptionhook(exc):
313 try:
314 callback(self, exc, source, *args, **kwargs)
315 except Exception:
316 self._cbexception('exceptionhook', chained=True, module=callback.__module__, function=callback.__name__, underlying=(source, args, kwargs))
317 if self.parent.cfg.getboolean('debug', 'cbexc'):
318 self.conn.send("PRIVMSG %s :%09.3f \ 34\1f!!! CBEXC\1f\ 3 %s" % (self.parent.cfg.get('debug', 'owner'), time.time() % 100000, source))
319 traceback.print_exc(chain=not chained)
320 self.log('!', "CBEXC %s %r %r" % (source, args, kwargs))
321
322
323 def parsemsg(self, user, target, msg):
324 if user.glevel <= -2: return # short circuit if user is IGNORED
325 chan = None
326 chanparam = None # was the channel specified as part of the command?
327 if len(msg) == 0:
328 return
329
330 if target == self.nick and msg.startswith("\001"): #ctcp
331 msg = msg.strip("\001")
332 if msg:
333 pieces = msg.split()
334 if pieces[0] == "CLIENTINFO":
335 self.msg(user, "\001CLIENTINFO VERSION PING\001")
336 elif pieces[0] == "VERSION":
337 self.msg(user, "\001VERSION Erebus v%d.%d - http://jfr.im/git/erebus.git\001" % (self.parent.APIVERSION, self.parent.RELEASE))
338 elif pieces[0] == "PING":
339 if len(pieces) > 1:
340 self.msg(user, "\001PING %s\001" % (' '.join(pieces[1:])))
341 else:
342 self.msg(user, "\001PING\001")
343 return
344
345 triggerused = msg.startswith(self.parent.trigger)
346 if triggerused: msg = msg[len(self.parent.trigger):]
347 pieces = msg.split()
348
349 if len(pieces) == 0:
350 return
351
352 if target != self.nick: # message was sent to a channel
353 try:
354 if pieces[0][:-1].lower() == self.nick.lower() and (pieces[0][-1] == ":" or pieces[0][-1] == ","):
355 pieces.pop(0) # command actually starts with next word
356 if len(pieces) == 0: # is there still anything left?
357 return
358 msg = ' '.join(pieces)
359 triggerused = True
360 except IndexError:
361 return # "message" is empty
362
363 if len(pieces) > 1:
364 chanword = pieces[1]
365 if chanword.startswith('#'):
366 chanparam = self.parent.channel(chanword)
367
368 if target != self.nick: # message was sent to a channel
369 chan = self.parent.channel(target)
370 if not triggerused:
371 if self.parent.haschanhook(target.lower()):
372 for callback in self.parent.getchanhook(target.lower()):
373 try:
374 cbret = callback(self, user, chan, *pieces)
375 if isinstance(cbret, stringbase):
376 self.reply(target, user, cbret)
377 except:
378 self.msg(user, "Command failed. Code: CBEXC%09.3f" % (time.time() % 100000))
379 self._cbexception("chanhook", user=user, target=target, msg=msg)
380 return # not to bot, don't process!
381
382 cmd = pieces[0].lower()
383 rancmd = False
384 if self.parent.hashook(cmd):
385 for callback in self.parent.gethook(cmd):
386 if chanparam is not None and (callback.needchan or callback.wantchan):
387 chan = chanparam
388 pieces.pop(1)
389 if chan is None and callback.needchan:
390 rancmd = True
391 self.msg(user, "You need to specify a channel for that command.")
392 elif user.glevel >= callback.reqglevel and (not callback.needchan or chan.levelof(user.auth) >= callback.reqclevel):
393 rancmd = True
394 try:
395 cbret = callback(self, user, chan, target, *pieces[1:])
396 if isinstance(cbret, stringbase):
397 self.reply(target, user, cbret)
398 except Exception:
399 self.msg(user, "Command failed. Code: CBEXC%09.3f" % (time.time() % 100000))
400 self._cbexception("hook", user=user, target=target, msg=msg)
401 except SystemExit as e:
402 self.parent.mustquit = e
403 try:
404 curs = self.parent.query("UPDATE bots SET connected = 0")
405 curs.close()
406 except: pass
407 raise e
408 else:
409 rancmd = True
410 self.msg(user, "I don't know that command.")
411 if not rancmd:
412 self.msg(user, "You don't have enough access to run that command.")
413
414 def __debug_nomsg(self, target, msg):
415 if self.parent.cfg.getboolean('debug', 'nomsg'):
416 self.conn.send("PRIVMSG %s :%09.3f \ 34\1f!!! NOMSG\1f\ 3 %r, %r" % (self.parent.cfg.get('debug', 'owner'), time.time() % 100000, target, msg))
417 self.log('!', "!!! NOMSG")
418 # print "%09.3f %s [!] %s" % (time.time() % 100000, self.nick, "!!! NOMSG")
419 traceback.print_stack()
420
421
422 def reply(self, chan, user, msg):
423 if chan is not None and (isinstance(chan, self.parent.Channel) or (isinstance(chan, stringbase) and chan[0] == "#")):
424 self.msg(chan, "%s: %s" % (user, msg))
425 else:
426 self.msg(user, msg)
427
428 """
429 Does the work for msg/slowmsg/fastmsg. Uses the append_callback to append to the correct queue.
430
431 In the case of fastmsg, self.conn.exceeded may be True, however, in this case append_callback=self.conn.send, so it will still be sent immediately.
432 """
433 def _msg(self, target, msg, truncate, append_callback, msgtype):
434 if self.parent.cfg.getboolean('erebus', 'nofakelag'): append_callback = self.conn.send
435
436 cmd = self._formatmsg(target, msg, msgtype)
437 # The max length is much shorter than conn.maxlen (510) because of the length the server adds on about the source (us).
438 # If you know your hostmask, you can of course figure the exact length, but it's very difficult to reliably know your hostmask.
439 maxlen = self.maxmsglen()
440 if len(cmd) > maxlen:
441 if not truncate:
442 return False
443 else:
444 cmd = cmd[:maxlen]
445
446 if self.conn.exceeded or self.conn.bytessent+len(cmd) >= self.conn.recvq:
447 append_callback(cmd)
448 else:
449 self.conn.send(cmd)
450
451 self.conn.exceeded = True
452 return True
453
454 def msg(self, target, msg, truncate=False, *, msgtype=None):
455 """msgtype must be a valid IRC command, i.e. NOTICE or PRIVMSG; or leave as None to use default"""
456 return self._msg(target, msg, truncate, self.msgqueue.append, msgtype)
457
458 def slowmsg(self, target, msg, truncate=False, *, msgtype=None):
459 return self._msg(target, msg, truncate, self.slowmsgqueue.append, msgtype)
460
461 def fastmsg(self, target, msg, truncate=False, *, msgtype=None):
462 return self._msg(target, msg, truncate, self.conn.send, msgtype)
463
464 def _formatmsg(self, target, msg, msgtype):
465 if target is None or msg is None:
466 return self.__debug_nomsg(target, msg)
467
468 target = str(target)
469
470 if msgtype is not None: command = "%s %s :%s" % (msgtype, target, msg)
471 elif target.startswith('#'): command = "PRIVMSG %s :%s" % (target, msg)
472 else: command = "NOTICE %s :%s" % (target, msg)
473
474 return command
475
476 def _popmsg(self):
477 self._makemsgtimer()
478 self.conn.bytessent -= self.conn.recvq/3
479 if self.conn.bytessent < 0: self.conn.bytessent = 0
480 self.conn.exceeded = True
481
482 cmd = None
483 try:
484 cmd = self.msgqueue.popleft()
485 except IndexError:
486 try:
487 cmd = self.slowmsgqueue.popleft()
488 except IndexError:
489 pass
490
491 if cmd is not None:
492 if self.conn.bytessent+len(cmd) > self.conn.recvq: # If it's too long
493 if len(cmd) > self.conn.recvq: # Is the command itself somehow over max length???
494 self._msgtimer.start()
495 raise ValueError('Somehow a command that was too long made it into the message queue. Uhoh!', cmd)
496 # Discard the message.
497 self.msgqueue.appendleft(cmd) # Phew, we've just sent too much recently. Put it (back) on the (primary) queue.
498 else:
499 self.conn.send(cmd)
500
501 self._msgtimer.start()
502
503 def _makemsgtimer(self):
504 self._msgtimer = MyTimer(3, self._popmsg)
505
506 def join(self, chan):
507 self.conn.send("JOIN %s" % (chan))
508
509 def part(self, chan):
510 self.conn.send("PART %s" % (chan))
511
512 def quit(self, reason="Shutdown"):
513 self.conn.send("QUIT :%s" % (reason))
514
515 def maxmsglen(self):
516 return (
517 self.maxlen
518 - 63 # max hostname len
519 - 11 # max ident len
520 - 3 # the symbols in :nick!user@host
521 - len(self.nick)
522 )
523
524 def __str__(self): return self.nick
525 def __repr__(self): return "<Bot %r>" % (self.nick)
526
527 class BotConnection(object):
528 def __init__(self, parent, bind, server, port):
529 self.parent = parent
530 self.buffer = bytearray()
531 self.socket = None
532
533 self.bind = bind
534 self.server = server
535 self.port = int(port)
536
537 self.state = 0 # 0=disconnected, 1=registering, 2=connected
538
539 self.bytessent = 0
540 self.recvq = 510 # How much we can send per period
541 self.exceeded = False
542 self._nowrite = False
543
544 def connect(self):
545 if self.parent.parent.cfg.getboolean('erebus', 'tls'):
546 import ssl
547 undersocket = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
548 context = ssl.create_default_context()
549 self.socket = context.wrap_socket(undersocket, server_hostname=self.server)
550 else:
551 self.socket = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
552 self.socket.setsockopt(socket.SOL_TCP, socket.TCP_NODELAY, 1) # Does Python make SOL_TCP portable? Who knows, it's not documented, and it appears to come from the _socket C lib.
553 self.socket.setsockopt(socket.SOL_SOCKET, socket.SO_LINGER, struct.pack('ii', 0, 0))
554 self.socket.setsockopt(socket.SOL_SOCKET, socket.SO_KEEPALIVE, 1)
555 self.socket.bind((self.bind, 0))
556 self.socket.connect((self.server, self.port))
557 return True
558 def register(self):
559 if self.state == 0:
560 pss = self.parent.parent.cfg.get('erebus', 'pass')
561 if pss:
562 self.send("PASS %s" % (pss))
563 self.send("NICK %s" % (self.parent.nick))
564 self.send("USER %s 0 * :%s" % (self.parent.user, self.parent.realname))
565 self.state = 1
566 return True
567
568 def registered(self, done=False):
569 if done: self.state = 2
570 return self.state == 2
571
572 def send(self, line):
573 if not self._nowrite:
574 if self.parent.parent.cfg.getboolean('debug', 'io'):
575 self.parent.log('O', line)
576 self.bytessent += len(line)
577 try:
578 self._write(line)
579 except socket.error as e:
580 self._nowrite = True
581 self.parent._goterror(repr(e))
582 else:
583 if self.parent.parent.cfg.getboolean('debug', 'io'):
584 self.parent.log('X', line)
585
586 def _write(self, line):
587 self.socket.sendall(line.encode('utf-8', 'backslashreplace')+b"\r\n")
588
589 def _getsockerr(self):
590 try: # SO_ERROR might not exist on all platforms
591 return self.socket.getsockopt(socket.SOL_SOCKET, socket.SO_ERROR)
592 except:
593 return None
594
595 def read(self):
596 recvd = self.socket.recv(8192)
597 if recvd == b"":
598 raise EOFError("socket.recv returned empty", self.parent.nick, self._getsockerr())
599 self.buffer += recvd
600 lines = []
601
602 while b"\r\n" in self.buffer:
603 pieces = self.buffer.split(b"\r\n", 1)
604 lines.append(pieces[0].decode('utf-8', 'backslashreplace'))
605 self.buffer = pieces[1]
606
607 return lines
608
609 def __str__(self): return self.parent.nick
610 def __repr__(self): return "<BotConnection %r (%r)>" % (self.socket.fileno(), self.parent.nick)