475 lines
18 KiB
Python
475 lines
18 KiB
Python
#--depends-on channel_access
|
|
#--depends-on check_mode
|
|
#--depends-on commands
|
|
#--depends-on config
|
|
|
|
from src import ModuleManager, utils
|
|
|
|
QUIET_METHODS = {
|
|
"qmode": ["q", "", "728", "729"],
|
|
"insp": ["b", "m:", "367", "368"],
|
|
"insp": ["b", "~q:", "367", "368"]
|
|
}
|
|
|
|
KICK_REASON = "your behavior is not conducive to the desired environment"
|
|
|
|
KICK_REASON_SETTING = utils.Setting("default-kick-reason",
|
|
"Set the default kick reason", example="have a nice trip")
|
|
|
|
@utils.export("channelset", utils.Setting("ban-format",
|
|
"Set ban format ($n = nick, $u = username, $h = hostname, $a = account)",
|
|
|
|
example="*!$u@$h"))
|
|
@utils.export("channelset", utils.Setting("ban-format-account",
|
|
"Set ban format for users with accounts "
|
|
"($n = nick, $u = username, $h = hostname, $a = account)", example="~a:$a"))
|
|
|
|
@utils.export("serverset", utils.OptionsSetting(
|
|
["qmode", "insp", "unreal", "none"], "quiet-method",
|
|
"Set this server's method of muting users"))
|
|
@utils.export("botset", KICK_REASON_SETTING)
|
|
@utils.export("serverset", KICK_REASON_SETTING)
|
|
@utils.export("channelset", KICK_REASON_SETTING)
|
|
class Module(ModuleManager.BaseModule):
|
|
_name = "ChanOp"
|
|
|
|
def _kick_reason(self, server, channel):
|
|
return channel.get_setting("default-kick-reason",
|
|
server.get_setting("default-kick-reason",
|
|
self.bot.get_setting("default-kick-reson", KICK_REASON)))
|
|
|
|
def _kick(self, server, channel, target_nickname, reason):
|
|
target_user = server.get_user(target_nickname, create=False)
|
|
if target_user and channel.has_user(target_user):
|
|
reason = " ".join(reason) or self._kick_reason(server, channel)
|
|
channel.send_kick(target_user.nickname, reason)
|
|
else:
|
|
raise utils.EventError("No such user")
|
|
|
|
@utils.hook("received.command.kick")
|
|
@utils.hook("received.command.k", alias_of="kick")
|
|
@utils.kwarg("min_args", 1)
|
|
@utils.kwarg("require_mode", "o")
|
|
@utils.kwarg("require_access", "kick")
|
|
@utils.kwarg("usage", "<nickname> [reason]")
|
|
def kick(self, event):
|
|
self._kick(event["server"], event["target"], event["args_split"][0],
|
|
event["args_split"][1:])
|
|
|
|
def _format_hostmask(self, user, s):
|
|
vars = {}
|
|
vars["n"] = vars["nickname"] = user.nickname
|
|
vars["u"] = vars["username"] = user.username
|
|
vars["h"] = vars["hostname"] = user.hostname
|
|
vars["a"] = vars["account"] = user.account or ""
|
|
return utils.parse.format_token_replace(s, vars)
|
|
def _get_hostmask(self, channel, user):
|
|
if not user.account == None:
|
|
account_format = channel.get_setting("ban-format-account", None)
|
|
if not account_format == None:
|
|
return self._format_hostmask(user, account_format)
|
|
|
|
format = channel.get_setting("ban-format", "*!$u@$h")
|
|
return self._format_hostmask(user, format)
|
|
|
|
def _ban(self, server, channel, target, allow_hostmask, time, add):
|
|
hostmask = None
|
|
target_user = server.get_user(target, create=False)
|
|
if target_user and channel.has_user(target_user):
|
|
hostmask = self._get_hostmask(channel, target_user)
|
|
else:
|
|
if not allow_hostmask:
|
|
raise utils.EventError("No such user")
|
|
hostmask = target
|
|
if not add:
|
|
channel.send_unban(hostmask)
|
|
else:
|
|
channel.send_ban(hostmask)
|
|
|
|
if not time == None:
|
|
self.timers.add_persistent("unban", time, server_id=server.id,
|
|
channel_name=channel.name, hostmask=hostmask)
|
|
|
|
@utils.hook("timer.unban")
|
|
def _timer_unban(self, event):
|
|
server = self.bot.get_server_by_id(event["server_id"])
|
|
if server and event["channel_name"] in server.channels:
|
|
channel = server.channels.get(event["channel_name"])
|
|
channel.send_unban(event["hostmask"])
|
|
|
|
@utils.hook("received.command.ban")
|
|
@utils.hook("received.command.b", alias_of="ban")
|
|
@utils.kwarg("min_args", 1)
|
|
@utils.kwarg("require_mode", "o")
|
|
@utils.kwarg("require_access", "ban")
|
|
@utils.kwarg("usage", "[+time] <target>")
|
|
def ban(self, event):
|
|
time, args = utils.parse.timed_args(event["args_split"], 1)
|
|
self._ban(event["server"], event["target"], args[0], True, time, True)
|
|
|
|
@utils.hook("received.command.unban")
|
|
@utils.kwarg("min_args", 1)
|
|
@utils.kwarg("require_mode", "o")
|
|
@utils.kwarg("require_access", "ban")
|
|
@utils.kwarg("usage", "<target>")
|
|
def unban(self, event):
|
|
self._ban(event["server"], event["target"], event["args_split"][0],
|
|
True, None, False)
|
|
|
|
@utils.hook("received.command.kickban")
|
|
@utils.hook("received.command.kb", alias_of="kickban")
|
|
@utils.kwarg("min_args", 1)
|
|
@utils.kwarg("require_mode", "o")
|
|
@utils.kwarg("require_access", "kickban")
|
|
@utils.kwarg("usage", "[+time] <nickname> [reason]")
|
|
def kickban(self, event):
|
|
time, args = utils.parse.timed_args(event["args_split"], 1)
|
|
self._ban(event["server"], event["target"], args[0], False, time, True)
|
|
self._kick(event["server"], event["target"], args[0], args[1:])
|
|
|
|
@utils.hook("received.command.op")
|
|
@utils.hook("received.command.up", alias_of="op")
|
|
@utils.kwarg("channel_only", True)
|
|
@utils.kwarg("require_mode", "o")
|
|
@utils.kwarg("require_access", "op")
|
|
@utils.kwarg("usage", "[nickname]")
|
|
def op(self, event):
|
|
self._op(True, event)
|
|
|
|
@utils.hook("received.command.deop")
|
|
@utils.hook("received.command.down", alias_of="deop")
|
|
@utils.kwarg("channel_only", True)
|
|
@utils.kwarg("require_mode", "o")
|
|
@utils.kwarg("require_access", "op")
|
|
@utils.kwarg("usage", "[nickname]")
|
|
def deop(self, event):
|
|
self._op(False, event)
|
|
|
|
def _op(self, add, event):
|
|
target = event["args_split"][0] if event["args"] else event[
|
|
"user"].nickname
|
|
event["target"].send_mode("+o" if add else "-o", [target])
|
|
|
|
@utils.hook("received.command.voice")
|
|
@utils.hook("received.command.devoice")
|
|
@utils.kwarg("channel_only", True)
|
|
@utils.kwarg("require_mode", "o")
|
|
@utils.kwarg("require_access", "voice")
|
|
@utils.kwarg("usage", "[nickname]")
|
|
def voice(self, event):
|
|
add = event["command"] == "voice"
|
|
target = event["args_split"][0] if event["args"] else event[
|
|
"user"].nickname
|
|
event["target"].send_mode("+v" if add else "-v", [target])
|
|
|
|
@utils.hook("received.command.topic")
|
|
@utils.kwarg("min_args", 1)
|
|
@utils.kwarg("channel_only", True)
|
|
@utils.kwarg("require_mode", "o")
|
|
@utils.kwarg("require_access", "topic")
|
|
@utils.kwarg("remove_empty", False)
|
|
@utils.kwarg("usage", "<topic>")
|
|
def topic(self, event):
|
|
event["target"].send_topic(event["args"])
|
|
|
|
@utils.hook("received.command.tappend")
|
|
@utils.kwarg("min_args", 1)
|
|
@utils.kwarg("channel_only", True)
|
|
@utils.kwarg("require_mode", "o")
|
|
@utils.kwarg("require_access", "topic")
|
|
@utils.kwarg("remove_empty", False)
|
|
@utils.kwarg("usage", "<topic>")
|
|
def tappend(self, event):
|
|
event["target"].send_topic(event["target"].topic + event["args"])
|
|
|
|
def _quiet_method(self, server):
|
|
if server.quiet:
|
|
return server.quiet
|
|
|
|
quiet_method = server.get_setting("quiet-method", "none").lower()
|
|
|
|
if quiet_method in QUIET_METHODS:
|
|
return QUIET_METHODS[quiet_method]
|
|
elif quiet_method == "none":
|
|
return None
|
|
else:
|
|
raise ValueError("Unknown mute-method '%s'" % mute_method)
|
|
|
|
@utils.hook("received.command.quiet")
|
|
@utils.hook("received.command.mute")
|
|
@utils.kwarg("min_args", 1)
|
|
@utils.kwarg("usage", "[+time] <nickname>")
|
|
@utils.kwarg("channel_only", True)
|
|
@utils.kwarg("require_mode", "o")
|
|
@utils.kwarg("require_access", "quiet")
|
|
@utils.kwarg("help", "Quiet a given user")
|
|
def quiet(self, event):
|
|
self._quiet(event, True)
|
|
|
|
@utils.hook("received.command.unquiet")
|
|
@utils.hook("received.command.unmute")
|
|
@utils.kwarg("min_args", 1)
|
|
@utils.kwarg("usage", "<nickname>")
|
|
@utils.kwarg("channel_only", True)
|
|
@utils.kwarg("require_mode", "o")
|
|
@utils.kwarg("require_access", "unquiet")
|
|
@utils.kwarg("help", "Unquiet a given user")
|
|
def unquiet(self, event):
|
|
self._quiet(event, False)
|
|
|
|
def _quiet(self, event, add):
|
|
time, args = utils.parse.timed_args(event["args_split"], 1)
|
|
|
|
target_name = args[0]
|
|
if not event["server"].has_user(target_name):
|
|
raise utils.EventError("No such user")
|
|
|
|
target_user = event["server"].get_user(target_name)
|
|
if not event["target"].has_user(target_user):
|
|
raise utils.EventError("No such user")
|
|
|
|
quiet_method = self._quiet_method(event["server"])
|
|
|
|
if quiet_method == None:
|
|
raise utils.EventError("This network doesn't support quiets")
|
|
|
|
mode, prefix, _, _ = quiet_method
|
|
mask = self._get_hostmask(event["target"], target_user)
|
|
mask = "%s%s" % (prefix, mask)
|
|
|
|
if add and time:
|
|
self.timers.add_persistent("unquiet", time,
|
|
server_id=event["server"].id, channel_name=event["target"].name,
|
|
mode=mode, mask=mask)
|
|
|
|
mode_modifier = "+" if add else "-"
|
|
event["target"].send_mode("%s%s" % (mode_modifier, mode), [mask])
|
|
|
|
@utils.hook("timer.unquiet")
|
|
def _timer_unquiet(self, event):
|
|
server = self.bot.get_server_by_id(event["server_id"])
|
|
if server and event["channel_name"] in server.channels:
|
|
channel = server.channels.get(event["channel_name"])
|
|
channel.send_mode("-%s" % event["mode"], [event["mask"]])
|
|
|
|
@utils.hook("received.command.invite")
|
|
@utils.kwarg("min_args", 1)
|
|
@utils.kwarg("channel_only", True)
|
|
@utils.kwarg("require_mode", "o")
|
|
@utils.kwarg("require_access", "invite")
|
|
@utils.kwarg("help", "Invite a given user")
|
|
@utils.kwarg("usage", "<nickname>")
|
|
def invite(self, event):
|
|
user_nickname = event["args_split"][0]
|
|
|
|
event["target"].send_invite(user_nickname)
|
|
|
|
user = event["server"].get_user(user_nickname, create=False)
|
|
if user:
|
|
user_nickname = user.nickname
|
|
|
|
event["stdout"].write("Invited %s" % user_nickname)
|
|
|
|
def _parse_flags(self, s):
|
|
if s[0] == "+":
|
|
return True, list(s[1:])
|
|
elif s[0] == "-":
|
|
return False, list(s[1:])
|
|
else:
|
|
return None, None
|
|
|
|
@utils.hook("received.command.flags")
|
|
@utils.kwarg("channel_only", True)
|
|
@utils.kwarg("min_args", 1)
|
|
@utils.kwarg("help", "Configure access flags for a given user")
|
|
@utils.kwarg("usage", "<nickname> [flags]")
|
|
@utils.kwarg("require_mode", "o")
|
|
@utils.kwarg("require_access", "flags")
|
|
def flags(self, event):
|
|
target = event["server"].get_user(event["args_split"][0])
|
|
current_flags = event["target"].get_user_setting(target.get_id(),
|
|
"flags", "")
|
|
|
|
if len(event["args_split"]) == 1:
|
|
current_flags_str = ("+%s" % current_flags) if current_flags else ""
|
|
event["stdout"].write("Flags for %s: %s" % (target.nickname,
|
|
current_flags_str))
|
|
else:
|
|
is_add, parsed_flags = self._parse_flags(event["args_split"][1])
|
|
new_flags = None
|
|
|
|
if is_add == None:
|
|
raise utils.EventError("Invalid flags format")
|
|
elif is_add:
|
|
new_flags = list(set(list(current_flags)+parsed_flags))
|
|
else:
|
|
new_flags = list(set(current_flags)-set(parsed_flags))
|
|
|
|
if new_flags:
|
|
# sort alphanumeric with uppercase after lowercase
|
|
new_flags = sorted(new_flags,
|
|
key=lambda c: ("0" if c.islower() else "1")+c)
|
|
|
|
new_flags_str = "".join(new_flags)
|
|
event["target"].set_user_setting(target.get_id(), "flags",
|
|
new_flags_str)
|
|
|
|
self._check_flags(event["server"], event["target"], target)
|
|
|
|
event["stdout"].write("Set flags for %s to +%s" % (
|
|
target.nickname, new_flags_str))
|
|
else:
|
|
event["target"].del_user_setting(target.get_id(), "flags")
|
|
event["stdout"].write("Cleared flags for %s" % target.nickname)
|
|
|
|
def _chunk_n(self, n, l):
|
|
return [l[i:i+n] for i in range(0, len(l), n)]
|
|
def _chunk(self, server, l):
|
|
return self._chunk_n(int(server.isupport.get("MODES", "3")), l)
|
|
|
|
@utils.hook("received.join")
|
|
def on_join(self, event):
|
|
self._check_flags(event["server"], event["channel"], event["user"])
|
|
@utils.hook("received.account.login")
|
|
@utils.hook("internal.identified")
|
|
def on_account(self, event):
|
|
for channel in event["user"].channels:
|
|
self._check_flags(event["server"], channel, event["user"])
|
|
|
|
def _check_flags(self, server, channel, user):
|
|
flags = channel.get_user_setting(user.get_id(), "flags", "")
|
|
|
|
if flags:
|
|
identified = not user._id_override == None
|
|
current_modes = channel.get_user_modes(user)
|
|
|
|
modes = []
|
|
kick_reason = None
|
|
for flag in list(flags):
|
|
if flag == "O" and identified:
|
|
modes.append(("o", user.nickname))
|
|
elif flag == "V" and identified:
|
|
modes.append(("v", user.nickname))
|
|
elif flag == "b":
|
|
modes.append(("b", self._get_hostmask(channel, user)))
|
|
kick_reason = "User is banned from this channel"
|
|
|
|
new_modes = []
|
|
for mode, arg in modes:
|
|
if not mode in current_modes:
|
|
new_modes.append((mode, arg))
|
|
|
|
# break up in to chunks of (maximum) 3
|
|
# https://tools.ietf.org/html/rfc2812.html#section-3.2.3
|
|
for chunk in self._chunk(server, new_modes):
|
|
chars, args = list(zip(*chunk))
|
|
channel.send_mode("+%s" % "".join(chars), list(args))
|
|
if not kick_reason == None:
|
|
channel.send_kick(user.nickname, kick_reason)
|
|
|
|
@utils.hook("received.command.cmute")
|
|
@utils.kwarg("channel_only", True)
|
|
@utils.kwarg("require_mode", "o")
|
|
@utils.kwarg("require_access", "cmute")
|
|
@utils.kwarg("usage", "[+time]")
|
|
@utils.kwarg("help", "Mute the current channel")
|
|
def cmute(self, event):
|
|
time, args = utils.parse.timed_args(event["args_split"], 0)
|
|
event["target"].send_mode("+m")
|
|
|
|
if time:
|
|
self.timers.add_persistent("cunmute", time,
|
|
server_id=event["server"].id, channel_name=event["target"].name)
|
|
@utils.hook("timer.cunmute")
|
|
def cunmute_timer(self, event):
|
|
server = self.bot.get_server_by_id(event["server_id"])
|
|
if server and event["channel_name"] in server.channels:
|
|
self._cunmute(server.channels.get(event["channel_name"]))
|
|
|
|
@utils.hook("received.command.cunmute")
|
|
@utils.kwarg("channel_only", True)
|
|
@utils.kwarg("require_mode", "o")
|
|
@utils.kwarg("require_access", "cmute")
|
|
@utils.kwarg("usage", "[+time]")
|
|
@utils.kwarg("help", "Mute the current channel")
|
|
def cunmute(self):
|
|
self._cunmute(event["target"])
|
|
|
|
def _cunmute(self, channel):
|
|
channel.send_mode("-m")
|
|
|
|
@utils.hook("new.channel")
|
|
def new_channel_lists(self, event):
|
|
event["channel"].mode_lists = {
|
|
m: [] for m in event["server"].channel_list_modes}
|
|
|
|
# RPL_BANLIST
|
|
@utils.hook("received.367")
|
|
def on_367(self, event):
|
|
self._mode_list_mask(event["server"], event["line"].args[1], "b",
|
|
event["line"].args[2])
|
|
@utils.hook("received.368")
|
|
def on_368(self, event):
|
|
self._mode_list_end(event["server"], event["line"].args[1], "b")
|
|
|
|
# RPL_QUIETLIST
|
|
@utils.hook("received.728")
|
|
def on_728(self, event):
|
|
self._mode_list_mask(event["server"], event["line"].args[1], "q",
|
|
event["line"].args[3])
|
|
@utils.hook("received.729")
|
|
def on_729(self, event):
|
|
self._mode_list_end(event["server"], event["line"].args[1], "q")
|
|
|
|
def _mode_list_mask(self, server, target, mode, mask):
|
|
if target in server.channels:
|
|
channel = server.channels.get(target)
|
|
temp_key = "~%s" % mode
|
|
if not temp_key in channel.mode_lists:
|
|
channel.mode_lists[temp_key] = set([])
|
|
channel.mode_lists[temp_key].add(mask)
|
|
def _mode_list_end(self, server, target, mode):
|
|
if target in server.channels:
|
|
channel = server.channels.get(target)
|
|
temp_key = "~%s" % mode
|
|
if temp_key in channel.mode_lists:
|
|
channel.mode_lists[mode] = channel.mode_lists.pop(temp_key)
|
|
|
|
@utils.hook("received.mode.channel")
|
|
def channel_mode_lists(self, event):
|
|
for mode, arg in event["modes"]:
|
|
if mode[1] in event["server"].channel_list_modes:
|
|
if mode[0] == "+":
|
|
event["channel"].mode_lists[mode[1]].add(arg)
|
|
else:
|
|
event["channel"].mode_lists[mode[1]].discard(arg)
|
|
|
|
@utils.hook("self.join")
|
|
def self_join(self, event):
|
|
event["channel"].send_mode("+%s" %
|
|
"".join(event["server"].channel_list_modes))
|
|
|
|
@utils.hook("received.command.clear")
|
|
@utils.kwarg("channel_only", True)
|
|
@utils.kwarg("require_mode", "o")
|
|
@utils.kwarg("require_access", "clear")
|
|
@utils.kwarg("help", "Clear a given channel list mode (e.g. +b)")
|
|
@utils.kwarg("usage", "+<mode> [mask]")
|
|
def clear(self, event):
|
|
type = event["args_split"][0]
|
|
if type[0] == "+" and type[1:]:
|
|
mode = type[1]
|
|
if mode in event["target"].mode_lists:
|
|
mode_list = event["target"].mode_lists[mode]
|
|
if len(event["args_split"]) > 1:
|
|
hostmask = utils.irc.hostmask_parse(event["args_split"][1])
|
|
mode_list = list(utils.irc.hostmask_match_many(
|
|
mode_list, hostmask))
|
|
|
|
chunks = self._chunk(event["server"], list(mode_list))
|
|
for chunk in chunks:
|
|
event["target"].send_mode("-%s" % mode*len(chunk), chunk)
|
|
else:
|
|
event["stderr"].write("Unknown list mode")
|
|
else:
|
|
...
|