Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

feat(silence): allow to silence threads #3122

Open
wants to merge 8 commits into
base: main
Choose a base branch
from
Open

feat(silence): allow to silence threads #3122

Changes from 5 commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
c156036
allow silencing threads
Snipy7374 Jul 14, 2024
332bbbd
lint files
Snipy7374 Jul 14, 2024
352dd56
Update bot/exts/moderation/silence.py
Snipy7374 Jul 18, 2024
3eb787a
move logic blocks and try to fix typings
Snipy7374 Jul 28, 2024
23fd132
Merge branch 'feat/silence' of github.com:Snipy7374/python-discord-bo…
Snipy7374 Jul 28, 2024
b488e80
Update bot/exts/moderation/silence.py
Snipy7374 Jul 29, 2024
f19fc4a
fix typing issues and add log message when silencing a thread
Snipy7374 Jul 29, 2024
9035d90
Merge branch 'main' into feat/silence
Snipy7374 Jul 29, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
62 changes: 39 additions & 23 deletions bot/exts/moderation/silence.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
from collections import OrderedDict
from contextlib import suppress
from datetime import UTC, datetime, timedelta
from typing import TYPE_CHECKING

from async_rediscache import RedisCache
from discord import Guild, PermissionOverwrite, TextChannel, Thread, VoiceChannel
Expand All @@ -16,6 +17,9 @@
from bot.log import get_logger
from bot.utils.lock import LockedResourceError, lock, lock_arg

if TYPE_CHECKING:
from discord.abc import MessageableChannel
Snipy7374 marked this conversation as resolved.
Show resolved Hide resolved

log = get_logger(__name__)

LOCK_NAMESPACE = "silence"
Expand All @@ -33,6 +37,7 @@
MSG_UNSILENCE_SUCCESS = f"{constants.Emojis.check_mark} unsilenced {{channel}}."

TextOrVoiceChannel = TextChannel | VoiceChannel
SilenceableChannel = TextChannel | VoiceChannel | Thread

VOICE_CHANNELS = {
constants.Channels.code_help_voice_0: constants.Channels.code_help_chat_0,
Expand All @@ -57,17 +62,17 @@ def __init__(self, alert_channel: TextChannel):
time=MISSING,
name=None
)
self._silenced_channels = {}
self._silenced_channels: dict[SilenceableChannel, int] = {}
self._alert_channel = alert_channel

def add_channel(self, channel: TextOrVoiceChannel) -> None:
def add_channel(self, channel: SilenceableChannel) -> None:
"""Add channel to `_silenced_channels` and start loop if not launched."""
if not self._silenced_channels:
self.start()
log.info("Starting notifier loop.")
self._silenced_channels[channel] = self._current_loop

def remove_channel(self, channel: TextChannel) -> None:
def remove_channel(self, channel: SilenceableChannel) -> None:
"""Remove channel from `_silenced_channels` and stop loop if no channels remain."""
with suppress(KeyError):
del self._silenced_channels[channel]
Expand All @@ -92,7 +97,7 @@ async def _notifier(self) -> None:
)


