2016-01-06 23:26:29 -05:00
|
|
|
# Copyright 2014-2016 OpenMarket Ltd
|
2014-08-12 10:10:52 -04:00
|
|
|
#
|
|
|
|
# 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.
|
|
|
|
|
2018-07-09 02:09:20 -04:00
|
|
|
import logging
|
2022-10-17 08:39:12 -04:00
|
|
|
from typing import TYPE_CHECKING, List, Optional, Tuple
|
|
|
|
|
2023-09-25 11:19:08 -04:00
|
|
|
from synapse._pydantic_compat import HAS_PYDANTIC_V2
|
|
|
|
|
|
|
|
if TYPE_CHECKING or HAS_PYDANTIC_V2:
|
|
|
|
from pydantic.v1 import StrictStr
|
|
|
|
else:
|
|
|
|
from pydantic import StrictStr
|
|
|
|
|
2022-10-17 08:39:12 -04:00
|
|
|
from typing_extensions import Literal
|
2021-08-23 08:14:17 -04:00
|
|
|
|
|
|
|
from twisted.web.server import Request
|
2018-07-09 02:09:20 -04:00
|
|
|
|
2022-06-17 07:19:22 -04:00
|
|
|
from synapse.api.errors import AuthError, Codes, NotFoundError, SynapseError
|
2021-08-23 08:14:17 -04:00
|
|
|
from synapse.http.server import HttpServer
|
2022-10-17 08:39:12 -04:00
|
|
|
from synapse.http.servlet import (
|
|
|
|
RestServlet,
|
|
|
|
parse_and_validate_json_object_from_request,
|
|
|
|
)
|
2021-08-23 08:14:17 -04:00
|
|
|
from synapse.http.site import SynapseRequest
|
2021-08-17 07:57:58 -04:00
|
|
|
from synapse.rest.client._base import client_patterns
|
2022-10-17 08:39:12 -04:00
|
|
|
from synapse.rest.models import RequestBodyModel
|
2021-08-23 08:14:17 -04:00
|
|
|
from synapse.types import JsonDict, RoomAlias
|
|
|
|
|
|
|
|
if TYPE_CHECKING:
|
|
|
|
from synapse.server import HomeServer
|
2016-03-09 06:26:26 -05:00
|
|
|
|
2014-08-12 10:10:52 -04:00
|
|
|
logger = logging.getLogger(__name__)
|
|
|
|
|
|
|
|
|
2021-08-23 08:14:17 -04:00
|
|
|
def register_servlets(hs: "HomeServer", http_server: HttpServer) -> None:
|
2014-08-12 10:10:52 -04:00
|
|
|
ClientDirectoryServer(hs).register(http_server)
|
2023-04-14 05:24:06 -04:00
|
|
|
if hs.config.worker.worker_app is None:
|
|
|
|
ClientDirectoryListServer(hs).register(http_server)
|
|
|
|
ClientAppserviceDirectoryListServer(hs).register(http_server)
|
2014-08-12 10:10:52 -04:00
|
|
|
|
|
|
|
|
2019-06-03 07:28:59 -04:00
|
|
|
class ClientDirectoryServer(RestServlet):
|
|
|
|
PATTERNS = client_patterns("/directory/room/(?P<room_alias>[^/]*)$", v1=True)
|
2023-04-14 05:24:06 -04:00
|
|
|
CATEGORY = "Client API requests"
|
2014-08-12 10:10:52 -04:00
|
|
|
|
2021-08-23 08:14:17 -04:00
|
|
|
def __init__(self, hs: "HomeServer"):
|
2020-09-18 09:56:44 -04:00
|
|
|
super().__init__()
|
2022-02-23 06:04:02 -05:00
|
|
|
self.store = hs.get_datastores().main
|
2020-10-09 07:24:34 -04:00
|
|
|
self.directory_handler = hs.get_directory_handler()
|
2019-06-03 07:28:59 -04:00
|
|
|
self.auth = hs.get_auth()
|
2016-08-12 05:03:19 -04:00
|
|
|
|
2021-08-23 08:14:17 -04:00
|
|
|
async def on_GET(self, request: Request, room_alias: str) -> Tuple[int, JsonDict]:
|
2022-06-22 10:32:18 -04:00
|
|
|
if not RoomAlias.is_valid(room_alias):
|
|
|
|
raise SynapseError(400, "Room alias invalid", errcode=Codes.INVALID_PARAM)
|
2021-08-23 08:14:17 -04:00
|
|
|
room_alias_obj = RoomAlias.from_string(room_alias)
|
2014-08-12 10:10:52 -04:00
|
|
|
|
2021-08-23 08:14:17 -04:00
|
|
|
res = await self.directory_handler.get_association(room_alias_obj)
|
2014-08-12 10:10:52 -04:00
|
|
|
|
2019-08-30 11:28:26 -04:00
|
|
|
return 200, res
|
2014-08-12 10:10:52 -04:00
|
|
|
|
2022-10-17 08:39:12 -04:00
|
|
|
class PutBody(RequestBodyModel):
|
|
|
|
# TODO: get Pydantic to validate that this is a valid room id?
|
|
|
|
room_id: StrictStr
|
|
|
|
# `servers` is unspecced
|
|
|
|
servers: Optional[List[StrictStr]] = None
|
|
|
|
|
2021-08-23 08:14:17 -04:00
|
|
|
async def on_PUT(
|
|
|
|
self, request: SynapseRequest, room_alias: str
|
|
|
|
) -> Tuple[int, JsonDict]:
|
2022-06-22 10:32:18 -04:00
|
|
|
if not RoomAlias.is_valid(room_alias):
|
|
|
|
raise SynapseError(400, "Room alias invalid", errcode=Codes.INVALID_PARAM)
|
2021-08-23 08:14:17 -04:00
|
|
|
room_alias_obj = RoomAlias.from_string(room_alias)
|
2018-07-13 15:40:14 -04:00
|
|
|
|
2022-10-17 08:39:12 -04:00
|
|
|
content = parse_and_validate_json_object_from_request(request, self.PutBody)
|
2014-08-12 10:10:52 -04:00
|
|
|
|
|
|
|
logger.debug("Got content: %s", content)
|
2021-08-23 08:14:17 -04:00
|
|
|
logger.debug("Got room name: %s", room_alias_obj.to_string())
|
2014-08-12 10:10:52 -04:00
|
|
|
|
2022-10-17 08:39:12 -04:00
|
|
|
logger.debug("Got room_id: %s", content.room_id)
|
|
|
|
logger.debug("Got servers: %s", content.servers)
|
2014-08-12 10:10:52 -04:00
|
|
|
|
2022-10-17 08:39:12 -04:00
|
|
|
room = await self.store.get_room(content.room_id)
|
2017-04-14 14:12:42 -04:00
|
|
|
if room is None:
|
|
|
|
raise SynapseError(400, "Room does not exist")
|
2014-08-12 10:10:52 -04:00
|
|
|
|
2019-12-05 10:53:06 -05:00
|
|
|
requester = await self.auth.get_user_by_req(request)
|
2014-08-12 10:10:52 -04:00
|
|
|
|
2020-10-09 07:24:34 -04:00
|
|
|
await self.directory_handler.create_association(
|
2022-10-17 08:39:12 -04:00
|
|
|
requester, room_alias_obj, content.room_id, content.servers
|
2018-10-18 11:14:24 -04:00
|
|
|
)
|
2014-08-12 10:10:52 -04:00
|
|
|
|
2019-08-30 11:28:26 -04:00
|
|
|
return 200, {}
|
2014-09-03 11:27:01 -04:00
|
|
|
|
2021-08-23 08:14:17 -04:00
|
|
|
async def on_DELETE(
|
|
|
|
self, request: SynapseRequest, room_alias: str
|
|
|
|
) -> Tuple[int, JsonDict]:
|
2022-06-22 10:32:18 -04:00
|
|
|
if not RoomAlias.is_valid(room_alias):
|
|
|
|
raise SynapseError(400, "Room alias invalid", errcode=Codes.INVALID_PARAM)
|
2021-08-23 08:14:17 -04:00
|
|
|
room_alias_obj = RoomAlias.from_string(room_alias)
|
2022-06-17 07:19:22 -04:00
|
|
|
requester = await self.auth.get_user_by_req(request)
|
2021-08-23 08:14:17 -04:00
|
|
|
|
2022-06-17 07:19:22 -04:00
|
|
|
if requester.app_service:
|
2020-10-09 07:24:34 -04:00
|
|
|
await self.directory_handler.delete_appservice_association(
|
2022-06-17 07:19:22 -04:00
|
|
|
requester.app_service, room_alias_obj
|
2020-10-09 07:24:34 -04:00
|
|
|
)
|
2022-06-17 07:19:22 -04:00
|
|
|
|
2015-02-06 06:32:07 -05:00
|
|
|
logger.info(
|
|
|
|
"Application service at %s deleted alias %s",
|
2022-06-17 07:19:22 -04:00
|
|
|
requester.app_service.url,
|
2021-08-23 08:14:17 -04:00
|
|
|
room_alias_obj.to_string(),
|
2015-02-06 06:32:07 -05:00
|
|
|
)
|
2014-09-30 06:31:22 -04:00
|
|
|
|
2022-06-17 07:19:22 -04:00
|
|
|
else:
|
|
|
|
await self.directory_handler.delete_association(requester, room_alias_obj)
|
2016-03-17 07:09:03 -04:00
|
|
|
|
2022-06-17 07:19:22 -04:00
|
|
|
logger.info(
|
|
|
|
"User %s deleted alias %s",
|
|
|
|
requester.user.to_string(),
|
|
|
|
room_alias_obj.to_string(),
|
|
|
|
)
|
2014-09-30 06:31:22 -04:00
|
|
|
|
2019-08-30 11:28:26 -04:00
|
|
|
return 200, {}
|
2016-03-21 10:03:20 -04:00
|
|
|
|
|
|
|
|
2019-06-03 07:28:59 -04:00
|
|
|
class ClientDirectoryListServer(RestServlet):
|
|
|
|
PATTERNS = client_patterns("/directory/list/room/(?P<room_id>[^/]*)$", v1=True)
|
2016-03-21 10:03:20 -04:00
|
|
|
|
2021-08-23 08:14:17 -04:00
|
|
|
def __init__(self, hs: "HomeServer"):
|
2020-09-18 09:56:44 -04:00
|
|
|
super().__init__()
|
2022-02-23 06:04:02 -05:00
|
|
|
self.store = hs.get_datastores().main
|
2020-10-09 07:24:34 -04:00
|
|
|
self.directory_handler = hs.get_directory_handler()
|
2019-06-03 07:28:59 -04:00
|
|
|
self.auth = hs.get_auth()
|
2016-03-21 10:03:20 -04:00
|
|
|
|
2021-08-23 08:14:17 -04:00
|
|
|
async def on_GET(self, request: Request, room_id: str) -> Tuple[int, JsonDict]:
|
2019-12-05 10:53:06 -05:00
|
|
|
room = await self.store.get_room(room_id)
|
2016-03-21 10:03:20 -04:00
|
|
|
if room is None:
|
2018-07-27 09:19:38 -04:00
|
|
|
raise NotFoundError("Unknown room")
|
2016-03-21 10:03:20 -04:00
|
|
|
|
2019-08-30 11:28:26 -04:00
|
|
|
return 200, {"visibility": "public" if room["is_public"] else "private"}
|
2016-03-21 10:03:20 -04:00
|
|
|
|
2022-10-17 08:39:12 -04:00
|
|
|
class PutBody(RequestBodyModel):
|
|
|
|
visibility: Literal["public", "private"] = "public"
|
|
|
|
|
2021-08-23 08:14:17 -04:00
|
|
|
async def on_PUT(
|
|
|
|
self, request: SynapseRequest, room_id: str
|
|
|
|
) -> Tuple[int, JsonDict]:
|
2019-12-05 10:53:06 -05:00
|
|
|
requester = await self.auth.get_user_by_req(request)
|
2016-03-21 10:03:20 -04:00
|
|
|
|
2022-10-17 08:39:12 -04:00
|
|
|
content = parse_and_validate_json_object_from_request(request, self.PutBody)
|
2016-03-21 10:03:20 -04:00
|
|
|
|
2020-10-09 07:24:34 -04:00
|
|
|
await self.directory_handler.edit_published_room_list(
|
2022-10-17 08:39:12 -04:00
|
|
|
requester, room_id, content.visibility
|
2016-03-21 10:03:20 -04:00
|
|
|
)
|
|
|
|
|
2019-08-30 11:28:26 -04:00
|
|
|
return 200, {}
|
2016-03-21 10:03:20 -04:00
|
|
|
|
2016-12-06 05:43:48 -05:00
|
|
|
|
2019-06-03 07:28:59 -04:00
|
|
|
class ClientAppserviceDirectoryListServer(RestServlet):
|
|
|
|
PATTERNS = client_patterns(
|
|
|
|
"/directory/list/appservice/(?P<network_id>[^/]*)/(?P<room_id>[^/]*)$", v1=True
|
2016-12-06 05:43:48 -05:00
|
|
|
)
|
|
|
|
|
2021-08-23 08:14:17 -04:00
|
|
|
def __init__(self, hs: "HomeServer"):
|
2020-09-18 09:56:44 -04:00
|
|
|
super().__init__()
|
2022-02-23 06:04:02 -05:00
|
|
|
self.store = hs.get_datastores().main
|
2020-10-09 07:24:34 -04:00
|
|
|
self.directory_handler = hs.get_directory_handler()
|
2019-06-03 07:28:59 -04:00
|
|
|
self.auth = hs.get_auth()
|
2016-12-06 05:43:48 -05:00
|
|
|
|
2022-10-17 08:39:12 -04:00
|
|
|
class PutBody(RequestBodyModel):
|
|
|
|
visibility: Literal["public", "private"] = "public"
|
|
|
|
|
2021-08-23 08:14:17 -04:00
|
|
|
async def on_PUT(
|
|
|
|
self, request: SynapseRequest, network_id: str, room_id: str
|
|
|
|
) -> Tuple[int, JsonDict]:
|
2022-10-17 08:39:12 -04:00
|
|
|
content = parse_and_validate_json_object_from_request(request, self.PutBody)
|
|
|
|
return await self._edit(request, network_id, room_id, content.visibility)
|
2016-12-06 05:43:48 -05:00
|
|
|
|
2021-08-23 08:14:17 -04:00
|
|
|
async def on_DELETE(
|
|
|
|
self, request: SynapseRequest, network_id: str, room_id: str
|
|
|
|
) -> Tuple[int, JsonDict]:
|
|
|
|
return await self._edit(request, network_id, room_id, "private")
|
2016-12-06 05:43:48 -05:00
|
|
|
|
2021-08-23 08:14:17 -04:00
|
|
|
async def _edit(
|
2022-10-17 08:39:12 -04:00
|
|
|
self,
|
|
|
|
request: SynapseRequest,
|
|
|
|
network_id: str,
|
|
|
|
room_id: str,
|
|
|
|
visibility: Literal["public", "private"],
|
2021-08-23 08:14:17 -04:00
|
|
|
) -> Tuple[int, JsonDict]:
|
2019-12-05 10:53:06 -05:00
|
|
|
requester = await self.auth.get_user_by_req(request)
|
2016-12-06 05:43:48 -05:00
|
|
|
if not requester.app_service:
|
|
|
|
raise AuthError(
|
|
|
|
403, "Only appservices can edit the appservice published room list"
|
|
|
|
)
|
|
|
|
|
2020-10-09 07:24:34 -04:00
|
|
|
await self.directory_handler.edit_published_appservice_room_list(
|
2019-06-20 05:32:02 -04:00
|
|
|
requester.app_service.id, network_id, room_id, visibility
|
2016-12-06 05:43:48 -05:00
|
|
|
)
|
|
|
|
|
2019-08-30 11:28:26 -04:00
|
|
|
return 200, {}
|