# No user-serviceable parts below this line
-version = "2.3"
+version = "2.6"
-import sys, getopt, urlparse, time, random, socket, signal, re
-import threading, Queue, SocketServer, select
+import Queue
+import SocketServer
+import getopt
+import logging
try:
import simplejson as json # Faster, also makes us Python-2.4-compatible
except ImportError:
import json
+import random
+import re
+import select
+import signal
+import socket
+import sys
+import threading
+import time
+import urlparse
+
+
+LOG = logging.getLogger(__name__)
+LOG.setLevel(logging.ERROR)
+LOG_LEVELS = ['critical', 'error', 'warning', 'info', 'debug']
+
# Sketch of implementation:
#
"An IRC exception"
pass
+
+class InvalidRequest (ValueError):
+ "An invalid JSON request"
+ pass
+
+
class IRCClient():
"An IRC client session to one or more servers."
- def __init__(self, debuglevel):
+ def __init__(self):
self.mutex = threading.RLock()
self.server_connections = []
self.event_handlers = {}
self.add_event_handler("ping",
lambda c, e: c.ship("PONG %s" % e.target))
- self.debuglevel = debuglevel
def newserver(self):
"Initialize a new server-connection object."
# Otherwise no other thread would ever be able to change
# the shared state of an IRC object running this function.
while True:
+ nextsleep = 0
with self.mutex:
connected = [x for x in self.server_connections
if x is not None and x.socket is not None]
for s in insocks:
connmap[s.fileno()].consume()
else:
- time.sleep(timeout)
+ nextsleep = timeout
+ time.sleep(nextsleep)
def add_event_handler(self, event, handler):
"Set a handler to be called later."
with self.mutex:
self.server_connections.remove(connection)
- def debug(self, level, errmsg):
- "Debugging information."
- if self.debuglevel >= level:
- sys.stderr.write("irkerd: %s\n" % errmsg)
class LineBufferedStream():
"Line-buffer a read stream."
self.master = master
self.socket = None
- def connect(self, server, port, nickname,
+ def connect(self, target, nickname,
password=None, username=None, ircname=None):
- self.master.debug(2, "connect(server=%r, port=%r, nickname=%r, ...)" %
- (server, port, nickname))
+ LOG.debug("connect(server=%r, port=%r, nickname=%r, ...)" % (
+ target.servername, target.port, nickname))
if self.socket is not None:
self.disconnect("Changing servers")
self.buffer = LineBufferedStream()
self.event_handlers = {}
self.real_server_name = ""
- self.server = server
- self.port = port
- self.server_address = (server, port)
+ self.target = target
self.nickname = nickname
- self.username = username or nickname
- self.ircname = ircname or nickname
- self.password = password
try:
self.socket = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
self.socket.bind(('', 0))
- self.socket.connect(self.server_address)
+ self.socket.connect((target.servername, target.port))
except socket.error as err:
raise IRCServerConnectionError("Couldn't connect to socket: %s" % err)
- if self.password:
- self.ship("PASS " + self.password)
+ if password:
+ self.ship("PASS " + password)
self.nick(self.nickname)
- self.user(self.username, self.ircname)
+ self.user(username=username or ircname, realname=ircname or nickname)
return self
def close(self):
self.buffer.append(incoming)
for line in self.buffer:
- self.master.debug(2, "FROM: %s" % line)
+ LOG.debug("FROM: %s" % line)
if not line:
continue
target = arguments[0]
arguments = arguments[1:]
- self.master.debug(2,
- "command: %s, source: %s, target: %s, arguments: %s" % (command, prefix, target, arguments))
+ LOG.debug("command: %s, source: %s, target: %s, arguments: %s" % (
+ command, prefix, target, arguments))
self.handle_event(Event(command, prefix, target, arguments))
def handle_event(self, event):
pass
del self.socket
self.socket = None
- self.handle_event(Event("disconnect", self.server, "", [message]))
+ self.handle_event(
+ Event("disconnect", self.target.server, "", [message]))
def join(self, channel, key=""):
self.ship("JOIN %s%s" % (channel, (key and (" " + key))))
"Ship a command to the server, appending CR/LF"
try:
self.socket.send(string.encode('utf-8') + b'\r\n')
- self.master.debug(2, "TO: %s" % string)
+ LOG.debug("TO: %s" % string)
except socket.error:
self.disconnect("Connection reset by peer.")
return string and string[0] in "#&+!"
class Connection:
- def __init__(self, irkerd, servername, port):
- self.irker = irkerd
- self.servername = servername
- self.port = port
+ def __init__(self, irker, target, nick_template, nick_needs_number=False,
+ password=None, **kwargs):
+ self.irker = irker
+ self.target = target
+ self.nick_template = nick_template
+ self.nick_needs_number = nick_needs_number
+ self.password = password
+ self.kwargs = kwargs
self.nick_trial = None
self.connection = None
self.status = None
"Return a name for the nth server connection."
if n is None:
n = self.nick_trial
- if fallback:
- return (namestyle % n)
+ if self.nick_needs_number:
+ return (self.nick_template % n)
else:
- return namestyle
+ return self.nick_template
def handle_ping(self):
"Register the fact that the server has pinged this connection."
self.last_ping = time.time()
def handle_welcome(self):
"The server says we're OK, with a non-conflicting nick."
self.status = "ready"
- self.irker.irc.debug(1, "nick %s accepted" % self.nickname())
- if password:
- self.connection.privmsg("nickserv", "identify %s" % password)
+ LOG.info("nick %s accepted" % self.nickname())
+ if self.password:
+ self.connection.privmsg("nickserv", "identify %s" % self.password)
def handle_badnick(self):
"The server says our nick is ill-formed or has a conflict."
- self.irker.irc.debug(1, "nick %s rejected" % self.nickname())
- if fallback:
+ LOG.info("nick %s rejected" % self.nickname())
+ if self.nick_needs_number:
# Randomness prevents a malicious user or bot from
# anticipating the next trial name in order to block us
# from completing the handshake.
try:
del self.channels_joined[outof]
except KeyError:
- self.irker.logerr("kicked by %s from %s that's not joined"
- % (self.servername, outof))
+ LOG.error("kicked by %s from %s that's not joined" % (
+ self.target, outof))
qcopy = []
while not self.queue.empty():
(channel, message, key) = self.queue.get()
self.status = "expired"
break
elif xmit_timeout or ping_timeout:
- 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))
+ LOG.info((
+ "timing out connection to %s at %s "
+ "(ping_timeout=%s, xmit_timeout=%s)") % (
+ self.target, time.asctime(), ping_timeout,
+ xmit_timeout))
with self.irker.irc.mutex:
self.connection.context = None
self.connection.quit("transmission timeout")
try:
# This will throw
# IRCServerConnectionError on failure
- self.connection.connect(self.servername,
- self.port,
- nickname=self.nickname(),
- username="irker",
- ircname="irker relaying client")
+ self.connection.connect(
+ target=self.target,
+ nickname=self.nickname(),
+ username="irker",
+ ircname="irker relaying client",
+ **self.kwargs)
self.status = "handshaking"
- self.irker.irc.debug(1, "XMIT_TTL bump (%s connection) at %s" % (self.servername, time.asctime()))
+ LOG.info("XMIT_TTL bump (%s connection) at %s" % (
+ self.target, time.asctime()))
self.last_xmit = time.time()
self.last_ping = time.time()
except IRCServerConnectionError:
self.status = "expired"
+ break
elif self.status == "handshaking":
if time.time() > self.last_xmit + HANDSHAKE_TTL:
self.status = "expired"
(channel, message, key) = self.queue.get()
if channel not in self.channels_joined:
self.connection.join(channel, key=key)
- self.irker.irc.debug(1, "joining %s on %s." % (channel, self.servername))
+ LOG.info("joining %s on %s." % (channel, self.target))
# None is magic - it's a request to quit the server
if message is None:
self.connection.quit()
try:
self.connection.privmsg(channel, segment)
except ValueError as err:
- self.irker.irc.debug(1, "irclib rejected a message to %s on %s because: %s" % (channel, self.servername, str(err)))
- self.irker.irc.debug(50, err.format_exc())
+ LOG.warning((
+ "irclib rejected a message to %s on %s "
+ "because: %s") % (
+ channel, self.target, str(err)))
+ LOG.debug(err.format_exc())
time.sleep(ANTI_FLOOD_DELAY)
self.last_xmit = self.channels_joined[channel] = time.time()
- self.irker.irc.debug(1, "XMIT_TTL bump (%s transmission) at %s" % (self.servername, time.asctime()))
+ LOG.info("XMIT_TTL bump (%s transmission) at %s" % (
+ self.target, time.asctime()))
self.queue.task_done()
- except:
- (exc_type, _exc_value, exc_traceback) = sys.exc_info()
- self.irker.logerr("exception %s in thread for %s" % \
- (exc_type, self.servername))
-
+ elif self.status == "expired":
+ print "We're expired but still running! This is a bug."
+ break
+ except Exception, e:
+ LOG.error("exception %s in thread for %s" % (e, self.target))
# Maybe this should have its own status?
self.status = "expired"
-
- # This is so we can see tracebacks for errors inside the thread
- # when we need to be able to for debugging purposes.
- if debuglvl > 0:
- raise exc_type, _exc_value, exc_traceback
+ LOG.debug(e.format_exc())
finally:
try:
# Make sure we don't leave any zombies behind
class Target():
"Represent a transmission target."
def __init__(self, url):
+ self.url = url
# Pre-2.6 Pythons don't recognize irc: as a valid URL prefix.
url = url.replace("irc://", "http://")
parsed = urlparse.urlparse(url)
if parsed.query:
self.key = re.sub("^key=", "", parsed.query)
self.port = int(ircport)
- def valid(self):
- "Both components must be present for a valid target."
- return self.servername and self.channel
+
+ def __str__(self):
+ "Represent this instance as a string"
+ return self.servername or self.url or repr(self)
+
+ def validate(self):
+ "Raise InvalidRequest if the URL is missing a critical component"
+ if not self.servername:
+ raise InvalidRequest(
+ 'target URL missing a servername: %r' % self.url)
+ if not self.channel:
+ raise InvalidRequest(
+ 'target URL missing a channel: %r' % self.url)
def server(self):
"Return a hashable tuple representing the destination server."
return (self.servername, self.port)
class Dispatcher:
"Manage connections to a particular server-port combination."
- def __init__(self, irkerd, servername, port):
- self.irker = irkerd
- self.servername = servername
- self.port = port
+ def __init__(self, irker, **kwargs):
+ self.irker = irker
+ self.kwargs = kwargs
self.connections = []
def dispatch(self, channel, message, key, quit_after=False):
"Dispatch messages for our server-port combination."
eligibles = [x for x in connections if x.joined_to(channel)] \
or [x for x in connections if x.accepting(channel)]
if eligibles:
- eligibles[0].enqueue(channel, message, key)
+ eligibles[0].enqueue(channel, message, key, quit_after)
return
# All connections are full up. Look for one old enough to be
# scavenged.
#time.sleep(ANTI_FLOOD_DELAY)
found_connection.enqueue(channel, message, key, quit_after)
return
- # Didn't find any channels with no recent activity
- newconn = Connection(self.irker,
- self.servername,
- self.port)
+ # All existing channels had recent activity
+ newconn = Connection(self.irker, **self.kwargs)
self.connections.append(newconn)
newconn.enqueue(channel, message, key, quit_after)
def live(self):
class Irker:
"Persistent IRC multiplexer."
- def __init__(self, debuglevel=0):
- self.debuglevel = debuglevel
- self.irc = IRCClient(self.debuglevel)
+ def __init__(self, logfile=None, **kwargs):
+ self.logfile = logfile
+ self.kwargs = kwargs
+ self.irc = IRCClient()
self.irc.add_event_handler("ping", self._handle_ping)
self.irc.add_event_handler("welcome", self._handle_welcome)
self.irc.add_event_handler("erroneusnickname", self._handle_badnick)
thread.setDaemon(True)
self.irc._thread = thread
thread.start()
- def logerr(self, errmsg):
- "Log a processing error."
- sys.stderr.write("irkerd: " + errmsg + "\n")
def _handle_ping(self, connection, _event):
"PING arrived, bump the last-received time for the connection."
if connection.context:
arguments = event.arguments
for lump in arguments:
if lump.startswith("DEAF="):
- if not logfile:
+ if not self.logfile:
connection.mode(cxt.nickname(), "+"+lump[5:])
elif lump.startswith("MAXCHANNELS="):
m = int(lump[12:])
for pref in "#&+":
cxt.channel_limits[pref] = m
- self.irc.debug(1, "%s maxchannels is %d"
- % (connection.server, m))
+ LOG.info("%s maxchannels is %d" % (connection.server, m))
elif lump.startswith("CHANLIMIT=#:"):
limits = lump[10:].split(",")
try:
limit = int(limit)
for c in prefixes:
cxt.channel_limits[c] = limit
- self.irc.debug(1, "%s channel limit map is %s"
- % (connection.server, cxt.channel_limits))
+ LOG.info("%s channel limit map is %s" % (
+ connection.target, cxt.channel_limits))
except ValueError:
- self.logerr("ill-formed CHANLIMIT property")
+ LOG.error("ill-formed CHANLIMIT property")
def _handle_disconnect(self, connection, _event):
"Server hung up the connection."
- self.irc.debug(1, "server %s disconnected" % connection.server)
+ LOG.info("server %s disconnected" % connection.target)
connection.close()
if connection.context:
connection.context.handle_disconnect()
def _handle_kick(self, connection, event):
"Server hung up the connection."
target = event.target
- self.irc.debug(1, "irker has been kicked from %s on %s" % (target, connection.server))
+ LOG.info("irker has been kicked from %s on %s" % (
+ target, connection.target))
if connection.context:
connection.context.handle_kick(target)
def _handle_every_raw_message(self, _connection, event):
"Log all messages when in watcher mode."
- if logfile:
- with open(logfile, "a") as logfp:
+ if self.logfile:
+ with open(self.logfile, "a") as logfp:
logfp.write("%03f|%s|%s\n" % \
(time.time(), event.source, event.arguments[0]))
def pending(self):
"Do we have any pending message traffic?"
return [k for (k, v) in self.servers.items() if v.pending()]
+
+ def _parse_request(self, line):
+ "Request-parsing helper for the handle() method"
+ request = json.loads(line.strip())
+ if not isinstance(request, dict):
+ raise InvalidRequest(
+ "request is not a JSON dictionary: %r" % request)
+ if "to" not in request or "privmsg" not in request:
+ raise InvalidRequest(
+ "malformed request - 'to' or 'privmsg' missing: %r" % request)
+ channels = request['to']
+ message = request['privmsg']
+ if not isinstance(channels, (list, basestring)):
+ raise InvalidRequest(
+ "malformed request - unexpected channel type: %r" % channels)
+ if not isinstance(message, basestring):
+ raise InvalidRequest(
+ "malformed request - unexpected message type: %r" % message)
+ if not isinstance(channels, list):
+ channels = [channels]
+ targets = []
+ for url in channels:
+ try:
+ if not isinstance(url, basestring):
+ raise InvalidRequest(
+ "malformed request - URL has unexpected type: %r" %
+ url)
+ target = Target(url)
+ target.validate()
+ except InvalidRequest, e:
+ LOG.error(str(e))
+ else:
+ targets.append(target)
+ return (targets, message)
+
def handle(self, line, quit_after=False):
"Perform a JSON relay request."
try:
- request = json.loads(line.strip())
- if not isinstance(request, dict):
- self.logerr("request is not a JSON dictionary: %r" % request)
- elif "to" not in request or "privmsg" not in request:
- self.logerr("malformed request - 'to' or 'privmsg' missing: %r" % request)
- else:
- channels = request['to']
- message = request['privmsg']
- if not isinstance(channels, (list, basestring)):
- self.logerr("malformed request - unexpected channel type: %r" % channels)
- if not isinstance(message, basestring):
- self.logerr("malformed request - unexpected message type: %r" % message)
- else:
- if not isinstance(channels, list):
- channels = [channels]
- for url in channels:
- if not isinstance(url, basestring):
- self.logerr("malformed request - URL has unexpected type: %r" % url)
- else:
- target = Target(url)
- if not target.valid():
- return
- if target.server() not in self.servers:
- self.servers[target.server()] = Dispatcher(self, target.servername, target.port)
- self.servers[target.server()].dispatch(target.channel, message, target.key, quit_after=quit_after)
- # GC dispatchers with no active connections
- servernames = self.servers.keys()
- for servername in servernames:
- if not self.servers[servername].live():
- del self.servers[servername]
- # If we might be pushing a resource limit
- # even after garbage collection, remove a
- # session. The goal here is to head off
- # DoS attacks that aim at exhausting
- # thread space or file descriptors. The
- # cost is that attempts to DoS this
- # service will cause lots of join/leave
- # spam as we scavenge old channels after
- # connecting to new ones. The particular
- # method used for selecting a session to
- # be terminated doesn't matter much; we
- # choose the one longest idle on the
- # assumption that message activity is likely
- # to be clumpy.
- if len(self.servers) >= CONNECTION_MAX:
- oldest = min(self.servers.keys(), key=lambda name: self.servers[name].last_xmit())
- del self.servers[oldest]
+ targets, message = self._parse_request(line=line)
+ for target in targets:
+ if target.server() not in self.servers:
+ self.servers[target.server()] = Dispatcher(
+ self, target=target, **self.kwargs)
+ self.servers[target.server()].dispatch(
+ target.channel, message, target.key, quit_after=quit_after)
+ # GC dispatchers with no active connections
+ servernames = self.servers.keys()
+ for servername in servernames:
+ if not self.servers[servername].live():
+ del self.servers[servername]
+ # If we might be pushing a resource limit even
+ # after garbage collection, remove a session. The
+ # goal here is to head off DoS attacks that aim at
+ # exhausting thread space or file descriptors.
+ # The cost is that attempts to DoS this service
+ # will cause lots of join/leave spam as we
+ # scavenge old channels after connecting to new
+ # ones. The particular method used for selecting a
+ # session to be terminated doesn't matter much; we
+ # choose the one longest idle on the assumption
+ # that message activity is likely to be clumpy.
+ if len(self.servers) >= CONNECTION_MAX:
+ oldest = min(
+ self.servers.keys(),
+ key=lambda name: self.servers[name].last_xmit())
+ del self.servers[oldest]
+ except InvalidRequest, e:
+ LOG.error(str(e))
except ValueError:
self.logerr("can't recognize JSON on input: %r" % line)
except RuntimeError:
""")
if __name__ == '__main__':
- debuglvl = 0
+ log_level = None
immediate = None
- namestyle = "irker%03d"
+ nick_template = "irker%03d"
password = None
logfile = None
try:
usage()
sys.exit(1)
for (opt, val) in options:
- if opt == '-d': # Enable debug/progress messages
- debuglvl = int(val)
+ if opt == '-d': # Enable debug/progress messages
+ if val.lower() not in LOG_LEVELS:
+ sys.stderr.write('invalid log level %r (choices: %s)\n' % (
+ val, ', '.join(LOG_LEVELS)))
+ sys.exit(1)
+ log_level = getattr(logging, val.upper())
elif opt == '-i': # Immediate mode - send one message, then exit.
immediate = val
elif opt == '-l': # Logfile mode - report traffic read in
logfile = val
elif opt == '-n': # Force the nick
- namestyle = val
+ nick_template = val
elif opt == '-p': # Set a nickserv password
password = val
elif opt == '-V': # Emit version and exit
elif opt == '-h':
usage()
sys.exit(0)
- fallback = re.search("%.*d", namestyle)
- irker = Irker(debuglevel=debuglvl)
- irker.irc.debug(1, "irkerd version %s" % version)
+
+ handler = logging.StreamHandler()
+ LOG.addHandler(handler)
+ if log_level:
+ LOG.setLevel(log_level)
+
+ irker = Irker(
+ logfile=logfile,
+ nick_template=nick_template,
+ nick_needs_number=re.search("%.*d", nick_template),
+ password=password,
+ )
+ LOG.info("irkerd version %s" % version)
if immediate:
irker.irc.add_event_handler("quit", lambda _c, _e: sys.exit(0))
irker.handle('{"to":"%s","privmsg":"%s"}' % (immediate, arguments[0]), quit_after=True)
projects / irker.git / blobdiff