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