bot.py

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