bot.py

   1 #!/usr/bin/python
   2
   3 # Erebus IRC bot - Author: John Runyon
   4 # "Bot" and "BotConnection" classes (handling a specific "arm")
   5
   6 import socket, sys, time, threading, os
   7 from collections import deque
   8
   9 #bots = {'erebus': bot.Bot(nick='Erebus', user='erebus', bind='', server='irc.quakenet.org', port=6667, realname='Erebus')}
  10 class Bot(object):
  11         def __init__(self, parent, nick, user, bind, authname, authpass, server, port, realname):
  12                 self.parent = parent
  13                 self.nick = nick
  14                 self.user = user
  15                 self.realname = realname
  16
  17                 self.authname = authname
  18                 self.authpass = authpass
  19
  20                 curs = self.parent.db.cursor()
  21                 if curs.execute("SELECT chname FROM chans WHERE bot = %s AND active = 1", (self.nick,)):
  22                         chansres = curs.fetchall()
  23                         curs.close()
  24                         self.chans = [self.parent.newchannel(self, row['chname']) for row in chansres]
  25
  26                 self.conn = BotConnection(self, bind, server, port)
  27
  28                 self.msgqueue = deque()
  29                 self.slowmsgqueue = deque()
  30                 self.makemsgtimer()
  31
  32
  33         def connect(self):
  34                 if self.conn.connect():
  35                         self.parent.newfd(self, self.conn.socket.fileno())
  36
  37         def getdata(self):
  38                 return self.conn.read()
  39
  40         def parse(self, line):
  41                 pieces = line.split()
  42
  43                 # dispatch dict
  44                 zero = { #things to look for without source
  45                         'NOTICE': self._gotregistered,
  46                         'PING': self._gotping,
  47                         'ERROR': self._goterror,
  48                 }
  49                 one = { #things to look for after source
  50                         '001': self._got001,
  51                         'PRIVMSG': self._gotprivmsg,
  52                         '354': self._got354,
  53                         'JOIN': self._gotjoin,
  54                         'PART': self._gotpart,
  55                         'QUIT': self._gotquit,
  56                         'NICK': self._gotnick,
  57                         'MODE': self._gotmode,
  58                 }
  59
  60                 if self.parent.hasnumhook(pieces[1]):
  61                         hooks = self.parent.getnumhook(pieces[1])
  62                         for callback in hooks:
  63                                 try:
  64                                         callback(self, line)
  65                                 except Exception:
  66                                         self.__debug_cbexception("numhook", line)
  67
  68                 if pieces[0] in zero:
  69                         zero[pieces[0]](pieces)
  70                 elif pieces[1] in one:
  71                         one[pieces[1]](pieces)
  72
  73         def _gotregistered(self, pieces):
  74                 if not self.conn.registered():
  75                         self.conn.register()
  76         def _gotping(self, pieces):
  77                 self.conn.send("PONG %s" % (pieces[1]))
  78         def _goterror(self, pieces): #TODO handle better
  79                 sys.exit(2)
  80                 os._exit(2)
  81         def _got001(self, pieces):
  82                 self.conn.registered(True)
  83                 self.conn.send("MODE %s +x" % (pieces[2]))
  84                 if self.authname is not None and self.authpass is not None:
  85                         self.conn.send("AUTH %s %s" % (self.authname, self.authpass))
  86                 for c in self.chans:
  87                         self.join(c.name)
  88         def _gotprivmsg(self, pieces):
  89                 nick = pieces[0].split('!')[0][1:]
  90                 user = self.parent.user(nick)
  91                 target = pieces[2]
  92                 msg = ' '.join(pieces[3:])[1:]
  93                 self.parsemsg(user, target, msg)
  94         def _got354(self, pieces):
  95                 qt, nick, auth = pieces[3:6]
  96                 self.parent.user(nick).authed(auth)
  97         def _gotjoin(self, pieces):
  98                 nick = pieces[0].split('!')[0][1:]
  99                 chan = self.parent.channel(pieces[2])
 100
 101                 if nick == self.nick:
 102                         self.conn.send("WHO %s c%%ant,1" % (chan))
 103                 else:
 104                         user = self.parent.user(nick, justjoined=True)
 105                         chan.userjoin(user)
 106                         user.join(chan)
 107         def _gotpart(self, pieces):
 108                 nick = pieces[0].split('!')[0][1:]
 109                 chan = self.parent.channel(pieces[2])
 110
 111                 if nick != self.nick:
 112                         self.parent.user(nick).part(chan)
 113                         chan.userpart(self.parent.user(nick))
 114         def _gotquit(self, pieces):
 115                 nick = pieces[0].split('!')[0][1:]
 116                 if nick != self.nick:
 117                         self.parent.user(nick).quit()
 118                         del self.parent.users[nick.lower()]
 119         def _gotnick(self, pieces):
 120                 oldnick = pieces[0].split('!')[0][1:]
 121                 newnick = pieces[2][1:]
 122                 if newnick.lower() != oldnick.lower():
 123                         self.parent.users[newnick.lower()] = self.parent.users[oldnick.lower()]
 124                         del self.parent.users[oldnick.lower()]
 125                 self.parent.users[newnick.lower()].nickchange(newnick)
 126         def _gotmode(self, pieces): #TODO parse for ops/voices (at least)
 127                 pass
 128
 129
 130         def __debug_cbexception(self, source, *args, **kwargs):
 131                 if int(self.parent.cfg.get('debug', 'cbexc', default=0)) == 1:
 132                         self.conn.send("PRIVMSG %s :%09.3f ^C4^B!!!^B^C CBEXC %s" % (self.parent.cfg.get('debug', 'owner'), time.time() % 100000, source))
 133                         __import__('traceback').print_exc()
 134                         print "%09.3f %s [!] CBEXC %s %r %r" % (time.time() % 100000, self.nick, source, args, kwargs)
 135
 136
 137         def parsemsg(self, user, target, msg):
 138                 chan = None
 139                 if len(msg) == 0:
 140                         return
 141
 142                 triggerused = msg[0] == self.parent.trigger
 143                 if triggerused: msg = msg[1:]
 144                 pieces = msg.split()
 145
 146                 if target == self.nick:
 147                         if msg[0] == "\001": #ctcp
 148                                 msg = msg.strip("\001")
 149                                 if msg == "VERSION":
 150                                         self.msg(user, "\001VERSION Erebus v%d.%d - http://github.com/zonidjan/erebus" % (self.parent.APIVERSION, self.parent.RELEASE))
 151                                 return
 152                         if len(pieces) > 1:
 153                                 chanword = pieces[1]
 154                                 if chanword[0] == '#':
 155                                         chan = self.parent.channel(chanword)
 156                                         if chan is not None: #if chan is still none, there's no bot on "chanword", and chanword is used as a parameter.
 157                                                 pieces.pop(1)
 158
 159                 else: # message was sent to a channel
 160                         chan = self.parent.channel(target)
 161                         try:
 162                                 if msg[0] == '*': # message may be addressed to bot by "*BOTNICK" trigger?
 163                                         if pieces[0][1:].lower() == self.nick.lower():
 164                                                 pieces.pop(0) # command actually starts with next word
 165                                                 msg = ' '.join(pieces) # command actually starts with next word
 166                                 elif not triggerused:
 167                                         if self.parent.haschanhook(target.lower()):
 168                                                 for callback in self.parent.getchanhook(target.lower()):
 169                                                         try:
 170                                                                 cbret = callback(self, user, chan, *pieces)
 171                                                                 if cbret is NotImplemented: self.msg(user, "Command not implemented.")
 172                                                         except:
 173                                                                 self.msg(user, "Command failed. Code: CBEXC%09.3f" % (time.time() % 100000))
 174                                                                 self.__debug_cbexception("chanhook", user=user, target=target, msg=msg)
 175                                         return # not to bot, don't process!
 176                         except IndexError:
 177                                 return # "message" is empty
 178
 179                 cmd = pieces[0].lower()
 180
 181                 if self.parent.hashook(cmd):
 182                         for callback in self.parent.gethook(cmd):
 183                                 if chan is None and callback.needchan:
 184                                         self.msg(user, "You need to specify a channel for that command.")
 185                                 elif user.glevel >= callback.reqglevel and (not callback.needchan or chan.levelof(user.auth) >= callback.reqclevel):
 186                                         try:
 187                                                 cbret = callback(self, user, chan, target, *pieces[1:])
 188                                                 if cbret is NotImplemented: self.msg(user, "Command not implemented.")
 189                                         except Exception:
 190                                                 self.msg(user, "Command failed. Code: CBEXC%09.3f" % (time.time() % 100000))
 191                                                 self.__debug_cbexception("hook", user=user, target=target, msg=msg)
 192
 193         def __debug_nomsg(self, target, msg):
 194                 if int(self.parent.cfg.get('debug', 'nomsg', default=0)) == 1:
 195                         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))
 196                         print "%09.3f %s [!] %s" % (time.time() % 100000, self.nick, "!!! NOMSG")
 197                         __import__('traceback').print_stack()
 198
 199         def msg(self, target, msg):
 200                 if target is None or msg is None:
 201                         return self.__debug_nomsg(target, msg)
 202
 203                 self.msgqueue.append((target, msg))
 204                 if not self.msgtimer.is_alive():
 205                         self.msgtimer.start()
 206
 207         def slowmsg(self, target, msg):
 208                 if target is None or msg is None:
 209                         return self.__debug_nomsg(target, msg)
 210
 211                 self.slowmsgqueue.append((target, msg))
 212                 if not self.msgtimer.is_alive():
 213                         self.msgtimer.start()
 214
 215         def fastmsg(self, target, msg):
 216                 if target is None or msg is None:
 217                         return self.__debug_nomsg(target, msg)
 218
 219                 target = str(target)
 220
 221                 if target[0] == '#': command = "PRIVMSG %s :%s" % (target, msg)
 222                 else: command = "NOTICE %s :%s" % (target, msg)
 223
 224                 self.conn.send(command)
 225
 226         def _popmsg(self):
 227                 self.makemsgtimer()
 228
 229                 try:
 230                         self.fastmsg(*self.msgqueue.popleft())
 231                         self.msgtimer.start()
 232                 except IndexError:
 233                         try:
 234                                 self.fastmsg(*self.slowmsgqueue.popleft())
 235                                 self.msgtimer.start()
 236                         except IndexError:
 237                                 pass
 238
 239         def makemsgtimer(self):
 240                 self.msgtimer = threading.Timer(2, self._popmsg)
 241                 self.msgtimer.daemon = True
 242
 243         def join(self, chan):
 244                 self.conn.send("JOIN %s" % (chan))
 245
 246         def part(self, chan):
 247                 self.conn.send("PART %s" % (chan))
 248
 249         def quit(self, reason="Shutdown"):
 250                 self.conn.send("QUIT :%s" % (reason))
 251
 252         def __str__(self): return self.nick
 253         def __repr__(self): return "<Bot %r>" % (self.nick)
 254
 255 class BotConnection(object):
 256         def __init__(self, parent, bind, server, port):
 257                 self.parent = parent
 258                 self.buffer = ''
 259                 self.socket = None
 260
 261                 self.bind = bind
 262                 self.server = server
 263                 self.port = int(port)
 264
 265                 self.state = 0 # 0=disconnected, 1=registering, 2=connected
 266
 267         def connect(self):
 268                 self.socket = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
 269                 self.socket.bind((self.bind, 0))
 270                 self.socket.connect((self.server, self.port))
 271                 return True
 272         def register(self):
 273                 if self.state == 0:
 274                         self.send("NICK %s" % (self.parent.nick))
 275                         self.send("USER %s 0 * :%s" % (self.parent.user, self.parent.realname))
 276                         self.state = 1
 277                 return True
 278
 279         def registered(self, done=False):
 280                 if done: self.state = 2
 281                 return self.state == 2
 282
 283         def send(self, line):
 284                 print "%09.3f %s [O] %s" % (time.time() % 100000, self.parent.nick, line)
 285                 self._write(line)
 286
 287         def _write(self, line):
 288                 self.socket.sendall(line+"\r\n")
 289
 290         def read(self):
 291                 self.buffer += self.socket.recv(8192)
 292                 lines = []
 293
 294                 while "\r\n" in self.buffer:
 295                         pieces = self.buffer.split("\r\n", 1)
 296                         print "%09.3f %s [I] %s" % (time.time() % 100000, self.parent.nick, pieces[0])
 297 #                       print (time.time() % 1460000000), self.parent.nick, '[I]', pieces[0]
 298                         lines.append(pieces[0])
 299                         self.buffer = pieces[1]
 300
 301                 return lines
 302
 303         def __str__(self): return self.parent.nick
 304         def __repr__(self): return "<BotConnection %r (%r)>" % (self.socket.fileno(), self.parent.nick)