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
   7
   8 #bots = {'erebus': bot.Bot(nick='Erebus', user='erebus', bind='', server='irc.quakenet.org', port=6667, realname='Erebus')}
   9 class Bot(object):
  10         def __init__(self, parent, nick, user, bind, authname, authpass, server, port, realname):
  11                 self.parent = parent
  12                 self.nick = nick
  13                 self.user = user
  14                 self.realname = realname
  15
  16                 self.authname = authname
  17                 self.authpass = authpass
  18
  19                 curs = self.parent.db.cursor()
  20                 if curs.execute("SELECT chname FROM chans WHERE bot = %s AND active = 1", (self.nick,)):
  21                         chansres = curs.fetchall()
  22                         curs.close()
  23                         self.chans = [self.parent.newchannel(self, row['chname']) for row in chansres]
  24
  25                 self.conn = BotConnection(self, bind, server, port)
  26         def connect(self):
  27                 if self.conn.connect():
  28                         self.parent.newfd(self, self.conn.socket.fileno())
  29
  30         def getdata(self):
  31                 return self.conn.read()
  32
  33         def parse(self, line):
  34                 pieces = line.split()
  35
  36                 if not self.conn.registered() and pieces[0] == "NOTICE":
  37                         self.conn.register()
  38                         return
  39
  40                 if self.parent.hasnumhook(pieces[1]):
  41                         hooks = self.parent.getnumhook(pieces[1])
  42                         for callback in hooks:
  43                                 callback(self, line)
  44
  45                 if pieces[1] == "001":
  46                         self.conn.registered(True)
  47                         self.conn.send("MODE %s +x" % (pieces[2]))
  48                         if self.authname is not None and self.authpass is not None:
  49                                 self.conn.send("AUTH %s %s" % (self.authname, self.authpass))
  50                         for c in self.chans:
  51                                 self.join(c.name)
  52
  53                 elif pieces[1] == "PRIVMSG":
  54                         nick = pieces[0].split('!')[0][1:]
  55                         user = self.parent.user(nick)
  56                         target = pieces[2]
  57                         msg = ' '.join(pieces[3:])[1:]
  58                         self.parsemsg(user, target, msg)
  59
  60                 elif pieces[0] == "PING":
  61                         self.conn.send("PONG %s" % (pieces[1]))
  62
  63                 elif pieces[1] == "354": # WHOX
  64                         qt = pieces[3]
  65                         nick = pieces[4]
  66                         auth = pieces[5]
  67                         self.parent.user(nick).authed(auth)
  68
  69                 elif pieces[1] == "JOIN":
  70                         nick = pieces[0].split('!')[0][1:]
  71                         chan = self.parent.channel(pieces[2])
  72
  73                         if nick == self.nick:
  74                                 self.conn.send("WHO %s c%%ant,1" % (chan))
  75                         else:
  76                                 user = self.parent.user(nick, justjoined=True)
  77                                 chan.userjoin(user)
  78                                 user.join(chan)
  79
  80                 elif pieces[1] == "PART":
  81                         nick = pieces[0].split('!')[0][1:]
  82                         chan = self.parent.channel(pieces[2])
  83
  84                         if nick != self.nick:
  85                                 self.parent.user(nick).part(chan)
  86                                 chan.userpart(self.parent.user(nick))
  87
  88                 elif pieces[1] == "QUIT":
  89                         nick = pieces[0].split('!')[0][1:]
  90                         if nick != self.nick:
  91                                 self.parent.user(nick).quit()
  92                                 del self.parent.users[nick.lower()]
  93
  94                 elif pieces[1] == "NICK":
  95                         oldnick = pieces[0].split('!')[0][1:]
  96                         newnick = pieces[2][1:]
  97                         self.parent.users[newnick.lower()] = self.parent.users[oldnick.lower()]
  98                         del self.parent.users[oldnick.lower()]
  99                         self.parent.user(newnick).nick(newnick)
 100
 101                 elif pieces[1] == "MODE": #TODO parse for ops/voices (at least)
 102                         pass
 103
 104
 105         def parsemsg(self, user, target, msg):
 106                 chan = None
 107                 if len(msg) == 0:
 108                         return
 109
 110                 triggerused = msg[0] == self.parent.trigger
 111                 if triggerused: msg = msg[1:]
 112                 pieces = msg.split()
 113
 114                 if target == self.nick:
 115                         if msg[0] == "\001": #ctcp
 116                                 msg = msg.strip("\001")
 117                                 if msg == "VERSION":
 118                                         self.msg(user, "\001VERSION Erebus v%d.%d - http://github.com/zonidjan/erebus" % (self.parent.APIVERSION, self.parent.RELEASE))
 119                                 return
 120                         if len(pieces) > 1:
 121                                 chanword = pieces[1]
 122                                 if chanword[0] == '#':
 123                                         chan = self.parent.channel(chanword)
 124                                         if chan is not None: #if chan is still none, there's no bot on "chanword", and chanword is used as a parameter.
 125                                                 pieces.pop(1)
 126
 127                 else: # message was sent to a channel
 128                         chan = self.parent.channel(target)
 129                         try:
 130                                 if msg[0] == '*': # message may be addressed to bot by "*BOTNICK" trigger?
 131                                         if pieces[0][1:].lower() == self.nick.lower():
 132                                                 pieces.pop(0) # command actually starts with next word
 133                                                 msg = ' '.join(pieces) # command actually starts with next word
 134                                 elif not triggerused:
 135                                         if self.parent.haschanhook(target.lower()):
 136                                                 for callback in self.parent.getchanhook(target.lower()):
 137                                                         cbret = callback(self, user, chan, *pieces)
 138                                                         if cbret is NotImplemented:
 139                                                                 self.msg(user, "Command not implemented.")
 140                                         return # not to bot, don't process!
 141                         except IndexError:
 142                                 return # "message" is empty
 143
 144                 cmd = pieces[0].lower()
 145
 146                 if self.parent.hashook(cmd):
 147                         for callback in self.parent.gethook(cmd):
 148                                 if chan is None and callback.needchan:
 149                                         self.msg(user, "You need to specify a channel for that command.")
 150                                 elif user.glevel >= callback.reqglevel and (not callback.needchan or chan.levelof(user.auth) >= callback.reqclevel):
 151                                         cbret = callback(self, user, chan, target, *pieces[1:])
 152                                         if cbret is NotImplemented:
 153                                                 self.msg(user, "Command not implemented.")
 154
 155         def msg(self, target, msg):
 156                 if target is None or msg is None: return
 157
 158                 if isinstance(target, self.parent.User): self.conn.send("NOTICE %s :%s" % (target.nick, msg))
 159                 elif isinstance(target, self.parent.Channel): self.conn.send("PRIVMSG %s :%s" % (target.name, msg))
 160                 elif isinstance(target, basestring):
 161                         if target[0] == '#': self.conn.send("PRIVMSG %s :%s" % (target, msg))
 162                         else: self.conn.send("NOTICE %s :%s" % (target, msg))
 163                 else: raise TypeError('Bot.msg() "target" must be Erebus.User, Erebus.Channel, or string')
 164
 165         def join(self, chan):
 166                 self.conn.send("JOIN %s" % (chan))
 167
 168         def part(self, chan):
 169                 self.conn.send("PART %s" % (chan))
 170
 171         def quit(self, reason="Shutdown"):
 172                 self.conn.send("QUIT :%s" % (reason))
 173
 174         def __str__(self): return self.nick
 175         def __repr__(self): return "<Bot %r>" % (self.nick)
 176
 177 class BotConnection(object):
 178         def __init__(self, parent, bind, server, port):
 179                 self.parent = parent
 180                 self.buffer = ''
 181                 self.socket = None
 182
 183                 self.bind = bind
 184                 self.server = server
 185                 self.port = int(port)
 186
 187                 self.state = 0 # 0=disconnected, 1=registering, 2=connected
 188
 189         def connect(self):
 190                 self.socket = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
 191                 self.socket.bind((self.bind, 0))
 192                 self.socket.connect((self.server, self.port))
 193                 return True
 194         def register(self):
 195                 if self.state == 0:
 196                         self.send("NICK %s" % (self.parent.nick))
 197                         self.send("USER %s 0 * :%s" % (self.parent.user, self.parent.realname))
 198                         self.state = 1
 199                 return True
 200
 201         def registered(self, done=False):
 202                 if done: self.state = 2
 203                 return self.state == 2
 204
 205         #TODO: rewrite send() to queue
 206         def send(self, line):
 207                 print self.parent.nick, '[O]', str(line)
 208                 self._write(line)
 209
 210         def _write(self, line):
 211                 self.socket.sendall(line+"\r\n")
 212
 213         def read(self):
 214                 self.buffer += self.socket.recv(8192)
 215                 lines = []
 216
 217                 while "\r\n" in self.buffer:
 218                         pieces = self.buffer.split("\r\n", 1)
 219                         print self.parent.nick, '[I]', pieces[0]
 220                         lines.append(pieces[0])
 221                         self.buffer = pieces[1]
 222
 223                 return lines
 224
 225         def __str__(self): return self.nick
 226         def __repr__(self): return "<BotConnection %r (%r)>" % (self.socket.fileno(), self.parent.nick)