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