mirror of
https://git.anonymousland.org/anonymousland/synapse.git
synced 2024-12-26 16:29:24 -05:00
c31c1091d4
This endpoint was removed from MSC2675 before it was approved. It is currently unspecified (even in any MSCs) and therefore subject to removal. It is not implemented by any known clients. This also changes the bundled aggregation format for `m.annotation`, which previously included pagination tokens for the `/aggregations` endpoint, which are no longer useful.
89 lines
3.0 KiB
Python
89 lines
3.0 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
|
|
from typing import TYPE_CHECKING, Optional, Tuple
|
|
|
|
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.types import JsonDict, StreamToken
|
|
|
|
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=(),
|
|
)
|
|
|
|
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)
|
|
|
|
limit = parse_integer(request, "limit", default=5)
|
|
direction = parse_string(
|
|
request, "org.matrix.msc3715.dir", default="b", allowed_values=["f", "b"]
|
|
)
|
|
from_token_str = parse_string(request, "from")
|
|
to_token_str = parse_string(request, "to")
|
|
|
|
# Return the relations
|
|
from_token = None
|
|
if from_token_str:
|
|
from_token = await StreamToken.from_string(self.store, from_token_str)
|
|
to_token = None
|
|
if to_token_str:
|
|
to_token = await StreamToken.from_string(self.store, to_token_str)
|
|
|
|
result = await self._relations_handler.get_relations(
|
|
requester=requester,
|
|
event_id=parent_id,
|
|
room_id=room_id,
|
|
relation_type=relation_type,
|
|
event_type=event_type,
|
|
limit=limit,
|
|
direction=direction,
|
|
from_token=from_token,
|
|
to_token=to_token,
|
|
)
|
|
|
|
return 200, result
|
|
|
|
|
|
def register_servlets(hs: "HomeServer", http_server: HttpServer) -> None:
|
|
RelationPaginationServlet(hs).register(http_server)
|