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