mirror of
https://github.com/Cog-Creators/Red-DiscordBot.git
synced 2025-12-05 17:02:32 -05:00
Migration to discord.py 2.0 (#5600)
* Temporarily set d.py to use latest git revision
* Remove `bot` param to Client.start
* Switch to aware datetimes
A lot of this is removing `.replace(...)` which while not technically
needed, simplifies the code base. There's only a few changes that are
actually necessary here.
* Update to work with new Asset design
* [threads] Update core ModLog API to support threads
- Added proper support for passing `Thread` to `channel`
when creating/editing case
- Added `parent_channel_id` attribute to Modlog API's Case
- Added `parent_channel` property that tries to get parent channel
- Updated case's content to show both thread and parent information
* [threads] Disallow usage of threads in some of the commands
- announceset channel
- filter channel clear
- filter channel add
- filter channel remove
- GlobalUniqueObjectFinder converter
- permissions addglobalrule
- permissions removeglobalrule
- permissions removeserverrule
- Permissions cog does not perform any validation for IDs
when setting through YAML so that has not been touched
- streamalert twitch/youtube/picarto
- embedset channel
- set ownernotifications adddestination
* [threads] Handle threads in Red's permissions system (Requires)
- Made permissions system apply rules of (only) parent in threads
* [threads] Update embed_requested to support threads
- Threads don't have their own embed settings and inherit from parent
* [threads] Update Red.message_eligible_as_command to support threads
* [threads] Properly handle invocation of [p](un)mutechannel in threads
Usage of a (un)mutechannel will mute/unmute user in the parent channel
if it's invoked in a thread.
* [threads] Update Filter cog to properly handle threads
- `[p]filter channel list` in a threads sends list for parent channel
- Checking for filter hits for a message in a thread checks its parent
channel's word list. There's no separate word list for threads.
* [threads] Support threads in Audio cog
- Handle threads being notify channels
- Update type hint for `is_query_allowed()`
* [threads] Update type hints and documentation to reflect thread support
- Documented that `{channel}` in CCs might be a thread
- Allowed (documented) usage of threads with `Config.channel()`
- Separate thread scope is still in the picture though
if it were to be done, it's going to be in separate in PR
- GuildContext.channel might be Thread
* Use less costy channel check in customcom's on_message_without_command
This isn't needed for d.py 2.0 but whatever...
* Update for in-place edits
* Embed's bool changed behavior, I'm hoping it doesn't affect us
* Address User.permissions_in() removal
* Swap VerificationLevel.extreme with VerificationLevel.highest
* Change to keyword-only parameters
* Change of `Guild.vanity_invite()` return type
* avatar -> display_avatar
* Fix metaclass shenanigans with Converter
* Update Red.add_cog() to be inline with `dpy_commands.Bot.add_cog()`
This means adding `override` keyword-only parameter and causing
small breakage by swapping RuntimeError with discord.ClientException.
* Address all DEP-WARNs
* Remove Context.clean_prefix and use upstream implementation instead
* Remove commands.Literal and use upstream implementation instead
Honestly, this was a rather bad implementation anyway...
Breaking but actually not really - it was provisional.
* Update Command.callback's setter
Support for functools.partial is now built into d.py
* Add new perms in HUMANIZED_PERM mapping (some from d.py 1.7 it seems)
BTW, that should really be in core instead of what we have now...
* Remove the part of do_conversion that has not worked for a long while
* Stop wrapping BadArgument in ConversionFailure
This is breaking but it's best to resolve it like this.
The functionality of ConversionFailure can be replicated with
Context.current_parameter and Context.current_argument.
* Add custom errors for int and float converters
* Remove Command.__call__ as it's now implemented in d.py
* Get rid of _dpy_reimplements
These were reimplemented for the purpose of typing
so it is no longer needed now that d.py is type hinted.
* Add return to Red.remove_cog
* Ensure we don't delete messages that differ only by used sticker
* discord.InvalidArgument->ValueError
* Move from raw <t:...> syntax to discord.utils.format_dt()
* Address AsyncIter removal
* Swap to pos-only for params that are pos-only in upstream
* Update for changes to Command.params
* [threads] Support threads in ignore checks and allow ignoring them
- Updated `[p](un)ignore channel` to accept threads
- Updated `[p]ignore list` to list ignored threads
- Updated logic in `Red.ignored_channel_or_guild()`
Ignores for guild channels now work as follows (only changes for threads):
- if channel is not a thread:
- check if user has manage channels perm in channel
and allow command usage if so
- check if channel is ignored and disallow command usage if so
- allow command usage if none of the conditions above happened
- if channel is a thread:
- check if user has manage channels perm in parent channel
and allow command usage if so
- check if parent channel is ignored and disallow command usage
if so
- check if user has manage thread perm in parent channel
and allow command usage if so
- check if thread is ignored and disallow command usage if so
- allow command usage if none of the conditions above happened
* [partial] Raise TypeError when channel is of PartialMessageable type
- Red.embed_requested
- Red.ignored_channel_or_guild
* [partial] Discard command messages when channel is PartialMessageable
* [threads] Add utilities for checking appropriate perms in both channels & threads
* [threads] Update code to use can_react_in() and @bot_can_react()
* [threads] Update code to use can_send_messages_in
* [threads] Add send_messages_in_threads perm to mute role and overrides
* [threads] Update code to use (bot/user)_can_manage_channel
* [threads] Update [p]diagnoseissues to work with threads
* Type hint fix
* [threads] Patch vendored discord.ext.menus to check proper perms in threads
I guess we've reached time when we have to patch the lib we vendor...
* Make docs generation work with non-final d.py releases
* Update discord.utils.oauth_url() usage
* Swap usage of discord.Embed.Empty/discord.embeds.EmptyEmbed to None
* Update usage of Guild.member_count to work with `None`
* Switch from Guild.vanity_invite() to Guild.vanity_url
* Update startup process to work with d.py's new asynchronous startup
* Use setup_hook() for pre-connect actions
* Update core's add_cog, remove_cog, and load_extension methods
* Update all setup functions to async and add awaits to bot.add_cog calls
* Modernize cogs by using async cog_load and cog_unload
* Address StoreChannel removal
* [partial] Disallow passing PartialMessageable to Case.channel
* [partial] Update cogs and utils to work better with PartialMessageable
- Ignore messages with PartialMessageable channel in CustomCommands cog
- In Filter cog, don't pass channel to modlog.create_case()
if it's PartialMessageable
- In Trivia cog, only compare channel IDs
- Make `.utils.menus.menu()` work for messages
with PartialMessageable channel
- Make checks in `.utils.tunnel.Tunnel.communicate()` more rigid
* Add few missing DEP-WARNs
This commit is contained in:
jack1142
GitHub
@@ -30,6 +30,8 @@ import discord
|
||||
from discord.ext.commands import check
|
||||
from .errors import BotMissingPermissions
|
||||
|
||||
from redbot.core import utils
|
||||
|
||||
if TYPE_CHECKING:
|
||||
from .commands import Command
|
||||
from .context import Context
|
||||
@@ -48,14 +50,20 @@ __all__ = [
|
||||
"permissions_check",
|
||||
"bot_has_permissions",
|
||||
"bot_in_a_guild",
|
||||
"bot_can_manage_channel",
|
||||
"bot_can_react",
|
||||
"has_permissions",
|
||||
"can_manage_channel",
|
||||
"has_guild_permissions",
|
||||
"is_owner",
|
||||
"guildowner",
|
||||
"guildowner_or_can_manage_channel",
|
||||
"guildowner_or_permissions",
|
||||
"admin",
|
||||
"admin_or_can_manage_channel",
|
||||
"admin_or_permissions",
|
||||
"mod",
|
||||
"mod_or_can_manage_channel",
|
||||
"mod_or_permissions",
|
||||
"transition_permstate_to",
|
||||
"PermStateTransitions",
|
||||
@@ -135,12 +143,11 @@ class PrivilegeLevel(enum.IntEnum):
|
||||
# admin or mod role.
|
||||
guild_settings = ctx.bot._config.guild(ctx.guild)
|
||||
|
||||
member_snowflakes = ctx.author._roles # DEP-WARN
|
||||
for snowflake in await guild_settings.admin_role():
|
||||
if member_snowflakes.has(snowflake): # DEP-WARN
|
||||
if ctx.author.get_role(snowflake):
|
||||
return cls.ADMIN
|
||||
for snowflake in await guild_settings.mod_role():
|
||||
if member_snowflakes.has(snowflake): # DEP-WARN
|
||||
if ctx.author.get_role(snowflake):
|
||||
return cls.MOD
|
||||
|
||||
return cls.NONE
|
||||
@@ -596,7 +603,10 @@ class Requires:
|
||||
channels = []
|
||||
if author.voice is not None:
|
||||
channels.append(author.voice.channel)
|
||||
channels.append(ctx.channel)
|
||||
if isinstance(ctx.channel, discord.Thread):
|
||||
channels.append(ctx.channel.parent)
|
||||
else:
|
||||
channels.append(ctx.channel)
|
||||
category = ctx.channel.category
|
||||
if category is not None:
|
||||
channels.append(category)
|
||||
@@ -731,6 +741,77 @@ def bot_in_a_guild():
|
||||
return check(predicate)
|
||||
|
||||
|
||||
def bot_can_manage_channel(*, allow_thread_owner: bool = False) -> Callable[[_T], _T]:
|
||||
"""
|
||||
Complain if the bot is missing permissions to manage channel.
|
||||
|
||||
This check properly resolves the permissions for `discord.Thread` as well.
|
||||
|
||||
Parameters
|
||||
----------
|
||||
allow_thread_owner: bool
|
||||
If ``True``, the command will also be allowed to run if the bot is a thread owner.
|
||||
This can, for example, be useful to check if the bot can edit a channel/thread's name
|
||||
as that, in addition to members with manage channel/threads permission,
|
||||
can also be done by the thread owner.
|
||||
"""
|
||||
|
||||
def predicate(ctx: "Context") -> bool:
|
||||
if ctx.guild is None:
|
||||
return False
|
||||
|
||||
if not utils.can_manage_channel_in(
|
||||
ctx.channel, ctx.me, allow_thread_owner=allow_thread_owner
|
||||
):
|
||||
if isinstance(ctx.channel, discord.Thread):
|
||||
# This is a slight lie - thread owner *might* also be allowed
|
||||
# but we just say that bot is missing the Manage Threads permission.
|
||||
missing = discord.Permissions(manage_threads=True)
|
||||
else:
|
||||
missing = discord.Permissions(manage_channels=True)
|
||||
raise BotMissingPermissions(missing=missing)
|
||||
|
||||
return True
|
||||
|
||||
return check(predicate)
|
||||
|
||||
|
||||
def bot_can_react() -> Callable[[_T], _T]:
|
||||
"""
|
||||
Complain if the bot is missing permissions to react.
|
||||
|
||||
This check properly resolves the permissions for `discord.Thread` as well.
|
||||
"""
|
||||
|
||||
async def predicate(ctx: "Context") -> bool:
|
||||
return not (isinstance(ctx.channel, discord.Thread) and ctx.channel.archived)
|
||||
|
||||
def decorator(func: _T) -> _T:
|
||||
func = bot_has_permissions(read_message_history=True, add_reactions=True)(func)
|
||||
func = check(predicate)(func)
|
||||
return func
|
||||
|
||||
return decorator
|
||||
|
||||
|
||||
def _can_manage_channel_deco(
|
||||
privilege_level: Optional[PrivilegeLevel] = None, allow_thread_owner: bool = False
|
||||
) -> Callable[[_T], _T]:
|
||||
async def predicate(ctx: "Context") -> bool:
|
||||
if utils.can_manage_channel_in(
|
||||
ctx.channel, ctx.author, allow_thread_owner=allow_thread_owner
|
||||
):
|
||||
return True
|
||||
|
||||
if privilege_level is not None:
|
||||
if await PrivilegeLevel.from_ctx(ctx) >= privilege_level:
|
||||
return True
|
||||
|
||||
return False
|
||||
|
||||
return permissions_check(predicate)
|
||||
|
||||
|
||||
def has_permissions(**perms: bool):
|
||||
"""Restrict the command to users with these permissions.
|
||||
|
||||
@@ -741,6 +822,24 @@ def has_permissions(**perms: bool):
|
||||
return Requires.get_decorator(None, perms)
|
||||
|
||||
|
||||
def can_manage_channel(*, allow_thread_owner: bool = False) -> Callable[[_T], _T]:
|
||||
"""Restrict the command to users with permissions to manage channel.
|
||||
|
||||
This check properly resolves the permissions for `discord.Thread` as well.
|
||||
|
||||
This check can be overridden by rules.
|
||||
|
||||
Parameters
|
||||
----------
|
||||
allow_thread_owner: bool
|
||||
If ``True``, the command will also be allowed to run if the author is a thread owner.
|
||||
This can, for example, be useful to check if the author can edit a channel/thread's name
|
||||
as that, in addition to members with manage channel/threads permission,
|
||||
can also be done by the thread owner.
|
||||
"""
|
||||
return _can_manage_channel_deco(allow_thread_owner)
|
||||
|
||||
|
||||
def is_owner():
|
||||
"""Restrict the command to bot owners.
|
||||
|
||||
@@ -757,6 +856,24 @@ def guildowner_or_permissions(**perms: bool):
|
||||
return Requires.get_decorator(PrivilegeLevel.GUILD_OWNER, perms)
|
||||
|
||||
|
||||
def guildowner_or_can_manage_channel(*, allow_thread_owner: bool = False) -> Callable[[_T], _T]:
|
||||
"""Restrict the command to the guild owner or user with permissions to manage channel.
|
||||
|
||||
This check properly resolves the permissions for `discord.Thread` as well.
|
||||
|
||||
This check can be overridden by rules.
|
||||
|
||||
Parameters
|
||||
----------
|
||||
allow_thread_owner: bool
|
||||
If ``True``, the command will also be allowed to run if the author is a thread owner.
|
||||
This can, for example, be useful to check if the author can edit a channel/thread's name
|
||||
as that, in addition to members with manage channel/threads permission,
|
||||
can also be done by the thread owner.
|
||||
"""
|
||||
return _can_manage_channel_deco(PrivilegeLevel.GUILD_OWNER, allow_thread_owner)
|
||||
|
||||
|
||||
def guildowner():
|
||||
"""Restrict the command to the guild owner.
|
||||
|
||||
@@ -773,6 +890,24 @@ def admin_or_permissions(**perms: bool):
|
||||
return Requires.get_decorator(PrivilegeLevel.ADMIN, perms)
|
||||
|
||||
|
||||
def admin_or_can_manage_channel(*, allow_thread_owner: bool = False) -> Callable[[_T], _T]:
|
||||
"""Restrict the command to users with the admin role or permissions to manage channel.
|
||||
|
||||
This check properly resolves the permissions for `discord.Thread` as well.
|
||||
|
||||
This check can be overridden by rules.
|
||||
|
||||
Parameters
|
||||
----------
|
||||
allow_thread_owner: bool
|
||||
If ``True``, the command will also be allowed to run if the author is a thread owner.
|
||||
This can, for example, be useful to check if the author can edit a channel/thread's name
|
||||
as that, in addition to members with manage channel/threads permission,
|
||||
can also be done by the thread owner.
|
||||
"""
|
||||
return _can_manage_channel_deco(PrivilegeLevel.ADMIN, allow_thread_owner)
|
||||
|
||||
|
||||
def admin():
|
||||
"""Restrict the command to users with the admin role.
|
||||
|
||||
@@ -789,6 +924,24 @@ def mod_or_permissions(**perms: bool):
|
||||
return Requires.get_decorator(PrivilegeLevel.MOD, perms)
|
||||
|
||||
|
||||
def mod_or_can_manage_channel(*, allow_thread_owner: bool = False) -> Callable[[_T], _T]:
|
||||
"""Restrict the command to users with the mod role or permissions to manage channel.
|
||||
|
||||
This check properly resolves the permissions for `discord.Thread` as well.
|
||||
|
||||
This check can be overridden by rules.
|
||||
|
||||
Parameters
|
||||
----------
|
||||
allow_thread_owner: bool
|
||||
If ``True``, the command will also be allowed to run if the author is a thread owner.
|
||||
This can, for example, be useful to check if the author can edit a channel/thread's name
|
||||
as that, in addition to members with manage channel/threads permission,
|
||||
can also be done by the thread owner.
|
||||
"""
|
||||
return _can_manage_channel_deco(PrivilegeLevel.MOD, allow_thread_owner)
|
||||
|
||||
|
||||
def mod():
|
||||
"""Restrict the command to users with the mod role.
|
||||
|
||||
|
||||
Reference in New Issue
Block a user