irkerd

   1 #!/usr/bin/env python
   2 """
   3 irkerd - a simple IRC multiplexer daemon
   4
   5 Listens for JSON objects of the form {'to':<irc-url>, 'privmsg':<text>}
   6 and relays messages to IRC channels. Each request must be followed by
   7 a newline.
   8
   9 The <text> must be a string.  The value of the 'to' attribute can be a
  10 string containing an IRC URL (e.g. 'irc://chat.freenet.net/botwar') or
  11 a list of such strings; in the latter case the message is broadcast to
  12 all listed channels.  Note that the channel portion of the URL need
  13 *not* have a leading '#' unless the channel name itself does.
  14
  15 Options: -d sets the debug-message level (probably only of interest to
  16 developers). The -V option prints the program version and exits.
  17
  18 Design and code by Eric S. Raymond <esr@thyrsus.com>. See the project
  19 resource page at <http://www.catb.org/~esr/irker/>.
  20
  21 Requires Python 2.6 or 2.5 with the simplejson library installed, and
  22 the irc client library at version >= 3.4 which requires 2.6: see
  23
  24 http://pypi.python.org/pypi/irc/
  25 """
  26 # These things might need tuning
  27
  28 HOST = "localhost"
  29 PORT = 6659
  30
  31 NAMESTYLE = "irker%03d"         # IRC nick template - must contain '%d'
  32 XMIT_TTL = (3 * 60 * 60)        # Time to live, seconds from last transmit
  33 PING_TTL = (15 * 60)            # Time to live, seconds from last PING
  34 HANDSHAKE_TTL = 60              # Time to live, seconds from nick transmit
  35 CHANNEL_TTL = (3 * 60 * 60)     # Time to live, seconds from last transmit
  36 DISCONNECT_TTL = (24 * 60 * 60) # Time to live, seconds from last connect
  37 UNSEEN_TTL = 60                 # Time to live, seconds since first request
  38 CHANNEL_MAX = 18                # Max channels open per socket (default)
  39 ANTI_FLOOD_DELAY = 0.5          # Anti-flood delay after transmissions, seconds
  40 ANTI_BUZZ_DELAY = 0.09          # Anti-buzz delay after queue-empty check
  41 CONNECTION_MAX = 200            # To avoid hitting a thread limit
  42
  43 # No user-serviceable parts below this line
  44
  45 version = "1.12"
  46
  47 import sys, getopt, urlparse, time, random, socket, signal
  48 import threading, Queue, SocketServer
  49 import irc.client, logging
  50 try:
  51     import simplejson as json   # Faster, also makes us Python-2.4-compatible
  52 except ImportError:
  53     import json
  54
  55 # Sketch of implementation:
  56 #
  57 # One Irker object manages multiple IRC sessions.  It holds a map of
  58 # Dispatcher objects, one per (server, port) combination, which are
  59 # responsible for routing messages to one of any number of Connection
  60 # objects that do the actual socket conversations.  The reason for the
  61 # Dispatcher layer is that IRC daemons limit the number of channels a
  62 # client (that is, from the daemon's point of view, a socket) can be
  63 # joined to, so each session to a server needs a flock of Connection
  64 # instances each with its own socket.
  65 #
  66 # Connections are timed out and removed when either they haven't seen a
  67 # PING for a while (indicating that the server may be stalled or down)
  68 # or there has been no message traffic to them for a while, or
  69 # even if the queue is nonempty but efforts to connect have failed for
  70 # a long time.
  71 #
  72 # There are multiple threads. One accepts incoming traffic from all
  73 # servers.  Each Connection also has a consumer thread and a
  74 # thread-safe message queue.  The program main appends messages to
  75 # queues as JSON requests are received; the consumer threads try to
  76 # ship them to servers.  When a socket write stalls, it only blocks an
  77 # individual consumer thread; if it stalls long enough, the session
  78 # will be timed out. This solves the biggest problem with a
  79 # single-threaded implementation, which is that you can't count on a
  80 # single stalled write not hanging all other traffic - you're at the
  81 # mercy of the length of the buffers in the TCP/IP layer.
  82 #
  83 # Message delivery is thus not reliable in the face of network stalls,
  84 # but this was considered acceptable because IRC (notoriously) has the
  85 # same problem - there is little point in reliable delivery to a relay
  86 # that is down or unreliable.
  87 #
  88 # This code uses only NICK, JOIN, PART, MODE, and PRIVMSG. It is strictly
  89 # compliant to RFC1459, except for the interpretation and use of the
  90 # DEAF and CHANLIMIT and (obsolete) MAXCHANNELS features.  CHANLIMIT
  91 # is as described in the Internet RFC draft
  92 # draft-brocklesby-irc-isupport-03 at <http://www.mirc.com/isupport.html>.
  93 # The ",isnick" feature is as described in
  94 # <http://ftp.ics.uci.edu/pub/ietf/uri/draft-mirashi-url-irc-01.txt>.
  95
  96 class Connection:
  97     def __init__(self, irkerd, servername, port):
  98         self.irker = irkerd
  99         self.servername = servername
 100         self.port = port
 101         self.nick_trial = None
 102         self.connection = None
 103         self.status = None
 104         self.last_xmit = time.time()
 105         self.last_ping = time.time()
 106         self.channels_joined = {}
 107         self.channel_limits = {}
 108         # The consumer thread
 109         self.queue = Queue.Queue()
 110         self.thread = None
 111     def nickname(self, n=None):
 112         "Return a name for the nth server connection."
 113         if n is None:
 114             n = self.nick_trial
 115         return (NAMESTYLE % n)
 116     def handle_ping(self):
 117         "Register the fact that the server has pinged this connection."
 118         self.last_ping = time.time()
 119     def handle_welcome(self):
 120         "The server says we're OK, with a non-conflicting nick."
 121         self.status = "ready"
 122         self.irker.debug(1, "nick %s accepted" % self.nickname())
 123     def handle_badnick(self):
 124         "The server says our nick has a conflict."
 125         self.irker.debug(1, "nick %s rejected" % self.nickname())
 126         # Randomness prevents a malicious user or bot from antcipating the
 127         # next trial name in order to block us from completing the handshake.
 128         self.nick_trial += random.randint(1, 3)
 129         self.last_xmit = time.time()
 130         self.connection.nick(self.nickname())
 131     def handle_disconnect(self):
 132         "Server disconnected us for flooding or some other reason."
 133         self.connection = None
 134         self.status = "disconnected"
 135     def handle_kick(self, outof):
 136         "We've been kicked."
 137         self.status = "handshaking"
 138         try:
 139             del self.channels_joined[outof]
 140         except KeyError:
 141             self.irker.logerr("kicked by %s from %s that's not joined"
 142                               % (self.servername, outof))
 143         qcopy = []
 144         while not self.queue.empty():
 145             (channel, message) = self.queue.get()
 146             if channel != outof:
 147                 qcopy.append((channel, message))
 148         for (channel, message) in qcopy:
 149             self.queue.put((channel, message))
 150         self.status = "ready"
 151     def enqueue(self, channel, message):
 152         "Enque a message for transmission."
 153         if self.thread is None or not self.thread.is_alive():
 154             self.status = "unseen"
 155             self.thread = threading.Thread(target=self.dequeue)
 156             self.thread.setDaemon(True)
 157             self.thread.start()
 158         self.queue.put((channel, message))
 159     def dequeue(self):
 160         "Try to ship pending messages from the queue."
 161         try:
 162             while True:
 163                 # We want to be kind to the IRC servers and not hold unused
 164                 # sockets open forever, so they have a time-to-live.  The
 165                 # loop is coded this particular way so that we can drop
 166                 # the actual server connection when its time-to-live
 167                 # expires, then reconnect and resume transmission if the
 168                 # queue fills up again.
 169                 if self.queue.empty():
 170                     # Queue is empty, at some point we want to time out
 171                     # the connection rather than holding a socket open in
 172                     # the server forever.
 173                     now = time.time()
 174                     xmit_timeout = now > self.last_xmit + XMIT_TTL
 175                     ping_timeout = now > self.last_ping + PING_TTL
 176                     if self.status == "disconnected":
 177                         # If the queue is empty, we can drop this connection.
 178                         self.status = "expired"
 179                         break
 180                     elif xmit_timeout or ping_timeout:
 181                         self.irker.debug(1, "timing out connection to %s at %s (ping_timeout=%s, xmit_timeout=%s)" % (self.servername, time.asctime(), ping_timeout, xmit_timeout))
 182                         with self.irker.irc.mutex:
 183                             self.connection.context = None
 184                             self.connection.quit("transmission timeout")
 185                             self.connection = None
 186                         self.status = "disconnected"
 187                     else:
 188                         # Prevent this thread from hogging the CPU by pausing
 189                         # for just a little bit after the queue-empty check.
 190                         # As long as this is less that the duration of a human
 191                         # reflex arc it is highly unlikely any human will ever
 192                         # notice.
 193                         time.sleep(ANTI_BUZZ_DELAY)
 194                 elif self.status == "disconnected" \
 195                          and time.time() > self.last_xmit + DISCONNECT_TTL:
 196                     # Queue is nonempty, but the IRC server might be
 197                     # down. Letting failed connections retain queue
 198                     # space forever would be a memory leak.
 199                     self.status = "expired"
 200                     break
 201                 elif not self.connection:
 202                     # Queue is nonempty but server isn't connected.
 203                     with self.irker.irc.mutex:
 204                         self.connection = self.irker.irc.server()
 205                         self.connection.context = self
 206                         # Try to avoid colliding with other instances
 207                         self.nick_trial = random.randint(1, 990)
 208                         self.channels_joined = {}
 209                         try:
 210                             # This will throw
 211                             # irc.client.ServerConnectionError on failure
 212                             self.connection.connect(self.servername,
 213                                                 self.port,
 214                                                 nickname=self.nickname(),
 215                                                 username="irker",
 216                                                 ircname="irker relaying client")
 217                             self.status = "handshaking"
 218                             self.irker.debug(1, "XMIT_TTL bump (%s connection) at %s" % (self.servername, time.asctime()))
 219                             self.last_xmit = time.time()
 220                             self.last_ping = time.time()
 221                         except irc.client.ServerConnectionError:
 222                             self.status = "disconnected"
 223                 elif self.status == "handshaking":
 224                     if time.time() > self.last_xmit + HANDSHAKE_TTL:
 225                         self.status = "expired"
 226                         break
 227                     else:
 228                         # Don't buzz on the empty-queue test while we're
 229                         # handshaking
 230                         time.sleep(ANTI_BUZZ_DELAY)
 231                 elif self.status == "unseen" \
 232                          and time.time() > self.last_xmit + UNSEEN_TTL:
 233                     # Nasty people could attempt a denial-of-service
 234                     # attack by flooding us with requests with invalid
 235                     # servernames. We guard against this by rapidly
 236                     # expiring connections that have a nonempty queue but
 237                     # have never had a successful open.
 238                     self.status = "expired"
 239                     break
 240                 elif self.status == "ready":
 241                     (channel, message) = self.queue.get()
 242                     if channel not in self.channels_joined:
 243                         self.connection.join(channel)
 244                         self.irker.debug(1, "joining %s on %s." % (channel, self.servername))
 245                     for segment in message.split("\n"):
 246                         self.connection.privmsg(channel, segment)
 247                         time.sleep(ANTI_FLOOD_DELAY)
 248                     self.last_xmit = self.channels_joined[channel] = time.time()
 249                     self.irker.debug(1, "XMIT_TTL bump (%s transmission) at %s" % (self.servername, time.asctime()))
 250                     self.queue.task_done()
 251         except:
 252             (exc_type, _exc_value, exc_traceback) = sys.exc_info()
 253             self.irker.logerr("exception %s in thread for %s" % \
 254                               (exc_type, self.servername))
 255             # This is so we can see tracebacks for errors inside the thread
 256             # when we need to be able to for debugging purposes.
 257             if debuglvl > 0:
 258                 raise exc_type, _exc_value, exc_traceback
 259             else:
 260                 # Maybe this should have its own status?
 261                 self.status = "expired"
 262     def live(self):
 263         "Should this connection not be scavenged?"
 264         return self.status != "expired"
 265     def joined_to(self, channel):
 266         "Is this connection joined to the specified channel?"
 267         return channel in self.channels_joined
 268     def accepting(self, channel):
 269         "Can this connection accept a join of this channel?"
 270         if self.channel_limits:
 271             match_count = 0
 272             for already in self.channels_joined:
 273                 # This obscure code is because the RFCs allow separate limits
 274                 # by channel type (indicated by the first character of the name)
 275                 # a feature that is almost never actually used.
 276                 if already[0] == channel[0]:
 277                     match_count += 1
 278             return match_count < self.channel_limits.get(channel[0], CHANNEL_MAX)
 279         else:
 280             return len(self.channels_joined) < CHANNEL_MAX
 281
 282 class Target():
 283     "Represent a transmission target."
 284     def __init__(self, url):
 285         parsed = urlparse.urlparse(url)
 286         irchost, _, ircport = parsed.netloc.partition(':')
 287         if not ircport:
 288             ircport = 6667
 289         self.servername = irchost
 290         # IRC channel names are case-insensitive.  If we don't smash
 291         # case here we may run into problems later. There was a bug
 292         # observed on irc.rizon.net where an irkerd user specified #Channel,
 293         # got kicked, and irkerd crashed because the server returned
 294         # "#channel" in the notification that our kick handler saw.
 295         self.channel = parsed.path.lstrip('/').lower()
 296         isnick = self.channel.endswith(",isnick")
 297         if isnick:
 298             self.channel = self.channel[:-7]
 299         if self.channel and not isnick and self.channel[0] not in "#&+":
 300             self.channel = "#" + self.channel
 301         self.port = int(ircport)
 302     def valid(self):
 303         "Both components must be present for a valid target."
 304         return self.servername and self.channel
 305     def server(self):
 306         "Return a hashable tuple representing the destination server."
 307         return (self.servername, self.port)
 308
 309 class Dispatcher:
 310     "Manage connections to a particular server-port combination."
 311     def __init__(self, irkerd, servername, port):
 312         self.irker = irkerd
 313         self.servername = servername
 314         self.port = port
 315         self.connections = []
 316     def dispatch(self, channel, message):
 317         "Dispatch messages for our server-port combination."
 318         # First, check if there is room for another channel
 319         # on any of our existing connections.
 320         connections = [x for x in self.connections if x.live()]
 321         eligibles = [x for x in connections if x.joined_to(channel)] \
 322                     or [x for x in connections if x.accepting(channel)]
 323         if eligibles:
 324             eligibles[0].enqueue(channel, message)
 325             return
 326         # All connections are full up. Look for one old enough to be
 327         # scavenged.
 328         ancients = []
 329         for connection in connections:
 330             for (chan, age) in connections.channels_joined.items():
 331                 if age < time.time() - CHANNEL_TTL:
 332                     ancients.append((connection, chan, age))
 333         if ancients:
 334             ancients.sort(key=lambda x: x[2])
 335             (found_connection, drop_channel, _drop_age) = ancients[0]
 336             found_connection.part(drop_channel, "scavenged by irkerd")
 337             del found_connection.channels_joined[drop_channel]
 338             #time.sleep(ANTI_FLOOD_DELAY)
 339             found_connection.enqueue(channel, message)
 340             return
 341         # Didn't find any channels with no recent activity
 342         newconn = Connection(self.irker,
 343                              self.servername,
 344                              self.port)
 345         self.connections.append(newconn)
 346         newconn.enqueue(channel, message)
 347     def live(self):
 348         "Does this server-port combination have any live connections?"
 349         self.connections = [x for x in self.connections if x.live()]
 350         return len(self.connections) > 0
 351     def last_xmit(self):
 352         "Return the time of the most recent transmission."
 353         return max(x.last_xmit for x in self.connections)
 354
 355 class Irker:
 356     "Persistent IRC multiplexer."
 357     def __init__(self, debuglevel=0):
 358         self.debuglevel = debuglevel
 359         self.irc = irc.client.IRC()
 360         self.irc.add_global_handler("ping", self._handle_ping)
 361         self.irc.add_global_handler("welcome", self._handle_welcome)
 362         self.irc.add_global_handler("erroneusnickname", self._handle_badnick)
 363         self.irc.add_global_handler("nicknameinuse", self._handle_badnick)
 364         self.irc.add_global_handler("nickcollision", self._handle_badnick)
 365         self.irc.add_global_handler("unavailresource", self._handle_badnick)
 366         self.irc.add_global_handler("featurelist", self._handle_features)
 367         self.irc.add_global_handler("disconnect", self._handle_disconnect)
 368         self.irc.add_global_handler("kick", self._handle_kick)
 369         thread = threading.Thread(target=self.irc.process_forever)
 370         thread.setDaemon(True)
 371         self.irc._thread = thread
 372         thread.start()
 373         self.servers = {}
 374     def logerr(self, errmsg):
 375         "Log a processing error."
 376         sys.stderr.write("irkerd: " + errmsg + "\n")
 377     def debug(self, level, errmsg):
 378         "Debugging information."
 379         if self.debuglevel >= level:
 380             sys.stderr.write("irkerd: %s\n" % errmsg)
 381     def _handle_ping(self, connection, _event):
 382         "PING arrived, bump the last-received time for the connection."
 383         if connection.context:
 384             connection.context.handle_ping()
 385     def _handle_welcome(self, connection, _event):
 386         "Welcome arrived, nick accepted for this connection."
 387         if connection.context:
 388             connection.context.handle_welcome()
 389     def _handle_badnick(self, connection, _event):
 390         "Nick not accepted for this connection."
 391         if connection.context:
 392             connection.context.handle_badnick()
 393     def _handle_features(self, connection, event):
 394         "Determine if and how we can set deaf mode."
 395         if connection.context:
 396             cxt = connection.context
 397             for lump in event.arguments():
 398                 if lump.startswith("DEAF="):
 399                     connection.mode(cxt.nickname(), "+"+lump[5:])
 400                 elif lump.startswith("MAXCHANNELS="):
 401                     m = int(lump[12:])
 402                     for pref in "#&+":
 403                         cxt.channel_limits[pref] = m
 404                     self.debug(1, "%s maxchannels is %d"
 405                                % (connection.server, m))
 406                 elif lump.startswith("CHANLIMIT=#:"):
 407                     limits = lump[10:].split(",")
 408                     try:
 409                         for token in limits:
 410                             (prefixes, limit) = token.split(":")
 411                             limit = int(limit)
 412                             for c in prefixes:
 413                                 cxt.channel_limits[c] = limit
 414                         self.debug(1, "%s channel limit map is %s"
 415                                    % (connection.server, cxt.channel_limits))
 416                     except ValueError:
 417                         self.logerr("ill-formed CHANLIMIT property")
 418     def _handle_disconnect(self, connection, _event):
 419         "Server hung up the connection."
 420         self.debug(1, "server %s disconnected" % connection.server)
 421         connection.close()
 422         if connection.context:
 423             connection.context.handle_disconnect()
 424     def _handle_kick(self, connection, event):
 425         "Server hung up the connection."
 426         self.debug(1, "irker has been kicked from %s on %s" % (event.target(), connection.server))
 427         if connection.context:
 428             connection.context.handle_kick(event.target())
 429     def handle(self, line):
 430         "Perform a JSON relay request."
 431         try:
 432             request = json.loads(line.strip())
 433             if not isinstance(request, dict):
 434                 self.logerr("request is not a JSON dictionary: %r" % request)
 435             elif "to" not in request or "privmsg" not in request:
 436                 self.logerr("malformed request - 'to' or 'privmsg' missing: %r" % request)
 437             else:
 438                 channels = request['to']
 439                 message = request['privmsg']
 440                 if not isinstance(channels, (list, basestring)):
 441                     self.logerr("malformed request - unexpected channel type: %r" % channels)
 442                 if not isinstance(message, basestring):
 443                     self.logerr("malformed request - unexpected message type: %r" % message)
 444                 else:
 445                     if not isinstance(channels, list):
 446                         channels = [channels]
 447                     for url in channels:
 448                         if not isinstance(url, basestring):
 449                             self.logerr("malformed request - URL has unexpected type: %r" % url)
 450                         else:
 451                             target = Target(url)
 452                             if not target.valid():
 453                                 return
 454                             if target.server() not in self.servers:
 455                                 self.servers[target.server()] = Dispatcher(self, target.servername, target.port)
 456                             self.servers[target.server()].dispatch(target.channel, message)
 457                             # GC dispatchers with no active connections
 458                             servernames = self.servers.keys()
 459                             for servername in servernames:
 460                                 if not self.servers[servername].live():
 461                                     del self.servers[servername]
 462                             # If we might be pushing a resource limit
 463                             # even after garbage collection, remove a
 464                             # session.  The goal here is to head off
 465                             # DoS attacks that aim at exhausting
 466                             # thread space or file descriptors.  The
 467                             # cost is that attempts to DoS this
 468                             # service will cause lots of join/leave
 469                             # spam as we scavenge old channels after
 470                             # connecting to new ones. The particular
 471                             # method used for selecting a session to
 472                             # be terminated doesn't matter much; we
 473                             # choose the one longest idle on the
 474                             # assumption that message activity is likely
 475                             # to be clumpy.
 476                             if len(self.servers) >= CONNECTION_MAX:
 477                                 oldest = min(self.servers.keys(), key=lambda name: self.servers[name].last_xmit())
 478                                 del self.servers[oldest]
 479         except ValueError:
 480             self.logerr("can't recognize JSON on input: %r" % line)
 481         except RuntimeError:
 482             self.logerr("wildly malformed JSON blew the parser stack.")
 483
 484 class IrkerTCPHandler(SocketServer.StreamRequestHandler):
 485     def handle(self):
 486         while True:
 487             line = self.rfile.readline()
 488             if not line:
 489                 break
 490             irker.handle(line.strip())
 491
 492 class IrkerUDPHandler(SocketServer.BaseRequestHandler):
 493     def handle(self):
 494         data = self.request[0].strip()
 495         #socket = self.request[1]
 496         irker.handle(data)
 497
 498 if __name__ == '__main__':
 499     debuglvl = 0
 500     (options, arguments) = getopt.getopt(sys.argv[1:], "d:V")
 501     for (opt, val) in options:
 502         if opt == '-d':         # Enable debug/progress messages
 503             debuglvl = int(val)
 504             if debuglvl > 1:
 505                 logging.basicConfig(level=logging.DEBUG)
 506         elif opt == '-V':       # Emit version and exit
 507             sys.stdout.write("irkerd version %s\n" % version)
 508             sys.exit(0)
 509     irker = Irker(debuglevel=debuglvl)
 510     irker.debug(1, "irkerd version %s" % version)
 511     try:
 512         tcpserver = SocketServer.TCPServer((HOST, PORT), IrkerTCPHandler)
 513         udpserver = SocketServer.UDPServer((HOST, PORT), IrkerUDPHandler)
 514         for server in [tcpserver, udpserver]:
 515             server = threading.Thread(target=server.serve_forever)
 516             server.setDaemon(True)
 517             server.start()
 518         try:
 519             signal.pause()
 520         except KeyboardInterrupt:
 521             raise SystemExit(1)
 522     except socket.error, e:
 523         sys.stderr.write("irkerd: server launch failed: %r\n" % e)
 524
 525 # end