mirror of
https://mau.dev/maunium/synapse.git
synced 2024-10-01 01:36:05 -04:00
90 lines
2.8 KiB
Python
90 lines
2.8 KiB
Python
#
|
|
# This file is licensed under the Affero General Public License (AGPL) version 3.
|
|
#
|
|
# Copyright (C) 2023 New Vector, Ltd
|
|
#
|
|
# This program is free software: you can redistribute it and/or modify
|
|
# it under the terms of the GNU Affero General Public License as
|
|
# published by the Free Software Foundation, either version 3 of the
|
|
# License, or (at your option) any later version.
|
|
#
|
|
# See the GNU Affero General Public License for more details:
|
|
# <https://www.gnu.org/licenses/agpl-3.0.html>.
|
|
#
|
|
# Originally licensed under the Apache License, Version 2.0:
|
|
# <http://www.apache.org/licenses/LICENSE-2.0>.
|
|
#
|
|
# [This file includes modifications made by New Vector Limited]
|
|
#
|
|
#
|
|
|
|
import logging
|
|
from typing import TYPE_CHECKING, Tuple
|
|
|
|
from synapse.api.errors import SynapseError
|
|
from synapse.http.server import HttpServer
|
|
from synapse.http.servlet import RestServlet, parse_json_object_from_request
|
|
from synapse.http.site import SynapseRequest
|
|
from synapse.types import JsonMapping
|
|
|
|
from ._base import client_patterns
|
|
|
|
if TYPE_CHECKING:
|
|
from synapse.server import HomeServer
|
|
|
|
logger = logging.getLogger(__name__)
|
|
|
|
|
|
class UserDirectorySearchRestServlet(RestServlet):
|
|
PATTERNS = client_patterns("/user_directory/search$")
|
|
CATEGORY = "User directory search requests"
|
|
|
|
def __init__(self, hs: "HomeServer"):
|
|
super().__init__()
|
|
self.hs = hs
|
|
self.auth = hs.get_auth()
|
|
self.user_directory_handler = hs.get_user_directory_handler()
|
|
|
|
async def on_POST(self, request: SynapseRequest) -> Tuple[int, JsonMapping]:
|
|
"""Searches for users in directory
|
|
|
|
Returns:
|
|
dict of the form::
|
|
|
|
{
|
|
"limited": <bool>, # whether there were more results or not
|
|
"results": [ # Ordered by best match first
|
|
{
|
|
"user_id": <user_id>,
|
|
"display_name": <display_name>,
|
|
"avatar_url": <avatar_url>
|
|
}
|
|
]
|
|
}
|
|
"""
|
|
requester = await self.auth.get_user_by_req(request, allow_guest=False)
|
|
user_id = requester.user.to_string()
|
|
|
|
if not self.hs.config.userdirectory.user_directory_search_enabled:
|
|
return 200, {"limited": False, "results": []}
|
|
|
|
body = parse_json_object_from_request(request)
|
|
|
|
limit = int(body.get("limit", 10))
|
|
limit = max(min(limit, 50), 0)
|
|
|
|
try:
|
|
search_term = body["search_term"]
|
|
except Exception:
|
|
raise SynapseError(400, "`search_term` is required field")
|
|
|
|
results = await self.user_directory_handler.search_users(
|
|
user_id, search_term, limit
|
|
)
|
|
|
|
return 200, results
|
|
|
|
|
|
def register_servlets(hs: "HomeServer", http_server: HttpServer) -> None:
|
|
UserDirectorySearchRestServlet(hs).register(http_server)
|