path: root/bouncer.py

#!/usr/bin/python
import socket, ssl, os, re, time, sys, string, hashlib, traceback
from threading import Thread, Lock
import Queue

class Bouncer (Thread):
	def __init__(self, addr="", port=16667, ssl=False, certfile=None, keyfile=None, ignore=None):
		self.__name__="Bouncer for pyIRC"
		self.__version__="1.0.0rc1"
		self.__author__="Brian Sherson"
		self.__date__="May 23, 2013"
		#print "Initializing ListenThread..."
		self.addr=addr
		self.port=port
		self.servers={}
		self.passwd={}
		self.socket=s=socket.socket()
		self.socket.setsockopt(socket.SOL_SOCKET, socket.SO_REUSEADDR, 1)
		self.ssl=ssl
		self.certfile=certfile
		self.keyfile=keyfile
		s.bind((self.addr,self.port))
		self.connections=[]
		self.ignore=ignore

		### Keep track of what extensions/connections are requesting WHO, WHOIS, and LIST, because we don't want to spam every bouncer connection with the server's replies.
		### In the future, MAY implement this idea in the irc module.
		self.whoexpected={}
		self.whoisexpected={}
		self.listexpected={}
		#self.lock=Lock()
		self.starttime=int(time.time())
		Thread.__init__ ( self )
		self.daemon=True
		self.start()
	def __repr__(self):
		return "<Bouncer listening on port %(addr)s:%(port)s>" % vars(self)

	def run(self):
		self.socket.listen(5)
		#print ((self,"Now listening on port "+str(self.port)))
		while True:
			try:
				(connection,addr)=self.socket.accept()
				if self.ssl:
					connection=ssl.wrap_socket(connection, server_side=True, certfile=self.certfile, keyfile=self.keyfile, ssl_version=ssl.PROTOCOL_SSLv23)
				try:
					hostname, aliaslist, addresslist = socket.gethostbyaddr(addr[0])
					addr = (hostname, addr[1])
				except:
					pass
				#print ((self,"New client connecting from %s:%s"%addr))
			except socket.error:
				#print "Shutting down Listener"
				self.socket.close()
				#raise
				sys.exit()
			bouncer=BouncerConnection(self, connection, addr)
			#bouncer.daemon=True
			#self.connections.append(bouncer)
			#bouncer.start()
			#ccrecv.start()
			time.sleep(0.5)
		try:
			self.socket.close()
		except: pass
	def onRecv(self, IRC, line, data):
		if type(self.ignore) not in (list, tuple) or all([not re.match(pattern, line) for pattern in self.ignore]):
			if data:
				(origin, ident, host, cmd, target, params, extinfo)=data
				#print data
				if re.match("^\\d+$",cmd): cmd=int(cmd) ### Code is a numerical response
				if cmd in (352, 315): ### WHO reply
					if len(self.whoexpected[IRC]) and self.whoexpected[IRC][0] in self.connections:
						self.whoexpected[IRC][0].connection.send(line+"\n")
					if cmd==315: ### End of WHO reply
						del self.whoexpected[IRC][0]
				elif cmd in (307, 311, 312, 313, 317, 318, 319, 330, 335, 336, 378, 379): ### WHO reply
					if len(self.whoisexpected[IRC]) and self.whoisexpected[IRC][0] in self.connections:
						self.whoisexpected[IRC][0].connection.send(line+"\n")
					if cmd==318: ### End of WHOIS reply
						del self.whoisexpected[IRC][0]
				elif cmd in (321, 322, 323): ### LIST reply
					if len(self.listexpected[IRC]) and self.listexpected[IRC][0] in self.connections:
						self.listexpected[IRC][0].connection.send(line+"\n")
					if cmd==323: ### End of LIST reply
						del self.listexpected[IRC][0]
				else:
					for bouncer in self.connections:
						#print bouncer.IRC
						#print IRC
						#print line
						if bouncer.IRC==IRC: bouncer.connection.send(line+"\n")
	def onSend(self, IRC, line, data, origin):
		if type(self.ignore) not in (list, tuple) or all([not re.match(pattern, line) for pattern in self.ignore]):
			(cmd, target, params, extinfo)=data
			if cmd.upper() in ("PRIVMSG", "NOTICE"):
				for bouncerconnection in self.connections:
					if bouncerconnection==origin: ### Do NOT send the message back to the originating client.
						continue
					if bouncerconnection.IRC==IRC: ### Send the message to the other clients connected to the bouncer.
						ctcp=re.findall("^\x01(.*?)(?:\\s+(.*?)\\s*)?\x01$",extinfo)
						if ctcp:
							(ctcptype,ext)=ctcp[0]
							if ctcptype=="ACTION":
								bouncerconnection.connection.send(":%s!%s@%s %s\n" % (bouncerconnection.IRC.identity.nick, bouncerconnection.IRC.identity.idnt, bouncerconnection.IRC.identity.host, line))
							### Unless the message is a CTCP that is not ACTION.
						else:
							bouncerconnection.connection.send(":%s!%s@%s %s\n" % (bouncerconnection.IRC.identity.nick, bouncerconnection.IRC.identity.idnt, bouncerconnection.IRC.identity.host, line))
			elif cmd.upper()=="WHO":
				#print origin, line
				self.whoexpected[IRC].append(origin)
			elif cmd.upper()=="WHOIS":
				#print origin, line
				self.whoisexpected[IRC].append(origin)
			elif cmd.upper()=="LIST":
				#print origin, line
				self.listexpected[IRC].append(origin)
	def onModuleAdd(self, IRC, label, passwd, hashtype="md5"):
		if IRC in [connection for (connection, passwd, hashtype) in self.servers.values()]: return # Silently do nothing
		if label in self.servers.keys(): return
		self.servers[label]=(IRC, passwd, hashtype)
		self.whoexpected[IRC]=[]
		self.whoisexpected[IRC]=[]
		self.listexpected[IRC]=[]

	def onModuleRem(self, IRC):
		for bouncerconnection in self.connections:
			if bouncerconnection.IRC==IRC:
				bouncerconnection.stop(quitmsg="Bouncer extension removed")
		for (label, (connection, passwd, hashtype)) in self.servers.items():
			if connection==IRC:
				del self.servers[label]

	def stop(self):
		#self.quitmsg=quitmsg
		#self.connection.send("ERROR :Closing link: (%s@%s) [%s]\n" % (self.IRC.identity.nick, self.addr[0], self.quitmsg))
		self.socket.shutdown(0)
	def disconnectall(self, quitmsg="Disconnecting all sessions"):
		for bouncerconnection in self.connections:
			bouncerconnection.stop(quitmsg=quitmsg)
	def onDisconnect(self, IRC):
		self.whoexpected[IRC]=[]
		self.whoisexpected[IRC]=[]
		self.listexpected[IRC]=[]
		for bouncerconnection in self.connections:
			if bouncerconnection.IRC==IRC:
				bouncerconnection.stop(quitmsg="IRC connection lost")

