matrix-synapse 1.143.0rc2__cp310-abi3-manylinux_2_28_aarch64.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (1058) hide show
  1. matrix_synapse-1.143.0rc2.dist-info/AUTHORS.rst +51 -0
  2. matrix_synapse-1.143.0rc2.dist-info/LICENSE-AGPL-3.0 +661 -0
  3. matrix_synapse-1.143.0rc2.dist-info/LICENSE-COMMERCIAL +6 -0
  4. matrix_synapse-1.143.0rc2.dist-info/METADATA +385 -0
  5. matrix_synapse-1.143.0rc2.dist-info/RECORD +1058 -0
  6. matrix_synapse-1.143.0rc2.dist-info/WHEEL +4 -0
  7. matrix_synapse-1.143.0rc2.dist-info/entry_points.txt +14 -0
  8. synapse/__init__.py +97 -0
  9. synapse/_scripts/__init__.py +0 -0
  10. synapse/_scripts/export_signing_key.py +109 -0
  11. synapse/_scripts/generate_config.py +83 -0
  12. synapse/_scripts/generate_log_config.py +56 -0
  13. synapse/_scripts/generate_signing_key.py +55 -0
  14. synapse/_scripts/generate_workers_map.py +318 -0
  15. synapse/_scripts/hash_password.py +95 -0
  16. synapse/_scripts/move_remote_media_to_new_store.py +128 -0
  17. synapse/_scripts/register_new_matrix_user.py +402 -0
  18. synapse/_scripts/review_recent_signups.py +212 -0
  19. synapse/_scripts/synapse_port_db.py +1604 -0
  20. synapse/_scripts/synctl.py +365 -0
  21. synapse/_scripts/update_synapse_database.py +130 -0
  22. synapse/api/__init__.py +20 -0
  23. synapse/api/auth/__init__.py +207 -0
  24. synapse/api/auth/base.py +406 -0
  25. synapse/api/auth/internal.py +299 -0
  26. synapse/api/auth/mas.py +436 -0
  27. synapse/api/auth/msc3861_delegated.py +617 -0
  28. synapse/api/auth_blocking.py +144 -0
  29. synapse/api/constants.py +362 -0
  30. synapse/api/errors.py +907 -0
  31. synapse/api/filtering.py +537 -0
  32. synapse/api/presence.py +102 -0
  33. synapse/api/ratelimiting.py +480 -0
  34. synapse/api/room_versions.py +535 -0
  35. synapse/api/urls.py +118 -0
  36. synapse/app/__init__.py +60 -0
  37. synapse/app/_base.py +862 -0
  38. synapse/app/admin_cmd.py +388 -0
  39. synapse/app/appservice.py +30 -0
  40. synapse/app/client_reader.py +30 -0
  41. synapse/app/complement_fork_starter.py +206 -0
  42. synapse/app/event_creator.py +29 -0
  43. synapse/app/federation_reader.py +30 -0
  44. synapse/app/federation_sender.py +30 -0
  45. synapse/app/frontend_proxy.py +30 -0
  46. synapse/app/generic_worker.py +474 -0
  47. synapse/app/homeserver.py +505 -0
  48. synapse/app/media_repository.py +30 -0
  49. synapse/app/phone_stats_home.py +296 -0
  50. synapse/app/pusher.py +30 -0
  51. synapse/app/synchrotron.py +30 -0
  52. synapse/app/user_dir.py +31 -0
  53. synapse/appservice/__init__.py +458 -0
  54. synapse/appservice/api.py +567 -0
  55. synapse/appservice/scheduler.py +564 -0
  56. synapse/config/__init__.py +27 -0
  57. synapse/config/__main__.py +62 -0
  58. synapse/config/_base.py +1106 -0
  59. synapse/config/_base.pyi +215 -0
  60. synapse/config/_util.py +99 -0
  61. synapse/config/account_validity.py +116 -0
  62. synapse/config/api.py +141 -0
  63. synapse/config/appservice.py +210 -0
  64. synapse/config/auth.py +80 -0
  65. synapse/config/auto_accept_invites.py +43 -0
  66. synapse/config/background_updates.py +44 -0
  67. synapse/config/cache.py +231 -0
  68. synapse/config/captcha.py +90 -0
  69. synapse/config/cas.py +116 -0
  70. synapse/config/consent.py +73 -0
  71. synapse/config/database.py +184 -0
  72. synapse/config/emailconfig.py +367 -0
  73. synapse/config/experimental.py +595 -0
  74. synapse/config/federation.py +114 -0
  75. synapse/config/homeserver.py +141 -0
  76. synapse/config/jwt.py +55 -0
  77. synapse/config/key.py +447 -0
  78. synapse/config/logger.py +390 -0
  79. synapse/config/mas.py +192 -0
  80. synapse/config/matrixrtc.py +66 -0
  81. synapse/config/metrics.py +84 -0
  82. synapse/config/modules.py +40 -0
  83. synapse/config/oembed.py +185 -0
  84. synapse/config/oidc.py +509 -0
  85. synapse/config/password_auth_providers.py +82 -0
  86. synapse/config/push.py +64 -0
  87. synapse/config/ratelimiting.py +254 -0
  88. synapse/config/redis.py +74 -0
  89. synapse/config/registration.py +296 -0
  90. synapse/config/repository.py +311 -0
  91. synapse/config/retention.py +162 -0
  92. synapse/config/room.py +88 -0
  93. synapse/config/room_directory.py +165 -0
  94. synapse/config/saml2.py +251 -0
  95. synapse/config/server.py +1170 -0
  96. synapse/config/server_notices.py +84 -0
  97. synapse/config/spam_checker.py +66 -0
  98. synapse/config/sso.py +121 -0
  99. synapse/config/stats.py +54 -0
  100. synapse/config/third_party_event_rules.py +40 -0
  101. synapse/config/tls.py +192 -0
  102. synapse/config/tracer.py +71 -0
  103. synapse/config/user_directory.py +47 -0
  104. synapse/config/user_types.py +42 -0
  105. synapse/config/voip.py +59 -0
  106. synapse/config/workers.py +642 -0
  107. synapse/crypto/__init__.py +20 -0
  108. synapse/crypto/context_factory.py +278 -0
  109. synapse/crypto/event_signing.py +194 -0
  110. synapse/crypto/keyring.py +931 -0
  111. synapse/event_auth.py +1266 -0
  112. synapse/events/__init__.py +667 -0
  113. synapse/events/auto_accept_invites.py +216 -0
  114. synapse/events/builder.py +387 -0
  115. synapse/events/presence_router.py +243 -0
  116. synapse/events/snapshot.py +559 -0
  117. synapse/events/utils.py +924 -0
  118. synapse/events/validator.py +305 -0
  119. synapse/federation/__init__.py +22 -0
  120. synapse/federation/federation_base.py +382 -0
  121. synapse/federation/federation_client.py +2132 -0
  122. synapse/federation/federation_server.py +1540 -0
  123. synapse/federation/persistence.py +70 -0
  124. synapse/federation/send_queue.py +531 -0
  125. synapse/federation/sender/__init__.py +1164 -0
  126. synapse/federation/sender/per_destination_queue.py +886 -0
  127. synapse/federation/sender/transaction_manager.py +210 -0
  128. synapse/federation/transport/__init__.py +28 -0
  129. synapse/federation/transport/client.py +1199 -0
  130. synapse/federation/transport/server/__init__.py +334 -0
  131. synapse/federation/transport/server/_base.py +429 -0
  132. synapse/federation/transport/server/federation.py +910 -0
  133. synapse/federation/units.py +133 -0
  134. synapse/handlers/__init__.py +20 -0
  135. synapse/handlers/account.py +162 -0
  136. synapse/handlers/account_data.py +360 -0
  137. synapse/handlers/account_validity.py +361 -0
  138. synapse/handlers/admin.py +615 -0
  139. synapse/handlers/appservice.py +989 -0
  140. synapse/handlers/auth.py +2481 -0
  141. synapse/handlers/cas.py +413 -0
  142. synapse/handlers/deactivate_account.py +363 -0
  143. synapse/handlers/delayed_events.py +599 -0
  144. synapse/handlers/device.py +1870 -0
  145. synapse/handlers/devicemessage.py +399 -0
  146. synapse/handlers/directory.py +545 -0
  147. synapse/handlers/e2e_keys.py +1834 -0
  148. synapse/handlers/e2e_room_keys.py +455 -0
  149. synapse/handlers/event_auth.py +390 -0
  150. synapse/handlers/events.py +201 -0
  151. synapse/handlers/federation.py +2039 -0
  152. synapse/handlers/federation_event.py +2419 -0
  153. synapse/handlers/identity.py +812 -0
  154. synapse/handlers/initial_sync.py +528 -0
  155. synapse/handlers/jwt.py +120 -0
  156. synapse/handlers/message.py +2347 -0
  157. synapse/handlers/oidc.py +1801 -0
  158. synapse/handlers/pagination.py +768 -0
  159. synapse/handlers/password_policy.py +102 -0
  160. synapse/handlers/presence.py +2633 -0
  161. synapse/handlers/profile.py +655 -0
  162. synapse/handlers/push_rules.py +164 -0
  163. synapse/handlers/read_marker.py +79 -0
  164. synapse/handlers/receipts.py +351 -0
  165. synapse/handlers/register.py +1059 -0
  166. synapse/handlers/relations.py +623 -0
  167. synapse/handlers/reports.py +98 -0
  168. synapse/handlers/room.py +2448 -0
  169. synapse/handlers/room_list.py +632 -0
  170. synapse/handlers/room_member.py +2365 -0
  171. synapse/handlers/room_member_worker.py +146 -0
  172. synapse/handlers/room_policy.py +186 -0
  173. synapse/handlers/room_summary.py +1057 -0
  174. synapse/handlers/saml.py +524 -0
  175. synapse/handlers/search.py +723 -0
  176. synapse/handlers/send_email.py +209 -0
  177. synapse/handlers/set_password.py +71 -0
  178. synapse/handlers/sliding_sync/__init__.py +1701 -0
  179. synapse/handlers/sliding_sync/extensions.py +969 -0
  180. synapse/handlers/sliding_sync/room_lists.py +2262 -0
  181. synapse/handlers/sliding_sync/store.py +128 -0
  182. synapse/handlers/sso.py +1291 -0
  183. synapse/handlers/state_deltas.py +82 -0
  184. synapse/handlers/stats.py +321 -0
  185. synapse/handlers/sync.py +3106 -0
  186. synapse/handlers/thread_subscriptions.py +190 -0
  187. synapse/handlers/typing.py +606 -0
  188. synapse/handlers/ui_auth/__init__.py +48 -0
  189. synapse/handlers/ui_auth/checkers.py +332 -0
  190. synapse/handlers/user_directory.py +783 -0
  191. synapse/handlers/worker_lock.py +371 -0
  192. synapse/http/__init__.py +105 -0
  193. synapse/http/additional_resource.py +62 -0
  194. synapse/http/client.py +1373 -0
  195. synapse/http/connectproxyclient.py +316 -0
  196. synapse/http/federation/__init__.py +19 -0
  197. synapse/http/federation/matrix_federation_agent.py +490 -0
  198. synapse/http/federation/srv_resolver.py +196 -0
  199. synapse/http/federation/well_known_resolver.py +367 -0
  200. synapse/http/matrixfederationclient.py +1873 -0
  201. synapse/http/proxy.py +290 -0
  202. synapse/http/proxyagent.py +497 -0
  203. synapse/http/replicationagent.py +202 -0
  204. synapse/http/request_metrics.py +309 -0
  205. synapse/http/server.py +1110 -0
  206. synapse/http/servlet.py +1018 -0
  207. synapse/http/site.py +825 -0
  208. synapse/http/types.py +27 -0
  209. synapse/logging/__init__.py +31 -0
  210. synapse/logging/_remote.py +261 -0
  211. synapse/logging/_terse_json.py +95 -0
  212. synapse/logging/context.py +1209 -0
  213. synapse/logging/formatter.py +62 -0
  214. synapse/logging/handlers.py +99 -0
  215. synapse/logging/loggers.py +25 -0
  216. synapse/logging/opentracing.py +1132 -0
  217. synapse/logging/scopecontextmanager.py +160 -0
  218. synapse/media/_base.py +830 -0
  219. synapse/media/filepath.py +417 -0
  220. synapse/media/media_repository.py +1580 -0
  221. synapse/media/media_storage.py +702 -0
  222. synapse/media/oembed.py +277 -0
  223. synapse/media/preview_html.py +556 -0
  224. synapse/media/storage_provider.py +195 -0
  225. synapse/media/thumbnailer.py +833 -0
  226. synapse/media/url_previewer.py +875 -0
  227. synapse/metrics/__init__.py +748 -0
  228. synapse/metrics/_gc.py +219 -0
  229. synapse/metrics/_reactor_metrics.py +171 -0
  230. synapse/metrics/_types.py +38 -0
  231. synapse/metrics/background_process_metrics.py +555 -0
  232. synapse/metrics/common_usage_metrics.py +94 -0
  233. synapse/metrics/jemalloc.py +248 -0
  234. synapse/module_api/__init__.py +2131 -0
  235. synapse/module_api/callbacks/__init__.py +50 -0
  236. synapse/module_api/callbacks/account_validity_callbacks.py +106 -0
  237. synapse/module_api/callbacks/media_repository_callbacks.py +157 -0
  238. synapse/module_api/callbacks/ratelimit_callbacks.py +78 -0
  239. synapse/module_api/callbacks/spamchecker_callbacks.py +991 -0
  240. synapse/module_api/callbacks/third_party_event_rules_callbacks.py +592 -0
  241. synapse/module_api/errors.py +42 -0
  242. synapse/notifier.py +970 -0
  243. synapse/push/__init__.py +212 -0
  244. synapse/push/bulk_push_rule_evaluator.py +635 -0
  245. synapse/push/clientformat.py +126 -0
  246. synapse/push/emailpusher.py +333 -0
  247. synapse/push/httppusher.py +564 -0
  248. synapse/push/mailer.py +1010 -0
  249. synapse/push/presentable_names.py +216 -0
  250. synapse/push/push_tools.py +114 -0
  251. synapse/push/push_types.py +141 -0
  252. synapse/push/pusher.py +87 -0
  253. synapse/push/pusherpool.py +501 -0
  254. synapse/push/rulekinds.py +33 -0
  255. synapse/py.typed +0 -0
  256. synapse/replication/__init__.py +20 -0
  257. synapse/replication/http/__init__.py +68 -0
  258. synapse/replication/http/_base.py +468 -0
  259. synapse/replication/http/account_data.py +297 -0
  260. synapse/replication/http/deactivate_account.py +81 -0
  261. synapse/replication/http/delayed_events.py +62 -0
  262. synapse/replication/http/devices.py +254 -0
  263. synapse/replication/http/federation.py +334 -0
  264. synapse/replication/http/login.py +106 -0
  265. synapse/replication/http/membership.py +364 -0
  266. synapse/replication/http/presence.py +133 -0
  267. synapse/replication/http/push.py +156 -0
  268. synapse/replication/http/register.py +172 -0
  269. synapse/replication/http/send_events.py +182 -0
  270. synapse/replication/http/state.py +82 -0
  271. synapse/replication/http/streams.py +101 -0
  272. synapse/replication/tcp/__init__.py +56 -0
  273. synapse/replication/tcp/client.py +552 -0
  274. synapse/replication/tcp/commands.py +569 -0
  275. synapse/replication/tcp/context.py +41 -0
  276. synapse/replication/tcp/external_cache.py +156 -0
  277. synapse/replication/tcp/handler.py +922 -0
  278. synapse/replication/tcp/protocol.py +608 -0
  279. synapse/replication/tcp/redis.py +509 -0
  280. synapse/replication/tcp/resource.py +348 -0
  281. synapse/replication/tcp/streams/__init__.py +96 -0
  282. synapse/replication/tcp/streams/_base.py +765 -0
  283. synapse/replication/tcp/streams/events.py +287 -0
  284. synapse/replication/tcp/streams/federation.py +92 -0
  285. synapse/replication/tcp/streams/partial_state.py +80 -0
  286. synapse/res/providers.json +29 -0
  287. synapse/res/templates/_base.html +29 -0
  288. synapse/res/templates/account_previously_renewed.html +6 -0
  289. synapse/res/templates/account_renewed.html +6 -0
  290. synapse/res/templates/add_threepid.html +8 -0
  291. synapse/res/templates/add_threepid.txt +6 -0
  292. synapse/res/templates/add_threepid_failure.html +7 -0
  293. synapse/res/templates/add_threepid_success.html +6 -0
  294. synapse/res/templates/already_in_use.html +12 -0
  295. synapse/res/templates/already_in_use.txt +10 -0
  296. synapse/res/templates/auth_success.html +21 -0
  297. synapse/res/templates/invalid_token.html +6 -0
  298. synapse/res/templates/mail-Element.css +7 -0
  299. synapse/res/templates/mail-Vector.css +7 -0
  300. synapse/res/templates/mail-expiry.css +4 -0
  301. synapse/res/templates/mail.css +156 -0
  302. synapse/res/templates/notice_expiry.html +46 -0
  303. synapse/res/templates/notice_expiry.txt +7 -0
  304. synapse/res/templates/notif.html +51 -0
  305. synapse/res/templates/notif.txt +22 -0
  306. synapse/res/templates/notif_mail.html +59 -0
  307. synapse/res/templates/notif_mail.txt +10 -0
  308. synapse/res/templates/password_reset.html +10 -0
  309. synapse/res/templates/password_reset.txt +7 -0
  310. synapse/res/templates/password_reset_confirmation.html +15 -0
  311. synapse/res/templates/password_reset_failure.html +7 -0
  312. synapse/res/templates/password_reset_success.html +6 -0
  313. synapse/res/templates/recaptcha.html +42 -0
  314. synapse/res/templates/registration.html +12 -0
  315. synapse/res/templates/registration.txt +10 -0
  316. synapse/res/templates/registration_failure.html +6 -0
  317. synapse/res/templates/registration_success.html +6 -0
  318. synapse/res/templates/registration_token.html +18 -0
  319. synapse/res/templates/room.html +33 -0
  320. synapse/res/templates/room.txt +9 -0
  321. synapse/res/templates/sso.css +129 -0
  322. synapse/res/templates/sso_account_deactivated.html +25 -0
  323. synapse/res/templates/sso_auth_account_details.html +186 -0
  324. synapse/res/templates/sso_auth_account_details.js +116 -0
  325. synapse/res/templates/sso_auth_bad_user.html +26 -0
  326. synapse/res/templates/sso_auth_confirm.html +27 -0
  327. synapse/res/templates/sso_auth_success.html +26 -0
  328. synapse/res/templates/sso_error.html +71 -0
  329. synapse/res/templates/sso_footer.html +19 -0
  330. synapse/res/templates/sso_login_idp_picker.html +60 -0
  331. synapse/res/templates/sso_new_user_consent.html +30 -0
  332. synapse/res/templates/sso_partial_profile.html +19 -0
  333. synapse/res/templates/sso_redirect_confirm.html +39 -0
  334. synapse/res/templates/style.css +33 -0
  335. synapse/res/templates/terms.html +27 -0
  336. synapse/rest/__init__.py +197 -0
  337. synapse/rest/admin/__init__.py +390 -0
  338. synapse/rest/admin/_base.py +72 -0
  339. synapse/rest/admin/background_updates.py +171 -0
  340. synapse/rest/admin/devices.py +221 -0
  341. synapse/rest/admin/event_reports.py +173 -0
  342. synapse/rest/admin/events.py +69 -0
  343. synapse/rest/admin/experimental_features.py +137 -0
  344. synapse/rest/admin/federation.py +243 -0
  345. synapse/rest/admin/media.py +540 -0
  346. synapse/rest/admin/registration_tokens.py +358 -0
  347. synapse/rest/admin/rooms.py +1061 -0
  348. synapse/rest/admin/scheduled_tasks.py +70 -0
  349. synapse/rest/admin/server_notice_servlet.py +132 -0
  350. synapse/rest/admin/statistics.py +132 -0
  351. synapse/rest/admin/username_available.py +58 -0
  352. synapse/rest/admin/users.py +1606 -0
  353. synapse/rest/client/__init__.py +20 -0
  354. synapse/rest/client/_base.py +113 -0
  355. synapse/rest/client/account.py +930 -0
  356. synapse/rest/client/account_data.py +319 -0
  357. synapse/rest/client/account_validity.py +103 -0
  358. synapse/rest/client/appservice_ping.py +125 -0
  359. synapse/rest/client/auth.py +218 -0
  360. synapse/rest/client/auth_metadata.py +122 -0
  361. synapse/rest/client/capabilities.py +121 -0
  362. synapse/rest/client/delayed_events.py +165 -0
  363. synapse/rest/client/devices.py +587 -0
  364. synapse/rest/client/directory.py +211 -0
  365. synapse/rest/client/events.py +116 -0
  366. synapse/rest/client/filter.py +112 -0
  367. synapse/rest/client/initial_sync.py +65 -0
  368. synapse/rest/client/keys.py +678 -0
  369. synapse/rest/client/knock.py +104 -0
  370. synapse/rest/client/login.py +750 -0
  371. synapse/rest/client/login_token_request.py +127 -0
  372. synapse/rest/client/logout.py +93 -0
  373. synapse/rest/client/matrixrtc.py +52 -0
  374. synapse/rest/client/media.py +285 -0
  375. synapse/rest/client/mutual_rooms.py +93 -0
  376. synapse/rest/client/notifications.py +137 -0
  377. synapse/rest/client/openid.py +109 -0
  378. synapse/rest/client/password_policy.py +69 -0
  379. synapse/rest/client/presence.py +131 -0
  380. synapse/rest/client/profile.py +291 -0
  381. synapse/rest/client/push_rule.py +331 -0
  382. synapse/rest/client/pusher.py +181 -0
  383. synapse/rest/client/read_marker.py +104 -0
  384. synapse/rest/client/receipts.py +165 -0
  385. synapse/rest/client/register.py +1067 -0
  386. synapse/rest/client/relations.py +138 -0
  387. synapse/rest/client/rendezvous.py +76 -0
  388. synapse/rest/client/reporting.py +207 -0
  389. synapse/rest/client/room.py +1669 -0
  390. synapse/rest/client/room_keys.py +426 -0
  391. synapse/rest/client/room_upgrade_rest_servlet.py +112 -0
  392. synapse/rest/client/sendtodevice.py +85 -0
  393. synapse/rest/client/sync.py +1131 -0
  394. synapse/rest/client/tags.py +129 -0
  395. synapse/rest/client/thirdparty.py +130 -0
  396. synapse/rest/client/thread_subscriptions.py +247 -0
  397. synapse/rest/client/tokenrefresh.py +52 -0
  398. synapse/rest/client/transactions.py +149 -0
  399. synapse/rest/client/user_directory.py +90 -0
  400. synapse/rest/client/versions.py +191 -0
  401. synapse/rest/client/voip.py +88 -0
  402. synapse/rest/consent/__init__.py +0 -0
  403. synapse/rest/consent/consent_resource.py +210 -0
  404. synapse/rest/health.py +38 -0
  405. synapse/rest/key/__init__.py +20 -0
  406. synapse/rest/key/v2/__init__.py +40 -0
  407. synapse/rest/key/v2/local_key_resource.py +125 -0
  408. synapse/rest/key/v2/remote_key_resource.py +302 -0
  409. synapse/rest/media/__init__.py +0 -0
  410. synapse/rest/media/config_resource.py +53 -0
  411. synapse/rest/media/create_resource.py +90 -0
  412. synapse/rest/media/download_resource.py +110 -0
  413. synapse/rest/media/media_repository_resource.py +113 -0
  414. synapse/rest/media/preview_url_resource.py +77 -0
  415. synapse/rest/media/thumbnail_resource.py +142 -0
  416. synapse/rest/media/upload_resource.py +187 -0
  417. synapse/rest/media/v1/__init__.py +39 -0
  418. synapse/rest/media/v1/_base.py +23 -0
  419. synapse/rest/media/v1/media_storage.py +23 -0
  420. synapse/rest/media/v1/storage_provider.py +23 -0
  421. synapse/rest/synapse/__init__.py +20 -0
  422. synapse/rest/synapse/client/__init__.py +93 -0
  423. synapse/rest/synapse/client/federation_whitelist.py +66 -0
  424. synapse/rest/synapse/client/jwks.py +77 -0
  425. synapse/rest/synapse/client/new_user_consent.py +115 -0
  426. synapse/rest/synapse/client/oidc/__init__.py +45 -0
  427. synapse/rest/synapse/client/oidc/backchannel_logout_resource.py +42 -0
  428. synapse/rest/synapse/client/oidc/callback_resource.py +48 -0
  429. synapse/rest/synapse/client/password_reset.py +129 -0
  430. synapse/rest/synapse/client/pick_idp.py +107 -0
  431. synapse/rest/synapse/client/pick_username.py +153 -0
  432. synapse/rest/synapse/client/rendezvous.py +58 -0
  433. synapse/rest/synapse/client/saml2/__init__.py +42 -0
  434. synapse/rest/synapse/client/saml2/metadata_resource.py +46 -0
  435. synapse/rest/synapse/client/saml2/response_resource.py +52 -0
  436. synapse/rest/synapse/client/sso_register.py +56 -0
  437. synapse/rest/synapse/client/unsubscribe.py +88 -0
  438. synapse/rest/synapse/mas/__init__.py +71 -0
  439. synapse/rest/synapse/mas/_base.py +55 -0
  440. synapse/rest/synapse/mas/devices.py +239 -0
  441. synapse/rest/synapse/mas/users.py +469 -0
  442. synapse/rest/well_known.py +148 -0
  443. synapse/server.py +1257 -0
  444. synapse/server_notices/__init__.py +0 -0
  445. synapse/server_notices/consent_server_notices.py +136 -0
  446. synapse/server_notices/resource_limits_server_notices.py +215 -0
  447. synapse/server_notices/server_notices_manager.py +388 -0
  448. synapse/server_notices/server_notices_sender.py +67 -0
  449. synapse/server_notices/worker_server_notices_sender.py +46 -0
  450. synapse/spam_checker_api/__init__.py +31 -0
  451. synapse/state/__init__.py +1022 -0
  452. synapse/state/v1.py +369 -0
  453. synapse/state/v2.py +984 -0
  454. synapse/static/client/login/index.html +47 -0
  455. synapse/static/client/login/js/jquery-3.4.1.min.js +2 -0
  456. synapse/static/client/login/js/login.js +291 -0
  457. synapse/static/client/login/spinner.gif +0 -0
  458. synapse/static/client/login/style.css +79 -0
  459. synapse/static/index.html +63 -0
  460. synapse/storage/__init__.py +43 -0
  461. synapse/storage/_base.py +245 -0
  462. synapse/storage/admin_client_config.py +25 -0
  463. synapse/storage/background_updates.py +1188 -0
  464. synapse/storage/controllers/__init__.py +57 -0
  465. synapse/storage/controllers/persist_events.py +1237 -0
  466. synapse/storage/controllers/purge_events.py +455 -0
  467. synapse/storage/controllers/state.py +950 -0
  468. synapse/storage/controllers/stats.py +119 -0
  469. synapse/storage/database.py +2719 -0
  470. synapse/storage/databases/__init__.py +175 -0
  471. synapse/storage/databases/main/__init__.py +420 -0
  472. synapse/storage/databases/main/account_data.py +1059 -0
  473. synapse/storage/databases/main/appservice.py +473 -0
  474. synapse/storage/databases/main/cache.py +911 -0
  475. synapse/storage/databases/main/censor_events.py +225 -0
  476. synapse/storage/databases/main/client_ips.py +815 -0
  477. synapse/storage/databases/main/delayed_events.py +562 -0
  478. synapse/storage/databases/main/deviceinbox.py +1271 -0
  479. synapse/storage/databases/main/devices.py +2578 -0
  480. synapse/storage/databases/main/directory.py +212 -0
  481. synapse/storage/databases/main/e2e_room_keys.py +689 -0
  482. synapse/storage/databases/main/end_to_end_keys.py +1894 -0
  483. synapse/storage/databases/main/event_federation.py +2508 -0
  484. synapse/storage/databases/main/event_push_actions.py +1933 -0
  485. synapse/storage/databases/main/events.py +3765 -0
  486. synapse/storage/databases/main/events_bg_updates.py +2910 -0
  487. synapse/storage/databases/main/events_forward_extremities.py +126 -0
  488. synapse/storage/databases/main/events_worker.py +2786 -0
  489. synapse/storage/databases/main/experimental_features.py +130 -0
  490. synapse/storage/databases/main/filtering.py +231 -0
  491. synapse/storage/databases/main/keys.py +291 -0
  492. synapse/storage/databases/main/lock.py +553 -0
  493. synapse/storage/databases/main/media_repository.py +1068 -0
  494. synapse/storage/databases/main/metrics.py +460 -0
  495. synapse/storage/databases/main/monthly_active_users.py +443 -0
  496. synapse/storage/databases/main/openid.py +60 -0
  497. synapse/storage/databases/main/presence.py +509 -0
  498. synapse/storage/databases/main/profile.py +539 -0
  499. synapse/storage/databases/main/purge_events.py +521 -0
  500. synapse/storage/databases/main/push_rule.py +970 -0
  501. synapse/storage/databases/main/pusher.py +793 -0
  502. synapse/storage/databases/main/receipts.py +1341 -0
  503. synapse/storage/databases/main/registration.py +3072 -0
  504. synapse/storage/databases/main/rejections.py +37 -0
  505. synapse/storage/databases/main/relations.py +1116 -0
  506. synapse/storage/databases/main/room.py +2779 -0
  507. synapse/storage/databases/main/roommember.py +2110 -0
  508. synapse/storage/databases/main/search.py +939 -0
  509. synapse/storage/databases/main/session.py +151 -0
  510. synapse/storage/databases/main/signatures.py +94 -0
  511. synapse/storage/databases/main/sliding_sync.py +603 -0
  512. synapse/storage/databases/main/state.py +1002 -0
  513. synapse/storage/databases/main/state_deltas.py +329 -0
  514. synapse/storage/databases/main/stats.py +789 -0
  515. synapse/storage/databases/main/stream.py +2577 -0
  516. synapse/storage/databases/main/tags.py +360 -0
  517. synapse/storage/databases/main/task_scheduler.py +225 -0
  518. synapse/storage/databases/main/thread_subscriptions.py +589 -0
  519. synapse/storage/databases/main/transactions.py +675 -0
  520. synapse/storage/databases/main/ui_auth.py +420 -0
  521. synapse/storage/databases/main/user_directory.py +1330 -0
  522. synapse/storage/databases/main/user_erasure_store.py +117 -0
  523. synapse/storage/databases/state/__init__.py +22 -0
  524. synapse/storage/databases/state/bg_updates.py +497 -0
  525. synapse/storage/databases/state/deletion.py +557 -0
  526. synapse/storage/databases/state/store.py +948 -0
  527. synapse/storage/engines/__init__.py +70 -0
  528. synapse/storage/engines/_base.py +154 -0
  529. synapse/storage/engines/postgres.py +261 -0
  530. synapse/storage/engines/sqlite.py +199 -0
  531. synapse/storage/invite_rule.py +112 -0
  532. synapse/storage/keys.py +40 -0
  533. synapse/storage/prepare_database.py +730 -0
  534. synapse/storage/push_rule.py +28 -0
  535. synapse/storage/roommember.py +88 -0
  536. synapse/storage/schema/README.md +4 -0
  537. synapse/storage/schema/__init__.py +186 -0
  538. synapse/storage/schema/common/delta/25/00background_updates.sql +40 -0
  539. synapse/storage/schema/common/delta/35/00background_updates_add_col.sql +36 -0
  540. synapse/storage/schema/common/delta/58/00background_update_ordering.sql +38 -0
  541. synapse/storage/schema/common/full_schemas/72/full.sql.postgres +8 -0
  542. synapse/storage/schema/common/full_schemas/72/full.sql.sqlite +6 -0
  543. synapse/storage/schema/common/schema_version.sql +60 -0
  544. synapse/storage/schema/main/delta/12/v12.sql +82 -0
  545. synapse/storage/schema/main/delta/13/v13.sql +38 -0
  546. synapse/storage/schema/main/delta/14/v14.sql +42 -0
  547. synapse/storage/schema/main/delta/15/appservice_txns.sql +50 -0
  548. synapse/storage/schema/main/delta/15/presence_indices.sql +2 -0
  549. synapse/storage/schema/main/delta/15/v15.sql +24 -0
  550. synapse/storage/schema/main/delta/16/events_order_index.sql +4 -0
  551. synapse/storage/schema/main/delta/16/remote_media_cache_index.sql +2 -0
  552. synapse/storage/schema/main/delta/16/remove_duplicates.sql +9 -0
  553. synapse/storage/schema/main/delta/16/room_alias_index.sql +3 -0
  554. synapse/storage/schema/main/delta/16/unique_constraints.sql +72 -0
  555. synapse/storage/schema/main/delta/16/users.sql +56 -0
  556. synapse/storage/schema/main/delta/17/drop_indexes.sql +37 -0
  557. synapse/storage/schema/main/delta/17/server_keys.sql +43 -0
  558. synapse/storage/schema/main/delta/17/user_threepids.sql +9 -0
  559. synapse/storage/schema/main/delta/18/server_keys_bigger_ints.sql +51 -0
  560. synapse/storage/schema/main/delta/19/event_index.sql +38 -0
  561. synapse/storage/schema/main/delta/20/dummy.sql +1 -0
  562. synapse/storage/schema/main/delta/20/pushers.py +93 -0
  563. synapse/storage/schema/main/delta/21/end_to_end_keys.sql +53 -0
  564. synapse/storage/schema/main/delta/21/receipts.sql +57 -0
  565. synapse/storage/schema/main/delta/22/receipts_index.sql +41 -0
  566. synapse/storage/schema/main/delta/22/user_threepids_unique.sql +19 -0
  567. synapse/storage/schema/main/delta/24/stats_reporting.sql +37 -0
  568. synapse/storage/schema/main/delta/25/fts.py +81 -0
  569. synapse/storage/schema/main/delta/25/guest_access.sql +44 -0
  570. synapse/storage/schema/main/delta/25/history_visibility.sql +44 -0
  571. synapse/storage/schema/main/delta/25/tags.sql +57 -0
  572. synapse/storage/schema/main/delta/26/account_data.sql +36 -0
  573. synapse/storage/schema/main/delta/27/account_data.sql +55 -0
  574. synapse/storage/schema/main/delta/27/forgotten_memberships.sql +45 -0
  575. synapse/storage/schema/main/delta/27/ts.py +61 -0
  576. synapse/storage/schema/main/delta/28/event_push_actions.sql +46 -0
  577. synapse/storage/schema/main/delta/28/events_room_stream.sql +39 -0
  578. synapse/storage/schema/main/delta/28/public_roms_index.sql +39 -0
  579. synapse/storage/schema/main/delta/28/receipts_user_id_index.sql +41 -0
  580. synapse/storage/schema/main/delta/28/upgrade_times.sql +40 -0
  581. synapse/storage/schema/main/delta/28/users_is_guest.sql +41 -0
  582. synapse/storage/schema/main/delta/29/push_actions.sql +54 -0
  583. synapse/storage/schema/main/delta/30/alias_creator.sql +35 -0
  584. synapse/storage/schema/main/delta/30/as_users.py +82 -0
  585. synapse/storage/schema/main/delta/30/deleted_pushers.sql +44 -0
  586. synapse/storage/schema/main/delta/30/presence_stream.sql +49 -0
  587. synapse/storage/schema/main/delta/30/public_rooms.sql +42 -0
  588. synapse/storage/schema/main/delta/30/push_rule_stream.sql +57 -0
  589. synapse/storage/schema/main/delta/30/threepid_guest_access_tokens.sql +43 -0
  590. synapse/storage/schema/main/delta/31/invites.sql +61 -0
  591. synapse/storage/schema/main/delta/31/local_media_repository_url_cache.sql +46 -0
  592. synapse/storage/schema/main/delta/31/pushers_0.py +92 -0
  593. synapse/storage/schema/main/delta/31/pushers_index.sql +41 -0
  594. synapse/storage/schema/main/delta/31/search_update.py +65 -0
  595. synapse/storage/schema/main/delta/32/events.sql +35 -0
  596. synapse/storage/schema/main/delta/32/openid.sql +9 -0
  597. synapse/storage/schema/main/delta/32/pusher_throttle.sql +42 -0
  598. synapse/storage/schema/main/delta/32/remove_indices.sql +52 -0
  599. synapse/storage/schema/main/delta/32/reports.sql +44 -0
  600. synapse/storage/schema/main/delta/33/access_tokens_device_index.sql +36 -0
  601. synapse/storage/schema/main/delta/33/devices.sql +40 -0
  602. synapse/storage/schema/main/delta/33/devices_for_e2e_keys.sql +38 -0
  603. synapse/storage/schema/main/delta/33/devices_for_e2e_keys_clear_unknown_device.sql +39 -0
  604. synapse/storage/schema/main/delta/33/event_fields.py +61 -0
  605. synapse/storage/schema/main/delta/33/remote_media_ts.py +43 -0
  606. synapse/storage/schema/main/delta/33/user_ips_index.sql +36 -0
  607. synapse/storage/schema/main/delta/34/appservice_stream.sql +42 -0
  608. synapse/storage/schema/main/delta/34/cache_stream.py +50 -0
  609. synapse/storage/schema/main/delta/34/device_inbox.sql +43 -0
  610. synapse/storage/schema/main/delta/34/push_display_name_rename.sql +39 -0
  611. synapse/storage/schema/main/delta/34/received_txn_purge.py +36 -0
  612. synapse/storage/schema/main/delta/35/contains_url.sql +36 -0
  613. synapse/storage/schema/main/delta/35/device_outbox.sql +58 -0
  614. synapse/storage/schema/main/delta/35/device_stream_id.sql +40 -0
  615. synapse/storage/schema/main/delta/35/event_push_actions_index.sql +36 -0
  616. synapse/storage/schema/main/delta/35/public_room_list_change_stream.sql +52 -0
  617. synapse/storage/schema/main/delta/35/stream_order_to_extrem.sql +56 -0
  618. synapse/storage/schema/main/delta/36/readd_public_rooms.sql +45 -0
  619. synapse/storage/schema/main/delta/37/remove_auth_idx.py +89 -0
  620. synapse/storage/schema/main/delta/37/user_threepids.sql +71 -0
  621. synapse/storage/schema/main/delta/38/postgres_fts_gist.sql +38 -0
  622. synapse/storage/schema/main/delta/39/appservice_room_list.sql +48 -0
  623. synapse/storage/schema/main/delta/39/device_federation_stream_idx.sql +35 -0
  624. synapse/storage/schema/main/delta/39/event_push_index.sql +36 -0
  625. synapse/storage/schema/main/delta/39/federation_out_position.sql +41 -0
  626. synapse/storage/schema/main/delta/39/membership_profile.sql +39 -0
  627. synapse/storage/schema/main/delta/40/current_state_idx.sql +36 -0
  628. synapse/storage/schema/main/delta/40/device_inbox.sql +40 -0
  629. synapse/storage/schema/main/delta/40/device_list_streams.sql +79 -0
  630. synapse/storage/schema/main/delta/40/event_push_summary.sql +57 -0
  631. synapse/storage/schema/main/delta/40/pushers.sql +58 -0
  632. synapse/storage/schema/main/delta/41/device_list_stream_idx.sql +36 -0
  633. synapse/storage/schema/main/delta/41/device_outbound_index.sql +35 -0
  634. synapse/storage/schema/main/delta/41/event_search_event_id_idx.sql +36 -0
  635. synapse/storage/schema/main/delta/41/ratelimit.sql +41 -0
  636. synapse/storage/schema/main/delta/42/current_state_delta.sql +48 -0
  637. synapse/storage/schema/main/delta/42/device_list_last_id.sql +52 -0
  638. synapse/storage/schema/main/delta/42/event_auth_state_only.sql +36 -0
  639. synapse/storage/schema/main/delta/42/user_dir.py +88 -0
  640. synapse/storage/schema/main/delta/43/blocked_rooms.sql +40 -0
  641. synapse/storage/schema/main/delta/43/quarantine_media.sql +36 -0
  642. synapse/storage/schema/main/delta/43/url_cache.sql +35 -0
  643. synapse/storage/schema/main/delta/43/user_share.sql +52 -0
  644. synapse/storage/schema/main/delta/44/expire_url_cache.sql +60 -0
  645. synapse/storage/schema/main/delta/45/group_server.sql +186 -0
  646. synapse/storage/schema/main/delta/45/profile_cache.sql +47 -0
  647. synapse/storage/schema/main/delta/46/drop_refresh_tokens.sql +36 -0
  648. synapse/storage/schema/main/delta/46/drop_unique_deleted_pushers.sql +54 -0
  649. synapse/storage/schema/main/delta/46/group_server.sql +51 -0
  650. synapse/storage/schema/main/delta/46/local_media_repository_url_idx.sql +43 -0
  651. synapse/storage/schema/main/delta/46/user_dir_null_room_ids.sql +54 -0
  652. synapse/storage/schema/main/delta/46/user_dir_typos.sql +43 -0
  653. synapse/storage/schema/main/delta/47/last_access_media.sql +35 -0
  654. synapse/storage/schema/main/delta/47/postgres_fts_gin.sql +36 -0
  655. synapse/storage/schema/main/delta/47/push_actions_staging.sql +47 -0
  656. synapse/storage/schema/main/delta/48/add_user_consent.sql +37 -0
  657. synapse/storage/schema/main/delta/48/add_user_ips_last_seen_index.sql +36 -0
  658. synapse/storage/schema/main/delta/48/deactivated_users.sql +44 -0
  659. synapse/storage/schema/main/delta/48/group_unique_indexes.py +67 -0
  660. synapse/storage/schema/main/delta/48/groups_joinable.sql +41 -0
  661. synapse/storage/schema/main/delta/49/add_user_consent_server_notice_sent.sql +39 -0
  662. synapse/storage/schema/main/delta/49/add_user_daily_visits.sql +40 -0
  663. synapse/storage/schema/main/delta/49/add_user_ips_last_seen_only_index.sql +36 -0
  664. synapse/storage/schema/main/delta/50/add_creation_ts_users_index.sql +38 -0
  665. synapse/storage/schema/main/delta/50/erasure_store.sql +40 -0
  666. synapse/storage/schema/main/delta/50/make_event_content_nullable.py +102 -0
  667. synapse/storage/schema/main/delta/51/e2e_room_keys.sql +58 -0
  668. synapse/storage/schema/main/delta/51/monthly_active_users.sql +46 -0
  669. synapse/storage/schema/main/delta/52/add_event_to_state_group_index.sql +38 -0
  670. synapse/storage/schema/main/delta/52/device_list_streams_unique_idx.sql +55 -0
  671. synapse/storage/schema/main/delta/52/e2e_room_keys.sql +72 -0
  672. synapse/storage/schema/main/delta/53/add_user_type_to_users.sql +38 -0
  673. synapse/storage/schema/main/delta/53/drop_sent_transactions.sql +35 -0
  674. synapse/storage/schema/main/delta/53/event_format_version.sql +35 -0
  675. synapse/storage/schema/main/delta/53/user_dir_populate.sql +49 -0
  676. synapse/storage/schema/main/delta/53/user_ips_index.sql +49 -0
  677. synapse/storage/schema/main/delta/53/user_share.sql +63 -0
  678. synapse/storage/schema/main/delta/53/user_threepid_id.sql +48 -0
  679. synapse/storage/schema/main/delta/53/users_in_public_rooms.sql +47 -0
  680. synapse/storage/schema/main/delta/54/account_validity_with_renewal.sql +49 -0
  681. synapse/storage/schema/main/delta/54/add_validity_to_server_keys.sql +42 -0
  682. synapse/storage/schema/main/delta/54/delete_forward_extremities.sql +42 -0
  683. synapse/storage/schema/main/delta/54/drop_legacy_tables.sql +49 -0
  684. synapse/storage/schema/main/delta/54/drop_presence_list.sql +35 -0
  685. synapse/storage/schema/main/delta/54/relations.sql +46 -0
  686. synapse/storage/schema/main/delta/54/stats.sql +99 -0
  687. synapse/storage/schema/main/delta/54/stats2.sql +47 -0
  688. synapse/storage/schema/main/delta/55/access_token_expiry.sql +37 -0
  689. synapse/storage/schema/main/delta/55/track_threepid_validations.sql +50 -0
  690. synapse/storage/schema/main/delta/55/users_alter_deactivated.sql +38 -0
  691. synapse/storage/schema/main/delta/56/add_spans_to_device_lists.sql +39 -0
  692. synapse/storage/schema/main/delta/56/current_state_events_membership.sql +41 -0
  693. synapse/storage/schema/main/delta/56/current_state_events_membership_mk2.sql +43 -0
  694. synapse/storage/schema/main/delta/56/delete_keys_from_deleted_backups.sql +44 -0
  695. synapse/storage/schema/main/delta/56/destinations_failure_ts.sql +44 -0
  696. synapse/storage/schema/main/delta/56/destinations_retry_interval_type.sql.postgres +18 -0
  697. synapse/storage/schema/main/delta/56/device_stream_id_insert.sql +39 -0
  698. synapse/storage/schema/main/delta/56/devices_last_seen.sql +43 -0
  699. synapse/storage/schema/main/delta/56/drop_unused_event_tables.sql +39 -0
  700. synapse/storage/schema/main/delta/56/event_expiry.sql +40 -0
  701. synapse/storage/schema/main/delta/56/event_labels.sql +49 -0
  702. synapse/storage/schema/main/delta/56/event_labels_background_update.sql +36 -0
  703. synapse/storage/schema/main/delta/56/fix_room_keys_index.sql +37 -0
  704. synapse/storage/schema/main/delta/56/hidden_devices.sql +37 -0
  705. synapse/storage/schema/main/delta/56/hidden_devices_fix.sql.sqlite +42 -0
  706. synapse/storage/schema/main/delta/56/nuke_empty_communities_from_db.sql +48 -0
  707. synapse/storage/schema/main/delta/56/public_room_list_idx.sql +35 -0
  708. synapse/storage/schema/main/delta/56/redaction_censor.sql +35 -0
  709. synapse/storage/schema/main/delta/56/redaction_censor2.sql +41 -0
  710. synapse/storage/schema/main/delta/56/redaction_censor3_fix_update.sql.postgres +25 -0
  711. synapse/storage/schema/main/delta/56/redaction_censor4.sql +35 -0
  712. synapse/storage/schema/main/delta/56/remove_tombstoned_rooms_from_directory.sql +38 -0
  713. synapse/storage/schema/main/delta/56/room_key_etag.sql +36 -0
  714. synapse/storage/schema/main/delta/56/room_membership_idx.sql +37 -0
  715. synapse/storage/schema/main/delta/56/room_retention.sql +52 -0
  716. synapse/storage/schema/main/delta/56/signing_keys.sql +75 -0
  717. synapse/storage/schema/main/delta/56/signing_keys_nonunique_signatures.sql +41 -0
  718. synapse/storage/schema/main/delta/56/stats_separated.sql +175 -0
  719. synapse/storage/schema/main/delta/56/unique_user_filter_index.py +46 -0
  720. synapse/storage/schema/main/delta/56/user_external_ids.sql +43 -0
  721. synapse/storage/schema/main/delta/56/users_in_public_rooms_idx.sql +36 -0
  722. synapse/storage/schema/main/delta/57/delete_old_current_state_events.sql +41 -0
  723. synapse/storage/schema/main/delta/57/device_list_remote_cache_stale.sql +44 -0
  724. synapse/storage/schema/main/delta/57/local_current_membership.py +111 -0
  725. synapse/storage/schema/main/delta/57/remove_sent_outbound_pokes.sql +40 -0
  726. synapse/storage/schema/main/delta/57/rooms_version_column.sql +43 -0
  727. synapse/storage/schema/main/delta/57/rooms_version_column_2.sql.postgres +35 -0
  728. synapse/storage/schema/main/delta/57/rooms_version_column_2.sql.sqlite +22 -0
  729. synapse/storage/schema/main/delta/57/rooms_version_column_3.sql.postgres +39 -0
  730. synapse/storage/schema/main/delta/57/rooms_version_column_3.sql.sqlite +23 -0
  731. synapse/storage/schema/main/delta/58/02remove_dup_outbound_pokes.sql +41 -0
  732. synapse/storage/schema/main/delta/58/03persist_ui_auth.sql +55 -0
  733. synapse/storage/schema/main/delta/58/05cache_instance.sql.postgres +30 -0
  734. synapse/storage/schema/main/delta/58/06dlols_unique_idx.py +83 -0
  735. synapse/storage/schema/main/delta/58/07add_method_to_thumbnail_constraint.sql.postgres +33 -0
  736. synapse/storage/schema/main/delta/58/07add_method_to_thumbnail_constraint.sql.sqlite +44 -0
  737. synapse/storage/schema/main/delta/58/07persist_ui_auth_ips.sql +44 -0
  738. synapse/storage/schema/main/delta/58/08_media_safe_from_quarantine.sql.postgres +18 -0
  739. synapse/storage/schema/main/delta/58/08_media_safe_from_quarantine.sql.sqlite +18 -0
  740. synapse/storage/schema/main/delta/58/09shadow_ban.sql +37 -0
  741. synapse/storage/schema/main/delta/58/10_pushrules_enabled_delete_obsolete.sql +47 -0
  742. synapse/storage/schema/main/delta/58/10drop_local_rejections_stream.sql +41 -0
  743. synapse/storage/schema/main/delta/58/10federation_pos_instance_name.sql +41 -0
  744. synapse/storage/schema/main/delta/58/11dehydration.sql +39 -0
  745. synapse/storage/schema/main/delta/58/11fallback.sql +43 -0
  746. synapse/storage/schema/main/delta/58/11user_id_seq.py +38 -0
  747. synapse/storage/schema/main/delta/58/12room_stats.sql +51 -0
  748. synapse/storage/schema/main/delta/58/13remove_presence_allow_inbound.sql +36 -0
  749. synapse/storage/schema/main/delta/58/14events_instance_name.sql +35 -0
  750. synapse/storage/schema/main/delta/58/14events_instance_name.sql.postgres +28 -0
  751. synapse/storage/schema/main/delta/58/15_catchup_destination_rooms.sql +61 -0
  752. synapse/storage/schema/main/delta/58/15unread_count.sql +45 -0
  753. synapse/storage/schema/main/delta/58/16populate_stats_process_rooms_fix.sql +41 -0
  754. synapse/storage/schema/main/delta/58/17_catchup_last_successful.sql +40 -0
  755. synapse/storage/schema/main/delta/58/18stream_positions.sql +41 -0
  756. synapse/storage/schema/main/delta/58/19instance_map.sql.postgres +25 -0
  757. synapse/storage/schema/main/delta/58/19txn_id.sql +59 -0
  758. synapse/storage/schema/main/delta/58/20instance_name_event_tables.sql +36 -0
  759. synapse/storage/schema/main/delta/58/20user_daily_visits.sql +37 -0
  760. synapse/storage/schema/main/delta/58/21as_device_stream.sql +36 -0
  761. synapse/storage/schema/main/delta/58/21drop_device_max_stream_id.sql +1 -0
  762. synapse/storage/schema/main/delta/58/22puppet_token.sql +36 -0
  763. synapse/storage/schema/main/delta/58/22users_have_local_media.sql +2 -0
  764. synapse/storage/schema/main/delta/58/23e2e_cross_signing_keys_idx.sql +36 -0
  765. synapse/storage/schema/main/delta/58/24drop_event_json_index.sql +38 -0
  766. synapse/storage/schema/main/delta/58/25user_external_ids_user_id_idx.sql +36 -0
  767. synapse/storage/schema/main/delta/58/26access_token_last_validated.sql +37 -0
  768. synapse/storage/schema/main/delta/58/27local_invites.sql +37 -0
  769. synapse/storage/schema/main/delta/58/28drop_last_used_column.sql.postgres +16 -0
  770. synapse/storage/schema/main/delta/58/28drop_last_used_column.sql.sqlite +62 -0
  771. synapse/storage/schema/main/delta/59/01ignored_user.py +85 -0
  772. synapse/storage/schema/main/delta/59/02shard_send_to_device.sql +37 -0
  773. synapse/storage/schema/main/delta/59/03shard_send_to_device_sequence.sql.postgres +25 -0
  774. synapse/storage/schema/main/delta/59/04_event_auth_chains.sql +71 -0
  775. synapse/storage/schema/main/delta/59/04_event_auth_chains.sql.postgres +16 -0
  776. synapse/storage/schema/main/delta/59/04drop_account_data.sql +36 -0
  777. synapse/storage/schema/main/delta/59/05cache_invalidation.sql +36 -0
  778. synapse/storage/schema/main/delta/59/06chain_cover_index.sql +36 -0
  779. synapse/storage/schema/main/delta/59/06shard_account_data.sql +39 -0
  780. synapse/storage/schema/main/delta/59/06shard_account_data.sql.postgres +32 -0
  781. synapse/storage/schema/main/delta/59/07shard_account_data_fix.sql +37 -0
  782. synapse/storage/schema/main/delta/59/08delete_pushers_for_deactivated_accounts.sql +39 -0
  783. synapse/storage/schema/main/delta/59/08delete_stale_pushers.sql +39 -0
  784. synapse/storage/schema/main/delta/59/09rejected_events_metadata.sql +45 -0
  785. synapse/storage/schema/main/delta/59/10delete_purged_chain_cover.sql +36 -0
  786. synapse/storage/schema/main/delta/59/11add_knock_members_to_stats.sql +39 -0
  787. synapse/storage/schema/main/delta/59/11drop_thumbnail_constraint.sql.postgres +22 -0
  788. synapse/storage/schema/main/delta/59/12account_validity_token_used_ts_ms.sql +37 -0
  789. synapse/storage/schema/main/delta/59/12presence_stream_instance.sql +37 -0
  790. synapse/storage/schema/main/delta/59/12presence_stream_instance_seq.sql.postgres +20 -0
  791. synapse/storage/schema/main/delta/59/13users_to_send_full_presence_to.sql +53 -0
  792. synapse/storage/schema/main/delta/59/14refresh_tokens.sql +53 -0
  793. synapse/storage/schema/main/delta/59/15locks.sql +56 -0
  794. synapse/storage/schema/main/delta/59/16federation_inbound_staging.sql +51 -0
  795. synapse/storage/schema/main/delta/60/01recreate_stream_ordering.sql.postgres +45 -0
  796. synapse/storage/schema/main/delta/60/02change_stream_ordering_columns.sql.postgres +30 -0
  797. synapse/storage/schema/main/delta/61/01change_appservices_txns.sql.postgres +23 -0
  798. synapse/storage/schema/main/delta/61/01insertion_event_lookups.sql +68 -0
  799. synapse/storage/schema/main/delta/61/02drop_redundant_room_depth_index.sql +37 -0
  800. synapse/storage/schema/main/delta/61/03recreate_min_depth.py +74 -0
  801. synapse/storage/schema/main/delta/62/01insertion_event_extremities.sql +43 -0
  802. synapse/storage/schema/main/delta/63/01create_registration_tokens.sql +42 -0
  803. synapse/storage/schema/main/delta/63/02delete_unlinked_email_pushers.sql +39 -0
  804. synapse/storage/schema/main/delta/63/02populate-rooms-creator.sql +36 -0
  805. synapse/storage/schema/main/delta/63/03session_store.sql +42 -0
  806. synapse/storage/schema/main/delta/63/04add_presence_stream_not_offline_index.sql +37 -0
  807. synapse/storage/schema/main/delta/64/01msc2716_chunk_to_batch_rename.sql.postgres +23 -0
  808. synapse/storage/schema/main/delta/64/01msc2716_chunk_to_batch_rename.sql.sqlite +37 -0
  809. synapse/storage/schema/main/delta/65/01msc2716_insertion_event_edges.sql +38 -0
  810. synapse/storage/schema/main/delta/65/03remove_hidden_devices_from_device_inbox.sql +41 -0
  811. synapse/storage/schema/main/delta/65/04_local_group_updates.sql +37 -0
  812. synapse/storage/schema/main/delta/65/05_remove_room_stats_historical_and_user_stats_historical.sql +38 -0
  813. synapse/storage/schema/main/delta/65/06remove_deleted_devices_from_device_inbox.sql +53 -0
  814. synapse/storage/schema/main/delta/65/07_arbitrary_relations.sql +37 -0
  815. synapse/storage/schema/main/delta/65/08_device_inbox_background_updates.sql +37 -0
  816. synapse/storage/schema/main/delta/65/10_expirable_refresh_tokens.sql +47 -0
  817. synapse/storage/schema/main/delta/65/11_devices_auth_provider_session.sql +46 -0
  818. synapse/storage/schema/main/delta/67/01drop_public_room_list_stream.sql +37 -0
  819. synapse/storage/schema/main/delta/68/01event_columns.sql +45 -0
  820. synapse/storage/schema/main/delta/68/02_msc2409_add_device_id_appservice_stream_type.sql +40 -0
  821. synapse/storage/schema/main/delta/68/03_delete_account_data_for_deactivated_accounts.sql +39 -0
  822. synapse/storage/schema/main/delta/68/04_refresh_tokens_index_next_token_id.sql +47 -0
  823. synapse/storage/schema/main/delta/68/04partial_state_rooms.sql +60 -0
  824. synapse/storage/schema/main/delta/68/05_delete_non_strings_from_event_search.sql.sqlite +22 -0
  825. synapse/storage/schema/main/delta/68/05partial_state_rooms_triggers.py +80 -0
  826. synapse/storage/schema/main/delta/68/06_msc3202_add_device_list_appservice_stream_type.sql +42 -0
  827. synapse/storage/schema/main/delta/69/01as_txn_seq.py +54 -0
  828. synapse/storage/schema/main/delta/69/01device_list_oubound_by_room.sql +57 -0
  829. synapse/storage/schema/main/delta/69/02cache_invalidation_index.sql +37 -0
  830. synapse/storage/schema/main/delta/70/01clean_table_purged_rooms.sql +39 -0
  831. synapse/storage/schema/main/delta/71/01rebuild_event_edges.sql.postgres +43 -0
  832. synapse/storage/schema/main/delta/71/01rebuild_event_edges.sql.sqlite +47 -0
  833. synapse/storage/schema/main/delta/71/01remove_noop_background_updates.sql +80 -0
  834. synapse/storage/schema/main/delta/71/02event_push_summary_unique.sql +37 -0
  835. synapse/storage/schema/main/delta/72/01add_room_type_to_state_stats.sql +38 -0
  836. synapse/storage/schema/main/delta/72/01event_push_summary_receipt.sql +54 -0
  837. synapse/storage/schema/main/delta/72/02event_push_actions_index.sql +38 -0
  838. synapse/storage/schema/main/delta/72/03bg_populate_events_columns.py +57 -0
  839. synapse/storage/schema/main/delta/72/03drop_event_reference_hashes.sql +36 -0
  840. synapse/storage/schema/main/delta/72/03remove_groups.sql +50 -0
  841. synapse/storage/schema/main/delta/72/04drop_column_application_services_state_last_txn.sql.postgres +17 -0
  842. synapse/storage/schema/main/delta/72/04drop_column_application_services_state_last_txn.sql.sqlite +40 -0
  843. synapse/storage/schema/main/delta/72/05receipts_event_stream_ordering.sql +38 -0
  844. synapse/storage/schema/main/delta/72/05remove_unstable_private_read_receipts.sql +38 -0
  845. synapse/storage/schema/main/delta/72/06add_consent_ts_to_users.sql +35 -0
  846. synapse/storage/schema/main/delta/72/06thread_notifications.sql +49 -0
  847. synapse/storage/schema/main/delta/72/07force_update_current_state_events_membership.py +67 -0
  848. synapse/storage/schema/main/delta/72/07thread_receipts.sql.postgres +30 -0
  849. synapse/storage/schema/main/delta/72/07thread_receipts.sql.sqlite +70 -0
  850. synapse/storage/schema/main/delta/72/08begin_cache_invalidation_seq_at_2.sql.postgres +23 -0
  851. synapse/storage/schema/main/delta/72/08thread_receipts.sql +39 -0
  852. synapse/storage/schema/main/delta/72/09partial_indices.sql.sqlite +56 -0
  853. synapse/storage/schema/main/delta/73/01event_failed_pull_attempts.sql +48 -0
  854. synapse/storage/schema/main/delta/73/02add_pusher_enabled.sql +35 -0
  855. synapse/storage/schema/main/delta/73/02room_id_indexes_for_purging.sql +41 -0
  856. synapse/storage/schema/main/delta/73/03pusher_device_id.sql +39 -0
  857. synapse/storage/schema/main/delta/73/03users_approved_column.sql +39 -0
  858. synapse/storage/schema/main/delta/73/04partial_join_details.sql +42 -0
  859. synapse/storage/schema/main/delta/73/04pending_device_list_updates.sql +47 -0
  860. synapse/storage/schema/main/delta/73/05old_push_actions.sql.postgres +22 -0
  861. synapse/storage/schema/main/delta/73/05old_push_actions.sql.sqlite +24 -0
  862. synapse/storage/schema/main/delta/73/06thread_notifications_thread_id_idx.sql +42 -0
  863. synapse/storage/schema/main/delta/73/08thread_receipts_non_null.sql.postgres +23 -0
  864. synapse/storage/schema/main/delta/73/08thread_receipts_non_null.sql.sqlite +76 -0
  865. synapse/storage/schema/main/delta/73/09partial_joined_via_destination.sql +37 -0
  866. synapse/storage/schema/main/delta/73/09threads_table.sql +49 -0
  867. synapse/storage/schema/main/delta/73/10_update_sqlite_fts4_tokenizer.py +71 -0
  868. synapse/storage/schema/main/delta/73/10login_tokens.sql +54 -0
  869. synapse/storage/schema/main/delta/73/11event_search_room_id_n_distinct.sql.postgres +33 -0
  870. synapse/storage/schema/main/delta/73/12refactor_device_list_outbound_pokes.sql +72 -0
  871. synapse/storage/schema/main/delta/73/13add_device_lists_index.sql +39 -0
  872. synapse/storage/schema/main/delta/73/20_un_partial_stated_room_stream.sql +51 -0
  873. synapse/storage/schema/main/delta/73/21_un_partial_stated_room_stream_seq.sql.postgres +20 -0
  874. synapse/storage/schema/main/delta/73/22_rebuild_user_dir_stats.sql +48 -0
  875. synapse/storage/schema/main/delta/73/22_un_partial_stated_event_stream.sql +53 -0
  876. synapse/storage/schema/main/delta/73/23_fix_thread_index.sql +52 -0
  877. synapse/storage/schema/main/delta/73/23_un_partial_stated_room_stream_seq.sql.postgres +20 -0
  878. synapse/storage/schema/main/delta/73/24_events_jump_to_date_index.sql +36 -0
  879. synapse/storage/schema/main/delta/73/25drop_presence.sql +36 -0
  880. synapse/storage/schema/main/delta/74/01_user_directory_stale_remote_users.sql +58 -0
  881. synapse/storage/schema/main/delta/74/02_set_device_id_for_pushers_bg_update.sql +38 -0
  882. synapse/storage/schema/main/delta/74/03_membership_tables_event_stream_ordering.sql.postgres +29 -0
  883. synapse/storage/schema/main/delta/74/03_membership_tables_event_stream_ordering.sql.sqlite +23 -0
  884. synapse/storage/schema/main/delta/74/03_room_membership_index.sql +38 -0
  885. synapse/storage/schema/main/delta/74/04_delete_e2e_backup_keys_for_deactivated_users.sql +36 -0
  886. synapse/storage/schema/main/delta/74/04_membership_tables_event_stream_ordering_triggers.py +87 -0
  887. synapse/storage/schema/main/delta/74/05_events_txn_id_device_id.sql +72 -0
  888. synapse/storage/schema/main/delta/74/90COMMENTS_destinations.sql.postgres +52 -0
  889. synapse/storage/schema/main/delta/76/01_add_profiles_full_user_id_column.sql +39 -0
  890. synapse/storage/schema/main/delta/76/02_add_user_filters_full_user_id_column.sql +39 -0
  891. synapse/storage/schema/main/delta/76/03_per_user_experimental_features.sql +46 -0
  892. synapse/storage/schema/main/delta/76/04_add_room_forgetter.sql +43 -0
  893. synapse/storage/schema/main/delta/77/01_add_profiles_not_valid_check.sql.postgres +16 -0
  894. synapse/storage/schema/main/delta/77/02_add_user_filters_not_valid_check.sql.postgres +16 -0
  895. synapse/storage/schema/main/delta/77/03bg_populate_full_user_id_profiles.sql +35 -0
  896. synapse/storage/schema/main/delta/77/04bg_populate_full_user_id_user_filters.sql +35 -0
  897. synapse/storage/schema/main/delta/77/05thread_notifications_backfill.sql +67 -0
  898. synapse/storage/schema/main/delta/77/06thread_notifications_not_null.sql.sqlite +102 -0
  899. synapse/storage/schema/main/delta/77/06thread_notifications_not_null_event_push_actions.sql.postgres +27 -0
  900. synapse/storage/schema/main/delta/77/06thread_notifications_not_null_event_push_actions_staging.sql.postgres +27 -0
  901. synapse/storage/schema/main/delta/77/06thread_notifications_not_null_event_push_summary.sql.postgres +29 -0
  902. synapse/storage/schema/main/delta/77/14bg_indices_event_stream_ordering.sql +39 -0
  903. synapse/storage/schema/main/delta/78/01_validate_and_update_profiles.py +99 -0
  904. synapse/storage/schema/main/delta/78/02_validate_and_update_user_filters.py +100 -0
  905. synapse/storage/schema/main/delta/78/03_remove_unused_indexes_user_filters.py +72 -0
  906. synapse/storage/schema/main/delta/78/03event_extremities_constraints.py +65 -0
  907. synapse/storage/schema/main/delta/78/04_add_full_user_id_index_user_filters.py +32 -0
  908. synapse/storage/schema/main/delta/79/03_read_write_locks_triggers.sql.postgres +102 -0
  909. synapse/storage/schema/main/delta/79/03_read_write_locks_triggers.sql.sqlite +72 -0
  910. synapse/storage/schema/main/delta/79/04_mitigate_stream_ordering_update_race.py +70 -0
  911. synapse/storage/schema/main/delta/79/05_read_write_locks_triggers.sql.postgres +69 -0
  912. synapse/storage/schema/main/delta/79/05_read_write_locks_triggers.sql.sqlite +65 -0
  913. synapse/storage/schema/main/delta/80/01_users_alter_locked.sql +35 -0
  914. synapse/storage/schema/main/delta/80/02_read_write_locks_unlogged.sql.postgres +30 -0
  915. synapse/storage/schema/main/delta/80/02_scheduled_tasks.sql +47 -0
  916. synapse/storage/schema/main/delta/80/03_read_write_locks_triggers.sql.postgres +37 -0
  917. synapse/storage/schema/main/delta/80/04_read_write_locks_deadlock.sql.postgres +71 -0
  918. synapse/storage/schema/main/delta/82/02_scheduled_tasks_index.sql +35 -0
  919. synapse/storage/schema/main/delta/82/04_add_indices_for_purging_rooms.sql +39 -0
  920. synapse/storage/schema/main/delta/82/05gaps.sql +44 -0
  921. synapse/storage/schema/main/delta/83/01_drop_old_tables.sql +43 -0
  922. synapse/storage/schema/main/delta/83/03_instance_name_receipts.sql.sqlite +17 -0
  923. synapse/storage/schema/main/delta/83/05_cross_signing_key_update_grant.sql +34 -0
  924. synapse/storage/schema/main/delta/83/06_event_push_summary_room.sql +36 -0
  925. synapse/storage/schema/main/delta/84/01_auth_links_stats.sql.postgres +20 -0
  926. synapse/storage/schema/main/delta/84/02_auth_links_index.sql +16 -0
  927. synapse/storage/schema/main/delta/84/03_auth_links_analyze.sql.postgres +16 -0
  928. synapse/storage/schema/main/delta/84/04_access_token_index.sql +15 -0
  929. synapse/storage/schema/main/delta/85/01_add_suspended.sql +14 -0
  930. synapse/storage/schema/main/delta/85/02_add_instance_names.sql +27 -0
  931. synapse/storage/schema/main/delta/85/03_new_sequences.sql.postgres +54 -0
  932. synapse/storage/schema/main/delta/85/04_cleanup_device_federation_outbox.sql +15 -0
  933. synapse/storage/schema/main/delta/85/05_add_instance_names_converted_pos.sql +16 -0
  934. synapse/storage/schema/main/delta/85/06_add_room_reports.sql +20 -0
  935. synapse/storage/schema/main/delta/86/01_authenticate_media.sql +15 -0
  936. synapse/storage/schema/main/delta/86/02_receipts_event_id_index.sql +15 -0
  937. synapse/storage/schema/main/delta/87/01_sliding_sync_memberships.sql +169 -0
  938. synapse/storage/schema/main/delta/87/02_per_connection_state.sql +81 -0
  939. synapse/storage/schema/main/delta/87/03_current_state_index.sql +19 -0
  940. synapse/storage/schema/main/delta/88/01_add_delayed_events.sql +43 -0
  941. synapse/storage/schema/main/delta/88/01_custom_profile_fields.sql +15 -0
  942. synapse/storage/schema/main/delta/88/02_fix_sliding_sync_membership_snapshots_forgotten_column.sql +21 -0
  943. synapse/storage/schema/main/delta/88/03_add_otk_ts_added_index.sql +18 -0
  944. synapse/storage/schema/main/delta/88/04_current_state_delta_index.sql +18 -0
  945. synapse/storage/schema/main/delta/88/05_drop_old_otks.sql.postgres +19 -0
  946. synapse/storage/schema/main/delta/88/05_drop_old_otks.sql.sqlite +19 -0
  947. synapse/storage/schema/main/delta/88/05_sliding_sync_room_config_index.sql +20 -0
  948. synapse/storage/schema/main/delta/88/06_events_received_ts_index.sql +17 -0
  949. synapse/storage/schema/main/delta/89/01_sliding_sync_membership_snapshot_index.sql +15 -0
  950. synapse/storage/schema/main/delta/90/01_add_column_participant_room_memberships_table.sql +16 -0
  951. synapse/storage/schema/main/delta/91/01_media_hash.sql +28 -0
  952. synapse/storage/schema/main/delta/92/01_remove_trigger.sql.postgres +16 -0
  953. synapse/storage/schema/main/delta/92/01_remove_trigger.sql.sqlite +16 -0
  954. synapse/storage/schema/main/delta/92/02_remove_populate_participant_bg_update.sql +17 -0
  955. synapse/storage/schema/main/delta/92/04_ss_membership_snapshot_idx.sql +16 -0
  956. synapse/storage/schema/main/delta/92/04_thread_subscriptions.sql +59 -0
  957. synapse/storage/schema/main/delta/92/04_thread_subscriptions_seq.sql.postgres +19 -0
  958. synapse/storage/schema/main/delta/92/05_fixup_max_depth_cap.sql +17 -0
  959. synapse/storage/schema/main/delta/92/05_thread_subscriptions_comments.sql.postgres +18 -0
  960. synapse/storage/schema/main/delta/92/06_device_federation_inbox_index.sql +16 -0
  961. synapse/storage/schema/main/delta/92/06_threads_last_sent_stream_ordering_comments.sql.postgres +24 -0
  962. synapse/storage/schema/main/delta/92/07_add_user_reports.sql +22 -0
  963. synapse/storage/schema/main/delta/92/07_event_txn_id_device_id_txn_id2.sql +15 -0
  964. synapse/storage/schema/main/delta/92/08_room_ban_redactions.sql +21 -0
  965. synapse/storage/schema/main/delta/92/08_thread_subscriptions_seq_fixup.sql.postgres +19 -0
  966. synapse/storage/schema/main/delta/92/09_thread_subscriptions_update.sql +20 -0
  967. synapse/storage/schema/main/delta/92/09_thread_subscriptions_update.sql.postgres +18 -0
  968. synapse/storage/schema/main/delta/93/01_add_delayed_events.sql +15 -0
  969. synapse/storage/schema/main/full_schemas/72/full.sql.postgres +1344 -0
  970. synapse/storage/schema/main/full_schemas/72/full.sql.sqlite +646 -0
  971. synapse/storage/schema/state/delta/23/drop_state_index.sql +35 -0
  972. synapse/storage/schema/state/delta/32/remove_state_indices.sql +38 -0
  973. synapse/storage/schema/state/delta/35/add_state_index.sql +36 -0
  974. synapse/storage/schema/state/delta/35/state.sql +41 -0
  975. synapse/storage/schema/state/delta/35/state_dedupe.sql +36 -0
  976. synapse/storage/schema/state/delta/47/state_group_seq.py +38 -0
  977. synapse/storage/schema/state/delta/56/state_group_room_idx.sql +36 -0
  978. synapse/storage/schema/state/delta/61/02state_groups_state_n_distinct.sql.postgres +34 -0
  979. synapse/storage/schema/state/delta/70/08_state_group_edges_unique.sql +36 -0
  980. synapse/storage/schema/state/delta/89/01_state_groups_deletion.sql +39 -0
  981. synapse/storage/schema/state/delta/90/02_delete_unreferenced_state_groups.sql +16 -0
  982. synapse/storage/schema/state/delta/90/03_remove_old_deletion_bg_update.sql +15 -0
  983. synapse/storage/schema/state/full_schemas/72/full.sql.postgres +30 -0
  984. synapse/storage/schema/state/full_schemas/72/full.sql.sqlite +20 -0
  985. synapse/storage/types.py +183 -0
  986. synapse/storage/util/__init__.py +20 -0
  987. synapse/storage/util/id_generators.py +928 -0
  988. synapse/storage/util/partial_state_events_tracker.py +194 -0
  989. synapse/storage/util/sequence.py +315 -0
  990. synapse/streams/__init__.py +43 -0
  991. synapse/streams/config.py +91 -0
  992. synapse/streams/events.py +203 -0
  993. synapse/synapse_rust/__init__.pyi +3 -0
  994. synapse/synapse_rust/acl.pyi +20 -0
  995. synapse/synapse_rust/events.pyi +136 -0
  996. synapse/synapse_rust/http_client.pyi +32 -0
  997. synapse/synapse_rust/push.pyi +86 -0
  998. synapse/synapse_rust/rendezvous.pyi +30 -0
  999. synapse/synapse_rust/segmenter.pyi +1 -0
  1000. synapse/synapse_rust.abi3.so +0 -0
  1001. synapse/types/__init__.py +1600 -0
  1002. synapse/types/handlers/__init__.py +93 -0
  1003. synapse/types/handlers/policy_server.py +16 -0
  1004. synapse/types/handlers/sliding_sync.py +908 -0
  1005. synapse/types/rest/__init__.py +25 -0
  1006. synapse/types/rest/client/__init__.py +413 -0
  1007. synapse/types/state.py +634 -0
  1008. synapse/types/storage/__init__.py +66 -0
  1009. synapse/util/__init__.py +169 -0
  1010. synapse/util/async_helpers.py +1045 -0
  1011. synapse/util/background_queue.py +142 -0
  1012. synapse/util/batching_queue.py +202 -0
  1013. synapse/util/caches/__init__.py +300 -0
  1014. synapse/util/caches/cached_call.py +143 -0
  1015. synapse/util/caches/deferred_cache.py +530 -0
  1016. synapse/util/caches/descriptors.py +692 -0
  1017. synapse/util/caches/dictionary_cache.py +346 -0
  1018. synapse/util/caches/expiringcache.py +249 -0
  1019. synapse/util/caches/lrucache.py +975 -0
  1020. synapse/util/caches/response_cache.py +322 -0
  1021. synapse/util/caches/stream_change_cache.py +370 -0
  1022. synapse/util/caches/treecache.py +189 -0
  1023. synapse/util/caches/ttlcache.py +197 -0
  1024. synapse/util/cancellation.py +63 -0
  1025. synapse/util/check_dependencies.py +335 -0
  1026. synapse/util/clock.py +567 -0
  1027. synapse/util/constants.py +22 -0
  1028. synapse/util/daemonize.py +165 -0
  1029. synapse/util/distributor.py +157 -0
  1030. synapse/util/events.py +134 -0
  1031. synapse/util/file_consumer.py +164 -0
  1032. synapse/util/frozenutils.py +57 -0
  1033. synapse/util/gai_resolver.py +178 -0
  1034. synapse/util/hash.py +38 -0
  1035. synapse/util/httpresourcetree.py +108 -0
  1036. synapse/util/iterutils.py +189 -0
  1037. synapse/util/json.py +56 -0
  1038. synapse/util/linked_list.py +156 -0
  1039. synapse/util/logcontext.py +46 -0
  1040. synapse/util/logformatter.py +28 -0
  1041. synapse/util/macaroons.py +325 -0
  1042. synapse/util/manhole.py +191 -0
  1043. synapse/util/metrics.py +339 -0
  1044. synapse/util/module_loader.py +116 -0
  1045. synapse/util/msisdn.py +51 -0
  1046. synapse/util/patch_inline_callbacks.py +250 -0
  1047. synapse/util/pydantic_models.py +63 -0
  1048. synapse/util/ratelimitutils.py +419 -0
  1049. synapse/util/retryutils.py +339 -0
  1050. synapse/util/rlimit.py +42 -0
  1051. synapse/util/rust.py +133 -0
  1052. synapse/util/sentinel.py +21 -0
  1053. synapse/util/stringutils.py +293 -0
  1054. synapse/util/task_scheduler.py +493 -0
  1055. synapse/util/templates.py +126 -0
  1056. synapse/util/threepids.py +123 -0
  1057. synapse/util/wheel_timer.py +112 -0
  1058. synapse/visibility.py +835 -0
