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