X-Git-Url: https://jfr.im/git/erebus.git/blobdiff_plain/fd07173df3e9070bac1a0cf79c729f14c781d799..a99afee6c437887dc90ad4b57347de9af3a09e89:/bot.py

diff --git a/bot.py b/bot.py
index acbeba6..793e27f 100644
--- a/bot.py
+++ b/bot.py
@@ -1,16 +1,28 @@
 #!/usr/bin/python
+# vim: fileencoding=utf-8
 
 # Erebus IRC bot - Author: John Runyon
 # "Bot" and "BotConnection" classes (handling a specific "arm")
 
-import socket, sys, time, threading, os, random
+import socket, sys, time, threading, os, random, struct
 from collections import deque
 
-class MyTimer(threading._Timer):
+if sys.version_info.major < 3:
+	timerbase = threading._Timer
+	stringbase = basestring
+else:
+	timerbase = threading.Timer
+	stringbase = str
+
+class MyTimer(timerbase):
 	def __init__(self, *args, **kwargs):
-		threading._Timer.__init__(self, *args, **kwargs)
+		timerbase.__init__(self, *args, **kwargs)
 		self.daemon = True
 
+if sys.version_info.major < 3:
+	stringbase = basestring
+else:
+	stringbase = str
 
 #bots = {'erebus': bot.Bot(nick='Erebus', user='erebus', bind='', server='irc.quakenet.org', port=6667, realname='Erebus')}
 class Bot(object):
@@ -24,8 +36,13 @@ class Bot(object):
 		self.authname = authname
 		self.authpass = authpass
 
-		curs = self.parent.db.cursor()
-		if curs.execute("SELECT chname FROM chans WHERE bot = %s AND active = 1", (self.nick,)):
+		self.connecttime = 0 # time at which we received numeric 001
+		self.server = server # the address we try to (re-)connect to
+		self.port = port
+		self.servername = server # the name of the server we got connected to
+
+		curs = self.parent.query("SELECT chname FROM chans WHERE bot = %s AND active = 1", (self.permnick,))
+		if curs:
 			chansres = curs.fetchall()
 			curs.close()
 			self.chans = [self.parent.newchannel(self, row['chname']) for row in chansres]
@@ -35,27 +52,30 @@ class Bot(object):
 		self.conn = BotConnection(self, bind, server, port)
 
 		self.lastreceived = time.time() #time we last received a line from the server
-		self.watchdogtimer = MyTimer(self.parent.cfg.get('watchdog', 'interval', default=30), self.watchdog)
+		self.watchdog()
 
 		self.msgqueue = deque()
 		self.slowmsgqueue = deque()
-		self.makemsgtimer()
-		self.msgtimer.start()
+		self._makemsgtimer()
+		self._msgtimer.start()
+		self.joined_chans = False
 
 	def __del__(self):
-		curs = self.parent.db.cursor()
-		curs.execute("UPDATE bots SET connected = 0 WHERE nick = %s", (self.nick,))
-		curs.close()
+		try:
+			curs = self.parent.query("UPDATE bots SET connected = 0 WHERE nick = %s", (self.permnick,))
+			curs.close()
+		except: pass
 
 	def watchdog(self):
-		if time.time() > self.parent.cfg.get('watchdog', 'maxtime', default=300)+self.lastreceived:
+		if time.time() > int(self.parent.cfg.get('watchdog', 'maxtime', default=300))+self.lastreceived:
 			self.parse("ERROR :Fake-error from watchdog timer.")
-
+		self.watchdogtimer = MyTimer(int(self.parent.cfg.get('watchdog', 'interval', default=30)), self.watchdog)
 
 	def log(self, *args, **kwargs):
 		self.parent.log(self.nick, *args, **kwargs)
 
 	def connect(self):
+		self.log('!', "Connecting")
 		if self.conn.connect():
 			self.parent.newfd(self, self.conn.socket.fileno())
 
@@ -68,22 +88,26 @@ class Bot(object):
 			self.conn.send("NICK %s" % (self.permnick))
 
 	def parse(self, line):
-		self.log('I', line)
+		if self.parent.cfg.getboolean('debug', 'io'):
+			self.log('I', line)
 		pieces = line.split()
 
