3
0
mirror of https://github.com/jlu5/PyLink.git synced 2024-11-01 09:19:23 +01:00
PyLink/plugins/changehost.py
2016-05-01 15:05:30 -07:00

93 lines
3.0 KiB
Python

"""
Changehost plugin - automatically changes the hostname of matching users.
"""
# Import hacks to access utils and log.
import sys
import os
sys.path.append(os.path.dirname(os.path.dirname(os.path.abspath(__file__))))
import string
# ircmatch library from https://github.com/mammon-ircd/ircmatch
# (pip install ircmatch)
import ircmatch
import utils
import world
from log import log
# Characters allowed in a hostname.
allowed_chars = string.ascii_letters + '-./:' + string.digits
def _changehost(irc, target, args):
changehost_conf = irc.conf.get("changehost")
if not changehost_conf:
log.warning("(%s) Missing 'changehost:' configuration block; "
"Changehost will not function correctly!", irc.name)
return
elif irc.name not in changehost_conf.get('enabled_nets'):
# We're not enabled on the network, break.
return
changehost_hosts = changehost_conf.get('hosts')
if not changehost_hosts:
log.warning("(%s) No hosts were defined in changehost::hosts; "
"Changehost will not function correctly!", irc.name)
return
# Match against both the user's IP and real host.
target_host = irc.getHostmask(target, realhost=True)
target_ip = irc.getHostmask(target, ip=True)
for host_glob, host_template in changehost_hosts.items():
if ircmatch.match(0, host_glob, target_host) or ircmatch.match(0, host_glob, target_ip):
# This uses template strings for simple substitution:
# https://docs.python.org/3/library/string.html#template-strings
template = string.Template(host_template)
# Substitute using the fields provided the hook data. This means
# that the following variables are available for substitution:
# $uid, $ts, $nick, $realhost, $host, $ident, $ip
new_host = template.substitute(args)
# Replace characters that are not allowed in hosts with "-".
for char in new_host:
if char not in allowed_chars:
new_host = new_host.replace(char, '-')
irc.proto.updateClient(target, 'HOST', new_host)
# Only operate on the first match.
break
def handle_uid(irc, sender, command, args):
"""
Changehost listener for new connections.
"""
target = args['uid']
_changehost(irc, target, args)
utils.add_hook(handle_uid, 'UID')
@utils.add_cmd
def applyhosts(irc, sender, args):
"""[<network>]
Applies all configured hosts for users on the given network, or the current network if none is specified."""
try: # Try to get network from the command line.
network = world.networkobjects[args[0]]
except IndexError: # No network was given
network = irc
except KeyError: # Unknown network
irc.reply("Error: Unknown network '%s'." % network)
return
for user, userdata in network.users.copy().items():
_changehost(network, user, userdata.__dict__)
irc.reply("Done.")