diff options
| author | 2018-09-30 17:29:09 +0100 | |
|---|---|---|
| committer | 2018-09-30 17:29:09 +0100 | |
| commit | 10ef985a8a849a6bbfa8cbb63c2548e42ffb3957 (patch) | |
| tree | 4da29ff0462ca69820d81aa95afb4b261ab3213c /modules/permissions.py | |
| parent | received.command takes a final [command] part (diff) | |
| signature | ||
Switch to using docstring for usage, permission and require_mode
Diffstat (limited to 'modules/permissions.py')
| -rw-r--r-- | modules/permissions.py | 38 |
1 files changed, 21 insertions, 17 deletions
diff --git a/modules/permissions.py b/modules/permissions.py index dde6b441..57b667d1 100644 --- a/modules/permissions.py +++ b/modules/permissions.py @@ -38,11 +38,11 @@ class Module(ModuleManager.BaseModule): user.identified_account_override = None user.identified_account_id_override = None - @Utils.hook("received.command.identify", private_only=True, min_args=1, - usage="[account] <password>") + @Utils.hook("received.command.identify", private_only=True, min_args=1) def identify(self, event): """ - Identify yourself + :help: Identify yourself + :usage: [account] <password> """ identity_mechanism = event["server"].get_setting("identity-mechanism", "internal") @@ -80,11 +80,11 @@ class Module(ModuleManager.BaseModule): else: event["stderr"].write("You are already identified") - @Utils.hook("received.command.register", private_only=True, min_args=1, - usage="<password>") + @Utils.hook("received.command.register", private_only=True, min_args=1) def register(self, event): """ - Register yourself + :help: Register yourself + :usage: <password> """ identity_mechanism = event["server"].get_setting("identity-mechanism", "internal") @@ -107,7 +107,7 @@ class Module(ModuleManager.BaseModule): @Utils.hook("received.command.logout", private_only=True) def logout(self, event): """ - Logout from your identified account + :help: Logout from your identified account """ if event["user"].identified_account_override: self._logout(event["user"]) @@ -116,10 +116,12 @@ class Module(ModuleManager.BaseModule): event["stderr"].write("You are not logged in") @Utils.hook("received.command.resetpassword", private_only=True, - min_args=2, usage="<nickname> <password>", permission="resetpassword") + min_args=2) def reset_password(self, event): """ - Reset a given user's password + :help: Reset a given user's password + :usage: <nickname> <password> + :permission: resetpassword """ target = event["server"].get_user(event["args_split"][0]) password = " ".join(event["args_split"][1:]) @@ -135,7 +137,7 @@ class Module(ModuleManager.BaseModule): @Utils.hook("preprocess.command") def preprocess_command(self, event): - permission = event["hook"].kwargs.get("permission", None) + permission = event["hook"].get_kwarg("permission", None) authenticated = event["hook"].kwargs.get("authenticated", False) identity_mechanism = event["server"].get_setting("identity-mechanism", @@ -166,7 +168,7 @@ class Module(ModuleManager.BaseModule): @Utils.hook("received.command.mypermissions", authenticated=True) def my_permissions(self, event): """ - Show your permissions + :help: Show your permissions """ permissions = event["user"].get_setting("permissions", []) event["stdout"].write("Your permissions: %s" % ", ".join(permissions)) @@ -177,11 +179,12 @@ class Module(ModuleManager.BaseModule): permissions = target.get_setting("permissions", []) return [target, registered, permissions] - @Utils.hook("received.command.givepermission", min_args=2, - permission="givepermission") + @Utils.hook("received.command.givepermission", min_args=2) def give_permission(self, event): """ - Give a given permission to a given user + :help: Give a given permission to a given user + :usage: <nickname> <permission> + :permission: givepermission """ permission = event["args_split"][1].lower() target, registered, permissions = self._get_user_details( @@ -199,11 +202,12 @@ class Module(ModuleManager.BaseModule): target.set_setting("permissions", permissions) event["stdout"].write("Gave permission '%s' to %s" % ( permission, target.nickname)) - @Utils.hook("received.command.removepermission", min_args=2, - permission="removepermission") + @Utils.hook("received.command.removepermission", min_args=2) def remove_permission(self, event): """ - Remove a given permission from a given user + :help: Remove a given permission from a given user + :usage: <nickname> <permission> + :permission: removepermission """ permission = event["args_split"][1].lower() target, registered, permissions = self._get_user_details( |
