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