@@ -0,0 +1,2786 @@
1
+ #
2
+ # This file is licensed under the Affero General Public License (AGPL) version 3.
3
+ #
4
+ # Copyright (C) 2023 New Vector, Ltd
5
+ #
6
+ # This program is free software: you can redistribute it and/or modify
7
+ # it under the terms of the GNU Affero General Public License as
8
+ # published by the Free Software Foundation, either version 3 of the
9
+ # License, or (at your option) any later version.
10
+ #
11
+ # See the GNU Affero General Public License for more details:
12
+ # <https://www.gnu.org/licenses/agpl-3.0.html>.
13
+ #
14
+ # Originally licensed under the Apache License, Version 2.0:
15
+ # <http://www.apache.org/licenses/LICENSE-2.0>.
16
+ #
17
+ # [This file includes modifications made by New Vector Limited]
18
+ #
19
+ #
20
+ import json
21
+ import logging
22
+ import threading
23
+ import weakref
24
+ from enum import Enum, auto
25
+ from itertools import chain
26
+ from typing import (
27
+ TYPE_CHECKING,
28
+ Any,
29
+ Collection,
30
+ Iterable,
31
+ Literal,
32
+ Mapping,
33
+ MutableMapping,
34
+ cast,
35
+ overload,
36
+ )
37
+
38
+ import attr
39
+ from prometheus_client import Gauge
40
+
41
+ from twisted.internet import defer
42
+
43
+ from synapse.api.constants import Direction, EventTypes
44
+ from synapse.api.errors import NotFoundError, SynapseError
45
+ from synapse.api.room_versions import (
46
+ KNOWN_ROOM_VERSIONS,
47
+ EventFormatVersions,
48
+ RoomVersion,
49
+ RoomVersions,
50
+ )
51
+ from synapse.events import EventBase, make_event_from_dict
52
+ from synapse.events.snapshot import EventContext
53
+ from synapse.events.utils import prune_event, strip_event
54
+ from synapse.logging.context import (
55
+ PreserveLoggingContext,
56
+ current_context,
57
+ make_deferred_yieldable,
58
+ )
59
+ from synapse.logging.opentracing import (
60
+ SynapseTags,
61
+ set_tag,
62
+ start_active_span,
63
+ tag_args,
64
+ trace,
65
+ )
66
+ from synapse.metrics import SERVER_NAME_LABEL
67
+ from synapse.metrics.background_process_metrics import (
68
+ wrap_as_background_process,
69
+ )
70
+ from synapse.replication.tcp.streams import BackfillStream, UnPartialStatedEventStream
71
+ from synapse.replication.tcp.streams.events import EventsStream
72
+ from synapse.replication.tcp.streams.partial_state import UnPartialStatedEventStreamRow
73
+ from synapse.storage._base import SQLBaseStore, db_to_json, make_in_list_sql_clause
74
+ from synapse.storage.database import (
75
+ DatabasePool,
76
+ LoggingDatabaseConnection,
77
+ LoggingTransaction,
78
+ make_tuple_in_list_sql_clause,
79
+ )
80
+ from synapse.storage.types import Cursor
81
+ from synapse.storage.util.id_generators import (
82
+ AbstractStreamIdGenerator,
83
+ MultiWriterIdGenerator,
84
+ )
85
+ from synapse.storage.util.sequence import build_sequence_generator
86
+ from synapse.types import JsonDict, get_domain_from_id
87
+ from synapse.types.state import StateFilter
88
+ from synapse.types.storage import _BackgroundUpdates
89
+ from synapse.util import unwrapFirstError
90
+ from synapse.util.async_helpers import ObservableDeferred, delay_cancellation
91
+ from synapse.util.caches.descriptors import cached, cachedList
92
+ from synapse.util.caches.lrucache import AsyncLruCache
93
+ from synapse.util.caches.stream_change_cache import StreamChangeCache
94
+ from synapse.util.cancellation import cancellable
95
+ from synapse.util.iterutils import batch_iter
96
+ from synapse.util.metrics import Measure
97
+
98
+ if TYPE_CHECKING:
99
+ from synapse.server import HomeServer
100
+
101
+ logger = logging.getLogger(__name__)
102
+
103
+
104
+ class DatabaseCorruptionError(RuntimeError):
105
+ """We found an event in the DB that has a persisted event ID that doesn't
106
+ match its computed event ID."""
107
+
108
+ def __init__(
109
+ self, room_id: str, persisted_event_id: str, computed_event_id: str
110
+ ) -> None:
111
+ self.room_id = room_id
112
+ self.persisted_event_id = persisted_event_id
113
+ self.computed_event_id = computed_event_id
114
+
115
+ message = (
116
+ f"Database corruption: Event {persisted_event_id} in room {room_id} "
117
+ f"from the database appears to have been modified (calculated "
118
+ f"event id {computed_event_id})"
119
+ )
120
+
121
+ super().__init__(message)
122
+
123
+
124
+ # These values are used in the `enqueue_event` and `_fetch_loop` methods to
125
+ # control how we batch/bulk fetch events from the database.
126
+ # The values are plucked out of thing air to make initial sync run faster
127
+ # on jki.re
128
+ # TODO: Make these configurable.
129
+ EVENT_QUEUE_THREADS = 3 # Max number of threads that will fetch events
130
+ EVENT_QUEUE_ITERATIONS = 3 # No. times we block waiting for requests for events
131
+ EVENT_QUEUE_TIMEOUT_S = 0.1 # Timeout when waiting for requests for events
132
+
133
+
134
+ event_fetch_ongoing_gauge = Gauge(
135
+ "synapse_event_fetch_ongoing",
136
+ "The number of event fetchers that are running",
137
+ labelnames=[SERVER_NAME_LABEL],
138
+ )
139
+
140
+
141
+ class InvalidEventError(Exception):
142
+ """The event retrieved from the database is invalid and cannot be used."""
143
+
144
+
145
+ @attr.s(slots=True, auto_attribs=True)
146
+ class EventCacheEntry:
147
+ event: EventBase
148
+ redacted_event: EventBase | None
149
+
150
+
151
+ @attr.s(slots=True, frozen=True, auto_attribs=True)
152
+ class _EventRow:
153
+ """
154
+ An event, as pulled from the database.
155
+
156
+ Properties:
157
+ event_id: The event ID of the event.
158
+
159
+ stream_ordering: stream ordering for this event
160
+
161
+ json: json-encoded event structure
162
+
163
+ internal_metadata: json-encoded internal metadata dict
164
+
165
+ format_version: The format of the event. Hopefully one of EventFormatVersions.
166
+ 'None' means the event predates EventFormatVersions (so the event is format V1).
167
+
168
+ room_version_id: The version of the room which contains the event. Hopefully
169
+ one of RoomVersions.
170
+
171
+ Due to historical reasons, there may be a few events in the database which
172
+ do not have an associated room; in this case None will be returned here.
173
+
174
+ rejected_reason: if the event was rejected, the reason why.
175
+
176
+ redactions: a list of event-ids which (claim to) redact this event.
177
+
178
+ outlier: True if this event is an outlier.
179
+ """
180
+
181
+ event_id: str
182
+ stream_ordering: int
183
+ instance_name: str
184
+ json: str
185
+ internal_metadata: str
186
+ format_version: int | None
187
+ room_version_id: str | None
188
+ rejected_reason: str | None
189
+ redactions: list[str]
190
+ outlier: bool
191
+
192
+
193
+ @attr.s(slots=True, frozen=True, auto_attribs=True)
194
+ class EventMetadata:
195
+ """Event metadata returned by `get_metadata_for_event(..)`"""
196
+
197
+ sender: str
198
+ received_ts: int
199
+
200
+
201
+ class EventRedactBehaviour(Enum):
202
+ """
203
+ What to do when retrieving a redacted event from the database.
204
+ """
205
+
206
+ as_is = auto()
207
+ redact = auto()
208
+ block = auto()
209
+
210
+
211
+ class EventsWorkerStore(SQLBaseStore):
212
+ # Whether to use dedicated DB threads for event fetching. This is only used
213
+ # if there are multiple DB threads available. When used will lock the DB
214
+ # thread for periods of time (so unit tests want to disable this when they
215
+ # run DB transactions on the main thread). See EVENT_QUEUE_* for more
216
+ # options controlling this.
217
+ USE_DEDICATED_DB_THREADS_FOR_EVENT_FETCHING = True
218
+
219
+ def __init__(
220
+ self,
221
+ database: DatabasePool,
222
+ db_conn: LoggingDatabaseConnection,
223
+ hs: "HomeServer",
224
+ ):
225
+ super().__init__(database, db_conn, hs)
226
+
227
+ self._stream_id_gen: MultiWriterIdGenerator
228
+ self._backfill_id_gen: MultiWriterIdGenerator
229
+
230
+ self._stream_id_gen = MultiWriterIdGenerator(
231
+ db_conn=db_conn,
232
+ db=database,
233
+ notifier=hs.get_replication_notifier(),
234
+ stream_name="events",
235
+ server_name=self.server_name,
236
+ instance_name=hs.get_instance_name(),
237
+ tables=[
238
+ ("events", "instance_name", "stream_ordering"),
239
+ ("current_state_delta_stream", "instance_name", "stream_id"),
240
+ ("ex_outlier_stream", "instance_name", "event_stream_ordering"),
241
+ ],
242
+ sequence_name="events_stream_seq",
243
+ writers=hs.config.worker.writers.events,
244
+ )
245
+ self._backfill_id_gen = MultiWriterIdGenerator(
246
+ db_conn=db_conn,
247
+ db=database,
248
+ notifier=hs.get_replication_notifier(),
249
+ stream_name="backfill",
250
+ server_name=self.server_name,
251
+ instance_name=hs.get_instance_name(),
252
+ tables=[
253
+ ("events", "instance_name", "stream_ordering"),
254
+ ("ex_outlier_stream", "instance_name", "event_stream_ordering"),
255
+ ],
256
+ sequence_name="events_backfill_stream_seq",
257
+ positive=False,
258
+ writers=hs.config.worker.writers.events,
259
+ )
260
+
261
+ events_max = self._stream_id_gen.get_current_token()
262
+ curr_state_delta_prefill, min_curr_state_delta_id = self.db_pool.get_cache_dict(
263
+ db_conn,
264
+ "current_state_delta_stream",
265
+ entity_column="room_id",
266
+ stream_column="stream_id",
267
+ max_value=events_max, # As we share the stream id with events token
268
+ limit=1000,
269
+ )
270
+ self._curr_state_delta_stream_cache: StreamChangeCache = StreamChangeCache(
271
+ name="_curr_state_delta_stream_cache",
272
+ server_name=self.server_name,
273
+ current_stream_pos=min_curr_state_delta_id,
274
+ prefilled_cache=curr_state_delta_prefill,
275
+ )
276
+
277
+ if hs.config.worker.run_background_tasks:
278
+ # We periodically clean out old transaction ID mappings
279
+ self.clock.looping_call(
280
+ self._cleanup_old_transaction_ids,
281
+ 5 * 60 * 1000,
282
+ )
283
+
284
+ self._get_event_cache: AsyncLruCache[tuple[str], EventCacheEntry] = (
285
+ AsyncLruCache(
286
+ clock=hs.get_clock(),
287
+ server_name=self.server_name,
288
+ cache_name="*getEvent*",
289
+ max_size=hs.config.caches.event_cache_size,
290
+ # `extra_index_cb` Returns a tuple as that is the key type
291
+ extra_index_cb=lambda _, v: (v.event.room_id,),
292
+ )
293
+ )
294
+
295
+ # Map from event ID to a deferred that will result in a map from event
296
+ # ID to cache entry. Note that the returned dict may not have the
297
+ # requested event in it if the event isn't in the DB.
298
+ self._current_event_fetches: dict[
299
+ str, ObservableDeferred[dict[str, EventCacheEntry]]
300
+ ] = {}
301
+
302
+ # We keep track of the events we have currently loaded in memory so that
303
+ # we can reuse them even if they've been evicted from the cache. We only
304
+ # track events that don't need redacting in here (as then we don't need
305
+ # to track redaction status).
306
+ self._event_ref: MutableMapping[str, EventBase] = weakref.WeakValueDictionary()
307
+
308
+ self._event_fetch_lock = threading.Condition()
309
+ self._event_fetch_list: list[
310
+ tuple[Iterable[str], "defer.Deferred[dict[str, _EventRow]]"]
311
+ ] = []
312
+ self._event_fetch_ongoing = 0
313
+ event_fetch_ongoing_gauge.labels(**{SERVER_NAME_LABEL: self.server_name}).set(
314
+ self._event_fetch_ongoing
315
+ )
316
+
317
+ # We define this sequence here so that it can be referenced from both
318
+ # the DataStore and PersistEventStore.
319
+ def get_chain_id_txn(txn: Cursor) -> int:
320
+ txn.execute("SELECT COALESCE(max(chain_id), 0) FROM event_auth_chains")
321
+ return cast(tuple[int], txn.fetchone())[0]
322
+
323
+ self.event_chain_id_gen = build_sequence_generator(
324
+ db_conn,
325
+ database.engine,
326
+ get_chain_id_txn,
327
+ "event_auth_chain_id",
328
+ table="event_auth_chains",
329
+ id_column="chain_id",
330
+ )
331
+
332
+ self._un_partial_stated_events_stream_id_gen: AbstractStreamIdGenerator
333
+
334
+ self._un_partial_stated_events_stream_id_gen = MultiWriterIdGenerator(
335
+ db_conn=db_conn,
336
+ db=database,
337
+ notifier=hs.get_replication_notifier(),
338
+ stream_name="un_partial_stated_event_stream",
339
+ server_name=self.server_name,
340
+ instance_name=hs.get_instance_name(),
341
+ tables=[("un_partial_stated_event_stream", "instance_name", "stream_id")],
342
+ sequence_name="un_partial_stated_event_stream_sequence",
343
+ # TODO(faster_joins, multiple writers) Support multiple writers.
344
+ writers=["master"],
345
+ )
346
+
347
+ # Added to accommodate some queries for the admin API in order to fetch/filter
348
+ # membership events by when it was received
349
+ self.db_pool.updates.register_background_index_update(
350
+ update_name="events_received_ts_index",
351
+ index_name="received_ts_idx",
352
+ table="events",
353
+ columns=("received_ts",),
354
+ where_clause="type = 'm.room.member'",
355
+ )
356
+
357
+ # Added to support efficient reverse lookups on the foreign key
358
+ # (user_id, device_id) when deleting devices.
359
+ # We already had a UNIQUE index on these 4 columns but out-of-order
360
+ # so replace that one.
361
+ self.db_pool.updates.register_background_index_update(
362
+ update_name="event_txn_id_device_id_txn_id2",
363
+ index_name="event_txn_id_device_id_txn_id2",
364
+ table="event_txn_id_device_id",
365
+ columns=("user_id", "device_id", "room_id", "txn_id"),
366
+ unique=True,
367
+ replaces_index="event_txn_id_device_id_txn_id",
368
+ )
369
+
370
+ self._has_finished_sliding_sync_background_jobs = False
371
+ """
372
+ Flag to track when the sliding sync background jobs have
373
+ finished (so we don't have to keep querying it every time)
374
+ """
375
+
376
+ def get_un_partial_stated_events_token(self, instance_name: str) -> int:
377
+ return (
378
+ self._un_partial_stated_events_stream_id_gen.get_current_token_for_writer(
379
+ instance_name
380
+ )
381
+ )
382
+
383
+ async def get_un_partial_stated_events_from_stream(
384
+ self, instance_name: str, last_id: int, current_id: int, limit: int
385
+ ) -> tuple[list[tuple[int, tuple[str, bool]]], int, bool]:
386
+ """Get updates for the un-partial-stated events replication stream.
387
+
388
+ Args:
389
+ instance_name: The writer we want to fetch updates from. Unused
390
+ here since there is only ever one writer.
391
+ last_id: The token to fetch updates from. Exclusive.
392
+ current_id: The token to fetch updates up to. Inclusive.
393
+ limit: The requested limit for the number of rows to return. The
394
+ function may return more or fewer rows.
395
+
396
+ Returns:
397
+ A tuple consisting of: the updates, a token to use to fetch
398
+ subsequent updates, and whether we returned fewer rows than exists
399
+ between the requested tokens due to the limit.
400
+
401
+ The token returned can be used in a subsequent call to this
402
+ function to get further updatees.
403
+
404
+ The updates are a list of 2-tuples of stream ID and the row data
405
+ """
406
+
407
+ if last_id == current_id:
408
+ return [], current_id, False
409
+
410
+ def get_un_partial_stated_events_from_stream_txn(
411
+ txn: LoggingTransaction,
412
+ ) -> tuple[list[tuple[int, tuple[str, bool]]], int, bool]:
413
+ sql = """
414
+ SELECT stream_id, event_id, rejection_status_changed
415
+ FROM un_partial_stated_event_stream
416
+ WHERE ? < stream_id AND stream_id <= ? AND instance_name = ?
417
+ ORDER BY stream_id ASC
418
+ LIMIT ?
419
+ """
420
+ txn.execute(sql, (last_id, current_id, instance_name, limit))
421
+ updates = [
422
+ (
423
+ row[0],
424
+ (
425
+ row[1],
426
+ bool(row[2]),
427
+ ),
428
+ )
429
+ for row in txn
430
+ ]
431
+ limited = False
432
+ upto_token = current_id
433
+ if len(updates) >= limit:
434
+ upto_token = updates[-1][0]
435
+ limited = True
436
+
437
+ return updates, upto_token, limited
438
+
439
+ return await self.db_pool.runInteraction(
440
+ "get_un_partial_stated_events_from_stream",
441
+ get_un_partial_stated_events_from_stream_txn,
442
+ )
443
+
444
+ def process_replication_rows(
445
+ self,
446
+ stream_name: str,
447
+ instance_name: str,
448
+ token: int,
449
+ rows: Iterable[Any],
450
+ ) -> None:
451
+ if stream_name == UnPartialStatedEventStream.NAME:
452
+ for row in rows:
453
+ assert isinstance(row, UnPartialStatedEventStreamRow)
454
+
455
+ self.is_partial_state_event.invalidate((row.event_id,))
456
+
457
+ if row.rejection_status_changed:
458
+ # If the partial-stated event became rejected or unrejected
459
+ # when it wasn't before, we need to invalidate this cache.
460
+ self._invalidate_local_get_event_cache(row.event_id)
461
+
462
+ super().process_replication_rows(stream_name, instance_name, token, rows)
463
+
464
+ def process_replication_position(
465
+ self, stream_name: str, instance_name: str, token: int
466
+ ) -> None:
467
+ if stream_name == EventsStream.NAME:
468
+ self._stream_id_gen.advance(instance_name, token)
469
+ elif stream_name == BackfillStream.NAME:
470
+ self._backfill_id_gen.advance(instance_name, -token)
471
+ elif stream_name == UnPartialStatedEventStream.NAME:
472
+ self._un_partial_stated_events_stream_id_gen.advance(instance_name, token)
473
+ super().process_replication_position(stream_name, instance_name, token)
474
+
475
+ async def have_censored_event(self, event_id: str) -> bool:
476
+ """Check if an event has been censored, i.e. if the content of the event has been erased
477
+ from the database due to a redaction.
478
+
479
+ Args:
480
+ event_id: The event ID that was redacted.
481
+
482
+ Returns:
483
+ True if the event has been censored, False otherwise.
484
+ """
485
+ censored_redactions_list = await self.db_pool.simple_select_onecol(
486
+ table="redactions",
487
+ keyvalues={"redacts": event_id},
488
+ retcol="have_censored",
489
+ desc="get_have_censored",
490
+ )
491
+ return any(censored_redactions_list)
492
+
493
+ # Inform mypy that if allow_none is False (the default) then get_event
494
+ # always returns an EventBase.
495
+ @overload
496
+ async def get_event(
497
+ self,
498
+ event_id: str,
499
+ redact_behaviour: EventRedactBehaviour = EventRedactBehaviour.redact,
500
+ get_prev_content: bool = ...,
501
+ allow_rejected: bool = ...,
502
+ allow_none: Literal[False] = ...,
503
+ check_room_id: str | None = ...,
504
+ ) -> EventBase: ...
505
+
506
+ @overload
507
+ async def get_event(
508
+ self,
509
+ event_id: str,
510
+ redact_behaviour: EventRedactBehaviour = EventRedactBehaviour.redact,
511
+ get_prev_content: bool = ...,
512
+ allow_rejected: bool = ...,
513
+ allow_none: Literal[True] = ...,
514
+ check_room_id: str | None = ...,
515
+ ) -> EventBase | None: ...
516
+
517
+ @cancellable
518
+ async def get_event(
519
+ self,
520
+ event_id: str,
521
+ redact_behaviour: EventRedactBehaviour = EventRedactBehaviour.redact,
522
+ get_prev_content: bool = False,
523
+ allow_rejected: bool = False,
524
+ allow_none: bool = False,
525
+ check_room_id: str | None = None,
526
+ ) -> EventBase | None:
527
+ """Get an event from the database by event_id.
528
+
529
+ Events for unknown room versions will also be filtered out.
530
+
531
+ Args:
532
+ event_id: The event_id of the event to fetch
533
+
534
+ redact_behaviour: Determine what to do with a redacted event. Possible values:
535
+ * as_is - Return the full event body with no redacted content
536
+ * redact - Return the event but with a redacted body
537
+ * block - Do not return redacted events (behave as per allow_none
538
+ if the event is redacted)
539
+
540
+ get_prev_content: If True and event is a state event,
541
+ include the previous states content in the unsigned field.
542
+
543
+ allow_rejected: If True, return rejected events. Otherwise,
544
+ behave as per allow_none.
545
+
546
+ allow_none: If True, return None if no event found, if
547
+ False throw a NotFoundError
548
+
549
+ check_room_id: if not None, check the room of the found event.
550
+ If there is a mismatch, behave as per allow_none.
551
+
552
+ Returns:
553
+ The event, or None if the event was not found and allow_none is `True`.
554
+ """
555
+ if not isinstance(event_id, str):
556
+ raise TypeError("Invalid event event_id %r" % (event_id,))
557
+
558
+ events = await self.get_events_as_list(
559
+ [event_id],
560
+ redact_behaviour=redact_behaviour,
561
+ get_prev_content=get_prev_content,
562
+ allow_rejected=allow_rejected,
563
+ )
564
+
565
+ event = events[0] if events else None
566
+
567
+ if event is not None and check_room_id is not None:
568
+ if event.room_id != check_room_id:
569
+ event = None
570
+
571
+ if event is None and not allow_none:
572
+ raise NotFoundError("Could not find event %s" % (event_id,))
573
+
574
+ return event
575
+
576
+ @trace
577
+ async def get_events(
578
+ self,
579
+ event_ids: Collection[str],
580
+ redact_behaviour: EventRedactBehaviour = EventRedactBehaviour.redact,
581
+ get_prev_content: bool = False,
582
+ allow_rejected: bool = False,
583
+ ) -> dict[str, EventBase]:
584
+ """Get events from the database
585
+
586
+ Unknown events will be omitted from the response.
587
+
588
+ Events for unknown room versions will also be filtered out.
589
+
590
+ Args:
591
+ event_ids: The event_ids of the events to fetch
592
+
593
+ redact_behaviour: Determine what to do with a redacted event. Possible
594
+ values:
595
+ * as_is - Return the full event body with no redacted content
596
+ * redact - Return the event but with a redacted body
597
+ * block - Do not return redacted events (omit them from the response)
598
+
599
+ get_prev_content: If True and event is a state event,
600
+ include the previous states content in the unsigned field.
601
+
602
+ allow_rejected: If True, return rejected events. Otherwise,
603
+ omits rejected events from the response.
604
+
605
+ Returns:
606
+ A mapping from event_id to event.
607
+ """
608
+ set_tag(
609
+ SynapseTags.FUNC_ARG_PREFIX + "event_ids.length",
610
+ str(len(event_ids)),
611
+ )
612
+
613
+ events = await self.get_events_as_list(
614
+ event_ids,
615
+ redact_behaviour=redact_behaviour,
616
+ get_prev_content=get_prev_content,
617
+ allow_rejected=allow_rejected,
618
+ )
619
+
620
+ return {e.event_id: e for e in events}
621
+
622
+ @trace
623
+ @tag_args
624
+ @cancellable
625
+ async def get_events_as_list(
626
+ self,
627
+ event_ids: Collection[str],
628
+ redact_behaviour: EventRedactBehaviour = EventRedactBehaviour.redact,
629
+ get_prev_content: bool = False,
630
+ allow_rejected: bool = False,
631
+ ) -> list[EventBase]:
632
+ """Get events from the database and return in a list in the same order
633
+ as given by `event_ids` arg.
634
+
635
+ Unknown events will be omitted from the response.
636
+
637
+ Events for unknown room versions will also be filtered out.
638
+
639
+ Args:
640
+ event_ids: The event_ids of the events to fetch
641
+
642
+ redact_behaviour: Determine what to do with a redacted event. Possible values:
643
+ * as_is - Return the full event body with no redacted content
644
+ * redact - Return the event but with a redacted body
645
+ * block - Do not return redacted events (omit them from the response)
646
+
647
+ get_prev_content: If True and event is a state event,
648
+ include the previous states content in the unsigned field.
649
+
650
+ allow_rejected: If True, return rejected events. Otherwise,
651
+ omits rejected events from the response.
652
+
653
+ Returns:
654
+ List of events fetched from the database. The events are in the same
655
+ order as `event_ids` arg.
656
+
657
+ Note that the returned list may be smaller than the list of event
658
+ IDs if not all events could be fetched.
659
+ """
660
+ set_tag(
661
+ SynapseTags.FUNC_ARG_PREFIX + "event_ids.length",
662
+ str(len(event_ids)),
663
+ )
664
+
665
+ if not event_ids:
666
+ return []
667
+
668
+ # there may be duplicates so we cast the list to a set
669
+ event_entry_map = await self.get_unredacted_events_from_cache_or_db(
670
+ set(event_ids), allow_rejected=allow_rejected
671
+ )
672
+
673
+ events = []
674
+ for event_id in event_ids:
675
+ entry = event_entry_map.get(event_id, None)
676
+ if not entry:
677
+ continue
678
+
679
+ if not allow_rejected:
680
+ assert not entry.event.rejected_reason, (
681
+ "rejected event returned from _get_events_from_cache_or_db despite "
682
+ "allow_rejected=False"
683
+ )
684
+
685
+ # We may not have had the original event when we received a redaction, so
686
+ # we have to recheck auth now.
687
+
688
+ if not allow_rejected and entry.event.type == EventTypes.Redaction:
689
+ if entry.event.redacts is None:
690
+ # A redacted redaction doesn't have a `redacts` key, in
691
+ # which case lets just withhold the event.
692
+ #
693
+ # Note: Most of the time if the redactions has been
694
+ # redacted we still have the un-redacted event in the DB
695
+ # and so we'll still see the `redacts` key. However, this
696
+ # isn't always true e.g. if we have censored the event.
697
+ logger.debug(
698
+ "Withholding redaction event %s as we don't have redacts key",
699
+ event_id,
700
+ )
701
+ continue
702
+
703
+ redacted_event_id = entry.event.redacts
704
+ event_map = await self.get_unredacted_events_from_cache_or_db(
705
+ [redacted_event_id]
706
+ )
707
+ original_event_entry = event_map.get(redacted_event_id)
708
+ if not original_event_entry:
709
+ # we don't have the redacted event (or it was rejected).
710
+ #
711
+ # We assume that the redaction isn't authorized for now; if the
712
+ # redacted event later turns up, the redaction will be re-checked,
713
+ # and if it is found valid, the original will get redacted before it
714
+ # is served to the client.
715
+ logger.debug(
716
+ "Withholding redaction event %s since we don't (yet) have the "
717
+ "original %s",
718
+ event_id,
719
+ redacted_event_id,
720
+ )
721
+ continue
722
+
723
+ original_event = original_event_entry.event
724
+ if original_event.type == EventTypes.Create:
725
+ # we never serve redactions of Creates to clients.
726
+ logger.info(
727
+ "Withholding redaction %s of create event %s",
728
+ event_id,
729
+ redacted_event_id,
730
+ )
731
+ continue
732
+
733
+ if original_event.room_id != entry.event.room_id:
734
+ logger.info(
735
+ "Withholding redaction %s of event %s from a different room",
736
+ event_id,
737
+ redacted_event_id,
738
+ )
739
+ continue
740
+
741
+ if entry.event.internal_metadata.need_to_check_redaction():
742
+ original_domain = get_domain_from_id(original_event.sender)
743
+ redaction_domain = get_domain_from_id(entry.event.sender)
744
+ if original_domain != redaction_domain:
745
+ # the senders don't match, so this is forbidden
746
+ logger.info(
747
+ "Withholding redaction %s whose sender domain %s doesn't "
748
+ "match that of redacted event %s %s",
749
+ event_id,
750
+ redaction_domain,
751
+ redacted_event_id,
752
+ original_domain,
753
+ )
754
+ continue
755
+
756
+ # Update the cache to save doing the checks again.
757
+ entry.event.internal_metadata.recheck_redaction = False
758
+
759
+ event = entry.event
760
+
761
+ if entry.redacted_event:
762
+ if redact_behaviour == EventRedactBehaviour.block:
763
+ # Skip this event
764
+ continue
765
+ elif redact_behaviour == EventRedactBehaviour.redact:
766
+ event = entry.redacted_event
767
+
768
+ events.append(event)
769
+
770
+ if get_prev_content:
771
+ if "replaces_state" in event.unsigned:
772
+ prev = await self.get_event(
773
+ event.unsigned["replaces_state"],
774
+ get_prev_content=False,
775
+ allow_none=True,
776
+ )
777
+ if prev:
778
+ event.unsigned = dict(event.unsigned)
779
+ event.unsigned["prev_content"] = prev.content
780
+ event.unsigned["prev_sender"] = prev.sender
781
+
782
+ return events
783
+
784
+ @trace
785
+ @cancellable
786
+ async def get_unredacted_events_from_cache_or_db(
787
+ self,
788
+ event_ids: Collection[str],
789
+ allow_rejected: bool = False,
790
+ ) -> dict[str, EventCacheEntry]:
791
+ """Fetch a bunch of events from the cache or the database.
792
+
793
+ Note that the events pulled by this function will not have any redactions
794
+ applied, and no guarantee is made about the ordering of the events returned.
795
+
796
+ If events are pulled from the database, they will be cached for future lookups.
797
+
798
+ Unknown events are omitted from the response.
799
+
800
+ Args:
801
+
802
+ event_ids: The event_ids of the events to fetch
803
+
804
+ allow_rejected: Whether to include rejected events. If False,
805
+ rejected events are omitted from the response.
806
+
807
+ Returns:
808
+ map from event id to result
809
+ """
810
+ set_tag(
811
+ SynapseTags.FUNC_ARG_PREFIX + "event_ids.length",
812
+ str(len(event_ids)),
813
+ )
814
+
815
+ # Shortcut: check if we have any events in the *in memory* cache - this function
816
+ # may be called repeatedly for the same event so at this point we cannot reach
817
+ # out to any external cache for performance reasons. The external cache is
818
+ # checked later on in the `get_missing_events_from_cache_or_db` function below.
819
+ event_entry_map = self._get_events_from_local_cache(
820
+ event_ids,
821
+ )
822
+
823
+ missing_events_ids = {e for e in event_ids if e not in event_entry_map}
824
+
825
+ # We now look up if we're already fetching some of the events in the DB,
826
+ # if so we wait for those lookups to finish instead of pulling the same
827
+ # events out of the DB multiple times.
828
+ #
829
+ # Note: we might get the same `ObservableDeferred` back for multiple
830
+ # events we're already fetching, so we deduplicate the deferreds to
831
+ # avoid extraneous work (if we don't do this we can end up in a n^2 mode
832
+ # when we wait on the same Deferred N times, then try and merge the
833
+ # same dict into itself N times).
834
+ already_fetching_ids: set[str] = set()
835
+ already_fetching_deferreds: set[
836
+ ObservableDeferred[dict[str, EventCacheEntry]]
837
+ ] = set()
838
+
839
+ for event_id in missing_events_ids:
840
+ deferred = self._current_event_fetches.get(event_id)
841
+ if deferred is not None:
842
+ # We're already pulling the event out of the DB. Add the deferred
843
+ # to the collection of deferreds to wait on.
844
+ already_fetching_ids.add(event_id)
845
+ already_fetching_deferreds.add(deferred)
846
+
847
+ missing_events_ids.difference_update(already_fetching_ids)
848
+
849
+ if missing_events_ids:
850
+
851
+ async def get_missing_events_from_cache_or_db() -> dict[
852
+ str, EventCacheEntry
853
+ ]:
854
+ """Fetches the events in `missing_event_ids` from the database.
855
+
856
+ Also creates entries in `self._current_event_fetches` to allow
857
+ concurrent `_get_events_from_cache_or_db` calls to reuse the same fetch.
858
+ """
859
+ log_ctx = current_context()
860
+ log_ctx.record_event_fetch(len(missing_events_ids))
861
+
862
+ # Add entries to `self._current_event_fetches` for each event we're
863
+ # going to pull from the DB. We use a single deferred that resolves
864
+ # to all the events we pulled from the DB (this will result in this
865
+ # function returning more events than requested, but that can happen
866
+ # already due to `_get_events_from_db`).
867
+ fetching_deferred: ObservableDeferred[dict[str, EventCacheEntry]] = (
868
+ ObservableDeferred(defer.Deferred(), consumeErrors=True)
869
+ )
870
+ for event_id in missing_events_ids:
871
+ self._current_event_fetches[event_id] = fetching_deferred
872
+
873
+ # Note that _get_events_from_db is also responsible for turning db rows
874
+ # into FrozenEvents (via _get_event_from_row), which involves seeing if
875
+ # the events have been redacted, and if so pulling the redaction event
876
+ # out of the database to check it.
877
+ #
878
+ try:
879
+ # Try to fetch from any external cache. We already checked the
880
+ # in-memory cache above.
881
+ missing_events = await self._get_events_from_external_cache(
882
+ missing_events_ids,
883
+ )
884
+ # Now actually fetch any remaining events from the DB
885
+ db_missing_events = await self._get_events_from_db(
886
+ missing_events_ids - missing_events.keys(),
887
+ )
888
+ missing_events.update(db_missing_events)
889
+ except Exception as e:
890
+ with PreserveLoggingContext():
891
+ fetching_deferred.errback(e)
892
+ raise e
893
+ finally:
894
+ # Ensure that we mark these events as no longer being fetched.
895
+ for event_id in missing_events_ids:
896
+ self._current_event_fetches.pop(event_id, None)
897
+
898
+ with PreserveLoggingContext():
899
+ fetching_deferred.callback(missing_events)
900
+
901
+ return missing_events
902
+
903
+ # We must allow the database fetch to complete in the presence of
904
+ # cancellations, since multiple `_get_events_from_cache_or_db` calls can
905
+ # reuse the same fetch.
906
+ missing_events: dict[str, EventCacheEntry] = await delay_cancellation(
907
+ get_missing_events_from_cache_or_db()
908
+ )
909
+ event_entry_map.update(missing_events)
910
+
911
+ if already_fetching_deferreds:
912
+ # Wait for the other event requests to finish and add their results
913
+ # to ours.
914
+ results = await make_deferred_yieldable(
915
+ defer.gatherResults(
916
+ (d.observe() for d in already_fetching_deferreds),
917
+ consumeErrors=True,
918
+ )
919
+ ).addErrback(unwrapFirstError)
920
+
921
+ for result in results:
922
+ # We filter out events that we haven't asked for as we might get
923
+ # a *lot* of superfluous events back, and there is no point
924
+ # going through and inserting them all (which can take time).
925
+ event_entry_map.update(
926
+ (event_id, entry)
927
+ for event_id, entry in result.items()
928
+ if event_id in already_fetching_ids
929
+ )
930
+
931
+ if not allow_rejected:
932
+ event_entry_map = {
933
+ event_id: entry
934
+ for event_id, entry in event_entry_map.items()
935
+ if not entry.event.rejected_reason
936
+ }
937
+
938
+ return event_entry_map
939
+
940
+ def invalidate_get_event_cache_after_txn(
941
+ self, txn: LoggingTransaction, event_id: str
942
+ ) -> None:
943
+ """
944
+ Prepares a database transaction to invalidate the get event cache for a given
945
+ event ID when executed successfully. This is achieved by attaching two callbacks
946
+ to the transaction, one to invalidate the async cache and one for the in memory
947
+ sync cache (importantly called in that order).
948
+
949
+ Arguments:
950
+ txn: the database transaction to attach the callbacks to
951
+ event_id: the event ID to be invalidated from caches
952
+ """
953
+
954
+ txn.async_call_after(self._invalidate_async_get_event_cache, event_id)
955
+ txn.call_after(self._invalidate_local_get_event_cache, event_id)
956
+
957
+ async def _invalidate_async_get_event_cache(self, event_id: str) -> None:
958
+ """
959
+ Invalidates an event in the asynchronous get event cache, which may be remote.
960
+
961
+ Arguments:
962
+ event_id: the event ID to invalidate
963
+ """
964
+
965
+ await self._get_event_cache.invalidate((event_id,))
966
+
967
+ def _invalidate_local_get_event_cache(self, event_id: str) -> None:
968
+ """
969
+ Invalidates an event in local in-memory get event caches.
970
+
971
+ Arguments:
972
+ event_id: the event ID to invalidate
973
+ """
974
+
975
+ self._get_event_cache.invalidate_local((event_id,))
976
+ self._event_ref.pop(event_id, None)
977
+ self._current_event_fetches.pop(event_id, None)
978
+
979
+ def _invalidate_local_get_event_cache_room_id(self, room_id: str) -> None:
980
+ """Clears the in-memory get event caches for a room.
981
+
982
+ Used when we purge room history.
983
+ """
984
+ self._get_event_cache.invalidate_on_extra_index_local((room_id,))
985
+ self._event_ref.clear()
986
+ self._current_event_fetches.clear()
987
+
988
+ def _invalidate_async_get_event_cache_room_id(self, room_id: str) -> None:
989
+ """
990
+ Clears the async get_event cache for a room. Currently a no-op until
991
+ an async get_event cache is implemented - see https://github.com/matrix-org/synapse/pull/13242
992
+ for preliminary work.
993
+ """
994
+
995
+ async def _get_events_from_cache(
996
+ self, events: Iterable[str], update_metrics: bool = True
997
+ ) -> dict[str, EventCacheEntry]:
998
+ """Fetch events from the caches, both in memory and any external.
999
+
1000
+ May return rejected events.
1001
+
1002
+ Args:
1003
+ events: list of event_ids to fetch
1004
+ update_metrics: Whether to update the cache hit ratio metrics
1005
+ """
1006
+ event_map = self._get_events_from_local_cache(
1007
+ events, update_metrics=update_metrics
1008
+ )
1009
+
1010
+ missing_event_ids = [e for e in events if e not in event_map]
1011
+ event_map.update(
1012
+ await self._get_events_from_external_cache(
1013
+ events=missing_event_ids,
1014
+ update_metrics=update_metrics,
1015
+ )
1016
+ )
1017
+
1018
+ return event_map
1019
+
1020
+ @trace
1021
+ async def _get_events_from_external_cache(
1022
+ self, events: Collection[str], update_metrics: bool = True
1023
+ ) -> dict[str, EventCacheEntry]:
1024
+ """Fetch events from any configured external cache.
1025
+
1026
+ May return rejected events.
1027
+
1028
+ Args:
1029
+ events: list of event_ids to fetch
1030
+ update_metrics: Whether to update the cache hit ratio metrics
1031
+ """
1032
+ set_tag(
1033
+ SynapseTags.FUNC_ARG_PREFIX + "events.length",
1034
+ str(len(events)),
1035
+ )
1036
+ event_map = {}
1037
+
1038
+ for event_id in events:
1039
+ ret = await self._get_event_cache.get_external(
1040
+ (event_id,), None, update_metrics=update_metrics
1041
+ )
1042
+ if ret:
1043
+ event_map[event_id] = ret
1044
+
1045
+ return event_map
1046
+
1047
+ def _get_events_from_local_cache(
1048
+ self, events: Iterable[str], update_metrics: bool = True
1049
+ ) -> dict[str, EventCacheEntry]:
1050
+ """Fetch events from the local, in memory, caches.
1051
+
1052
+ May return rejected events.
1053
+
1054
+ Args:
1055
+ events: list of event_ids to fetch
1056
+ update_metrics: Whether to update the cache hit ratio metrics
1057
+ """
1058
+ event_map = {}
1059
+
1060
+ for event_id in events:
1061
+ # First check if it's in the event cache
1062
+ ret = self._get_event_cache.get_local(
1063
+ (event_id,), None, update_metrics=update_metrics
1064
+ )
1065
+ if ret:
1066
+ event_map[event_id] = ret
1067
+ continue
1068
+
1069
+ # Otherwise check if we still have the event in memory.
1070
+ event = self._event_ref.get(event_id)
1071
+ if event:
1072
+ # Reconstruct an event cache entry
1073
+
1074
+ cache_entry = EventCacheEntry(
1075
+ event=event,
1076
+ # We don't cache weakrefs to redacted events, so we know
1077
+ # this is None.
1078
+ redacted_event=None,
1079
+ )
1080
+ event_map[event_id] = cache_entry
1081
+
1082
+ # We add the entry back into the cache as we want to keep
1083
+ # recently queried events in the cache.
1084
+ self._get_event_cache.set_local((event_id,), cache_entry)
1085
+
1086
+ return event_map
1087
+
1088
+ async def get_stripped_room_state_from_event_context(
1089
+ self,
1090
+ context: EventContext,
1091
+ state_keys_to_include: StateFilter,
1092
+ membership_user_id: str | None = None,
1093
+ ) -> list[JsonDict]:
1094
+ """
1095
+ Retrieve the stripped state from a room, given an event context to retrieve state
1096
+ from as well as the state types to include. Optionally, include the membership
1097
+ events from a specific user.
1098
+
1099
+ "Stripped" state means that only the `type`, `state_key`, `content` and `sender` keys
1100
+ are included from each state event.
1101
+
1102
+ Args:
1103
+ context: The event context to retrieve state of the room from.
1104
+ state_keys_to_include: The state events to include, for each event type.
1105
+ membership_user_id: An optional user ID to include the stripped membership state
1106
+ events of. This is useful when generating the stripped state of a room for
1107
+ invites. We want to send membership events of the inviter, so that the
1108
+ invitee can display the inviter's profile information if the room lacks any.
1109
+
1110
+ Returns:
1111
+ A list of dictionaries, each representing a stripped state event from the room.
1112
+ """
1113
+ if membership_user_id:
1114
+ types = chain(
1115
+ state_keys_to_include.to_types(),
1116
+ [(EventTypes.Member, membership_user_id)],
1117
+ )
1118
+ filter = StateFilter.from_types(types)
1119
+ else:
1120
+ filter = state_keys_to_include
1121
+ selected_state_ids = await context.get_current_state_ids(filter)
1122
+
1123
+ # We know this event is not an outlier, so this must be
1124
+ # non-None.
1125
+ assert selected_state_ids is not None
1126
+
1127
+ # Confusingly, get_current_state_events may return events that are discarded by
1128
+ # the filter, if they're in context._state_delta_due_to_event. Strip these away.
1129
+ selected_state_ids = filter.filter_state(selected_state_ids)
1130
+
1131
+ state_to_include = await self.get_events(selected_state_ids.values())
1132
+
1133
+ return [strip_event(e) for e in state_to_include.values()]
1134
+
1135
+ def _maybe_start_fetch_thread(self) -> None:
1136
+ """Starts an event fetch thread if we are not yet at the maximum number."""
1137
+ with self._event_fetch_lock:
1138
+ if (
1139
+ self._event_fetch_list
1140
+ and self._event_fetch_ongoing < EVENT_QUEUE_THREADS
1141
+ ):
1142
+ self._event_fetch_ongoing += 1
1143
+ event_fetch_ongoing_gauge.labels(
1144
+ **{SERVER_NAME_LABEL: self.server_name}
1145
+ ).set(self._event_fetch_ongoing)
1146
+ # `_event_fetch_ongoing` is decremented in `_fetch_thread`.
1147
+ should_start = True
1148
+ else:
1149
+ should_start = False
1150
+
1151
+ if should_start:
1152
+ self.hs.run_as_background_process("fetch_events", self._fetch_thread)
1153
+
1154
+ async def _fetch_thread(self) -> None:
1155
+ """Services requests for events from `_event_fetch_list`."""
1156
+ exc = None
1157
+ try:
1158
+ await self.db_pool.runWithConnection(self._fetch_loop)
1159
+ except BaseException as e:
1160
+ exc = e
1161
+ raise
1162
+ finally:
1163
+ should_restart = False
1164
+ event_fetches_to_fail = []
1165
+ with self._event_fetch_lock:
1166
+ self._event_fetch_ongoing -= 1
1167
+ event_fetch_ongoing_gauge.labels(
1168
+ **{SERVER_NAME_LABEL: self.server_name}
1169
+ ).set(self._event_fetch_ongoing)
1170
+
1171
+ # There may still be work remaining in `_event_fetch_list` if we
1172
+ # failed, or it was added in between us deciding to exit and
1173
+ # decrementing `_event_fetch_ongoing`.
1174
+ if self._event_fetch_list:
1175
+ if exc is None:
1176
+ # We decided to exit, but then some more work was added
1177
+ # before `_event_fetch_ongoing` was decremented.
1178
+ # If a new event fetch thread was not started, we should
1179
+ # restart ourselves since the remaining event fetch threads
1180
+ # may take a while to get around to the new work.
1181
+ #
1182
+ # Unfortunately it is not possible to tell whether a new
1183
+ # event fetch thread was started, so we restart
1184
+ # unconditionally. If we are unlucky, we will end up with
1185
+ # an idle fetch thread, but it will time out after
1186
+ # `EVENT_QUEUE_ITERATIONS * EVENT_QUEUE_TIMEOUT_S` seconds
1187
+ # in any case.
1188
+ #
1189
+ # Note that multiple fetch threads may run down this path at
1190
+ # the same time.
1191
+ should_restart = True
1192
+ elif isinstance(exc, Exception):
1193
+ if self._event_fetch_ongoing == 0:
1194
+ # We were the last remaining fetcher and failed.
1195
+ # Fail any outstanding fetches since no one else will
1196
+ # handle them.
1197
+ event_fetches_to_fail = self._event_fetch_list
1198
+ self._event_fetch_list = []
1199
+ else:
1200
+ # We weren't the last remaining fetcher, so another
1201
+ # fetcher will pick up the work. This will either happen
1202
+ # after their existing work, however long that takes,
1203
+ # or after at most `EVENT_QUEUE_TIMEOUT_S` seconds if
1204
+ # they are idle.
1205
+ pass
1206
+ else:
1207
+ # The exception is a `SystemExit`, `KeyboardInterrupt` or
1208
+ # `GeneratorExit`. Don't try to do anything clever here.
1209
+ pass
1210
+
1211
+ if should_restart:
1212
+ # We exited cleanly but noticed more work.
1213
+ self._maybe_start_fetch_thread()
1214
+
1215
+ if event_fetches_to_fail:
1216
+ # We were the last remaining fetcher and failed.
1217
+ # Fail any outstanding fetches since no one else will handle them.
1218
+ assert exc is not None
1219
+ with PreserveLoggingContext():
1220
+ for _, deferred in event_fetches_to_fail:
1221
+ deferred.errback(exc)
1222
+
1223
+ def _fetch_loop(self, conn: LoggingDatabaseConnection) -> None:
1224
+ """Takes a database connection and waits for requests for events from
1225
+ the _event_fetch_list queue.
1226
+ """
1227
+ i = 0
1228
+ while True:
1229
+ with self._event_fetch_lock:
1230
+ event_list = self._event_fetch_list
1231
+ self._event_fetch_list = []
1232
+
1233
+ if not event_list:
1234
+ # There are no requests waiting. If we haven't yet reached the
1235
+ # maximum iteration limit, wait for some more requests to turn up.
1236
+ # Otherwise, bail out.
1237
+ single_threaded = self.database_engine.single_threaded
1238
+ if (
1239
+ not self.USE_DEDICATED_DB_THREADS_FOR_EVENT_FETCHING
1240
+ or single_threaded
1241
+ or i > EVENT_QUEUE_ITERATIONS
1242
+ ):
1243
+ return
1244
+
1245
+ self._event_fetch_lock.wait(EVENT_QUEUE_TIMEOUT_S)
1246
+ i += 1
1247
+ continue
1248
+ i = 0
1249
+
1250
+ self._fetch_event_list(conn, event_list)
1251
+
1252
+ def _fetch_event_list(
1253
+ self,
1254
+ conn: LoggingDatabaseConnection,
1255
+ event_list: list[tuple[Iterable[str], "defer.Deferred[dict[str, _EventRow]]"]],
1256
+ ) -> None:
1257
+ """Handle a load of requests from the _event_fetch_list queue
1258
+
1259
+ Args:
1260
+ conn: database connection
1261
+
1262
+ event_list:
1263
+ The fetch requests. Each entry consists of a list of event
1264
+ ids to be fetched, and a deferred to be completed once the
1265
+ events have been fetched.
1266
+
1267
+ The deferreds are callbacked with a dictionary mapping from event id
1268
+ to event row. Note that it may well contain additional events that
1269
+ were not part of this request.
1270
+ """
1271
+ with Measure(
1272
+ self.clock, name="_fetch_event_list", server_name=self.server_name
1273
+ ):
1274
+ try:
1275
+ events_to_fetch = {
1276
+ event_id for events, _ in event_list for event_id in events
1277
+ }
1278
+
1279
+ row_dict = self.db_pool.new_transaction(
1280
+ conn,
1281
+ "do_fetch",
1282
+ [],
1283
+ [],
1284
+ [],
1285
+ self._fetch_event_rows,
1286
+ events_to_fetch,
1287
+ )
1288
+
1289
+ # We only want to resolve deferreds from the main thread
1290
+ def fire() -> None:
1291
+ for _, d in event_list:
1292
+ d.callback(row_dict)
1293
+
1294
+ with PreserveLoggingContext():
1295
+ self.hs.get_reactor().callFromThread(fire)
1296
+ except Exception as e:
1297
+ logger.exception("do_fetch")
1298
+
1299
+ # We only want to resolve deferreds from the main thread
1300
+ def fire_errback(exc: Exception) -> None:
1301
+ for _, d in event_list:
1302
+ d.errback(exc)
1303
+
1304
+ with PreserveLoggingContext():
1305
+ self.hs.get_reactor().callFromThread(fire_errback, e)
1306
+
1307
+ @trace
1308
+ async def _get_events_from_db(
1309
+ self, event_ids: Collection[str]
1310
+ ) -> dict[str, EventCacheEntry]:
1311
+ """Fetch a bunch of events from the database.
1312
+
1313
+ May return rejected events.
1314
+
1315
+ Returned events will be added to the cache for future lookups.
1316
+
1317
+ Unknown events are omitted from the response.
1318
+
1319
+ Args:
1320
+ event_ids: The event_ids of the events to fetch
1321
+
1322
+ Returns:
1323
+ map from event id to result. May return extra events which
1324
+ weren't asked for.
1325
+ """
1326
+ set_tag(
1327
+ SynapseTags.FUNC_ARG_PREFIX + "event_ids.length",
1328
+ str(len(event_ids)),
1329
+ )
1330
+
1331
+ fetched_event_ids: set[str] = set()
1332
+ fetched_events: dict[str, _EventRow] = {}
1333
+
1334
+ @trace
1335
+ async def _fetch_event_ids_and_get_outstanding_redactions(
1336
+ event_ids_to_fetch: Collection[str],
1337
+ ) -> Collection[str]:
1338
+ """
1339
+ Fetch all of the given event_ids and return any associated redaction event_ids
1340
+ that we still need to fetch in the next iteration.
1341
+ """
1342
+ set_tag(
1343
+ SynapseTags.FUNC_ARG_PREFIX + "event_ids_to_fetch.length",
1344
+ str(len(event_ids_to_fetch)),
1345
+ )
1346
+ row_map = await self._enqueue_events(event_ids_to_fetch)
1347
+
1348
+ # we need to recursively fetch any redactions of those events
1349
+ redaction_ids: set[str] = set()
1350
+ for event_id in event_ids_to_fetch:
1351
+ row = row_map.get(event_id)
1352
+ fetched_event_ids.add(event_id)
1353
+ if row:
1354
+ fetched_events[event_id] = row
1355
+ redaction_ids.update(row.redactions)
1356
+
1357
+ event_ids_to_fetch = redaction_ids.difference(fetched_event_ids)
1358
+ return event_ids_to_fetch
1359
+
1360
+ # Grab the initial list of events requested
1361
+ event_ids_to_fetch = await _fetch_event_ids_and_get_outstanding_redactions(
1362
+ event_ids
1363
+ )
1364
+ # Then go and recursively find all of the associated redactions
1365
+ with start_active_span("recursively fetching redactions"):
1366
+ while event_ids_to_fetch:
1367
+ logger.debug("Also fetching redaction events %s", event_ids_to_fetch)
1368
+
1369
+ event_ids_to_fetch = (
1370
+ await _fetch_event_ids_and_get_outstanding_redactions(
1371
+ event_ids_to_fetch
1372
+ )
1373
+ )
1374
+
1375
+ # build a map from event_id to EventBase
1376
+ event_map: dict[str, EventBase] = {}
1377
+ for event_id, row in fetched_events.items():
1378
+ assert row.event_id == event_id
1379
+
1380
+ rejected_reason = row.rejected_reason
1381
+
1382
+ # If the event or metadata cannot be parsed, log the error and act
1383
+ # as if the event is unknown.
1384
+ try:
1385
+ d = db_to_json(row.json)
1386
+ except ValueError:
1387
+ logger.error("Unable to parse json from event: %s", event_id)
1388
+ continue
1389
+ try:
1390
+ internal_metadata = db_to_json(row.internal_metadata)
1391
+ except ValueError:
1392
+ logger.error(
1393
+ "Unable to parse internal_metadata from event: %s", event_id
1394
+ )
1395
+ continue
1396
+
1397
+ format_version = row.format_version
1398
+ if format_version is None:
1399
+ # This means that we stored the event before we had the concept
1400
+ # of a event format version, so it must be a V1 event.
1401
+ format_version = EventFormatVersions.ROOM_V1_V2
1402
+
1403
+ room_version_id = row.room_version_id
1404
+
1405
+ room_version: RoomVersion | None
1406
+ if not room_version_id:
1407
+ # this should only happen for out-of-band membership events which
1408
+ # arrived before https://github.com/matrix-org/synapse/issues/6983
1409
+ # landed. For all other events, we should have
1410
+ # an entry in the 'rooms' table.
1411
+ #
1412
+ # However, the 'out_of_band_membership' flag is unreliable for older
1413
+ # invites, so just accept it for all membership events.
1414
+ #
1415
+ if d["type"] != EventTypes.Member:
1416
+ raise InvalidEventError(
1417
+ "Room %s for event %s is unknown" % (d["room_id"], event_id)
1418
+ )
1419
+
1420
+ # so, assuming this is an out-of-band-invite that arrived before
1421
+ # https://github.com/matrix-org/synapse/issues/6983
1422
+ # landed, we know that the room version must be v5 or earlier (because
1423
+ # v6 hadn't been invented at that point, so invites from such rooms
1424
+ # would have been rejected.)
1425
+ #
1426
+ # The main reason we need to know the room version here (other than
1427
+ # choosing the right python Event class) is in case the event later has
1428
+ # to be redacted - and all the room versions up to v5 used the same
1429
+ # redaction algorithm.
1430
+ #
1431
+ # So, the following approximations should be adequate.
1432
+
1433
+ if format_version == EventFormatVersions.ROOM_V1_V2:
1434
+ # if it's event format v1 then it must be room v1 or v2
1435
+ room_version = RoomVersions.V1
1436
+ elif format_version == EventFormatVersions.ROOM_V3:
1437
+ # if it's event format v2 then it must be room v3
1438
+ room_version = RoomVersions.V3
1439
+ else:
1440
+ # if it's event format v3 then it must be room v4 or v5
1441
+ room_version = RoomVersions.V5
1442
+ else:
1443
+ room_version = KNOWN_ROOM_VERSIONS.get(room_version_id)
1444
+ if not room_version:
1445
+ logger.warning(
1446
+ "Event %s in room %s has unknown room version %s",
1447
+ event_id,
1448
+ d["room_id"],
1449
+ room_version_id,
1450
+ )
1451
+ continue
1452
+
1453
+ if room_version.event_format != format_version:
1454
+ logger.error(
1455
+ "Event %s in room %s with version %s has wrong format: "
1456
+ "expected %s, was %s",
1457
+ event_id,
1458
+ d["room_id"],
1459
+ room_version_id,
1460
+ room_version.event_format,
1461
+ format_version,
1462
+ )
1463
+ continue
1464
+
1465
+ original_ev = make_event_from_dict(
1466
+ event_dict=d,
1467
+ room_version=room_version,
1468
+ internal_metadata_dict=internal_metadata,
1469
+ rejected_reason=rejected_reason,
1470
+ )
1471
+ original_ev.internal_metadata.stream_ordering = row.stream_ordering
1472
+ original_ev.internal_metadata.instance_name = row.instance_name
1473
+ original_ev.internal_metadata.outlier = row.outlier
1474
+
1475
+ # Consistency check: if the content of the event has been modified in the
1476
+ # database, then the calculated event ID will not match the event id in the
1477
+ # database.
1478
+ if original_ev.event_id != event_id:
1479
+ # it's difficult to see what to do here. Pretty much all bets are off
1480
+ # if Synapse cannot rely on the consistency of its database.
1481
+ raise DatabaseCorruptionError(
1482
+ d["room_id"], event_id, original_ev.event_id
1483
+ )
1484
+
1485
+ event_map[event_id] = original_ev
1486
+
1487
+ # finally, we can decide whether each one needs redacting, and build
1488
+ # the cache entries.
1489
+ result_map: dict[str, EventCacheEntry] = {}
1490
+ for event_id, original_ev in event_map.items():
1491
+ redactions = fetched_events[event_id].redactions
1492
+ redacted_event = self._maybe_redact_event_row(
1493
+ original_ev, redactions, event_map
1494
+ )
1495
+
1496
+ cache_entry = EventCacheEntry(
1497
+ event=original_ev, redacted_event=redacted_event
1498
+ )
1499
+
1500
+ await self._get_event_cache.set((event_id,), cache_entry)
1501
+ result_map[event_id] = cache_entry
1502
+
1503
+ if not redacted_event:
1504
+ # We only cache references to unredacted events.
1505
+ self._event_ref[event_id] = original_ev
1506
+
1507
+ return result_map
1508
+
1509
+ async def _enqueue_events(self, events: Collection[str]) -> dict[str, _EventRow]:
1510
+ """Fetches events from the database using the _event_fetch_list. This
1511
+ allows batch and bulk fetching of events - it allows us to fetch events
1512
+ without having to create a new transaction for each request for events.
1513
+
1514
+ Args:
1515
+ events: events to be fetched.
1516
+
1517
+ Returns:
1518
+ A map from event id to row data from the database. May contain events
1519
+ that weren't requested.
1520
+ """
1521
+
1522
+ events_d: "defer.Deferred[dict[str, _EventRow]]" = defer.Deferred()
1523
+ with self._event_fetch_lock:
1524
+ self._event_fetch_list.append((events, events_d))
1525
+ self._event_fetch_lock.notify()
1526
+
1527
+ self._maybe_start_fetch_thread()
1528
+
1529
+ logger.debug("Loading %d events: %s", len(events), events)
1530
+ with PreserveLoggingContext():
1531
+ row_map = await events_d
1532
+ logger.debug("Loaded %d events (%d rows)", len(events), len(row_map))
1533
+
1534
+ return row_map
1535
+
1536
+ def _fetch_event_rows(
1537
+ self, txn: LoggingTransaction, event_ids: Iterable[str]
1538
+ ) -> dict[str, _EventRow]:
1539
+ """Fetch event rows from the database
1540
+
1541
+ Events which are not found are omitted from the result.
1542
+
1543
+ Args:
1544
+ txn: The database transaction.
1545
+ event_ids: event IDs to fetch
1546
+
1547
+ Returns:
1548
+ A map from event id to event info.
1549
+ """
1550
+ event_dict = {}
1551
+ for evs in batch_iter(event_ids, 200):
1552
+ sql = """\
1553
+ SELECT
1554
+ e.event_id,
1555
+ e.stream_ordering,
1556
+ e.instance_name,
1557
+ ej.internal_metadata,
1558
+ ej.json,
1559
+ ej.format_version,
1560
+ r.room_version,
1561
+ rej.reason,
1562
+ e.outlier
1563
+ FROM events AS e
1564
+ JOIN event_json AS ej USING (event_id)
1565
+ LEFT JOIN rooms r ON r.room_id = e.room_id
1566
+ LEFT JOIN rejections as rej USING (event_id)
1567
+ WHERE """
1568
+
1569
+ clause, args = make_in_list_sql_clause(
1570
+ txn.database_engine, "e.event_id", evs
1571
+ )
1572
+
1573
+ txn.execute(sql + clause, args)
1574
+
1575
+ for row in txn:
1576
+ event_id = row[0]
1577
+ event_dict[event_id] = _EventRow(
1578
+ event_id=event_id,
1579
+ stream_ordering=row[1],
1580
+ # If instance_name is null we default to "master"
1581
+ instance_name=row[2] or "master",
1582
+ internal_metadata=row[3],
1583
+ json=row[4],
1584
+ format_version=row[5],
1585
+ room_version_id=row[6],
1586
+ rejected_reason=row[7],
1587
+ redactions=[],
1588
+ outlier=bool(row[8]), # This is an int in SQLite3
1589
+ )
1590
+
1591
+ # check for redactions
1592
+ redactions_sql = "SELECT event_id, redacts FROM redactions WHERE "
1593
+
1594
+ clause, args = make_in_list_sql_clause(txn.database_engine, "redacts", evs)
1595
+
1596
+ txn.execute(redactions_sql + clause, args)
1597
+
1598
+ for redacter, redacted in txn:
1599
+ d = event_dict.get(redacted)
1600
+ if d:
1601
+ d.redactions.append(redacter)
1602
+
1603
+ # check for MSC4293 redactions
1604
+ to_check = []
1605
+ events: list[_EventRow] = []
1606
+ for e in evs:
1607
+ try:
1608
+ event = event_dict.get(e)
1609
+ if not event:
1610
+ continue
1611
+ events.append(event)
1612
+ event_json = json.loads(event.json)
1613
+ room_id = event_json.get("room_id")
1614
+ user_id = event_json.get("sender")
1615
+ to_check.append((room_id, user_id))
1616
+ except Exception as exc:
1617
+ raise InvalidEventError(f"Invalid event {event_id}") from exc
1618
+
1619
+ # likely that some of these events may be for the same room/user combo, in
1620
+ # which case we don't need to do redundant queries
1621
+ to_check_set = set(to_check)
1622
+ room_redaction_sql = "SELECT room_id, user_id, redacting_event_id, redact_end_ordering FROM room_ban_redactions WHERE "
1623
+ (
1624
+ in_list_clause,
1625
+ room_redaction_args,
1626
+ ) = make_tuple_in_list_sql_clause(
1627
+ self.database_engine, ("room_id", "user_id"), to_check_set
1628
+ )
1629
+ txn.execute(room_redaction_sql + in_list_clause, room_redaction_args)
1630
+ for (
1631
+ returned_room_id,
1632
+ returned_user_id,
1633
+ redacting_event_id,
1634
+ redact_end_ordering,
1635
+ ) in txn:
1636
+ for e_row in events:
1637
+ e_json = json.loads(e_row.json)
1638
+ room_id = e_json.get("room_id")
1639
+ user_id = e_json.get("sender")
1640
+ room_and_user = (returned_room_id, returned_user_id)
1641
+ # check if we have a redaction match for this room, user combination
1642
+ if room_and_user != (room_id, user_id):
1643
+ continue
1644
+ if redact_end_ordering:
1645
+ # Avoid redacting any events arriving *after* the membership event which
1646
+ # ends an active redaction - note that this will always redact
1647
+ # backfilled events, as they have a negative stream ordering
1648
+ if e_row.stream_ordering >= redact_end_ordering:
1649
+ continue
1650
+ e_row.redactions.append(redacting_event_id)
1651
+ return event_dict
1652
+
1653
+ def _maybe_redact_event_row(
1654
+ self,
1655
+ original_ev: EventBase,
1656
+ redactions: Iterable[str],
1657
+ event_map: dict[str, EventBase],
1658
+ ) -> EventBase | None:
1659
+ """Given an event object and a list of possible redacting event ids,
1660
+ determine whether to honour any of those redactions and if so return a redacted
1661
+ event.
1662
+
1663
+ Args:
1664
+ original_ev: The original event.
1665
+ redactions: list of event ids of potential redaction events
1666
+ event_map: other events which have been fetched, in which we can
1667
+ look up the redaaction events. Map from event id to event.
1668
+
1669
+ Returns:
1670
+ If the event should be redacted, a pruned event object. Otherwise, None.
1671
+ """
1672
+ if original_ev.type == "m.room.create":
1673
+ # we choose to ignore redactions of m.room.create events.
1674
+ return None
1675
+
1676
+ for redaction_id in redactions:
1677
+ redaction_event = event_map.get(redaction_id)
1678
+ if not redaction_event or redaction_event.rejected_reason:
1679
+ # we don't have the redaction event, or the redaction event was not
1680
+ # authorized.
1681
+ logger.debug(
1682
+ "%s was redacted by %s but redaction not found/authed",
1683
+ original_ev.event_id,
1684
+ redaction_id,
1685
+ )
1686
+ continue
1687
+
1688
+ if redaction_event.room_id != original_ev.room_id:
1689
+ logger.debug(
1690
+ "%s was redacted by %s but redaction was in a different room!",
1691
+ original_ev.event_id,
1692
+ redaction_id,
1693
+ )
1694
+ continue
1695
+
1696
+ # Starting in room version v3, some redactions need to be
1697
+ # rechecked if we didn't have the redacted event at the
1698
+ # time, so we recheck on read instead.
1699
+ if redaction_event.internal_metadata.need_to_check_redaction():
1700
+ expected_domain = get_domain_from_id(original_ev.sender)
1701
+ if get_domain_from_id(redaction_event.sender) == expected_domain:
1702
+ # This redaction event is allowed. Mark as not needing a recheck.
1703
+ redaction_event.internal_metadata.recheck_redaction = False
1704
+ else:
1705
+ # Senders don't match, so the event isn't actually redacted
1706
+ logger.debug(
1707
+ "%s was redacted by %s but the senders don't match",
1708
+ original_ev.event_id,
1709
+ redaction_id,
1710
+ )
1711
+ continue
1712
+
1713
+ logger.debug("Redacting %s due to %s", original_ev.event_id, redaction_id)
1714
+
1715
+ # we found a good redaction event. Redact!
1716
+ redacted_event = prune_event(original_ev)
1717
+ redacted_event.unsigned["redacted_by"] = redaction_id
1718
+
1719
+ # It's fine to add the event directly, since get_pdu_json
1720
+ # will serialise this field correctly
1721
+ redacted_event.unsigned["redacted_because"] = redaction_event
1722
+
1723
+ return redacted_event
1724
+
1725
+ # no valid redaction found for this event
1726
+ return None
1727
+
1728
+ async def have_events_in_timeline(self, event_ids: Iterable[str]) -> set[str]:
1729
+ """Given a list of event ids, check if we have already processed and
1730
+ stored them as non outliers.
1731
+ """
1732
+ rows = cast(
1733
+ list[tuple[str]],
1734
+ await self.db_pool.simple_select_many_batch(
1735
+ table="events",
1736
+ retcols=("event_id",),
1737
+ column="event_id",
1738
+ iterable=list(event_ids),
1739
+ keyvalues={"outlier": False},
1740
+ desc="have_events_in_timeline",
1741
+ ),
1742
+ )
1743
+
1744
+ return {r[0] for r in rows}
1745
+
1746
+ @trace
1747
+ @tag_args
1748
+ async def have_seen_events(
1749
+ self, room_id: str, event_ids: Iterable[str]
1750
+ ) -> set[str]:
1751
+ """Given a list of event ids, check if we have already processed them.
1752
+
1753
+ The room_id is only used to structure the cache (so that it can later be
1754
+ invalidated by room_id) - there is no guarantee that the events are actually
1755
+ in the room in question.
1756
+
1757
+ Args:
1758
+ room_id: Room we are polling
1759
+ event_ids: events we are looking for
1760
+
1761
+ Returns:
1762
+ The set of events we have already seen.
1763
+ """
1764
+
1765
+ # @cachedList chomps lots of memory if you call it with a big list, so
1766
+ # we break it down. However, each batch requires its own index scan, so we make
1767
+ # the batches as big as possible.
1768
+
1769
+ results: set[str] = set()
1770
+ for event_ids_chunk in batch_iter(event_ids, 500):
1771
+ events_seen_dict = await self._have_seen_events_dict(
1772
+ room_id, event_ids_chunk
1773
+ )
1774
+ results.update(
1775
+ eid for (eid, have_event) in events_seen_dict.items() if have_event
1776
+ )
1777
+
1778
+ return results
1779
+
1780
+ @cachedList(cached_method_name="have_seen_event", list_name="event_ids")
1781
+ async def _have_seen_events_dict(
1782
+ self,
1783
+ room_id: str,
1784
+ event_ids: Collection[str],
1785
+ ) -> Mapping[str, bool]:
1786
+ """Helper for have_seen_events
1787
+
1788
+ Returns:
1789
+ a dict {event_id -> bool}
1790
+ """
1791
+ # TODO: We used to query the _get_event_cache here as a fast-path before
1792
+ # hitting the database. For if an event were in the cache, we've presumably
1793
+ # seen it before.
1794
+ #
1795
+ # But this is currently an invalid assumption due to the _get_event_cache
1796
+ # not being invalidated when purging events from a room. The optimisation can
1797
+ # be re-added after https://github.com/matrix-org/synapse/issues/13476
1798
+
1799
+ def have_seen_events_txn(txn: LoggingTransaction) -> dict[str, bool]:
1800
+ # we deliberately do *not* query the database for room_id, to make the
1801
+ # query an index-only lookup on `events_event_id_key`.
1802
+ #
1803
+ # We therefore pull the events from the database into a set...
1804
+
1805
+ sql = "SELECT event_id FROM events AS e WHERE "
1806
+ clause, args = make_in_list_sql_clause(
1807
+ txn.database_engine, "e.event_id", event_ids
1808
+ )
1809
+ txn.execute(sql + clause, args)
1810
+ found_events = {eid for (eid,) in txn}
1811
+
1812
+ # ... and then we can update the results for each key
1813
+ return {eid: (eid in found_events) for eid in event_ids}
1814
+
1815
+ return await self.db_pool.runInteraction(
1816
+ "have_seen_events", have_seen_events_txn
1817
+ )
1818
+
1819
+ @cached(max_entries=100000, tree=True)
1820
+ async def have_seen_event(self, room_id: str, event_id: str) -> bool:
1821
+ res = await self._have_seen_events_dict(room_id, [event_id])
1822
+ return res[event_id]
1823
+
1824
+ def _get_current_state_event_counts_txn(
1825
+ self, txn: LoggingTransaction, room_id: str
1826
+ ) -> int:
1827
+ """
1828
+ See get_current_state_event_counts.
1829
+ """
1830
+ sql = "SELECT COUNT(*) FROM current_state_events WHERE room_id=?"
1831
+ txn.execute(sql, (room_id,))
1832
+ row = txn.fetchone()
1833
+ return row[0] if row else 0
1834
+
1835
+ async def get_current_state_event_counts(self, room_id: str) -> int:
1836
+ """
1837
+ Gets the current number of state events in a room.
1838
+
1839
+ Args:
1840
+ room_id: The room ID to query.
1841
+
1842
+ Returns:
1843
+ The current number of state events.
1844
+ """
1845
+ return await self.db_pool.runInteraction(
1846
+ "get_current_state_event_counts",
1847
+ self._get_current_state_event_counts_txn,
1848
+ room_id,
1849
+ )
1850
+
1851
+ async def get_room_complexity(self, room_id: str) -> dict[str, float]:
1852
+ """
1853
+ Get a rough approximation of the complexity of the room. This is used by
1854
+ remote servers to decide whether they wish to join the room or not.
1855
+ Higher complexity value indicates that being in the room will consume
1856
+ more resources.
1857
+
1858
+ Args:
1859
+ room_id: The room ID to query.
1860
+
1861
+ Returns:
1862
+ Map of complexity version to complexity.
1863
+ """
1864
+ state_events = await self.get_current_state_event_counts(room_id)
1865
+
1866
+ # Call this one "v1", so we can introduce new ones as we want to develop
1867
+ # it.
1868
+ complexity_v1 = round(state_events / 500, 2)
1869
+
1870
+ return {"v1": complexity_v1}
1871
+
1872
+ async def get_all_new_forward_event_rows(
1873
+ self, instance_name: str, last_id: int, current_id: int, limit: int
1874
+ ) -> list[tuple[int, str, str, str, str, str, str, str, bool, bool]]:
1875
+ """Returns new events, for the Events replication stream
1876
+
1877
+ Args:
1878
+ last_id: the last stream_id from the previous batch.
1879
+ current_id: the maximum stream_id to return up to
1880
+ limit: the maximum number of rows to return
1881
+
1882
+ Returns:
1883
+ a list of events stream rows. Each tuple consists of a stream id as
1884
+ the first element, followed by fields suitable for casting into an
1885
+ EventsStreamRow.
1886
+ """
1887
+
1888
+ def get_all_new_forward_event_rows(
1889
+ txn: LoggingTransaction,
1890
+ ) -> list[tuple[int, str, str, str, str, str, str, str, bool, bool]]:
1891
+ sql = (
1892
+ "SELECT e.stream_ordering, e.event_id, e.room_id, e.type,"
1893
+ " se.state_key, redacts, relates_to_id, membership, rejections.reason IS NOT NULL,"
1894
+ " e.outlier"
1895
+ " FROM events AS e"
1896
+ " LEFT JOIN redactions USING (event_id)"
1897
+ " LEFT JOIN state_events AS se USING (event_id)"
1898
+ " LEFT JOIN event_relations USING (event_id)"
1899
+ " LEFT JOIN room_memberships USING (event_id)"
1900
+ " LEFT JOIN rejections USING (event_id)"
1901
+ " WHERE ? < stream_ordering AND stream_ordering <= ?"
1902
+ " AND instance_name = ?"
1903
+ " ORDER BY stream_ordering ASC"
1904
+ " LIMIT ?"
1905
+ )
1906
+ txn.execute(sql, (last_id, current_id, instance_name, limit))
1907
+ return cast(
1908
+ list[tuple[int, str, str, str, str, str, str, str, bool, bool]],
1909
+ txn.fetchall(),
1910
+ )
1911
+
1912
+ return await self.db_pool.runInteraction(
1913
+ "get_all_new_forward_event_rows", get_all_new_forward_event_rows
1914
+ )
1915
+
1916
+ async def get_ex_outlier_stream_rows(
1917
+ self, instance_name: str, last_id: int, current_id: int
1918
+ ) -> list[tuple[int, str, str, str, str, str, str, str, bool, bool]]:
1919
+ """Returns de-outliered events, for the Events replication stream
1920
+
1921
+ Args:
1922
+ last_id: the last stream_id from the previous batch.
1923
+ current_id: the maximum stream_id to return up to
1924
+
1925
+ Returns:
1926
+ a list of events stream rows. Each tuple consists of a stream id as
1927
+ the first element, followed by fields suitable for casting into an
1928
+ EventsStreamRow.
1929
+ """
1930
+
1931
+ def get_ex_outlier_stream_rows_txn(
1932
+ txn: LoggingTransaction,
1933
+ ) -> list[tuple[int, str, str, str, str, str, str, str, bool, bool]]:
1934
+ sql = (
1935
+ "SELECT out.event_stream_ordering, e.event_id, e.room_id, e.type,"
1936
+ " se.state_key, redacts, relates_to_id, membership, rejections.reason IS NOT NULL,"
1937
+ " e.outlier"
1938
+ " FROM events AS e"
1939
+ # NB: the next line (inner join) is what makes this query different from
1940
+ # get_all_new_forward_event_rows.
1941
+ " INNER JOIN ex_outlier_stream AS out USING (event_id)"
1942
+ " LEFT JOIN redactions USING (event_id)"
1943
+ " LEFT JOIN state_events AS se USING (event_id)"
1944
+ " LEFT JOIN event_relations USING (event_id)"
1945
+ " LEFT JOIN room_memberships USING (event_id)"
1946
+ " LEFT JOIN rejections USING (event_id)"
1947
+ " WHERE ? < out.event_stream_ordering"
1948
+ " AND out.event_stream_ordering <= ?"
1949
+ " AND out.instance_name = ?"
1950
+ " ORDER BY out.event_stream_ordering ASC"
1951
+ )
1952
+
1953
+ txn.execute(sql, (last_id, current_id, instance_name))
1954
+ return cast(
1955
+ list[tuple[int, str, str, str, str, str, str, str, bool, bool]],
1956
+ txn.fetchall(),
1957
+ )
1958
+
1959
+ return await self.db_pool.runInteraction(
1960
+ "get_ex_outlier_stream_rows", get_ex_outlier_stream_rows_txn
1961
+ )
1962
+
1963
+ async def get_all_new_backfill_event_rows(
1964
+ self, instance_name: str, last_id: int, current_id: int, limit: int
1965
+ ) -> tuple[list[tuple[int, tuple[str, str, str, str, str, str]]], int, bool]:
1966
+ """Get updates for backfill replication stream, including all new
1967
+ backfilled events and events that have gone from being outliers to not.
1968
+
1969
+ NOTE: The IDs given here are from replication, and so should be
1970
+ *positive*.
1971
+
1972
+ Args:
1973
+ instance_name: The writer we want to fetch updates from. Unused
1974
+ here since there is only ever one writer.
1975
+ last_id: The token to fetch updates from. Exclusive.
1976
+ current_id: The token to fetch updates up to. Inclusive.
1977
+ limit: The requested limit for the number of rows to return. The
1978
+ function may return more or fewer rows.
1979
+
1980
+ Returns:
1981
+ A tuple consisting of: the updates, a token to use to fetch
1982
+ subsequent updates, and whether we returned fewer rows than exists
1983
+ between the requested tokens due to the limit.
1984
+
1985
+ The token returned can be used in a subsequent call to this
1986
+ function to get further updatees.
1987
+
1988
+ The updates are a list of 2-tuples of stream ID and the row data
1989
+ """
1990
+ if last_id == current_id:
1991
+ return [], current_id, False
1992
+
1993
+ def get_all_new_backfill_event_rows(
1994
+ txn: LoggingTransaction,
1995
+ ) -> tuple[list[tuple[int, tuple[str, str, str, str, str, str]]], int, bool]:
1996
+ sql = (
1997
+ "SELECT -e.stream_ordering, e.event_id, e.room_id, e.type,"
1998
+ " se.state_key, redacts, relates_to_id"
1999
+ " FROM events AS e"
2000
+ " LEFT JOIN redactions USING (event_id)"
2001
+ " LEFT JOIN state_events AS se USING (event_id)"
2002
+ " LEFT JOIN event_relations USING (event_id)"
2003
+ " WHERE ? > stream_ordering AND stream_ordering >= ?"
2004
+ " AND instance_name = ?"
2005
+ " ORDER BY stream_ordering ASC"
2006
+ " LIMIT ?"
2007
+ )
2008
+ txn.execute(sql, (-last_id, -current_id, instance_name, limit))
2009
+ new_event_updates: list[
2010
+ tuple[int, tuple[str, str, str, str, str, str]]
2011
+ ] = []
2012
+ row: tuple[int, str, str, str, str, str, str]
2013
+ # Type safety: iterating over `txn` yields `Tuple`, i.e.
2014
+ # `Tuple[Any, ...]` of arbitrary length. Mypy detects assigning a
2015
+ # variadic tuple to a fixed length tuple and flags it up as an error.
2016
+ for row in txn:
2017
+ new_event_updates.append((row[0], row[1:]))
2018
+
2019
+ limited = False
2020
+ if len(new_event_updates) == limit:
2021
+ upper_bound = new_event_updates[-1][0]
2022
+ limited = True
2023
+ else:
2024
+ upper_bound = current_id
2025
+
2026
+ sql = (
2027
+ "SELECT -event_stream_ordering, e.event_id, e.room_id, e.type,"
2028
+ " se.state_key, redacts, relates_to_id"
2029
+ " FROM events AS e"
2030
+ " INNER JOIN ex_outlier_stream AS out USING (event_id)"
2031
+ " LEFT JOIN redactions USING (event_id)"
2032
+ " LEFT JOIN state_events AS se USING (event_id)"
2033
+ " LEFT JOIN event_relations USING (event_id)"
2034
+ " WHERE ? > event_stream_ordering"
2035
+ " AND event_stream_ordering >= ?"
2036
+ " AND out.instance_name = ?"
2037
+ " ORDER BY event_stream_ordering DESC"
2038
+ )
2039
+ txn.execute(sql, (-last_id, -upper_bound, instance_name))
2040
+ # Type safety: iterating over `txn` yields `Tuple`, i.e.
2041
+ # `Tuple[Any, ...]` of arbitrary length. Mypy detects assigning a
2042
+ # variadic tuple to a fixed length tuple and flags it up as an error.
2043
+ for row in txn:
2044
+ new_event_updates.append((row[0], row[1:]))
2045
+
2046
+ if len(new_event_updates) >= limit:
2047
+ upper_bound = new_event_updates[-1][0]
2048
+ limited = True
2049
+
2050
+ return new_event_updates, upper_bound, limited
2051
+
2052
+ return await self.db_pool.runInteraction(
2053
+ "get_all_new_backfill_event_rows", get_all_new_backfill_event_rows
2054
+ )
2055
+
2056
+ async def get_all_updated_current_state_deltas(
2057
+ self, instance_name: str, from_token: int, to_token: int, target_row_count: int
2058
+ ) -> tuple[list[tuple[int, str, str, str, str]], int, bool]:
2059
+ """Fetch updates from current_state_delta_stream
2060
+
2061
+ Args:
2062
+ from_token: The previous stream token. Updates from this stream id will
2063
+ be excluded.
2064
+
2065
+ to_token: The current stream token (ie the upper limit). Updates up to this
2066
+ stream id will be included (modulo the 'limit' param)
2067
+
2068
+ target_row_count: The number of rows to try to return. If more rows are
2069
+ available, we will set 'limited' in the result. In the event of a large
2070
+ batch, we may return more rows than this.
2071
+ Returns:
2072
+ A triplet `(updates, new_last_token, limited)`, where:
2073
+ * `updates` is a list of database tuples.
2074
+ * `new_last_token` is the new position in stream.
2075
+ * `limited` is whether there are more updates to fetch.
2076
+ """
2077
+
2078
+ def get_all_updated_current_state_deltas_txn(
2079
+ txn: LoggingTransaction,
2080
+ ) -> list[tuple[int, str, str, str, str]]:
2081
+ sql = """
2082
+ SELECT stream_id, room_id, type, state_key, event_id
2083
+ FROM current_state_delta_stream
2084
+ WHERE ? < stream_id AND stream_id <= ?
2085
+ AND instance_name = ?
2086
+ ORDER BY stream_id ASC LIMIT ?
2087
+ """
2088
+ txn.execute(sql, (from_token, to_token, instance_name, target_row_count))
2089
+ return cast(list[tuple[int, str, str, str, str]], txn.fetchall())
2090
+
2091
+ def get_deltas_for_stream_id_txn(
2092
+ txn: LoggingTransaction, stream_id: int
2093
+ ) -> list[tuple[int, str, str, str, str]]:
2094
+ sql = """
2095
+ SELECT stream_id, room_id, type, state_key, event_id
2096
+ FROM current_state_delta_stream
2097
+ WHERE stream_id = ?
2098
+ """
2099
+ txn.execute(sql, [stream_id])
2100
+ return cast(list[tuple[int, str, str, str, str]], txn.fetchall())
2101
+
2102
+ # we need to make sure that, for every stream id in the results, we get *all*
2103
+ # the rows with that stream id.
2104
+
2105
+ rows: list[tuple[int, str, str, str, str]] = await self.db_pool.runInteraction(
2106
+ "get_all_updated_current_state_deltas",
2107
+ get_all_updated_current_state_deltas_txn,
2108
+ )
2109
+
2110
+ # if we've got fewer rows than the limit, we're good
2111
+ if len(rows) < target_row_count:
2112
+ return rows, to_token, False
2113
+
2114
+ # we hit the limit, so reduce the upper limit so that we exclude the stream id
2115
+ # of the last row in the result.
2116
+ assert rows[-1][0] <= to_token
2117
+ to_token = rows[-1][0] - 1
2118
+
2119
+ # search backwards through the list for the point to truncate
2120
+ for idx in range(len(rows) - 1, 0, -1):
2121
+ if rows[idx - 1][0] <= to_token:
2122
+ return rows[:idx], to_token, True
2123
+
2124
+ # bother. We didn't get a full set of changes for even a single
2125
+ # stream id. let's run the query again, without a row limit, but for
2126
+ # just one stream id.
2127
+ to_token += 1
2128
+ rows = await self.db_pool.runInteraction(
2129
+ "get_deltas_for_stream_id", get_deltas_for_stream_id_txn, to_token
2130
+ )
2131
+
2132
+ return rows, to_token, True
2133
+
2134
+ async def get_senders_for_event_ids(
2135
+ self, event_ids: Collection[str]
2136
+ ) -> dict[str, str | None]:
2137
+ """
2138
+ Given a sequence of event IDs, return the sender associated with each.
2139
+
2140
+ Args:
2141
+ event_ids: A collection of event IDs as strings.
2142
+
2143
+ Returns:
2144
+ A dict of event ID -> sender of the event.
2145
+
2146
+ If a given event ID does not exist in the `events` table, then no entry
2147
+ for that event ID will be returned.
2148
+ """
2149
+
2150
+ def _get_senders_for_event_ids(
2151
+ txn: LoggingTransaction,
2152
+ ) -> dict[str, str | None]:
2153
+ rows = self.db_pool.simple_select_many_txn(
2154
+ txn=txn,
2155
+ table="events",
2156
+ column="event_id",
2157
+ iterable=event_ids,
2158
+ keyvalues={},
2159
+ retcols=["event_id", "sender"],
2160
+ )
2161
+ return dict(rows)
2162
+
2163
+ return await self.db_pool.runInteraction(
2164
+ "get_senders_for_event_ids", _get_senders_for_event_ids
2165
+ )
2166
+
2167
+ @cached(max_entries=5000)
2168
+ async def get_event_ordering(self, event_id: str, room_id: str) -> tuple[int, int]:
2169
+ res = await self.db_pool.simple_select_one(
2170
+ table="events",
2171
+ retcols=["topological_ordering", "stream_ordering"],
2172
+ keyvalues={"event_id": event_id, "room_id": room_id},
2173
+ allow_none=True,
2174
+ )
2175
+
2176
+ if not res:
2177
+ raise SynapseError(
2178
+ 404, "Could not find event %s in room %s" % (event_id, room_id)
2179
+ )
2180
+
2181
+ return int(res[0]), int(res[1])
2182
+
2183
+ async def get_next_event_to_expire(self) -> tuple[str, int] | None:
2184
+ """Retrieve the entry with the lowest expiry timestamp in the event_expiry
2185
+ table, or None if there's no more event to expire.
2186
+
2187
+ Returns:
2188
+ A tuple containing the event ID as its first element and an expiry timestamp
2189
+ as its second one, if there's at least one row in the event_expiry table.
2190
+ None otherwise.
2191
+ """
2192
+
2193
+ def get_next_event_to_expire_txn(
2194
+ txn: LoggingTransaction,
2195
+ ) -> tuple[str, int] | None:
2196
+ txn.execute(
2197
+ """
2198
+ SELECT event_id, expiry_ts FROM event_expiry
2199
+ ORDER BY expiry_ts ASC LIMIT 1
2200
+ """
2201
+ )
2202
+
2203
+ return cast(tuple[str, int] | None, txn.fetchone())
2204
+
2205
+ return await self.db_pool.runInteraction(
2206
+ desc="get_next_event_to_expire", func=get_next_event_to_expire_txn
2207
+ )
2208
+
2209
+ async def get_event_id_from_transaction_id_and_device_id(
2210
+ self, room_id: str, user_id: str, device_id: str, txn_id: str
2211
+ ) -> str | None:
2212
+ """Look up if we have already persisted an event for the transaction ID,
2213
+ returning the event ID if so.
2214
+ """
2215
+ return await self.db_pool.simple_select_one_onecol(
2216
+ table="event_txn_id_device_id",
2217
+ keyvalues={
2218
+ "room_id": room_id,
2219
+ "user_id": user_id,
2220
+ "device_id": device_id,
2221
+ "txn_id": txn_id,
2222
+ },
2223
+ retcol="event_id",
2224
+ allow_none=True,
2225
+ desc="get_event_id_from_transaction_id_and_device_id",
2226
+ )
2227
+
2228
+ async def get_already_persisted_events(
2229
+ self, events: Iterable[EventBase]
2230
+ ) -> dict[str, str]:
2231
+ """Look up if we have already persisted an event for the transaction ID,
2232
+ returning a mapping from event ID in the given list to the event ID of
2233
+ an existing event.
2234
+
2235
+ Also checks if there are duplicates in the given events, if there are
2236
+ will map duplicates to the *first* event.
2237
+ """
2238
+
2239
+ mapping = {}
2240
+ txn_id_to_event: dict[tuple[str, str, str, str], str] = {}
2241
+
2242
+ for event in events:
2243
+ device_id = getattr(event.internal_metadata, "device_id", None)
2244
+ txn_id = getattr(event.internal_metadata, "txn_id", None)
2245
+
2246
+ if device_id and txn_id:
2247
+ # Check if this is a duplicate of an event in the given events.
2248
+ existing = txn_id_to_event.get(
2249
+ (event.room_id, event.sender, device_id, txn_id)
2250
+ )
2251
+ if existing:
2252
+ mapping[event.event_id] = existing
2253
+ continue
2254
+
2255
+ # Check if this is a duplicate of an event we've already
2256
+ # persisted.
2257
+ existing = await self.get_event_id_from_transaction_id_and_device_id(
2258
+ event.room_id, event.sender, device_id, txn_id
2259
+ )
2260
+ if existing:
2261
+ mapping[event.event_id] = existing
2262
+ txn_id_to_event[
2263
+ (event.room_id, event.sender, device_id, txn_id)
2264
+ ] = existing
2265
+ else:
2266
+ txn_id_to_event[
2267
+ (event.room_id, event.sender, device_id, txn_id)
2268
+ ] = event.event_id
2269
+
2270
+ return mapping
2271
+
2272
+ @wrap_as_background_process("_cleanup_old_transaction_ids")
2273
+ async def _cleanup_old_transaction_ids(self) -> None:
2274
+ """Cleans out transaction id mappings older than 24hrs."""
2275
+
2276
+ def _cleanup_old_transaction_ids_txn(txn: LoggingTransaction) -> None:
2277
+ one_day_ago = self.clock.time_msec() - 24 * 60 * 60 * 1000
2278
+ sql = """
2279
+ DELETE FROM event_txn_id_device_id
2280
+ WHERE inserted_ts < ?
2281
+ """
2282
+ txn.execute(sql, (one_day_ago,))
2283
+
2284
+ return await self.db_pool.runInteraction(
2285
+ "_cleanup_old_transaction_ids",
2286
+ _cleanup_old_transaction_ids_txn,
2287
+ )
2288
+
2289
+ async def is_event_next_to_backward_gap(self, event: EventBase) -> bool:
2290
+ """Check if the given event is next to a backward gap of missing events.
2291
+ <latest messages> A(False)--->B(False)--->C(True)---> <gap, unknown events> <oldest messages>
2292
+
2293
+ Args:
2294
+ room_id: room where the event lives
2295
+ event: event to check (can't be an `outlier`)
2296
+
2297
+ Returns:
2298
+ Boolean indicating whether it's an extremity
2299
+ """
2300
+
2301
+ assert not event.internal_metadata.is_outlier(), (
2302
+ "is_event_next_to_backward_gap(...) can't be used with `outlier` events. "
2303
+ "This function relies on `event_backward_extremities` which won't be filled in for `outliers`."
2304
+ )
2305
+
2306
+ def is_event_next_to_backward_gap_txn(txn: LoggingTransaction) -> bool:
2307
+ # If the event in question has any of its prev_events listed as a
2308
+ # backward extremity, it's next to a gap.
2309
+ #
2310
+ # We can't just check the backward edges in `event_edges` because
2311
+ # when we persist events, we will also record the prev_events as
2312
+ # edges to the event in question regardless of whether we have those
2313
+ # prev_events yet. We need to check whether those prev_events are
2314
+ # backward extremities, also known as gaps, that need to be
2315
+ # backfilled.
2316
+ backward_extremity_query = """
2317
+ SELECT 1 FROM event_backward_extremities
2318
+ WHERE
2319
+ room_id = ?
2320
+ AND %s
2321
+ LIMIT 1
2322
+ """
2323
+
2324
+ # If the event in question is a backward extremity or has any of its
2325
+ # prev_events listed as a backward extremity, it's next to a
2326
+ # backward gap.
2327
+ clause, args = make_in_list_sql_clause(
2328
+ self.database_engine,
2329
+ "event_id",
2330
+ [event.event_id] + list(event.prev_event_ids()),
2331
+ )
2332
+
2333
+ txn.execute(backward_extremity_query % (clause,), [event.room_id] + args)
2334
+ backward_extremities = txn.fetchall()
2335
+
2336
+ # We consider any backward extremity as a backward gap
2337
+ if len(backward_extremities):
2338
+ return True
2339
+
2340
+ return False
2341
+
2342
+ return await self.db_pool.runInteraction(
2343
+ "is_event_next_to_backward_gap_txn",
2344
+ is_event_next_to_backward_gap_txn,
2345
+ )
2346
+
2347
+ async def is_event_next_to_forward_gap(self, event: EventBase) -> bool:
2348
+ """Check if the given event is next to a forward gap of missing events.
2349
+ The gap in front of the latest events is not considered a gap.
2350
+ <latest messages> A(False)--->B(False)--->C(False)---> <gap, unknown events> <oldest messages>
2351
+ <latest messages> A(False)--->B(False)---> <gap, unknown events> --->D(True)--->E(False) <oldest messages>
2352
+
2353
+ Args:
2354
+ room_id: room where the event lives
2355
+ event: event to check (can't be an `outlier`)
2356
+
2357
+ Returns:
2358
+ Boolean indicating whether it's an extremity
2359
+ """
2360
+
2361
+ assert not event.internal_metadata.is_outlier(), (
2362
+ "is_event_next_to_forward_gap(...) can't be used with `outlier` events. "
2363
+ "This function relies on `event_edges` and `event_forward_extremities` which won't be filled in for `outliers`."
2364
+ )
2365
+
2366
+ def is_event_next_to_gap_txn(txn: LoggingTransaction) -> bool:
2367
+ # If the event in question is a forward extremity, we will just
2368
+ # consider any potential forward gap as not a gap since it's one of
2369
+ # the latest events in the room.
2370
+ #
2371
+ # `event_forward_extremities` does not include backfilled or outlier
2372
+ # events so we can't rely on it to find forward gaps. We can only
2373
+ # use it to determine whether a message is the latest in the room.
2374
+ #
2375
+ # We can't combine this query with the `forward_edge_query` below
2376
+ # because if the event in question has no forward edges (isn't
2377
+ # referenced by any other event's prev_events) but is in
2378
+ # `event_forward_extremities`, we don't want to return 0 rows and
2379
+ # say it's next to a gap.
2380
+ forward_extremity_query = """
2381
+ SELECT 1 FROM event_forward_extremities
2382
+ WHERE
2383
+ room_id = ?
2384
+ AND event_id = ?
2385
+ LIMIT 1
2386
+ """
2387
+
2388
+ # We consider any forward extremity as the latest in the room and
2389
+ # not a forward gap.
2390
+ #
2391
+ # To expand, even though there is technically a gap at the front of
2392
+ # the room where the forward extremities are, we consider those the
2393
+ # latest messages in the room so asking other homeservers for more
2394
+ # is useless. The new latest messages will just be federated as
2395
+ # usual.
2396
+ txn.execute(forward_extremity_query, (event.room_id, event.event_id))
2397
+ if txn.fetchone():
2398
+ return False
2399
+
2400
+ # Check to see whether the event in question is already referenced
2401
+ # by another event. If we don't see any edges, we're next to a
2402
+ # forward gap.
2403
+ forward_edge_query = """
2404
+ SELECT 1 FROM event_edges
2405
+ /* Check to make sure the event referencing our event in question is not rejected */
2406
+ LEFT JOIN rejections ON event_edges.event_id = rejections.event_id
2407
+ WHERE
2408
+ event_edges.prev_event_id = ?
2409
+ /* It's not a valid edge if the event referencing our event in
2410
+ * question is rejected.
2411
+ */
2412
+ AND rejections.event_id IS NULL
2413
+ LIMIT 1
2414
+ """
2415
+
2416
+ # If there are no forward edges to the event in question (another
2417
+ # event hasn't referenced this event in their prev_events), then we
2418
+ # assume there is a forward gap in the history.
2419
+ txn.execute(forward_edge_query, (event.event_id,))
2420
+ if not txn.fetchone():
2421
+ return True
2422
+
2423
+ return False
2424
+
2425
+ return await self.db_pool.runInteraction(
2426
+ "is_event_next_to_gap_txn",
2427
+ is_event_next_to_gap_txn,
2428
+ )
2429
+
2430
+ async def get_event_id_for_timestamp(
2431
+ self, room_id: str, timestamp: int, direction: Direction
2432
+ ) -> str | None:
2433
+ """Find the closest event to the given timestamp in the given direction.
2434
+
2435
+ Args:
2436
+ room_id: Room to fetch the event from
2437
+ timestamp: The point in time (inclusive) we should navigate from in
2438
+ the given direction to find the closest event.
2439
+ direction: indicates whether we should navigate forward
2440
+ or backward from the given timestamp to find the closest event.
2441
+
2442
+ Returns:
2443
+ The closest event_id otherwise None if we can't find any event in
2444
+ the given direction.
2445
+ """
2446
+ if direction == Direction.BACKWARDS:
2447
+ # Find closest event *before* a given timestamp. We use descending
2448
+ # (which gives values largest to smallest) because we want the
2449
+ # largest possible timestamp *before* the given timestamp.
2450
+ comparison_operator = "<="
2451
+ order = "DESC"
2452
+ else:
2453
+ # Find closest event *after* a given timestamp. We use ascending
2454
+ # (which gives values smallest to largest) because we want the
2455
+ # closest possible timestamp *after* the given timestamp.
2456
+ comparison_operator = ">="
2457
+ order = "ASC"
2458
+
2459
+ sql_template = f"""
2460
+ SELECT event_id FROM events
2461
+ LEFT JOIN rejections USING (event_id)
2462
+ WHERE
2463
+ room_id = ?
2464
+ AND origin_server_ts {comparison_operator} ?
2465
+ /**
2466
+ * Make sure the event isn't an `outlier` because we have no way
2467
+ * to later check whether it's next to a gap. `outliers` do not
2468
+ * have entries in the `event_edges`, `event_forward_extremeties`,
2469
+ * and `event_backward_extremities` tables to check against
2470
+ * (used by `is_event_next_to_backward_gap` and `is_event_next_to_forward_gap`).
2471
+ */
2472
+ AND NOT outlier
2473
+ /* Make sure event is not rejected */
2474
+ AND rejections.event_id IS NULL
2475
+ /**
2476
+ * First sort by the message timestamp. If the message timestamps are the
2477
+ * same, we want the message that logically comes "next" (before/after
2478
+ * the given timestamp) based on the DAG and its topological order (`depth`).
2479
+ * Finally, we can tie-break based on when it was received on the server
2480
+ * (`stream_ordering`).
2481
+ */
2482
+ ORDER BY origin_server_ts {order}, depth {order}, stream_ordering {order}
2483
+ LIMIT 1;
2484
+ """
2485
+
2486
+ def get_event_id_for_timestamp_txn(txn: LoggingTransaction) -> str | None:
2487
+ txn.execute(
2488
+ sql_template,
2489
+ (room_id, timestamp),
2490
+ )
2491
+ row = txn.fetchone()
2492
+ if row:
2493
+ (event_id,) = row
2494
+ return event_id
2495
+
2496
+ return None
2497
+
2498
+ return await self.db_pool.runInteraction(
2499
+ "get_event_id_for_timestamp_txn",
2500
+ get_event_id_for_timestamp_txn,
2501
+ )
2502
+
2503
+ @cachedList(cached_method_name="is_partial_state_event", list_name="event_ids")
2504
+ async def get_partial_state_events(
2505
+ self, event_ids: Collection[str]
2506
+ ) -> Mapping[str, bool]:
2507
+ """Checks which of the given events have partial state
2508
+
2509
+ Args:
2510
+ event_ids: the events we want to check for partial state.
2511
+
2512
+ Returns:
2513
+ a dict mapping from event id to partial-stateness. We return True for
2514
+ any of the events which are unknown (or are outliers).
2515
+ """
2516
+ result = cast(
2517
+ list[tuple[str]],
2518
+ await self.db_pool.simple_select_many_batch(
2519
+ table="partial_state_events",
2520
+ column="event_id",
2521
+ iterable=event_ids,
2522
+ retcols=["event_id"],
2523
+ desc="get_partial_state_events",
2524
+ ),
2525
+ )
2526
+ # convert the result to a dict, to make @cachedList work
2527
+ partial = {r[0] for r in result}
2528
+ return {e_id: e_id in partial for e_id in event_ids}
2529
+
2530
+ @cached()
2531
+ async def is_partial_state_event(self, event_id: str) -> bool:
2532
+ """Checks if the given event has partial state"""
2533
+ result = await self.db_pool.simple_select_one_onecol(
2534
+ table="partial_state_events",
2535
+ keyvalues={"event_id": event_id},
2536
+ retcol="1",
2537
+ allow_none=True,
2538
+ desc="is_partial_state_event",
2539
+ )
2540
+ return result is not None
2541
+
2542
+ async def get_partial_state_events_batch(self, room_id: str) -> list[str]:
2543
+ """
2544
+ Get a list of events in the given room that:
2545
+ - have partial state; and
2546
+ - are ready to be resynced (because they have no prev_events that are
2547
+ partial-stated)
2548
+
2549
+ See the docstring on `_get_partial_state_events_batch_txn` for more
2550
+ information.
2551
+ """
2552
+ return await self.db_pool.runInteraction(
2553
+ "get_partial_state_events_batch",
2554
+ self._get_partial_state_events_batch_txn,
2555
+ room_id,
2556
+ )
2557
+
2558
+ @staticmethod
2559
+ def _get_partial_state_events_batch_txn(
2560
+ txn: LoggingTransaction, room_id: str
2561
+ ) -> list[str]:
2562
+ # we want to work through the events from oldest to newest, so
2563
+ # we only want events whose prev_events do *not* have partial state - hence
2564
+ # the 'NOT EXISTS' clause in the below.
2565
+ #
2566
+ # This is necessary because ordering by stream ordering isn't quite enough
2567
+ # to ensure that we work from oldest to newest event (in particular,
2568
+ # if an event is initially persisted as an outlier and later de-outliered,
2569
+ # it can end up with a lower stream_ordering than its prev_events).
2570
+ #
2571
+ # Typically this means we'll only return one event per batch, but that's
2572
+ # hard to do much about.
2573
+ #
2574
+ # See also: https://github.com/matrix-org/synapse/issues/13001
2575
+ txn.execute(
2576
+ """
2577
+ SELECT event_id FROM partial_state_events AS pse
2578
+ JOIN events USING (event_id)
2579
+ WHERE pse.room_id = ? AND
2580
+ NOT EXISTS(
2581
+ SELECT 1 FROM event_edges AS ee
2582
+ JOIN partial_state_events AS prev_pse ON (prev_pse.event_id=ee.prev_event_id)
2583
+ WHERE ee.event_id=pse.event_id
2584
+ )
2585
+ ORDER BY events.stream_ordering
2586
+ LIMIT 100
2587
+ """,
2588
+ (room_id,),
2589
+ )
2590
+ return [row[0] for row in txn]
2591
+
2592
+ def mark_event_rejected_txn(
2593
+ self,
2594
+ txn: LoggingTransaction,
2595
+ event_id: str,
2596
+ rejection_reason: str | None,
2597
+ ) -> None:
2598
+ """Mark an event that was previously accepted as rejected, or vice versa
2599
+
2600
+ This can happen, for example, when resyncing state during a faster join.
2601
+
2602
+ It is the caller's responsibility to ensure that other workers are
2603
+ sent a notification so that they call `_invalidate_local_get_event_cache()`.
2604
+
2605
+ Args:
2606
+ txn:
2607
+ event_id: ID of event to update
2608
+ rejection_reason: reason it has been rejected, or None if it is now accepted
2609
+ """
2610
+ if rejection_reason is None:
2611
+ logger.info(
2612
+ "Marking previously-processed event %s as accepted",
2613
+ event_id,
2614
+ )
2615
+ self.db_pool.simple_delete_txn(
2616
+ txn,
2617
+ "rejections",
2618
+ keyvalues={"event_id": event_id},
2619
+ )
2620
+ else:
2621
+ logger.info(
2622
+ "Marking previously-processed event %s as rejected(%s)",
2623
+ event_id,
2624
+ rejection_reason,
2625
+ )
2626
+ self.db_pool.simple_upsert_txn(
2627
+ txn,
2628
+ table="rejections",
2629
+ keyvalues={"event_id": event_id},
2630
+ values={
2631
+ "reason": rejection_reason,
2632
+ "last_check": self.clock.time_msec(),
2633
+ },
2634
+ )
2635
+ self.db_pool.simple_update_txn(
2636
+ txn,
2637
+ table="events",
2638
+ keyvalues={"event_id": event_id},
2639
+ updatevalues={"rejection_reason": rejection_reason},
2640
+ )
2641
+
2642
+ self.invalidate_get_event_cache_after_txn(txn, event_id)
2643
+
2644
+ async def get_events_sent_by_user_in_room(
2645
+ self, user_id: str, room_id: str, limit: int, filter: list[str] | None = None
2646
+ ) -> list[str] | None:
2647
+ """
2648
+ Get a list of event ids of events sent by the user in the specified room
2649
+
2650
+ Args:
2651
+ user_id: user ID to search against
2652
+ room_id: room ID of the room to search for events in
2653
+ filter: type of events to filter for
2654
+ limit: maximum number of event ids to return
2655
+ """
2656
+
2657
+ def _get_events_by_user_in_room_txn(
2658
+ txn: LoggingTransaction,
2659
+ user_id: str,
2660
+ room_id: str,
2661
+ filter: list[str] | None,
2662
+ batch_size: int,
2663
+ offset: int,
2664
+ ) -> tuple[list[str] | None, int]:
2665
+ if filter:
2666
+ base_clause, args = make_in_list_sql_clause(
2667
+ txn.database_engine, "type", filter
2668
+ )
2669
+ clause = f"AND {base_clause}"
2670
+ parameters = (user_id, room_id, *args, batch_size, offset)
2671
+ else:
2672
+ clause = ""
2673
+ parameters = (user_id, room_id, batch_size, offset)
2674
+
2675
+ sql = f"""
2676
+ SELECT event_id FROM events
2677
+ WHERE sender = ? AND room_id = ?
2678
+ {clause}
2679
+ ORDER BY received_ts DESC
2680
+ LIMIT ?
2681
+ OFFSET ?
2682
+ """
2683
+ txn.execute(sql, parameters)
2684
+ res = txn.fetchall()
2685
+ if res:
2686
+ events = [row[0] for row in res]
2687
+ else:
2688
+ events = None
2689
+
2690
+ return events, offset + batch_size
2691
+
2692
+ offset = 0
2693
+ batch_size = 100
2694
+ if batch_size > limit:
2695
+ batch_size = limit
2696
+
2697
+ selected_ids: list[str] = []
2698
+ while offset < limit:
2699
+ res, offset = await self.db_pool.runInteraction(
2700
+ "get_events_by_user",
2701
+ _get_events_by_user_in_room_txn,
2702
+ user_id,
2703
+ room_id,
2704
+ filter,
2705
+ batch_size,
2706
+ offset,
2707
+ )
2708
+ if res:
2709
+ selected_ids = selected_ids + res
2710
+ else:
2711
+ break
2712
+ return selected_ids
2713
+
2714
+ async def have_finished_sliding_sync_background_jobs(self) -> bool:
2715
+ """Return if it's safe to use the sliding sync membership tables."""
2716
+
2717
+ if self._has_finished_sliding_sync_background_jobs:
2718
+ # as an optimisation, once the job finishes, don't issue another
2719
+ # database transaction to check it, since it won't 'un-finish'
2720
+ return True
2721
+
2722
+ self._has_finished_sliding_sync_background_jobs = await self.db_pool.updates.have_completed_background_updates(
2723
+ (
2724
+ _BackgroundUpdates.SLIDING_SYNC_PREFILL_JOINED_ROOMS_TO_RECALCULATE_TABLE_BG_UPDATE,
2725
+ _BackgroundUpdates.SLIDING_SYNC_JOINED_ROOMS_BG_UPDATE,
2726
+ _BackgroundUpdates.SLIDING_SYNC_MEMBERSHIP_SNAPSHOTS_BG_UPDATE,
2727
+ )
2728
+ )
2729
+ return self._has_finished_sliding_sync_background_jobs
2730
+
2731
+ async def get_sent_invite_count_by_user(self, user_id: str, from_ts: int) -> int:
2732
+ """
2733
+ Get the number of invites sent by the given user at or after the provided timestamp.
2734
+
2735
+ Args:
2736
+ user_id: user ID to search against
2737
+ from_ts: a timestamp in milliseconds from the unix epoch. Filters against
2738
+ `events.received_ts`
2739
+
2740
+ """
2741
+
2742
+ def _get_sent_invite_count_by_user_txn(
2743
+ txn: LoggingTransaction, user_id: str, from_ts: int
2744
+ ) -> int:
2745
+ sql = """
2746
+ SELECT COUNT(rm.event_id)
2747
+ FROM room_memberships AS rm
2748
+ INNER JOIN events AS e USING(event_id)
2749
+ WHERE rm.sender = ?
2750
+ AND rm.membership = 'invite'
2751
+ AND e.type = 'm.room.member'
2752
+ AND e.received_ts >= ?
2753
+ """
2754
+
2755
+ txn.execute(sql, (user_id, from_ts))
2756
+ res = txn.fetchone()
2757
+
2758
+ if res is None:
2759
+ return 0
2760
+ return int(res[0])
2761
+
2762
+ return await self.db_pool.runInteraction(
2763
+ "_get_sent_invite_count_by_user_txn",
2764
+ _get_sent_invite_count_by_user_txn,
2765
+ user_id,
2766
+ from_ts,
2767
+ )
2768
+
2769
+ @cached(tree=True)
2770
+ async def get_metadata_for_event(
2771
+ self, room_id: str, event_id: str
2772
+ ) -> EventMetadata | None:
2773
+ row = await self.db_pool.simple_select_one(
2774
+ table="events",
2775
+ keyvalues={"room_id": room_id, "event_id": event_id},
2776
+ retcols=("sender", "received_ts"),
2777
+ allow_none=True,
2778
+ desc="get_metadata_for_event",
2779
+ )
2780
+ if row is None:
2781
+ return None
2782
+
2783
+ return EventMetadata(
2784
+ sender=row[0],
2785
+ received_ts=row[1],
2786
+ )