svrt.py

#!/usr/bin/python3

import time
import socket
from splitter import splitCall


class ircSrv:

	def __init__(self, nick, server, port = 6667, svrPass = False,
			csPass = False, chans = [], user = False, mode = 8, rn = False):
		self.nick = nick
		if not(user):
			user = nick
		if not(rn):
			rn = nick
		self.host = server
		self.password = svrPass
		self.port = port
		self.csp = csPass
		self.initChans = chans
		self.chans = []
		self.userString = 'USER ' + user + ' ' + str(mode) + ' * : ' + rn
		self.userAuth = True
		self.throttle = False
		self.isConnected = False
		self.lastMsgOut = 0

	fullyDone = False

	# Not used yet?
	logfunc = None

	def setLogger(self, logger):
		self.logfunc = logger

	def logData(self, data):
		if self.logfunc:
			self.logfunc(data)

	@splitCall
	def showout(self, out):
		outstr = '(%s)< %s' % (self.host, out.rstrip())

		self.logData(outstr)

	@splitCall
	def showin(self, out):
		outstr = '(%s)> %s' % (self.host, out.rstrip())
		self.logData(outstr)

	@splitCall
	def showdbg(self, out):
		outstr = '(%s)* %s' % (self.host, out.rstrip())
		self.logData(outstr)

	def _recvRaw(self):
		dataRaw = self.socket.recv(1024)
		data = dataRaw.decode()
		return data

	def recv(self):
		# This might throw socket.error (when there's no data), which we want to
		# pass down anyway so no need to catch it here
		data = False
		data = self._recvRaw()

		# Wait for a newline to be received, otherwise we get incomplete
		# lines sometimes
		# handle pings here too
		while data and data[-1] != '\n':
			data += self._recvRaw()

		if len(data) > 1:
			lines = data.split('\n')
			for line in lines:
				if len(line) > 1:
					self.showin(line)

		if (data.find('PING') == 0):
			self.sendPing(data.split(' ')[1])

		return data

	def recvTry(self):
		try:
			data = recv(self)
		except:
			data = None
		return data

	def _sendToServerRaw(self, data):
		if self.isConnected:
			encdata = data.encode()
			self.socket.sendall(encdata)
		else:
			raise Exception('Tried to send data to server when not connected. ')

	def send(self, data, alt = None):
		sendparts = data.split('\n')

		if (len(sendparts) > 2):
			for part in sendparts[:-1]:
				self.send(part + '\n')

		else:
			for part in sendparts:
				if len(part) > 1:
					self._sendToServerRaw(sendparts[0] + '\n')
					self.lastMsgOut = time.time()
					# False is legacy
					if (alt is not None) and (alt is not False):
						self.showout(alt)
					else:
						self.showout(part)

	def initialize(self):
		self.connSocket()
		self.handShake()
		self.waitForHsFinish()
		self.fullyDone = True

	def disconnect(self):
		self.socket.close()
		self.chans = []
		self.isConnected = False
		self.fullyDone = False

	def connSocket(self):
		host = self.host
		port = int(self.port)
		s = socket.socket()
		s.connect((host, port))
		self.socket = s
		self.s = s
		self.isConnected = True

	# Tell the server basic parameters after we connect
	def handShake(self):
		self.showdbg('Doing handshake...')

		# Sometimes we need to wait before sending anything
		time.sleep(.5)
		self.s.settimeout(1)

		self.recvTry()

		# Send password
		if self.password:
			self.showdbg('Sending password...')
			self.send('PASS %s' % (self.password), 'PASS <censored>')

		# Nick
		self.showdbg('Setting nick...')
		self.send('NICK %s' % (self.nick))

		self.recvTry()

		# Some servers do this as an anti-spoofer
		self.recvTry()

		# Send USER string
		self.send(self.userString)

		self.s.settimeout(10)

	def waitForHsFinish(self):
		line = ''
		remaining = 30
		while (line.find('001') < 1):
			try:
				line = self._recvRaw()
			except socket.timeout:
				remaining -= 1
				if remaining == 0:
					raise
			self.showin(line)

		self.showdbg('Connected')

	def csIdentify(self):
		csp = self.csp
		self.privmsg('nickserv', 'identify %s' % csp)
		self.showdbg('Identified with nickserv')

	def sendPing(self, param):
		outStr = 'PONG %s' % param
		self.send(outStr)

	def joinChans(self):
		self.chans = []
		for chan in self.initChans:
			self.joinChannel(chan)

		self.showdbg('Joined channels')

	def joinChannel(self, channel):
		self.send('JOIN %s' % channel)
		# Need to clean up, this doesn't check to see if joining was
		# actually successful
		self.chans.append(channel)

	def partChannel(self, channel):
		self.send('PART %s' % channel)
		self.chans.remove(channel)

	def privmsg(self, channel, text):
		self.send('PRIVMSG %s :%s' % (channel, text))
		if self.throttle:
			timeSinceLast = time.time() - self.lastMsgOut
			if timeSinceLast < self.throttle:
				time.sleep(self.throttle - timeSinceLast)

	def kickNick(self, channel, nick, message = False):
		if message:
			self.send('KICK %s %s %s' % (channel, user, message))
		else:
			self.send('KICK %s %s' % (channel, user))

	def banNick(self, channel, nick, duration):
		# Ignore duration, it's just there as a placeholder
		# for servers that actually do support durations.
		self.banUser(channel, nick = nick)

	# Accepts either a full user string, or constructs one out
	# of provided nick/ident/host
	def banUser(self, channel, nick = '*', ident = '*',
			host = '*', user = False):
		if not(user):
			user = '%s!%s@%s' % (nick, ident, host)
		self.setChanMode(channel, '+b', user)

	def unBanNick(self, channel, nick):
		self.unBanUser(channel, nick = nick)

	def unBanUser(self, channel, nick = '*', ident = '*',
			host = '*', user = False):
		if not(user):
			user = '%s!%s@%s' % (nick, ident, host)
		self.setChanMode(channel, '-b', user)

	def setChanMode(channel, mode, extraArgs = False):
		if extraArgs:
			self.send('MODE %s %s %s' % (channel, mode, extraArgs))
		else:
			self.send('MODE %s %s' % (channel, mode))

	def setUserMode(self, nick, mode):
		self.send('MODE %s %s' % (nick, mode))

	def requestUserList(self, channel):
		self.send('NAMES %s' % channel)


