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