Shadow-ban command

.gitignore

@@ -6,3 +6,4 @@ dist
 doc/build
 __pycache__
 .vscode/
+env/

README.md

@@ -234,7 +234,7 @@ python3 setup.py install
   * [x] `user password <user id>`
   * [x] `user membership <user id>`
   * [x] `user whois <user id>`
-  * [ ] `user shadow_ban <user id>`
+  * [x] `user shadow_ban <user id>`
   * [x] `user media -u <user id>` (also available as `media list -u <user id>`)
   * [x] `user login <user id>`
   * [ ] Additional commands and aliases around user management

synadm/api.py

@@ -1063,3 +1063,16 @@ def regtok_delete(self, token):
 
         """
         return self.query("delete", f"v1/registration_tokens/{token}")
+
+    def user_shadow_ban(self, user_id, unban):
+        """ Shadow-ban or unban a user.
+
+        Args:
+            user_id (string): The user to be banned/unbanned.
+            unban (boolean): Unban the specified user.
+        """
+        if unban:
+            method = "delete"
+        else:
+            method = "post"
+        return self.query(method, f"v1/users/{user_id}/shadow_ban")

synadm/cli/user.py

@@ -554,3 +554,34 @@ def user_login_cmd(helper, user_id, expire_days, expire, expire_ts,
             raise SystemExit(1)
         else:
             helper.output(user_login)
+
+@user.command(name="shadow-ban")
+@click.argument("user_id", type=str)
+@click.option(
+    "-u", "--unban", is_flag=True, default=False, show_default=False,
+    help="Unban the specified user"
+)
+@click.pass_obj
+def user_shadow_ban(helper, user_id, unban):
+    """Shadow-ban or unban a user.
+
+    Useful for moderating malicious or egregiously abusive users.
+
+    A shadow-banned user will not receive any notification, but still will be
+    unable to contact anyone on the server. Use this as a tool of last resort
+    since it may lead to confusing or broken behaviour for the client.
+
+    Generally, it is more appropriate to ban or kick abusive users.
+    """
+    user_ban = helper.api.user_shadow_ban(user_id, unban)
+    if user_ban is None:
+        click.echo("Failed to shadow-ban: {}".format(user_id))
+        raise SystemExit(1)
+    if helper.output_format == "human":
+        if user_ban:
+            click.echo("Failed to shadow-ban the user: {}".format(user_id))
+            helper.output(user_ban)
+        else:
+            click.echo("Successfully shadow-banned user: {}".format(user_id))
+    else:
+        helper.output(user_ban)