CopyBot/Red-DiscordBot
1
0
Fork 0
mirror of https://github.com/Cog-Creators/Red-DiscordBot.git synced 2025-12-06 09:22:31 -05:00
Code Issues Packages Projects Releases Wiki Activity

[3.4] [Core] Add more APIs for allowlists and blocklists (#5206) (#5295)

Browse Source 
* [Core] Blacklist api

* [Core] Use to_add, remove star from other method calls

* various touch ups

* style

* fix doc style

* [Core] Remove iterable import

* [Core] Update commands to use the blacklist/whitelist api

* Change signatures to not use `*args`

* Update all usage of private cache to the new public APIs

* Update the docstrings

* Update the usage in diagnoser

(cherry picked from commit 0dded8aa47)

Co-authored-by: Just-Jojo <62262765+Just-Jojo@users.noreply.github.com>
Co-authored-by: Kreusada <67752638+Kreusada@users.noreply.github.com>
Co-authored-by: jack1142 <6032823+jack1142@users.noreply.github.com>

Co-authored-by: Just-Jojo <62262765+Just-Jojo@users.noreply.github.com>
Co-authored-by: Kreusada <67752638+Kreusada@users.noreply.github.com>
Co-authored-by: jack1142 <6032823+jack1142@users.noreply.github.com>
This commit is contained in:
Red-GitHubBot
2021-09-08 22:43:45 +02:00
committed by GitHub
parent 373c04de11
commit c739500a13
3 changed files with 184 additions and 39 deletions
Download Patch File Download Diff File Expand all files Collapse all files

54
redbot/core/core_commands.py
View File

@@ -3765,9 +3765,8 @@ class Core(commands.commands._RuleDropper, commands.Cog, CoreLogic):
**Arguments:**
- `<users...>` - The user or users to add to the allowlist.
"""
uids = {getattr(user, "id", user) for user in users}
await self.bot._whiteblacklist_cache.add_to_whitelist(None, uids)
if len(uids) > 1:
await self.bot.add_to_whitelist(users)
if len(users) > 1:
await ctx.send(_("Users have been added to the allowlist."))
else:
await ctx.send(_("User has been added to the allowlist."))
@@ -3812,9 +3811,8 @@ class Core(commands.commands._RuleDropper, commands.Cog, CoreLogic):
**Arguments:**
- `<users...>` - The user or users to remove from the allowlist.
"""
uids = {getattr(user, "id", user) for user in users}
await self.bot._whiteblacklist_cache.remove_from_whitelist(None, uids)
if len(uids) > 1:
await self.bot.remove_from_whitelist(users)
if len(users) > 1:
await ctx.send(_("Users have been removed from the allowlist."))
else:
await ctx.send(_("User has been removed from the allowlist."))
@@ -3829,7 +3827,7 @@ class Core(commands.commands._RuleDropper, commands.Cog, CoreLogic):
**Example:**
- `[p]allowlist clear`
"""
await self.bot._whiteblacklist_cache.clear_whitelist()
await self.bot.clear_whitelist()
await ctx.send(_("Allowlist has been cleared."))
@commands.group(aliases=["blacklist", "denylist"])
@@ -3863,9 +3861,8 @@ class Core(commands.commands._RuleDropper, commands.Cog, CoreLogic):
await ctx.send(_("You cannot add an owner to the blocklist!"))
return
uids = {getattr(user, "id", user) for user in users}
await self.bot._whiteblacklist_cache.add_to_blacklist(None, uids)
if len(uids) > 1:
await self.bot.add_to_blacklist(users)
if len(users) > 1:
await ctx.send(_("Users have been added to the blocklist."))
else:
await ctx.send(_("User has been added to the blocklist."))
@@ -3878,7 +3875,7 @@ class Core(commands.commands._RuleDropper, commands.Cog, CoreLogic):
**Example:**
- `[p]blocklist list`
"""
curr_list = await self.bot._whiteblacklist_cache.get_blacklist(None)
curr_list = await self.bot.get_blacklist()
if not curr_list:
await ctx.send("Blocklist is empty.")
@@ -3908,9 +3905,8 @@ class Core(commands.commands._RuleDropper, commands.Cog, CoreLogic):
**Arguments:**
- `<users...>` - The user or users to remove from the blocklist.
"""
uids = {getattr(user, "id", user) for user in users}
await self.bot._whiteblacklist_cache.remove_from_blacklist(None, uids)
if len(uids) > 1:
await self.bot.remove_from_blacklist(users)
if len(users) > 1:
await ctx.send(_("Users have been removed from the blocklist."))
else:
await ctx.send(_("User has been removed from the blocklist."))
@@ -3923,7 +3919,7 @@ class Core(commands.commands._RuleDropper, commands.Cog, CoreLogic):
**Example:**
- `[p]blocklist clear`
"""
await self.bot._whiteblacklist_cache.clear_blacklist()
await self.bot.clear_blacklist()
await ctx.send(_("Blocklist has been cleared."))
@commands.group(aliases=["localwhitelist"])
@@ -3957,7 +3953,7 @@ class Core(commands.commands._RuleDropper, commands.Cog, CoreLogic):
names = [getattr(u_or_r, "name", u_or_r) for u_or_r in users_or_roles]
uids = {getattr(u_or_r, "id", u_or_r) for u_or_r in users_or_roles}
if not (ctx.guild.owner == ctx.author or await self.bot.is_owner(ctx.author)):
current_whitelist = await self.bot._whiteblacklist_cache.get_whitelist(ctx.guild)
current_whitelist = await self.bot.get_whitelist(ctx.guild)
theoretical_whitelist = current_whitelist.union(uids)
ids = {i for i in (ctx.author.id, *(getattr(ctx.author, "_roles", [])))}
if ids.isdisjoint(theoretical_whitelist):
@@ -3968,7 +3964,7 @@ class Core(commands.commands._RuleDropper, commands.Cog, CoreLogic):
"please ensure to add yourself to the allowlist first."
)
)
await self.bot._whiteblacklist_cache.add_to_whitelist(ctx.guild, uids)
await self.bot.add_to_whitelist(uids, guild=ctx.guild)
if len(uids) > 1:
await ctx.send(_("Users and/or roles have been added to the allowlist."))
@@ -3983,7 +3979,7 @@ class Core(commands.commands._RuleDropper, commands.Cog, CoreLogic):
**Example:**
- `[p]localallowlist list`
"""
curr_list = await self.bot._whiteblacklist_cache.get_whitelist(ctx.guild)
curr_list = await self.bot.get_whitelist(ctx.guild)
if not curr_list:
await ctx.send("Server allowlist is empty.")
@@ -4021,7 +4017,7 @@ class Core(commands.commands._RuleDropper, commands.Cog, CoreLogic):
names = [getattr(u_or_r, "name", u_or_r) for u_or_r in users_or_roles]
uids = {getattr(u_or_r, "id", u_or_r) for u_or_r in users_or_roles}
if not (ctx.guild.owner == ctx.author or await self.bot.is_owner(ctx.author)):
current_whitelist = await self.bot._whiteblacklist_cache.get_whitelist(ctx.guild)
current_whitelist = await self.bot.get_whitelist(ctx.guild)
theoretical_whitelist = current_whitelist - uids
ids = {i for i in (ctx.author.id, *(getattr(ctx.author, "_roles", [])))}
if theoretical_whitelist and ids.isdisjoint(theoretical_whitelist):
@@ -4031,7 +4027,7 @@ class Core(commands.commands._RuleDropper, commands.Cog, CoreLogic):
"remove your ability to run commands."
)
)
await self.bot._whiteblacklist_cache.remove_from_whitelist(ctx.guild, uids)
await self.bot.remove_from_whitelist(uids, guild=ctx.guild)
if len(uids) > 1:
await ctx.send(_("Users and/or roles have been removed from the server allowlist."))
@@ -4048,7 +4044,7 @@ class Core(commands.commands._RuleDropper, commands.Cog, CoreLogic):
**Example:**
- `[p]localallowlist clear`
"""
await self.bot._whiteblacklist_cache.clear_whitelist(ctx.guild)
await self.bot.clear_whitelist(ctx.guild)
await ctx.send(_("Server allowlist has been cleared."))
@commands.group(aliases=["localblacklist"])
@@ -4088,11 +4084,9 @@ class Core(commands.commands._RuleDropper, commands.Cog, CoreLogic):
if await ctx.bot.is_owner(uid):
await ctx.send(_("You cannot add a bot owner to the blocklist!"))
return
names = [getattr(u_or_r, "name", u_or_r) for u_or_r in users_or_roles]
uids = {getattr(u_or_r, "id", u_or_r) for u_or_r in users_or_roles}
await self.bot._whiteblacklist_cache.add_to_blacklist(ctx.guild, uids)
await self.bot.add_to_blacklist(users_or_roles, guild=ctx.guild)
if len(uids) > 1:
if len(users_or_roles) > 1:
await ctx.send(_("Users and/or roles have been added from the server blocklist."))
else:
await ctx.send(_("User or role has been added from the server blocklist."))
@@ -4105,7 +4099,7 @@ class Core(commands.commands._RuleDropper, commands.Cog, CoreLogic):
**Example:**
- `[p]localblocklist list`
"""
curr_list = await self.bot._whiteblacklist_cache.get_blacklist(ctx.guild)
curr_list = await self.bot.get_blacklist(ctx.guild)
if not curr_list:
await ctx.send("Server blocklist is empty.")
@@ -4138,11 +4132,9 @@ class Core(commands.commands._RuleDropper, commands.Cog, CoreLogic):
**Arguments:**
- `<users_or_roles...>` - The users or roles to remove from the local blocklist.
"""
names = [getattr(u_or_r, "name", u_or_r) for u_or_r in users_or_roles]
uids = {getattr(u_or_r, "id", u_or_r) for u_or_r in users_or_roles}
await self.bot._whiteblacklist_cache.remove_from_blacklist(ctx.guild, uids)
await self.bot.remove_from_blacklist(users_or_roles, guild=ctx.guild)
if len(uids) > 1:
if len(users_or_roles) > 1:
await ctx.send(_("Users and/or roles have been removed from the server blocklist."))
else:
await ctx.send(_("User or role has been removed from the server blocklist."))
@@ -4157,7 +4149,7 @@ class Core(commands.commands._RuleDropper, commands.Cog, CoreLogic):
**Example:**
- `[p]blocklist clear`
"""
await self.bot._whiteblacklist_cache.clear_blacklist(ctx.guild)
await self.bot.clear_blacklist(ctx.guild)
await ctx.send(_("Server blocklist has been cleared."))
@checks.guildowner_or_permissions(administrator=True)