# -*- coding: utf-8 -*- # Copyright 2014-2016 OpenMarket Ltd # Copyright 2018-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. import logging from synapse.api.errors import AuthError, Codes, NotFoundError, SynapseError from synapse.http.servlet import RestServlet, parse_boolean, parse_integer from synapse.rest.admin._base import ( admin_patterns, assert_requester_is_admin, assert_user_is_admin, ) logger = logging.getLogger(__name__) class QuarantineMediaInRoom(RestServlet): """Quarantines all media in a room so that no one can download it via this server. """ PATTERNS = ( admin_patterns("/room/(?P[^/]+)/media/quarantine") + # This path kept around for legacy reasons admin_patterns("/quarantine_media/(?P[^/]+)") ) def __init__(self, hs): self.store = hs.get_datastore() self.auth = hs.get_auth() async def on_POST(self, request, room_id: str): requester = await self.auth.get_user_by_req(request) await assert_user_is_admin(self.auth, requester.user) logging.info("Quarantining room: %s", room_id) # Quarantine all media in this room num_quarantined = await self.store.quarantine_media_ids_in_room( room_id, requester.user.to_string() ) return 200, {"num_quarantined": num_quarantined} class QuarantineMediaByUser(RestServlet): """Quarantines all local media by a given user so that no one can download it via this server. """ PATTERNS = admin_patterns("/user/(?P[^/]+)/media/quarantine") def __init__(self, hs): self.store = hs.get_datastore() self.auth = hs.get_auth() async def on_POST(self, request, user_id: str): requester = await self.auth.get_user_by_req(request) await assert_user_is_admin(self.auth, requester.user) logging.info("Quarantining local media by user: %s", user_id) # Quarantine all media this user has uploaded num_quarantined = await self.store.quarantine_media_ids_by_user( user_id, requester.user.to_string() ) return 200, {"num_quarantined": num_quarantined} class QuarantineMediaByID(RestServlet): """Quarantines local or remote media by a given ID so that no one can download it via this server. """ PATTERNS = admin_patterns( "/media/quarantine/(?P[^/]+)/(?P[^/]+)" ) def __init__(self, hs): self.store = hs.get_datastore() self.auth = hs.get_auth() async def on_POST(self, request, server_name: str, media_id: str): requester = await self.auth.get_user_by_req(request) await assert_user_is_admin(self.auth, requester.user) logging.info("Quarantining local media by ID: %s/%s", server_name, media_id) # Quarantine this media id await self.store.quarantine_media_by_id( server_name, media_id, requester.user.to_string() ) return 200, {} class ListMediaInRoom(RestServlet): """Lists all of the media in a given room. """ PATTERNS = admin_patterns("/room/(?P[^/]+)/media") def __init__(self, hs): self.store = hs.get_datastore() self.auth = hs.get_auth() async def on_GET(self, request, room_id): requester = await self.auth.get_user_by_req(request) is_admin = await self.auth.is_server_admin(requester.user) if not is_admin: raise AuthError(403, "You are not a server admin") local_mxcs, remote_mxcs = await self.store.get_media_mxcs_in_room(room_id) return 200, {"local": local_mxcs, "remote": remote_mxcs} class PurgeMediaCacheRestServlet(RestServlet): PATTERNS = admin_patterns("/purge_media_cache") def __init__(self, hs): self.media_repository = hs.get_media_repository() self.auth = hs.get_auth() async def on_POST(self, request): await assert_requester_is_admin(self.auth, request) before_ts = parse_integer(request, "before_ts", required=True) logger.info("before_ts: %r", before_ts) ret = await self.media_repository.delete_old_remote_media(before_ts) return 200, ret class DeleteMediaByID(RestServlet): """Delete local media by a given ID. Removes it from this server. """ PATTERNS = admin_patterns("/media/(?P[^/]+)/(?P[^/]+)") def __init__(self, hs): self.store = hs.get_datastore() self.auth = hs.get_auth() self.server_name = hs.hostname self.media_repository = hs.get_media_repository() async def on_DELETE(self, request, server_name: str, media_id: str): await assert_requester_is_admin(self.auth, request) if self.server_name != server_name: raise SynapseError(400, "Can only delete local media") if await self.store.get_local_media(media_id) is None: raise NotFoundError("Unknown media") logging.info("Deleting local media by ID: %s", media_id) deleted_media, total = await self.media_repository.delete_local_media(media_id) return 200, {"deleted_media": deleted_media, "total": total} class DeleteMediaByDateSize(RestServlet): """Delete local media and local copies of remote media by timestamp and size. """ PATTERNS = admin_patterns("/media/(?P[^/]+)/delete") def __init__(self, hs): self.store = hs.get_datastore() self.auth = hs.get_auth() self.server_name = hs.hostname self.media_repository = hs.get_media_repository() async def on_POST(self, request, server_name: str): await assert_requester_is_admin(self.auth, request) before_ts = parse_integer(request, "before_ts", required=True) size_gt = parse_integer(request, "size_gt", default=0) keep_profiles = parse_boolean(request, "keep_profiles", default=True) if before_ts < 0: raise SynapseError( 400, "Query parameter before_ts must be a string representing a positive integer.", errcode=Codes.INVALID_PARAM, ) if size_gt < 0: raise SynapseError( 400, "Query parameter size_gt must be a string representing a positive integer.", errcode=Codes.INVALID_PARAM, ) if self.server_name != server_name: raise SynapseError(400, "Can only delete local media") logging.info( "Deleting local media by timestamp: %s, size larger than: %s, keep profile media: %s" % (before_ts, size_gt, keep_profiles) ) deleted_media, total = await self.media_repository.delete_old_local_media( before_ts, size_gt, keep_profiles ) return 200, {"deleted_media": deleted_media, "total": total} def register_servlets_for_media_repo(hs, http_server): """ Media repo specific APIs. """ PurgeMediaCacheRestServlet(hs).register(http_server) QuarantineMediaInRoom(hs).register(http_server) QuarantineMediaByID(hs).register(http_server) QuarantineMediaByUser(hs).register(http_server) ListMediaInRoom(hs).register(http_server) DeleteMediaByID(hs).register(http_server) DeleteMediaByDateSize(hs).register(http_server)