IRC Bot ported to Twisted

This commit is contained in:
Uriziel 2013-01-27 23:18:12 +01:00
parent 1af1f33e80
commit 01e6b5b9a6
2 changed files with 185 additions and 238 deletions

View File

@ -1,231 +1,190 @@
#!/usr/bin/env python from twisted.words.protocols import irc
# -*- coding: utf-8 -*- from twisted.internet import reactor, protocol
# @author HarHar
import socket
import threading
from syncplay import utils from syncplay import utils
from time import sleep
import traceback
class ColorCode(object):
NORMAL = chr(15)
BOLD = chr(2)
RED = chr(3) + "5"
BLUE = chr(3) + "12"
'''
@author Uriziel
@author HarHar
'''
class Bot(object): class Bot(object):
def __init__(self, server='irc.rizon.net', serverPassword='', port=6667, nick='SyncBot', nickservPass='', channel='', channelPassword='', functions=[]): def __init__(self, server='irc.rizon.net', port=6667, nick='SyncBot', channel='', functions=[]):
#Arguments '''
# server - IRC Server to connect to functions - dict of functions that can be used from the bot:
# serverPassword - probably empty functions = {
# port - usually between 6660 - 6669, 7000 "pause": lambda setBy, state: None,
# nick - duh "getRooms": lambda: ["",],
# nickservPass - if not given, NickServ identification string won't be sent "setRoomPosition": lambda setBy, seconds 0: None,
# channel - channel to autojoin and interact with "getRoomPosition": lambda room: 0,
# channelPassword - if channel is +k "getRoomUsers": lambda room: [{"nick": "", "file": "", "duration": 0},],
# functions - list/tuple of functions that can be used from the bot: "isRoomPaused": lambda room: True,
# * pause(setBy, state=bool) }
# * getRooms() -> list '''
# * getPosition(room) -> int self.factory = BotFactory(self, channel.encode("ascii", "replace"), nick.encode("ascii", "replace"))
# * setPosition(setBy, seconds) self.proto = None
# * getUsers(room) -> list of {'nick': str, 'file': str, 'length': int} self.server = server
# * isPaused(room) -> bool self.port = port
self._functions = functions
self.functions = functions def start(self):
self.server = server reactor.connectTCP(self.server, self.port, self.factory)
self.serverPassword = serverPassword
self.port = port
self.nick = nick
self.nickservPass = nickservPass
self.channel = channel
self.channelPassword = channelPassword
#Connection/authentication routine def registerProto(self, proto):
self.sock = socket.socket() self.proto = proto
self.sock.connect((server, port))
if serverPassword != '': def __playpause(self, user):
self.sockSend('PASS ' + serverPassword) rooms = self._functions["getRooms"]()
self.sockSend('NICK ' + nick) for room in rooms:
self.sockSend('USER ' + nick + ' ' + nick + ' ' + nick + ' :SyncPlay Bot') #Don't ask me users = self._functions["getRoomUsers"](room)
self.sock.recv(4096) #Wait for authentication to finish for u in users:
if u['nick'] == user:
paused = self._functions["isRoomPaused"](room)
self._functions["pause"](user, not (paused))
return "<{}> {} the room: `{}`".format(ColorCode.BOLD, user, ColorCode.NORMAL, "paused" if paused else "unpaused", room)
return "{}Error!{} Your nick was not found on the server.".format(ColorCode.RED, ColorCode.NORMAL)
if nickservPass != '': def __listRooms(self):
self.msg('NickServ', 'IDENTIFY ' + nickservPass) rooms = self._functions["getRooms"]()
self.sock.recv(4096) #We don't want to join if nickserv hasn't done its job (shouldn't really matter, but good for vHost) if(len(rooms) >= 3):
v = ("`, `".join(rooms[:-1]), rooms[-1])
return "Currently the Syncplay server hosts viewing sessions as follows: `{}` and ultimately `{}`.".format(*v)
elif(len(rooms) == 2):
return "Currently the Syncplay server hosts viewing sessions as follows: `{}` and `{}`.".format(rooms[0], rooms[1])
elif(len(rooms) == 1):
return "Currently the Syncplay server hosts one viewing session called `{}`".format(rooms[0])
else:
return "{}Notice:{} No rooms have been found on server".format(ColorCode.BLUE, ColorCode.NORMAL)
if channel != '': def __getListOfFiles(self, users):
self.join(channel, channelPassword) files = []
for u in users:
if [u["file"], u["duration"]] not in files:
files.append([u["file"], u["duration"]])
return files
self.active = True def __getUserlist(self, room):
self.thread = threading.Thread(target=handlingThread, args=(self.sock, self)) users = self._functions["getRoomUsers"](room)
self.thread.setDaemon(True) position = self._functions["getRoomPosition"](room)
self.thread.start() paused = "Paused" if self._functions["isRoomPaused"](room) else "Playing"
files = self.__getListOfFiles(users)
message = ""
for f in files:
if (f[0] == None):
message += "No file:\n"
else:
v = (
ColorCode.BOLD, paused, ColorCode.NORMAL,
utils.formatTime(position),
utils.formatTime(f[1]), f[0]
)
message += "{}<{}>{} [{}/{}] {}\n".format(*v)
u = [u['nick'] for u in users if f[0] == u['file'] and f[1] == u['duration']]
if (len(u) > 1):
message += "Played by: <{}> and <{}>.\n".format(">, <".join(u[:-1]), u[-1])
else:
message += "Played by {} alone.\n".format(u[0])
return message
def sp_joined(self, who, room): def __getRoomInfo(self, action):
self.msg(self.channel, chr(2) + '<' + who + '>'+ chr(15) +' has joined ' + room) if(action.startswith("rooms")):
def sp_left(self, who, room): room = action.replace("rooms", "", 1)
self.msg(self.channel, chr(2) + '<' + who + '>'+ chr(15) +' has left ' + room) else:
def sp_unpaused(self, who, room): room = action.replace("ri", "", 1)
self.msg(self.channel, chr(2) + '<' + who + '>'+ chr(15) +' has unpaused (room ' + room + ')') room = room.strip()
def sp_paused(self, who, room): if('' == room):
self.msg(self.channel, chr(2) + '<' + who + '>'+ chr(15) +' has paused (room ' + room + ')') return "{}Usage:{} !roominfo [room]".format(ColorCode.BLUE, ColorCode.NORMAL)
def sp_fileplaying(self, who, filename, room): #for when syncplay knows what filename is being played rooms = self._functions["getRooms"]()
if filename == '': if(not room in rooms):
return return "{}Error!{} Room does not exists.".format(ColorCode.RED, ColorCode.NORMAL)
self.msg(self.channel, chr(2) + '<' + who + '>'+ chr(15) +' is playing "' + filename + '" (room ' + room + ')') message = self.__getUserlist(room)
def sp_seek(self, who, fromTime, toTime, room): return message
self.msg(self.channel, chr(2) + '<' + who + '>'+ chr(15) +' has jumped from ' + utils.formatTime(fromTime) + ' to ' + utils.formatTime(toTime) +' (room ' + room + ')')
def sockSend(self, s): def takeAction(self, action, user):
try: if(action == "help" or action == "h"):
self.sock.send(s.encode('utf8') + '\r\n') v = (ColorCode.BOLD, ColorCode.NORMAL)
except socket.error, info: return "{}Available commands:{} !rooms / !roominfo [room] / !playpause (or aliases: !r, !ri [room], !p).".format(*v)
self.active = False elif(action == "rooms" or action == "r"):
print '\033[91mSocket error (bot disconnected)\033[0;0m ' + str(info) return self.__listRooms()
elif(action.startswith("roominfo") or action.startswith("ri")):
return self.__getRoomInfo(action)
elif(action == "playpause" or action == "p"):
return self.__playpause(user)
else:
return "{}Error!{} Unknown command".format(ColorCode.RED, ColorCode.NORMAL)
def msg(self, who, message): def _sendChanMessage(self, msg):
self.sockSend('PRIVMSG ' + who + ' :' + message) if(self.proto):
def join(self, channel, passw=''): self.proto.sendChanMessage(msg)
if passw != '': passw = ' ' + passw
self.sockSend('\r\nJOIN ' + channel + passw)
#Just to make sure we joined; doesn't hurt anyone
sleep(1)
self.sockSend('\r\nJOIN ' + channel + passw)
def part(self, channel, reason=''):
self.sockSend('PART ' + channel + ' :' + reason)
def quit(self, reason='Leaving'):
self.active = False
self.sockSend('QUIT :' + reason)
self.sock.close()
def nick(self, newnick):
self.sockSend('NICK ' + newnick)
self.nick = newnick
def irc_onMsg(self, nickFrom, host, to, msg):
sleep(0.5)
if to[0] == '#': #channel
split = msg.split(' ')
if split[0].lower() == '!rooms': def sp_joined(self, who, room):
rooms = self.functions[1]() msg ="{}<{}>{} has joined the room: `{}`".format(ColorCode.BOLD, who, ColorCode.NORMAL, room)
self._sendChanMessage(msg)
if len(rooms) == 0: def sp_left(self, who, room):
self.msg(to, chr(3) + '12Notice:' + chr(15) + ' No rooms found on server') msg ="{}<{}>{} has left the room: `{}`".format(ColorCode.BOLD, who, ColorCode.NORMAL, room)
return self._sendChanMessage(msg)
out = 'Currently the Syncplay server hosts viewing sessions as follows: ' def sp_unpaused(self, who, room):
i = 0 msg ="{}<{}>{} has unpaused (in room `{}`)".format(ColorCode.BOLD, who, ColorCode.NORMAL, room)
for room in rooms: self._sendChanMessage(msg)
if i == len(rooms)-1:
out += chr(3) + '10' + room + chr(15) + '.'
elif i == len(rooms)-2:
out += chr(3) + '10' + room + chr(15) + ' and ultimately '
else:
out += chr(3) + '10' + room + chr(15) + ', '
i += 1
self.msg(to, out)
elif split[0].lower() == '!roominfo':
if len(split) >= 2:
rooms = self.functions[1]()
room = ''
for r in split[1:]:
room += r + ' '
room = room[:-1]
if (room in rooms) == False:
self.msg(to, chr(3) + '5Error!' + chr(15) + ' Room does not exists (' + room + ')')
else:
users = self.functions[4](room)
paused = self.functions[5](room)
out = chr(2) + '<Paused>' + chr(15) if paused else chr(2) + '<Playing>' + chr(15)
time = self.functions[2](room)
if time == None: time = 0
for u in users:
if u['length'] == None: continue
out += ' [' + utils.formatTime(time) + '/' + utils.formatTime(u['length']) + '] '
break
else:
out += ' '
for u in users: def sp_paused(self, who, room):
if u['file'] == None: continue msg ="{}<{}>{} has paused (in room `{}`)".format(ColorCode.BOLD, who, ColorCode.NORMAL, room)
out += u['file'] self._sendChanMessage(msg)
break
else:
out += '[no file]'
self.msg(to, out)
out = 'Users: '
i = 0
for user in users:
if i == len(users)-1:
out += chr(3) + '2' + user['nick'] + chr(15) + '.'
elif i == len(users)-2:
out += chr(3) + '2' + user['nick'] + chr(15) + ' and '
else:
out += chr(3) + '2' + user['nick'] + chr(15) + ', '
i += 1
self.msg(to, out)
else:
self.msg(to, chr(2) + 'Usage:' + chr(15) + ' !roominfo [room]')
elif split[0].lower() == '!pause':
rooms = self.functions[1]()
for room in rooms: def sp_fileplaying(self, who, filename, room):
users = self.functions[4](room) if filename:
for u in users: msg ="{}<{}>{} is playing {} (in room `{}`)".format(ColorCode.BOLD, who, ColorCode.NORMAL, filename, room)
if u['nick'] == nickFrom: self._sendChanMessage(msg)
self.functions[0](nickFrom, True)
return
self.msg(to, chr(3) + '5Error!' + chr(15) + ' Your nick was not found on the server')
elif split[0].lower() == '!play':
rooms = self.functions[1]()
for room in rooms: def sp_seek(self, who, fromTime, toTime, room):
users = self.functions[4](room) v = (ColorCode.BOLD, who, ColorCode.NORMAL, utils.formatTime(fromTime), utils.formatTime(toTime), room,)
for u in users: msg ="{}<{}>{} has jumped from {} to {} (in room `{}`)".format(*v)
if u['nick'] == nickFrom: self._sendChanMessage(msg)
self.functions[0](nickFrom, False)
return
self.msg(to, chr(3) + '5Error!' + chr(15) + ' Your nick was not found on the server')
elif split[0].lower() == '!help':
self.msg(to, chr(2) + 'Available commands:' + chr(15) + ' !rooms / !roominfo [room] / !pause / !play')
def handlingThread(sock, bot): class BotProto(irc.IRCClient):
while bot.active: def __init__(self, bot, nickname):
try: self.nickname = nickname
rcvd = sock.recv(4096).split('\n') self.bot = bot
except socket.error, info: self.bot.registerProto(self)
bot.active = False
print '\033[91mSocket error (bot disconnected)\033[0;0m ' + str(info)
break
for line in rcvd:
try:
line = line.replace('\r', '')
if line.split(' ')[0] == 'PING': def signedOn(self):
try: self.join(self.factory.channel)
sock.send('\r\nPONG ' + line.split(' ')[1].replace(':', '') + '\r\n')
except: #if we were fooled by the server :C
sock.send('\r\nPONG\r\n')
#\r\n on the beggining too because if we send two things too fast, the IRC server can discern
lsplit = line.split(':') def joined(self, channel):
if len(lsplit) >= 2: self.msg(channel, "Syncplay IRC Bot - I'm all fired up!")
if len(lsplit[1].split(' ')) >= 2:
if lsplit[1].split(' ')[1] == '404':
bot.join(bot.channel, bot.channelPassword)
if 'PRIVMSG' in lsplit[1] or 'NOTICE' in lsplit[1]: def privmsg(self, user, channel, msg):
# ---BEGIN WTF BLOCK--- user = user.split('!', 1)[0]
lsplit = line.split(':') isActionMessage = channel == self.nickname or msg.startswith(self.nickname + ":") or msg.startswith("!") or msg.startswith(".")
addrnfrom = '' if isActionMessage:
if '~' in lsplit[1]: action = msg.replace(self.nickname + ":", "")
addrnfrom = lsplit[1].split('~')[1].split(' ')[0] action = msg.lstrip(".!")
nfrom = lsplit[1].split('!')[0] reply = self.bot.takeAction(action.lower(), user)
else: for line in reply.splitlines():
nfrom = lsplit[1].split('!')[0] self.msg(channel, line)
if len(lsplit[1].split()) >= 3: def sendChanMessage(self, msg):
to = lsplit[1].split()[2] self.msg(self.factory.channel, msg)
msg = ''
for brks in lsplit[2:]: class BotFactory(protocol.ClientFactory):
msg += brks + ':' def __init__(self, bot, channel, nickname):
msg = msg[:-1].lstrip() self.channel = channel
# ---END WTF BLOCK- -- self.nickname = nickname
bot.irc_onMsg(nfrom, addrnfrom, to, msg) self.bot = bot
except:
print traceback.format_exc() def buildProtocol(self, addr):
p = BotProto(self.bot, self.nickname)
p.factory = self
return p
def clientConnectionLost(self, connector, reason):
connector.connect()
def clientConnectionFailed(self, connector, reason):
print "IRC Bot connection failed, please check your configuration"

