bot.py

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