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). -l sets a logfile to capture message traffic from
  17 channels.  -n sets the nick and -p the nickserv password. The -V
  18 option prints the program version and exits.
  19
  20 Design and code by Eric S. Raymond <esr@thyrsus.com>. See the project
  21 resource page at <http://www.catb.org/~esr/irker/>.
  22
  23 Requires Python 2.6 or 2.5 with the simplejson library installed.
  24 """
  25
  26 from __future__ import with_statement
  27
  28 # These things might need tuning
  29
  30 HOST = "localhost"
  31 PORT = 6659
  32
  33 XMIT_TTL = (3 * 60 * 60)        # Time to live, seconds from last transmit
  34 PING_TTL = (15 * 60)            # Time to live, seconds from last PING
  35 HANDSHAKE_TTL = 60              # Time to live, seconds from nick transmit
  36 CHANNEL_TTL = (3 * 60 * 60)     # Time to live, seconds from last transmit
  37 DISCONNECT_TTL = (24 * 60 * 60) # Time to live, seconds from last connect
  38 UNSEEN_TTL = 60                 # Time to live, seconds since first request
  39 CHANNEL_MAX = 18                # Max channels open per socket (default)
  40 ANTI_FLOOD_DELAY = 1.0          # Anti-flood delay after transmissions, seconds
  41 ANTI_BUZZ_DELAY = 0.09          # Anti-buzz delay after queue-empty check
  42 CONNECTION_MAX = 200            # To avoid hitting a thread limit
  43
  44 # No user-serviceable parts below this line
  45
  46 version = "2.3"
  47
  48 import sys, getopt, urlparse, time, random, socket, signal, re
  49 import threading, Queue, SocketServer, select
  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, PRIVMSG, USER, and QUIT.
  89 # It is strictly compliant to RFC1459, except for the interpretation and
  90 # use of the DEAF and CHANLIMIT and (obsolete) MAXCHANNELS features.
  91 #
  92 # CHANLIMIT is as described in the Internet RFC draft
  93 # draft-brocklesby-irc-isupport-03 at <http://www.mirc.com/isupport.html>.
  94 # The ",isnick" feature is as described in
  95 # <http://ftp.ics.uci.edu/pub/ietf/uri/draft-mirashi-url-irc-01.txt>.
  96
  97 # Historical note: the IRCClient and IRCServerConnection classes
  98 # (~270LOC) replace the overweight, overcomplicated 3KLOC mass of
  99 # irclib code that irker formerly used as a service library.  They
 100 # still look similar to parts of irclib because I contributed to that
 101 # code before giving up on it.
 102
 103 class IRCError(Exception):
 104     "An IRC exception"
 105     pass
 106
 107 class IRCClient():
 108     "An IRC client session to one or more servers."
 109     def __init__(self, debuglevel):
 110         self.mutex = threading.RLock()
 111         self.server_connections = []
 112         self.event_handlers = {}
 113         self.add_event_handler("ping",
 114                                lambda c, e: c.ship("PONG %s" % e.target))
 115         self.debuglevel = debuglevel
 116
 117     def newserver(self):
 118         "Initialize a new server-connection object."
 119         conn = IRCServerConnection(self)
 120         with self.mutex:
 121             self.server_connections.append(conn)
 122         return conn
 123
 124     def spin(self, timeout=0.2):
 125         "Spin processing data from connections forever."
 126         # Outer loop should specifically *not* be mutex-locked.
 127         # Otherwise no other thread would ever be able to change
 128         # the shared state of an IRC object running this function.
 129         while True:
 130             with self.mutex:
 131                 connected = [x for x in self.server_connections
 132                              if x is not None and x.socket is not None]
 133                 sockets = [x.socket for x in connected]
 134                 if sockets:
 135                     connmap = dict([(c.socket.fileno(), c) for c in connected])
 136                     (insocks, _o, _e) = select.select(sockets, [], [], timeout)
 137                     for s in insocks:
 138                         connmap[s.fileno()].consume()
 139                 else:
 140                     time.sleep(timeout)
 141
 142     def add_event_handler(self, event, handler):
 143         "Set a handler to be called later."
 144         with self.mutex:
 145             event_handlers = self.event_handlers.setdefault(event, [])
 146             event_handlers.append(handler)
 147
 148     def handle_event(self, connection, event):
 149         with self.mutex:
 150             h = self.event_handlers
 151             th = sorted(h.get("all_events", []) + h.get(event.type, []))
 152             for handler in th:
 153                 handler(connection, event)
 154
 155     def drop_connection(self, connection):
 156         with self.mutex:
 157             self.server_connections.remove(connection)
 158
 159     def debug(self, level, errmsg):
 160         "Debugging information."
 161         if self.debuglevel >= level:
 162             sys.stderr.write("irkerd: %s\n" % errmsg)
 163
 164 class LineBufferedStream():
 165     "Line-buffer a read stream."
 166     crlf_re = re.compile(b'\r?\n')
 167
 168     def __init__(self):
 169         self.buffer = ''
 170
 171     def append(self, newbytes):
 172         self.buffer += newbytes
 173
 174     def lines(self):
 175         "Iterate over lines in the buffer."
 176         lines = LineBufferedStream.crlf_re.split(self.buffer)
 177         self.buffer = lines.pop()
 178         return iter(lines)
 179
 180     def __iter__(self):
 181         return self.lines()
 182
 183 class IRCServerConnectionError(IRCError):
 184     pass
 185
 186 class IRCServerConnection():
 187     command_re = re.compile("^(:(?P<prefix>[^ ]+) +)?(?P<command>[^ ]+)( *(?P<argument> .+))?")
 188     # The full list of numeric-to-event mappings is in Perl's Net::IRC.
 189     # We only need to ensure that if some ancient server throws numerics
 190     # for the ones we actually want to catch, they're mapped.
 191     codemap = {
 192         "001": "welcome",
 193         "005": "featurelist",
 194         "432": "erroneusnickname",
 195         "433": "nicknameinuse",
 196         "436": "nickcollision",
 197         "437": "unavailresource",
 198     }
 199
 200     def __init__(self, master):
 201         self.master = master
 202         self.socket = None
 203
 204     def connect(self, server, port, nickname,
 205                 password=None, username=None, ircname=None):
 206         self.master.debug(2, "connect(server=%r, port=%r, nickname=%r, ...)" %
 207                           (server, port, nickname))
 208         if self.socket is not None:
 209             self.disconnect("Changing servers")
 210
 211         self.buffer = LineBufferedStream()
 212         self.event_handlers = {}
 213         self.real_server_name = ""
 214         self.server = server
 215         self.port = port
 216         self.server_address = (server, port)
 217         self.nickname = nickname
 218         self.username = username or nickname
 219         self.ircname = ircname or nickname
 220         self.password = password
 221         try:
 222             self.socket = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
 223             self.socket.bind(('', 0))
 224             self.socket.connect(self.server_address)
 225         except socket.error as err:
 226             raise IRCServerConnectionError("Couldn't connect to socket: %s" % err)
 227
 228         if self.password:
 229             self.ship("PASS " + self.password)
 230         self.nick(self.nickname)
 231         self.user(self.username, self.ircname)
 232         return self
 233
 234     def close(self):
 235         # Without this thread lock, there is a window during which
 236         # select() can find a closed socket, leading to an EBADF error.
 237         with self.master.mutex:
 238             self.disconnect("Closing object")
 239             self.master.drop_connection(self)
 240
 241     def consume(self):
 242         try:
 243             incoming = self.socket.recv(16384)
 244         except socket.error:
 245             # Server hung up on us.
 246             self.disconnect("Connection reset by peer")
 247             return
 248         if not incoming:
 249             # Dead air also indicates a connection reset.
 250             self.disconnect("Connection reset by peer")
 251             return
 252
 253         self.buffer.append(incoming)
 254
 255         for line in self.buffer:
 256             self.master.debug(2, "FROM: %s" % line)
 257
 258             if not line:
 259                 continue
 260
 261             prefix = None
 262             command = None
 263             arguments = None
 264             self.handle_event(Event("every_raw_message",
 265                                      self.real_server_name,
 266                                      None,
 267                                      [line]))
 268
 269             m = IRCServerConnection.command_re.match(line)
 270             if m.group("prefix"):
 271                 prefix = m.group("prefix")
 272                 if not self.real_server_name:
 273                     self.real_server_name = prefix
 274             if m.group("command"):
 275                 command = m.group("command").lower()
 276             if m.group("argument"):
 277                 a = m.group("argument").split(" :", 1)
 278                 arguments = a[0].split()
 279                 if len(a) == 2:
 280                     arguments.append(a[1])
 281
 282             command = IRCServerConnection.codemap.get(command, command)
 283             if command in ["privmsg", "notice"]:
 284                 target = arguments.pop(0)
 285             else:
 286                 target = None
 287
 288                 if command == "quit":
 289                     arguments = [arguments[0]]
 290                 elif command == "ping":
 291                     target = arguments[0]
 292                 else:
 293                     target = arguments[0]
 294                     arguments = arguments[1:]
 295
 296             self.master.debug(2,
 297                               "command: %s, source: %s, target: %s, arguments: %s" % (command, prefix, target, arguments))
 298             self.handle_event(Event(command, prefix, target, arguments))
 299
 300     def handle_event(self, event):
 301         self.master.handle_event(self, event)
 302         if event.type in self.event_handlers:
 303             for fn in self.event_handlers[event.type]:
 304                 fn(self, event)
 305
 306     def is_connected(self):
 307         return self.socket is not None
 308
 309     def disconnect(self, message=""):
 310         if self.socket is None:
 311             return
 312         # Don't send a QUIT here - causes infinite loop!
 313         try:
 314             self.socket.shutdown(socket.SHUT_WR)
 315             self.socket.close()
 316         except socket.error:
 317             pass
 318         del self.socket
 319         self.socket = None
 320         self.handle_event(Event("disconnect", self.server, "", [message]))
 321
 322     def join(self, channel, key=""):
 323         self.ship("JOIN %s%s" % (channel, (key and (" " + key))))
 324
 325     def mode(self, target, command):
 326         self.ship("MODE %s %s" % (target, command))
 327
 328     def nick(self, newnick):
 329         self.ship("NICK " + newnick)
 330
 331     def part(self, channel, message=""):
 332         cmd_parts = ['PART', channel]
 333         if message:
 334             cmd_parts.append(message)
 335         self.ship(' '.join(cmd_parts))
 336
 337     def privmsg(self, target, text):
 338         self.ship("PRIVMSG %s :%s" % (target, text))
 339
 340     def quit(self, message=""):
 341         self.ship("QUIT" + (message and (" :" + message)))
 342
 343     def user(self, username, realname):
 344         self.ship("USER %s 0 * :%s" % (username, realname))
 345
 346     def ship(self, string):
 347         "Ship a command to the server, appending CR/LF"
 348         try:
 349             self.socket.send(string.encode('utf-8') + b'\r\n')
 350             self.master.debug(2, "TO: %s" % string)
 351         except socket.error:
 352             self.disconnect("Connection reset by peer.")
 353
 354 class Event(object):
 355     def __init__(self, evtype, source, target, arguments=None):
 356         self.type = evtype
 357         self.source = source
 358         self.target = target
 359         if arguments is None:
 360             arguments = []
 361         self.arguments = arguments
 362
 363 def is_channel(string):
 364     return string and string[0] in "#&+!"
 365
 366 class Connection:
 367     def __init__(self, irkerd, servername, port):
 368         self.irker = irkerd
 369         self.servername = servername
 370         self.port = port
 371         self.nick_trial = None
 372         self.connection = None
 373         self.status = None
 374         self.last_xmit = time.time()
 375         self.last_ping = time.time()
 376         self.channels_joined = {}
 377         self.channel_limits = {}
 378         # The consumer thread
 379         self.queue = Queue.Queue()
 380         self.thread = None
 381     def nickname(self, n=None):
 382         "Return a name for the nth server connection."
 383         if n is None:
 384             n = self.nick_trial
 385         if fallback:
 386             return (namestyle % n)
 387         else:
 388             return namestyle
 389     def handle_ping(self):
 390         "Register the fact that the server has pinged this connection."
 391         self.last_ping = time.time()
 392     def handle_welcome(self):
 393         "The server says we're OK, with a non-conflicting nick."
 394         self.status = "ready"
 395         self.irker.irc.debug(1, "nick %s accepted" % self.nickname())
 396         if password:
 397             self.connection.privmsg("nickserv", "identify %s" % password)
 398     def handle_badnick(self):
 399         "The server says our nick is ill-formed or has a conflict."
 400         self.irker.irc.debug(1, "nick %s rejected" % self.nickname())
 401         if fallback:
 402             # Randomness prevents a malicious user or bot from
 403             # anticipating the next trial name in order to block us
 404             # from completing the handshake.
 405             self.nick_trial += random.randint(1, 3)
 406             self.last_xmit = time.time()
 407             self.connection.nick(self.nickname())
 408         # Otherwise fall through, it might be possible to
 409         # recover manually.
 410     def handle_disconnect(self):
 411         "Server disconnected us for flooding or some other reason."
 412         self.connection = None
 413         if self.status != "expired":
 414             self.status = "disconnected"
 415     def handle_kick(self, outof):
 416         "We've been kicked."
 417         self.status = "handshaking"
 418         try:
 419             del self.channels_joined[outof]
 420         except KeyError:
 421             self.irker.logerr("kicked by %s from %s that's not joined"
 422                               % (self.servername, outof))
 423         qcopy = []
 424         while not self.queue.empty():
 425             (channel, message, key) = self.queue.get()
 426             if channel != outof:
 427                 qcopy.append((channel, message, key))
 428         for (channel, message, key) in qcopy:
 429             self.queue.put((channel, message, key))
 430         self.status = "ready"
 431     def enqueue(self, channel, message, key, quit_after):
 432         "Enque a message for transmission."
 433         if self.thread is None or not self.thread.is_alive():
 434             self.status = "unseen"
 435             self.thread = threading.Thread(target=self.dequeue)
 436             self.thread.setDaemon(True)
 437             self.thread.start()
 438         self.queue.put((channel, message, key))
 439         if quit_after:
 440             self.queue.put((channel, None, key))
 441     def dequeue(self):
 442         "Try to ship pending messages from the queue."
 443         try:
 444             while True:
 445                 # We want to be kind to the IRC servers and not hold unused
 446                 # sockets open forever, so they have a time-to-live.  The
 447                 # loop is coded this particular way so that we can drop
 448                 # the actual server connection when its time-to-live
 449                 # expires, then reconnect and resume transmission if the
 450                 # queue fills up again.
 451                 if self.queue.empty():
 452                     # Queue is empty, at some point we want to time out
 453                     # the connection rather than holding a socket open in
 454                     # the server forever.
 455                     now = time.time()
 456                     xmit_timeout = now > self.last_xmit + XMIT_TTL
 457                     ping_timeout = now > self.last_ping + PING_TTL
 458                     if self.status == "disconnected":
 459                         # If the queue is empty, we can drop this connection.
 460                         self.status = "expired"
 461                         break
 462                     elif xmit_timeout or ping_timeout:
 463                         self.irker.irc.debug(1, "timing out connection to %s at %s (ping_timeout=%s, xmit_timeout=%s)" % (self.servername, time.asctime(), ping_timeout, xmit_timeout))
 464                         with self.irker.irc.mutex:
 465                             self.connection.context = None
 466                             self.connection.quit("transmission timeout")
 467                             self.connection = None
 468                         self.status = "disconnected"
 469                     else:
 470                         # Prevent this thread from hogging the CPU by pausing
 471                         # for just a little bit after the queue-empty check.
 472                         # As long as this is less that the duration of a human
 473                         # reflex arc it is highly unlikely any human will ever
 474                         # notice.
 475                         time.sleep(ANTI_BUZZ_DELAY)
 476                 elif self.status == "disconnected" \
 477                          and time.time() > self.last_xmit + DISCONNECT_TTL:
 478                     # Queue is nonempty, but the IRC server might be
 479                     # down. Letting failed connections retain queue
 480                     # space forever would be a memory leak.
 481                     self.status = "expired"
 482                     break
 483                 elif not self.connection and self.status != "expired":
 484                     # Queue is nonempty but server isn't connected.
 485                     with self.irker.irc.mutex:
 486                         self.connection = self.irker.irc.newserver()
 487                         self.connection.context = self
 488                         # Try to avoid colliding with other instances
 489                         self.nick_trial = random.randint(1, 990)
 490                         self.channels_joined = {}
 491                         try:
 492                             # This will throw
 493                             # IRCServerConnectionError on failure
 494                             self.connection.connect(self.servername,
 495                                                 self.port,
 496                                                 nickname=self.nickname(),
 497                                                 username="irker",
 498                                                 ircname="irker relaying client")
 499                             self.status = "handshaking"
 500                             self.irker.irc.debug(1, "XMIT_TTL bump (%s connection) at %s" % (self.servername, time.asctime()))
 501                             self.last_xmit = time.time()
 502                             self.last_ping = time.time()
 503                         except IRCServerConnectionError:
 504                             self.status = "expired"
 505                 elif self.status == "handshaking":
 506                     if time.time() > self.last_xmit + HANDSHAKE_TTL:
 507                         self.status = "expired"
 508                         break
 509                     else:
 510                         # Don't buzz on the empty-queue test while we're
 511                         # handshaking
 512                         time.sleep(ANTI_BUZZ_DELAY)
 513                 elif self.status == "unseen" \
 514                          and time.time() > self.last_xmit + UNSEEN_TTL:
 515                     # Nasty people could attempt a denial-of-service
 516                     # attack by flooding us with requests with invalid
 517                     # servernames. We guard against this by rapidly
 518                     # expiring connections that have a nonempty queue but
 519                     # have never had a successful open.
 520                     self.status = "expired"
 521                     break
 522                 elif self.status == "ready":
 523                     (channel, message, key) = self.queue.get()
 524                     if channel not in self.channels_joined:
 525                         self.connection.join(channel, key=key)
 526                         self.irker.irc.debug(1, "joining %s on %s." % (channel, self.servername))
 527                     # None is magic - it's a request to quit the server
 528                     if message is None:
 529                         self.connection.quit()
 530                     # An empty message might be used as a keepalive or
 531                     # to join a channel for logging, so suppress the
 532                     # privmsg send unless there is actual traffic.
 533                     elif message:
 534                         for segment in message.split("\n"):
 535                             # Truncate the message if it's too long,
 536                             # but we're working with characters here,
 537                             # not bytes, so we could be off.
 538                             # 500 = 512 - CRLF - 'PRIVMSG ' - ' :'
 539                             maxlength = 500 - len(channel)
 540                             if len(segment) > maxlength:
 541                                 segment = segment[:maxlength]
 542                             try:
 543                                 self.connection.privmsg(channel, segment)
 544                             except ValueError as err:
 545                                 self.irker.irc.debug(1, "irclib rejected a message to %s on %s because: %s" % (channel, self.servername, str(err)))
 546                                 self.irker.irc.debug(50, err.format_exc())
 547                             time.sleep(ANTI_FLOOD_DELAY)
 548                     self.last_xmit = self.channels_joined[channel] = time.time()
 549                     self.irker.irc.debug(1, "XMIT_TTL bump (%s transmission) at %s" % (self.servername, time.asctime()))
 550                     self.queue.task_done()
 551         except:
 552             (exc_type, _exc_value, exc_traceback) = sys.exc_info()
 553             self.irker.logerr("exception %s in thread for %s" % \
 554                               (exc_type, self.servername))
 555
 556             # Maybe this should have its own status?
 557             self.status = "expired"
 558
 559             # This is so we can see tracebacks for errors inside the thread
 560             # when we need to be able to for debugging purposes.
 561             if debuglvl > 0:
 562                 raise exc_type, _exc_value, exc_traceback
 563         finally:
 564             try:
 565                 # Make sure we don't leave any zombies behind
 566                 self.connection.close()
 567             except:
 568                 # Irclib has a habit of throwing fresh exceptions here. Ignore that
 569                 pass
 570     def live(self):
 571         "Should this connection not be scavenged?"
 572         return self.status != "expired"
 573     def joined_to(self, channel):
 574         "Is this connection joined to the specified channel?"
 575         return channel in self.channels_joined
 576     def accepting(self, channel):
 577         "Can this connection accept a join of this channel?"
 578         if self.channel_limits:
 579             match_count = 0
 580             for already in self.channels_joined:
 581                 # This obscure code is because the RFCs allow separate limits
 582                 # by channel type (indicated by the first character of the name)
 583                 # a feature that is almost never actually used.
 584                 if already[0] == channel[0]:
 585                     match_count += 1
 586             return match_count < self.channel_limits.get(channel[0], CHANNEL_MAX)
 587         else:
 588             return len(self.channels_joined) < CHANNEL_MAX
 589
 590 class Target():
 591     "Represent a transmission target."
 592     def __init__(self, url):
 593         # Pre-2.6 Pythons don't recognize irc: as a valid URL prefix.
 594         url = url.replace("irc://", "http://")
 595         parsed = urlparse.urlparse(url)
 596         irchost, _, ircport = parsed.netloc.partition(':')
 597         if not ircport:
 598             ircport = 6667
 599         self.servername = irchost
 600         # IRC channel names are case-insensitive.  If we don't smash
 601         # case here we may run into problems later. There was a bug
 602         # observed on irc.rizon.net where an irkerd user specified #Channel,
 603         # got kicked, and irkerd crashed because the server returned
 604         # "#channel" in the notification that our kick handler saw.
 605         self.channel = parsed.path.lstrip('/').lower()
 606         # This deals with a tweak in recent versions of urlparse.
 607         if parsed.fragment:
 608             self.channel += "#" + parsed.fragment
 609         isnick = self.channel.endswith(",isnick")
 610         if isnick:
 611             self.channel = self.channel[:-7]
 612         if self.channel and not isnick and self.channel[0] not in "#&+":
 613             self.channel = "#" + self.channel
 614         # support both channel?secret and channel?key=secret
 615         self.key = ""
 616         if parsed.query:
 617             self.key = re.sub("^key=", "", parsed.query)
 618         self.port = int(ircport)
 619     def valid(self):
 620         "Both components must be present for a valid target."
 621         return self.servername and self.channel
 622     def server(self):
 623         "Return a hashable tuple representing the destination server."
 624         return (self.servername, self.port)
 625
 626 class Dispatcher:
 627     "Manage connections to a particular server-port combination."
 628     def __init__(self, irkerd, servername, port):
 629         self.irker = irkerd
 630         self.servername = servername
 631         self.port = port
 632         self.connections = []
 633     def dispatch(self, channel, message, key, quit_after=False):
 634         "Dispatch messages for our server-port combination."
 635         # First, check if there is room for another channel
 636         # on any of our existing connections.
 637         connections = [x for x in self.connections if x.live()]
 638         eligibles = [x for x in connections if x.joined_to(channel)] \
 639                     or [x for x in connections if x.accepting(channel)]
 640         if eligibles:
 641             eligibles[0].enqueue(channel, message, key)
 642             return
 643         # All connections are full up. Look for one old enough to be
 644         # scavenged.
 645         ancients = []
 646         for connection in connections:
 647             for (chan, age) in connections.channels_joined.items():
 648                 if age < time.time() - CHANNEL_TTL:
 649                     ancients.append((connection, chan, age))
 650         if ancients:
 651             ancients.sort(key=lambda x: x[2])
 652             (found_connection, drop_channel, _drop_age) = ancients[0]
 653             found_connection.part(drop_channel, "scavenged by irkerd")
 654             del found_connection.channels_joined[drop_channel]
 655             #time.sleep(ANTI_FLOOD_DELAY)
 656             found_connection.enqueue(channel, message, key, quit_after)
 657             return
 658         # Didn't find any channels with no recent activity
 659         newconn = Connection(self.irker,
 660                              self.servername,
 661                              self.port)
 662         self.connections.append(newconn)
 663         newconn.enqueue(channel, message, key, quit_after)
 664     def live(self):
 665         "Does this server-port combination have any live connections?"
 666         self.connections = [x for x in self.connections if x.live()]
 667         return len(self.connections) > 0
 668     def pending(self):
 669         "Return all connections with pending traffic."
 670         return [x for x in self.connections if not x.queue.empty()]
 671     def last_xmit(self):
 672         "Return the time of the most recent transmission."
 673         return max(x.last_xmit for x in self.connections)
 674
 675 class Irker:
 676     "Persistent IRC multiplexer."
 677     def __init__(self, debuglevel=0):
 678         self.debuglevel = debuglevel
 679         self.irc = IRCClient(self.debuglevel)
 680         self.irc.add_event_handler("ping", self._handle_ping)
 681         self.irc.add_event_handler("welcome", self._handle_welcome)
 682         self.irc.add_event_handler("erroneusnickname", self._handle_badnick)
 683         self.irc.add_event_handler("nicknameinuse", self._handle_badnick)
 684         self.irc.add_event_handler("nickcollision", self._handle_badnick)
 685         self.irc.add_event_handler("unavailresource", self._handle_badnick)
 686         self.irc.add_event_handler("featurelist", self._handle_features)
 687         self.irc.add_event_handler("disconnect", self._handle_disconnect)
 688         self.irc.add_event_handler("kick", self._handle_kick)
 689         self.irc.add_event_handler("every_raw_message", self._handle_every_raw_message)
 690         self.servers = {}
 691     def thread_launch(self):
 692         thread = threading.Thread(target=self.irc.spin)
 693         thread.setDaemon(True)
 694         self.irc._thread = thread
 695         thread.start()
 696     def logerr(self, errmsg):
 697         "Log a processing error."
 698         sys.stderr.write("irkerd: " + errmsg + "\n")
 699     def _handle_ping(self, connection, _event):
 700         "PING arrived, bump the last-received time for the connection."
 701         if connection.context:
 702             connection.context.handle_ping()
 703     def _handle_welcome(self, connection, _event):
 704         "Welcome arrived, nick accepted for this connection."
 705         if connection.context:
 706             connection.context.handle_welcome()
 707     def _handle_badnick(self, connection, _event):
 708         "Nick not accepted for this connection."
 709         if connection.context:
 710             connection.context.handle_badnick()
 711     def _handle_features(self, connection, event):
 712         "Determine if and how we can set deaf mode."
 713         if connection.context:
 714             cxt = connection.context
 715             arguments = event.arguments
 716             for lump in arguments:
 717                 if lump.startswith("DEAF="):
 718                     if not logfile:
 719                         connection.mode(cxt.nickname(), "+"+lump[5:])
 720                 elif lump.startswith("MAXCHANNELS="):
 721                     m = int(lump[12:])
 722                     for pref in "#&+":
 723                         cxt.channel_limits[pref] = m
 724                     self.irc.debug(1, "%s maxchannels is %d"
 725                                % (connection.server, m))
 726                 elif lump.startswith("CHANLIMIT=#:"):
 727                     limits = lump[10:].split(",")
 728                     try:
 729                         for token in limits:
 730                             (prefixes, limit) = token.split(":")
 731                             limit = int(limit)
 732                             for c in prefixes:
 733                                 cxt.channel_limits[c] = limit
 734                         self.irc.debug(1, "%s channel limit map is %s"
 735                                    % (connection.server, cxt.channel_limits))
 736                     except ValueError:
 737                         self.logerr("ill-formed CHANLIMIT property")
 738     def _handle_disconnect(self, connection, _event):
 739         "Server hung up the connection."
 740         self.irc.debug(1, "server %s disconnected" % connection.server)
 741         connection.close()
 742         if connection.context:
 743             connection.context.handle_disconnect()
 744     def _handle_kick(self, connection, event):
 745         "Server hung up the connection."
 746         target = event.target
 747         self.irc.debug(1, "irker has been kicked from %s on %s" % (target, connection.server))
 748         if connection.context:
 749             connection.context.handle_kick(target)
 750     def _handle_every_raw_message(self, _connection, event):
 751         "Log all messages when in watcher mode."
 752         if logfile:
 753             with open(logfile, "a") as logfp:
 754                 logfp.write("%03f|%s|%s\n" % \
 755                              (time.time(), event.source, event.arguments[0]))
 756     def pending(self):
 757         "Do we have any pending message traffic?"
 758         return [k for (k, v) in self.servers.items() if v.pending()]
 759     def handle(self, line, quit_after=False):
 760         "Perform a JSON relay request."
 761         try:
 762             request = json.loads(line.strip())
 763             if not isinstance(request, dict):
 764                 self.logerr("request is not a JSON dictionary: %r" % request)
 765             elif "to" not in request or "privmsg" not in request:
 766                 self.logerr("malformed request - 'to' or 'privmsg' missing: %r" % request)
 767             else:
 768                 channels = request['to']
 769                 message = request['privmsg']
 770                 if not isinstance(channels, (list, basestring)):
 771                     self.logerr("malformed request - unexpected channel type: %r" % channels)
 772                 if not isinstance(message, basestring):
 773                     self.logerr("malformed request - unexpected message type: %r" % message)
 774                 else:
 775                     if not isinstance(channels, list):
 776                         channels = [channels]
 777                     for url in channels:
 778                         if not isinstance(url, basestring):
 779                             self.logerr("malformed request - URL has unexpected type: %r" % url)
 780                         else:
 781                             target = Target(url)
 782                             if not target.valid():
 783                                 return
 784                             if target.server() not in self.servers:
 785                                 self.servers[target.server()] = Dispatcher(self, target.servername, target.port)
 786                             self.servers[target.server()].dispatch(target.channel, message, target.key, quit_after=quit_after)
 787                             # GC dispatchers with no active connections
 788                             servernames = self.servers.keys()
 789                             for servername in servernames:
 790                                 if not self.servers[servername].live():
 791                                     del self.servers[servername]
 792                             # If we might be pushing a resource limit
 793                             # even after garbage collection, remove a
 794                             # session.  The goal here is to head off
 795                             # DoS attacks that aim at exhausting
 796                             # thread space or file descriptors.  The
 797                             # cost is that attempts to DoS this
 798                             # service will cause lots of join/leave
 799                             # spam as we scavenge old channels after
 800                             # connecting to new ones. The particular
 801                             # method used for selecting a session to
 802                             # be terminated doesn't matter much; we
 803                             # choose the one longest idle on the
 804                             # assumption that message activity is likely
 805                             # to be clumpy.
 806                             if len(self.servers) >= CONNECTION_MAX:
 807                                 oldest = min(self.servers.keys(), key=lambda name: self.servers[name].last_xmit())
 808                                 del self.servers[oldest]
 809         except ValueError:
 810             self.logerr("can't recognize JSON on input: %r" % line)
 811         except RuntimeError:
 812             self.logerr("wildly malformed JSON blew the parser stack.")
 813
 814 class IrkerTCPHandler(SocketServer.StreamRequestHandler):
 815     def handle(self):
 816         while True:
 817             line = self.rfile.readline()
 818             if not line:
 819                 break
 820             irker.handle(line.strip())
 821
 822 class IrkerUDPHandler(SocketServer.BaseRequestHandler):
 823     def handle(self):
 824         data = self.request[0].strip()
 825         #socket = self.request[1]
 826         irker.handle(data)
 827
 828 def usage():
 829     sys.stdout.write("""
 830 Usage:
 831   irkerd [-d debuglevel] [-l logfile] [-n nick] [-p password] [-i channel message] [-V] [-h]
 832
 833 Options
 834   -d    set debug level
 835   -l    set logfile
 836   -n    set nick-style
 837   -p    set nickserv password
 838   -i    immediate mode
 839   -V    return irkerd version
 840   -h    print this help dialog
 841 """)
 842
 843 if __name__ == '__main__':
 844     debuglvl = 0
 845     immediate = None
 846     namestyle = "irker%03d"
 847     password = None
 848     logfile = None
 849     try:
 850         (options, arguments) = getopt.getopt(sys.argv[1:], "d:i:l:n:p:Vh")
 851     except getopt.GetoptError as e:
 852         sys.stderr.write("%s" % e)
 853         usage()
 854         sys.exit(1)
 855     for (opt, val) in options:
 856         if opt == '-d':         # Enable debug/progress messages
 857             debuglvl = int(val)
 858         elif opt == '-i':       # Immediate mode - send one message, then exit.
 859             immediate = val
 860         elif opt == '-l':       # Logfile mode - report traffic read in
 861             logfile = val
 862         elif opt == '-n':       # Force the nick
 863             namestyle = val
 864         elif opt == '-p':       # Set a nickserv password
 865             password = val
 866         elif opt == '-V':       # Emit version and exit
 867             sys.stdout.write("irkerd version %s\n" % version)
 868             sys.exit(0)
 869         elif opt == '-h':
 870             usage()
 871             sys.exit(0)
 872     fallback = re.search("%.*d", namestyle)
 873     irker = Irker(debuglevel=debuglvl)
 874     irker.irc.debug(1, "irkerd version %s" % version)
 875     if immediate:
 876         def bailout():
 877             raise SystemExit, 1
 878         irker.irc.add_event_handler("quit", lambda _c, _e: bailout())
 879         irker.handle('{"to":"%s","privmsg":"%s"}' % (immediate, arguments[0]), quit_after=True)
 880         irker.irc.spin()
 881     else:
 882         irker.thread_launch()
 883         try:
 884             tcpserver = SocketServer.TCPServer((HOST, PORT), IrkerTCPHandler)
 885             udpserver = SocketServer.UDPServer((HOST, PORT), IrkerUDPHandler)
 886             for server in [tcpserver, udpserver]:
 887                 server = threading.Thread(target=server.serve_forever)
 888                 server.setDaemon(True)
 889                 server.start()
 890             try:
 891                 signal.pause()
 892             except KeyboardInterrupt:
 893                 raise SystemExit(1)
 894         except socket.error, e:
 895             sys.stderr.write("irkerd: server launch failed: %r\n" % e)
 896
 897 # end