X-Git-Url: https://jfr.im/git/erebus.git/blobdiff_plain/a99afee6c437887dc90ad4b57347de9af3a09e89..3cec5bdc665d310ac628e80b007dd2d71ae7d7bd:/bot.py diff --git a/bot.py b/bot.py index 793e27f..fd92922 100644 --- a/bot.py +++ b/bot.py @@ -4,7 +4,7 @@ # Erebus IRC bot - Author: John Runyon # "Bot" and "BotConnection" classes (handling a specific "arm") -import socket, sys, time, threading, os, random, struct +import os, random, socket, struct, sys, threading, time, traceback, fcntl from collections import deque if sys.version_info.major < 3: @@ -27,6 +27,8 @@ else: #bots = {'erebus': bot.Bot(nick='Erebus', user='erebus', bind='', server='irc.quakenet.org', port=6667, realname='Erebus')} class Bot(object): def __init__(self, parent, nick, user, bind, authname, authpass, server, port, realname): + self.maxlen = 510 + self.parent = parent self.nick = nick self.permnick = nick @@ -69,7 +71,12 @@ class Bot(object): def watchdog(self): if time.time() > int(self.parent.cfg.get('watchdog', 'maxtime', default=300))+self.lastreceived: self.parse("ERROR :Fake-error from watchdog timer.") - self.watchdogtimer = MyTimer(int(self.parent.cfg.get('watchdog', 'interval', default=30)), self.watchdog) + return + if self.conn.registered(): + self.conn.send("PING :%s" % (time.time())) + self._checknick() + watchdogtimer = MyTimer(int(self.parent.cfg.get('watchdog', 'interval', default=30)), self.watchdog) + watchdogtimer.start() def log(self, *args, **kwargs): self.parent.log(self.nick, *args, **kwargs) @@ -77,19 +84,22 @@ class Bot(object): def connect(self): self.log('!', "Connecting") if self.conn.connect(): + self.log('!', "Connected") self.parent.newfd(self, self.conn.socket.fileno()) def getdata(self): - self.lastreceived = time.time() - return self.conn.read() + try: + recvd = self.conn.read() + self.lastreceived = time.time() + return recvd + except EOFError as e: + return [":%s ERROR :%s%r" % (self.nick, e.__class__.__name__, e.args)] def _checknick(self): # check if we're using the right nick, try changing if self.nick != self.permnick and self.conn.registered(): self.conn.send("NICK %s" % (self.permnick)) def parse(self, line): - if self.parent.cfg.getboolean('debug', 'io'): - self.log('I', line) pieces = line.split() if pieces[0][0] == ":": @@ -98,7 +108,7 @@ class Bot(object): numeric = pieces[0] # dispatch dict - dispatch = { #things to look for after source + dispatch = { 'NOTICE': self._gotconnected, '001': self._got001, '004': self._got004, @@ -109,6 +119,7 @@ class Bot(object): '354': self._got354, #WHO '396': self._gotHiddenHost, # hidden host has been set '433': self._got433, #nick in use + '437': self._got433, #nick protected 'JOIN': self._gotjoin, 'PART': self._gotpart, 'KICK': self._gotkick, @@ -125,7 +136,7 @@ class Bot(object): try: callback(self, line) except Exception: - self.__debug_cbexception("numhook", line) + self._cbexception("numhook", line) if numeric in dispatch: dispatch[numeric](pieces) @@ -138,14 +149,19 @@ class Bot(object): self._checknick() def _goterror(self, pieces): # TODO: better handling, just reconnect that single bot + error = ' '.join(pieces) try: - self.quit("Error detected: %s" % ' '.join(pieces)) + raise Exception(error) + except Exception as e: + self.parent.mustquit = e + try: + self.quit("Error detected: %s" % (error)) except: pass try: curs = self.parent.query("UPDATE bots SET connected = 0") curs.close() except: pass - os._exit(2) # can't use sys.exit since we might be in a sub-thread + self.log('!', 'Bot exiting due to: %s' % (error)) def _got001(self, pieces): # We wait until the end of MOTD instead to consider ourselves registered, but consider uptime as of 001 self.connecttime = time.time() @@ -223,15 +239,24 @@ class Bot(object): if nick == self.nick: self.conn.send("WHO %s c%%cant,3" % (chan)) else: - user = self.parent.user(nick, justjoined=True) + user = self.parent.user(nick, send_who=True) chan.userjoin(user) user.join(chan) def _clientLeft(self, nick, chan): - if nick != self.nick: - gone = self.parent.user(nick).part(chan) - chan.userpart(self.parent.user(nick)) + if nick == self.nick: + for u in chan.users: + if u.nick != self.nick: + self._clientLeft(u.nick, chan) + if chan.deleting: + chan.bot.chans.remove(chan) + del self.parent.chans[chan.name.lower()] + del chan + else: + user = self.parent.user(nick) + gone = user.part(chan) + chan.userpart(user) if gone: - self.parent.user(nick).quit() + user.quit() del self.parent.users[nick.lower()] def _gotpart(self, pieces): nick = pieces[0].split('!')[0][1:] @@ -285,12 +310,19 @@ class Bot(object): else: pass # don't care about other modes - def __debug_cbexception(self, source, *args, **kwargs): + def _cbexception(self, source, *args, chained=False, **kwargs): + if not chained: # skip hooks if we were caused by a hook + exc = sys.exception() + if self.parent.hasexceptionhook(exc): + for callback in self.parent.getexceptionhook(exc): + try: + callback(self, exc, source, *args, **kwargs) + except Exception: + self._cbexception('exceptionhook', chained=True, module=callback.__module__, function=callback.__name__, underlying=(source, args, kwargs)) if self.parent.cfg.getboolean('debug', 'cbexc'): self.conn.send("PRIVMSG %s :%09.3f 4!!! CBEXC %s" % (self.parent.cfg.get('debug', 'owner'), time.time() % 100000, source)) - __import__('traceback').print_exc() + traceback.print_exc(chain=not chained) self.log('!', "CBEXC %s %r %r" % (source, args, kwargs)) -# print "%09.3f %s [!] CBEXC %s %r %r" % (time.time() % 100000, self.nick, source, args, kwargs) def parsemsg(self, user, target, msg): @@ -300,12 +332,20 @@ class Bot(object): if len(msg) == 0: return - if target == self.nick: - if msg.startswith("\001"): #ctcp - msg = msg.strip("\001") - if msg == "VERSION": - self.msg(user, "\001VERSION Erebus v%d.%d - http://jfr.im/git/erebus.git" % (self.parent.APIVERSION, self.parent.RELEASE)) - return + if target == self.nick and msg.startswith("\001"): #ctcp + msg = msg.strip("\001") + if msg: + pieces = msg.split() + if pieces[0] == "CLIENTINFO": + self.msg(user, "\001CLIENTINFO VERSION PING\001") + elif pieces[0] == "VERSION": + self.msg(user, "\001VERSION Erebus v%d.%d - http://jfr.im/git/erebus.git\001" % (self.parent.APIVERSION, self.parent.RELEASE)) + elif pieces[0] == "PING": + if len(pieces) > 1: + self.msg(user, "\001PING %s\001" % (' '.join(pieces[1:]))) + else: + self.msg(user, "\001PING\001") + return triggerused = msg.startswith(self.parent.trigger) if triggerused: msg = msg[len(self.parent.trigger):] @@ -341,7 +381,7 @@ class Bot(object): 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) + self._cbexception("chanhook", user=user, target=target, msg=msg) return # not to bot, don't process! cmd = pieces[0].lower() @@ -362,8 +402,9 @@ class Bot(object): 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) + self._cbexception("hook", user=user, target=target, msg=msg) except SystemExit as e: + self.parent.mustquit = e try: curs = self.parent.query("UPDATE bots SET connected = 0") curs.close() @@ -380,7 +421,7 @@ class Bot(object): self.conn.send("PRIVMSG %s :%09.3f 4!!! NOMSG %r, %r" % (self.parent.cfg.get('debug', 'owner'), time.time() % 100000, target, msg)) self.log('!', "!!! NOMSG") # print "%09.3f %s [!] %s" % (time.time() % 100000, self.nick, "!!! NOMSG") - __import__('traceback').print_stack() + traceback.print_stack() def reply(self, chan, user, msg): @@ -395,18 +436,12 @@ class Bot(object): 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) + if self.parent.cfg.getboolean('erebus', 'nofakelag'): append_callback = self.conn.send 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). + # The max length is much shorter than conn.maxlen (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) - ) + maxlen = self.maxmsglen() if len(cmd) > maxlen: if not truncate: return False @@ -482,6 +517,15 @@ class Bot(object): def quit(self, reason="Shutdown"): self.conn.send("QUIT :%s" % (reason)) + def maxmsglen(self): + return ( + self.maxlen + - 63 # max hostname len + - 11 # max ident len + - 3 # the symbols in :nick!user@host + - len(self.nick) + ) + def __str__(self): return self.nick def __repr__(self): return "" % (self.nick) @@ -498,7 +542,7 @@ class BotConnection(object): self.state = 0 # 0=disconnected, 1=registering, 2=connected self.bytessent = 0 - self.recvq = 510 + self.recvq = 510 # How much we can send per period self.exceeded = False self._nowrite = False @@ -514,17 +558,23 @@ class BotConnection(object): 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._write_oidentd() self.socket.connect((self.server, self.port)) return True def register(self): if self.state == 0: + pss = self.parent.parent.cfg.get('erebus', 'pass') + if pss: + self.send("PASS %s" % (pss)) self.send("NICK %s" % (self.parent.nick)) self.send("USER %s 0 * :%s" % (self.parent.user, self.parent.realname)) self.state = 1 return True def registered(self, done=False): - if done: self.state = 2 + if done: + self.state = 2 + self._unwrite_oidentd() return self.state == 2 def send(self, line): @@ -542,10 +592,19 @@ class BotConnection(object): self.parent.log('X', line) def _write(self, line): - self.socket.sendall(line.encode('utf-8', 'backslashreplace')+b"\r\n") + self.socket.sendall(line.encode('utf-8', 'surrogateescape')+b"\r\n") + + def _getsockerr(self): + try: # SO_ERROR might not exist on all platforms + return self.socket.getsockopt(socket.SOL_SOCKET, socket.SO_ERROR) + except: + return None def read(self): - self.buffer += self.socket.recv(8192) + recvd = self.socket.recv(8192) + if recvd == b"": + raise EOFError("socket.recv returned empty", self.parent.nick, self._getsockerr()) + self.buffer += recvd lines = [] while b"\r\n" in self.buffer: @@ -555,5 +614,33 @@ class BotConnection(object): return lines + def _format_oidentd(self): + ident = self.parent.user + fport = self.parent.port + from_ = self.bind + lport = self.socket.getsockname()[1] + if from_: + return 'fport %s from %s lport %s { reply "%s" }\n' % (fport, from_, lport, ident) + else: + return 'fport %s lport %s { reply "%s" }\n' % (fport, lport, ident) + def _write_oidentd(self): + path = self.parent.parent.cfg.get('erebus', 'oidentd_path') + if path is not None: + with open(path, 'a') as fh: + fcntl.lockf(fh, fcntl.LOCK_EX) + fh.write(self._format_oidentd()) + fcntl.lockf(fh, fcntl.LOCK_UN) + def _unwrite_oidentd(self): + path = self.parent.parent.cfg.get('erebus', 'oidentd_path') + if path is not None: + with open(path, 'r+') as fh: + fcntl.lockf(fh, fcntl.LOCK_EX) + data = fh.read() + newdata = data.replace(self._format_oidentd(), '') + fh.seek(0) + fh.write(newdata) + fh.truncate() + fcntl.lockf(fh, fcntl.LOCK_UN) + def __str__(self): return self.parent.nick def __repr__(self): return "" % (self.socket.fileno(), self.parent.nick)