# Other server classes

# Twitch.tv chat, with throttling built in.
# Use this if the bot is not modded, or twitch will
# eat messages if they are sent too fast in succession.
class twIrc(ircSrv):

	throttle = 2.5

	def __init__(self, nick, chans, authkey):
		self.host = 'irc.twitch.tv'
		self.port = 6667
		self.csp = False
		self.chans = []
		self.initChans = chans
		self.userString = 'USER ' + nick + ' 8 * : ' + nick
		self.userAuth = False
		self.password = authkey
		self.isConnected = False
		self.nick = nick

	def kickNick(self, channel, nick, message = False):
		self.privmsg(channel, '.timeout %s 1')

	def banNick(self, channel, nick, duration):
		# Ignore duration, it's just there as a placeholder
		# for servers that actually do support durations.
		self.privmsg(channel, '.ban %s')

	def unBanNick(self, channel, nick):
		self.privmsg(channel, '.unban %s')

	def joinChans(self):
		self.send('CAP REQ :twitch.tv/membership')
		self.send('CAP REQ :twitch.tv/commands')
		super(twIrc, self).joinChans()

	def initialize(self):
		super(twIrc, self).initialize()
		self.send('CAP REQ :twitch.tv/membership')
		self.send('CAP REQ :twitch.tv/commands')
		time.sleep(3)


# twitch.tv chat with very little throttling built in
# Use this if the bot is modded, as moderators
# can send messages in quick succession.
class twIrcNt(twIrc):

	throttle = 0.5