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