X-Git-Url: https://jfr.im/git/erebus.git/blobdiff_plain/24b74bb30ce43c47dae6a7b93452012b07c505d6..8b8ff79e13341645e2b5fce2b1a94a8ce52987c1:/bot.py diff --git a/bot.py b/bot.py index c753fe1..2feb253 100644 --- a/bot.py +++ b/bot.py @@ -3,7 +3,7 @@ # Erebus IRC bot - Author: John Runyon # "Bot" and "BotConnection" classes (handling a specific "arm") -import socket, sys, time, threading +import socket, sys, time, threading, os, random from collections import deque #bots = {'erebus': bot.Bot(nick='Erebus', user='erebus', bind='', server='irc.quakenet.org', port=6667, realname='Erebus')} @@ -11,6 +11,7 @@ class Bot(object): def __init__(self, parent, nick, user, bind, authname, authpass, server, port, realname): self.parent = parent self.nick = nick + self.permnick = nick self.user = user self.realname = realname @@ -22,13 +23,25 @@ class Bot(object): chansres = curs.fetchall() curs.close() self.chans = [self.parent.newchannel(self, row['chname']) for row in chansres] + else: + self.chans = [] self.conn = BotConnection(self, bind, server, port) self.msgqueue = deque() + self.slowmsgqueue = deque() self.makemsgtimer() + self.msgtimer.start() + + def __del__(self): + curs = self.parent.db.cursor() + curs.execute("UPDATE bots SET connected = 0 WHERE nick = %s", (self.nick,)) + curs.close() + def log(self, *args, **kwargs): + self.parent.log(self.nick, *args, **kwargs) + def connect(self): if self.conn.connect(): self.parent.newfd(self, self.conn.socket.fileno()) @@ -36,85 +49,197 @@ class Bot(object): def getdata(self): return self.conn.read() + 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): + self.log('I', line) pieces = line.split() - if not self.conn.registered() and pieces[0] == "NOTICE": - self.conn.register() - return + # dispatch dict + zero = { #things to look for without source + 'NOTICE': self._gotconnected, + 'PING': self._gotping, + 'ERROR': self._goterror, + } + one = { #things to look for after source + '001': self._got001, + '376': self._gotRegistered, + '422': self._gotRegistered, + 'PRIVMSG': self._gotprivmsg, + '353': self._got353, #NAMES + '354': self._got354, #WHO + '433': self._got433, #nick in use + 'JOIN': self._gotjoin, + 'PART': self._gotpart, + 'KICK': self._gotkick, + 'QUIT': self._gotquit, + 'NICK': self._gotnick, + 'MODE': self._gotmode, + } if self.parent.hasnumhook(pieces[1]): hooks = self.parent.getnumhook(pieces[1]) for callback in hooks: - callback(self, line) - - if pieces[1] == "001": - self.conn.registered(True) - 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) - - elif pieces[1] == "PRIVMSG": - nick = pieces[0].split('!')[0][1:] - user = self.parent.user(nick) - target = pieces[2] - msg = ' '.join(pieces[3:])[1:] - self.parsemsg(user, target, msg) - - elif pieces[0] == "PING": - self.conn.send("PONG %s" % (pieces[1])) - - elif pieces[1] == "354": # WHOX - qt = pieces[3] - nick = pieces[4] - auth = pieces[5] - self.parent.user(nick).authed(auth) - - elif pieces[1] == "JOIN": - nick = pieces[0].split('!')[0][1:] - chan = self.parent.channel(pieces[2]) - - if nick == self.nick: - self.conn.send("WHO %s c%%ant,1" % (chan)) + 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) + + def _gotconnected(self, pieces): + if not self.conn.registered(): + self.conn.register() + def _gotping(self, pieces): + self.conn.send("PONG %s" % (pieces[1])) + self._checknick() + def _goterror(self, pieces): #TODO handle more gracefully + curs = self.parent.db.cursor() + curs.execute("UPDATE bots SET connected = 0") + curs.close() + sys.exit(2) + os._exit(2) + def _got001(self, pieces): + pass # wait until the end of MOTD instead + def _gotRegistered(self, pieces): + self.conn.registered(True) + + curs = self.parent.db.cursor() + curs.execute("UPDATE bots SET connected = 1 WHERE nick = %s", (self.nick,)) + 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) + def _gotprivmsg(self, pieces): + nick = pieces[0].split('!')[0][1:] + user = self.parent.user(nick) + target = pieces[2] + msg = ' '.join(pieces[3:])[1:] + self.parsemsg(user, target, msg) + def _got353(self, pieces): + chan = self.parent.channel(pieces[4]) + names = pieces[5:] + names[0] = names[0][1:] #remove colon + for n in names: + user = self.parent.user(n.lstrip('@+')) + if n[0] == '@': + chan.userjoin(user, 'op') + elif n[0] == '+': + chan.userjoin(user, 'voice') else: - user = self.parent.user(nick, justjoined=True) chan.userjoin(user) - user.join(chan) - - elif pieces[1] == "PART": - nick = pieces[0].split('!')[0][1:] - chan = self.parent.channel(pieces[2]) - - if nick != self.nick: - self.parent.user(nick).part(chan) - chan.userpart(self.parent.user(nick)) - - elif pieces[1] == "QUIT": - nick = pieces[0].split('!')[0][1:] - if nick != self.nick: + user.join(chan) + def _got354(self, pieces): + qt = int(pieces[3]) + if qt < 3: + nick, auth = pieces[4:6] + chan = None + else: + chan, nick, auth = pieces[4:7] + chan = self.parent.channel(chan) + user = self.parent.user(nick) + user.authed(auth) + + if chan is not None: + user.join(chan) + chan.userjoin(user) + + if qt == 2: # triggered by !auth + if user.isauthed(): + if user.glevel > 0: + self.msg(nick, "You are now known as #%s (access level: %s)" % (auth, user.glevel)) + else: + self.msg(nick, "You are now known as #%s (not staff)" % (auth)) + else: + self.msg(nick, "I tried, but you're not authed!") + def _got433(self, pieces): + if not self.conn.registered(): #we're trying to connect + newnick = "%s%d" % (self.nick, random.randint(111,999)) + self.conn.send("NICK %s" % (newnick)) + self.nick = newnick + def _gotjoin(self, pieces): + nick = pieces[0].split('!')[0][1:] + chan = self.parent.channel(pieces[2]) + + if nick == self.nick: + self.conn.send("WHO %s c%%cant,3" % (chan)) + else: + user = self.parent.user(nick, justjoined=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 gone: self.parent.user(nick).quit() del self.parent.users[nick.lower()] + def _gotpart(self, pieces): + nick = pieces[0].split('!')[0][1:] + chan = self.parent.channel(pieces[2]) + self._clientLeft(nick, chan) + def _gotkick(self, pieces): + nick = pieces[3] + chan = self.parent.channel(pieces[2]) + self._clientLeft(nick, chan) + def _gotquit(self, pieces): + nick = pieces[0].split('!')[0][1:] + if nick != self.nick: + for chan in self.parent.user(nick).chans: + chan.userpart(self.parent.user(nick)) + self.parent.user(nick).quit() + del self.parent.users[nick.lower()] + 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) + def _gotmode(self, pieces): + source = pieces[0].split('!')[0][1:] + chan = self.parent.channel(pieces[2]) + mode = pieces[3] + args = pieces[4:] + + adding = True + for c in mode: + if c == '+': + adding = True + elif c == '-': + adding = False + elif c == 'o': + if adding: + chan.userop(self.parent.user(args.pop(0))) + else: + chan.userdeop(self.parent.user(args.pop(0))) + elif c == 'v': + if adding: + chan.uservoice(self.parent.user(args.pop(0))) + else: + chan.userdevoice(self.parent.user(args.pop(0))) + else: + pass # don't care about other modes - elif pieces[1] == "NICK": - 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) - - elif pieces[0] == "ERROR": #TODO handle better - sys.exit(2) - os._exit(2) - - elif pieces[1] == "MODE": #TODO parse for ops/voices (at least) - pass + def __debug_cbexception(self, source, *args, **kwargs): + if int(self.parent.cfg.get('debug', 'cbexc', default=0)) == 1: + self.conn.send("PRIVMSG %s :%09.3f 4!!! CBEXC %s" % (self.parent.cfg.get('debug', 'owner'), time.time() % 100000, source)) + __import__('traceback').print_exc() + 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): chan = None + chanparam = None # was the channel specified as part of the command? if len(msg) == 0: return @@ -128,14 +253,12 @@ class Bot(object): if msg == "VERSION": self.msg(user, "\001VERSION Erebus v%d.%d - http://github.com/zonidjan/erebus" % (self.parent.APIVERSION, self.parent.RELEASE)) return - if len(pieces) > 1: - chanword = pieces[1] - if chanword[0] == '#': - chan = self.parent.channel(chanword) - if chan is not None: #if chan is still none, there's no bot on "chanword", and chanword is used as a parameter. - pieces.pop(1) - - else: # message was sent to a channel + if len(pieces) > 1: + chanword = pieces[1] + if chanword[0] == '#': + chanparam = self.parent.channel(chanword) + + if target != self.nick: # message was sent to a channel chan = self.parent.channel(target) try: if msg[0] == '*': # message may be addressed to bot by "*BOTNICK" trigger? @@ -145,52 +268,109 @@ class Bot(object): elif not triggerused: if self.parent.haschanhook(target.lower()): for callback in self.parent.getchanhook(target.lower()): - cbret = callback(self, user, chan, *pieces) - if cbret is NotImplemented: + try: + cbret = callback(self, user, chan, *pieces) + except NotImplementedError: self.msg(user, "Command not implemented.") + except: + self.msg(user, "Command failed. Code: CBEXC%09.3f" % (time.time() % 100000)) + self.__debug_cbexception("chanhook", user=user, target=target, msg=msg) return # not to bot, don't process! except IndexError: return # "message" is empty cmd = pieces[0].lower() - + rancmd = False if self.parent.hashook(cmd): for callback in self.parent.gethook(cmd): + if chanparam is not None and callback.needchan: + chan = chanparam + pieces.pop(1) if chan is None and callback.needchan: + rancmd = True self.msg(user, "You need to specify a channel for that command.") elif user.glevel >= callback.reqglevel and (not callback.needchan or chan.levelof(user.auth) >= callback.reqclevel): - cbret = callback(self, user, chan, target, *pieces[1:]) - if cbret is NotImplemented: + rancmd = True + try: + cbret = callback(self, user, chan, target, *pieces[1:]) + except NotImplementedError: self.msg(user, "Command not implemented.") + except Exception: + self.msg(user, "Command failed. Code: CBEXC%09.3f" % (time.time() % 100000)) + self.__debug_cbexception("hook", user=user, target=target, msg=msg) + except SystemExit as e: + curs = self.parent.db.cursor() + curs.execute("UPDATE bots SET connected = 0") + curs.close() + raise e + else: + rancmd = True + self.msg(user, "I don't know that command.") + if not rancmd: + self.msg(user, "You don't have enough access to run that command.") + + def __debug_nomsg(self, target, msg): + if int(self.parent.cfg.get('debug', 'nomsg', default=0)) == 1: + 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() def msg(self, target, msg): - if target is None or msg is None: return - - self.msgqueue.append((target,msg)) - if not self.msgtimer.is_alive(): - self.msgtimer.start() + cmd = self._formatmsg(target, msg) + 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 + + def slowmsg(self, target, msg): + cmd = self._formatmsg(target, msg) + if self.conn.exceeded or self.conn.bytessent+len(cmd) >= self.conn.recvq: + self.slowmsgqueue.append(cmd) + else: + self.conn.send(cmd) + self.conn.exceeded = True def fastmsg(self, target, msg): + self.conn.send(self._formatmsg(target, msg)) + self.conn.exceeded = True + + def _formatmsg(self, target, msg): + if target is None or msg is None: + return self.__debug_nomsg(target, msg) - if isinstance(target, self.parent.User): target = target.nick - elif isinstance(target, self.parent.Channel): target = target.name - elif not isinstance(target, basestring): raise TypeError('Bot.msg() "target" must be Erebus.User, Erebus.Channel, or string') + target = str(target) if target[0] == '#': command = "PRIVMSG %s :%s" % (target, msg) else: command = "NOTICE %s :%s" % (target, msg) - self.conn.send(command) + return command def _popmsg(self): self.makemsgtimer() + self.conn.bytessent -= self.conn.recvq/3 + if self.conn.bytessent < 0: self.conn.bytessent = 0 + self.conn.exceeded = False try: - self.fastmsg(*self.msgqueue.popleft()) - self.msgtimer.start() - except IndexError: pass + 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(2, self._popmsg) + self.msgtimer = threading.Timer(3, self._popmsg) self.msgtimer.daemon = True def join(self, chan): @@ -217,6 +397,10 @@ class BotConnection(object): self.state = 0 # 0=disconnected, 1=registering, 2=connected + self.bytessent = 0 + self.recvq = 500 + self.exceeded = False + def connect(self): self.socket = socket.socket(socket.AF_INET, socket.SOCK_STREAM) self.socket.bind((self.bind, 0)) @@ -233,11 +417,10 @@ class BotConnection(object): if done: self.state = 2 return self.state == 2 - #TODO: rewrite send() to queue def send(self, line): - print "%05.3f %s [O] %s" % (time.time() % 100000, self.parent.nick, line) - sys.stdout.flush() -# print (time.time() % 1466400000), self.parent.nick, '[O]', str(line) + self.parent.log('O', line) +# print "%09.3f %s [O] %s" % (time.time() % 100000, self.parent.nick, line) + self.bytessent += len(line) self._write(line) def _write(self, line): @@ -249,13 +432,12 @@ class BotConnection(object): while "\r\n" in self.buffer: pieces = self.buffer.split("\r\n", 1) - print "%05.3f %s [I] %s" % (time.time() % 100000, self.parent.nick, pieces[0]) - sys.stdout.flush() -# print (time.time() % 1460000000), self.parent.nick, '[I]', pieces[0] +# self.parent.log('I', pieces[0]) # replaced by statement in Bot.parse() +# print "%09.3f %s [I] %s" % (time.time() % 100000, self.parent.nick, pieces[0]) lines.append(pieces[0]) self.buffer = pieces[1] return lines - def __str__(self): return self.nick + def __str__(self): return self.parent.nick def __repr__(self): return "" % (self.socket.fileno(), self.parent.nick)