# Erebus IRC bot - Author: John Runyon
# "Bot" and "BotConnection" classes (handling a specific "arm")
-#TODO: error checking
-
-import socket, sys
+import socket, sys, time, threading, os
+from collections import deque
#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):
+ def __init__(self, parent, nick, user, bind, authname, authpass, server, port, realname):
self.parent = parent
self.nick = nick
self.user = user
self.realname = realname
- self.chans = []
-
- chcurs = self.parent.db.cursor()
- chcurs.execute("SELECT chname FROM chans WHERE bot = %s AND active = 1", (self.nick,))
- chans = chcurs.fetchall()
- chcurs.close()
+ self.authname = authname
+ self.authpass = authpass
- for chrow in chans:
- uscurs = self.parent.db.cursor()
- uscurs.execute("SELECT user, level FROM chusers WHERE chan = %s", (chrow['chname'],))
- usrow = uscurs.fetchone()
- levels = {}
- while usrow is not None:
- levels[usrow['user']] = -usrow['level']
- usrow = uscurs.fetchone()
- uscurs.close()
- self.chans.append(self.parent.newchannel(self, chrow['chname'], levels))
+ curs = self.parent.db.cursor()
+ if curs.execute("SELECT chname FROM chans WHERE bot = %s AND active = 1", (self.nick,)):
+ chansres = curs.fetchall()
+ curs.close()
+ self.chans = [self.parent.newchannel(self, row['chname']) for row in chansres]
self.conn = BotConnection(self, bind, server, port)
+
+ self.msgqueue = deque()
+ self.slowmsgqueue = deque()
+ self.makemsgtimer()
+
+
def connect(self):
if self.conn.connect():
self.parent.newfd(self, self.conn.socket.fileno())
def parse(self, line):
pieces = line.split()
- if not self.conn.registered() and pieces[0] == "NOTICE":
- self.conn.register()
-
- elif pieces[1] == "001":
- self.conn.registered(True)
- 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]
- if auth != '0':
- 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 %%ant,1" % (chan))
- else:
- user = self.parent.user(nick, justjoined=True)
- chan.userjoin(user)
- user.join(chan)
-
+ zero = {
+ 'NOTICE': self._gotregistered,
+ 'PING': self._gotping,
+ 'ERROR': self._goterror,
+ }
+ one = {
+ '001': self._got001,
+ 'PRIVMSG': self._gotprivmsg,
+ '354': self._got354,
+ 'JOIN': self._gotjoin,
+ 'PART': self._gotpart,
+ '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[0] in zero:
+ zero[pieces[0]](pieces)
+ elif pieces[1] in one:
+ one[pieces[1]](pieces)
+
+ def _gotregistered(self, pieces):
+ if not self.conn.registered():
+ self.conn.register()
+ def _gotping(self, pieces):
+ self.conn.send("PONG %s" % (pieces[1]))
+ def _goterror(self, pieces): #TODO handle better
+ sys.exit(2)
+ os._exit(2)
+ def _got001(self, pieces):
+ 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)
+ 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 _got354(self, pieces):
+ qt, nick, auth = pieces[3:6]
+ self.parent.user(nick).authed(auth)
+ 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%%ant,1" % (chan))
+ else:
+ user = self.parent.user(nick, justjoined=True)
+ chan.userjoin(user)
+ user.join(chan)
+ def _gotpart(self, pieces):
+ 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))
+ def _gotquit(self, pieces):
+ nick = pieces[0].split('!')[0][1:]
+ if nick != self.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): #TODO parse for ops/voices (at least)
+ pass
+
+
+ def __debug_cbexception(self, *args):
+ if int(self.parent.cfg.get('debug', 'cbexc', default=0)) == 1:
+ self.conn.send("PRIVMSG DimeCadmium :%09.3f ^C4^B!!!^B^C CBEXC" % (time.time() % 100000))
+ print "%09.3f %s [!] CBEXC %r" % (time.time() % 100000, self.nick, args)
+ __import__('traceback').print_exc()
+
+
def parsemsg(self, user, target, msg):
chan = None
+ if len(msg) == 0:
+ return
+
triggerused = msg[0] == self.parent.trigger
if triggerused: msg = msg[1:]
pieces = msg.split()
if target == self.nick:
+ if msg[0] == "\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))
+ return
if len(pieces) > 1:
chanword = pieces[1]
if chanword[0] == '#':
chan = self.parent.channel(chanword)
- pieces.pop(1)
+ 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
- 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():
- pieces.pop(0) # command actually starts with next word
- msg = ' '.join(pieces) # command actually starts with next word
- elif not triggerused:
- return # not to bot, don't process!
+ chan = self.parent.channel(target)
+ try:
+ if msg[0] == '*': # message may be addressed to bot by "*BOTNICK" trigger?
+ if pieces[0][1:].lower() == self.nick.lower():
+ pieces.pop(0) # command actually starts with next word
+ msg = ' '.join(pieces) # command actually starts with next word
+ elif not triggerused:
+ if self.parent.haschanhook(target.lower()):
+ for callback in self.parent.getchanhook(target.lower()):
+ try:
+ cbret = callback(self, user, chan, *pieces)
+ if cbret is NotImplemented: self.msg(user, "Command not implemented.")
+ except:
+ self.msg(user, "Command failed. Code: CBEXC%09.3f" % (time.time() % 100000))
+ self.__debug_cbexception("chanhook", user, target, msg)
+ return # not to bot, don't process!
+ except IndexError:
+ return # "message" is empty
cmd = pieces[0].lower()
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
- cbret = callback(self, user, chan, target, *pieces[1:])
- if cbret is NotImplemented:
- self.msg(user, "Command not implemented.")
- return
-
- self.msg(user, "No such command, or you don't have access.")
+ for callback in self.parent.gethook(cmd):
+ if chan is None and callback.needchan:
+ 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):
+ try:
+ cbret = callback(self, user, chan, target, *pieces[1:])
+ if cbret is NotImplemented: 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, target, msg)
+
+ def __debug_nomsg(self, target, msg):
+ if int(self.parent.cfg.get('debug', 'nomsg', default=0)) == 1:
+ self.conn.send("PRIVMSG DimeCadmium :%09.3f \ 34\ 2!!!\ 2\ 3 NOMSG %r, %r" % (time.time() % 100000, target, msg))
+ print "%09.3f %s [!] %s" % (time.time() % 100000, self.nick, "!!! NOMSG")
+ __import__('traceback').print_stack()
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')
+ if target is None or msg is None:
+ return self.__debug_nomsg(target, msg)
+
+ self.msgqueue.append((target, msg))
+ if not self.msgtimer.is_alive():
+ self.msgtimer.start()
+
+ def slowmsg(self, target, msg):
+ if target is None or msg is None:
+ return self.__debug_nomsg(target, msg)
+
+ self.slowmsgqueue.append((target, msg))
+ if not self.msgtimer.is_alive():
+ self.msgtimer.start()
+
+ def fastmsg(self, target, msg):
+ if target is None or msg is None:
+ return self.__debug_nomsg(target, msg)
+
+ target = str(target)
+
+ if target[0] == '#': command = "PRIVMSG %s :%s" % (target, msg)
+ else: command = "NOTICE %s :%s" % (target, msg)
+
+ self.conn.send(command)
+
+ def _popmsg(self):
+ self.makemsgtimer()
+
+ try:
+ self.fastmsg(*self.msgqueue.popleft())
+ self.msgtimer.start()
+ except IndexError:
+ try:
+ self.fastmsg(*self.slowmsgqueue.popleft())
+ self.msgtimer.start()
+ except IndexError:
+ pass
+
+ def makemsgtimer(self):
+ self.msgtimer = threading.Timer(2, self._popmsg)
+ self.msgtimer.daemon = True
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.server = server
self.port = int(port)
+ self.state = 0 # 0=disconnected, 1=registering, 2=connected
+
def connect(self):
self.socket = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
self.socket.bind((self.bind, 0))
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)
+ print "%09.3f %s [O] %s" % (time.time() % 100000, self.parent.nick, line)
+ self._write(line)
- def write(self, line):
+ def _write(self, line):
self.socket.sendall(line+"\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)
- print self.parent.nick, '[I]', pieces[0]
+ while "\r\n" in self.buffer:
+ pieces = self.buffer.split("\r\n", 1)
+ print "%09.3f %s [I] %s" % (time.time() % 100000, self.parent.nick, pieces[0])
+# print (time.time() % 1460000000), self.parent.nick, '[I]', 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 "<BotConnection %r (%r)>" % (self.socket.fileno(), self.parent.nick)