[V3] Permissions (#1548)

* This starts setting up checks.py to handle managed permission overrides

* A decent starting point, more work to come

* missing else fix

* more work on this

* reduce redundant code

* More work on this...

* more progress

* add a debug flag to some things in .resolvers to help with exploring why checks behave in a certain way

* modify this to be a list for ease of showing full resolution order

* more

* don't bypass is_owner, ever

* remove old logic about ownercommands

* better handling of chec validity

* anonymous functions return None for __module__, remove some code as a result

* mutable default bind fix

* Add a caching layer (to be invalidated as needed)

Ensure checks in the chain inserted before the core logic only return None or False
(whitelists then blacklists are checked first in core logic, from most to least specific scope, overriding this with an allow does not make sense)

* more progress, slow work as I have time

* Modifies the predicates so that their inner functions are accesible from cogs without
being a check

* Update checks.py

Safety for existing permissions.py cogs

* This is where I take a change of course on setting this up,
because this would have been the most long winded interactive command ever as
it was starting to progress.

This is going to support individual entry updates, settings from yaml, gettings, and clearing existing settings
as well as printing a settings template out and referring people to what is going to be very well written docs

* block permissions cog from being unblocked by the permissions cog as a safety feature (really, co-owner exists at this point)

* WIP

* Okay, this has the intent of the changes, just to actually test these as working as intended + add corresponding guild functions

* oh nice, missed a couple files, sec...

* WIP, also, something's broken in resolvers or check_overrides >>

* This is working now (still needs docs and more...)

* unmerge changes from other PR

* is_owner still needs to exist in here due to management of non checked commands

* Update this to new style standards

* forgot to commit some local changes earlier

* fix update logic

* fix update logic

* b14 fix, lol

* fix issue with management command name

* this isnt a real fix

* Ok..

* perms

* This is working, but needs docs and more configuration opts now

* more

* Ux functions, need testing

* style

* fix using the obj str rather than the id

* fix CogOrCommand converter

* Return the correct things in the converter

* last fix, needs docs, and possibly some extra Ux utils

* start doc writing

* extra user facing commands

* yaml docs

* yaml fix

* secondary checks-fix

* 3rd party check stuff

* remove warning that this isn't ready yet

* swap ctx.tick for real responses, require emoji perms for interactive menuing, better attr handling for nicknames

* send file to author

* alias to `p`

* more ctx tick removal

(This is a long ass changelog...)
This commit is contained in:
Michael H 2018-05-27 18:17:17 -04:00 committed by Kowlin
parent 537531803a
commit 54975eb812
9 changed files with 937 additions and 0 deletions

1
.github/CODEOWNERS vendored
View File

@ -43,6 +43,7 @@ redbot/cogs/streams/* @Twentysix26 @palmtree5
redbot/cogs/trivia/* @Tobotimus redbot/cogs/trivia/* @Tobotimus
redbot/cogs/dataconverter/* @mikeshardmind redbot/cogs/dataconverter/* @mikeshardmind
redbot/cogs/reports/* @mikeshardmind redbot/cogs/reports/* @mikeshardmind
redbot/cogs/permissions/* @mikeshardmind
# Docs # Docs
docs/* @tekulvw @palmtree5 docs/* @tekulvw @palmtree5

75
docs/cog_permissions.rst Normal file
View File

@ -0,0 +1,75 @@
.. Permissions Cog Reference
=========================
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 as if
the cog was not loaded.
-------------
Rule priority
-------------
Rules set will be checked in the following order
1. Owner level command specific settings
2. Owner level cog specific settings
3. Server level command specific settings
4. Server level cog specific settings
For each of those, settings have varying priorities (listed below, highest to lowest priority)
1. User whitelist
2. User blacklist
3. Voice Channel whitelist
4. Voice Channel blacklist
5. Text Channel whitelist
6. Text Channel blacklist
7. Role settings (see below)
8. Server whitelist
9. Server blacklist
For the role whitelist and blacklist settings,
roles will be checked individually in order from highest to lowest role the user has
Each role will be checked for whitelist, then blacklist. The first role with a setting
found will be the one used.
-------------------------
Setting Rules from a file
-------------------------
The permissions cog can set rules from a yaml file:
All entries are based on ID.
An example of the expected format is shown below.
.. code-block:: yaml
cogs:
Admin:
allow:
- 78631113035100160
deny:
- 96733288462286848
Audio:
allow:
- 133049272517001216
default: deny
commands:
cleanup bot:
allow:
- 78631113035100160
default: deny
ping:
deny:
- 96733288462286848
default: allow

View File

@ -26,6 +26,7 @@ Welcome to Red - Discord Bot's documentation!
:caption: Cog Reference: :caption: Cog Reference:
cog_downloader cog_downloader
cog_permissions
.. toctree:: .. toctree::
:maxdepth: 2 :maxdepth: 2

View File

@ -0,0 +1,5 @@
from .permissions import Permissions
def setup(bot):
bot.add_cog(Permissions(bot))

View File

@ -0,0 +1,26 @@
from redbot.core import commands
from typing import Tuple
class CogOrCommand(commands.Converter):
async def convert(self, ctx: commands.Context, arg: str) -> Tuple[str]:
ret = ctx.bot.get_cog(arg)
if ret:
return "cogs", ret.__class__.__name__
ret = ctx.bot.get_command(arg)
if ret:
return "commands", ret.qualified_name
raise commands.BadArgument()
class RuleType(commands.Converter):
async def convert(self, ctx: commands.Context, arg: str) -> str:
if arg.lower() in ("allow", "whitelist", "allowed"):
return "allow"
if arg.lower() in ("deny", "blacklist", "denied"):
return "deny"
raise commands.BadArgument()

View File

@ -0,0 +1,652 @@
from copy import copy
import contextlib
import asyncio
import discord
from redbot.core import commands
from redbot.core.bot import Red
from redbot.core import checks
from redbot.core.config import Config
from redbot.core.i18n import Translator, cog_i18n
from .resolvers import val_if_check_is_valid, resolve_models
from .yaml_handler import yamlset_acl, yamlget_acl
from .converters import CogOrCommand, RuleType
_models = ["owner", "guildowner", "admin", "mod"]
_ = Translator("Permissions", __file__)
REACTS = {"\N{WHITE HEAVY CHECK MARK}": True, "\N{NEGATIVE SQUARED CROSS MARK}": False}
@cog_i18n(_)
class Permissions:
"""
A high level permission model
"""
# Not sure if we will use admin or mod models in core red
# but they are explicitly supported
resolution_order = {k: _models[:i] for i, k in enumerate(_models, 1)}
def __init__(self, bot: Red):
self.bot = bot
self.config = Config.get_conf(self, identifier=78631113035100160, force_registration=True)
self._before = []
self._after = []
self.config.register_global(owner_models={})
self.config.register_guild(owner_models={})
def add_check(self, check_obj: object, before_or_after: str):
"""
adds a check to the check ordering
checks should be a function taking 2 arguments:
ctx: commands.Context
level: str
and returning:
None: do not interfere
True: command should be allowed even if they dont
have role or perm requirements for the check
False: command should be blocked
before_or_after:
Should literally be a str equaling 'before' or 'after'
This should be based on if this should take priority
over set rules or not
3rd party cogs adding checks using this should only allow
the owner to add checks before, and ensure only the owner
can add checks recieving the level 'owner'
3rd party cogs should keep a copy of of any checks they registered
and deregister then on unload
"""
if before_or_after == "before":
self._before.append(check_obj)
elif before_or_after == "after":
self._after.append(check_obj)
else:
raise TypeError("RTFM")
def remove_check(self, check_obj: object, before_or_after: str):
"""
removes a previously registered check object
3rd party cogs should keep a copy of of any checks they registered
and deregister then on unload
"""
if before_or_after == "before":
self._before.remove(check_obj)
elif before_or_after == "after":
self._after.remove(check_obj)
else:
raise TypeError("RTFM")
async def __global_check(self, ctx):
"""
Yes, this is needed on top of hooking into checks.py
to ensure that unchecked commands can still be managed by permissions
This should return True in the case of no overrides
defering to check logic
This works since all checks must be True to run
"""
v = await self.check_overrides(ctx, "mod")
if v is False:
return False
return True
async def check_overrides(self, ctx: commands.Context, level: str) -> bool:
"""
This checks for any overrides in the permission model
Parameters
----------
ctx: `redbot.core.context.commands.Context`
The context of the command
level: `str`
One of 'owner', 'guildowner', 'admin', 'mod'
Returns
-------
bool
a trinary value using None + bool to resolve permissions for
checks.py
"""
if await ctx.bot.is_owner(ctx.author):
return True
voice_channel = None
with contextlib.suppress(Exception):
voice_channel = ctx.author.voice.voice_channel
entries = [x for x in (ctx.author, voice_channel, ctx.channel) if x]
roles = sorted(ctx.author.roles, reverse=True) if ctx.guild else []
entries.extend([x.id for x in roles])
for check in self._before:
override = await val_if_check_is_valid(check=check, ctx=ctx, level=level)
if override is not None:
return override
for model in self.resolution_order[level]:
override_model = getattr(self, model + "_model", None)
override = await override_model(ctx) if override_model else None
if override is not None:
return override
for check in self._after:
override = await val_if_check_is_valid(check=check, ctx=ctx, level=level)
if override is not None:
return override
return None
async def owner_model(self, ctx: commands.Context) -> bool:
"""
Handles owner level overrides
"""
async with self.config.owner_models() as models:
return resolve_models(ctx=ctx, models=models)
async def guildowner_model(self, ctx: commands.Context) -> bool:
"""
Handles guild level overrides
"""
async with self.config.guild(ctx.guild).owner_models() as models:
return resolve_models(ctx=ctx, models=models)
# Either of the below function signatures could be used
# without any other modifications required at a later date
#
# async def admin_model(self, ctx: commands.Context) -> bool:
# async def mod_model(self, ctx: commands.Context) -> bool:
@commands.group(aliases=["p"])
async def permissions(self, ctx: commands.Context):
"""
Permission management tools
"""
if ctx.invoked_subcommand is None:
await ctx.send_help()
@permissions.command()
async def explain(self, ctx: commands.Context):
"""
Provides a detailed explanation of how the permission model functions
"""
# Apologies in advance for the translators out there...
message = _(
"This cog extends the default permission model of the bot. "
"By default, many commands are restricted based on what "
"the command can do."
"\n"
"Any command that could impact the host machine, "
"is generally owner only."
"\n"
"Commands that take administrative or moderator "
"actions in servers generally require a mod or an admin."
"\n"
"This cog allows you to refine some of those settings. "
"You can allow wider or narrower "
"access to most commands using it."
"\n\n"
"When additional rules are set using this cog, "
"those rules will be checked prior to "
"checking for the default restrictions of the command. "
"\n"
"Rules set globally (by the owner) are checked first, "
"then rules set for guilds. If multiple global or guild "
"rules apply to the case, the order they are checked is:"
"\n"
"1. Rules about a user.\n"
"2. Rules about the voice channel a user is in.\n"
"3. Rules about the text channel a command was issued in\n"
"4. Rules about a role the user has "
"(The highest role they have with a rule will be used)\n"
"5. Rules about the guild a user is in (Owner level only)"
"\n\nFor more details, please read the official documentation."
)
await ctx.maybe_send_embed(message)
@permissions.command(name="canrun")
async def _test_permission_model(
self, ctx: commands.Context, user: discord.Member, *, command: str
):
"""
This checks if someone can run a command in the current location
"""
if not command:
return await ctx.send_help()
message = copy(ctx.message)
message.author = user
message.content = "{}{}".format(ctx.prefix, command)
com = self.bot.get_command(command)
if com is None:
out = _("No such command")
else:
try:
testcontext = await self.bot.get_context(message, cls=commands.Context)
can = await com.can_run(testcontext)
except commands.CheckFailure:
can = False
out = (
_("That user can run the specified command.")
if can
else _("That user can not run the specified command.")
)
await ctx.send(out)
@checks.is_owner()
@permissions.command(name="setglobalacl")
async def owner_set_acl(self, ctx: commands.Context):
"""
Take a YAML file upload to set permissions from
"""
if not ctx.message.attachments:
return await ctx.send(_("You must upload a file"))
try:
await yamlset_acl(ctx, config=self.config.owner_models, update=False)
except Exception as e:
print(e)
return await ctx.send(_("Inalid syntax"))
else:
await ctx.send(_("Rules set."))
@checks.is_owner()
@permissions.command(name="getglobalacl")
async def owner_get_acl(self, ctx: commands.Context):
"""
Dumps a YAML file with the current owner level permissions
"""
await yamlget_acl(ctx, config=self.config.owner_models)
@commands.guild_only()
@checks.guildowner_or_permissions(administrator=True)
@permissions.command(name="setguildacl")
async def guild_set_acl(self, ctx: commands.Context):
"""
Take a YAML file upload to set permissions from
"""
if not ctx.message.attachments:
return await ctx.send(_("You must upload a file"))
try:
await yamlset_acl(ctx, config=self.config.guild(ctx.guild).owner_models, update=False)
except Exception as e:
print(e)
return await ctx.send(_("Inalid syntax"))
else:
await ctx.send(_("Rules set."))
@commands.guild_only()
@checks.guildowner_or_permissions(administrator=True)
@permissions.command(name="getguildacl")
async def guild_get_acl(self, ctx: commands.Context):
"""
Dumps a YAML file with the current owner level permissions
"""
await yamlget_acl(ctx, config=self.config.guild(ctx.guild).owner_models)
@commands.guild_only()
@checks.guildowner_or_permissions(administrator=True)
@permissions.command(name="updateguildacl")
async def guild_update_acl(self, ctx: commands.Context):
"""
Take a YAML file upload to update permissions from
Use this to not lose existing rules
"""
if not ctx.message.attachments:
return await ctx.send(_("You must upload a file"))
try:
await yamlset_acl(ctx, config=self.config.guild(ctx.guild).owner_models, update=True)
except Exception as e:
print(e)
return await ctx.send(_("Inalid syntax"))
else:
await ctx.send(_("Rules set."))
@checks.is_owner()
@permissions.command(name="updateglobalacl")
async def owner_update_acl(self, ctx: commands.Context):
"""
Take a YAML file upload to set permissions from
Use this to not lose existing rules
"""
if not ctx.message.attachments:
return await ctx.send(_("You must upload a file"))
try:
await yamlset_acl(ctx, config=self.config.owner_models, update=True)
except Exception as e:
print(e)
return await ctx.send(_("Inalid syntax"))
else:
await ctx.send(_("Rules set."))
@checks.is_owner()
@permissions.command(name="addglobalrule")
async def add_to_global_rule(
self,
ctx: commands.Context,
allow_or_deny: RuleType,
cog_or_command: CogOrCommand,
who_or_what: str,
):
"""
adds something to the rules
allow_or_deny: "allow" or "deny", depending on the rule to modify
cog_or_command: case sensitive cog or command name
nested commands should be space seperated, but enclosed in quotes
who_or_what: what to add to the rule list.
For best results, use an ID or mention
The bot will try to uniquely match even without,
but a failure to do so will raise an error
This can be a user, role, channel, or guild
"""
obj = self.find_object_uniquely(who_or_what)
if not obj:
return await ctx.send(_("No unique matches. Try using an ID or mention"))
model_type, type_name = cog_or_command
async with self.config.owner_models() as models:
data = {k: v for k, v in models.items()}
if model_type not in data:
data[model_type] = {}
if type_name not in data[model_type]:
data[model_type][type_name] = {}
if allow_or_deny not in data[model_type][type_name]:
data[model_type][type_name][allow_or_deny] = []
if obj in data[model_type][type_name][allow_or_deny]:
return await ctx.send(_("That rule already exists."))
data[model_type][type_name][allow_or_deny].append(obj)
models.update(data)
await ctx.send(_("Rule added."))
@commands.guild_only()
@checks.guildowner_or_permissions(administrator=True)
@permissions.command(name="addguildrule")
async def add_to_guild_rule(
self,
ctx: commands.Context,
allow_or_deny: RuleType,
cog_or_command: CogOrCommand,
who_or_what: str,
):
"""
adds something to the rules
allow_or_deny: "allow" or "deny", depending on the rule to modify
cog_or_command: case sensitive cog or command name
nested commands should be space seperated, but enclosed in quotes
who_or_what: what to add to the rule list.
For best results, use an ID or mention
The bot will try to uniquely match even without,
but a failure to do so will raise an error
This can be a user, role, channel, or guild
"""
obj = self.find_object_uniquely(who_or_what)
if not obj:
return await ctx.send(_("No unique matches. Try using an ID or mention"))
model_type, type_name = cog_or_command
async with self.config.guild(ctx.guild).owner_models() as models:
data = {k: v for k, v in models.items()}
if model_type not in data:
data[model_type] = {}
if type_name not in data[model_type]:
data[model_type][type_name] = {}
if allow_or_deny not in data[model_type][type_name]:
data[model_type][type_name][allow_or_deny] = []
if obj in data[model_type][type_name][allow_or_deny]:
return await ctx.send(_("That rule already exists."))
data[model_type][type_name][allow_or_deny].append(obj)
models.update(data)
await ctx.send(_("Rule added."))
@checks.is_owner()
@permissions.command(name="removeglobalrule")
async def rem_from_global_rule(
self,
ctx: commands.Context,
allow_or_deny: RuleType,
cog_or_command: CogOrCommand,
who_or_what: str,
):
"""
removes something from the rules
allow_or_deny: "allow" or "deny", depending on the rule to modify
cog_or_command: case sensitive cog or command name
nested commands should be space seperated, but enclosed in quotes
who_or_what: what to add to the rule list.
For best results, use an ID or mention
The bot will try to uniquely match even without,
but a failure to do so will raise an error
This can be a user, role, channel, or guild
"""
obj = self.find_object_uniquely(who_or_what)
if not obj:
return await ctx.send(_("No unique matches. Try using an ID or mention"))
model_type, type_name = cog_or_command
async with self.config.owner_models() as models:
data = {k: v for k, v in models.items()}
if model_type not in data:
data[model_type] = {}
if type_name not in data[model_type]:
data[model_type][type_name] = {}
if allow_or_deny not in data[model_type][type_name]:
data[model_type][type_name][allow_or_deny] = []
if obj not in data[model_type][type_name][allow_or_deny]:
return await ctx.send(_("That rule doesn't exist."))
data[model_type][type_name][allow_or_deny].remove(obj)
models.update(data)
await ctx.send(_("Rule removed."))
@commands.guild_only()
@checks.guildowner_or_permissions(administrator=True)
@permissions.command(name="removeguildrule")
async def rem_from_guild_rule(
self,
ctx: commands.Context,
allow_or_deny: RuleType,
cog_or_command: CogOrCommand,
who_or_what: str,
):
"""
removes something from the rules
allow_or_deny: "allow" or "deny", depending on the rule to modify
cog_or_command: case sensitive cog or command name
nested commands should be space seperated, but enclosed in quotes
who_or_what: what to add to the rule list.
For best results, use an ID or mention
The bot will try to uniquely match even without,
but a failure to do so will raise an error
This can be a user, role, channel, or guild
"""
obj = self.find_object_uniquely(who_or_what)
if not obj:
return await ctx.send(_("No unique matches. Try using an ID or mention"))
model_type, type_name = cog_or_command
async with self.config.guild(ctx.guild).owner_models() as models:
data = {k: v for k, v in models.items()}
if model_type not in data:
data[model_type] = {}
if type_name not in data[model_type]:
data[model_type][type_name] = {}
if allow_or_deny not in data[model_type][type_name]:
data[model_type][type_name][allow_or_deny] = []
if obj not in data[model_type][type_name][allow_or_deny]:
return await ctx.send(_("That rule doesn't exist."))
data[model_type][type_name][allow_or_deny].remove(obj)
models.update(data)
await ctx.send(_("Rule removed."))
@commands.guild_only()
@checks.guildowner_or_permissions(administrator=True)
@permissions.command(name="setdefaultguildrule")
async def set_default_guild_rule(
self, ctx: commands.Context, cog_or_command: CogOrCommand, allow_or_deny: RuleType = None
):
"""
Sets the default behavior for a cog or command if no rule is set
Use with a cog or command and no setting to clear the default and defer to
normal check logic
"""
if allow_or_deny:
val_to_set = {"allow": True, "deny": False}.get(allow_or_deny)
else:
val_to_set = None
model_type, type_name = cog_or_command
async with self.config.guild(ctx.guild).owner_models() as models:
data = {k: v for k, v in models.items()}
if model_type not in data:
data[model_type] = {}
if type_name not in data[model_type]:
data[model_type][type_name] = {}
data[model_type][type_name]["default"] = val_to_set
models.update(data)
await ctx.send(_("Defualt set."))
@checks.is_owner()
@permissions.command(name="setdefaultglobalrule")
async def set_default_global_rule(
self, ctx: commands.Context, cog_or_command: CogOrCommand, allow_or_deny: RuleType = None
):
"""
Sets the default behavior for a cog or command if no rule is set
Use with a cog or command and no setting to clear the default and defer to
normal check logic
"""
if allow_or_deny:
val_to_set = {"allow": True, "deny": False}.get(allow_or_deny)
else:
val_to_set = None
model_type, type_name = cog_or_command
async with self.config.owner_models() as models:
data = {k: v for k, v in models.items()}
if model_type not in data:
data[model_type] = {}
if type_name not in data[model_type]:
data[model_type][type_name] = {}
data[model_type][type_name]["default"] = val_to_set
models.update(data)
await ctx.send(_("Defualt set."))
@commands.bot_has_permissions(add_reactions=True)
@checks.is_owner()
@permissions.command(name="clearglobalsettings")
async def clear_globals(self, ctx: commands.Context):
"""
Clears all global rules.
"""
m = await ctx.send("Are you sure?")
for r in REACTS.keys():
await m.add_reaction(r)
try:
reaction, user = await self.bot.wait_for(
"reaction_add", check=lambda r, u: u == ctx.author and str(r) in REACTS, timeout=30
)
except asyncio.TimeoutError:
return await ctx.send(_("Ok, try responding with an emoji next time."))
if REACTS.get(str(reaction)):
await self.config.owner_models.clear()
await ctx.send(_("Global settings cleared"))
else:
await ctx.send(_("Okay."))
@commands.bot_has_permissions(add_reactions=True)
@commands.guild_only()
@checks.guildowner_or_permissions(administrator=True)
@permissions.command(name="clearguildsettings")
async def clear_guild_settings(self, ctx: commands.Context):
"""
Clears all guild rules.
"""
m = await ctx.send("Are you sure?")
for r in REACTS.keys():
await m.add_reaction(r)
try:
reaction, user = await self.bot.wait_for(
"reaction_add", check=lambda r, u: u == ctx.author and str(r) in REACTS, timeout=30
)
except asyncio.TimeoutError:
return await ctx.send(_("Ok, try responding with an emoji next time."))
if REACTS.get(str(reaction)):
await self.config.guild(ctx.guild).owner_models.clear()
await ctx.send(_("Guild settings cleared"))
else:
await ctx.send(_("Okay."))
def find_object_uniquely(self, info: str) -> int:
"""
Finds an object uniquely, returns it's id or returns None
"""
if info is None:
return None
objs = []
objs.extend(self.bot.users)
for guild in self.bot.guilds:
objs.extend(guild.roles)
try:
_id = int(info)
except ValueError:
_id = None
for function in (
lambda x: x.id == _id,
lambda x: x.mention == info,
lambda x: str(x) == info,
lambda x: x.name == info,
lambda x: (x.nick if hasattr(x, "nick") else None) == info,
):
canidates = list(filter(function, objs))
if len(canidates) == 1:
return canidates[0].id
return None

View File

@ -0,0 +1,91 @@
import types
import contextlib
import asyncio
import logging
from redbot.core import commands
log = logging.getLogger("redbot.cogs.permissions.resolvers")
async def val_if_check_is_valid(*, ctx: commands.Context, check: object, level: str) -> bool:
"""
Returns the value from a check if it is valid
"""
# Non staticmethods should not be run without their parent
# class, even if the parent class did not deregister them
if check.__module__ is None:
pass
elif isinstance(check, types.FunctionType):
if (
next(filter(lambda x: check.__module__ == x.__module__, ctx.bot.cogs.values()), None)
is None
):
return None
val = None
# let's not spam the console with improperly made 3rd party checks
try:
if asyncio.iscoroutine(check) or asyncio.iscoroutinefunction(check):
val = await check(ctx, level=level)
else:
val = check(ctx, level=level)
except Exception as e:
# but still provide a way to view it (run with debug flag)
log.debug(str(e))
return val
def resolve_models(*, ctx: commands.Context, models: dict) -> bool:
"""
Resolves models in order.
"""
cmd_name = ctx.command.qualified_name
cog_name = ctx.cog.__class__.__name__
resolved = None
to_iter = (("commands", cmd_name), ("cogs", cog_name))
for model_name, ctx_attr in to_iter:
if ctx_attr in models.get(model_name, {}):
blacklist = models[model_name][ctx_attr].get("deny", [])
whitelist = models[model_name][ctx_attr].get("allow", [])
resolved = resolve_lists(ctx=ctx, whitelist=whitelist, blacklist=blacklist)
if resolved is not None:
return resolved
resolved = models[model_name][ctx_attr].get("default", None)
if resolved is not None:
return resolved
return None
def resolve_lists(*, ctx: commands.Context, whitelist: list, blacklist: list) -> bool:
"""
resolves specific lists
"""
voice_channel = None
with contextlib.suppress(Exception):
voice_channel = ctx.author.voice.voice_channel
entries = [x.id for x in (ctx.author, voice_channel, ctx.channel) if x]
roles = sorted(ctx.author.roles, reverse=True) if ctx.guild else []
entries.extend([x.id for x in roles])
# entries now contains the following (in order) (if applicable)
# author.id
# author.voice.voice_channel.id
# channel.id
# role.id for each role (highest to lowest)
# (implicitly) guild.id because
# the @everyone role shares an id with the guild
for entry in entries:
if entry in whitelist:
return True
if entry in blacklist:
return False
return None

View File

@ -0,0 +1,19 @@
cogs:
Admin:
allow:
- 78631113035100160
deny:
- 96733288462286848
Audio:
allow:
- 133049272517001216
default: deny
commands:
cleanup bot:
allow:
- 78631113035100160
default: deny
ping:
deny:
- 96733288462286848
default: allow

View File

@ -0,0 +1,67 @@
import io
import yaml
import pathlib
import discord
def yaml_template() -> dict:
template_fp = pathlib.Path(__file__).parent / "template.yaml"
with template_fp.open() as f:
return yaml.safe_load(f)
async def yamlset_acl(ctx, *, config, update):
_fp = io.BytesIO()
await ctx.message.attachments[0].save(_fp)
try:
data = yaml.safe_load(_fp)
except yaml.YAMLError:
_fp.close()
del _fp
raise
old_data = await config()
for outer, inner in data.items():
for ok, iv in inner.items():
for k, v in iv.items():
if k == "default":
data[outer][ok][k] = {"allow": True, "deny": False}.get(v.lower(), None)
if not update:
continue
try:
if isinstance(old_data[outer][ok][k], list):
data[outer][ok][k].extend(old_data[outer][ok][k])
except KeyError:
pass
await config.set(data)
async def yamlget_acl(ctx, *, config):
data = await config()
removals = []
for outer, inner in data.items():
for ok, iv in inner.items():
for k, v in iv.items():
if k != "default":
continue
if v is True:
data[outer][ok][k] = "allow"
elif v is False:
data[outer][ok][k] = "deny"
else:
removals.append((outer, ok, k))
for tup in removals:
o, i, k = tup
data[o][i].pop(k, None)
_fp = io.BytesIO(yaml.dump(data, default_flow_style=False).encode())
_fp.seek(0)
await ctx.author.send(file=discord.File(_fp, filename="acl.yaml"))
_fp.close()