matrix-synapse 1.145.0rc2__cp310-abi3-manylinux_2_28_x86_64.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.

Potentially problematic release.


This version of matrix-synapse might be problematic. Click here for more details.

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