+		if pieces[0][0] == ":":
+			numeric = pieces[1]
+		else:
+			numeric = pieces[0]
+
 		# dispatch dict
-		zero = { #things to look for without source
+		dispatch = { #things to look for after source
 			'NOTICE': self._gotconnected,
-			'PING': self._gotping,
-			'ERROR': self._goterror,
-		}
-		one = { #things to look for after source
 			'001': self._got001,
+			'004': self._got004,
 			'376': self._gotRegistered,
 			'422': self._gotRegistered,
 			'PRIVMSG': self._gotprivmsg,
 			'353': self._got353, #NAMES
 			'354': self._got354, #WHO
+			'396': self._gotHiddenHost, # hidden host has been set
 			'433': self._got433, #nick in use
 			'JOIN': self._gotjoin,
 			'PART': self._gotpart,
@@ -91,20 +115,20 @@ class Bot(object):
 			'QUIT': self._gotquit,
 			'NICK': self._gotnick,
 			'MODE': self._gotmode,
+			'PING': self._gotping,
+			'ERROR': self._goterror,
 		}
 
-		if self.parent.hasnumhook(pieces[1]):
-			hooks = self.parent.getnumhook(pieces[1])
+		if self.parent.hasnumhook(numeric):
+			hooks = self.parent.getnumhook(numeric)
 			for callback in hooks:
 				try:
 					callback(self, line)
 				except Exception:
 					self.__debug_cbexception("numhook", line)
 
-		if pieces[0] in zero:
-			zero[pieces[0]](pieces)
-		elif pieces[1] in one:
-			one[pieces[1]](pieces)
+		if numeric in dispatch:
+			dispatch[numeric](pieces)
 
 	def _gotconnected(self, pieces):
 		if not self.conn.registered():
@@ -113,27 +137,38 @@ class Bot(object):
 		self.conn.send("PONG %s" % (pieces[1]))
 		self._checknick()
 	def _goterror(self, pieces):
-		try: self.quit("Error detected: %s" % ' '.join(pieces))
+		# TODO: better handling, just reconnect that single bot
+		try:
+			self.quit("Error detected: %s" % ' '.join(pieces))
 		except: pass
-		curs = self.parent.db.cursor()
-		curs.execute("UPDATE bots SET connected = 0")
-		curs.close()
-		sys.exit(2)
-		os._exit(2)
+		try:
+			curs = self.parent.query("UPDATE bots SET connected = 0")
+			curs.close()
+		except: pass
+		os._exit(2) # can't use sys.exit since we might be in a sub-thread
 	def _got001(self, pieces):
-		pass # wait until the end of MOTD instead
+		# We wait until the end of MOTD instead to consider ourselves registered, but consider uptime as of 001
+		self.connecttime = time.time()
+	def _got004(self, pieces):
+		self.servername = pieces[3]
 	def _gotRegistered(self, pieces):
 		self.conn.registered(True)
 
-		curs = self.parent.db.cursor()
-		curs.execute("UPDATE bots SET connected = 1 WHERE nick = %s", (self.nick,))
-		curs.close()
+		curs = self.parent.query("UPDATE bots SET connected = 1 WHERE nick = %s", (self.permnick,))
+		if curs: curs.close()
 
 		self.conn.send("MODE %s +x" % (pieces[2]))
 		if self.authname is not None and self.authpass is not None:
-			self.conn.send("AUTH %s %s" % (self.authname, self.authpass))
-		for c in self.chans:
-			self.join(c.name)
+			self.conn.send(self.parent.cfg.get('erebus', 'auth_command', "AUTH %s %s") % (self.authname, self.authpass))
+		if not self.parent.cfg.getboolean('erebus', 'wait_for_hidden_host'):
+			for c in self.chans:
+				self.join(c.name)
+			self.joined_chans = True
+	def _gotHiddenHost(self, pieces):
+		if not self.joined_chans and self.parent.cfg.getboolean('erebus', 'wait_for_hidden_host'):
+			for c in self.chans:
+				self.join(c.name)
+			self.joined_chans = True
 	def _gotprivmsg(self, pieces):
 		nick = pieces[0].split('!')[0][1:]
 		user = self.parent.user(nick)
@@ -141,16 +176,16 @@ class Bot(object):
 		msg = ' '.join(pieces[3:])[1:]
 		self.parsemsg(user, target, msg)
 	def _got353(self, pieces):
+		prefixes = {'@': 'op', '+': 'voice'}
 		chan = self.parent.channel(pieces[4])
 		names = pieces[5:]
 		names[0] = names[0][1:] #remove colon
 		for n in names:
-			user = self.parent.user(n.lstrip('@+'))
-			if n.startswith('@'):
-				chan.userjoin(user, 'op')
-			elif n.startswith('+'):
-				chan.userjoin(user, 'voice')
+			if n[0] in prefixes:
+				user = self.parent.user(n[1:])
+				chan.userjoin(user, prefixes[n[0]])
 			else:
+				user = self.parent.user(n)
 				chan.userjoin(user)
 			user.join(chan)
 	def _got354(self, pieces):
@@ -178,7 +213,7 @@ class Bot(object):
 				self.msg(nick, "I tried, but you're not authed!")
 	def _got433(self, pieces):
 		if not self.conn.registered(): #we're trying to connect
-			newnick = "%s%d" % (self.nick, random.randint(111,999))
+			newnick = "%s%d" % (self.nick, random.randint(111, 999))
 			self.conn.send("NICK %s" % (newnick))
 			self.nick = newnick
 	def _gotjoin(self, pieces):
@@ -216,12 +251,17 @@ class Bot(object):
 	def _gotnick(self, pieces):
 		oldnick = pieces[0].split('!')[0][1:]
 		newnick = pieces[2][1:]
-		if newnick.lower() != oldnick.lower():
-			self.parent.users[newnick.lower()] = self.parent.users[oldnick.lower()]
-			del self.parent.users[oldnick.lower()]
-		self.parent.users[newnick.lower()].nickchange(newnick)
+		if oldnick == self.nick:
+			self.nick = newnick
+		else:
+			if newnick.lower() != oldnick.lower():
+				self.parent.users[newnick.lower()] = self.parent.users[oldnick.lower()]
+				del self.parent.users[oldnick.lower()]
+			self.parent.users[newnick.lower()].nickchange(newnick)
 	def _gotmode(self, pieces):
 		source = pieces[0].split('!')[0][1:]
+		chan = pieces[2]
+		if not chan.startswith("#"): return
 		chan = self.parent.channel(pieces[2])
 		mode = pieces[3]
 		args = pieces[4:]
@@ -246,7 +286,7 @@ class Bot(object):
 				pass # don't care about other modes
 
 	def __debug_cbexception(self, source, *args, **kwargs):
-		if int(self.parent.cfg.get('debug', 'cbexc', default=0)) == 1:
+		if self.parent.cfg.getboolean('debug', 'cbexc'):
 			self.conn.send("PRIVMSG %s :%09.3f 4!!! CBEXC %s" % (self.parent.cfg.get('debug', 'owner'), time.time() % 100000, source))
 			__import__('traceback').print_exc()
 			self.log('!', "CBEXC %s %r %r" % (source, args, kwargs))
@@ -260,16 +300,31 @@ class Bot(object):
 		if len(msg) == 0:
 			return
 
-		triggerused = msg.startswith(self.parent.trigger)
-		if triggerused: msg = msg[len(self.parent.trigger):]
-		pieces = msg.split()
-
 		if target == self.nick:
 			if msg.startswith("\001"): #ctcp
 				msg = msg.strip("\001")
 				if msg == "VERSION":
-					self.msg(user, "\001VERSION Erebus v%d.%d - http://github.com/zonidjan/erebus" % (self.parent.APIVERSION, self.parent.RELEASE))
+					self.msg(user, "\001VERSION Erebus v%d.%d - http://jfr.im/git/erebus.git" % (self.parent.APIVERSION, self.parent.RELEASE))
 				return
+
+		triggerused = msg.startswith(self.parent.trigger)
+		if triggerused: msg = msg[len(self.parent.trigger):]
+		pieces = msg.split()
+
+		if len(pieces) == 0:
+			return
+
+		if target != self.nick: # message was sent to a channel
+			try:
+				if pieces[0][:-1].lower() == self.nick.lower() and (pieces[0][-1] == ":" or pieces[0][-1] == ","):
+					pieces.pop(0) # command actually starts with next word
+					if len(pieces) == 0: # is there still anything left?
+						return
+					msg = ' '.join(pieces)
+					triggerused = True
+			except IndexError:
+				return # "message" is empty
+
 		if len(pieces) > 1:
 			chanword = pieces[1]
 			if chanword.startswith('#'):
@@ -277,30 +332,23 @@ class Bot(object):
 
 		if target != self.nick: # message was sent to a channel
 			chan = self.parent.channel(target)
-			try:
-				if msg.startswith('*'): # message may be addressed to bot by "*BOTNICK" trigger?
-					if pieces[0][1:].lower() == self.nick.lower():
-						pieces.pop(0) # command actually starts with next word
-						msg = ' '.join(pieces) # command actually starts with next word
-				elif not triggerused:
-					if self.parent.haschanhook(target.lower()):
-						for callback in self.parent.getchanhook(target.lower()):
-							try:
-								cbret = callback(self, user, chan, *pieces)
-							except NotImplementedError:
-								self.msg(user, "Command not implemented.")
-							except:
-								self.msg(user, "Command failed. Code: CBEXC%09.3f" % (time.time() % 100000))
-								self.__debug_cbexception("chanhook", user=user, target=target, msg=msg)
-					return # not to bot, don't process!
-			except IndexError:
-				return # "message" is empty
+			if not triggerused:
+				if self.parent.haschanhook(target.lower()):
+					for callback in self.parent.getchanhook(target.lower()):
+						try:
+							cbret = callback(self, user, chan, *pieces)
+							if isinstance(cbret, stringbase):
+								self.reply(target, user, cbret)
+						except:
+							self.msg(user, "Command failed. Code: CBEXC%09.3f" % (time.time() % 100000))
+							self.__debug_cbexception("chanhook", user=user, target=target, msg=msg)
+				return # not to bot, don't process!
 
 		cmd = pieces[0].lower()
 		rancmd = False
 		if self.parent.hashook(cmd):
 			for callback in self.parent.gethook(cmd):
-				if chanparam is not None and callback.needchan:
+				if chanparam is not None and (callback.needchan or callback.wantchan):
 					chan = chanparam
 					pieces.pop(1)
 				if chan is None and callback.needchan:
@@ -310,15 +358,16 @@ class Bot(object):
 					rancmd = True
 					try:
 						cbret = callback(self, user, chan, target, *pieces[1:])
-					except NotImplementedError:
-						self.msg(user, "Command not implemented.")
+						if isinstance(cbret, stringbase):
+							self.reply(target, user, cbret)
 					except Exception:
 						self.msg(user, "Command failed. Code: CBEXC%09.3f" % (time.time() % 100000))
 						self.__debug_cbexception("hook", user=user, target=target, msg=msg)
 					except SystemExit as e:
-						curs = self.parent.db.cursor()
-						curs.execute("UPDATE bots SET connected = 0")
-						curs.close()
+						try:
+							curs = self.parent.query("UPDATE bots SET connected = 0")
+							curs.close()
+						except: pass
 						raise e
 		else:
 			rancmd = True
@@ -327,68 +376,102 @@ class Bot(object):
 			self.msg(user, "You don't have enough access to run that command.")
 
 	def __debug_nomsg(self, target, msg):
-		if int(self.parent.cfg.get('debug', 'nomsg', default=0)) == 1:
+		if self.parent.cfg.getboolean('debug', 'nomsg'):
 			self.conn.send("PRIVMSG %s :%09.3f 4!!! NOMSG %r, %r" % (self.parent.cfg.get('debug', 'owner'), time.time() % 100000, target, msg))
 			self.log('!', "!!! NOMSG")
 #			print "%09.3f %s [!] %s" % (time.time() % 100000, self.nick, "!!! NOMSG")
 			__import__('traceback').print_stack()
 
-	def msg(self, target, msg):
-		cmd = self._formatmsg(target, msg)
-		if self.conn.exceeded or self.conn.bytessent+len(cmd) >= self.conn.recvq:
-			self.msgqueue.append(cmd)
+
+	def reply(self, chan, user, msg):
+		if chan is not None and (isinstance(chan, self.parent.Channel) or (isinstance(chan, stringbase) and chan[0] == "#")):
+			self.msg(chan, "%s: %s" % (user, msg))
 		else:
-			self.conn.send(cmd)
-		self.conn.exceeded = True
+			self.msg(user, msg)
+
+	"""
+		Does the work for msg/slowmsg/fastmsg. Uses the append_callback to append to the correct queue.
+
+		In the case of fastmsg, self.conn.exceeded may be True, however, in this case append_callback=self.conn.send, so it will still be sent immediately.
+	"""
+	def _msg(self, target, msg, truncate, append_callback, msgtype):
+		if self.parent.cfg.getboolean('erebus', 'nofakelag'): return self.fastmsg(target, msg)
+
+		cmd = self._formatmsg(target, msg, msgtype)
+		# The max length is much shorter than recvq (510) because of the length the server adds on about the source (us).
+		# If you know your hostmask, you can of course figure the exact length, but it's very difficult to reliably know your hostmask.
+		maxlen = (
+			self.conn.recvq
+			- 63 # max hostname len
+			- 11 # max ident len
+			- 3  # the symbols in :nick!user@host
+			- len(self.nick)
+		)
+		if len(cmd) > maxlen:
+			if not truncate:
+				return False
+			else:
+				cmd = cmd[:maxlen]
 
-	def slowmsg(self, target, msg):
-		cmd = self._formatmsg(target, msg)
 		if self.conn.exceeded or self.conn.bytessent+len(cmd) >= self.conn.recvq:
-			self.slowmsgqueue.append(cmd)
+			append_callback(cmd)
 		else:
 			self.conn.send(cmd)
-		self.conn.exceeded = True
 
-	def fastmsg(self, target, msg):
-		self.conn.send(self._formatmsg(target, msg))
 		self.conn.exceeded = True
+		return True
+
+	def msg(self, target, msg, truncate=False, *, msgtype=None):
+		"""msgtype must be a valid IRC command, i.e. NOTICE or PRIVMSG; or leave as None to use default"""
+		return self._msg(target, msg, truncate, self.msgqueue.append, msgtype)
+
+	def slowmsg(self, target, msg, truncate=False, *, msgtype=None):
+		return self._msg(target, msg, truncate, self.slowmsgqueue.append, msgtype)
 
-	def _formatmsg(self, target, msg):
+	def fastmsg(self, target, msg, truncate=False, *, msgtype=None):
+		return self._msg(target, msg, truncate, self.conn.send, msgtype)
+
+	def _formatmsg(self, target, msg, msgtype):
 		if target is None or msg is None:
 			return self.__debug_nomsg(target, msg)
 
 		target = str(target)
 
-		if target.startswith('#'): command = "PRIVMSG %s :%s" % (target, msg)
+		if msgtype is not None: command = "%s %s :%s" % (msgtype, target, msg)
+		elif target.startswith('#'): command = "PRIVMSG %s :%s" % (target, msg)
 		else: command = "NOTICE %s :%s" % (target, msg)
 
 		return command
 
 	def _popmsg(self):
-		self.makemsgtimer()
+		self._makemsgtimer()
 		self.conn.bytessent -= self.conn.recvq/3
 		if self.conn.bytessent < 0: self.conn.bytessent = 0
-		self.conn.exceeded = False
+		self.conn.exceeded = True
 
+		cmd = None
 		try:
 			cmd = self.msgqueue.popleft()
-			if not self.conn.exceeded and self.conn.bytessent+len(cmd) < self.conn.recvq:
-				self.conn.send(cmd)
-				self.conn.exceeded = True
-			else: raise IndexError
 		except IndexError:
 			try:
 				cmd = self.slowmsgqueue.popleft()
-				if not self.conn.exceeded and self.conn.bytessent+len(cmd) < self.conn.recvq:
-					self.conn.send(cmd)
-					self.conn.exceeded = True
 			except IndexError:
 				pass
-		self.msgtimer.start()
 
-	def makemsgtimer(self):
-		self.msgtimer = threading.Timer(3, self._popmsg)
-		self.msgtimer.daemon = True
+		if cmd is not None:
+			if self.conn.bytessent+len(cmd) > self.conn.recvq: # If it's too long
+				if len(cmd) > self.conn.recvq: # Is the command itself somehow over max length???
+					self._msgtimer.start()
+					raise ValueError('Somehow a command that was too long made it into the message queue. Uhoh!', cmd)
+					# Discard the message.
+				self.msgqueue.appendleft(cmd) # Phew, we've just sent too much recently. Put it (back) on the (primary) queue.
+			else:
+				self.conn.send(cmd)
+
+		self._msgtimer.start()
+
+	def _makemsgtimer(self):
+		self._msgtimer = MyTimer(3, self._popmsg)
 
 	def join(self, chan):
 		self.conn.send("JOIN %s" % (chan))
@@ -405,7 +488,7 @@ class Bot(object):
 class BotConnection(object):
 	def __init__(self, parent, bind, server, port):
 		self.parent = parent
-		self.buffer = ''
+		self.buffer = bytearray()
 		self.socket = None
 
 		self.bind = bind
@@ -415,11 +498,21 @@ class BotConnection(object):
 		self.state = 0 # 0=disconnected, 1=registering, 2=connected
 
 		self.bytessent = 0
-		self.recvq = 500
+		self.recvq = 510
 		self.exceeded = False
+		self._nowrite = False
 
 	def connect(self):
-		self.socket = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
+		if self.parent.parent.cfg.getboolean('erebus', 'tls'):
+			import ssl
+			undersocket = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
+			context = ssl.create_default_context()
+			self.socket = context.wrap_socket(undersocket, server_hostname=self.server)
+		else:
+			self.socket = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
+		self.socket.setsockopt(socket.SOL_TCP, socket.TCP_NODELAY, 1) # Does Python make SOL_TCP portable? Who knows, it's not documented, and it appears to come from the _socket C lib.
+		self.socket.setsockopt(socket.SOL_SOCKET, socket.SO_LINGER, struct.pack('ii', 0, 0))
+		self.socket.setsockopt(socket.SOL_SOCKET, socket.SO_KEEPALIVE, 1)
 		self.socket.bind((self.bind, 0))
 		self.socket.connect((self.server, self.port))
 		return True
@@ -435,23 +528,29 @@ class BotConnection(object):
 		return self.state == 2
 
 	def send(self, line):
-		self.parent.log('O', line)
-#		print "%09.3f %s [O] %s" % (time.time() % 100000, self.parent.nick, line)
-		self.bytessent += len(line)
-		self._write(line)
+		if not self._nowrite:
+			if self.parent.parent.cfg.getboolean('debug', 'io'):
+				self.parent.log('O', line)
+			self.bytessent += len(line)
+			try:
+				self._write(line)
+			except socket.error as e:
+				self._nowrite = True
+				self.parent._goterror(repr(e))
+		else:
+			if self.parent.parent.cfg.getboolean('debug', 'io'):
+				self.parent.log('X', line)
 
 	def _write(self, line):
-		self.socket.sendall(line+"\r\n")
+		self.socket.sendall(line.encode('utf-8', 'backslashreplace')+b"\r\n")
 
 	def read(self):
 		self.buffer += self.socket.recv(8192)
 		lines = []
 
-		while "\r\n" in self.buffer:
-			pieces = self.buffer.split("\r\n", 1)
-#			self.parent.log('I', pieces[0]) # replaced by statement in Bot.parse()
-#			print "%09.3f %s [I] %s" % (time.time() % 100000, self.parent.nick, pieces[0])
-			lines.append(pieces[0])
+		while b"\r\n" in self.buffer:
+			pieces = self.buffer.split(b"\r\n", 1)
+			lines.append(pieces[0].decode('utf-8', 'backslashreplace'))
 			self.buffer = pieces[1]
 
 		return lines