async def _select_lock_channel(args: OrderedDict[str, any]) -> TextOrVoiceChannel:
async def _select_lock_channel(args: OrderedDict[str, any]) -> SilenceableChannel:
"""Passes the channel to be silenced to the resource lock."""
channel, _ = Silence.parse_silence_args(args["ctx"], args["duration_or_channel"], args["duration"])
return channel
Expand Down Expand Up @@ -130,8 +135,8 @@ async def cog_load(self) -> None:
async def send_message(
self,
message: str,
source_channel: TextChannel,
target_channel: TextOrVoiceChannel,
source_channel: "MessageableChannel",
target_channel: SilenceableChannel,
*,
alert_target: bool = False
) -> None:
Expand Down Expand Up @@ -159,7 +164,7 @@ async def send_message(
async def silence(
self,
ctx: Context,
duration_or_channel: TextOrVoiceChannel | HushDurationConverter = None,
duration_or_channel: SilenceableChannel | HushDurationConverter | None = None,
duration: HushDurationConverter = 10,
*,
kick: bool = False
Expand All @@ -178,12 +183,6 @@ async def silence(
channel_info = f"#{channel} ({channel.id})"
log.debug(f"{ctx.author} is silencing channel {channel_info}.")

# Since threads don't have specific overrides, we cannot silence them individually.
# The parent channel has to be muted or the thread should be archived.
if isinstance(channel, Thread):
await ctx.send(":x: Threads cannot be silenced.")
return

if not await self._set_silence_overwrites(channel, kick=kick):
log.info(f"Tried to silence channel {channel_info} but the channel was already silenced.")
await self.send_message(MSG_SILENCE_FAIL, ctx.channel, channel, alert_target=False)
Expand All @@ -210,12 +209,12 @@ async def silence(
@staticmethod
def parse_silence_args(
ctx: Context,
duration_or_channel: TextOrVoiceChannel | int,
duration_or_channel: SilenceableChannel | int | None,
duration: HushDurationConverter
) -> tuple[TextOrVoiceChannel, int | None]:
) -> tuple[SilenceableChannel, int | None]:
"""Helper method to parse the arguments of the silence command."""
if duration_or_channel:
if isinstance(duration_or_channel, TextChannel | VoiceChannel):
if isinstance(duration_or_channel, TextChannel | VoiceChannel | Thread):
channel = duration_or_channel
else:
channel = ctx.channel
Expand All @@ -228,8 +227,11 @@ def parse_silence_args(

return channel, duration

async def _set_silence_overwrites(self, channel: TextOrVoiceChannel, *, kick: bool = False) -> bool:
async def _set_silence_overwrites(self, channel: SilenceableChannel, *, kick: bool = False) -> bool:
"""Set silence permission overwrites for `channel` and return True if successful."""
if channel.id in self.scheduler:
return False

# Get the original channel overwrites
if isinstance(channel, TextChannel):
role = self._everyone_role
Expand All @@ -242,6 +244,10 @@ async def _set_silence_overwrites(self, channel: TextOrVoiceChannel, *, kick: bo
send_messages_in_threads=overwrite.send_messages_in_threads
)

elif isinstance(channel, Thread):
await channel.edit(locked=True)
Snipy7374 marked this conversation as resolved.
Show resolved Hide resolved
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If the thread is already locked, this will just schedule an unlock in the set amount of time. Failing is probably better to keep consistent with how it behaves with text channels.

return True

else:
role = self._verified_voice_role
overwrite = channel.overwrites_for(role)
Expand All @@ -250,7 +256,7 @@ async def _set_silence_overwrites(self, channel: TextOrVoiceChannel, *, kick: bo
prev_overwrites.update(connect=overwrite.connect)

# Stop if channel was already silenced
if channel.id in self.scheduler or all(val is False for val in prev_overwrites.values()):
if all(val is False for val in prev_overwrites.values()):
return False

# Set new permissions, store
Expand All @@ -260,7 +266,7 @@ async def _set_silence_overwrites(self, channel: TextOrVoiceChannel, *, kick: bo

return True

async def _schedule_unsilence(self, ctx: Context, channel: TextOrVoiceChannel, duration: int | None) -> None:
async def _schedule_unsilence(self, ctx: Context, channel: SilenceableChannel, duration: int | None) -> None:
"""Schedule `ctx.channel` to be unsilenced if `duration` is not None."""
if duration is None:
await self.unsilence_timestamps.set(channel.id, -1)
Expand All @@ -270,7 +276,7 @@ async def _schedule_unsilence(self, ctx: Context, channel: TextOrVoiceChannel, d
await self.unsilence_timestamps.set(channel.id, unsilence_time.timestamp())

@commands.command(aliases=("unhush",))
async def unsilence(self, ctx: Context, *, channel: TextOrVoiceChannel = None) -> None:
async def unsilence(self, ctx: Context, *, channel: SilenceableChannel | None = None) -> None:
"""
Unsilence the given channel if given, else the current one.

Expand All @@ -282,7 +288,7 @@ async def unsilence(self, ctx: Context, *, channel: TextOrVoiceChannel = None) -
await self._unsilence_wrapper(channel, ctx)

@lock_arg(LOCK_NAMESPACE, "channel", raise_error=True)
async def _unsilence_wrapper(self, channel: TextOrVoiceChannel, ctx: Context | None = None) -> None:
async def _unsilence_wrapper(self, channel: SilenceableChannel, ctx: Context | None = None) -> None:
"""
Unsilence `channel` and send a success/failure message to ctx.channel.

Expand All @@ -297,6 +303,10 @@ async def _unsilence_wrapper(self, channel: TextOrVoiceChannel, ctx: Context | N
if isinstance(channel, VoiceChannel):
overwrite = channel.overwrites_for(self._verified_voice_role)
has_channel_overwrites = overwrite.speak is False

elif isinstance(channel, Thread):
has_channel_overwrites = False

else:
overwrite = channel.overwrites_for(self._everyone_role)
has_channel_overwrites = overwrite.send_messages is False or overwrite.add_reactions is False
Expand All @@ -310,15 +320,15 @@ async def _unsilence_wrapper(self, channel: TextOrVoiceChannel, ctx: Context | N
else:
await self.send_message(MSG_UNSILENCE_SUCCESS, msg_channel, channel, alert_target=True)

async def _unsilence(self, channel: TextOrVoiceChannel) -> bool:
async def _unsilence(self, channel: SilenceableChannel) -> bool:
"""
Unsilence `channel`.

If `channel` has a silence task scheduled or has its previous overwrites cached, unsilence
it, cancel the task, and remove it from the notifier. Notify admins if it has a task but
not cached overwrites.

Return `True` if channel permissions were changed, `False` otherwise.
Return `True` if channel was unsilenced, `False` otherwise.
"""
# Get stored overwrites, and return if channel is unsilenced
prev_overwrites = await self.previous_overwrites.get(channel.id)
Expand All @@ -331,6 +341,12 @@ async def _unsilence(self, channel: TextOrVoiceChannel) -> bool:
role = self._everyone_role
overwrite = channel.overwrites_for(role)
permissions = "`Send Messages` and `Add Reactions`"
elif isinstance(channel, Thread):
await channel.edit(locked=False)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same as above: if the thread was manually unlocked before the scheduled time, there won't be any indication of it.

log.info(f"Unsilenced channel #{channel} ({channel.id}).")
Snipy7374 marked this conversation as resolved.
Show resolved Hide resolved
self.scheduler.cancel(channel.id)
self.notifier.remove_channel(channel)
return True
else:
role = self._verified_voice_role
overwrite = channel.overwrites_for(role)
Expand Down