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 import socket, sys, time, threading, os, random
   7 from collections import deque
   8
   9 #bots = {'erebus': bot.Bot(nick='Erebus', user='erebus', bind='', server='irc.quakenet.org', port=6667, realname='Erebus')}
  10 class Bot(object):
  11         def __init__(self, parent, nick, user, bind, authname, authpass, server, port, realname):
  12                 self.parent = parent
  13                 self.nick = nick
  14                 self.permnick = 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                 else:
  27                         self.chans = []
  28
  29                 self.conn = BotConnection(self, bind, server, port)
  30
  31                 self.msgqueue = deque()
  32                 self.slowmsgqueue = deque()
  33                 self.makemsgtimer()
  34                 self.msgtimer.start()
  35
  36         def __del__(self):
  37                 curs = self.parent.db.cursor()
  38                 curs.execute("UPDATE bots SET connected = 0 WHERE nick = %s", (self.nick,))
  39                 curs.close()
  40
  41
  42         def log(self, *args, **kwargs):
  43                 self.parent.log(self.nick, *args, **kwargs)
  44
  45         def connect(self):
  46                 if self.conn.connect():
  47                         self.parent.newfd(self, self.conn.socket.fileno())
  48
  49         def getdata(self):
  50                 return self.conn.read()
  51
  52         def _checknick(self): # check if we're using the right nick, try changing
  53                 if self.nick != self.permnick and self.conn.registered():
  54                         self.conn.send("NICK %s" % (self.permnick))
  55
  56         def parse(self, line):
  57                 self.log('I', line)
  58                 pieces = line.split()
  59
  60                 # dispatch dict
  61                 zero = { #things to look for without source
  62                         'NOTICE': self._gotconnected,
  63                         'PING': self._gotping,
  64                         'ERROR': self._goterror,
  65                 }
  66                 one = { #things to look for after source
  67                         '001': self._got001,
  68                         '376': self._gotRegistered,
  69                         '422': self._gotRegistered,
  70                         'PRIVMSG': self._gotprivmsg,
  71                         '353': self._got353, #NAMES
  72                         '354': self._got354, #WHO
  73                         '433': self._got433, #nick in use
  74                         'JOIN': self._gotjoin,
  75                         'PART': self._gotpart,
  76                         'KICK': self._gotkick,
  77                         'QUIT': self._gotquit,
  78                         'NICK': self._gotnick,
  79                         'MODE': self._gotmode,
  80                 }
  81
  82                 if self.parent.hasnumhook(pieces[1]):
  83                         hooks = self.parent.getnumhook(pieces[1])
  84                         for callback in hooks:
  85                                 try:
  86                                         callback(self, line)
  87                                 except Exception:
  88                                         self.__debug_cbexception("numhook", line)
  89
  90                 if pieces[0] in zero:
  91                         zero[pieces[0]](pieces)
  92                 elif pieces[1] in one:
  93                         one[pieces[1]](pieces)
  94
  95         def _gotconnected(self, pieces):
  96                 if not self.conn.registered():
  97                         self.conn.register()
  98         def _gotping(self, pieces):
  99                 self.conn.send("PONG %s" % (pieces[1]))
 100                 self._checknick()
 101         def _goterror(self, pieces): #TODO handle more gracefully
 102                 curs = self.parent.db.cursor()
 103                 curs.execute("UPDATE bots SET connected = 0")
 104                 curs.close()
 105                 sys.exit(2)
 106                 os._exit(2)
 107         def _got001(self, pieces):
 108                 pass # wait until the end of MOTD instead
 109         def _gotRegistered(self, pieces):
 110                 self.conn.registered(True)
 111
 112                 curs = self.parent.db.cursor()
 113                 curs.execute("UPDATE bots SET connected = 1 WHERE nick = %s", (self.nick,))
 114                 curs.close()
 115
 116                 self.conn.send("MODE %s +x" % (pieces[2]))
 117                 if self.authname is not None and self.authpass is not None:
 118                         self.conn.send("AUTH %s %s" % (self.authname, self.authpass))
 119                 for c in self.chans:
 120                         self.join(c.name)
 121         def _gotprivmsg(self, pieces):
 122                 nick = pieces[0].split('!')[0][1:]
 123                 user = self.parent.user(nick)
 124                 target = pieces[2]
 125                 msg = ' '.join(pieces[3:])[1:]
 126                 self.parsemsg(user, target, msg)
 127         def _got353(self, pieces):
 128                 chan = self.parent.channel(pieces[4])
 129                 names = pieces[5:]
 130                 names[0] = names[0][1:] #remove colon
 131                 for n in names:
 132                         user = self.parent.user(n.lstrip('@+'))
 133                         if n[0] == '@':
 134                                 chan.userjoin(user, 'op')
 135                         elif n[0] == '+':
 136                                 chan.userjoin(user, 'voice')
 137                         else:
 138                                 chan.userjoin(user)
 139                         user.join(chan)
 140         def _got354(self, pieces):
 141                 qt = int(pieces[3])
 142                 if qt < 3:
 143                         nick, auth = pieces[4:6]
 144                         chan = None
 145                 else:
 146                         chan, nick, auth = pieces[4:7]
 147                         chan = self.parent.channel(chan)
 148                 user = self.parent.user(nick)
 149                 user.authed(auth)
 150
 151                 if chan is not None:
 152                         user.join(chan)
 153                         chan.userjoin(user)
 154
 155                 if qt == 2: # triggered by !auth
 156                         if user.isauthed():
 157                                 if user.glevel > 0:
 158                                         self.msg(nick, "You are now known as #%s (access level: %s)" % (auth, user.glevel))
 159                                 else:
 160                                         self.msg(nick, "You are now known as #%s (not staff)" % (auth))
 161                         else:
 162                                 self.msg(nick, "I tried, but you're not authed!")
 163         def _got433(self, pieces):
 164                 if not self.conn.registered(): #we're trying to connect
 165                         newnick = "%s%d" % (self.nick, random.randint(111,999))
 166                         self.conn.send("NICK %s" % (newnick))
 167                         self.nick = newnick
 168         def _gotjoin(self, pieces):
 169                 nick = pieces[0].split('!')[0][1:]
 170                 chan = self.parent.channel(pieces[2])
 171
 172                 if nick == self.nick:
 173                         self.conn.send("WHO %s c%%cant,3" % (chan))
 174                 else:
 175                         user = self.parent.user(nick, justjoined=True)
 176                         chan.userjoin(user)
 177                         user.join(chan)
 178         def _clientLeft(self, nick, chan):
 179                 if nick != self.nick:
 180                         gone = self.parent.user(nick).part(chan)
 181                         chan.userpart(self.parent.user(nick))
 182                         if gone:
 183                                 self.parent.user(nick).quit()
 184                                 del self.parent.users[nick.lower()]
 185         def _gotpart(self, pieces):
 186                 nick = pieces[0].split('!')[0][1:]
 187                 chan = self.parent.channel(pieces[2])
 188                 self._clientLeft(nick, chan)
 189         def _gotkick(self, pieces):
 190                 nick = pieces[3]
 191                 chan = self.parent.channel(pieces[2])
 192                 self._clientLeft(nick, chan)
 193         def _gotquit(self, pieces):
 194                 nick = pieces[0].split('!')[0][1:]
 195                 if nick != self.nick:
 196                         for chan in self.parent.user(nick).chans:
 197                                 chan.userpart(self.parent.user(nick))
 198                         self.parent.user(nick).quit()
 199                         del self.parent.users[nick.lower()]
 200         def _gotnick(self, pieces):
 201                 oldnick = pieces[0].split('!')[0][1:]
 202                 newnick = pieces[2][1:]
 203                 if newnick.lower() != oldnick.lower():
 204                         self.parent.users[newnick.lower()] = self.parent.users[oldnick.lower()]
 205                         del self.parent.users[oldnick.lower()]
 206                 self.parent.users[newnick.lower()].nickchange(newnick)
 207         def _gotmode(self, pieces):
 208                 source = pieces[0].split('!')[0][1:]
 209                 chan = self.parent.channel(pieces[2])
 210                 mode = pieces[3]
 211                 args = pieces[4:]
 212
 213                 adding = True
 214                 for c in mode:
 215                         if c == '+':
 216                                 adding = True
 217                         elif c == '-':
 218                                 adding = False
 219                         elif c == 'o':
 220                                 if adding:
 221                                         chan.userop(self.parent.user(args.pop(0)))
 222                                 else:
 223                                         chan.userdeop(self.parent.user(args.pop(0)))
 224                         elif c == 'v':
 225                                 if adding:
 226                                         chan.uservoice(self.parent.user(args.pop(0)))
 227                                 else:
 228                                         chan.userdevoice(self.parent.user(args.pop(0)))
 229                         else:
 230                                 pass # don't care about other modes
 231
 232         def __debug_cbexception(self, source, *args, **kwargs):
 233                 if int(self.parent.cfg.get('debug', 'cbexc', default=0)) == 1:
 234                         self.conn.send("PRIVMSG %s :%09.3f \ 34\1f!!! CBEXC\1f\ 3 %s" % (self.parent.cfg.get('debug', 'owner'), time.time() % 100000, source))
 235                         __import__('traceback').print_exc()
 236                         self.log('!', "CBEXC %s %r %r" % (source, args, kwargs))
 237 #                       print "%09.3f %s [!] CBEXC %s %r %r" % (time.time() % 100000, self.nick, source, args, kwargs)
 238
 239
 240         def parsemsg(self, user, target, msg):
 241                 chan = None
 242                 chanparam = None # was the channel specified as part of the command?
 243                 if len(msg) == 0:
 244                         return
 245
 246                 triggerused = msg[0] == self.parent.trigger
 247                 if triggerused: msg = msg[1:]
 248                 pieces = msg.split()
 249
 250                 if target == self.nick:
 251                         if msg[0] == "\001": #ctcp
 252                                 msg = msg.strip("\001")
 253                                 if msg == "VERSION":
 254                                         self.msg(user, "\001VERSION Erebus v%d.%d - http://github.com/zonidjan/erebus" % (self.parent.APIVERSION, self.parent.RELEASE))
 255                                 return
 256                 if len(pieces) > 1:
 257                         chanword = pieces[1]
 258                         if chanword[0] == '#':
 259                                 chanparam = self.parent.channel(chanword)
 260
 261                 if target != self.nick: # message was sent to a channel
 262                         chan = self.parent.channel(target)
 263                         try:
 264                                 if msg[0] == '*': # message may be addressed to bot by "*BOTNICK" trigger?
 265                                         if pieces[0][1:].lower() == self.nick.lower():
 266                                                 pieces.pop(0) # command actually starts with next word
 267                                                 msg = ' '.join(pieces) # command actually starts with next word
 268                                 elif not triggerused:
 269                                         if self.parent.haschanhook(target.lower()):
 270                                                 for callback in self.parent.getchanhook(target.lower()):
 271                                                         try:
 272                                                                 cbret = callback(self, user, chan, *pieces)
 273                                                         except NotImplementedError:
 274                                                                 self.msg(user, "Command not implemented.")
 275                                                         except:
 276                                                                 self.msg(user, "Command failed. Code: CBEXC%09.3f" % (time.time() % 100000))
 277                                                                 self.__debug_cbexception("chanhook", user=user, target=target, msg=msg)
 278                                         return # not to bot, don't process!
 279                         except IndexError:
 280                                 return # "message" is empty
 281
 282                 cmd = pieces[0].lower()
 283                 rancmd = False
 284                 if self.parent.hashook(cmd):
 285                         for callback in self.parent.gethook(cmd):
 286                                 if chanparam is not None and callback.needchan:
 287                                         chan = chanparam
 288                                         pieces.pop(1)
 289                                 if chan is None and callback.needchan:
 290                                         rancmd = True
 291                                         self.msg(user, "You need to specify a channel for that command.")
 292                                 elif user.glevel >= callback.reqglevel and (not callback.needchan or chan.levelof(user.auth) >= callback.reqclevel):
 293                                         rancmd = True
 294                                         try:
 295                                                 cbret = callback(self, user, chan, target, *pieces[1:])
 296                                         except NotImplementedError:
 297                                                 self.msg(user, "Command not implemented.")
 298                                         except Exception:
 299                                                 self.msg(user, "Command failed. Code: CBEXC%09.3f" % (time.time() % 100000))
 300                                                 self.__debug_cbexception("hook", user=user, target=target, msg=msg)
 301                                         except SystemExit as e:
 302                                                 curs = self.parent.db.cursor()
 303                                                 curs.execute("UPDATE bots SET connected = 0")
 304                                                 curs.close()
 305                                                 raise e
 306                 else:
 307                         rancmd = True
 308                         self.msg(user, "I don't know that command.")
 309                 if not rancmd:
 310                         self.msg(user, "You don't have enough access to run that command.")
 311
 312         def __debug_nomsg(self, target, msg):
 313                 if int(self.parent.cfg.get('debug', 'nomsg', default=0)) == 1:
 314                         self.conn.send("PRIVMSG %s :%09.3f \ 34\1f!!! NOMSG\1f\ 3 %r, %r" % (self.parent.cfg.get('debug', 'owner'), time.time() % 100000, target, msg))
 315                         self.log('!', "!!! NOMSG")
 316 #                       print "%09.3f %s [!] %s" % (time.time() % 100000, self.nick, "!!! NOMSG")
 317                         __import__('traceback').print_stack()
 318
 319         def msg(self, target, msg):
 320                 cmd = self._formatmsg(target, msg)
 321                 if self.conn.exceeded or self.conn.bytessent+len(cmd) >= self.conn.recvq:
 322                         self.msgqueue.append(cmd)
 323                 else:
 324                         self.conn.send(cmd)
 325                 self.conn.exceeded = True
 326
 327         def slowmsg(self, target, msg):
 328                 cmd = self._formatmsg(target, msg)
 329                 if self.conn.exceeded or self.conn.bytessent+len(cmd) >= self.conn.recvq:
 330                         self.slowmsgqueue.append(cmd)
 331                 else:
 332                         self.conn.send(cmd)
 333                 self.conn.exceeded = True
 334
 335         def fastmsg(self, target, msg):
 336                 self.conn.send(self._formatmsg(target, msg))
 337                 self.conn.exceeded = True
 338
 339         def _formatmsg(self, target, msg):
 340                 if target is None or msg is None:
 341                         return self.__debug_nomsg(target, msg)
 342
 343                 target = str(target)
 344
 345                 if target[0] == '#': command = "PRIVMSG %s :%s" % (target, msg)
 346                 else: command = "NOTICE %s :%s" % (target, msg)
 347
 348                 return command
 349
 350         def _popmsg(self):
 351                 self.makemsgtimer()
 352                 self.conn.bytessent -= self.conn.recvq/3
 353                 if self.conn.bytessent < 0: self.conn.bytessent = 0
 354                 self.conn.exceeded = False
 355
 356                 try:
 357                         cmd = self.msgqueue.popleft()
 358                         if not self.conn.exceeded and self.conn.bytessent+len(cmd) < self.conn.recvq:
 359                                 self.conn.send(cmd)
 360                                 self.conn.exceeded = True
 361                         else: raise IndexError
 362                 except IndexError:
 363                         try:
 364                                 cmd = self.slowmsgqueue.popleft()
 365                                 if not self.conn.exceeded and self.conn.bytessent+len(cmd) < self.conn.recvq:
 366                                         self.conn.send(cmd)
 367                                         self.conn.exceeded = True
 368                         except IndexError:
 369                                 pass
 370                 self.msgtimer.start()
 371
 372         def makemsgtimer(self):
 373                 self.msgtimer = threading.Timer(3, self._popmsg)
 374                 self.msgtimer.daemon = True
 375
 376         def join(self, chan):
 377                 self.conn.send("JOIN %s" % (chan))
 378
 379         def part(self, chan):
 380                 self.conn.send("PART %s" % (chan))
 381
 382         def quit(self, reason="Shutdown"):
 383                 self.conn.send("QUIT :%s" % (reason))
 384
 385         def __str__(self): return self.nick
 386         def __repr__(self): return "<Bot %r>" % (self.nick)
 387
 388 class BotConnection(object):
 389         def __init__(self, parent, bind, server, port):
 390                 self.parent = parent
 391                 self.buffer = ''
 392                 self.socket = None
 393
 394                 self.bind = bind
 395                 self.server = server
 396                 self.port = int(port)
 397
 398                 self.state = 0 # 0=disconnected, 1=registering, 2=connected
 399
 400                 self.bytessent = 0
 401                 self.recvq = 500
 402                 self.exceeded = False
 403
 404         def connect(self):
 405                 self.socket = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
 406                 self.socket.bind((self.bind, 0))
 407                 self.socket.connect((self.server, self.port))
 408                 return True
 409         def register(self):
 410                 if self.state == 0:
 411                         self.send("NICK %s" % (self.parent.nick))
 412                         self.send("USER %s 0 * :%s" % (self.parent.user, self.parent.realname))
 413                         self.state = 1
 414                 return True
 415
 416         def registered(self, done=False):
 417                 if done: self.state = 2
 418                 return self.state == 2
 419
 420         def send(self, line):
 421                 self.parent.log('O', line)
 422 #               print "%09.3f %s [O] %s" % (time.time() % 100000, self.parent.nick, line)
 423                 self.bytessent += len(line)
 424                 self._write(line)
 425
 426         def _write(self, line):
 427                 self.socket.sendall(line+"\r\n")
 428
 429         def read(self):
 430                 self.buffer += self.socket.recv(8192)
 431                 lines = []
 432
 433                 while "\r\n" in self.buffer:
 434                         pieces = self.buffer.split("\r\n", 1)
 435 #                       self.parent.log('I', pieces[0]) # replaced by statement in Bot.parse()
 436 #                       print "%09.3f %s [I] %s" % (time.time() % 100000, self.parent.nick, pieces[0])
 437                         lines.append(pieces[0])
 438                         self.buffer = pieces[1]
 439
 440                 return lines
 441
 442         def __str__(self): return self.parent.nick
 443         def __repr__(self): return "<BotConnection %r (%r)>" % (self.socket.fileno(), self.parent.nick)