irc.py

'''
	Copyright 2014-2015 Teemu Piippo
	All rights reserved.

	Redistribution and use in source and binary forms, with or without
	modification, are permitted provided that the following conditions
	are met:

	1. Redistributions of source code must retain the above copyright
	   notice, this list of conditions and the following disclaimer.
	2. Redistributions in binary form must reproduce the above copyright
	   notice, this list of conditions and the following disclaimer in the
	   documentation and/or other materials provided with the distribution.
	3. The name of the author may not be used to endorse or promote products
	   derived from this software without specific prior written permission.

	THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
	IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
	OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
	IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
	INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
	NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
	DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
	THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
	(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
	THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
'''

from __future__ import print_function
import asyncore
import socket
import sys
import re
import traceback
import time
import datetime

import modulecore
from configfile import Config
import bt as Bt
import hgpoll as HgPoll

CLIF_CONNECTED = (1 << 1)

CtcpChar = '\001'
BoldChar = '\002'
ColorChar = '\003'

all_clients = []
ClientsByName = {}

class RestartError (Exception):
	def __init__ (self, value):
		self.message = value
	def __str__ (self):
		return self.message

def get_timestamp():
	return datetime.datetime.now().strftime ('%a %d %b %H:%M:%S')

#
# Prints a line to log channel(s)
#
def broadcast (line):
	print (line)

	for client in all_clients:
		if not client.flags & CLIF_CONNECTED:
			continue

		for channel in client.channels:
			if channel.get_value ('logchannel', default=False):
				client.write ("PRIVMSG %s :%s" % (channel.get_value ('name'), line))

class logical_exception (Exception):
	def __init__ (self, value):
		self.value = value
	def __str__ (self):
		return self.value

def get_client (name):
	for client in all_clients:
		if client.name == name:
			return client

	raise ValueError ('no such client %s' % name)

