2018-08-22 11:57:54 +02:00
|
|
|
# -*- coding: utf-8 -*-
|
|
|
|
# Copyright 2016 OpenMarket 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 twisted.internet import defer
|
|
|
|
|
|
|
|
from synapse.api.errors import Codes, SynapseError
|
2019-04-01 11:24:38 +02:00
|
|
|
from synapse.api.room_versions import KNOWN_ROOM_VERSIONS
|
2018-08-22 11:57:54 +02:00
|
|
|
from synapse.http.servlet import (
|
|
|
|
RestServlet,
|
|
|
|
assert_params_in_dict,
|
|
|
|
parse_json_object_from_request,
|
|
|
|
)
|
|
|
|
|
|
|
|
from ._base import client_v2_patterns
|
|
|
|
|
|
|
|
logger = logging.getLogger(__name__)
|
|
|
|
|
|
|
|
|
|
|
|
class RoomUpgradeRestServlet(RestServlet):
|
2018-10-26 18:10:30 +02:00
|
|
|
"""Handler for room uprade requests.
|
|
|
|
|
|
|
|
Handles requests of the form:
|
|
|
|
|
|
|
|
POST /_matrix/client/r0/rooms/$roomid/upgrade HTTP/1.1
|
|
|
|
Content-Type: application/json
|
|
|
|
|
|
|
|
{
|
|
|
|
"new_version": "2",
|
|
|
|
}
|
|
|
|
|
|
|
|
Creates a new room and shuts down the old one. Returns the ID of the new room.
|
|
|
|
|
|
|
|
Args:
|
|
|
|
hs (synapse.server.HomeServer):
|
|
|
|
"""
|
2018-08-22 11:57:54 +02:00
|
|
|
PATTERNS = client_v2_patterns(
|
|
|
|
# /rooms/$roomid/upgrade
|
|
|
|
"/rooms/(?P<room_id>[^/]*)/upgrade$",
|
|
|
|
v2_alpha=False,
|
|
|
|
)
|
|
|
|
|
|
|
|
def __init__(self, hs):
|
|
|
|
super(RoomUpgradeRestServlet, self).__init__()
|
|
|
|
self._hs = hs
|
|
|
|
self._room_creation_handler = hs.get_room_creation_handler()
|
|
|
|
self._auth = hs.get_auth()
|
|
|
|
|
|
|
|
@defer.inlineCallbacks
|
|
|
|
def on_POST(self, request, room_id):
|
|
|
|
requester = yield self._auth.get_user_by_req(request)
|
|
|
|
|
|
|
|
content = parse_json_object_from_request(request)
|
|
|
|
assert_params_in_dict(content, ("new_version", ))
|
|
|
|
new_version = content["new_version"]
|
|
|
|
|
|
|
|
if new_version not in KNOWN_ROOM_VERSIONS:
|
|
|
|
raise SynapseError(
|
|
|
|
400,
|
|
|
|
"Your homeserver does not support this room version",
|
|
|
|
Codes.UNSUPPORTED_ROOM_VERSION,
|
|
|
|
)
|
|
|
|
|
|
|
|
new_room_id = yield self._room_creation_handler.upgrade_room(
|
|
|
|
requester, room_id, new_version
|
|
|
|
)
|
|
|
|
|
|
|
|
ret = {
|
|
|
|
"replacement_room": new_room_id,
|
|
|
|
}
|
|
|
|
|
|
|
|
defer.returnValue((200, ret))
|
|
|
|
|
|
|
|
|
|
|
|
def register_servlets(hs, http_server):
|
|
|
|
RoomUpgradeRestServlet(hs).register(http_server)
|