Administration functionalities #1784

morteza-araby · 2017-01-09T14:13:34Z

1- Get Request to get list of users for administrator
2- Post request to reset password for users
3 - Get Request to get a paginated users With start and limit.
4 - Search users from database and return an array of found users or empty

matrixbot · 2017-01-09T14:13:36Z

Can one of the admins verify this patch?

matrixbot · 2017-01-09T14:13:36Z

Can one of the admins verify this patch?

matrixbot · 2017-01-09T14:13:36Z

Can one of the admins verify this patch?

erikjohnston · 2017-01-19T12:45:58Z

@matrixbot ok to test

erikjohnston · 2017-01-19T12:50:27Z

There's a bunch of PEP8 violations:

synapse/handlers/admin.py:22:1: F401 'operator.attrgetter' imported but unused
synapse/rest/client/v1/admin.py:40:9: F841 local variable 'auth_user' is assigned to but never used
synapse/rest/client/v1/admin.py:57:1: E302 expected 2 blank lines, found 1
synapse/rest/client/v1/admin.py:159:1: E302 expected 2 blank lines, found 1
synapse/rest/client/v1/admin.py:190:1: E302 expected 2 blank lines, found 1
synapse/rest/client/v1/admin.py:204:9: F841 local variable 'auth_user' is assigned to but never used
synapse/rest/client/v1/admin.py:253:1: E302 expected 2 blank lines, found 1
synapse/rest/client/v1/admin.py:290:1: E302 expected 2 blank lines, found 1
synapse/storage/_base.py:931:37: E128 continuation line under-indented for visual indent
synapse/storage/_base.py:951:91: E501 line too long (92 > 90 characters)
synapse/storage/_base.py:953:91: E501 line too long (93 > 90 characters)
synapse/storage/_base.py:973:91: E501 line too long (92 > 90 characters)
synapse/storage/_base.py:1039:1: E303 too many blank lines (3)

You should be able to test locally by installing flake8 and then running flake8 synapse/

erikjohnston

This broadly looks good. If you can just add some docstring to:

the functions in the handler and storage
the classes in the rest layer explaining what they do

erikjohnston · 2017-01-19T12:54:18Z

synapse/rest/client/v1/admin.py

+            raise SynapseError(400, "Missing 'limit' arg")
+        if not start:
+            raise SynapseError(400, "Missing 'start' arg")
+        logger.info("limit: %s, start: %s", limit, start)


This should probably be debug level logging.

erikjohnston · 2017-01-19T12:54:22Z

synapse/rest/client/v1/admin.py

+            raise SynapseError(400, "Missing 'limit' arg")
+        if not start:
+            raise SynapseError(400, "Missing 'start' arg")
+        logger.info("limit: %s, start: %s", limit, start)


This should probably be debug level logging.

erikjohnston · 2017-01-19T12:54:31Z

synapse/rest/client/v1/admin.py

+        if not term:
+            raise SynapseError(400, "Missing 'term' arg")
+
+        logger.info("term: %s ", term)


This should probably be debug level logging.

erikjohnston · 2017-01-19T12:54:51Z

synapse/storage/__init__.py

@@ -284,6 +284,48 @@ def get_user_ip_and_agents(self, user):
            desc="get_user_ip_and_agents",
        )

+    def get_users(self, user):


Why does this take a user param?

erikjohnston · 2017-01-19T12:56:18Z

synapse/handlers/admin.py

+    def get_users_paginate(self, user, start, limit):
+        ret = yield self.store.get_users_paginate(user, start, limit)
+
+        defer.returnValue(ret)


These functions can simply be rewritten as:

def get_users_paginate(self, user, start, limit): return self.store.get_users_paginate(user, start, limit)

erikjohnston · 2017-01-19T13:31:04Z

scripts-dev/add_admin.py

+    url = 'http://localhost:8008/_matrix/client/api/v1/register'
+    post_data = {'user': 'admin',
+                 'password': 'admin123',
+                 'type': 'm.login.password'}


I'm a bit hesitant to add example scripts like this, as they can't directly be run. I believe the register_new_user script actually has an option to specify the new user is an admin or not.

