Make it possible to disable commands dynamically #1
Conversation
This allows for hiding them completely depending on e.g. a config setting, or arbitrary sender rules (up to the implementing bridge).
|
|
||
| _help_text: str | ||
| _help_args: str | ||
| help_section: HelpSection | ||
|
|
||
| def __init__(self, handler: CommandHandlerFunc, management_only: bool, name: str, | ||
| help_text: str, help_args: str, help_section: HelpSection, | ||
| needs_auth: bool, needs_admin: bool, **kwargs) -> None: | ||
| needs_auth: bool, needs_admin: bool, | ||
| is_enabled_for: IsEnabledForFunc = lambda _: True, |
There was a problem hiding this comment.
Shouldn't this be True or False? (implying this is the return type declaration of that lamda)
| is_enabled_for: IsEnabledForFunc = lambda _: True, | |
| is_enabled_for: IsEnabledForFunc = lambda _: bool, |
There was a problem hiding this comment.
That's the default value, not the type signature. This makes the parameter optional, and backwards compatible.
The (return) type declaration is covered by the IsEnabledForFunc ahead, after = we get the concrete implementation of that.
That is up to a bridge implementation. An example usecase is here: element-hq/mautrix-signal#1 |
mautrix/bridge/commands/handler.py
Outdated
| @@ -392,6 +397,8 @@ async def handle(self, room_id: RoomID, event_id: EventID, sender: BaseUser, | |||
| command = command.lower() | |||
| try: | |||
| handler = command_handlers[command] | |||
| if not handler.is_enabled_for(evt): | |||
| raise KeyError() | |||
| except KeyError: | |||
| try: | |||
| handler = command_aliases[command] | |||
There was a problem hiding this comment.
Do we need another check here in case the disabled command has an alias?
There was a problem hiding this comment.
Good catch. Fixed it in 697e4e9, I think it made the code tidier as well.
Co-authored-by: Sumner Evans <me@sumnerevans.com>
|
This has been merged upstream now (including the suggestions from y'all) so we just need to pull that instead and save ourselves future merge conflicts. |
This allows for hiding them completely depending on e.g. a config setting, or arbitrary sender rules (up to the implementing bridge).
Also accidentally upstreamed already to mautrix#56 – no harm done (though I planned for it to pass here first), but we probably want this for ourselves regardless.