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