Hi,
Made a new commit.
1- Fix all error from flake8
2- add docstring to all the new methods
3 - Used _simple_select_list_paginate as private method which is more generic to use for other list search as well and used get_user_list_paginate for calling from rest api

erikjohnston · 2017-01-19T13:32:34Z

(The sytest dendron failure is probably spurious, ignore it)

morteza-araby · 2017-01-21T14:59:21Z

Hi, Made a new commit. 1- Fix all error from flake8 2- add docstring to all the new methods 3 - Used _simple_select_list_paginate as private method which is more generic to use for other list search as well and used get_user_list_paginate for calling from rest api

…

On Thu, Jan 19, 2017 at 2:32 PM, Erik Johnston ***@***.***> wrote: (The sytest dendron failure is probably spurious, ignore it) — You are receiving this because you authored the thread. Reply to this email directly, view it on GitHub <#1784 (comment)>, or mute the thread <https://github.com/notifications/unsubscribe-auth/ANONn-rSvU8bqpnebpQm95arJqxux77Vks5rT2XzgaJpZM4LeTG4> .

administrators can now: - Set displayname of users - Update user avatars - Search for users by user_id - Browse all users in a paginated API - Reset user passwords - Deactivate users Helpers for doing paginated queries has also been added to storage Signed-off-by: Morteza Araby <morteza.araby@ericsson.com>

