mirror of
https://github.com/jlu5/PyLink.git
synced 2024-11-01 09:19:23 +01:00
924 lines
41 KiB
Python
924 lines
41 KiB
Python
# relay.py: PyLink Relay plugin
|
|
import sys
|
|
import os
|
|
sys.path.append(os.path.dirname(os.path.dirname(os.path.abspath(__file__))))
|
|
import pickle
|
|
import sched
|
|
import threading
|
|
import string
|
|
from collections import defaultdict
|
|
|
|
import utils
|
|
from log import log
|
|
|
|
dbname = "pylinkrelay.db"
|
|
relayusers = defaultdict(dict)
|
|
|
|
def relayWhoisHandlers(irc, target):
|
|
user = irc.users[target]
|
|
orig = getLocalUser(irc, target)
|
|
if orig:
|
|
network, remoteuid = orig
|
|
remotenick = utils.networkobjects[network].users[remoteuid].nick
|
|
return [320, "%s :is a remote user connected via PyLink Relay. Home "
|
|
"network: %s; Home nick: %s" % (user.nick, network,
|
|
remotenick)]
|
|
utils.whois_handlers.append(relayWhoisHandlers)
|
|
|
|
def normalizeNick(irc, netname, nick, separator=None):
|
|
# Block until we know the IRC network's nick length (after capabilities
|
|
# are sent)
|
|
log.debug('(%s) normalizeNick: waiting for irc.connected', irc.name)
|
|
irc.connected.wait(1)
|
|
|
|
separator = separator or irc.serverdata.get('separator') or "/"
|
|
log.debug('(%s) normalizeNick: using %r as separator.', irc.name, separator)
|
|
|
|
orig_nick = nick
|
|
protoname = irc.proto.__name__
|
|
maxnicklen = irc.maxnicklen
|
|
if not protoname.startswith(('insp', 'unreal')):
|
|
# Charybdis doesn't allow / in usernames, and will quit with
|
|
# a protocol violation if there is one.
|
|
separator = separator.replace('/', '|')
|
|
nick = nick.replace('/', '|')
|
|
if nick.startswith(tuple(string.digits)):
|
|
# On TS6 IRCd-s, nicks that start with 0-9 are only allowed if
|
|
# they match the UID of the originating server. Otherwise, you'll
|
|
# get nasty protocol violations!
|
|
nick = '_' + nick
|
|
tagnicks = True
|
|
|
|
suffix = separator + netname
|
|
nick = nick[:maxnicklen]
|
|
# Maximum allowed length of a nickname.
|
|
allowedlength = maxnicklen - len(suffix)
|
|
# If a nick is too long, the real nick portion must be cut off, but the
|
|
# /network suffix must remain the same.
|
|
|
|
nick = nick[:allowedlength]
|
|
nick += suffix
|
|
# FIXME: factorize
|
|
while utils.nickToUid(irc, nick) and not utils.isInternalClient(irc, utils.nickToUid(irc, nick)):
|
|
# The nick we want exists? Darn, create another one then, but only if
|
|
# the target isn't an internal client!
|
|
# Increase the separator length by 1 if the user was already tagged,
|
|
# but couldn't be created due to a nick conflict.
|
|
# This can happen when someone steals a relay user's nick.
|
|
new_sep = separator + separator[-1]
|
|
log.debug('(%s) normalizeNick: using %r as new_sep.', irc.name, separator)
|
|
nick = normalizeNick(irc, netname, orig_nick, separator=new_sep)
|
|
finalLength = len(nick)
|
|
assert finalLength <= maxnicklen, "Normalized nick %r went over max " \
|
|
"nick length (got: %s, allowed: %s!" % (nick, finalLength, maxnicklen)
|
|
|
|
return nick
|
|
|
|
def loadDB():
|
|
global db
|
|
try:
|
|
with open(dbname, "rb") as f:
|
|
db = pickle.load(f)
|
|
except (ValueError, IOError):
|
|
log.exception("Relay: failed to load links database %s"
|
|
", creating a new one in memory...", dbname)
|
|
db = {}
|
|
|
|
def exportDB(reschedule=False):
|
|
scheduler = utils.schedulers.get('relaydb')
|
|
if reschedule and scheduler:
|
|
scheduler.enter(30, 1, exportDB, argument=(True,))
|
|
log.debug("Relay: exporting links database to %s", dbname)
|
|
with open(dbname, 'wb') as f:
|
|
pickle.dump(db, f, protocol=4)
|
|
|
|
@utils.add_cmd
|
|
def save(irc, source, args):
|
|
"""takes no arguments.
|
|
|
|
Saves the relay database to disk."""
|
|
if irc.users[source].identified:
|
|
exportDB()
|
|
utils.msg(irc, source, 'Done.')
|
|
else:
|
|
utils.msg(irc, source, 'Error: you are not authenticated!')
|
|
return
|
|
|
|
def getPrefixModes(irc, remoteirc, channel, user):
|
|
modes = ''
|
|
for pmode in ('owner', 'admin', 'op', 'halfop', 'voice'):
|
|
if pmode in remoteirc.cmodes: # Mode supported by IRCd
|
|
mlist = irc.channels[channel].prefixmodes[pmode+'s']
|
|
log.debug('(%s) getPrefixModes: checking if %r is in %r', irc.name, user, mlist)
|
|
if user in mlist:
|
|
modes += remoteirc.cmodes[pmode]
|
|
return modes
|
|
|
|
def getRemoteUser(irc, remoteirc, user, spawnIfMissing=True):
|
|
# If the user (stored here as {('netname', 'UID'):
|
|
# {'network1': 'UID1', 'network2': 'UID2'}}) exists, don't spawn it
|
|
# again!
|
|
try:
|
|
if user == remoteirc.pseudoclient.uid:
|
|
return irc.pseudoclient.uid
|
|
if user == irc.pseudoclient.uid:
|
|
return remoteirc.pseudoclient.uid
|
|
except AttributeError: # Network hasn't been initialized yet?
|
|
pass
|
|
try:
|
|
u = relayusers[(irc.name, user)][remoteirc.name]
|
|
except KeyError:
|
|
userobj = irc.users.get(user)
|
|
if userobj is None or (not spawnIfMissing) or (not remoteirc.connected):
|
|
# The query wasn't actually a valid user, or the network hasn't
|
|
# been connected yet... Oh well!
|
|
return
|
|
nick = normalizeNick(remoteirc, irc.name, userobj.nick)
|
|
# Truncate idents at 10 characters, because TS6 won't like them otherwise!
|
|
ident = userobj.ident[:10]
|
|
# Ditto hostname at 64 chars.
|
|
host = userobj.host[:64]
|
|
realname = userobj.realname
|
|
modes = getSupportedUmodes(irc, remoteirc, userobj.modes)
|
|
u = remoteirc.proto.spawnClient(remoteirc, nick, ident=ident,
|
|
host=host, realname=realname,
|
|
modes=modes, ts=userobj.ts).uid
|
|
remoteirc.users[u].remote = irc.name
|
|
relayusers[(irc.name, user)][remoteirc.name] = u
|
|
remoteirc.users[u].remote = irc.name
|
|
return u
|
|
|
|
def getLocalUser(irc, user, targetirc=None):
|
|
"""<irc object> <pseudoclient uid> [<target irc object>]
|
|
|
|
Returns a tuple with the home network name and the UID of the original
|
|
user that <pseudoclient uid> was spawned for, where <pseudoclient uid>
|
|
is the UID of a PyLink relay dummy client.
|
|
|
|
If <target irc object> is specified, returns the UID of the pseudoclient
|
|
representing the original user on the target network, similar to what
|
|
getRemoteUser() does."""
|
|
# First, iterate over everyone!
|
|
remoteuser = None
|
|
for k, v in relayusers.items():
|
|
log.debug('(%s) getLocalUser: processing %s, %s in relayusers', irc.name, k, v)
|
|
if k[0] == irc.name:
|
|
# We don't need to do anything if the target users is on
|
|
# the same network as us.
|
|
log.debug('(%s) getLocalUser: skipping %s since the target network matches the source network.', irc.name, k)
|
|
continue
|
|
if v.get(irc.name) == user:
|
|
# If the stored pseudoclient UID for the kicked user on
|
|
# this network matches the target we have, set that user
|
|
# as the one we're kicking! It's a handful, but remember
|
|
# we're mapping (home network, UID) pairs to their
|
|
# respective relay pseudoclients on other networks.
|
|
remoteuser = k
|
|
log.debug('(%s) getLocalUser: found %s to correspond to %s.', irc.name, v, k)
|
|
break
|
|
log.debug('(%s) getLocalUser: remoteuser set to %r (looking up %s/%s).', irc.name, remoteuser, user, irc.name)
|
|
if remoteuser:
|
|
# If targetirc is given, we'll return simply the UID of the user on the
|
|
# target network, if it exists. Otherwise, we'll return a tuple
|
|
# with the home network name and the original user's UID.
|
|
sourceobj = utils.networkobjects.get(remoteuser[0])
|
|
if targetirc and sourceobj:
|
|
if remoteuser[0] == targetirc.name:
|
|
# The user we found's home network happens to be the one being
|
|
# requested; just return the UID then.
|
|
return remoteuser[1]
|
|
# Otherwise, use getRemoteUser to find our UID.
|
|
res = getRemoteUser(sourceobj, targetirc, remoteuser[1], spawnIfMissing=False)
|
|
log.debug('(%s) getLocalUser: targetirc found, getting %r as remoteuser for %r (looking up %s/%s).', irc.name, res, remoteuser[1], user, irc.name)
|
|
return res
|
|
else:
|
|
return remoteuser
|
|
|
|
def findRelay(chanpair):
|
|
if chanpair in db: # This chanpair is a shared channel; others link to it
|
|
return chanpair
|
|
# This chanpair is linked *to* a remote channel
|
|
for name, dbentry in db.items():
|
|
if chanpair in dbentry['links']:
|
|
return name
|
|
|
|
def findRemoteChan(irc, remoteirc, channel):
|
|
query = (irc.name, channel)
|
|
remotenetname = remoteirc.name
|
|
chanpair = findRelay(query)
|
|
if chanpair is None:
|
|
return
|
|
if chanpair[0] == remotenetname:
|
|
return chanpair[1]
|
|
else:
|
|
for link in db[chanpair]['links']:
|
|
if link[0] == remotenetname:
|
|
return link[1]
|
|
|
|
def initializeChannel(irc, channel):
|
|
# We're initializing a relay that already exists. This can be done at
|
|
# ENDBURST, or on the LINK command.
|
|
c = irc.channels[channel]
|
|
relay = findRelay((irc.name, channel))
|
|
log.debug('(%s) initializeChannel being called on %s', irc.name, channel)
|
|
log.debug('(%s) initializeChannel: relay pair found to be %s', irc.name, relay)
|
|
queued_users = []
|
|
if relay:
|
|
all_links = db[relay]['links'].copy()
|
|
all_links.update((relay,))
|
|
log.debug('(%s) initializeChannel: all_links: %s', irc.name, all_links)
|
|
# Iterate over all the remote channels linked in this relay.
|
|
for link in all_links:
|
|
modes = []
|
|
remotenet, remotechan = link
|
|
if remotenet == irc.name:
|
|
continue
|
|
remoteirc = utils.networkobjects.get(remotenet)
|
|
if remoteirc is None:
|
|
continue
|
|
rc = remoteirc.channels[remotechan]
|
|
if not (remoteirc.connected and findRemoteChan(remoteirc, irc, remotechan)):
|
|
continue # They aren't connected, don't bother!
|
|
# Join their (remote) users and set their modes.
|
|
relayJoins(remoteirc, remotechan, rc.users,
|
|
rc.ts, rc.modes)
|
|
relayModes(irc, remoteirc, irc.sid, channel)
|
|
topic = remoteirc.channels[relay[1]].topic
|
|
# Only update the topic if it's different from what we already have,
|
|
# and topic bursting is complete.
|
|
if remoteirc.channels[channel].topicset and topic != irc.channels[channel].topic:
|
|
irc.proto.topicServer(irc, irc.sid, channel, topic)
|
|
|
|
log.debug('(%s) initializeChannel: joining our users: %s', irc.name, c.users)
|
|
# After that's done, we'll send our users to them.
|
|
relayJoins(irc, channel, c.users, c.ts, c.modes)
|
|
irc.proto.joinClient(irc, irc.pseudoclient.uid, channel)
|
|
|
|
def handle_join(irc, numeric, command, args):
|
|
channel = args['channel']
|
|
if not findRelay((irc.name, channel)):
|
|
# No relay here, return.
|
|
return
|
|
modes = args['modes']
|
|
ts = args['ts']
|
|
users = set(args['users'])
|
|
relayJoins(irc, channel, users, ts, modes)
|
|
utils.add_hook(handle_join, 'JOIN')
|
|
|
|
def handle_quit(irc, numeric, command, args):
|
|
ouruser = numeric
|
|
for netname, user in relayusers[(irc.name, numeric)].items():
|
|
remoteirc = utils.networkobjects[netname]
|
|
remoteirc.proto.quitClient(remoteirc, user, args['text'])
|
|
del relayusers[(irc.name, ouruser)]
|
|
utils.add_hook(handle_quit, 'QUIT')
|
|
|
|
def handle_squit(irc, numeric, command, args):
|
|
users = args['users']
|
|
for user in users:
|
|
log.debug('(%s) relay handle_squit: sending handle_quit on %s', irc.name, user)
|
|
handle_quit(irc, user, command, {'text': '*.net *.split'})
|
|
utils.add_hook(handle_squit, 'SQUIT')
|
|
|
|
def handle_nick(irc, numeric, command, args):
|
|
for netname, user in relayusers[(irc.name, numeric)].items():
|
|
remoteirc = utils.networkobjects[netname]
|
|
newnick = normalizeNick(remoteirc, irc.name, args['newnick'])
|
|
if remoteirc.users[user].nick != newnick:
|
|
remoteirc.proto.nickClient(remoteirc, user, newnick)
|
|
utils.add_hook(handle_nick, 'NICK')
|
|
|
|
def handle_part(irc, numeric, command, args):
|
|
channels = args['channels']
|
|
text = args['text']
|
|
for channel in channels:
|
|
for netname, user in relayusers[(irc.name, numeric)].copy().items():
|
|
remoteirc = utils.networkobjects[netname]
|
|
remotechan = findRemoteChan(irc, remoteirc, channel)
|
|
if remotechan is None:
|
|
continue
|
|
remoteirc.proto.partClient(remoteirc, user, remotechan, text)
|
|
if not remoteirc.users[user].channels:
|
|
remoteirc.proto.quitClient(remoteirc, user, 'Left all shared channels.')
|
|
del relayusers[(irc.name, numeric)][remoteirc.name]
|
|
utils.add_hook(handle_part, 'PART')
|
|
|
|
def handle_privmsg(irc, numeric, command, args):
|
|
notice = (command == 'NOTICE')
|
|
target = args['target']
|
|
text = args['text']
|
|
if target == irc.pseudoclient.uid:
|
|
return
|
|
sent = 0
|
|
relay = findRelay((irc.name, target))
|
|
# Don't send any "you must be in common channels" if we're not part
|
|
# of a relay, or we are but there are no links!
|
|
if utils.isChannel(target) and ((relay and not db[relay]['links']) or \
|
|
relay is None):
|
|
return
|
|
for netname, user in relayusers[(irc.name, numeric)].items():
|
|
remoteirc = utils.networkobjects[netname]
|
|
# HACK: Don't break on sending to @#channel or similar.
|
|
try:
|
|
prefix, target = target.split('#', 1)
|
|
except ValueError:
|
|
prefix = ''
|
|
else:
|
|
target = '#' + target
|
|
if utils.isChannel(target):
|
|
log.debug('(%s) relay privmsg: prefix is %r, target is %r', irc.name, prefix, target)
|
|
real_target = findRemoteChan(irc, remoteirc, target)
|
|
if not real_target:
|
|
continue
|
|
real_target = prefix + real_target
|
|
else:
|
|
remoteuser = getLocalUser(irc, target)
|
|
if remoteuser is None:
|
|
continue
|
|
real_target = remoteuser[1]
|
|
if notice:
|
|
remoteirc.proto.noticeClient(remoteirc, user, real_target, text)
|
|
else:
|
|
remoteirc.proto.messageClient(remoteirc, user, real_target, text)
|
|
sent += 1
|
|
if not sent:
|
|
# We must be on a common channel with the target. Otherwise, the sender
|
|
# doesn't have a client representing them on the remote network,
|
|
# and we won't have anywhere to send our messages from.
|
|
# In this case, we've iterated over all networks where the sender
|
|
# has pseudoclients, and found no suitable targets to send to.
|
|
if target in irc.users:
|
|
target_s = 'a common channel with %r' % irc.users[target].nick
|
|
else:
|
|
target_s = repr(target)
|
|
utils.msg(irc, numeric, 'Error: You must be in %s in order to send messages.' % \
|
|
target_s, notice=True)
|
|
utils.add_hook(handle_privmsg, 'PRIVMSG')
|
|
utils.add_hook(handle_privmsg, 'NOTICE')
|
|
|
|
def handle_kick(irc, source, command, args):
|
|
channel = args['channel']
|
|
target = args['target']
|
|
text = args['text']
|
|
kicker = source
|
|
kicker_modes = getPrefixModes(irc, irc, channel, kicker)
|
|
relay = findRelay((irc.name, channel))
|
|
if relay is None:
|
|
return
|
|
for name, remoteirc in utils.networkobjects.items():
|
|
if irc.name == name:
|
|
continue
|
|
remotechan = findRemoteChan(irc, remoteirc, channel)
|
|
log.debug('(%s) Relay kick: remotechan for %s on %s is %s', irc.name, channel, name, remotechan)
|
|
if remotechan is None:
|
|
continue
|
|
real_kicker = getRemoteUser(irc, remoteirc, kicker, spawnIfMissing=False)
|
|
log.debug('(%s) Relay kick: real kicker for %s on %s is %s', irc.name, kicker, name, real_kicker)
|
|
if not utils.isInternalClient(irc, target):
|
|
log.debug('(%s) Relay kick: target %s is NOT an internal client', irc.name, target)
|
|
# Both the target and kicker are external clients; i.e.
|
|
# they originate from the same network. We won't have
|
|
# to filter this; the uplink IRCd will handle it appropriately,
|
|
# and we'll just follow.
|
|
real_target = getRemoteUser(irc, remoteirc, target)
|
|
log.debug('(%s) Relay kick: real target for %s is %s', irc.name, target, real_target)
|
|
else:
|
|
log.debug('(%s) Relay kick: target %s is an internal client, going to look up the real user', irc.name, target)
|
|
real_target = getLocalUser(irc, target, targetirc=remoteirc)
|
|
log.debug('(%s) Relay kick: kicker_modes are %r', irc.name, kicker_modes)
|
|
if irc.name not in db[relay]['claim'] and not \
|
|
any([mode in kicker_modes for mode in ('q', 'a', 'o', 'h')]):
|
|
log.debug('(%s) Relay kick: kicker %s is not opped... We should rejoin the target user %s', irc.name, kicker, real_target)
|
|
# Home network is not in the channel's claim AND the kicker is not
|
|
# opped. We won't propograte the kick then.
|
|
# TODO: make the check slightly more advanced: i.e. halfops can't
|
|
# kick ops, admins can't kick owners, etc.
|
|
modes = getPrefixModes(remoteirc, irc, remotechan, real_target)
|
|
# Join the kicked client back with its respective modes.
|
|
irc.proto.sjoinServer(irc, irc.sid, remotechan, [(modes, target)])
|
|
utils.msg(irc, kicker, "This channel is claimed; your kick has "
|
|
"to %s been blocked because you are not "
|
|
"(half)opped." % channel, notice=True)
|
|
return
|
|
|
|
# Propogate the kick!
|
|
if real_kicker:
|
|
log.debug('(%s) Relay kick: Kicking %s from channel %s via %s on behalf of %s/%s', irc.name, real_target, remotechan,real_kicker, kicker, irc.name)
|
|
remoteirc.proto.kickClient(remoteirc, real_kicker,
|
|
remotechan, real_target, text)
|
|
else:
|
|
# Kick originated from a server, or the kicker isn't in any
|
|
# common channels with the target relay network.
|
|
log.debug('(%s) Relay kick: Kicking %s from channel %s via %s on behalf of %s/%s', irc.name, real_target, remotechan,remoteirc.sid, kicker, irc.name)
|
|
try:
|
|
if kicker in irc.servers:
|
|
kname = irc.servers[kicker].name
|
|
else:
|
|
kname = irc.users.get(kicker).nick
|
|
text = "(%s/%s) %s" % (kname, irc.name, text)
|
|
except AttributeError:
|
|
text = "(<unknown kicker>@%s) %s" % (irc.name, text)
|
|
remoteirc.proto.kickServer(remoteirc, remoteirc.sid,
|
|
remotechan, real_target, text)
|
|
|
|
if target != irc.pseudoclient.uid and not irc.users[target].channels:
|
|
irc.proto.quitClient(irc, target, 'Left all shared channels.')
|
|
remoteuser = getLocalUser(irc, target)
|
|
del relayusers[remoteuser][irc.name]
|
|
|
|
utils.add_hook(handle_kick, 'KICK')
|
|
|
|
def handle_chgclient(irc, source, command, args):
|
|
target = args['target']
|
|
if args.get('newhost'):
|
|
field = 'HOST'
|
|
text = args['newhost']
|
|
elif args.get('newident'):
|
|
field = 'IDENT'
|
|
text = args['newident']
|
|
elif args.get('newgecos'):
|
|
field = 'GECOS'
|
|
text = args['newgecos']
|
|
if field:
|
|
for netname, user in relayusers[(irc.name, target)].items():
|
|
remoteirc = utils.networkobjects[netname]
|
|
try:
|
|
remoteirc.proto.updateClient(remoteirc, user, field, text)
|
|
except NotImplementedError: # IRCd doesn't support changing the field we want
|
|
log.debug('(%s) Ignoring changing field %r of %s on %s (for %s/%s);'
|
|
' remote IRCd doesn\'t support it', irc.name, field,
|
|
user, target, netname, irc.name)
|
|
continue
|
|
|
|
for c in ('CHGHOST', 'CHGNAME', 'CHGIDENT'):
|
|
utils.add_hook(handle_chgclient, c)
|
|
|
|
whitelisted_cmodes = {'admin', 'allowinvite', 'autoop', 'ban', 'banexception',
|
|
'blockcolor', 'halfop', 'invex', 'inviteonly', 'key',
|
|
'limit', 'moderated', 'noctcp', 'noextmsg', 'nokick',
|
|
'noknock', 'nonick', 'nonotice', 'op', 'operonly',
|
|
'opmoderated', 'owner', 'private', 'regonly',
|
|
'regmoderated', 'secret', 'sslonly', 'adminonly',
|
|
'stripcolor', 'topiclock', 'voice'}
|
|
whitelisted_umodes = {'bot', 'hidechans', 'hideoper', 'invisible', 'oper',
|
|
'regdeaf', 'u_stripcolor', 'u_noctcp', 'wallops'}
|
|
def relayModes(irc, remoteirc, sender, channel, modes=None):
|
|
remotechan = findRemoteChan(irc, remoteirc, channel)
|
|
log.debug('(%s) Relay mode: remotechan for %s on %s is %s', irc.name, channel, irc.name, remotechan)
|
|
if remotechan is None:
|
|
return
|
|
if modes is None:
|
|
modes = irc.channels[channel].modes
|
|
log.debug('(%s) Relay mode: channel data for %s%s: %s', irc.name, remoteirc.name, remotechan, remoteirc.channels[remotechan])
|
|
supported_modes = []
|
|
log.debug('(%s) Relay mode: initial modelist for %s is %s', irc.name, channel, modes)
|
|
for modepair in modes:
|
|
try:
|
|
prefix, modechar = modepair[0]
|
|
except ValueError:
|
|
modechar = modepair[0]
|
|
prefix = '+'
|
|
arg = modepair[1]
|
|
# Iterate over every mode see whether the remote IRCd supports
|
|
# this mode, and what its mode char for it is (if it is different).
|
|
for name, m in irc.cmodes.items():
|
|
supported_char = None
|
|
if modechar == m:
|
|
supported_char = remoteirc.cmodes.get(name)
|
|
if supported_char is None:
|
|
break
|
|
if name not in whitelisted_cmodes:
|
|
log.debug("(%s) Relay mode: skipping mode (%r, %r) because "
|
|
"it isn't a whitelisted (safe) mode for relay.",
|
|
irc.name, modechar, arg)
|
|
break
|
|
if modechar in irc.prefixmodes:
|
|
# This is a prefix mode (e.g. +o). We must coerse the argument
|
|
# so that the target exists on the remote relay network.
|
|
log.debug("(%s) Relay mode: coersing argument of (%r, %r) "
|
|
"for network %r.",
|
|
irc.name, modechar, arg, remoteirc.name)
|
|
# If the target is a remote user, get the real target
|
|
# (original user).
|
|
arg = getLocalUser(irc, arg, targetirc=remoteirc) or \
|
|
getRemoteUser(irc, remoteirc, arg, spawnIfMissing=False)
|
|
log.debug("(%s) Relay mode: argument found as (%r, %r) "
|
|
"for network %r.",
|
|
irc.name, modechar, arg, remoteirc.name)
|
|
oplist = remoteirc.channels[remotechan].prefixmodes[name+'s']
|
|
log.debug("(%s) Relay mode: list of %ss on %r is: %s",
|
|
irc.name, name, remotechan, oplist)
|
|
if prefix == '+' and arg in oplist:
|
|
# Don't set prefix modes that are already set.
|
|
log.debug("(%s) Relay mode: skipping setting %s on %s/%s because it appears to be already set.",
|
|
irc.name, name, arg, remoteirc.name)
|
|
break
|
|
supported_char = remoteirc.cmodes.get(name)
|
|
if supported_char:
|
|
final_modepair = (prefix+supported_char, arg)
|
|
if name in ('ban', 'banexception', 'invex') and not utils.isHostmask(arg):
|
|
# Don't add bans that don't match n!u@h syntax!
|
|
log.debug("(%s) Relay mode: skipping mode (%r, %r) because it doesn't match nick!user@host syntax.",
|
|
irc.name, modechar, arg)
|
|
break
|
|
# Don't set modes that are already set, to prevent floods on TS6
|
|
# where the same mode can be set infinite times.
|
|
if prefix == '+' and final_modepair in remoteirc.channels[remotechan].modes:
|
|
log.debug("(%s) Relay mode: skipping setting mode (%r, %r) on %s%s because it appears to be already set.",
|
|
irc.name, supported_char, arg, remoteirc.name, remotechan)
|
|
break
|
|
supported_modes.append(final_modepair)
|
|
log.debug('(%s) Relay mode: final modelist (sending to %s%s) is %s', irc.name, remoteirc.name, remotechan, supported_modes)
|
|
# Don't send anything if there are no supported modes left after filtering.
|
|
if supported_modes:
|
|
# Check if the sender is a user; remember servers are allowed to set modes too.
|
|
if sender in irc.users:
|
|
u = getRemoteUser(irc, remoteirc, sender, spawnIfMissing=False)
|
|
if u:
|
|
remoteirc.proto.modeClient(remoteirc, u, remotechan, supported_modes)
|
|
else:
|
|
remoteirc.proto.modeServer(remoteirc, remoteirc.sid, remotechan, supported_modes)
|
|
|
|
def getSupportedUmodes(irc, remoteirc, modes):
|
|
supported_modes = []
|
|
for modepair in modes:
|
|
try:
|
|
prefix, modechar = modepair[0]
|
|
except ValueError:
|
|
modechar = modepair[0]
|
|
prefix = '+'
|
|
arg = modepair[1]
|
|
for name, m in irc.umodes.items():
|
|
supported_char = None
|
|
if modechar == m:
|
|
if name not in whitelisted_umodes:
|
|
log.debug("(%s) getSupportedUmodes: skipping mode (%r, %r) because "
|
|
"it isn't a whitelisted (safe) mode for relay.",
|
|
irc.name, modechar, arg)
|
|
break
|
|
supported_char = remoteirc.umodes.get(name)
|
|
if supported_char:
|
|
supported_modes.append((prefix+supported_char, arg))
|
|
break
|
|
else:
|
|
log.debug("(%s) getSupportedUmodes: skipping mode (%r, %r) because "
|
|
"the remote network (%s)'s IRCd (%s) doesn't support it.",
|
|
irc.name, modechar, arg, remoteirc.name, irc.proto.__name__)
|
|
return supported_modes
|
|
|
|
def handle_mode(irc, numeric, command, args):
|
|
target = args['target']
|
|
modes = args['modes']
|
|
for name, remoteirc in utils.networkobjects.items():
|
|
if irc.name == name:
|
|
continue
|
|
if utils.isChannel(target):
|
|
relayModes(irc, remoteirc, numeric, target, modes)
|
|
else:
|
|
modes = getSupportedUmodes(irc, remoteirc, modes)
|
|
remoteuser = getRemoteUser(irc, remoteirc, target, spawnIfMissing=False)
|
|
if remoteuser is None:
|
|
continue
|
|
remoteirc.proto.modeClient(remoteirc, remoteuser, remoteuser, modes)
|
|
|
|
utils.add_hook(handle_mode, 'MODE')
|
|
|
|
def handle_topic(irc, numeric, command, args):
|
|
channel = args['channel']
|
|
topic = args['topic']
|
|
for name, remoteirc in utils.networkobjects.items():
|
|
if irc.name == name:
|
|
continue
|
|
|
|
remotechan = findRemoteChan(irc, remoteirc, channel)
|
|
# Don't send if the remote topic is the same as ours.
|
|
if remotechan is None or topic == remoteirc.channels[remotechan].topic:
|
|
continue
|
|
# This might originate from a server too.
|
|
remoteuser = getRemoteUser(irc, remoteirc, numeric, spawnIfMissing=False)
|
|
if remoteuser:
|
|
remoteirc.proto.topicClient(remoteirc, remoteuser, remotechan, topic)
|
|
else:
|
|
remoteirc.proto.topicServer(remoteirc, remoteirc.sid, remotechan, topic)
|
|
utils.add_hook(handle_topic, 'TOPIC')
|
|
|
|
def handle_kill(irc, numeric, command, args):
|
|
target = args['target']
|
|
userdata = args['userdata']
|
|
realuser = getLocalUser(irc, target)
|
|
log.debug('(%s) relay handle_kill: realuser is %r', irc.name, realuser)
|
|
# Target user was remote:
|
|
if realuser and realuser[0] != irc.name:
|
|
# We don't allow killing over the relay, so we must respawn the affected
|
|
# client and rejoin it to its channels.
|
|
del relayusers[realuser][irc.name]
|
|
remoteirc = utils.networkobjects[realuser[0]]
|
|
for channel in remoteirc.channels:
|
|
remotechan = findRemoteChan(remoteirc, irc, channel)
|
|
if remotechan:
|
|
modes = getPrefixModes(remoteirc, irc, remotechan, realuser[1])
|
|
log.debug('(%s) relay handle_kill: userpair: %s, %s', irc.name, modes, realuser)
|
|
client = getRemoteUser(remoteirc, irc, realuser[1])
|
|
irc.proto.sjoinServer(irc, irc.sid, remotechan, [(modes, client)])
|
|
if userdata and numeric in irc.users:
|
|
utils.msg(irc, numeric, "Your kill has to %s been blocked "
|
|
"because PyLink does not allow killing"
|
|
" users over the relay at this time." % \
|
|
userdata.nick, notice=True)
|
|
# Target user was local.
|
|
else:
|
|
# IMPORTANT: some IRCds (charybdis) don't send explicit QUIT messages
|
|
# for locally killed clients, while others (inspircd) do!
|
|
# If we receive a user object in 'userdata' instead of None, it means
|
|
# that the KILL hasn't been handled by a preceding QUIT message.
|
|
if userdata:
|
|
handle_quit(irc, target, 'KILL', {'text': args['text']})
|
|
|
|
utils.add_hook(handle_kill, 'KILL')
|
|
|
|
def relayJoins(irc, channel, users, ts, modes):
|
|
for name, remoteirc in utils.networkobjects.items():
|
|
queued_users = []
|
|
if name == irc.name:
|
|
# Don't relay things to their source network...
|
|
continue
|
|
remotechan = findRemoteChan(irc, remoteirc, channel)
|
|
if remotechan is None:
|
|
# If there is no link on our network for the user, don't
|
|
# bother spawning it.
|
|
continue
|
|
log.debug('(%s) relayJoins: got %r for users', irc.name, users)
|
|
for user in users.copy():
|
|
if utils.isInternalClient(irc, user) or user not in irc.users:
|
|
# We don't need to clone PyLink pseudoclients... That's
|
|
# meaningless.
|
|
continue
|
|
try:
|
|
if irc.users[user].remote:
|
|
# Is the .remote attribute set? If so, don't relay already
|
|
# relayed clients; that'll trigger an endless loop!
|
|
continue
|
|
except AttributeError: # Nope, it isn't.
|
|
pass
|
|
log.debug('Okay, spawning %s/%s everywhere', user, irc.name)
|
|
assert user in irc.users, "(%s) How is this possible? %r isn't in our user database." % (irc.name, user)
|
|
u = getRemoteUser(irc, remoteirc, user)
|
|
ts = irc.channels[channel].ts
|
|
# TODO: join users in batches with SJOIN, not one by one.
|
|
prefixes = getPrefixModes(irc, remoteirc, channel, user)
|
|
userpair = (prefixes, u)
|
|
queued_users.append(userpair)
|
|
log.debug('(%s) relayJoins: joining %s to %s%s', irc.name, userpair, remoteirc.name, remotechan)
|
|
remoteirc.proto.sjoinServer(remoteirc, remoteirc.sid, remotechan, queued_users, ts=ts)
|
|
relayModes(irc, remoteirc, irc.sid, channel, modes)
|
|
|
|
def relayPart(irc, channel, user):
|
|
for name, remoteirc in utils.networkobjects.items():
|
|
if name == irc.name:
|
|
# Don't relay things to their source network...
|
|
continue
|
|
remotechan = findRemoteChan(irc, remoteirc, channel)
|
|
log.debug('(%s) relayPart: looking for %s/%s on %s', irc.name, user, irc.name, remoteirc.name)
|
|
log.debug('(%s) relayPart: remotechan found as %s', irc.name, remotechan)
|
|
remoteuser = getRemoteUser(irc, remoteirc, user, spawnIfMissing=False)
|
|
log.debug('(%s) relayPart: remoteuser for %s/%s found as %s', irc.name, user, irc.name, remoteuser)
|
|
if remotechan is None or remoteuser is None:
|
|
continue
|
|
remoteirc.proto.partClient(remoteirc, remoteuser, remotechan, 'Channel delinked.')
|
|
if not remoteirc.users[remoteuser].channels:
|
|
remoteirc.proto.quitClient(remoteirc, remoteuser, 'Left all shared channels.')
|
|
del relayusers[(irc.name, user)][remoteirc.name]
|
|
|
|
def removeChannel(irc, channel):
|
|
if irc is None:
|
|
return
|
|
if channel not in map(str.lower, irc.serverdata['channels']):
|
|
irc.proto.partClient(irc, irc.pseudoclient.uid, channel)
|
|
relay = findRelay((irc.name, channel))
|
|
if relay:
|
|
for user in irc.channels[channel].users.copy():
|
|
if not utils.isInternalClient(irc, user):
|
|
relayPart(irc, channel, user)
|
|
# Don't ever part the main client from any of its autojoin channels.
|
|
else:
|
|
if user == irc.pseudoclient.uid and channel in \
|
|
irc.serverdata['channels']:
|
|
continue
|
|
irc.proto.partClient(irc, user, channel, 'Channel delinked.')
|
|
# Don't ever quit it either...
|
|
if user != irc.pseudoclient.uid and not irc.users[user].channels:
|
|
irc.proto.quitClient(irc, user, 'Left all shared channels.')
|
|
remoteuser = getLocalUser(irc, user)
|
|
del relayusers[remoteuser][irc.name]
|
|
|
|
@utils.add_cmd
|
|
def create(irc, source, args):
|
|
"""<channel>
|
|
|
|
Creates the channel <channel> over the relay."""
|
|
try:
|
|
channel = args[0].lower()
|
|
except IndexError:
|
|
utils.msg(irc, source, "Error: not enough arguments. Needs 1: channel.")
|
|
return
|
|
if not utils.isChannel(channel):
|
|
utils.msg(irc, source, 'Error: invalid channel %r.' % channel)
|
|
return
|
|
if source not in irc.channels[channel].users:
|
|
utils.msg(irc, source, 'Error: you must be in %r to complete this operation.' % channel)
|
|
return
|
|
if not utils.isOper(irc, source):
|
|
utils.msg(irc, source, 'Error: you must be opered in order to complete this operation.')
|
|
return
|
|
db[(irc.name, channel)] = {'claim': [irc.name], 'links': set(), 'blocked_nets': set()}
|
|
initializeChannel(irc, channel)
|
|
utils.msg(irc, source, 'Done.')
|
|
|
|
@utils.add_cmd
|
|
def destroy(irc, source, args):
|
|
"""<channel>
|
|
|
|
Removes <channel> from the relay, delinking all networks linked to it."""
|
|
try:
|
|
channel = args[0].lower()
|
|
except IndexError:
|
|
utils.msg(irc, source, "Error: not enough arguments. Needs 1: channel.")
|
|
return
|
|
if not utils.isChannel(channel):
|
|
utils.msg(irc, source, 'Error: invalid channel %r.' % channel)
|
|
return
|
|
if not utils.isOper(irc, source):
|
|
utils.msg(irc, source, 'Error: you must be opered in order to complete this operation.')
|
|
return
|
|
|
|
entry = (irc.name, channel)
|
|
if entry in db:
|
|
for link in db[entry]['links']:
|
|
removeChannel(utils.networkobjects.get(link[0]), link[1])
|
|
removeChannel(irc, channel)
|
|
del db[entry]
|
|
utils.msg(irc, source, 'Done.')
|
|
else:
|
|
utils.msg(irc, source, 'Error: no such relay %r exists.' % channel)
|
|
return
|
|
|
|
@utils.add_cmd
|
|
def link(irc, source, args):
|
|
"""<remotenet> <channel> <local channel>
|
|
|
|
Links channel <channel> on <remotenet> over the relay to <local channel>.
|
|
If <local channel> is not specified, it defaults to the same name as <channel>."""
|
|
try:
|
|
channel = args[1].lower()
|
|
remotenet = args[0].lower()
|
|
except IndexError:
|
|
utils.msg(irc, source, "Error: not enough arguments. Needs 2-3: remote netname, channel, local channel name (optional).")
|
|
return
|
|
try:
|
|
localchan = args[2].lower()
|
|
except IndexError:
|
|
localchan = channel
|
|
for c in (channel, localchan):
|
|
if not utils.isChannel(c):
|
|
utils.msg(irc, source, 'Error: invalid channel %r.' % c)
|
|
return
|
|
if source not in irc.channels[localchan].users:
|
|
utils.msg(irc, source, 'Error: you must be in %r to complete this operation.' % localchan)
|
|
return
|
|
if not utils.isOper(irc, source):
|
|
utils.msg(irc, source, 'Error: you must be opered in order to complete this operation.')
|
|
return
|
|
if remotenet not in utils.networkobjects:
|
|
utils.msg(irc, source, 'Error: no network named %r exists.' % remotenet)
|
|
return
|
|
localentry = findRelay((irc.name, localchan))
|
|
if localentry:
|
|
utils.msg(irc, source, 'Error: channel %r is already part of a relay.' % localchan)
|
|
return
|
|
try:
|
|
entry = db[(remotenet, channel)]
|
|
except KeyError:
|
|
utils.msg(irc, source, 'Error: no such relay %r exists.' % channel)
|
|
return
|
|
else:
|
|
for link in entry['links']:
|
|
if link[0] == irc.name:
|
|
utils.msg(irc, source, "Error: remote channel '%s%s' is already"
|
|
" linked here as %r." % (remotenet,
|
|
channel, link[1]))
|
|
return
|
|
entry['links'].add((irc.name, localchan))
|
|
initializeChannel(irc, localchan)
|
|
utils.msg(irc, source, 'Done.')
|
|
|
|
@utils.add_cmd
|
|
def delink(irc, source, args):
|
|
"""<local channel> [<network>]
|
|
|
|
Delinks channel <local channel>. <network> must and can only be specified if you are on the host network for <local channel>, and allows you to pick which network to delink.
|
|
To remove a relay entirely, use the 'destroy' command instead."""
|
|
try:
|
|
channel = args[0].lower()
|
|
except IndexError:
|
|
utils.msg(irc, source, "Error: not enough arguments. Needs 1-2: channel, remote netname (optional).")
|
|
return
|
|
try:
|
|
remotenet = args[1].lower()
|
|
except IndexError:
|
|
remotenet = None
|
|
if not utils.isOper(irc, source):
|
|
utils.msg(irc, source, 'Error: you must be opered in order to complete this operation.')
|
|
return
|
|
if not utils.isChannel(channel):
|
|
utils.msg(irc, source, 'Error: invalid channel %r.' % channel)
|
|
return
|
|
entry = findRelay((irc.name, channel))
|
|
if entry:
|
|
if entry[0] == irc.name: # We own this channel.
|
|
if remotenet is None:
|
|
utils.msg(irc, source, "Error: you must select a network to delink, or use the 'destroy' command no remove this relay entirely.")
|
|
return
|
|
else:
|
|
for link in db[entry]['links'].copy():
|
|
if link[0] == remotenet:
|
|
removeChannel(utils.networkobjects.get(remotenet), link[1])
|
|
db[entry]['links'].remove(link)
|
|
else:
|
|
removeChannel(irc, channel)
|
|
db[entry]['links'].remove((irc.name, channel))
|
|
utils.msg(irc, source, 'Done.')
|
|
else:
|
|
utils.msg(irc, source, 'Error: no such relay %r.' % channel)
|
|
|
|
def initializeAll(irc):
|
|
log.debug('(%s) initializeAll: waiting for utils.started', irc.name)
|
|
utils.started.wait()
|
|
for chanpair, entrydata in db.items():
|
|
network, channel = chanpair
|
|
initializeChannel(irc, channel)
|
|
for link in entrydata['links']:
|
|
network, channel = link
|
|
initializeChannel(irc, channel)
|
|
|
|
def main():
|
|
loadDB()
|
|
utils.schedulers['relaydb'] = scheduler = sched.scheduler()
|
|
scheduler.enter(30, 1, exportDB, argument=(True,))
|
|
# Thread this because exportDB() queues itself as part of its
|
|
# execution, in order to get a repeating loop.
|
|
thread = threading.Thread(target=scheduler.run)
|
|
thread.daemon = True
|
|
thread.start()
|
|
|
|
def handle_endburst(irc, numeric, command, args):
|
|
initializeAll(irc)
|
|
utils.add_hook(handle_endburst, "ENDBURST")
|
|
|
|
def handle_disconnect(irc, numeric, command, args):
|
|
for k, v in relayusers.copy().items():
|
|
if irc.name in v:
|
|
del relayusers[k][irc.name]
|
|
if k[0] == irc.name:
|
|
handle_quit(irc, k[1], 'PYLINK_DISCONNECT', {'text': 'Home network lost connection.'})
|
|
|
|
utils.add_hook(handle_disconnect, "PYLINK_DISCONNECT")
|
|
|
|
def handle_save(irc, numeric, command, args):
|
|
target = args['target']
|
|
realuser = getLocalUser(irc, target)
|
|
log.debug('(%s) relay handle_save: %r got in a nick collision! Real user: %r',
|
|
irc.name, target, realuser)
|
|
if utils.isInternalClient(irc, target) and realuser:
|
|
# Nick collision!
|
|
# It's one of our relay clients; try to fix our nick to the next
|
|
# available normalized nick.
|
|
remotenet, remoteuser = realuser
|
|
remoteirc = utils.networkobjects[remotenet]
|
|
nick = remoteirc.users[remoteuser].nick
|
|
newnick = normalizeNick(irc, remotenet, nick)
|
|
irc.proto.nickClient(irc, target, newnick)
|
|
else:
|
|
# Somebody else on the network (not a PyLink client) had a nick collision;
|
|
# relay this as a nick change appropriately.
|
|
handle_nick(irc, target, 'SAVE', {'oldnick': None, 'newnick': target})
|
|
|
|
utils.add_hook(handle_save, "SAVE")
|
|
|
|
@utils.add_cmd
|
|
def linked(irc, source, args):
|
|
"""takes no arguments.
|
|
|
|
Returns a list of channels shared across the relay."""
|
|
networks = list(utils.networkobjects.keys())
|
|
networks.remove(irc.name)
|
|
s = 'Connected networks: \x02%s\x02 %s' % (irc.name, ' '.join(networks))
|
|
utils.msg(irc, source, s)
|
|
# Sort relay DB by channel name, and then sort.
|
|
for k, v in sorted(db.items(), key=lambda channel: channel[0][1]):
|
|
s = '\x02%s%s\x02 ' % k
|
|
if v['links']:
|
|
s += ' '.join([''.join(link) for link in v['links']])
|
|
else:
|
|
s += '(no relays yet)'
|
|
utils.msg(irc, source, s)
|