]> jfr.im git - erebus.git/blobdiff - bot.py
update module loading system
[erebus.git] / bot.py
diff --git a/bot.py b/bot.py
index 10be7f6a4908207091535cc1d05f4021c53eddd5..f3df2785d42f2e1281aafbf5ed7b0962201fa66e 100644 (file)
--- a/bot.py
+++ b/bot.py
@@ -3,26 +3,38 @@
 # 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.authname = authname
+               self.authpass = authpass
+
                curs = self.parent.db.cursor()
-               curs.execute("SELECT chname FROM chans WHERE bot = %s AND active = 1", (self.nick,))
-               chansres = curs.fetchall()
+               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 __del__(self):
+               curs = self.parent.db.cursor()
+               curs.execute("UPDATE bots SET connected = 0 WHERE nick = %s", (self.nick,))
                curs.close()
 
-               self.chans = [self.parent.newchannel(self, row['chname']) for row in chansres]
 
-               self.conn = BotConnection(self, bind, server, port)
        def connect(self):
                if self.conn.connect():
                        self.parent.newfd(self, self.conn.socket.fileno())
@@ -33,48 +45,117 @@ class Bot(object):
        def parse(self, 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._gotregistered,
+                       'PING': self._gotping,
+                       'ERROR': self._goterror,
+               }
+               one = { #things to look for after source
+                       '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[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))
+                               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 _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
+               curs = self.parent.db.cursor()
+               curs.execute("UPDATE bots SET connected = 0")
+               curs.close()
+               sys.exit(2)
+               os._exit(2)
+       def _got001(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 _got354(self, pieces):
+               qt, nick, auth = pieces[3:6]
+               user = self.parent.user(nick)
+               user.authed(auth)
+               if qt == "2":
+                       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:
-                               user = self.parent.user(nick, justjoined=True)
-                               chan.userjoin(user)
-                               user.join(chan)
-                       
+                               self.msg(nick, "I tried, but you're not authed!")
+       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, source, *args, **kwargs):
+               if int(self.parent.cfg.get('debug', 'cbexc', default=0)) == 1:
+                       self.conn.send("PRIVMSG %s :%09.3f ^C4^B!!!^B^C CBEXC %s" % (self.parent.cfg.get('debug', 'owner'), time.time() % 100000, source))
+                       __import__('traceback').print_exc()
+                       print "%09.3f %s [!] CBEXC %s %r %r" % (time.time() % 100000, self.nick, source, args, kwargs)
+
+
        def parsemsg(self, user, target, msg):
                chan = None
                if len(msg) == 0:
@@ -85,6 +166,11 @@ class Bot(object):
                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] == '#':
@@ -93,16 +179,25 @@ class Bot(object):
                                                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?
+                       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)
+                                                       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 # Fix if you feel like it /BiohZn
+                               return # "message" is empty
 
                cmd = pieces[0].lower()
 
@@ -111,19 +206,68 @@ class Bot(object):
                                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):
-                                       cbret = callback(self, user, chan, target, *pieces[1:])
-                                       if cbret is NotImplemented:
+                                       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
+
+       def __debug_nomsg(self, target, msg):
+               if int(self.parent.cfg.get('debug', 'nomsg', default=0)) == 1:
+                       self.conn.send("PRIVMSG %s :%09.3f \ 34\ 2!!!\ 2\ 3 NOMSG %r, %r" % (self.parent.cfg.get('debug', 'owner'), 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 target is None or msg is None: return
+               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)
 
-               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.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))
@@ -138,8 +282,6 @@ class Bot(object):
        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 = ''
@@ -149,6 +291,8 @@ class BotConnection(object):
                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))
@@ -165,25 +309,25 @@ class BotConnection(object):
                if done: self.state = 2
                return self.state == 2
 
-       #TODO: rewrite send() to queue
        def send(self, line):
-               print self.parent.nick, '[O]', str(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)