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