2020-06-05 06:07:22 -06:00
|
|
|
# Copyright 2020 Dirk Klimpel
|
|
|
|
#
|
|
|
|
# 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
|
2021-11-29 15:19:45 -07:00
|
|
|
from http import HTTPStatus
|
2021-03-02 02:31:12 -07:00
|
|
|
from typing import TYPE_CHECKING, Tuple
|
2020-06-05 06:07:22 -06:00
|
|
|
|
|
|
|
from synapse.api.errors import NotFoundError, SynapseError
|
2022-11-22 12:08:04 -07:00
|
|
|
from synapse.handlers.device import DeviceHandler
|
2020-06-05 06:07:22 -06:00
|
|
|
from synapse.http.servlet import (
|
|
|
|
RestServlet,
|
|
|
|
assert_params_in_dict,
|
|
|
|
parse_json_object_from_request,
|
|
|
|
)
|
2021-03-02 02:31:12 -07:00
|
|
|
from synapse.http.site import SynapseRequest
|
2020-09-17 05:04:15 -06:00
|
|
|
from synapse.rest.admin._base import admin_patterns, assert_requester_is_admin
|
2021-03-02 02:31:12 -07:00
|
|
|
from synapse.types import JsonDict, UserID
|
|
|
|
|
|
|
|
if TYPE_CHECKING:
|
|
|
|
from synapse.server import HomeServer
|
2020-06-05 06:07:22 -06:00
|
|
|
|
|
|
|
logger = logging.getLogger(__name__)
|
|
|
|
|
|
|
|
|
|
|
|
class DeviceRestServlet(RestServlet):
|
|
|
|
"""
|
|
|
|
Get, update or delete the given user's device
|
|
|
|
"""
|
|
|
|
|
2020-09-17 05:04:15 -06:00
|
|
|
PATTERNS = admin_patterns(
|
|
|
|
"/users/(?P<user_id>[^/]*)/devices/(?P<device_id>[^/]*)$", "v2"
|
2020-06-05 06:07:22 -06:00
|
|
|
)
|
|
|
|
|
2021-03-02 02:31:12 -07:00
|
|
|
def __init__(self, hs: "HomeServer"):
|
2020-09-18 07:56:44 -06:00
|
|
|
super().__init__()
|
2020-06-05 06:07:22 -06:00
|
|
|
self.auth = hs.get_auth()
|
2022-11-22 12:08:04 -07:00
|
|
|
handler = hs.get_device_handler()
|
|
|
|
assert isinstance(handler, DeviceHandler)
|
|
|
|
self.device_handler = handler
|
2022-02-23 04:04:02 -07:00
|
|
|
self.store = hs.get_datastores().main
|
2021-12-08 09:59:40 -07:00
|
|
|
self.is_mine = hs.is_mine
|
2020-06-05 06:07:22 -06:00
|
|
|
|
2021-03-02 02:31:12 -07:00
|
|
|
async def on_GET(
|
2021-09-15 06:45:32 -06:00
|
|
|
self, request: SynapseRequest, user_id: str, device_id: str
|
2021-03-02 02:31:12 -07:00
|
|
|
) -> Tuple[int, JsonDict]:
|
2020-06-05 06:07:22 -06:00
|
|
|
await assert_requester_is_admin(self.auth, request)
|
|
|
|
|
|
|
|
target_user = UserID.from_string(user_id)
|
2021-12-08 09:59:40 -07:00
|
|
|
if not self.is_mine(target_user):
|
2021-11-29 15:19:45 -07:00
|
|
|
raise SynapseError(HTTPStatus.BAD_REQUEST, "Can only lookup local users")
|
2020-06-05 06:07:22 -06:00
|
|
|
|
|
|
|
u = await self.store.get_user_by_id(target_user.to_string())
|
|
|
|
if u is None:
|
|
|
|
raise NotFoundError("Unknown user")
|
|
|
|
|
|
|
|
device = await self.device_handler.get_device(
|
|
|
|
target_user.to_string(), device_id
|
|
|
|
)
|
2021-12-13 08:39:43 -07:00
|
|
|
if device is None:
|
|
|
|
raise NotFoundError("No device found")
|
2021-11-29 15:19:45 -07:00
|
|
|
return HTTPStatus.OK, device
|
2020-06-05 06:07:22 -06:00
|
|
|
|
2021-03-02 02:31:12 -07:00
|
|
|
async def on_DELETE(
|
|
|
|
self, request: SynapseRequest, user_id: str, device_id: str
|
|
|
|
) -> Tuple[int, JsonDict]:
|
2020-06-05 06:07:22 -06:00
|
|
|
await assert_requester_is_admin(self.auth, request)
|
|
|
|
|
|
|
|
target_user = UserID.from_string(user_id)
|
2021-12-08 09:59:40 -07:00
|
|
|
if not self.is_mine(target_user):
|
2021-11-29 15:19:45 -07:00
|
|
|
raise SynapseError(HTTPStatus.BAD_REQUEST, "Can only lookup local users")
|
2020-06-05 06:07:22 -06:00
|
|
|
|
|
|
|
u = await self.store.get_user_by_id(target_user.to_string())
|
|
|
|
if u is None:
|
|
|
|
raise NotFoundError("Unknown user")
|
|
|
|
|
2022-06-07 05:43:35 -06:00
|
|
|
await self.device_handler.delete_devices(target_user.to_string(), [device_id])
|
2021-11-29 15:19:45 -07:00
|
|
|
return HTTPStatus.OK, {}
|
2020-06-05 06:07:22 -06:00
|
|
|
|
2021-03-02 02:31:12 -07:00
|
|
|
async def on_PUT(
|
|
|
|
self, request: SynapseRequest, user_id: str, device_id: str
|
|
|
|
) -> Tuple[int, JsonDict]:
|
2020-06-05 06:07:22 -06:00
|
|
|
await assert_requester_is_admin(self.auth, request)
|
|
|
|
|
|
|
|
target_user = UserID.from_string(user_id)
|
2021-12-08 09:59:40 -07:00
|
|
|
if not self.is_mine(target_user):
|
2021-11-29 15:19:45 -07:00
|
|
|
raise SynapseError(HTTPStatus.BAD_REQUEST, "Can only lookup local users")
|
2020-06-05 06:07:22 -06:00
|
|
|
|
|
|
|
u = await self.store.get_user_by_id(target_user.to_string())
|
|
|
|
if u is None:
|
|
|
|
raise NotFoundError("Unknown user")
|
|
|
|
|
|
|
|
body = parse_json_object_from_request(request, allow_empty_body=True)
|
|
|
|
await self.device_handler.update_device(
|
|
|
|
target_user.to_string(), device_id, body
|
|
|
|
)
|
2021-11-29 15:19:45 -07:00
|
|
|
return HTTPStatus.OK, {}
|
2020-06-05 06:07:22 -06:00
|
|
|
|
|
|
|
|
|
|
|
class DevicesRestServlet(RestServlet):
|
|
|
|
"""
|
|
|
|
Retrieve the given user's devices
|
|
|
|
"""
|
|
|
|
|
2020-09-17 05:04:15 -06:00
|
|
|
PATTERNS = admin_patterns("/users/(?P<user_id>[^/]*)/devices$", "v2")
|
2020-06-05 06:07:22 -06:00
|
|
|
|
2021-03-02 02:31:12 -07:00
|
|
|
def __init__(self, hs: "HomeServer"):
|
2020-06-05 06:07:22 -06:00
|
|
|
self.auth = hs.get_auth()
|
2022-11-22 12:08:04 -07:00
|
|
|
handler = hs.get_device_handler()
|
|
|
|
assert isinstance(handler, DeviceHandler)
|
|
|
|
self.device_handler = handler
|
2022-02-23 04:04:02 -07:00
|
|
|
self.store = hs.get_datastores().main
|
2021-12-08 09:59:40 -07:00
|
|
|
self.is_mine = hs.is_mine
|
2020-06-05 06:07:22 -06:00
|
|
|
|
2021-03-02 02:31:12 -07:00
|
|
|
async def on_GET(
|
|
|
|
self, request: SynapseRequest, user_id: str
|
|
|
|
) -> Tuple[int, JsonDict]:
|
2020-06-05 06:07:22 -06:00
|
|
|
await assert_requester_is_admin(self.auth, request)
|
|
|
|
|
|
|
|
target_user = UserID.from_string(user_id)
|
2021-12-08 09:59:40 -07:00
|
|
|
if not self.is_mine(target_user):
|
2021-11-29 15:19:45 -07:00
|
|
|
raise SynapseError(HTTPStatus.BAD_REQUEST, "Can only lookup local users")
|
2020-06-05 06:07:22 -06:00
|
|
|
|
|
|
|
u = await self.store.get_user_by_id(target_user.to_string())
|
|
|
|
if u is None:
|
|
|
|
raise NotFoundError("Unknown user")
|
|
|
|
|
|
|
|
devices = await self.device_handler.get_devices_by_user(target_user.to_string())
|
2021-11-29 15:19:45 -07:00
|
|
|
return HTTPStatus.OK, {"devices": devices, "total": len(devices)}
|
2020-06-05 06:07:22 -06:00
|
|
|
|
|
|
|
|
|
|
|
class DeleteDevicesRestServlet(RestServlet):
|
|
|
|
"""
|
|
|
|
API for bulk deletion of devices. Accepts a JSON object with a devices
|
|
|
|
key which lists the device_ids to delete.
|
|
|
|
"""
|
|
|
|
|
2020-09-17 05:04:15 -06:00
|
|
|
PATTERNS = admin_patterns("/users/(?P<user_id>[^/]*)/delete_devices$", "v2")
|
2020-06-05 06:07:22 -06:00
|
|
|
|
2021-03-02 02:31:12 -07:00
|
|
|
def __init__(self, hs: "HomeServer"):
|
2020-06-05 06:07:22 -06:00
|
|
|
self.auth = hs.get_auth()
|
2022-11-22 12:08:04 -07:00
|
|
|
handler = hs.get_device_handler()
|
|
|
|
assert isinstance(handler, DeviceHandler)
|
|
|
|
self.device_handler = handler
|
2022-02-23 04:04:02 -07:00
|
|
|
self.store = hs.get_datastores().main
|
2021-12-08 09:59:40 -07:00
|
|
|
self.is_mine = hs.is_mine
|
2020-06-05 06:07:22 -06:00
|
|
|
|
2021-03-02 02:31:12 -07:00
|
|
|
async def on_POST(
|
|
|
|
self, request: SynapseRequest, user_id: str
|
|
|
|
) -> Tuple[int, JsonDict]:
|
2020-06-05 06:07:22 -06:00
|
|
|
await assert_requester_is_admin(self.auth, request)
|
|
|
|
|
|
|
|
target_user = UserID.from_string(user_id)
|
2021-12-08 09:59:40 -07:00
|
|
|
if not self.is_mine(target_user):
|
2021-11-29 15:19:45 -07:00
|
|
|
raise SynapseError(HTTPStatus.BAD_REQUEST, "Can only lookup local users")
|
2020-06-05 06:07:22 -06:00
|
|
|
|
|
|
|
u = await self.store.get_user_by_id(target_user.to_string())
|
|
|
|
if u is None:
|
|
|
|
raise NotFoundError("Unknown user")
|
|
|
|
|
|
|
|
body = parse_json_object_from_request(request, allow_empty_body=False)
|
|
|
|
assert_params_in_dict(body, ["devices"])
|
|
|
|
|
|
|
|
await self.device_handler.delete_devices(
|
|
|
|
target_user.to_string(), body["devices"]
|
|
|
|
)
|
2021-11-29 15:19:45 -07:00
|
|
|
return HTTPStatus.OK, {}
|