Changes in synapse v0.19.3-rc1 (2017-03-08) =========================================== Features: * Add some administration functionalities. Thanks to morteza-araby! (PR #1784) Changes: * Reduce database table sizes (PR #1873, #1916, #1923, #1963) * Update contrib/ to not use syutil. Thanks to andrewshadura! (PR #1907) * Don't fetch current state when sending an event in common case (PR #1955) Bug fixes: * Fix synapse_port_db failure. Thanks to Pneumaticat! (PR #1904) * Fix caching to not cache error responses (PR #1913) * Fix APIs to make kick & ban reasons work (PR #1917) * Fix bugs in the /keys/changes api (PR #1921) * Fix bug where users couldn't forget rooms they were banned from (PR #1922) * Fix issue with long language values in pushers API (PR #1925) * Fix a race in transaction queue (PR #1930) * Fix dynamic thumbnailing to preserve aspect ratio. Thanks to jkolo! (PR #1945) * Fix device list update to not constantly resync (PR #1964) * Fix potential for huge memory usage when getting device that have changed (PR #1969)

richvdh · 2017-03-22T07:30:15Z

It'd be nice if someone could write something in https://github.com/matrix-org/synapse/tree/master/docs/admin_api about this.

jcgruenhage · 2017-03-22T10:39:20Z

Also, it would be great if the swagger ui supported this.

richvdh · 2017-03-22T11:02:56Z

The swagger spec is limited to the client-server API. These APIs are synapse-specific.

Of course, you could give them a swagger UI, but it wouldn't be appropriate to include them in the current one.

jcgruenhage · 2017-03-22T14:13:10Z

It would probably be more appropriate to write a little synapse admin client instead
(Or maybe even a web interface for those :D)

richvdh · 2017-04-20T19:34:52Z

synapse/rest/client/v1/admin.py

@@ -25,6 +26,34 @@
 logger = logging.getLogger(__name__)


+class UsersRestServlet(ClientV1RestServlet):
+    PATTERNS = client_path_patterns("/admin/users/(?P<user_id>[^/]*)")


is my understanding correct? this takes a user_id, and then ignores it? @morteza-araby

you are right, I must have missed that. The UsersRest Api, has not been used at my client side implementation and I think that's why I've missed all of your comments here. Probably should have wrote some test cases.

This is now tracked as #2522

richvdh · 2017-04-20T19:35:10Z

synapse/rest/client/v1/admin.py

+        #     raise AuthError(403, "You are not a server admin")
+
+        if not self.hs.is_mine(target_user):
+            raise SynapseError(400, "Can only users a local user")


this error makes no sense

you are right.

richvdh · 2017-04-20T19:36:35Z

synapse/rest/client/v1/admin.py

+        if not new_password:
+            raise SynapseError(400, "Missing 'new_password' arg")
+
+        logger.info("new_password: %r", new_password)


we really shouldn't log passwords at info.

should be removed.

yes it should...

this finally got fixed by #4965

I haven't (yet) documented all of the user-list APIs introduced in #1784 because the API shape seems very odd, given the functionality.

erikjohnston reviewed Jan 19, 2017

View reviewed changes

morteza-araby force-pushed the user-admin branch from 01bbbcd to 8f98f3f Compare January 21, 2017 17:45

morteza-araby force-pushed the user-admin branch from a5b95b8 to 5ebeda6 Compare February 2, 2017 12:57

morteza-araby changed the base branch from master to develop February 2, 2017 12:58

morteza-araby force-pushed the user-admin branch from 5ebeda6 to 8324176 Compare February 2, 2017 13:00

morteza-araby force-pushed the user-admin branch from 8324176 to 2849d3f Compare February 2, 2017 13:02

erikjohnston merged commit af6da6d into matrix-org:develop Feb 6, 2017

richvdh reviewed Apr 20, 2017

View reviewed changes

richvdh added a commit that referenced this pull request Apr 20, 2017

Document some of the admin APIs

8bbf154

I haven't (yet) documented all of the user-list APIs introduced in #1784 because the API shape seems very odd, given the functionality.

richvdh mentioned this pull request Apr 20, 2017

Document some of the admin APIs #2143

Merged

richvdh added a commit that referenced this pull request Apr 21, 2017

Document some of the admin APIs (#2143)

cea7839

I haven't (yet) documented all of the user-list APIs introduced in #1784 because the API shape seems very odd, given the functionality.

richvdh mentioned this pull request Oct 10, 2017

<user id> should be removed from /admin/users/<user id> and /admin/users_paginate/<user id> #2522

Closed

richvdh mentioned this pull request Aug 8, 2018

/admin/users_paginate/ doesn't work on postgres #3666

Closed

richvdh mentioned this pull request Jun 19, 2019

/admin/users_paginate is pointless and should be merged into /admin/users #5494

Closed

richvdh mentioned this pull request Dec 4, 2019

Replace /admin/v1/users_paginate endpoint with /admin/v2/users #5925

Merged

3 tasks

richvdh mentioned this pull request Aug 26, 2020

Convert additional database methods to async (select list, search, insert_many, delete_*) #8168

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Administration functionalities #1784

Administration functionalities #1784

morteza-araby commented Jan 9, 2017

matrixbot commented Jan 9, 2017

matrixbot commented Jan 9, 2017

matrixbot commented Jan 9, 2017

erikjohnston commented Jan 19, 2017

erikjohnston commented Jan 19, 2017

erikjohnston left a comment

erikjohnston Jan 19, 2017

erikjohnston Jan 19, 2017

erikjohnston Jan 19, 2017

erikjohnston Jan 19, 2017

erikjohnston Jan 19, 2017

erikjohnston Jan 19, 2017

morteza-araby Jan 21, 2017

erikjohnston commented Jan 19, 2017

morteza-araby commented Jan 21, 2017 via email

richvdh commented Mar 22, 2017

jcgruenhage commented Mar 22, 2017

richvdh commented Mar 22, 2017

jcgruenhage commented Mar 22, 2017

richvdh Apr 20, 2017

morteza-araby Apr 21, 2017

richvdh Oct 10, 2017

richvdh Apr 20, 2017

morteza-araby Apr 21, 2017

richvdh Apr 20, 2017

morteza-araby Apr 21, 2017

richvdh Oct 10, 2017

richvdh Jun 19, 2019

Administration functionalities #1784

Administration functionalities #1784

Conversation

morteza-araby commented Jan 9, 2017

matrixbot commented Jan 9, 2017

matrixbot commented Jan 9, 2017

matrixbot commented Jan 9, 2017

erikjohnston commented Jan 19, 2017

erikjohnston commented Jan 19, 2017

erikjohnston left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

erikjohnston commented Jan 19, 2017

morteza-araby commented Jan 21, 2017 via email

richvdh commented Mar 22, 2017

jcgruenhage commented Mar 22, 2017

richvdh commented Mar 22, 2017

jcgruenhage commented Mar 22, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment