2019-01-25 06:16:29 -05:00
|
|
|
# Copyright 2019 New Vector
|
|
|
|
#
|
|
|
|
# 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.
|
2019-01-29 10:58:37 -05:00
|
|
|
import logging
|
2021-03-16 11:44:25 -04:00
|
|
|
from typing import TYPE_CHECKING, Tuple
|
2019-01-29 10:58:37 -05:00
|
|
|
|
2019-05-23 10:00:20 -04:00
|
|
|
from synapse.api.room_versions import KNOWN_ROOM_VERSIONS
|
2019-01-25 06:16:29 -05:00
|
|
|
from synapse.http.servlet import RestServlet
|
2021-03-16 11:44:25 -04:00
|
|
|
from synapse.http.site import SynapseRequest
|
|
|
|
from synapse.types import JsonDict
|
2019-01-25 06:16:29 -05:00
|
|
|
|
2019-06-03 07:28:59 -04:00
|
|
|
from ._base import client_patterns
|
2019-01-25 06:16:29 -05:00
|
|
|
|
2021-03-16 11:44:25 -04:00
|
|
|
if TYPE_CHECKING:
|
|
|
|
from synapse.server import HomeServer
|
|
|
|
|
2019-01-29 10:58:37 -05:00
|
|
|
logger = logging.getLogger(__name__)
|
|
|
|
|
2019-01-25 06:16:29 -05:00
|
|
|
|
|
|
|
class CapabilitiesRestServlet(RestServlet):
|
2019-01-29 10:58:37 -05:00
|
|
|
"""End point to expose the capabilities of the server."""
|
|
|
|
|
2019-06-03 07:28:59 -04:00
|
|
|
PATTERNS = client_patterns("/capabilities$")
|
2019-01-25 06:16:29 -05:00
|
|
|
|
2021-03-16 11:44:25 -04:00
|
|
|
def __init__(self, hs: "HomeServer"):
|
2020-09-18 09:56:44 -04:00
|
|
|
super().__init__()
|
2019-01-25 06:16:29 -05:00
|
|
|
self.hs = hs
|
2019-05-23 10:00:20 -04:00
|
|
|
self.config = hs.config
|
2019-01-29 06:37:56 -05:00
|
|
|
self.auth = hs.get_auth()
|
2021-03-16 11:44:25 -04:00
|
|
|
self.auth_handler = hs.get_auth_handler()
|
2019-01-25 06:16:29 -05:00
|
|
|
|
2021-03-16 11:44:25 -04:00
|
|
|
async def on_GET(self, request: SynapseRequest) -> Tuple[int, JsonDict]:
|
|
|
|
await self.auth.get_user_by_req(request, allow_guest=True)
|
|
|
|
change_password = self.auth_handler.can_change_password()
|
2019-01-29 06:37:56 -05:00
|
|
|
|
2019-01-30 05:23:26 -05:00
|
|
|
response = {
|
|
|
|
"capabilities": {
|
|
|
|
"m.room_versions": {
|
2019-05-23 10:00:20 -04:00
|
|
|
"default": self.config.default_room_version.identifier,
|
2019-01-30 05:23:26 -05:00
|
|
|
"available": {
|
2019-04-01 05:24:38 -04:00
|
|
|
v.identifier: v.disposition
|
|
|
|
for v in KNOWN_ROOM_VERSIONS.values()
|
2019-01-29 13:04:56 -05:00
|
|
|
},
|
2019-01-30 05:23:26 -05:00
|
|
|
},
|
|
|
|
"m.change_password": {"enabled": change_password},
|
|
|
|
}
|
|
|
|
}
|
2019-08-30 11:28:26 -04:00
|
|
|
return 200, response
|
2019-01-25 06:16:29 -05:00
|
|
|
|
|
|
|
|
2021-03-16 11:44:25 -04:00
|
|
|
def register_servlets(hs: "HomeServer", http_server):
|
2019-01-25 06:16:29 -05:00
|
|
|
CapabilitiesRestServlet(hs).register(http_server)
|