mirror of
https://git.anonymousland.org/anonymousland/synapse.git
synced 2024-12-13 19:34:22 -05:00
c3e4edb4d6
Stabilize the threads API (MSC3856) by supporting (only) the v1 path for the endpoint. This also marks the API as safe for workers since it is a read-only API.
126 lines
4.2 KiB
Python
126 lines
4.2 KiB
Python
# Copyright 2019 New Vector Ltd
|
|
#
|
|
# Licensed under the Apache License, Version 2.0 (the "License");
|
|
# you may not use this file except in compliance with the License.
|
|
# You may obtain a copy of the License at
|
|
#
|
|
# http://www.apache.org/licenses/LICENSE-2.0
|
|
#
|
|
# Unless required by applicable law or agreed to in writing, software
|
|
# distributed under the License is distributed on an "AS IS" BASIS,
|
|
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
# See the License for the specific language governing permissions and
|
|
# limitations under the License.
|
|
|
|
import logging
|
|
import re
|
|
from typing import TYPE_CHECKING, Optional, Tuple
|
|
|
|
from synapse.handlers.relations import ThreadsListInclude
|
|
from synapse.http.server import HttpServer
|
|
from synapse.http.servlet import RestServlet, parse_integer, parse_string
|
|
from synapse.http.site import SynapseRequest
|
|
from synapse.rest.client._base import client_patterns
|
|
from synapse.storage.databases.main.relations import ThreadsNextBatch
|
|
from synapse.streams.config import PaginationConfig
|
|
from synapse.types import JsonDict
|
|
|
|
if TYPE_CHECKING:
|
|
from synapse.server import HomeServer
|
|
|
|
logger = logging.getLogger(__name__)
|
|
|
|
|
|
class RelationPaginationServlet(RestServlet):
|
|
"""API to paginate relations on an event by topological ordering, optionally
|
|
filtered by relation type and event type.
|
|
"""
|
|
|
|
PATTERNS = client_patterns(
|
|
"/rooms/(?P<room_id>[^/]*)/relations/(?P<parent_id>[^/]*)"
|
|
"(/(?P<relation_type>[^/]*)(/(?P<event_type>[^/]*))?)?$",
|
|
releases=("v1",),
|
|
)
|
|
|
|
def __init__(self, hs: "HomeServer"):
|
|
super().__init__()
|
|
self.auth = hs.get_auth()
|
|
self._store = hs.get_datastores().main
|
|
self._relations_handler = hs.get_relations_handler()
|
|
|
|
async def on_GET(
|
|
self,
|
|
request: SynapseRequest,
|
|
room_id: str,
|
|
parent_id: str,
|
|
relation_type: Optional[str] = None,
|
|
event_type: Optional[str] = None,
|
|
) -> Tuple[int, JsonDict]:
|
|
requester = await self.auth.get_user_by_req(request, allow_guest=True)
|
|
|
|
pagination_config = await PaginationConfig.from_request(
|
|
self._store, request, default_limit=5, default_dir="b"
|
|
)
|
|
|
|
# The unstable version of this API returns an extra field for client
|
|
# compatibility, see https://github.com/matrix-org/synapse/issues/12930.
|
|
assert request.path is not None
|
|
include_original_event = request.path.startswith(b"/_matrix/client/unstable/")
|
|
|
|
# Return the relations
|
|
result = await self._relations_handler.get_relations(
|
|
requester=requester,
|
|
event_id=parent_id,
|
|
room_id=room_id,
|
|
pagin_config=pagination_config,
|
|
include_original_event=include_original_event,
|
|
relation_type=relation_type,
|
|
event_type=event_type,
|
|
)
|
|
|
|
return 200, result
|
|
|
|
|
|
class ThreadsServlet(RestServlet):
|
|
PATTERNS = (re.compile("^/_matrix/client/v1/rooms/(?P<room_id>[^/]*)/threads"),)
|
|
|
|
def __init__(self, hs: "HomeServer"):
|
|
super().__init__()
|
|
self.auth = hs.get_auth()
|
|
self.store = hs.get_datastores().main
|
|
self._relations_handler = hs.get_relations_handler()
|
|
|
|
async def on_GET(
|
|
self, request: SynapseRequest, room_id: str
|
|
) -> Tuple[int, JsonDict]:
|
|
requester = await self.auth.get_user_by_req(request)
|
|
|
|
limit = parse_integer(request, "limit", default=5)
|
|
from_token_str = parse_string(request, "from")
|
|
include = parse_string(
|
|
request,
|
|
"include",
|
|
default=ThreadsListInclude.all.value,
|
|
allowed_values=[v.value for v in ThreadsListInclude],
|
|
)
|
|
|
|
# Return the relations
|
|
from_token = None
|
|
if from_token_str:
|
|
from_token = ThreadsNextBatch.from_string(from_token_str)
|
|
|
|
result = await self._relations_handler.get_threads(
|
|
requester=requester,
|
|
room_id=room_id,
|
|
include=ThreadsListInclude(include),
|
|
limit=limit,
|
|
from_token=from_token,
|
|
)
|
|
|
|
return 200, result
|
|
|
|
|
|
def register_servlets(hs: "HomeServer", http_server: HttpServer) -> None:
|
|
RelationPaginationServlet(hs).register(http_server)
|
|
ThreadsServlet(hs).register(http_server)
|