1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254
|
#
# This file is licensed under the Affero General Public License (AGPL) version 3.
#
# Copyright (C) 2023 New Vector, Ltd
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU Affero General Public License as
# published by the Free Software Foundation, either version 3 of the
# License, or (at your option) any later version.
#
# See the GNU Affero General Public License for more details:
# <https://www.gnu.org/licenses/agpl-3.0.html>.
#
# Originally licensed under the Apache License, Version 2.0:
# <http://www.apache.org/licenses/LICENSE-2.0>.
#
# [This file includes modifications made by New Vector Limited]
#
#
import logging
from typing import TYPE_CHECKING
from twisted.web.server import Request
from synapse.http.server import HttpServer
from synapse.logging.opentracing import active_span
from synapse.replication.http._base import ReplicationEndpoint
from synapse.types import JsonDict, JsonMapping
if TYPE_CHECKING:
from synapse.server import HomeServer
logger = logging.getLogger(__name__)
class ReplicationNotifyDeviceUpdateRestServlet(ReplicationEndpoint):
"""Notify a device writer that a user's device list has changed.
Request format:
POST /_synapse/replication/notify_device_update/:user_id
{
"device_ids": ["JLAFKJWSCS", "JLAFKJWSCS"]
}
"""
NAME = "notify_device_update"
PATH_ARGS = ("user_id",)
CACHE = False
def __init__(self, hs: "HomeServer"):
super().__init__(hs)
self.device_handler = hs.get_device_handler()
self.store = hs.get_datastores().main
self.clock = hs.get_clock()
@staticmethod
async def _serialize_payload( # type: ignore[override]
user_id: str, device_ids: list[str]
) -> JsonDict:
return {"device_ids": device_ids}
async def _handle_request( # type: ignore[override]
self, request: Request, content: JsonDict, user_id: str
) -> tuple[int, JsonDict]:
device_ids = content["device_ids"]
span = active_span()
if span:
span.set_tag("user_id", user_id)
span.set_tag("device_ids", f"{device_ids!r}")
await self.device_handler.notify_device_update(user_id, device_ids)
return 200, {}
class ReplicationNotifyUserSignatureUpdateRestServlet(ReplicationEndpoint):
"""Notify a device writer that a user have made new signatures of other users.
Request format:
POST /_synapse/replication/notify_user_signature_update/:from_user_id
{
"user_ids": ["@alice:example.org", "@bob:example.org", ...]
}
"""
NAME = "notify_user_signature_update"
PATH_ARGS = ("from_user_id",)
CACHE = False
def __init__(self, hs: "HomeServer"):
super().__init__(hs)
self.device_handler = hs.get_device_handler()
self.store = hs.get_datastores().main
self.clock = hs.get_clock()
@staticmethod
async def _serialize_payload(from_user_id: str, user_ids: list[str]) -> JsonDict: # type: ignore[override]
return {"user_ids": user_ids}
async def _handle_request( # type: ignore[override]
self, request: Request, content: JsonDict, from_user_id: str
) -> tuple[int, JsonDict]:
user_ids = content["user_ids"]
span = active_span()
if span:
span.set_tag("from_user_id", from_user_id)
span.set_tag("user_ids", f"{user_ids!r}")
await self.device_handler.notify_user_signature_update(from_user_id, user_ids)
return 200, {}
class ReplicationMultiUserDevicesResyncRestServlet(ReplicationEndpoint):
"""Ask master to resync the device list for multiple users from the same
remote server by contacting their server.
This must happen on master so that the results can be correctly cached in
the database and streamed to workers.
Request format:
POST /_synapse/replication/multi_user_device_resync
{
"user_ids": ["@alice:example.org", "@bob:example.org", ...]
}
Response is roughly equivalent to ` /_matrix/federation/v1/user/devices/:user_id`
response, but there is a map from user ID to response, e.g.:
{
"@alice:example.org": {
"devices": [
{
"device_id": "JLAFKJWSCS",
"keys": { ... },
"device_display_name": "Alice's Mobile Phone"
}
]
},
...
}
"""
NAME = "multi_user_device_resync"
PATH_ARGS = ()
CACHE = True
def __init__(self, hs: "HomeServer"):
super().__init__(hs)
self.device_list_updater = hs.get_device_handler().device_list_updater
self.store = hs.get_datastores().main
self.clock = hs.get_clock()
@staticmethod
async def _serialize_payload(user_ids: list[str]) -> JsonDict: # type: ignore[override]
return {"user_ids": user_ids}
async def _handle_request( # type: ignore[override]
self, request: Request, content: JsonDict
) -> tuple[int, dict[str, JsonMapping | None]]:
user_ids: list[str] = content["user_ids"]
logger.info("Resync for %r", user_ids)
span = active_span()
if span:
span.set_tag("user_ids", f"{user_ids!r}")
multi_user_devices = await self.device_list_updater.multi_user_device_resync(
user_ids
)
return 200, multi_user_devices
class ReplicationHandleNewDeviceUpdateRestServlet(ReplicationEndpoint):
"""Wake up a device writer to send local device list changes as federation outbound pokes.
Request format:
POST /_synapse/replication/handle_new_device_update
{}
"""
NAME = "handle_new_device_update"
PATH_ARGS = ()
CACHE = False
def __init__(self, hs: "HomeServer"):
super().__init__(hs)
self.device_handler = hs.get_device_handler()
@staticmethod
async def _serialize_payload() -> JsonDict: # type: ignore[override]
return {}
async def _handle_request( # type: ignore[override]
self, request: Request, content: JsonDict
) -> tuple[int, JsonDict]:
await self.device_handler.handle_new_device_update()
return 200, {}
class ReplicationDeviceHandleRoomUnPartialStated(ReplicationEndpoint):
"""Handles sending appropriate device list updates in a room that has
gone from partial to full state.
Request format:
POST /_synapse/replication/device_handle_room_un_partial_stated/:room_id
{}
"""
NAME = "device_handle_room_un_partial_stated"
PATH_ARGS = ("room_id",)
CACHE = True
def __init__(self, hs: "HomeServer"):
super().__init__(hs)
self.device_handler = hs.get_device_handler()
@staticmethod
async def _serialize_payload(room_id: str) -> JsonDict: # type: ignore[override]
return {}
async def _handle_request( # type: ignore[override]
self, request: Request, content: JsonDict, room_id: str
) -> tuple[int, JsonDict]:
await self.device_handler.handle_room_un_partial_stated(room_id)
return 200, {}
def register_servlets(hs: "HomeServer", http_server: HttpServer) -> None:
ReplicationNotifyDeviceUpdateRestServlet(hs).register(http_server)
ReplicationNotifyUserSignatureUpdateRestServlet(hs).register(http_server)
ReplicationMultiUserDevicesResyncRestServlet(hs).register(http_server)
ReplicationHandleNewDeviceUpdateRestServlet(hs).register(http_server)
ReplicationDeviceHandleRoomUnPartialStated(hs).register(http_server)
|