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