View File

@ -1,5 +1,4 @@
#coding:utf8 #coding:utf8
#TODO: #12, #13, #8;
import hashlib import hashlib
from twisted.internet import task, reactor from twisted.internet import task, reactor
from twisted.internet.protocol import Factory from twisted.internet.protocol import Factory
@ -30,56 +29,45 @@ class SyncFactory(Factory):
if(ircConnectionData): if(ircConnectionData):
self.setupIRCBot(ircConnectionData) self.setupIRCBot(ircConnectionData)
def readIrcConfig(self, ircConfig): #TODO: def readIrcConfig(self, ircConfig):
if(ircConfig and os.path.isfile(ircConfig)): if(ircConfig and os.path.isfile(ircConfig)):
cfg = codecs.open(ircConfig, "r", "utf-8-sig").read() cfg = codecs.open(ircConfig, "r", "utf-8-sig").read()
cfg = cfg.splitlines() cfg = cfg.splitlines()
ircConnectionData = { ircConnectionData = {
"server": "", "server": "",
"serverPassword": "",
"port": "", "port": "",
"nick": "", "nick": "",
"nickservPass": "",
"channelPassword": "",
"channel": "" "channel": ""
} }
for line in cfg: for line in cfg:
if("irc.server: " in line): if("irc.server: " in line):
ircConnectionData['server'] = line.split(": ")[1] ircConnectionData['server'] = line.split(": ")[1]
elif("irc.serverPassword: " in line):
ircConnectionData['serverPassword'] = line.split(": ")[1]
elif("irc.serverPort: " in line): elif("irc.serverPort: " in line):
ircConnectionData['port'] = int(line.split(": ")[1]) ircConnectionData['port'] = int(line.split(": ")[1])
elif("irc.botName: " in line): elif("irc.botName: " in line):
ircConnectionData['nick'] = line.split(": ")[1] ircConnectionData['nick'] = line.split(": ")[1]
elif("irc.nickservPass: " in line):
ircConnectionData['nickservPass'] = line.split(": ")[1]
elif("irc.channelPassword: " in line):
ircConnectionData['channelPassword'] = line.split(": ")[1]
elif("irc.channel: " in line): elif("irc.channel: " in line):
ircConnectionData['channel'] = line.split(": ")[1] ircConnectionData['channel'] = line.split(": ")[1]
return ircConnectionData return ircConnectionData
def setupIRCBot(self, ircConnectionData): def setupIRCBot(self, ircConnectionData):
botFunctions = [ botFunctions = {
self.ircPauseRoom, "pause": self.ircPauseRoom,
self.getRooms, "getRooms": self.getRooms,
self.getRoomPosition, "setRoomPosition": self.ircSetRoomPosition,
self.ircSetRoomPosition, "getRoomPosition": self.getRoomPosition,
self.getRoomUsernames, "getRoomUsers": self.getRoomUsernames,
self.isRoomPaused, "isRoomPaused": self.isRoomPaused,
] }
try: try:
self.ircBot = IRCBot( self.ircBot = IRCBot(
ircConnectionData['server'], ircConnectionData['server'],
ircConnectionData['serverPassword'],
ircConnectionData['port'], ircConnectionData['port'],
ircConnectionData['nick'], ircConnectionData['nick'],
ircConnectionData['nickservPass'],
ircConnectionData['channel'], ircConnectionData['channel'],
ircConnectionData['channelPassword'],
botFunctions, botFunctions,
) )
self.ircBot.start()
except: except:
print "IRC Bot could not be started, please check your configuration" print "IRC Bot could not be started, please check your configuration"
@ -339,9 +327,9 @@ class SyncFactory(Factory):
if room in self._rooms: if room in self._rooms:
for user in self._rooms[room].itervalues(): for user in self._rooms[room].itervalues():
if(user.file): if(user.file):
l.append({'nick': user.name, 'file': user.file['name'], "length": user.file['duration']}) l.append({'nick': user.name, 'file': user.file['name'], "duration": user.file['duration']})
else: else:
l.append({'nick': user.name, 'file': None, "length": None}) l.append({'nick': user.name, 'file': None, "duration": None})
return l return l
def isRoomPaused(self, room): def isRoomPaused(self, room):