3
0
mirror of https://github.com/jlu5/PyLink.git synced 2024-11-01 01:09:22 +01:00
PyLink/plugins/opercmds.py

269 lines
8.9 KiB
Python
Raw Normal View History

"""
opercmds.py: Provides a subset of network management commands.
"""
import argparse
from pylinkirc import utils
from pylinkirc.log import log
from pylinkirc.coremods import permissions
# Having a hard limit here is sensible because otherwise it can flood the client or server off.
CHECKBAN_MAX_RESULTS = 200
def _checkban_positiveint(value):
value = int(value)
if value <= 0 or value > CHECKBAN_MAX_RESULTS:
raise argparse.ArgumentTypeError("%s is not a positive integer between 1 and %s." % (value, CHECKBAN_MAX_RESULTS))
return value
checkban_parser = utils.IRCParser()
checkban_parser.add_argument('banmask')
checkban_parser.add_argument('target', nargs='?', default='')
checkban_parser.add_argument('--channel', default='')
checkban_parser.add_argument('--maxresults', type=_checkban_positiveint, default=50)
@utils.add_cmd
def checkban(irc, source, args):
"""<banmask> [<target nick or hostmask>] [--channel #channel] [--maxresults <num>]
CHECKBAN provides a ban checker command based on nick!user@host masks, user@host masks, and
PyLink extended targets.
2017-08-02 15:45:20 +02:00
If a target nick or hostmask is given, this command returns whether the given banmask will match it.
Otherwise, it will display a list of connected users matching the banmask.
If the --channel argument is given without a target mask, the returned results will only
include users in the given channel.
The --maxresults option configures how many responses will be shown."""
permissions.check_permissions(irc, source, ['opercmds.checkban'])
args = checkban_parser.parse_args(args)
if not args.target:
# No hostmask was given, return a list of matched users.
results = 0
# Process the --channel argument if it exists. This is just a lazy wrapper around the
# $and and $channel exttargets, but it's mostly to convenience users.
if args.channel:
args.banmask = "$and:(%s+$channel:%s)" % (args.banmask, args.channel)
irc.reply("Checking for hosts that match \x02%s\x02:" % args.banmask, private=True)
for uid, userobj in irc.users.copy().items():
if irc.match_host(args.banmask, uid):
if results < args.maxresults:
s = "\x02%s\x02 (%s@%s) [%s] {\x02%s\x02}" % (userobj.nick, userobj.ident,
userobj.host, userobj.realname, irc.get_friendly_name(irc.get_server(uid)))
# Always reply in private to prevent information leaks.
irc.reply(s, private=True)
results += 1
else:
if results:
irc.reply("\x02%s\x02 out of \x02%s\x02 results shown." %
(min([results, args.maxresults]), results), private=True)
else:
irc.reply("No results found.", private=True)
else:
# Target can be both a nick (of an online user) or a hostmask. irc.match_host() handles this
# automatically.
if irc.match_host(args.banmask, args.target):
irc.reply('Yes, \x02%s\x02 matches \x02%s\x02.' % (args.target, args.banmask))
else:
irc.reply('No, \x02%s\x02 does not match \x02%s\x02.' % (args.target, args.banmask))
2016-01-04 04:59:48 +01:00
@utils.add_cmd
def jupe(irc, source, args):
"""<server> [<reason>]
Jupes the given server."""
2016-01-04 04:59:48 +01:00
permissions.check_permissions(irc, source, ['opercmds.jupe'])
2016-01-04 04:59:48 +01:00
try:
servername = args[0]
reason = ' '.join(args[1:]) or "No reason given"
desc = "Juped by %s: [%s]" % (irc.get_hostmask(source), reason)
2016-01-04 04:59:48 +01:00
except IndexError:
irc.error('Not enough arguments. Needs 1-2: servername, reason (optional).')
2016-01-04 04:59:48 +01:00
return
if not utils.isServerName(servername):
irc.error("Invalid server name %r." % servername)
2016-01-04 04:59:48 +01:00
return
sid = irc.spawn_server(servername, desc=desc)
2016-01-04 04:59:48 +01:00
irc.call_hooks([irc.pseudoclient.uid, 'OPERCMDS_SPAWNSERVER',
2016-01-04 04:59:48 +01:00
{'name': servername, 'sid': sid, 'text': desc}])
irc.reply("Done.")
@utils.add_cmd
def kick(irc, source, args):
"""<channel> <user> [<reason>]
2016-01-04 04:59:48 +01:00
Kicks <user> from the specified channel."""
permissions.check_permissions(irc, source, ['opercmds.kick'])
2016-01-04 04:59:48 +01:00
try:
channel = irc.to_lower(args[0])
target = args[1]
reason = ' '.join(args[2:])
2016-01-04 04:59:48 +01:00
except IndexError:
irc.error("Not enough arguments. Needs 2-3: channel, target, reason (optional).")
2016-01-04 04:59:48 +01:00
return
targetu = irc.nick_to_uid(target)
2016-01-04 04:59:48 +01:00
if channel not in irc.channels: # KICK only works on channels that exist.
irc.error("Unknown channel %r." % channel)
2016-01-04 04:59:48 +01:00
return
if not targetu:
2016-01-04 04:59:48 +01:00
# Whatever we were told to kick doesn't exist!
irc.error("No such target nick %r." % target)
2016-01-04 04:59:48 +01:00
return
sender = irc.pseudoclient.uid
irc.kick(sender, channel, targetu, reason)
irc.reply("Done.")
irc.call_hooks([sender, 'CHANCMDS_KICK', {'channel': channel, 'target': targetu,
2016-01-04 04:59:48 +01:00
'text': reason, 'parse_as': 'KICK'}])
2016-01-10 03:34:57 +01:00
@utils.add_cmd
def kill(irc, source, args):
"""<target> [<reason>]
2016-01-10 03:34:57 +01:00
Kills the given target."""
permissions.check_permissions(irc, source, ['opercmds.kill'])
2016-01-10 03:34:57 +01:00
try:
target = args[0]
reason = ' '.join(args[1:])
2016-01-10 03:34:57 +01:00
except IndexError:
irc.error("Not enough arguments. Needs 1-2: target, reason (optional).")
2016-01-10 03:34:57 +01:00
return
# Convert the source and target nicks to UIDs.
sender = irc.pseudoclient.uid
targetu = irc.nick_to_uid(target)
2016-01-10 03:34:57 +01:00
userdata = irc.users.get(targetu)
if targetu not in irc.users:
2016-01-10 03:34:57 +01:00
# Whatever we were told to kick doesn't exist!
irc.error("No such nick %r." % target)
2016-01-10 03:34:57 +01:00
return
irc.kill(sender, targetu, reason)
# Format the kill reason properly in hooks.
reason = "Killed (%s (%s))" % (irc.get_friendly_name(sender), reason)
irc.reply("Done.")
irc.call_hooks([sender, 'CHANCMDS_KILL', {'target': targetu, 'text': reason,
2016-01-10 03:34:57 +01:00
'userdata': userdata, 'parse_as': 'KILL'}])
@utils.add_cmd
def mode(irc, source, args):
"""<channel> <modes>
Sets the given modes on the target channel."""
permissions.check_permissions(irc, source, ['opercmds.mode'])
try:
target, modes = args[0], args[1:]
except IndexError:
irc.error('Not enough arguments. Needs 2: target, modes to set.')
return
if target not in irc.channels:
irc.error("Unknown channel %r." % target)
return
elif not modes:
# No modes were given before parsing (i.e. mode list was blank).
irc.error("No valid modes were given.")
return
parsedmodes = irc.parse_modes(target, modes)
if not parsedmodes:
# Modes were given but they failed to parse into anything meaningful.
# For example, "mode #somechan +o" would be erroneous because +o
# requires an argument!
irc.error("No valid modes were given.")
return
irc.mode(irc.pseudoclient.uid, target, parsedmodes)
2016-01-03 20:45:01 +01:00
# Call the appropriate hooks for plugins like relay.
irc.call_hooks([irc.pseudoclient.uid, 'OPERCMDS_MODEOVERRIDE',
{'target': target, 'modes': parsedmodes, 'parse_as': 'MODE'}])
2016-01-03 20:45:01 +01:00
irc.reply("Done.")
@utils.add_cmd
2016-01-04 04:59:48 +01:00
def topic(irc, source, args):
"""<channel> <topic>
2016-01-03 20:45:01 +01:00
Changes the topic in a channel."""
permissions.check_permissions(irc, source, ['opercmds.topic'])
2016-01-03 20:45:01 +01:00
try:
2016-01-04 04:59:48 +01:00
channel = args[0]
topic = ' '.join(args[1:])
2016-01-03 20:45:01 +01:00
except IndexError:
irc.error("Not enough arguments. Needs 2: channel, topic.")
2016-01-03 20:45:01 +01:00
return
2016-01-04 04:59:48 +01:00
if channel not in irc.channels:
irc.error("Unknown channel %r." % channel)
2016-01-03 20:45:01 +01:00
return
irc.topic(irc.pseudoclient.uid, channel, topic)
2016-01-03 20:45:01 +01:00
irc.reply("Done.")
irc.call_hooks([irc.pseudoclient.uid, 'CHANCMDS_TOPIC',
2016-01-04 04:59:48 +01:00
{'channel': channel, 'text': topic, 'setter': source,
'parse_as': 'TOPIC'}])
@utils.add_cmd
def chghost(irc, source, args):
"""<user> <new host>
Changes the visible host of the target user."""
chgfield(irc, source, args, 'host')
@utils.add_cmd
def chgident(irc, source, args):
"""<user> <new ident>
Changes the ident of the target user."""
chgfield(irc, source, args, 'ident')
@utils.add_cmd
def chgname(irc, source, args):
"""<user> <new name>
Changes the GECOS (realname) of the target user."""
chgfield(irc, source, args, 'name', 'GECOS')
def chgfield(irc, source, args, human_field, internal_field=None):
permissions.check_permissions(irc, source, ['opercmds.chg' + human_field])
try:
target = args[0]
new = args[1]
except IndexError:
irc.error("Not enough arguments. Needs 2: target, new %s." % human_field)
return
# Find the user
targetu = irc.nick_to_uid(target)
if targetu not in irc.users:
irc.error("No such nick %r." % target)
return
internal_field = internal_field or human_field.upper()
irc.update_client(targetu, internal_field, new)
irc.reply("Done.")