class BouncerConnection (Thread):
	def __init__(self, bouncer, connection, addr):
		#print "Initializing ListenThread..."
		self.bouncer=bouncer
		self.connection=connection
		self.host, self.port=self.addr=addr
		self.IRC=None
		self.pwd=None
		self.nick=None
		self.label=None
		self.idnt=None
		self.realname=None
		self.addr=addr
		self.quitmsg="Connection Closed"

		Thread.__init__ ( self )
		self.daemon=True
		self.start()

	def __repr__(self):
		server=self.IRC.server if self.IRC else "*"
		port=self.IRC.port if self.IRC else "*"
		if self.IRC and self.IRC.identity:
			nick=self.IRC.identity.nick
			ident=self.IRC.identity.idnt if self.IRC.identity.idnt else "*"
			host=self.IRC.identity.host if self.IRC.identity.host else "*"
		else:
			nick="*"
			ident="*"
			host="*"
		protocol="ircs" if self.IRC.ssl else "irc"
		addr=self.host
		return "<Bouncer connection from %(addr)s to %(nick)s!%(ident)s@%(host)s on %(protocol)s://%(server)s:%(port)s>" % locals()

	def stop(self, quitmsg="Disconnected"):
		self.quitmsg=quitmsg
		#self.connection.send("ERROR :Closing link: (%s@%s) [%s]\n" % (self.IRC.identity.nick, self.host, self.quitmsg))
		self.connection.shutdown(0)

	def run(self):
		### Add connection to connection list.

		listnumerics=dict(b=(367, 368, "channel ban list"), e=(348, 349, "Channel Exception List"), I=(346, 347, "Channel Invite Exception List"), w=(910, 911, "Channel Access List"), g=(941, 940, "chanel spamfilter list"), X=(954, 953, "channel exemptchanops list"))

		passwd=None
		nick=None
		user=None

		readbuf=""
		linebuf=[]

		try:
			while True:
				### Read data (appending) into readbuf, then break lines and append lines to linebuf
				while len(linebuf)==0:
					timestamp=reduce(lambda x,y: x+":"+y,[str(t).rjust(2,"0") for t in time.localtime()[0:6]])
					read=self.connection.recv(512)
					if read=="" and len(linebuf)==0: ### No more data to process. 
						#self.quitmsg="Connection Closed"
						sys.exit()

					readbuf+=read
					lastlf=readbuf.rfind("\n")

					if lastlf>=0:
						linebuf.extend(string.split(readbuf[0:lastlf], "\n"))
						readbuf=readbuf[lastlf+1:]

				line=string.rstrip(linebuf.pop(0))
				match=re.findall("^(.+?)(?:\\s+(.+?)(?:\\s+(.+?))??)??(?:\\s+:(.*))?$", line, re.I)

				if len(match)==0: continue
				(cmd, target, params, extinfo)=match[0]

				if not passwd: ### Bouncer expects a password
					if cmd.upper()=="PASS":
						passwd=target if target else extinfo
					else:
						self.quitmsg="Access Denied"
						break

				elif not nick: ### Bouncer expects a NICK command
					if cmd.upper()=="NICK":
						nick=target if target else extinfo
					else:
						self.quitmsg="Access Denied"
						break

				elif not self.idnt: ### Bouncer expects a USER command to finish registration
					if cmd.upper()=="USER":
						self.idnt=target
						#print self.idnt
						if self.idnt in self.bouncer.servers.keys():
							self.IRC, passwdhash, hashtype=self.bouncer.servers[self.idnt]
							passmatch=hashlib.new(hashtype, passwd).hexdigest()==passwdhash
							self.IRC.lock.acquire()
							if not (self.IRC.connected and self.IRC.registered and type(self.IRC.supports)==dict and "CHANMODES" in self.IRC.supports.keys() and passmatch):
								self.quitmsg="Access Denied"
								self.IRC.lock.release()
								break

							### If we have made it to this point, then access has been granted.
							self.bouncer.connections.append(self)
							labels=[bouncerconnection.label for bouncerconnection in self.bouncer.connections if bouncerconnection.IRC==self.IRC and bouncerconnection.label]
							n=1
							while "*%s_%d"%(self.idnt, n) in labels:
								n+=1
							self.label="*%s_%d"%(self.idnt, n)

							### Request Version info.
							self.connection.send(":$bouncer PRIVMSG %s :\x01VERSION\x01\n" % (self.IRC.identity.nick))

							### Send Greeting.
							self.connection.send(":%s 001 %s :%s\n" % (self.IRC.serv, self.IRC.identity.nick, self.IRC.welcome))
							self.connection.send(":%s 002 %s :%s\n" % (self.IRC.serv, self.IRC.identity.nick, self.IRC.hostinfo))
							self.connection.send(":%s 003 %s :%s\n" % (self.IRC.serv, self.IRC.identity.nick, self.IRC.servinfo))
							self.connection.send(":%s 004 %s %s\n" % (self.IRC.serv, self.IRC.identity.nick, self.IRC.serv004))

							### Send 005 response.
							supports=["CHANMODES=%s"%(",".join(value)) if name=="CHANMODES" else "PREFIX=(%s)%s"%value if name=="PREFIX" else "%s=%s"%(name, value) if value else name for name, value in self.IRC.supports.items()]
							supports.sort()
							supportsreply=[]
							supportsstr=" ".join(supports)
							index=0
							while True:
								if len(supportsstr)-index>196:
									nextindex=supportsstr.rfind(" ", index, index+196)
									supportsreply.append(supportsstr[index:nextindex])
									index=nextindex+1
								else:
									supportsreply.append(supportsstr[index:])
									break
							for support in supportsreply:
								self.connection.send(":%s 005 %s %s :are supported by this server\n" % (self.IRC.serv, self.IRC.identity.nick, support))

							### Send MOTD
							self.connection.send(":%s 375 %s :%s\n" % (self.IRC.serv, self.IRC.identity.nick, self.IRC.motdgreet))
							for motdline in self.IRC.motd:
								self.connection.send(":%s 372 %s :%s\n" % (self.IRC.serv, self.IRC.identity.nick, motdline))
							self.connection.send(":%s 376 %s :%s\n" % (self.IRC.serv, self.IRC.identity.nick, self.IRC.motdend))

							### Send user modes and snomasks.
							self.connection.send(":%s 221 %s +%s\n" % (self.IRC.serv, self.IRC.identity.nick, self.IRC.identity.modes))
							if "s" in self.IRC.identity.modes and self.IRC.identity.snomask:
								self.connection.send(":%s 008 %s +%s :Server notice mask\n" % (self.IRC.server, self.IRC.identity.nick, self.IRC.identity.snomask))

							### Join user to internal bouncer channel.
							self.connection.send(":%s!%s@%s JOIN :$bouncer\n" % (self.IRC.identity.nick, self.IRC.identity.idnt, self.IRC.identity.host))

							### Set internal bouncer topic.
							self.connection.send(":$bouncer 332 %s $bouncer :Bouncer internal channel. Enter bouncer commands here.\n" % (self.IRC.identity.nick))
							self.connection.send(":$bouncer 333 %s $bouncer $bouncer %s\n" % (self.IRC.identity.nick, self.bouncer.starttime))

							### Send NAMES for internal bouncer channel.
							self.connection.send(":$bouncer 353 %s @ $bouncer :%s\n" % (
								self.IRC.identity.nick,
								string.join(["@*Bouncer*"]+["@%s"%bouncerconnection.label for bouncerconnection in self.bouncer.connections]))
								)
							self.connection.send(":$bouncer 366 %s $bouncer :End of /NAMES list.\n" % (self.IRC.identity.nick))

							### Give operator mode to user.
							self.connection.send(":*Bouncer* MODE $bouncer +o %s\n" % (self.IRC.identity.nick))


							### Join user to channels.
							for channel in self.IRC.identity.channels:
								### JOIN command
								self.connection.send(":%s!%s@%s JOIN :%s\n" % (self.IRC.identity.nick, self.IRC.identity.idnt, self.IRC.identity.host, channel.name))

								### Topic
								self.connection.send(":%s 332 %s %s :%s\n" % (self.IRC.serv, self.IRC.identity.nick, channel.name, channel.topic))
								self.connection.send(":%s 333 %s %s %s %s\n" % (self.IRC.serv, self.IRC.identity.nick, channel.name, channel.topicsetby, channel.topictime))

								### Determine if +s or +p modes are set in channel
								secret="s" in channel.modes.keys() and channel.modes["s"]
								private="p" in channel.modes.keys() and channel.modes["p"]

								### Construct NAMES for channel.
								namesusers=[]
								modes, symbols=self.IRC.supports["PREFIX"]
								self.connection.send(":%s 353 %s %s %s :%s\n" % (
									self.IRC.serv,
									self.IRC.identity.nick,
									"@" if secret else ("*" if private else "="),
									channel.name,
									string.join([string.join([symbols[k] if modes[k] in channel.modes.keys() and user in channel.modes[modes[k]] else "" for k in xrange(len(modes))],"")+user.nick for user in channel.users]))
									)
								self.connection.send(":%s 366 %s %s :End of /NAMES list.\n" % (self.IRC.serv, self.IRC.identity.nick, channel.name))

							### Announce connection to all other bouncer connections.
							for bouncerconnection in self.bouncer.connections:
								try:
									bouncerconnection.connection.send(":%s!%s@%s JOIN :$bouncer\n" % (self.label, self.idnt, self.addr[0]))
									bouncerconnection.connection.send(":*Bouncer* MODE $bouncer +o %s\n" % (self.label))
								except:
									pass
							self.IRC.lock.release()
						else: ### User not found
							self.quitmsg="Access Denied"
							break
					else: ### Client did not send USER command when expected
						self.quitmsg="Access Denied"
						break

				elif cmd.upper()=="QUIT":
					self.quitmsg=extinfo
					break

				elif cmd.upper()=="PING":
					self.connection.send(":%s PONG %s :%s\n" % (self.IRC.serv, self.IRC.serv, self.IRC.identity.nick))

				elif cmd.upper()=="WHO" and target.lower()=="$bouncer":
					for bouncerconnection in self.bouncer.connections:
						self.connection.send(":$bouncer 352 %s $bouncer %s %s $bouncer %s H@ :0 %s\n" % (self.IRC.identity.nick, bouncerconnection.idnt, bouncerconnection.host, bouncerconnection.label, bouncerconnection.IRC))
					self.connection.send(":$bouncer 315 %s $bouncer :End if /WHO list.\n" % (self.IRC.identity.nick))

				elif cmd.upper() in ("PRIVMSG", "NOTICE"):
					### Check if CTCP
					ctcp=re.findall("^\x01(.*?)(?:\\s+(.*?)\\s*)?\x01$",extinfo)


					if target.lower()=="$bouncer": ### Message to internal bouncer control channel
						if ctcp and cmd.upper()=="NOTICE":
							(ctcptype, ext)=ctcp[0] ### Unpack CTCP info
							if ctcptype=="VERSION": ### Client is sending back version reply
								for bouncerconnection in self.bouncer.connections:
									reply=":%s!%s@%s PRIVMSG $bouncer :Version reply: %s\n" % (self.label, self.idnt, self.addr[0], ext)
									try:
										bouncerconnection.connection.send(reply)
									except:
										pass
					elif ctcp: ### If CTCP, only want to 
						(ctcptype, ext)=ctcp[0] ### Unpack CTCP info

						if ctcptype=="LAGCHECK": ### Client is doing a lag check. No need to send to IRC network, just reply back.
							self.connection.send(":%s!%s@%s %s\n" % (self.IRC.identity.nick, self.IRC.identity.idnt, self.IRC.identity.host, line))
						else:
							self.IRC.raw(line, origin=self)
					else:
						self.IRC.raw(line, origin=self)

				elif cmd.upper() == "MODE": ### Will want to determine is requesting modes, or attempting to modify modes.
					if target and "CHANTYPES" in self.IRC.supports.keys() and target[0] in self.IRC.supports["CHANTYPES"]:
						if params=="":
							channel=self.IRC.channel(target)
							modes=channel.modes.keys()
							modestr="".join([mode for mode in modes if mode not in self.IRC.supports["CHANMODES"][0]+self.IRC.supports["PREFIX"][0] and channel.modes[mode]])
							params=" ".join([channel.modes[mode] for mode in modes if mode in self.IRC.supports["CHANMODES"][1]+self.IRC.supports["CHANMODES"][2] and channel.modes[mode]])
							self.connection.send(":%s 324 %s %s +%s %s\n" % (self.IRC.serv, self.IRC.identity.nick, channel.name, modestr, params))
							self.connection.send(":%s 329 %s %s %s\n" % (self.IRC.serv, self.IRC.identity.nick, channel.name, channel.created))
						elif re.match("^\\+?[%s]+$"%self.IRC.supports["CHANMODES"][0], params) and extinfo=="":
							#print "ddd Mode List Request", params
							channel=self.IRC.channel(target)
							redundant=[]
							for mode in params.lstrip("+"):
								if mode in redundant or mode not in listnumerics.keys(): continue
								i,e,l=listnumerics[mode]
								if mode in channel.modes.keys():
									for (mask, setby, settime) in channel.modes[mode]:
										self.connection.send(":%s %d %s %s %s %s %s\n" % (self.IRC.serv, i, channel.context.identity.nick, channel.name, mask, setby, settime))
								self.connection.send(":%s %d %s %s :End of %s\n" % (self.IRC.serv, e, channel.context.identity.nick, channel.name, l))
								redundant.append(mode)
						else:
							self.IRC.raw(line, origin=self)
					elif params=="" and target.lower()==self.IRC.identity.nick.lower():
						self.connection.send(":%s 221 %s +%s\n" % (self.IRC.serv, self.IRC.identity.nick, self.IRC.identity.modes))
						if "s" in self.IRC.identity.modes and self.IRC.identity.snomask:
							self.connection.send(":%s 008 %s +%s :Server notice mask\n" % (self.IRC.serv, self.IRC.identity.nick, self.IRC.identity.snomask))
					else:
						self.IRC.raw(line, origin=self)
				else:
					self.IRC.raw(line, origin=self)








		except SystemExit:
			pass ### No need to pass error message if break resulted from sys.exit()
		except:
			exc,excmsg,tb=sys.exc_info()
			self.quitmsg=str(excmsg)
		finally:
			if self.IRC and self.IRC.lock.locked(): self.IRC.lock.release() ### Release lock in case lock is locked.
			try:
				self.connection.send("ERROR :Closing link: (%s@%s) [%s]\n" % (self.IRC.identity.nick if self.IRC else "*", self.host, self.quitmsg))
				self.connection.shutdown(1)
				self.connection.close()
			except:
				pass

			if self in self.bouncer.connections:
				self.bouncer.connections.remove(self)

				### Announce QUIT to other bouncer connections.
				for bouncerconnection in self.bouncer.connections:
					try:
						bouncerconnection.connection.send(":%s!%s@%s QUIT :%s\n" % (self.label, self.idnt, self.host, self.quitmsg))
					except:
						pass