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