#!/usr/bin/python
+# vim: fileencoding=utf-8
# Erebus IRC bot - Author: John Runyon
# "Bot" and "BotConnection" classes (handling a specific "arm")
-#TODO: error checking
+import socket, sys, time, threading, os, random, struct
+from collections import deque
-import socket, sys
+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)
+ self.daemon = True
+
+if sys.version_info.major < 3:
+ stringbase = basestring
+else:
+ stringbase = str
#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, server, port, realname, chans):
+ 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
- self.chans = chans
+
+ self.authname = authname
+ self.authpass = authpass
+
+ 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()
+ self.chans = [self.parent.newchannel(self, row['chname']) for row in chansres]
+ else:
+ self.chans = []
self.conn = BotConnection(self, bind, server, port)
+
+ self.lastreceived = time.time() #time we last received a line from the server
+ self.watchdog()
+
+ self.msgqueue = deque()
+ self.slowmsgqueue = deque()
+ 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.permnick,))
+ curs.close()
+ except: pass
+
+ 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)
+
+ def log(self, *args, **kwargs):
+ 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())
def getdata(self):
- for line in self.conn.read():
- print self.nick, '[I]', line
+ self.lastreceived = time.time()
+ return self.conn.read()
- if not self.conn.registered():
- pieces = line.split()
+ 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))
- if pieces[0] == "PING":
- self.conn.send("PONG %s" % (pieces[1]))
-
- elif pieces[1] == "001":
- self.conn.registered(True)
- for c in self.chans:
- self.join(c)
-
- else:
- self.parse(line)
def parse(self, line):
+ if self.parent.cfg.getboolean('debug', 'io'):
+ self.log('I', line)
pieces = line.split()
- if 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]
- if auth != '0':
- self.parent.user(nick).authed(auth)
-
- elif pieces[1] == "JOIN":
- nick = pieces[0].split('!')[0][1:]
- user = self.parent.user(nick)
- chan = self.parent.channel(pieces[2])
-
- if nick == self.nick:
- self.conn.send("WHO %s %%ant,1" % (chan))
+ if pieces[0][0] == ":":
+ numeric = pieces[1]
+ else:
+ numeric = pieces[0]
+
+ # dispatch dict
+ dispatch = { #things to look for after source
+ 'NOTICE': self._gotconnected,
+ '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,
+ 'KICK': self._gotkick,
+ 'QUIT': self._gotquit,
+ 'NICK': self._gotnick,
+ 'MODE': self._gotmode,
+ 'PING': self._gotping,
+ 'ERROR': self._goterror,
+ }
+
+ 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 numeric in dispatch:
+ dispatch[numeric](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: 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
+ os._exit(2) # can't use sys.exit since we might be in a sub-thread
+ 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()
+ 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.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(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)
+ target = pieces[2]
+ msg = ' '.join(pieces[3:])[1:]
+ self.parsemsg(user, target, msg)
+ def _got353(self, pieces):
+ prefixes = {'@': 'op', '+': 'voice'}
+ chan = self.parent.channel(pieces[4])
+ names = pieces[5:]
+ names[0] = names[0][1:] #remove colon
+ for n in names:
+ if n[0] in prefixes:
+ user = self.parent.user(n[1:])
+ chan.userjoin(user, prefixes[n[0]])
+ else:
+ user = self.parent.user(n)
+ chan.userjoin(user)
+ 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 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]
+ if not chan.startswith("#"): return
+ 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 #TODO TODO TODO add to common chans!
-
+ pass # don't care about other modes
+
+ def __debug_cbexception(self, source, *args, **kwargs):
+ if self.parent.cfg.getboolean('debug', 'cbexc'):
+ self.conn.send("PRIVMSG %s :%09.3f \ 34\1f!!! CBEXC\1f\ 3 %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):
+ if user.glevel <= -2: return # short circuit if user is IGNORED
chan = None
- triggerused = msg[0] == self.parent.trigger
- if triggerused: msg = msg[1:]
- pieces = msg.split()
+ chanparam = None # was the channel specified as part of the command?
+ if len(msg) == 0:
+ return
if target == self.nick:
- chanword = pieces[1]
- if chanword[0] == '#':
- chan = self.parent.channel(chanword)
- pieces.pop(1)
-
- else: # message was sent to a channel
- chan = self.parent.channel(target) #TODO check if bot's on channel --- in Erebus.channel() maybe?
- if msg[0] == '*': # message may be addressed to bot by "*BOTNICK" trigger?
- if pieces[0][1:].lower() == self.nick.lower():
+ 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
+
+ triggerused = msg.startswith(self.parent.trigger)
+ if triggerused: msg = msg[len(self.parent.trigger):]
+ pieces = msg.split()
+
+ if len(pieces) == 0:
+ return
+
+ if target != self.nick: # message was sent to a channel
+ try:
+ if pieces[0][:-1].lower() == self.nick.lower() and (pieces[0][-1] == ":" or pieces[0][-1] == ","):
pieces.pop(0) # command actually starts with next word
- msg = ' '.join(pieces) # command actually starts with next word
- elif not triggerused:
+ if len(pieces) == 0: # is there still anything left?
+ return
+ msg = ' '.join(pieces)
+ triggerused = True
+ except IndexError:
+ return # "message" is empty
+
+ if len(pieces) > 1:
+ chanword = pieces[1]
+ if chanword.startswith('#'):
+ chanparam = self.parent.channel(chanword)
+
+ if target != self.nick: # message was sent to a channel
+ chan = self.parent.channel(target)
+ if not triggerused:
+ if self.parent.haschanhook(target.lower()):
+ for callback in self.parent.getchanhook(target.lower()):
+ try:
+ cbret = callback(self, user, chan, *pieces)
+ 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)
return # not to bot, don't process!
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 or callback.wantchan):
+ 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):
+ rancmd = True
+ try:
+ cbret = callback(self, user, chan, target, *pieces[1:])
+ 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)
+ except SystemExit as e:
+ try:
+ curs = self.parent.query("UPDATE bots SET connected = 0")
+ curs.close()
+ except: pass
+ 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 self.parent.cfg.getboolean('debug', 'nomsg'):
+ 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))
+ self.log('!', "!!! NOMSG")
+# print "%09.3f %s [!] %s" % (time.time() % 100000, self.nick, "!!! NOMSG")
+ __import__('traceback').print_stack()
+
+
+ def reply(self, chan, user, msg):
+ 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)
+
+ """
+ Does the work for msg/slowmsg/fastmsg. Uses the append_callback to append to the correct queue.
+
+ 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, 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]
- print "%r %r %r %r" % (cmd, user, target, msg)
+ if self.conn.exceeded or self.conn.bytessent+len(cmd) >= self.conn.recvq:
+ append_callback(cmd)
+ else:
+ self.conn.send(cmd)
- if self.parent.hashook(cmd):
- callback = self.parent.gethook(cmd)
- if chan is None and callback.needchan:
- self.msg(user, "You need to specify a channel for that command.")
- return
- if user.glevel >= callback.reqglevel:
- #TODO TODO TODO check reqclevel
- callback(self, user, chan, target, *pieces[1:])
- return
+ self.conn.exceeded = True
+ return True
- self.msg(user, "No such command, or you don't have access.")
+ 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 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.conn.bytessent -= self.conn.recvq/3
+ if self.conn.bytessent < 0: self.conn.bytessent = 0
+ self.conn.exceeded = True
+
+ cmd = None
+ try:
+ cmd = self.msgqueue.popleft()
+ except IndexError:
+ try:
+ cmd = self.slowmsgqueue.popleft()
+ except IndexError:
+ pass
+
+ 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)
- def msg(self, target, msg):
- if isinstance(target, self.parent.User): self.conn.send("NOTICE %s :%s" % (target.nick, msg))
- elif isinstance(target, self.parent.Channel): self.conn.send("PRIVMSG %s :%s" % (target.name, msg))
- elif isinstance(target, basestring):
- if target[0] == '#': self.conn.send("PRIVMSG %s :%s" % (target, msg))
- else: self.conn.send("NOTICE %s :%s" % (target, msg))
- else: raise TypeError('Bot.msg() "target" must be Erebus.User, Erebus.Channel, or string')
+ self._msgtimer.start()
+
+ def _makemsgtimer(self):
+ self._msgtimer = MyTimer(3, self._popmsg)
def join(self, chan):
self.conn.send("JOIN %s" % (chan))
def __repr__(self): return "<Bot %r>" % (self.nick)
class BotConnection(object):
- state = 0 # 0=disconnected, 1=registering, 2=connected
-
def __init__(self, parent, bind, server, port):
self.parent = parent
- self.buffer = ''
+ self.buffer = bytearray()
self.socket = None
self.bind = bind
self.server = server
self.port = int(port)
+ self.state = 0 # 0=disconnected, 1=registering, 2=connected
+
+ self.bytessent = 0
+ 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))
- 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 register(self):
+ if self.state == 0:
+ 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
return self.state == 2
- #TODO: rewrite send() to queue
def send(self, line):
- print self.parent.nick, '[O]', line
- self.write(line)
-
- def write(self, line):
- self.socket.sendall(line+"\r\n")
+ 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")
def read(self):
self.buffer += self.socket.recv(8192)
lines = []
- while '\r\n' in self.buffer:
- pieces = self.buffer.split('\r\n', 1)
- lines.append(pieces[0])
+ while b"\r\n" in self.buffer:
+ pieces = self.buffer.split(b"\r\n", 1)
+ lines.append(pieces[0].decode('utf-8', 'backslashreplace'))
self.buffer = pieces[1]
return lines
- def __str__(self): return self.nick
+ def __str__(self): return self.parent.nick
def __repr__(self): return "<BotConnection %r (%r)>" % (self.socket.fileno(), self.parent.nick)