X-Git-Url: https://jfr.im/git/erebus.git/blobdiff_plain/3296dba1501001a004e95145372ec8050ee2537b..a99afee6c437887dc90ad4b57347de9af3a09e89:/bot.py?ds=inline diff --git a/bot.py b/bot.py index 1f8c710..793e27f 100644 --- a/bot.py +++ b/bot.py @@ -4,17 +4,16 @@ # Erebus IRC bot - Author: John Runyon # "Bot" and "BotConnection" classes (handling a specific "arm") -import socket, sys, time, threading, os, random +import socket, sys, time, threading, os, random, struct from collections import deque -MAXLEN = 400 # arbitrary max length of a command generated by Bot.msg functions - if sys.version_info.major < 3: timerbase = threading._Timer stringbase = basestring else: timerbase = threading.Timer stringbase = str + class MyTimer(timerbase): def __init__(self, *args, **kwargs): timerbase.__init__(self, *args, **kwargs) @@ -37,7 +36,12 @@ class Bot(object): self.authname = authname self.authpass = authpass - curs = self.parent.query("SELECT chname FROM chans WHERE bot = %s AND active = 1", (self.nick,)) + self.connecttime = 0 # time at which we received numeric 001 + self.server = server # the address we try to (re-)connect to + self.port = port + self.servername = server # the name of the server we got connected to + + curs = self.parent.query("SELECT chname FROM chans WHERE bot = %s AND active = 1", (self.permnick,)) if curs: chansres = curs.fetchall() curs.close() @@ -52,12 +56,13 @@ class Bot(object): self.msgqueue = deque() self.slowmsgqueue = deque() - self.makemsgtimer() - self.msgtimer.start() + self._makemsgtimer() + self._msgtimer.start() + self.joined_chans = False def __del__(self): try: - curs = self.parent.query("UPDATE bots SET connected = 0 WHERE nick = %s", (self.nick,)) + curs = self.parent.query("UPDATE bots SET connected = 0 WHERE nick = %s", (self.permnick,)) curs.close() except: pass @@ -70,6 +75,7 @@ class Bot(object): self.parent.log(self.nick, *args, **kwargs) def connect(self): + self.log('!', "Connecting") if self.conn.connect(): self.parent.newfd(self, self.conn.socket.fileno()) @@ -86,19 +92,22 @@ class Bot(object): self.log('I', line) pieces = line.split() + if pieces[0][0] == ":": + numeric = pieces[1] + else: + numeric = pieces[0] + # dispatch dict - zero = { #things to look for without source + dispatch = { #things to look for after source 'NOTICE': self._gotconnected, - 'PING': self._gotping, - 'ERROR': self._goterror, - } - one = { #things to look for after source '001': self._got001, + '004': self._got004, '376': self._gotRegistered, '422': self._gotRegistered, 'PRIVMSG': self._gotprivmsg, '353': self._got353, #NAMES '354': self._got354, #WHO + '396': self._gotHiddenHost, # hidden host has been set '433': self._got433, #nick in use 'JOIN': self._gotjoin, 'PART': self._gotpart, @@ -106,20 +115,20 @@ class Bot(object): 'QUIT': self._gotquit, 'NICK': self._gotnick, 'MODE': self._gotmode, + 'PING': self._gotping, + 'ERROR': self._goterror, } - if self.parent.hasnumhook(pieces[1]): - hooks = self.parent.getnumhook(pieces[1]) + if self.parent.hasnumhook(numeric): + hooks = self.parent.getnumhook(numeric) for callback in hooks: try: callback(self, line) except Exception: self.__debug_cbexception("numhook", line) - if pieces[0] in zero: - zero[pieces[0]](pieces) - elif pieces[1] in one: - one[pieces[1]](pieces) + if numeric in dispatch: + dispatch[numeric](pieces) def _gotconnected(self, pieces): if not self.conn.registered(): @@ -128,26 +137,38 @@ class Bot(object): self.conn.send("PONG %s" % (pieces[1])) self._checknick() def _goterror(self, pieces): + # TODO: better handling, just reconnect that single bot try: self.quit("Error detected: %s" % ' '.join(pieces)) + except: pass + try: curs = self.parent.query("UPDATE bots SET connected = 0") curs.close() except: pass - sys.exit(2) - os._exit(2) + os._exit(2) # can't use sys.exit since we might be in a sub-thread def _got001(self, pieces): - pass # wait until the end of MOTD instead + # We wait until the end of MOTD instead to consider ourselves registered, but consider uptime as of 001 + self.connecttime = time.time() + def _got004(self, pieces): + self.servername = pieces[3] def _gotRegistered(self, pieces): self.conn.registered(True) - curs = self.parent.query("UPDATE bots SET connected = 1 WHERE nick = %s", (self.nick,)) + curs = self.parent.query("UPDATE bots SET connected = 1 WHERE nick = %s", (self.permnick,)) if curs: curs.close() self.conn.send("MODE %s +x" % (pieces[2])) if self.authname is not None and self.authpass is not None: - self.conn.send("AUTH %s %s" % (self.authname, self.authpass)) - for c in self.chans: - self.join(c.name) + self.conn.send(self.parent.cfg.get('erebus', 'auth_command', "AUTH %s %s") % (self.authname, self.authpass)) + if not self.parent.cfg.getboolean('erebus', 'wait_for_hidden_host'): + for c in self.chans: + self.join(c.name) + self.joined_chans = True + def _gotHiddenHost(self, pieces): + if not self.joined_chans and self.parent.cfg.getboolean('erebus', 'wait_for_hidden_host'): + for c in self.chans: + self.join(c.name) + self.joined_chans = True def _gotprivmsg(self, pieces): nick = pieces[0].split('!')[0][1:] user = self.parent.user(nick) @@ -230,10 +251,13 @@ class Bot(object): def _gotnick(self, pieces): oldnick = pieces[0].split('!')[0][1:] newnick = pieces[2][1:] - if newnick.lower() != oldnick.lower(): - self.parent.users[newnick.lower()] = self.parent.users[oldnick.lower()] - del self.parent.users[oldnick.lower()] - self.parent.users[newnick.lower()].nickchange(newnick) + if oldnick == self.nick: + self.nick = newnick + else: + if newnick.lower() != oldnick.lower(): + self.parent.users[newnick.lower()] = self.parent.users[oldnick.lower()] + del self.parent.users[oldnick.lower()] + self.parent.users[newnick.lower()].nickchange(newnick) def _gotmode(self, pieces): source = pieces[0].split('!')[0][1:] chan = pieces[2] @@ -280,7 +304,7 @@ class Bot(object): if msg.startswith("\001"): #ctcp msg = msg.strip("\001") if msg == "VERSION": - self.msg(user, "\001VERSION Erebus v%d.%d - http://github.com/zonidjan/erebus" % (self.parent.APIVERSION, self.parent.RELEASE)) + self.msg(user, "\001VERSION Erebus v%d.%d - http://jfr.im/git/erebus.git" % (self.parent.APIVERSION, self.parent.RELEASE)) return triggerused = msg.startswith(self.parent.trigger) @@ -313,8 +337,8 @@ class Bot(object): for callback in self.parent.getchanhook(target.lower()): try: cbret = callback(self, user, chan, *pieces) - except NotImplementedError: - self.msg(user, "Command not implemented.") + if isinstance(cbret, stringbase): + self.reply(target, user, cbret) except: self.msg(user, "Command failed. Code: CBEXC%09.3f" % (time.time() % 100000)) self.__debug_cbexception("chanhook", user=user, target=target, msg=msg) @@ -334,12 +358,8 @@ class Bot(object): rancmd = True try: cbret = callback(self, user, chan, target, *pieces[1:]) - if cbret is NotImplemented: - raise NotImplementedError - elif isinstance(cbret, stringbase): - self.reply(chan, user, cbret) - except NotImplementedError: - self.msg(user, "Command not implemented.") + if isinstance(cbret, stringbase): + self.reply(target, user, cbret) except Exception: self.msg(user, "Command failed. Code: CBEXC%09.3f" % (time.time() % 100000)) self.__debug_cbexception("hook", user=user, target=target, msg=msg) @@ -364,76 +384,94 @@ class Bot(object): def reply(self, chan, user, msg): - if chan is not None: + if chan is not None and (isinstance(chan, self.parent.Channel) or (isinstance(chan, stringbase) and chan[0] == "#")): self.msg(chan, "%s: %s" % (user, msg)) else: self.msg(user, msg) - def msg(self, target, msg): - if self.parent.cfg.getboolean('erebus', 'nofakelag'): return self.fastmsg(target, msg) - cmd = self._formatmsg(target, msg) - if len(cmd) > MAXLEN: return False - if self.conn.exceeded or self.conn.bytessent+len(cmd) >= self.conn.recvq: - self.msgqueue.append(cmd) - else: - self.conn.send(cmd) - self.conn.exceeded = True - return True + """ + Does the work for msg/slowmsg/fastmsg. Uses the append_callback to append to the correct queue. - def slowmsg(self, target, msg): + 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. + """ + def _msg(self, target, msg, truncate, append_callback, msgtype): if self.parent.cfg.getboolean('erebus', 'nofakelag'): return self.fastmsg(target, msg) - cmd = self._formatmsg(target, msg) - if len(cmd) > MAXLEN: return False + + cmd = self._formatmsg(target, msg, msgtype) + # The max length is much shorter than recvq (510) because of the length the server adds on about the source (us). + # If you know your hostmask, you can of course figure the exact length, but it's very difficult to reliably know your hostmask. + maxlen = ( + self.conn.recvq + - 63 # max hostname len + - 11 # max ident len + - 3 # the symbols in :nick!user@host + - len(self.nick) + ) + if len(cmd) > maxlen: + if not truncate: + return False + else: + cmd = cmd[:maxlen] + if self.conn.exceeded or self.conn.bytessent+len(cmd) >= self.conn.recvq: - self.slowmsgqueue.append(cmd) + append_callback(cmd) else: self.conn.send(cmd) - self.conn.exceeded = True - return True - def fastmsg(self, target, msg): - cmd = self._formatmsg(target, msg) - if len(cmd) > MAXLEN: return False - self.conn.send(cmd) self.conn.exceeded = True return True - def _formatmsg(self, target, msg): + def msg(self, target, msg, truncate=False, *, msgtype=None): + """msgtype must be a valid IRC command, i.e. NOTICE or PRIVMSG; or leave as None to use default""" + return self._msg(target, msg, truncate, self.msgqueue.append, msgtype) + + def slowmsg(self, target, msg, truncate=False, *, msgtype=None): + return self._msg(target, msg, truncate, self.slowmsgqueue.append, msgtype) + + def fastmsg(self, target, msg, truncate=False, *, msgtype=None): + return self._msg(target, msg, truncate, self.conn.send, msgtype) + + def _formatmsg(self, target, msg, msgtype): if target is None or msg is None: return self.__debug_nomsg(target, msg) target = str(target) - if target.startswith('#'): command = "PRIVMSG %s :%s" % (target, msg) + if msgtype is not None: command = "%s %s :%s" % (msgtype, target, msg) + elif target.startswith('#'): command = "PRIVMSG %s :%s" % (target, msg) else: command = "NOTICE %s :%s" % (target, msg) return command def _popmsg(self): - self.makemsgtimer() + self._makemsgtimer() self.conn.bytessent -= self.conn.recvq/3 if self.conn.bytessent < 0: self.conn.bytessent = 0 - self.conn.exceeded = False + self.conn.exceeded = True + cmd = None try: cmd = self.msgqueue.popleft() - if not self.conn.exceeded and self.conn.bytessent+len(cmd) < self.conn.recvq: - self.conn.send(cmd) - self.conn.exceeded = True - else: raise IndexError except IndexError: try: cmd = self.slowmsgqueue.popleft() - if not self.conn.exceeded and self.conn.bytessent+len(cmd) < self.conn.recvq: - self.conn.send(cmd) - self.conn.exceeded = True except IndexError: pass - self.msgtimer.start() - def makemsgtimer(self): - self.msgtimer = threading.Timer(3, self._popmsg) - self.msgtimer.daemon = True + if cmd is not None: + if self.conn.bytessent+len(cmd) > self.conn.recvq: # If it's too long + if len(cmd) > self.conn.recvq: # Is the command itself somehow over max length??? + self._msgtimer.start() + raise ValueError('Somehow a command that was too long made it into the message queue. Uhoh!', cmd) + # Discard the message. + self.msgqueue.appendleft(cmd) # Phew, we've just sent too much recently. Put it (back) on the (primary) queue. + else: + self.conn.send(cmd) + + self._msgtimer.start() + + def _makemsgtimer(self): + self._msgtimer = MyTimer(3, self._popmsg) def join(self, chan): self.conn.send("JOIN %s" % (chan)) @@ -450,7 +488,7 @@ class Bot(object): class BotConnection(object): def __init__(self, parent, bind, server, port): self.parent = parent - self.buffer = bytearray(8192) + self.buffer = bytearray() self.socket = None self.bind = bind @@ -460,11 +498,21 @@ class BotConnection(object): self.state = 0 # 0=disconnected, 1=registering, 2=connected self.bytessent = 0 - self.recvq = 500 + self.recvq = 510 self.exceeded = False + self._nowrite = False def connect(self): - self.socket = socket.socket(socket.AF_INET, socket.SOCK_STREAM) + if self.parent.parent.cfg.getboolean('erebus', 'tls'): + import ssl + undersocket = socket.socket(socket.AF_INET, socket.SOCK_STREAM) + context = ssl.create_default_context() + self.socket = context.wrap_socket(undersocket, server_hostname=self.server) + else: + self.socket = socket.socket(socket.AF_INET, socket.SOCK_STREAM) + 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. + self.socket.setsockopt(socket.SOL_SOCKET, socket.SO_LINGER, struct.pack('ii', 0, 0)) + self.socket.setsockopt(socket.SOL_SOCKET, socket.SO_KEEPALIVE, 1) self.socket.bind((self.bind, 0)) self.socket.connect((self.server, self.port)) return True @@ -480,10 +528,18 @@ class BotConnection(object): return self.state == 2 def send(self, line): - if self.parent.parent.cfg.getboolean('debug', 'io'): - self.parent.log('O', line) - self.bytessent += len(line) - self._write(line) + if not self._nowrite: + if self.parent.parent.cfg.getboolean('debug', 'io'): + self.parent.log('O', line) + self.bytessent += len(line) + try: + self._write(line) + except socket.error as e: + self._nowrite = True + self.parent._goterror(repr(e)) + else: + if self.parent.parent.cfg.getboolean('debug', 'io'): + self.parent.log('X', line) def _write(self, line): self.socket.sendall(line.encode('utf-8', 'backslashreplace')+b"\r\n")