match user list api options to synapse

Fixes: #169

Author: JacksonChen666

synadm/api.py

@@ -454,9 +454,12 @@ def __init__(self, log, user, token, base_url, admin_path, timeout, debug,
         self.user = user
 
     def user_list(self, _from, _limit, _guests, _deactivated,
-                  _name, _user_id, _admin=None):
+                  _name, _user_id, _admin=None, order_by=None, _dir=None,
+                  not_user_type=None, locked=False):
         """List and search users
 
+        https://element-hq.github.io/synapse/latest/admin_api/user_admin_api.html#list-accounts
+
         Args:
             _from (int): offsets user list by this number, used for pagination
             _limit (int): maximum number of users returned, used for pagination
@@ -467,6 +470,19 @@ def user_list(self, _from, _limit, _guests, _deactivated,
             _user_id (string): fully qualified Matrix user ID to search for
             _admin (bool or None): whether to filter for admins. a None
                 does not filter.
+            order_by (string or None): Method of sorting returned users. See
+                Synapse's documentation for valid choices. None uses Synapse
+                defaults. Note that methods other than "name" or
+                "creation_ts" may be slow and cause a major load as they
+                have no database index.
+            _dir (string or None): Direction of sorting. "f" for forwards
+                (default or when None), "b" for backwards/reversed.
+            not_user_type (string or list or None): User type to exclude.
+                Supports list for multiple values. Possible values are
+                "bot", "support", or "" (to exclude users without a user
+                type). Defaults to None for no filtering.
+            locked (bool): Include locked users. Defaults to not
+                including them.
 
         Returns:
             string: JSON string containing the found users
@@ -478,14 +494,19 @@ def user_list(self, _from, _limit, _guests, _deactivated,
                        else None),
             "deactivated": "true" if _deactivated else None,
             "name": _name,
-            "user_id": _user_id
+            "user_id": _user_id,
+            "order_by": order_by,
+            "dir": _dir,
+            "not_user_type": not_user_type,
+            "locked": str(locked).lower()
         }
         if _admin is not None:
             params["admins"] = str(_admin).lower()
         return self.query("get", "v2/users", params=params)
 
-    def user_list_paginate(self, _limit, _guests, _deactivated,
-                           _name, _user_id, _from="0", admin=None):
+    def user_list_paginate(self, _limit, _guests, _deactivated, _name,
+                           _user_id, _from="0", admin=None, order_by=None,
+                           _dir=None, not_user_type=None, locked=False):
         # documentation is mostly duplicated from user_list...
         """Yields API responses for all of the pagination.
 
@@ -500,14 +521,28 @@ def user_list_paginate(self, _limit, _guests, _deactivated,
             _user_id (string): Fully qualified Matrix user ID to search for.
             _from (string): Offsets user list by this number, used for
                 pagination.
+            order_by (string or None): Method of sorting returned users. See
+                Synapse's documentation for valid choices. None uses Synapse
+                defaults. Note that methods other than "name" or
+                "creation_ts" may be slow and cause a major load as they
+                have no database index.
+            _dir (string or None): Direction of sorting. "f" for forwards
+                (default or when None), "b" for backwards/reversed.
+            not_user_type (string or list or None): User type to exclude.
+                Supports list for multiple values. Possible values are
+                "bot", "support", or "" (to exclude users without a user
+                type). Defaults to None for no filtering.
+            locked (bool): Include locked users. Defaults to not
+                including them.
 
         Yields:
             dict: The Admin API response for listing accounts.
                 https://element-hq.github.io/synapse/latest/admin_api/user_admin_api.html#list-accounts
         """
         while _from is not None:
             response = self.user_list(_from, _limit, _guests, _deactivated,
-                                      _name, _user_id, admin)
+                                      _name, _user_id, admin, order_by,
+                                      _dir, not_user_type, locked)
             yield response
             _from = response.get("next_token", None)
 

synadm/cli/user.py

@@ -57,6 +57,21 @@ def user():
     "--admins/--non-admins", "-a/-A", default=None,
     help="""Whether to filter for admins, or non-admins. If not specified,
     no admin filter is applied.""")
+@click.option(
+    "--sort-by", type=str, help="""Method of sorting users. Valid options
+    are name, is_guest, admin, user_type, deactivated, shadow_banned,
+    displayname, avatar_url, creation_ts, and last_seen_ts.""")
+@click.option(
+    "--reverse", is_flag=True, default=False, type=bool, help="""Display
+    items in reverse order, from last to first.""")
+@click.option(
+    "--exclude-user-type", type=str, default=None, multiple=True,
+    help="""Exclude users of specific user types. Can be specified multiple
+    times. Valid values are "bot", "support", or "" (excludes those without
+    user types).""")
+@click.option(
+    "--locked", "-L", type=bool, default=False, is_flag=True,
+    help="""Include locked users in the user list""")
 @optgroup.group(
     "Search options",
     cls=MutuallyExclusiveOptionGroup,
@@ -71,13 +86,15 @@ def user():
     help="""Search users by ID - filters to only return users with Matrix IDs
     (@user:server) that contain this value""")
 @click.pass_obj
-def list_user_cmd(helper, from_, limit, guests, deactivated, name, user_id,
-                  admins):
+def list_user_cmd(helper, from_, limit, guests, deactivated, name, sort_by,
+                  reverse, exclude_user_type, locked, user_id, admins):
     """ List users, search for users.
     """
     mxid = helper.generate_mxid(user_id)
+    _dir = "b" if reverse else None
     users = helper.api.user_list(from_, limit, guests, deactivated, name,
-                                 mxid, admins)
+                                 mxid, admins, sort_by, _dir,
+                                 exclude_user_type, locked)
     if users is None:
         click.echo("Users could not be fetched.")
         raise SystemExit(1)