mirror of
https://git.anonymousland.org/anonymousland/synapse.git
synced 2024-09-07 16:51:59 +00:00
Merge pull request #4472 from matrix-org/neilj/room_capabilities
Server capabilities support
This commit is contained in:
commit
6587b0b89b
1
changelog.d/4472.feature
Normal file
1
changelog.d/4472.feature
Normal file
@ -0,0 +1 @@
|
|||||||
|
Support exposing server capabilities in CS API (MSC1753, MSC1804)
|
@ -108,6 +108,11 @@ class RoomVersions(object):
|
|||||||
STATE_V2_TEST = "state-v2-test"
|
STATE_V2_TEST = "state-v2-test"
|
||||||
|
|
||||||
|
|
||||||
|
class RoomDisposition(object):
|
||||||
|
STABLE = "stable",
|
||||||
|
UNSTABLE = "unstable"
|
||||||
|
|
||||||
|
|
||||||
# the version we will give rooms which are created on this server
|
# the version we will give rooms which are created on this server
|
||||||
DEFAULT_ROOM_VERSION = RoomVersions.V1
|
DEFAULT_ROOM_VERSION = RoomVersions.V1
|
||||||
|
|
||||||
@ -118,6 +123,7 @@ KNOWN_ROOM_VERSIONS = {
|
|||||||
RoomVersions.V2,
|
RoomVersions.V2,
|
||||||
RoomVersions.V3,
|
RoomVersions.V3,
|
||||||
RoomVersions.STATE_V2_TEST,
|
RoomVersions.STATE_V2_TEST,
|
||||||
|
RoomVersions.V3,
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
||||||
|
@ -34,6 +34,7 @@ from synapse.rest.client.v2_alpha import (
|
|||||||
account,
|
account,
|
||||||
account_data,
|
account_data,
|
||||||
auth,
|
auth,
|
||||||
|
capabilities,
|
||||||
devices,
|
devices,
|
||||||
filter,
|
filter,
|
||||||
groups,
|
groups,
|
||||||
@ -107,3 +108,4 @@ class ClientRestResource(JsonResource):
|
|||||||
user_directory.register_servlets(hs, client_resource)
|
user_directory.register_servlets(hs, client_resource)
|
||||||
groups.register_servlets(hs, client_resource)
|
groups.register_servlets(hs, client_resource)
|
||||||
room_upgrade_rest_servlet.register_servlets(hs, client_resource)
|
room_upgrade_rest_servlet.register_servlets(hs, client_resource)
|
||||||
|
capabilities.register_servlets(hs, client_resource)
|
||||||
|
66
synapse/rest/client/v2_alpha/capabilities.py
Normal file
66
synapse/rest/client/v2_alpha/capabilities.py
Normal file
@ -0,0 +1,66 @@
|
|||||||
|
# -*- coding: utf-8 -*-
|
||||||
|
# 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.
|
||||||
|
import logging
|
||||||
|
|
||||||
|
from twisted.internet import defer
|
||||||
|
|
||||||
|
from synapse.api.constants import DEFAULT_ROOM_VERSION, RoomDisposition, RoomVersions
|
||||||
|
from synapse.http.servlet import RestServlet
|
||||||
|
|
||||||
|
from ._base import client_v2_patterns
|
||||||
|
|
||||||
|
logger = logging.getLogger(__name__)
|
||||||
|
|
||||||
|
|
||||||
|
class CapabilitiesRestServlet(RestServlet):
|
||||||
|
"""End point to expose the capabilities of the server."""
|
||||||
|
|
||||||
|
PATTERNS = client_v2_patterns("/capabilities$")
|
||||||
|
|
||||||
|
def __init__(self, hs):
|
||||||
|
"""
|
||||||
|
Args:
|
||||||
|
hs (synapse.server.HomeServer): server
|
||||||
|
"""
|
||||||
|
super(CapabilitiesRestServlet, self).__init__()
|
||||||
|
self.hs = hs
|
||||||
|
self.auth = hs.get_auth()
|
||||||
|
self.store = hs.get_datastore()
|
||||||
|
|
||||||
|
@defer.inlineCallbacks
|
||||||
|
def on_GET(self, request):
|
||||||
|
requester = yield self.auth.get_user_by_req(request, allow_guest=True)
|
||||||
|
user = yield self.store.get_user_by_id(requester.user.to_string())
|
||||||
|
change_password = bool(user["password_hash"])
|
||||||
|
|
||||||
|
response = {
|
||||||
|
"capabilities": {
|
||||||
|
"m.room_versions": {
|
||||||
|
"default": DEFAULT_ROOM_VERSION,
|
||||||
|
"available": {
|
||||||
|
RoomVersions.V1: RoomDisposition.STABLE,
|
||||||
|
RoomVersions.V2: RoomDisposition.STABLE,
|
||||||
|
RoomVersions.STATE_V2_TEST: RoomDisposition.UNSTABLE,
|
||||||
|
RoomVersions.V3: RoomDisposition.STABLE,
|
||||||
|
},
|
||||||
|
},
|
||||||
|
"m.change_password": {"enabled": change_password},
|
||||||
|
}
|
||||||
|
}
|
||||||
|
defer.returnValue((200, response))
|
||||||
|
|
||||||
|
|
||||||
|
def register_servlets(hs, http_server):
|
||||||
|
CapabilitiesRestServlet(hs).register(http_server)
|
78
tests/rest/client/v2_alpha/test_capabilities.py
Normal file
78
tests/rest/client/v2_alpha/test_capabilities.py
Normal file
@ -0,0 +1,78 @@
|
|||||||
|
# -*- coding: utf-8 -*-
|
||||||
|
# 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.
|
||||||
|
|
||||||
|
from synapse.api.constants import DEFAULT_ROOM_VERSION, KNOWN_ROOM_VERSIONS
|
||||||
|
from synapse.rest.client.v1 import admin, login
|
||||||
|
from synapse.rest.client.v2_alpha import capabilities
|
||||||
|
|
||||||
|
from tests import unittest
|
||||||
|
|
||||||
|
|
||||||
|
class CapabilitiesTestCase(unittest.HomeserverTestCase):
|
||||||
|
|
||||||
|
servlets = [
|
||||||
|
admin.register_servlets,
|
||||||
|
capabilities.register_servlets,
|
||||||
|
login.register_servlets,
|
||||||
|
]
|
||||||
|
|
||||||
|
def make_homeserver(self, reactor, clock):
|
||||||
|
self.url = b"/_matrix/client/r0/capabilities"
|
||||||
|
hs = self.setup_test_homeserver()
|
||||||
|
self.store = hs.get_datastore()
|
||||||
|
return hs
|
||||||
|
|
||||||
|
def test_check_auth_required(self):
|
||||||
|
request, channel = self.make_request("GET", self.url)
|
||||||
|
self.render(request)
|
||||||
|
|
||||||
|
self.assertEqual(channel.code, 401)
|
||||||
|
|
||||||
|
def test_get_room_version_capabilities(self):
|
||||||
|
self.register_user("user", "pass")
|
||||||
|
access_token = self.login("user", "pass")
|
||||||
|
|
||||||
|
request, channel = self.make_request("GET", self.url, access_token=access_token)
|
||||||
|
self.render(request)
|
||||||
|
capabilities = channel.json_body['capabilities']
|
||||||
|
|
||||||
|
self.assertEqual(channel.code, 200)
|
||||||
|
for room_version in capabilities['m.room_versions']['available'].keys():
|
||||||
|
self.assertTrue(room_version in KNOWN_ROOM_VERSIONS, "" + room_version)
|
||||||
|
self.assertEqual(
|
||||||
|
DEFAULT_ROOM_VERSION, capabilities['m.room_versions']['default']
|
||||||
|
)
|
||||||
|
|
||||||
|
def test_get_change_password_capabilities(self):
|
||||||
|
localpart = "user"
|
||||||
|
password = "pass"
|
||||||
|
user = self.register_user(localpart, password)
|
||||||
|
access_token = self.login(user, password)
|
||||||
|
|
||||||
|
request, channel = self.make_request("GET", self.url, access_token=access_token)
|
||||||
|
self.render(request)
|
||||||
|
capabilities = channel.json_body['capabilities']
|
||||||
|
|
||||||
|
self.assertEqual(channel.code, 200)
|
||||||
|
|
||||||
|
# Test case where password is handled outside of Synapse
|
||||||
|
self.assertTrue(capabilities['m.change_password']['enabled'])
|
||||||
|
self.get_success(self.store.user_set_password_hash(user, None))
|
||||||
|
request, channel = self.make_request("GET", self.url, access_token=access_token)
|
||||||
|
self.render(request)
|
||||||
|
capabilities = channel.json_body['capabilities']
|
||||||
|
|
||||||
|
self.assertEqual(channel.code, 200)
|
||||||
|
self.assertFalse(capabilities['m.change_password']['enabled'])
|
Loading…
Reference in New Issue
Block a user