mirror of
https://github.com/Cog-Creators/Red-DiscordBot.git
synced 2025-11-05 18:58:53 -05:00
febca8ccbb
* 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
99 lines
2.8 KiB
ReStructuredText
99 lines
2.8 KiB
ReStructuredText
.. Permissions Cog Reference
|
|
.. _cog_permissions:
|
|
|
|
=========================
|
|
Permissions Cog Reference
|
|
=========================
|
|
|
|
------------
|
|
How it works
|
|
------------
|
|
|
|
When loaded, the permissions cog will allow you to define extra custom rules for who can use a
|
|
command.
|
|
|
|
If no applicable rules are found, the command will behave normally.
|
|
|
|
Rules can also be added to cogs, which will affect all commands from that cog. The cog name can be
|
|
found from the help menu.
|
|
|
|
-------------
|
|
Rule priority
|
|
-------------
|
|
|
|
Rules set for subcommands will take precedence over rules set for the parent commands, which
|
|
lastly take precedence over rules set for the cog. So for example, if a user is denied the Core
|
|
cog, but allowed the ``[p]set token`` command, the user will not be able to use any command in the
|
|
Core cog except for ``[p]set token``.
|
|
|
|
In terms of scope, global rules will be checked first, then server rules.
|
|
|
|
For each of those, the first rule pertaining to one of the following models will be used:
|
|
|
|
1. User
|
|
2. Voice channel
|
|
3. Text channel (parent text channel in case of invocations in threads)
|
|
4. Channel category
|
|
5. Roles, highest to lowest
|
|
6. Server (can only be in global rules)
|
|
7. Default rules
|
|
|
|
In private messages, only global rules about a user will be checked.
|
|
|
|
-------------------------
|
|
Setting Rules From a File
|
|
-------------------------
|
|
|
|
The permissions cog can also set, display or update rules with a YAML file with the
|
|
``[p]permissions yaml`` command. Models must be represented by ID. Rules must be ``true`` for
|
|
allow, or ``false`` for deny. Here is an example:
|
|
|
|
.. code-block:: yaml
|
|
|
|
COG:
|
|
Admin:
|
|
78631113035100160: true
|
|
96733288462286848: false
|
|
Audio:
|
|
133049272517001216: true
|
|
default: false
|
|
COMMAND:
|
|
cleanup bot:
|
|
78631113035100160: true
|
|
default: false
|
|
ping:
|
|
96733288462286848: false
|
|
default: true
|
|
|
|
----------------------
|
|
Example configurations
|
|
----------------------
|
|
|
|
Locking the ``[p]play`` command to approved server(s) as a bot owner:
|
|
|
|
.. code-block:: none
|
|
|
|
[p]permissions setdefaultglobalrule deny play
|
|
[p]permissions addglobalrule allow play [server ID or name]
|
|
|
|
Locking the ``[p]play`` command to specific voice channel(s) as a serverowner or admin:
|
|
|
|
.. code-block:: none
|
|
|
|
[p]permissions setdefaultserverrule deny play
|
|
[p]permissions setdefaultserverrule deny "playlist start"
|
|
[p]permissions addserverrule allow play [voice channel ID or name]
|
|
[p]permissions addserverrule allow "playlist start" [voice channel ID or name]
|
|
|
|
Allowing extra roles to use ``[p]cleanup``:
|
|
|
|
.. code-block:: none
|
|
|
|
[p]permissions addserverrule allow cleanup [role ID]
|
|
|
|
Preventing ``[p]cleanup`` from being used in channels where message history is important:
|
|
|
|
.. code-block:: none
|
|
|
|
[p]permissions addserverrule deny cleanup [channel ID or mention]
|