#
# Main IRC client class
#
class irc_client (asyncore.dispatcher):
	def __init__ (self, cfg, flags):
		global all_clients
		self.name = cfg.get_value ('name')
		self.host = cfg.get_value ('address')
		self.port = cfg.get_value ('port', default=6667)
		self.password = cfg.get_value ('password', default='')
		self.channels = cfg.get_nodelist ('channels')
		self.flags = flags
		self.send_buffer = []
		self.umode = cfg.get_value ('umode', default='')
		self.cfg = cfg
		self.desired_name = Config.get_value ('nickname', default='cobalt')
		self.mynick = self.desired_name
		self.verbose = Config.get_value ('verbose', default=False)
		self.commandprefix = Config.get_value ('commandprefix', default='.')
		all_clients.append (self)
		asyncore.dispatcher.__init__ (self)
		self.create_socket (socket.AF_INET, socket.SOCK_STREAM)
		print ("[%s] Connecting to [%s] %s:%d..." % \
			(get_timestamp(), self.name, self.host, self.port))
		self.connect ((self.host, self.port))
		ClientsByName[self.name] = self

	def register_to_irc (self):
		ident = Config.get_value ('ident', default='cobalt')
		gecos = Config.get_value ('gecos', default='cobalt')
		self.write ("PASS %s" % self.password)
		self.write ("USER %s * * :%s" % (ident, gecos))
		self.write ("NICK %s" % self.mynick)

	def handle_connect (self):
		print ("[%s] Connected to [%s] %s:%d" % (get_timestamp(), self.name, self.host, self.port))
		self.register_to_irc()

	def write (self, utfdata):
		try:
			self.send_buffer.append (utfdata)
		except UnicodeEncodeError:
			pass

	def handle_close (self):
		print ("[%s] Connection to [%s] %s:%d terminated." %
			(get_timestamp(), self.name, self.host, self.port))
		self.close()

	def handle_write (self):
		self.send_all_now()

	def readable (self):
		return True

	def writable (self):
		return len (self.send_buffer) > 0

	def send_all_now (self):
		for line in self.send_buffer:
			if self.verbose:
				print ("[%s] [%s] <- %s" % (get_timestamp(), self.name, line))

			self.send (bytes (line + '\n', 'UTF-8'))
			time.sleep (0.25)
		self.send_buffer = []

	def handle_read (self):
		lines = self.recv (4096).splitlines()
		for line in lines:
			line = line.decode ('utf-8', 'ignore')

			if self.verbose:
				print ("[%s] [%s] -> %s" % (get_timestamp(), self.name, line))

			if line[:len('PING :')] == ('PING :'):
				self.write ("PONG :%s" % line[len('PING :'):])

				# Pings must be responded to immediately, otherwise command/event/etc processing may
				# delay the pong sending enough for the bot to be disconnected over a timeout.
				self.send_all_now()
			else:
				words = line.split(" ")
				if len(words) >= 2:
					if words[1] == "001":
						self.flags |= CLIF_CONNECTED

						umode = self.cfg.get_value ('umode', '')

						if umode != '':
							self.write ('MODE %s %s' % (self.mynick, self.cfg.get_value ('umode', '')))

						for channel in self.channels:
							self.write ("JOIN %s %s" %
								(channel.get_value ('name'),
								channel.get_value ('password', default='')))
					elif words[1] == "PRIVMSG":
						self.handle_privmsg (line)
					elif words[1] == 'QUIT':
						rex = re.compile (r'^:([^!]+)!([^@]+)@([^ ]+) QUIT')
						match = rex.match (line)

						# Try reclaim our nickname if possible
						if match and match.group(1) == self.desired_name:
							self.mynick = self.desired_name
							self.write ("NICK %s" % self.mynick)
					elif words[1] == "433":
						#:irc.localhost 433 * cobalt :Nickname is already in use.
						self.mynick += self.cfg.get_value ('conflictsuffix', default='`')
						self.write ("NICK " + self.mynick)

			# Check for new issues on the bugtracker
			Bt.poll()

			# Check for new commits in the repositories
			HgPoll.poll()

	# # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #
	#
	#	Handle a PRIVMSG line from the IRC server
	#
	def handle_privmsg (self, line):
		rex = re.compile (r'^:([^!]+)!([^@]+)@([^ ]+) PRIVMSG ([^ ]+) :(.*)$')
		match = rex.match (line)

		if not match:
			broadcast ("Recieved bad PRIVMSG: %s" % line)
			return

		sender = match.group (1)
		user = match.group (2)
		host = match.group (3)
		channel = match.group (4)
		message = match.group (5)
		replyto = channel if channel != self.mynick else sender

		# Check for command.
		if len(message) >= 2 and message[0] == self.commandprefix and message[1] != self.commandprefix:
			stuff = message[1:].split(' ')
			command = stuff[0]
			args = stuff[1:]
			self.handle_command (sender, user, host, channel, replyto, command, args, message)
			return

		if channel != self.mynick:
			modulecore.call_hook (bot=self, hookname='chanmsg', channel=channel, sender=sender,
				ident=user, host=host, message=message, replyto=replyto)
		else:
			modulecore.call_hook (bot=self, hookname='querymsg', sender=sender, ident=user,
				host=host, message=message, replyto=replyto)

		modulecore.call_hook (bot=self, hookname='privmsg', target=channel, sender=sender,
			ident=user, host=host, message=message, replyto=replyto)

		Bt.process_message (self, line, replyto)

	def add_irc_channel (self, channame):
		for channel in self.channels:
			if channel.get_value ('name').upper() == channame.upper():
				return

		channel = self.cfg.append_nodelist ('channels')
		channel.set_value ('name', channame)
		self.channels = self.cfg.get_nodelist ('channels')
		self.write ('JOIN ' + channame)
		self.cfg.save()

	def remove_irc_channel (self, channame):
		for channel in self.channels:
			if channel.get_value ('name') == channame:
				self.channels.remove (channel)
				break
		else:
			return

		self.write ('PART ' + channame)
		self.cfg.save()

	def handle_command (self, sender, ident, host, target, replyto, command, args, message):
		kvargs = {'sender': sender, 'ident': ident, 'host': host, 'target': target,
			'replyto': replyto, 'cmdname': command, 'message': message}

		try:
			modulecore.call_command (self, **kvargs)
			return
		except modulecore.CommandError as e:
			lines = str (e).splitlines()
			self.privmsg (replyto, 'error: %s' % lines[0])

			for line in lines[1:]:
				self.privmsg (replyto, '  ' + line)
			return

	def handle_error(self):
		raise RestartError (traceback.format_exception (*sys.exc_info()))

	def restart(self):
		raise RestartError('')

	def privmsg (self, channel, msg):
		self.write ("PRIVMSG %s :%s" % (channel, msg))

	def close_connection (self, message):
		if self.flags & CLIF_CONNECTED:
			self.write ("QUIT :" + message)
		self.send_all_now()
		self.close()

	def quit_irc (self):
		self.close_connection ('Leaving')

	def exceptdie (self):
		self.close_connection ('Caught exception')

	def keyboardinterrupt (self):
		self.close_connection ('KeyboardInterrupt')