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,2366 @@
1
+ #
2
+ # This file is licensed under the Affero General Public License (AGPL) version 3.
3
+ #
4
+ # Copyright 2020 Sorunome
5
+ # Copyright 2016-2020 The Matrix.org Foundation C.I.C.
6
+ # Copyright (C) 2023 New Vector, Ltd
7
+ #
8
+ # This program is free software: you can redistribute it and/or modify
9
+ # it under the terms of the GNU Affero General Public License as
10
+ # published by the Free Software Foundation, either version 3 of the
11
+ # License, or (at your option) any later version.
12
+ #
13
+ # See the GNU Affero General Public License for more details:
14
+ # <https://www.gnu.org/licenses/agpl-3.0.html>.
15
+ #
16
+ # Originally licensed under the Apache License, Version 2.0:
17
+ # <http://www.apache.org/licenses/LICENSE-2.0>.
18
+ #
19
+ # [This file includes modifications made by New Vector Limited]
20
+ #
21
+ #
22
+ import abc
23
+ import logging
24
+ import random
25
+ from http import HTTPStatus
26
+ from typing import TYPE_CHECKING, Iterable
27
+
28
+ from synapse import types
29
+ from synapse.api.constants import (
30
+ AccountDataTypes,
31
+ EventContentFields,
32
+ EventTypes,
33
+ GuestAccess,
34
+ Membership,
35
+ )
36
+ from synapse.api.errors import (
37
+ AuthError,
38
+ Codes,
39
+ PartialStateConflictError,
40
+ ShadowBanError,
41
+ SynapseError,
42
+ )
43
+ from synapse.api.ratelimiting import Ratelimiter
44
+ from synapse.event_auth import get_named_level, get_power_level_event
45
+ from synapse.events import EventBase, is_creator
46
+ from synapse.events.snapshot import EventContext
47
+ from synapse.handlers.pagination import PURGE_ROOM_ACTION_NAME
48
+ from synapse.handlers.profile import MAX_AVATAR_URL_LEN, MAX_DISPLAYNAME_LEN
49
+ from synapse.handlers.state_deltas import MatchChange, StateDeltasHandler
50
+ from synapse.handlers.worker_lock import NEW_EVENT_DURING_PURGE_LOCK_NAME
51
+ from synapse.logging import opentracing
52
+ from synapse.metrics import SERVER_NAME_LABEL, event_processing_positions
53
+ from synapse.replication.http.push import ReplicationCopyPusherRestServlet
54
+ from synapse.storage.databases.main.state_deltas import StateDelta
55
+ from synapse.storage.invite_rule import InviteRule
56
+ from synapse.types import (
57
+ JsonDict,
58
+ Requester,
59
+ RoomAlias,
60
+ RoomID,
61
+ StateMap,
62
+ UserID,
63
+ create_requester,
64
+ get_domain_from_id,
65
+ )
66
+ from synapse.types.state import StateFilter
67
+ from synapse.util.async_helpers import Linearizer
68
+ from synapse.util.distributor import user_left_room
69
+ from synapse.util.duration import Duration
70
+
71
+ if TYPE_CHECKING:
72
+ from synapse.server import HomeServer
73
+
74
+
75
+ logger = logging.getLogger(__name__)
76
+
77
+
78
+ class NoKnownServersError(SynapseError):
79
+ """No server already resident to the room was provided to the join/knock operation."""
80
+
81
+ def __init__(self, msg: str = "No known servers"):
82
+ super().__init__(404, msg)
83
+
84
+
85
+ class RoomMemberHandler(metaclass=abc.ABCMeta):
86
+ # TODO(paul): This handler currently contains a messy conflation of
87
+ # low-level API that works on UserID objects and so on, and REST-level
88
+ # API that takes ID strings and returns pagination chunks. These concerns
89
+ # ought to be separated out a lot better.
90
+
91
+ def __init__(self, hs: "HomeServer"):
92
+ self.hs = hs
93
+ self.store = hs.get_datastores().main
94
+ self._storage_controllers = hs.get_storage_controllers()
95
+ self.auth = hs.get_auth()
96
+ self.state_handler = hs.get_state_handler()
97
+ self.config = hs.config
98
+ self._server_name = hs.hostname
99
+
100
+ self.federation_handler = hs.get_federation_handler()
101
+ self.directory_handler = hs.get_directory_handler()
102
+ self.identity_handler = hs.get_identity_handler()
103
+ self.registration_handler = hs.get_registration_handler()
104
+ self.profile_handler = hs.get_profile_handler()
105
+ self.event_creation_handler = hs.get_event_creation_handler()
106
+ self.account_data_handler = hs.get_account_data_handler()
107
+ self.event_auth_handler = hs.get_event_auth_handler()
108
+ self._worker_lock_handler = hs.get_worker_locks_handler()
109
+
110
+ self._membership_types_to_include_profile_data_in = {
111
+ Membership.JOIN,
112
+ Membership.KNOCK,
113
+ }
114
+ if self.hs.config.server.include_profile_data_on_invite:
115
+ self._membership_types_to_include_profile_data_in.add(Membership.INVITE)
116
+
117
+ self.member_linearizer: Linearizer = Linearizer(
118
+ name="member", clock=hs.get_clock()
119
+ )
120
+ self.member_as_limiter = Linearizer(
121
+ max_count=10, name="member_as_limiter", clock=hs.get_clock()
122
+ )
123
+
124
+ self.clock = hs.get_clock()
125
+ self._spam_checker_module_callbacks = hs.get_module_api_callbacks().spam_checker
126
+ self._third_party_event_rules = (
127
+ hs.get_module_api_callbacks().third_party_event_rules
128
+ )
129
+ self._server_notices_mxid = self.config.servernotices.server_notices_mxid
130
+ self._enable_lookup = hs.config.registration.enable_3pid_lookup
131
+ self.allow_per_room_profiles = self.config.server.allow_per_room_profiles
132
+
133
+ self._join_rate_limiter_local = Ratelimiter(
134
+ store=self.store,
135
+ clock=self.clock,
136
+ cfg=hs.config.ratelimiting.rc_joins_local,
137
+ )
138
+ # Tracks joins from local users to rooms this server isn't a member of.
139
+ # I.e. joins this server makes by requesting /make_join /send_join from
140
+ # another server.
141
+ self._join_rate_limiter_remote = Ratelimiter(
142
+ store=self.store,
143
+ clock=self.clock,
144
+ cfg=hs.config.ratelimiting.rc_joins_remote,
145
+ )
146
+ # TODO: find a better place to keep this Ratelimiter.
147
+ # It needs to be
148
+ # - written to by event persistence code
149
+ # - written to by something which can snoop on replication streams
150
+ # - read by the RoomMemberHandler to rate limit joins from local users
151
+ # - read by the FederationServer to rate limit make_joins and send_joins from
152
+ # other homeservers
153
+ # I wonder if a homeserver-wide collection of rate limiters might be cleaner?
154
+ self._join_rate_per_room_limiter = Ratelimiter(
155
+ store=self.store,
156
+ clock=self.clock,
157
+ cfg=hs.config.ratelimiting.rc_joins_per_room,
158
+ )
159
+
160
+ # Ratelimiter for invites, keyed by room (across all issuers, all
161
+ # recipients).
162
+ self._invites_per_room_limiter = Ratelimiter(
163
+ store=self.store,
164
+ clock=self.clock,
165
+ cfg=hs.config.ratelimiting.rc_invites_per_room,
166
+ ratelimit_callbacks=hs.get_module_api_callbacks().ratelimit,
167
+ )
168
+
169
+ # Ratelimiter for invites, keyed by recipient (across all rooms, all
170
+ # issuers).
171
+ self._invites_per_recipient_limiter = Ratelimiter(
172
+ store=self.store,
173
+ clock=self.clock,
174
+ cfg=hs.config.ratelimiting.rc_invites_per_user,
175
+ ratelimit_callbacks=hs.get_module_api_callbacks().ratelimit,
176
+ )
177
+
178
+ # Ratelimiter for invites, keyed by issuer (across all rooms, all
179
+ # recipients).
180
+ self._invites_per_issuer_limiter = Ratelimiter(
181
+ store=self.store,
182
+ clock=self.clock,
183
+ cfg=hs.config.ratelimiting.rc_invites_per_issuer,
184
+ ratelimit_callbacks=hs.get_module_api_callbacks().ratelimit,
185
+ )
186
+
187
+ self._third_party_invite_limiter = Ratelimiter(
188
+ store=self.store,
189
+ clock=self.clock,
190
+ cfg=hs.config.ratelimiting.rc_third_party_invite,
191
+ )
192
+
193
+ self.request_ratelimiter = hs.get_request_ratelimiter()
194
+ hs.get_notifier().add_new_join_in_room_callback(self._on_user_joined_room)
195
+
196
+ self._forgotten_room_retention_period = (
197
+ hs.config.server.forgotten_room_retention_period
198
+ )
199
+
200
+ self._is_push_writer = (
201
+ hs.get_instance_name() in hs.config.worker.writers.push_rules
202
+ )
203
+ self._push_writer = hs.config.worker.writers.push_rules[0]
204
+ self._copy_push_client = ReplicationCopyPusherRestServlet.make_client(hs)
205
+
206
+ def _on_user_joined_room(self, event_id: str, room_id: str) -> None:
207
+ """Notify the rate limiter that a room join has occurred.
208
+
209
+ Use this to inform the RoomMemberHandler about joins that have either
210
+ - taken place on another homeserver, or
211
+ - on another worker in this homeserver.
212
+ Joins actioned by this worker should use the usual `ratelimit` method, which
213
+ checks the limit and increments the counter in one go.
214
+ """
215
+ self._join_rate_per_room_limiter.record_action(requester=None, key=room_id)
216
+
217
+ @abc.abstractmethod
218
+ async def _remote_join(
219
+ self,
220
+ requester: Requester,
221
+ remote_room_hosts: list[str],
222
+ room_id: str,
223
+ user: UserID,
224
+ content: dict,
225
+ ) -> tuple[str, int]:
226
+ """Try and join a room that this server is not in
227
+
228
+ Args:
229
+ requester: The user making the request, according to the access token.
230
+ remote_room_hosts: List of servers that can be used to join via.
231
+ room_id: Room that we are trying to join
232
+ user: User who is trying to join
233
+ content: A dict that should be used as the content of the join event.
234
+
235
+ Raises:
236
+ NoKnownServersError: if remote_room_hosts does not contain a server joined to
237
+ the room.
238
+ """
239
+ raise NotImplementedError()
240
+
241
+ @abc.abstractmethod
242
+ async def remote_knock(
243
+ self,
244
+ requester: Requester,
245
+ remote_room_hosts: list[str],
246
+ room_id: str,
247
+ user: UserID,
248
+ content: dict,
249
+ ) -> tuple[str, int]:
250
+ """Try and knock on a room that this server is not in
251
+
252
+ Args:
253
+ remote_room_hosts: List of servers that can be used to knock via.
254
+ room_id: Room that we are trying to knock on.
255
+ user: User who is trying to knock.
256
+ content: A dict that should be used as the content of the knock event.
257
+ """
258
+ raise NotImplementedError()
259
+
260
+ @abc.abstractmethod
261
+ async def remote_reject_invite(
262
+ self,
263
+ invite_event_id: str,
264
+ txn_id: str | None,
265
+ requester: Requester,
266
+ content: JsonDict,
267
+ ) -> tuple[str, int]:
268
+ """
269
+ Rejects an out-of-band invite we have received from a remote server
270
+
271
+ Args:
272
+ invite_event_id: ID of the invite to be rejected
273
+ txn_id: optional transaction ID supplied by the client
274
+ requester: user making the rejection request, according to the access token
275
+ content: additional content to include in the rejection event.
276
+ Normally an empty dict.
277
+
278
+ Returns:
279
+ event id, stream_id of the leave event
280
+ """
281
+ raise NotImplementedError()
282
+
283
+ @abc.abstractmethod
284
+ async def remote_rescind_knock(
285
+ self,
286
+ knock_event_id: str,
287
+ txn_id: str | None,
288
+ requester: Requester,
289
+ content: JsonDict,
290
+ ) -> tuple[str, int]:
291
+ """Rescind a local knock made on a remote room.
292
+
293
+ Args:
294
+ knock_event_id: The ID of the knock event to rescind.
295
+ txn_id: An optional transaction ID supplied by the client.
296
+ requester: The user making the request, according to the access token.
297
+ content: The content of the generated leave event.
298
+
299
+ Returns:
300
+ A tuple containing (event_id, stream_id of the leave event).
301
+ """
302
+ raise NotImplementedError()
303
+
304
+ @abc.abstractmethod
305
+ async def _user_left_room(self, target: UserID, room_id: str) -> None:
306
+ """Notifies distributor on master process that the user has left the
307
+ room.
308
+
309
+ Args:
310
+ target
311
+ room_id
312
+ """
313
+ raise NotImplementedError()
314
+
315
+ async def forget(
316
+ self, user: UserID, room_id: str, do_not_schedule_purge: bool = False
317
+ ) -> None:
318
+ user_id = user.to_string()
319
+
320
+ member = await self._storage_controllers.state.get_current_state_event(
321
+ room_id=room_id, event_type=EventTypes.Member, state_key=user_id
322
+ )
323
+ membership = member.membership if member else None
324
+
325
+ if membership is not None and membership not in [
326
+ Membership.LEAVE,
327
+ Membership.BAN,
328
+ ]:
329
+ raise SynapseError(400, "User %s in room %s" % (user_id, room_id))
330
+
331
+ # In normal case this call is only required if `membership` is not `None`.
332
+ # But: After the last member had left the room, the background update
333
+ # `_background_remove_left_rooms` is deleting rows related to this room from
334
+ # the table `current_state_events` and `get_current_state_events` is `None`.
335
+ await self.store.forget(user_id, room_id)
336
+
337
+ # If everyone locally has left the room, then there is no reason for us to keep the
338
+ # room around and we automatically purge room after a little bit
339
+ if (
340
+ not do_not_schedule_purge
341
+ and self._forgotten_room_retention_period
342
+ and await self.store.is_locally_forgotten_room(room_id)
343
+ ):
344
+ await self.hs.get_task_scheduler().schedule_task(
345
+ PURGE_ROOM_ACTION_NAME,
346
+ resource_id=room_id,
347
+ timestamp=self.clock.time_msec()
348
+ + self._forgotten_room_retention_period,
349
+ )
350
+
351
+ async def ratelimit_multiple_invites(
352
+ self,
353
+ requester: Requester | None,
354
+ room_id: str | None,
355
+ n_invites: int,
356
+ update: bool = True,
357
+ ) -> None:
358
+ """Ratelimit more than one invite sent by the given requester in the given room.
359
+
360
+ Args:
361
+ requester: The requester sending the invites.
362
+ room_id: The room the invites are being sent in.
363
+ n_invites: The amount of invites to ratelimit for.
364
+ update: Whether to update the ratelimiter's cache.
365
+
366
+ Raises:
367
+ LimitExceededError: The requester can't send that many invites in the room.
368
+ """
369
+ await self._invites_per_room_limiter.ratelimit(
370
+ requester,
371
+ room_id,
372
+ update=update,
373
+ n_actions=n_invites,
374
+ )
375
+
376
+ async def ratelimit_invite(
377
+ self,
378
+ requester: Requester | None,
379
+ room_id: str | None,
380
+ invitee_user_id: str,
381
+ ) -> None:
382
+ """Ratelimit invites by room and by target user.
383
+
384
+ If room ID is missing then we just rate limit by target user.
385
+ """
386
+ if room_id:
387
+ await self._invites_per_room_limiter.ratelimit(requester, room_id)
388
+
389
+ await self._invites_per_recipient_limiter.ratelimit(requester, invitee_user_id)
390
+ if requester is not None:
391
+ await self._invites_per_issuer_limiter.ratelimit(requester)
392
+
393
+ async def _local_membership_update(
394
+ self,
395
+ *,
396
+ requester: Requester,
397
+ target: UserID,
398
+ room_id: str,
399
+ membership: str,
400
+ prev_event_ids: list[str] | None = None,
401
+ state_event_ids: list[str] | None = None,
402
+ depth: int | None = None,
403
+ txn_id: str | None = None,
404
+ ratelimit: bool = True,
405
+ content: dict | None = None,
406
+ require_consent: bool = True,
407
+ outlier: bool = False,
408
+ origin_server_ts: int | None = None,
409
+ ) -> tuple[str, int]:
410
+ """
411
+ Internal membership update function to get an existing event or create
412
+ and persist a new event for the new membership change.
413
+
414
+ Args:
415
+ requester: User requesting the membership change, i.e. the sender of the
416
+ desired membership event.
417
+ target: Use whose membership should change, i.e. the state_key of the
418
+ desired membership event.
419
+ room_id:
420
+ membership:
421
+ prev_event_ids: The event IDs to use as the prev events
422
+ state_event_ids:
423
+ The full state at a given event. This was previously used particularly
424
+ by the MSC2716 /batch_send endpoint. This should normally be left as
425
+ None, which will cause the auth_event_ids to be calculated based on the
426
+ room state at the prev_events.
427
+ depth: Override the depth used to order the event in the DAG.
428
+ Should normally be set to None, which will cause the depth to be calculated
429
+ based on the prev_events.
430
+
431
+ txn_id:
432
+ ratelimit:
433
+ content:
434
+ require_consent:
435
+
436
+ outlier: Indicates whether the event is an `outlier`, i.e. if
437
+ it's from an arbitrary point and floating in the DAG as
438
+ opposed to being inline with the current DAG.
439
+ origin_server_ts: The origin_server_ts to use if a new event is created. Uses
440
+ the current timestamp if set to None.
441
+
442
+ Returns:
443
+ Tuple of event ID and stream ordering position
444
+ """
445
+ user_id = target.to_string()
446
+
447
+ if content is None:
448
+ content = {}
449
+
450
+ content["membership"] = membership
451
+ if requester.is_guest:
452
+ content["kind"] = "guest"
453
+
454
+ # Check if we already have an event with a matching transaction ID. (We
455
+ # do this check just before we persist an event as well, but may as well
456
+ # do it up front for efficiency.)
457
+ if txn_id:
458
+ existing_event_id = (
459
+ await self.event_creation_handler.get_event_id_from_transaction(
460
+ requester, txn_id, room_id
461
+ )
462
+ )
463
+ if existing_event_id:
464
+ event_pos = await self.store.get_position_for_event(existing_event_id)
465
+ return existing_event_id, event_pos.stream
466
+
467
+ # Try several times, it could fail with PartialStateConflictError,
468
+ # in handle_new_client_event, cf comment in except block.
469
+ max_retries = 5
470
+ for i in range(max_retries):
471
+ try:
472
+ (
473
+ event,
474
+ unpersisted_context,
475
+ ) = await self.event_creation_handler.create_event(
476
+ requester,
477
+ {
478
+ "type": EventTypes.Member,
479
+ "content": content,
480
+ "room_id": room_id,
481
+ "sender": requester.user.to_string(),
482
+ "state_key": user_id,
483
+ # For backwards compatibility:
484
+ "membership": membership,
485
+ "origin_server_ts": origin_server_ts,
486
+ },
487
+ txn_id=txn_id,
488
+ prev_event_ids=prev_event_ids,
489
+ state_event_ids=state_event_ids,
490
+ depth=depth,
491
+ require_consent=require_consent,
492
+ outlier=outlier,
493
+ )
494
+ context = await unpersisted_context.persist(event)
495
+ prev_state_ids = await context.get_prev_state_ids(
496
+ StateFilter.from_types([(EventTypes.Member, user_id)])
497
+ )
498
+
499
+ prev_member_event_id = prev_state_ids.get(
500
+ (EventTypes.Member, user_id), None
501
+ )
502
+
503
+ with opentracing.start_active_span("handle_new_client_event"):
504
+ result_event = (
505
+ await self.event_creation_handler.handle_new_client_event(
506
+ requester,
507
+ events_and_context=[(event, context)],
508
+ extra_users=[target],
509
+ ratelimit=ratelimit,
510
+ )
511
+ )
512
+
513
+ if event.membership == Membership.LEAVE:
514
+ if prev_member_event_id:
515
+ prev_member_event = await self.store.get_event(
516
+ prev_member_event_id
517
+ )
518
+ if prev_member_event.membership == Membership.JOIN:
519
+ await self._user_left_room(target, room_id)
520
+
521
+ break
522
+ except PartialStateConflictError as e:
523
+ # Persisting couldn't happen because the room got un-partial stated
524
+ # in the meantime and context needs to be recomputed, so let's do so.
525
+ if i == max_retries - 1:
526
+ raise e
527
+
528
+ # we know it was persisted, so should have a stream ordering
529
+ assert result_event.internal_metadata.stream_ordering
530
+ return result_event.event_id, result_event.internal_metadata.stream_ordering
531
+
532
+ async def copy_room_tags_and_direct_to_room(
533
+ self, old_room_id: str, new_room_id: str, user_id: str
534
+ ) -> None:
535
+ """Copies the tags and direct room state from one room to another.
536
+
537
+ Args:
538
+ old_room_id: The room ID of the old room.
539
+ new_room_id: The room ID of the new room.
540
+ user_id: The user's ID.
541
+ """
542
+ # Retrieve user account data for predecessor room
543
+ user_account_data = await self.store.get_global_account_data_for_user(user_id)
544
+
545
+ # Copy direct message state if applicable
546
+ direct_rooms = user_account_data.get(AccountDataTypes.DIRECT, {})
547
+
548
+ # Check which key this room is under
549
+ if isinstance(direct_rooms, dict):
550
+ for key, room_id_list in direct_rooms.items():
551
+ if old_room_id in room_id_list and new_room_id not in room_id_list:
552
+ # Add new room_id to this key
553
+ direct_rooms[key].append(new_room_id)
554
+
555
+ # Save back to user's m.direct account data
556
+ await self.account_data_handler.add_account_data_for_user(
557
+ user_id, AccountDataTypes.DIRECT, direct_rooms
558
+ )
559
+ break
560
+
561
+ # Copy room tags if applicable
562
+ room_tags = await self.store.get_tags_for_room(user_id, old_room_id)
563
+
564
+ # Copy each room tag to the new room
565
+ for tag, tag_content in room_tags.items():
566
+ await self.account_data_handler.add_tag_to_room(
567
+ user_id, new_room_id, tag, tag_content
568
+ )
569
+
570
+ async def update_membership(
571
+ self,
572
+ requester: Requester,
573
+ target: UserID,
574
+ room_id: str,
575
+ action: str,
576
+ txn_id: str | None = None,
577
+ remote_room_hosts: list[str] | None = None,
578
+ third_party_signed: dict | None = None,
579
+ ratelimit: bool = True,
580
+ content: dict | None = None,
581
+ new_room: bool = False,
582
+ require_consent: bool = True,
583
+ outlier: bool = False,
584
+ prev_event_ids: list[str] | None = None,
585
+ state_event_ids: list[str] | None = None,
586
+ depth: int | None = None,
587
+ origin_server_ts: int | None = None,
588
+ ) -> tuple[str, int]:
589
+ """Update a user's membership in a room.
590
+
591
+ Params:
592
+ requester: The user who is performing the update.
593
+ target: The user whose membership is being updated.
594
+ room_id: The room ID whose membership is being updated.
595
+ action: The membership change, see synapse.api.constants.Membership.
596
+ txn_id: The transaction ID, if given.
597
+ remote_room_hosts: Remote servers to send the update to.
598
+ third_party_signed: Information from a 3PID invite.
599
+ ratelimit: Whether to rate limit the request.
600
+ content: The content of the created event.
601
+ new_room: Whether the membership update is happening in the context of a room
602
+ creation.
603
+ require_consent: Whether consent is required.
604
+ outlier: Indicates whether the event is an `outlier`, i.e. if
605
+ it's from an arbitrary point and floating in the DAG as
606
+ opposed to being inline with the current DAG.
607
+ prev_event_ids: The event IDs to use as the prev events
608
+ state_event_ids:
609
+ The full state at a given event. This was previously used particularly
610
+ by the MSC2716 /batch_send endpoint. This should normally be left as
611
+ None, which will cause the auth_event_ids to be calculated based on the
612
+ room state at the prev_events.
613
+ depth: Override the depth used to order the event in the DAG.
614
+ Should normally be set to None, which will cause the depth to be calculated
615
+ based on the prev_events.
616
+ origin_server_ts: The origin_server_ts to use if a new event is created. Uses
617
+ the current timestamp if set to None.
618
+
619
+ Returns:
620
+ A tuple of the new event ID and stream ID.
621
+
622
+ Raises:
623
+ ShadowBanError if a shadow-banned requester attempts to send an invite.
624
+ """
625
+ if ratelimit:
626
+ if action == Membership.JOIN:
627
+ # Only rate-limit if the user isn't already joined to the room, otherwise
628
+ # we'll end up blocking profile updates.
629
+ (
630
+ current_membership,
631
+ _,
632
+ ) = await self.store.get_local_current_membership_for_user_in_room(
633
+ requester.user.to_string(),
634
+ room_id,
635
+ )
636
+ if current_membership != Membership.JOIN:
637
+ await self._join_rate_limiter_local.ratelimit(requester)
638
+ await self._join_rate_per_room_limiter.ratelimit(
639
+ requester, key=room_id, update=False
640
+ )
641
+ elif action == Membership.INVITE:
642
+ await self.ratelimit_invite(requester, room_id, target.to_string())
643
+
644
+ if action == Membership.INVITE and requester.shadow_banned:
645
+ # We randomly sleep a bit just to annoy the requester.
646
+ await self.clock.sleep(Duration(seconds=random.randint(1, 10)))
647
+ raise ShadowBanError()
648
+
649
+ key = (room_id,)
650
+
651
+ as_id = object()
652
+ if requester.app_service:
653
+ as_id = requester.app_service.id
654
+
655
+ # We first linearise by the application service (to try to limit concurrent joins
656
+ # by application services), and then by room ID.
657
+ async with self.member_as_limiter.queue(as_id):
658
+ async with self.member_linearizer.queue(key):
659
+ async with self._worker_lock_handler.acquire_read_write_lock(
660
+ NEW_EVENT_DURING_PURGE_LOCK_NAME, room_id, write=False
661
+ ):
662
+ with opentracing.start_active_span("update_membership_locked"):
663
+ result = await self.update_membership_locked(
664
+ requester,
665
+ target,
666
+ room_id,
667
+ action,
668
+ txn_id=txn_id,
669
+ remote_room_hosts=remote_room_hosts,
670
+ third_party_signed=third_party_signed,
671
+ ratelimit=ratelimit,
672
+ content=content,
673
+ new_room=new_room,
674
+ require_consent=require_consent,
675
+ outlier=outlier,
676
+ prev_event_ids=prev_event_ids,
677
+ state_event_ids=state_event_ids,
678
+ depth=depth,
679
+ origin_server_ts=origin_server_ts,
680
+ )
681
+
682
+ return result
683
+
684
+ async def update_membership_locked(
685
+ self,
686
+ requester: Requester,
687
+ target: UserID,
688
+ room_id: str,
689
+ action: str,
690
+ txn_id: str | None = None,
691
+ remote_room_hosts: list[str] | None = None,
692
+ third_party_signed: dict | None = None,
693
+ ratelimit: bool = True,
694
+ content: dict | None = None,
695
+ new_room: bool = False,
696
+ require_consent: bool = True,
697
+ outlier: bool = False,
698
+ prev_event_ids: list[str] | None = None,
699
+ state_event_ids: list[str] | None = None,
700
+ depth: int | None = None,
701
+ origin_server_ts: int | None = None,
702
+ ) -> tuple[str, int]:
703
+ """Helper for update_membership.
704
+
705
+ Assumes that the membership linearizer is already held for the room.
706
+
707
+ Args:
708
+ requester:
709
+ target:
710
+ room_id:
711
+ action:
712
+ txn_id:
713
+ remote_room_hosts:
714
+ third_party_signed:
715
+ ratelimit:
716
+ content:
717
+ new_room: Whether the membership update is happening in the context of a room
718
+ creation.
719
+ require_consent:
720
+ outlier: Indicates whether the event is an `outlier`, i.e. if
721
+ it's from an arbitrary point and floating in the DAG as
722
+ opposed to being inline with the current DAG.
723
+ prev_event_ids: The event IDs to use as the prev events
724
+ state_event_ids:
725
+ The full state at a given event. This was previously used particularly
726
+ by the MSC2716 /batch_send endpoint. This should normally be left as
727
+ None, which will cause the auth_event_ids to be calculated based on the
728
+ room state at the prev_events.
729
+ depth: Override the depth used to order the event in the DAG.
730
+ Should normally be set to None, which will cause the depth to be calculated
731
+ based on the prev_events.
732
+ origin_server_ts: The origin_server_ts to use if a new event is created. Uses
733
+ the current timestamp if set to None.
734
+
735
+ Returns:
736
+ A tuple of the new event ID and stream ID.
737
+ """
738
+
739
+ content_specified = bool(content)
740
+ if content is None:
741
+ content = {}
742
+ else:
743
+ # We do a copy here as we potentially change some keys
744
+ # later on.
745
+ content = dict(content)
746
+
747
+ # allow the server notices mxid to set room-level profile
748
+ is_requester_server_notices_user = (
749
+ self._server_notices_mxid is not None
750
+ and requester.user.to_string() == self._server_notices_mxid
751
+ )
752
+
753
+ # The requester may be a regular user, but puppeted by the server.
754
+ request_by_server = requester.authenticated_entity == self._server_name
755
+
756
+ # If the request is initiated by the server, ignore whether the
757
+ # requester or target is suspended.
758
+ if not request_by_server:
759
+ requester_suspended = await self.store.get_user_suspended_status(
760
+ requester.user.to_string()
761
+ )
762
+ if action == Membership.INVITE and requester_suspended:
763
+ raise SynapseError(
764
+ 403,
765
+ "Sending invites while account is suspended is not allowed.",
766
+ Codes.USER_ACCOUNT_SUSPENDED,
767
+ )
768
+
769
+ if target.to_string() != requester.user.to_string():
770
+ target_suspended = await self.store.get_user_suspended_status(
771
+ target.to_string()
772
+ )
773
+ else:
774
+ target_suspended = requester_suspended
775
+
776
+ if action == Membership.JOIN and target_suspended:
777
+ raise SynapseError(
778
+ 403,
779
+ "Joining rooms while account is suspended is not allowed.",
780
+ Codes.USER_ACCOUNT_SUSPENDED,
781
+ )
782
+ if action == Membership.KNOCK and target_suspended:
783
+ raise SynapseError(
784
+ 403,
785
+ "Knocking on rooms while account is suspended is not allowed.",
786
+ Codes.USER_ACCOUNT_SUSPENDED,
787
+ )
788
+
789
+ if (
790
+ not self.allow_per_room_profiles and not is_requester_server_notices_user
791
+ ) or requester.shadow_banned:
792
+ # Strip profile data, knowing that new profile data will be added to
793
+ # the event's content below using the target's global profile.
794
+ content.pop("displayname", None)
795
+ content.pop("avatar_url", None)
796
+
797
+ if len(content.get("displayname") or "") > MAX_DISPLAYNAME_LEN:
798
+ raise SynapseError(
799
+ 400,
800
+ f"Displayname is too long (max {MAX_DISPLAYNAME_LEN})",
801
+ errcode=Codes.BAD_JSON,
802
+ )
803
+
804
+ if len(content.get("avatar_url") or "") > MAX_AVATAR_URL_LEN:
805
+ raise SynapseError(
806
+ 400,
807
+ f"Avatar URL is too long (max {MAX_AVATAR_URL_LEN})",
808
+ errcode=Codes.BAD_JSON,
809
+ )
810
+
811
+ if "avatar_url" in content and content.get("avatar_url") is not None:
812
+ if not await self.profile_handler.check_avatar_size_and_mime_type(
813
+ content["avatar_url"],
814
+ ):
815
+ raise SynapseError(403, "This avatar is not allowed", Codes.FORBIDDEN)
816
+
817
+ # The event content should *not* include the authorising user as
818
+ # it won't be properly signed. Strip it out since it might come
819
+ # back from a client updating a display name / avatar.
820
+ #
821
+ # This only applies to restricted rooms, but there should be no reason
822
+ # for a client to include it. Unconditionally remove it.
823
+ content.pop(EventContentFields.AUTHORISING_USER, None)
824
+
825
+ effective_membership_state = action
826
+ if action in ["kick", "unban"]:
827
+ effective_membership_state = "leave"
828
+
829
+ if effective_membership_state not in Membership.LIST:
830
+ raise SynapseError(400, "Invalid membership key")
831
+
832
+ # Add profile data for joins etc, if no per-room profile.
833
+ if (
834
+ effective_membership_state
835
+ in self._membership_types_to_include_profile_data_in
836
+ ):
837
+ # If event doesn't include a display name, add one.
838
+ profile = self.profile_handler
839
+
840
+ try:
841
+ if "displayname" not in content:
842
+ displayname = await profile.get_displayname(target)
843
+ if displayname is not None:
844
+ content["displayname"] = displayname
845
+ if "avatar_url" not in content:
846
+ avatar_url = await profile.get_avatar_url(target)
847
+ if avatar_url is not None:
848
+ content["avatar_url"] = avatar_url
849
+ except Exception as e:
850
+ logger.info("Failed to get profile information for %r: %s", target, e)
851
+
852
+ # if this is a join with a 3pid signature, we may need to turn a 3pid
853
+ # invite into a normal invite before we can handle the join.
854
+ if third_party_signed is not None:
855
+ await self.federation_handler.exchange_third_party_invite(
856
+ third_party_signed["sender"],
857
+ target.to_string(),
858
+ room_id,
859
+ third_party_signed,
860
+ )
861
+
862
+ if not remote_room_hosts:
863
+ remote_room_hosts = []
864
+
865
+ if effective_membership_state not in ("leave", "ban"):
866
+ is_blocked = await self.store.is_room_blocked(room_id)
867
+ if is_blocked:
868
+ raise SynapseError(403, "This room has been blocked on this server")
869
+
870
+ if effective_membership_state == Membership.INVITE:
871
+ target_id = target.to_string()
872
+
873
+ # block any attempts to invite the server notices mxid
874
+ if target_id == self._server_notices_mxid:
875
+ raise SynapseError(HTTPStatus.FORBIDDEN, "Cannot invite this user")
876
+
877
+ block_invite_result: tuple[Codes, dict] | None = None
878
+
879
+ if (
880
+ self._server_notices_mxid is not None
881
+ and requester.user.to_string() == self._server_notices_mxid
882
+ ):
883
+ # allow the server notices mxid to send invites
884
+ is_requester_admin = True
885
+
886
+ else:
887
+ is_requester_admin = await self.auth.is_server_admin(requester)
888
+
889
+ if not is_requester_admin:
890
+ if self.config.server.block_non_admin_invites:
891
+ logger.info(
892
+ "Blocking invite: user is not admin and non-admin "
893
+ "invites disabled"
894
+ )
895
+ block_invite_result = (Codes.FORBIDDEN, {})
896
+
897
+ spam_check = await self._spam_checker_module_callbacks.user_may_invite(
898
+ requester.user.to_string(), target_id, room_id
899
+ )
900
+ if spam_check != self._spam_checker_module_callbacks.NOT_SPAM:
901
+ logger.info("Blocking invite due to spam checker")
902
+ block_invite_result = spam_check
903
+
904
+ if block_invite_result is not None:
905
+ raise SynapseError(
906
+ 403,
907
+ "Invites have been disabled on this server",
908
+ errcode=block_invite_result[0],
909
+ additional_fields=block_invite_result[1],
910
+ )
911
+
912
+ # check the invitee's configuration and apply rules. Admins on the server can bypass.
913
+ if not is_requester_admin:
914
+ invite_config = await self.store.get_invite_config_for_user(target_id)
915
+ rule = invite_config.get_invite_rule(requester.user.to_string())
916
+ if rule == InviteRule.BLOCK:
917
+ logger.info(
918
+ "Automatically rejecting invite from %s due to the the invite filtering rules of %s",
919
+ target_id,
920
+ requester.user,
921
+ )
922
+ raise SynapseError(
923
+ 403,
924
+ "You are not permitted to invite this user.",
925
+ errcode=Codes.INVITE_BLOCKED,
926
+ )
927
+ # InviteRule.IGNORE is handled at the sync layer.
928
+
929
+ if prev_event_ids is not None:
930
+ return await self._local_membership_update(
931
+ requester=requester,
932
+ target=target,
933
+ room_id=room_id,
934
+ membership=effective_membership_state,
935
+ txn_id=txn_id,
936
+ ratelimit=ratelimit,
937
+ prev_event_ids=prev_event_ids,
938
+ state_event_ids=state_event_ids,
939
+ depth=depth,
940
+ content=content,
941
+ require_consent=require_consent,
942
+ outlier=outlier,
943
+ origin_server_ts=origin_server_ts,
944
+ )
945
+
946
+ latest_event_ids = await self.store.get_prev_events_for_room(room_id)
947
+
948
+ is_partial_state_room = await self.store.is_partial_state_room(room_id)
949
+ partial_state_before_join = await self.state_handler.compute_state_after_events(
950
+ room_id, latest_event_ids, await_full_state=False
951
+ )
952
+ # `is_partial_state_room` also indicates whether `partial_state_before_join` is
953
+ # partial.
954
+
955
+ is_host_in_room = await self._is_host_in_room(partial_state_before_join)
956
+
957
+ # if we are not in the room, we won't have the current state
958
+ if is_host_in_room:
959
+ # TODO: Refactor into dictionary of explicitly allowed transitions
960
+ # between old and new state, with specific error messages for some
961
+ # transitions and generic otherwise
962
+ old_state_id = partial_state_before_join.get(
963
+ (EventTypes.Member, target.to_string())
964
+ )
965
+
966
+ if old_state_id:
967
+ old_state = await self.store.get_event(old_state_id, allow_none=True)
968
+ old_membership = (
969
+ old_state.content.get("membership") if old_state else None
970
+ )
971
+ if action == "unban" and old_membership != "ban":
972
+ raise SynapseError(
973
+ 403,
974
+ "Cannot unban user who was not banned"
975
+ " (membership=%s)" % old_membership,
976
+ errcode=Codes.BAD_STATE,
977
+ )
978
+ if old_membership == "ban" and action not in ["ban", "unban", "leave"]:
979
+ raise SynapseError(
980
+ 403,
981
+ "Cannot %s user who was banned" % (action,),
982
+ errcode=Codes.BAD_STATE,
983
+ )
984
+
985
+ if old_state:
986
+ same_content = content == old_state.content
987
+ same_membership = old_membership == effective_membership_state
988
+ same_sender = requester.user.to_string() == old_state.sender
989
+ if same_sender and same_membership and same_content:
990
+ # duplicate event.
991
+ # we know it was persisted, so must have a stream ordering.
992
+ assert old_state.internal_metadata.stream_ordering
993
+ return (
994
+ old_state.event_id,
995
+ old_state.internal_metadata.stream_ordering,
996
+ )
997
+
998
+ if old_membership in ["ban", "leave"] and action == "kick":
999
+ raise AuthError(403, "The target user is not in the room")
1000
+
1001
+ # we don't allow people to reject invites to the server notice
1002
+ # room, but they can leave it once they are joined.
1003
+ if (
1004
+ old_membership == Membership.INVITE
1005
+ and effective_membership_state == Membership.LEAVE
1006
+ ):
1007
+ is_blocked = await self.store.is_server_notice_room(room_id)
1008
+ if is_blocked:
1009
+ raise SynapseError(
1010
+ HTTPStatus.FORBIDDEN,
1011
+ "You cannot reject this invite",
1012
+ errcode=Codes.CANNOT_LEAVE_SERVER_NOTICE_ROOM,
1013
+ )
1014
+ else:
1015
+ if action == "kick":
1016
+ raise AuthError(403, "The target user is not in the room")
1017
+
1018
+ if effective_membership_state == Membership.JOIN:
1019
+ if requester.is_guest:
1020
+ guest_can_join = await self._can_guest_join(partial_state_before_join)
1021
+ if not guest_can_join:
1022
+ # This should be an auth check, but guests are a local concept,
1023
+ # so don't really fit into the general auth process.
1024
+ raise AuthError(403, "Guest access not allowed")
1025
+
1026
+ # Figure out whether the user is a server admin to determine whether they
1027
+ # should be able to bypass the spam checker.
1028
+ if (
1029
+ self._server_notices_mxid is not None
1030
+ and requester.user.to_string() == self._server_notices_mxid
1031
+ ):
1032
+ # allow the server notices mxid to join rooms
1033
+ bypass_spam_checker = True
1034
+
1035
+ else:
1036
+ bypass_spam_checker = await self.auth.is_server_admin(requester)
1037
+
1038
+ inviter = await self._get_inviter(target.to_string(), room_id)
1039
+ if (
1040
+ not bypass_spam_checker
1041
+ # We assume that if the spam checker allowed the user to create
1042
+ # a room then they're allowed to join it.
1043
+ and not new_room
1044
+ ):
1045
+ spam_check = (
1046
+ await self._spam_checker_module_callbacks.user_may_join_room(
1047
+ target.to_string(), room_id, is_invited=inviter is not None
1048
+ )
1049
+ )
1050
+ if spam_check != self._spam_checker_module_callbacks.NOT_SPAM:
1051
+ raise SynapseError(
1052
+ 403,
1053
+ "Not allowed to join this room",
1054
+ errcode=spam_check[0],
1055
+ additional_fields=spam_check[1],
1056
+ )
1057
+
1058
+ # Check if a remote join should be performed.
1059
+ remote_join, remote_room_hosts = await self._should_perform_remote_join(
1060
+ target.to_string(),
1061
+ room_id,
1062
+ remote_room_hosts,
1063
+ content,
1064
+ is_partial_state_room,
1065
+ is_host_in_room,
1066
+ partial_state_before_join,
1067
+ )
1068
+ if remote_join:
1069
+ if ratelimit:
1070
+ await self._join_rate_limiter_remote.ratelimit(
1071
+ requester,
1072
+ )
1073
+ await self._join_rate_per_room_limiter.ratelimit(
1074
+ requester,
1075
+ key=room_id,
1076
+ update=False,
1077
+ )
1078
+
1079
+ inviter = await self._get_inviter(target.to_string(), room_id)
1080
+ if inviter and not self.hs.is_mine(inviter):
1081
+ remote_room_hosts.append(inviter.domain)
1082
+
1083
+ content["membership"] = Membership.JOIN
1084
+
1085
+ try:
1086
+ profile = self.profile_handler
1087
+ if not content_specified:
1088
+ content["displayname"] = await profile.get_displayname(target)
1089
+ content["avatar_url"] = await profile.get_avatar_url(target)
1090
+ except Exception as e:
1091
+ logger.info(
1092
+ "Failed to get profile information while processing remote join for %r: %s",
1093
+ target,
1094
+ e,
1095
+ )
1096
+
1097
+ if requester.is_guest:
1098
+ content["kind"] = "guest"
1099
+
1100
+ remote_join_response = await self._remote_join(
1101
+ requester, remote_room_hosts, room_id, target, content
1102
+ )
1103
+
1104
+ return remote_join_response
1105
+
1106
+ elif effective_membership_state == Membership.LEAVE:
1107
+ if not is_host_in_room:
1108
+ # Figure out the user's current membership state for the room
1109
+ (
1110
+ current_membership_type,
1111
+ current_membership_event_id,
1112
+ ) = await self.store.get_local_current_membership_for_user_in_room(
1113
+ target.to_string(), room_id
1114
+ )
1115
+ if not current_membership_type or not current_membership_event_id:
1116
+ logger.info(
1117
+ "%s sent a leave request to %s, but that is not an active room "
1118
+ "on this server, or there is no pending invite or knock",
1119
+ target,
1120
+ room_id,
1121
+ )
1122
+
1123
+ raise SynapseError(404, "Not a known room")
1124
+
1125
+ # perhaps we've been invited
1126
+ if current_membership_type == Membership.INVITE:
1127
+ invite = await self.store.get_event(current_membership_event_id)
1128
+ logger.info(
1129
+ "%s rejects invite to %s from %s",
1130
+ target,
1131
+ room_id,
1132
+ invite.sender,
1133
+ )
1134
+
1135
+ if not self.hs.is_mine_id(invite.sender):
1136
+ # send the rejection to the inviter's HS (with fallback to
1137
+ # local event)
1138
+ return await self.remote_reject_invite(
1139
+ invite.event_id,
1140
+ txn_id,
1141
+ requester,
1142
+ content,
1143
+ )
1144
+
1145
+ # the inviter was on our server, but has now left. Carry on
1146
+ # with the normal rejection codepath, which will also send the
1147
+ # rejection out to any other servers we believe are still in the room.
1148
+
1149
+ # thanks to overzealous cleaning up of event_forward_extremities in
1150
+ # `delete_old_current_state_events`, it's possible to end up with no
1151
+ # forward extremities here. If that happens, let's just hang the
1152
+ # rejection off the invite event.
1153
+ #
1154
+ # see: https://github.com/matrix-org/synapse/issues/7139
1155
+ if len(latest_event_ids) == 0:
1156
+ latest_event_ids = [invite.event_id]
1157
+
1158
+ # or perhaps this is a remote room that a local user has knocked on
1159
+ elif current_membership_type == Membership.KNOCK:
1160
+ knock = await self.store.get_event(current_membership_event_id)
1161
+ return await self.remote_rescind_knock(
1162
+ knock.event_id, txn_id, requester, content
1163
+ )
1164
+
1165
+ elif effective_membership_state == Membership.KNOCK:
1166
+ if not is_host_in_room:
1167
+ # we used to add the domain of the room ID to remote_room_hosts.
1168
+ # This is not safe in MSC4291 rooms which do not have a domain.
1169
+ content["membership"] = Membership.KNOCK
1170
+
1171
+ try:
1172
+ profile = self.profile_handler
1173
+ if "displayname" not in content:
1174
+ content["displayname"] = await profile.get_displayname(target)
1175
+ if "avatar_url" not in content:
1176
+ content["avatar_url"] = await profile.get_avatar_url(target)
1177
+ except Exception as e:
1178
+ logger.info(
1179
+ "Failed to get profile information while processing remote knock for %r: %s",
1180
+ target,
1181
+ e,
1182
+ )
1183
+
1184
+ return await self.remote_knock(
1185
+ requester, remote_room_hosts, room_id, target, content
1186
+ )
1187
+
1188
+ return await self._local_membership_update(
1189
+ requester=requester,
1190
+ target=target,
1191
+ room_id=room_id,
1192
+ membership=effective_membership_state,
1193
+ txn_id=txn_id,
1194
+ ratelimit=ratelimit,
1195
+ prev_event_ids=latest_event_ids,
1196
+ state_event_ids=state_event_ids,
1197
+ depth=depth,
1198
+ content=content,
1199
+ require_consent=require_consent,
1200
+ outlier=outlier,
1201
+ origin_server_ts=origin_server_ts,
1202
+ )
1203
+
1204
+ async def check_for_any_membership_in_room(
1205
+ self, *, user_id: str, room_id: str
1206
+ ) -> None:
1207
+ """
1208
+ Check if the user has any membership in the room and raise error if not.
1209
+
1210
+ Args:
1211
+ user_id: The user to check.
1212
+ room_id: The room to check.
1213
+
1214
+ Raises:
1215
+ AuthError if the user doesn't have any membership in the room.
1216
+ """
1217
+ result = await self.store.get_local_current_membership_for_user_in_room(
1218
+ user_id=user_id, room_id=room_id
1219
+ )
1220
+
1221
+ if result is None or result == (None, None):
1222
+ raise AuthError(403, f"User {user_id} has no membership in room {room_id}")
1223
+
1224
+ async def _should_perform_remote_join(
1225
+ self,
1226
+ user_id: str,
1227
+ room_id: str,
1228
+ remote_room_hosts: list[str],
1229
+ content: JsonDict,
1230
+ is_partial_state_room: bool,
1231
+ is_host_in_room: bool,
1232
+ partial_state_before_join: StateMap[str],
1233
+ ) -> tuple[bool, list[str]]:
1234
+ """
1235
+ Check whether the server should do a remote join (as opposed to a local
1236
+ join) for a user.
1237
+
1238
+ Generally a remote join is used if:
1239
+
1240
+ * The server is not yet in the room.
1241
+ * The server is in the room, the room has restricted join rules, the user
1242
+ is not joined or invited to the room, and the server does not have
1243
+ another user who is capable of issuing invites.
1244
+
1245
+ Args:
1246
+ user_id: The user joining the room.
1247
+ room_id: The room being joined.
1248
+ remote_room_hosts: A list of remote room hosts.
1249
+ content: The content to use as the event body of the join. This may
1250
+ be modified.
1251
+ is_partial_state_room: `True` if the server currently doesn't hold the full
1252
+ state of the room.
1253
+ is_host_in_room: `True` if the host is in the room.
1254
+ partial_state_before_join: The state before the join event (i.e. the
1255
+ resolution of the states after its parent events). May be full or
1256
+ partial state, depending on `is_partial_state_room`.
1257
+
1258
+ Returns:
1259
+ A tuple of:
1260
+ True if a remote join should be performed. False if the join can be
1261
+ done locally.
1262
+
1263
+ A list of remote room hosts to use. This is an empty list if a
1264
+ local join is to be done.
1265
+ """
1266
+ # If the host isn't in the room, pass through the prospective hosts.
1267
+ if not is_host_in_room:
1268
+ return True, remote_room_hosts
1269
+
1270
+ prev_member_event_id = partial_state_before_join.get(
1271
+ (EventTypes.Member, user_id), None
1272
+ )
1273
+ previous_membership = None
1274
+ if prev_member_event_id:
1275
+ prev_member_event = await self.store.get_event(prev_member_event_id)
1276
+ previous_membership = prev_member_event.membership
1277
+
1278
+ # If we are not fully joined yet, and the target is not already in the room,
1279
+ # let's do a remote join so another server with the full state can validate
1280
+ # that the user has not been banned for example.
1281
+ # We could just accept the join and wait for state res to resolve that later on
1282
+ # but we would then leak room history to this person until then, which is pretty
1283
+ # bad.
1284
+ if is_partial_state_room and previous_membership != Membership.JOIN:
1285
+ return True, remote_room_hosts
1286
+
1287
+ # If the host is in the room, but not one of the authorised hosts
1288
+ # for restricted join rules, a remote join must be used.
1289
+ room_version = await self.store.get_room_version(room_id)
1290
+
1291
+ # If restricted join rules are not being used, a local join can always
1292
+ # be used.
1293
+ if not await self.event_auth_handler.has_restricted_join_rules(
1294
+ partial_state_before_join, room_version
1295
+ ):
1296
+ return False, []
1297
+
1298
+ # If the user is invited to the room or already joined, the join
1299
+ # event can always be issued locally.
1300
+ if previous_membership in (Membership.JOIN, Membership.INVITE):
1301
+ return False, []
1302
+
1303
+ # All the partial state cases are covered above. We have been given the full
1304
+ # state of the room.
1305
+ assert not is_partial_state_room
1306
+ state_before_join = partial_state_before_join
1307
+
1308
+ # If the local host has a user who can issue invites, then a local
1309
+ # join can be done.
1310
+ #
1311
+ # If not, generate a new list of remote hosts based on which
1312
+ # can issue invites.
1313
+ event_map = await self.store.get_events(state_before_join.values())
1314
+ current_state = {
1315
+ state_key: event_map[event_id]
1316
+ for state_key, event_id in state_before_join.items()
1317
+ }
1318
+ allowed_servers = get_servers_from_users(
1319
+ get_users_which_can_issue_invite(current_state)
1320
+ )
1321
+
1322
+ # If the local server is not one of allowed servers, then a remote
1323
+ # join must be done. Return the list of prospective servers based on
1324
+ # which can issue invites.
1325
+ if self.hs.hostname not in allowed_servers:
1326
+ return True, list(allowed_servers)
1327
+
1328
+ # Ensure the member should be allowed access via membership in a room.
1329
+ await self.event_auth_handler.check_restricted_join_rules(
1330
+ state_before_join, room_version, user_id, previous_membership
1331
+ )
1332
+
1333
+ # If this is going to be a local join, additional information must
1334
+ # be included in the event content in order to efficiently validate
1335
+ # the event.
1336
+ content[
1337
+ EventContentFields.AUTHORISING_USER
1338
+ ] = await self.event_auth_handler.get_user_which_could_invite(
1339
+ room_id,
1340
+ state_before_join,
1341
+ )
1342
+
1343
+ return False, []
1344
+
1345
+ async def transfer_room_state_on_room_upgrade(
1346
+ self, old_room_id: str, room_id: str
1347
+ ) -> None:
1348
+ """Upon our server becoming aware of an upgraded room, either by upgrading a room
1349
+ ourselves or joining one, we can transfer over information from the previous room.
1350
+
1351
+ Copies user state (tags/push rules) for every local user that was in the old room, as
1352
+ well as migrating the room directory state.
1353
+
1354
+ Args:
1355
+ old_room_id: The ID of the old room
1356
+ room_id: The ID of the new room
1357
+ """
1358
+ logger.info("Transferring room state from %s to %s", old_room_id, room_id)
1359
+
1360
+ # Find all local users that were in the old room and copy over each user's state
1361
+ local_users = await self.store.get_local_users_in_room(old_room_id)
1362
+ await self.copy_user_state_on_room_upgrade(old_room_id, room_id, local_users)
1363
+
1364
+ # Add new room to the room directory if the old room was there
1365
+ # Remove old room from the room directory
1366
+ old_room = await self.store.get_room(old_room_id)
1367
+ # If the old room exists and is public.
1368
+ if old_room is not None and old_room[0]:
1369
+ await self.store.set_room_is_public(old_room_id, False)
1370
+ await self.store.set_room_is_public(room_id, True)
1371
+
1372
+ # Transfer alias mappings in the room directory
1373
+ await self.store.update_aliases_for_room(old_room_id, room_id)
1374
+
1375
+ async def copy_user_state_on_room_upgrade(
1376
+ self, old_room_id: str, new_room_id: str, user_ids: Iterable[str]
1377
+ ) -> None:
1378
+ """Copy user-specific information when they join a new room when that new room is the
1379
+ result of a room upgrade
1380
+
1381
+ Args:
1382
+ old_room_id: The ID of upgraded room
1383
+ new_room_id: The ID of the new room
1384
+ user_ids: User IDs to copy state for
1385
+ """
1386
+
1387
+ logger.debug(
1388
+ "Copying over room tags and push rules from %s to %s for users %s",
1389
+ old_room_id,
1390
+ new_room_id,
1391
+ user_ids,
1392
+ )
1393
+
1394
+ for user_id in user_ids:
1395
+ try:
1396
+ # It is an upgraded room. Copy over old tags
1397
+ await self.copy_room_tags_and_direct_to_room(
1398
+ old_room_id, new_room_id, user_id
1399
+ )
1400
+ # Copy over push rules
1401
+ if self._is_push_writer:
1402
+ await self.store.copy_push_rules_from_room_to_room_for_user(
1403
+ old_room_id, new_room_id, user_id
1404
+ )
1405
+ else:
1406
+ await self._copy_push_client(
1407
+ instance_name=self._push_writer,
1408
+ user_id=user_id,
1409
+ old_room_id=old_room_id,
1410
+ new_room_id=new_room_id,
1411
+ )
1412
+ except Exception:
1413
+ logger.exception(
1414
+ "Error copying tags and/or push rules from rooms %s to %s for user %s. "
1415
+ "Skipping...",
1416
+ old_room_id,
1417
+ new_room_id,
1418
+ user_id,
1419
+ )
1420
+ continue
1421
+
1422
+ async def send_membership_event(
1423
+ self,
1424
+ requester: Requester | None,
1425
+ event: EventBase,
1426
+ context: EventContext,
1427
+ ratelimit: bool = True,
1428
+ ) -> None:
1429
+ """
1430
+ Change the membership status of a user in a room.
1431
+
1432
+ Args:
1433
+ requester: The local user who requested the membership
1434
+ event. If None, certain checks, like whether this homeserver can
1435
+ act as the sender, will be skipped.
1436
+ event: The membership event.
1437
+ context: The context of the event.
1438
+ ratelimit: Whether to rate limit this request.
1439
+ Raises:
1440
+ SynapseError if there was a problem changing the membership.
1441
+ PartialStateConflictError: if attempting to persist a partial state event in
1442
+ a room that has been un-partial stated.
1443
+ """
1444
+ target_user = UserID.from_string(event.state_key)
1445
+ room_id = event.room_id
1446
+
1447
+ if requester is not None:
1448
+ sender = UserID.from_string(event.sender)
1449
+ assert sender == requester.user, (
1450
+ "Sender (%s) must be same as requester (%s)" % (sender, requester.user)
1451
+ )
1452
+ assert self.hs.is_mine(sender), "Sender must be our own: %s" % (sender,)
1453
+ else:
1454
+ requester = types.create_requester(target_user)
1455
+
1456
+ prev_state_ids = await context.get_prev_state_ids(
1457
+ StateFilter.from_types([(EventTypes.GuestAccess, "")])
1458
+ )
1459
+ if event.membership == Membership.JOIN:
1460
+ if requester.is_guest:
1461
+ guest_can_join = await self._can_guest_join(prev_state_ids)
1462
+ if not guest_can_join:
1463
+ # This should be an auth check, but guests are a local concept,
1464
+ # so don't really fit into the general auth process.
1465
+ raise AuthError(403, "Guest access not allowed")
1466
+
1467
+ if event.membership not in (Membership.LEAVE, Membership.BAN):
1468
+ is_blocked = await self.store.is_room_blocked(room_id)
1469
+ if is_blocked:
1470
+ raise SynapseError(403, "This room has been blocked on this server")
1471
+
1472
+ event = await self.event_creation_handler.handle_new_client_event(
1473
+ requester,
1474
+ events_and_context=[(event, context)],
1475
+ extra_users=[target_user],
1476
+ ratelimit=ratelimit,
1477
+ )
1478
+
1479
+ if event.membership == Membership.LEAVE:
1480
+ prev_state_ids = await context.get_prev_state_ids(
1481
+ StateFilter.from_types([(EventTypes.Member, event.state_key)])
1482
+ )
1483
+ prev_member_event_id = prev_state_ids.get(
1484
+ (EventTypes.Member, event.state_key), None
1485
+ )
1486
+
1487
+ if prev_member_event_id:
1488
+ prev_member_event = await self.store.get_event(prev_member_event_id)
1489
+ if prev_member_event.membership == Membership.JOIN:
1490
+ await self._user_left_room(target_user, room_id)
1491
+
1492
+ async def _can_guest_join(self, partial_current_state_ids: StateMap[str]) -> bool:
1493
+ """
1494
+ Returns whether a guest can join a room based on its current state.
1495
+
1496
+ Args:
1497
+ partial_current_state_ids: The current state of the room. May be full or
1498
+ partial state.
1499
+ """
1500
+ guest_access_id = partial_current_state_ids.get(
1501
+ (EventTypes.GuestAccess, ""), None
1502
+ )
1503
+ if not guest_access_id:
1504
+ return False
1505
+
1506
+ guest_access = await self.store.get_event(guest_access_id)
1507
+
1508
+ return bool(
1509
+ guest_access
1510
+ and guest_access.content
1511
+ and guest_access.content.get(EventContentFields.GUEST_ACCESS)
1512
+ == GuestAccess.CAN_JOIN
1513
+ )
1514
+
1515
+ async def kick_guest_users(self, current_state: Iterable[EventBase]) -> None:
1516
+ """Kick any local guest users from the room.
1517
+
1518
+ This is called when the room state changes from guests allowed to not-allowed.
1519
+
1520
+ Params:
1521
+ current_state: the current state of the room. We will iterate this to look
1522
+ for guest users to kick.
1523
+ """
1524
+ for member_event in current_state:
1525
+ try:
1526
+ if member_event.type != EventTypes.Member:
1527
+ continue
1528
+
1529
+ if not self.hs.is_mine_id(member_event.state_key):
1530
+ continue
1531
+
1532
+ if member_event.content["membership"] not in {
1533
+ Membership.JOIN,
1534
+ Membership.INVITE,
1535
+ }:
1536
+ continue
1537
+
1538
+ if (
1539
+ "kind" not in member_event.content
1540
+ or member_event.content["kind"] != "guest"
1541
+ ):
1542
+ continue
1543
+
1544
+ # We make the user choose to leave, rather than have the
1545
+ # event-sender kick them. This is partially because we don't
1546
+ # need to worry about power levels, and partially because guest
1547
+ # users are a concept which doesn't hugely work over federation,
1548
+ # and having homeservers have their own users leave keeps more
1549
+ # of that decision-making and control local to the guest-having
1550
+ # homeserver.
1551
+ target_user = UserID.from_string(member_event.state_key)
1552
+ requester = create_requester(
1553
+ target_user, is_guest=True, authenticated_entity=self._server_name
1554
+ )
1555
+ handler = self.hs.get_room_member_handler()
1556
+ await handler.update_membership(
1557
+ requester,
1558
+ target_user,
1559
+ member_event.room_id,
1560
+ "leave",
1561
+ ratelimit=False,
1562
+ require_consent=False,
1563
+ )
1564
+ except Exception as e:
1565
+ logger.exception("Error kicking guest user: %s", e)
1566
+
1567
+ async def lookup_room_alias(
1568
+ self, room_alias: RoomAlias
1569
+ ) -> tuple[RoomID, list[str]]:
1570
+ """
1571
+ Get the room ID associated with a room alias.
1572
+
1573
+ Args:
1574
+ room_alias: The alias to look up.
1575
+ Returns:
1576
+ A tuple of:
1577
+ The room ID as a RoomID object.
1578
+ Hosts likely to be participating in the room ([str]).
1579
+ Raises:
1580
+ SynapseError if room alias could not be found.
1581
+ """
1582
+ directory_handler = self.directory_handler
1583
+ mapping = await directory_handler.get_association(room_alias)
1584
+
1585
+ if not mapping:
1586
+ raise SynapseError(404, "No such room alias")
1587
+
1588
+ room_id = mapping["room_id"]
1589
+ servers = mapping["servers"]
1590
+
1591
+ # put the server which owns the alias at the front of the server list.
1592
+ if room_alias.domain in servers:
1593
+ servers.remove(room_alias.domain)
1594
+ servers.insert(0, room_alias.domain)
1595
+
1596
+ return RoomID.from_string(room_id), servers
1597
+
1598
+ async def _get_inviter(self, user_id: str, room_id: str) -> UserID | None:
1599
+ invite = await self.store.get_invite_for_local_user_in_room(
1600
+ user_id=user_id, room_id=room_id
1601
+ )
1602
+ if invite:
1603
+ return UserID.from_string(invite.sender)
1604
+ return None
1605
+
1606
+ async def do_3pid_invite(
1607
+ self,
1608
+ room_id: str,
1609
+ inviter: UserID,
1610
+ medium: str,
1611
+ address: str,
1612
+ id_server: str,
1613
+ requester: Requester,
1614
+ txn_id: str | None,
1615
+ id_access_token: str,
1616
+ prev_event_ids: list[str] | None = None,
1617
+ depth: int | None = None,
1618
+ ) -> tuple[str, int]:
1619
+ """Invite a 3PID to a room.
1620
+
1621
+ Args:
1622
+ room_id: The room to invite the 3PID to.
1623
+ inviter: The user sending the invite.
1624
+ medium: The 3PID's medium.
1625
+ address: The 3PID's address.
1626
+ id_server: The identity server to use.
1627
+ requester: The user making the request.
1628
+ txn_id: The transaction ID this is part of, or None if this is not
1629
+ part of a transaction.
1630
+ id_access_token: Identity server access token.
1631
+ depth: Override the depth used to order the event in the DAG.
1632
+ prev_event_ids: The event IDs to use as the prev events
1633
+ Should normally be set to None, which will cause the depth to be calculated
1634
+ based on the prev_events.
1635
+
1636
+ Returns:
1637
+ Tuple of event ID and stream ordering position
1638
+
1639
+ Raises:
1640
+ ShadowBanError if the requester has been shadow-banned.
1641
+ """
1642
+ if self.config.server.block_non_admin_invites:
1643
+ is_requester_admin = await self.auth.is_server_admin(requester)
1644
+ if not is_requester_admin:
1645
+ raise SynapseError(
1646
+ 403, "Invites have been disabled on this server", Codes.FORBIDDEN
1647
+ )
1648
+
1649
+ if requester.shadow_banned:
1650
+ # We randomly sleep a bit just to annoy the requester.
1651
+ await self.clock.sleep(Duration(seconds=random.randint(1, 10)))
1652
+ raise ShadowBanError()
1653
+
1654
+ # We need to rate limit *before* we send out any 3PID invites, so we
1655
+ # can't just rely on the standard ratelimiting of events.
1656
+ await self._third_party_invite_limiter.ratelimit(requester)
1657
+
1658
+ can_invite = await self._third_party_event_rules.check_threepid_can_be_invited(
1659
+ medium, address, room_id
1660
+ )
1661
+ if not can_invite:
1662
+ raise SynapseError(
1663
+ 403,
1664
+ "This third-party identifier can not be invited in this room",
1665
+ Codes.FORBIDDEN,
1666
+ )
1667
+
1668
+ if not self._enable_lookup:
1669
+ raise SynapseError(
1670
+ 403, "Looking up third-party identifiers is denied from this server"
1671
+ )
1672
+
1673
+ invitee = await self.identity_handler.lookup_3pid(
1674
+ id_server, medium, address, id_access_token
1675
+ )
1676
+
1677
+ if invitee:
1678
+ # Note that update_membership with an action of "invite" can raise
1679
+ # a ShadowBanError, but this was done above already.
1680
+ # We don't check the invite against the spamchecker(s) here (through
1681
+ # user_may_invite) because we'll do it further down the line anyway (in
1682
+ # update_membership_locked).
1683
+ event_id, stream_id = await self.update_membership(
1684
+ requester, UserID.from_string(invitee), room_id, "invite", txn_id=txn_id
1685
+ )
1686
+ else:
1687
+ # Check if the spamchecker(s) allow this invite to go through.
1688
+ spam_check = (
1689
+ await self._spam_checker_module_callbacks.user_may_send_3pid_invite(
1690
+ inviter_userid=requester.user.to_string(),
1691
+ medium=medium,
1692
+ address=address,
1693
+ room_id=room_id,
1694
+ )
1695
+ )
1696
+ if spam_check != self._spam_checker_module_callbacks.NOT_SPAM:
1697
+ raise SynapseError(
1698
+ 403,
1699
+ "Cannot send threepid invite",
1700
+ errcode=spam_check[0],
1701
+ additional_fields=spam_check[1],
1702
+ )
1703
+
1704
+ event, stream_id = await self._make_and_store_3pid_invite(
1705
+ requester,
1706
+ id_server,
1707
+ medium,
1708
+ address,
1709
+ room_id,
1710
+ inviter,
1711
+ txn_id=txn_id,
1712
+ id_access_token=id_access_token,
1713
+ prev_event_ids=prev_event_ids,
1714
+ depth=depth,
1715
+ )
1716
+ event_id = event.event_id
1717
+
1718
+ return event_id, stream_id
1719
+
1720
+ async def _make_and_store_3pid_invite(
1721
+ self,
1722
+ requester: Requester,
1723
+ id_server: str,
1724
+ medium: str,
1725
+ address: str,
1726
+ room_id: str,
1727
+ user: UserID,
1728
+ txn_id: str | None,
1729
+ id_access_token: str,
1730
+ prev_event_ids: list[str] | None = None,
1731
+ depth: int | None = None,
1732
+ ) -> tuple[EventBase, int]:
1733
+ room_state = await self._storage_controllers.state.get_current_state(
1734
+ room_id,
1735
+ StateFilter.from_types(
1736
+ [
1737
+ (EventTypes.Member, user.to_string()),
1738
+ (EventTypes.CanonicalAlias, ""),
1739
+ (EventTypes.Name, ""),
1740
+ (EventTypes.Create, ""),
1741
+ (EventTypes.JoinRules, ""),
1742
+ (EventTypes.RoomAvatar, ""),
1743
+ ]
1744
+ ),
1745
+ )
1746
+
1747
+ inviter_display_name = ""
1748
+ inviter_avatar_url = ""
1749
+ member_event = room_state.get((EventTypes.Member, user.to_string()))
1750
+ if member_event:
1751
+ inviter_display_name = member_event.content.get("displayname", "")
1752
+ inviter_avatar_url = member_event.content.get("avatar_url", "")
1753
+
1754
+ # if user has no display name, default to their MXID
1755
+ if not inviter_display_name:
1756
+ inviter_display_name = user.to_string()
1757
+
1758
+ canonical_room_alias = ""
1759
+ canonical_alias_event = room_state.get((EventTypes.CanonicalAlias, ""))
1760
+ if canonical_alias_event:
1761
+ canonical_room_alias = canonical_alias_event.content.get("alias", "")
1762
+
1763
+ room_name = ""
1764
+ room_name_event = room_state.get((EventTypes.Name, ""))
1765
+ if room_name_event:
1766
+ room_name = room_name_event.content.get("name", "")
1767
+
1768
+ room_type = None
1769
+ room_create_event = room_state.get((EventTypes.Create, ""))
1770
+ if room_create_event:
1771
+ room_type = room_create_event.content.get(EventContentFields.ROOM_TYPE)
1772
+
1773
+ room_join_rules = ""
1774
+ join_rules_event = room_state.get((EventTypes.JoinRules, ""))
1775
+ if join_rules_event:
1776
+ room_join_rules = join_rules_event.content.get("join_rule", "")
1777
+
1778
+ room_avatar_url = ""
1779
+ room_avatar_event = room_state.get((EventTypes.RoomAvatar, ""))
1780
+ if room_avatar_event:
1781
+ room_avatar_url = room_avatar_event.content.get("url", "")
1782
+
1783
+ (
1784
+ token,
1785
+ public_keys,
1786
+ fallback_public_key,
1787
+ display_name,
1788
+ ) = await self.identity_handler.ask_id_server_for_third_party_invite(
1789
+ requester=requester,
1790
+ id_server=id_server,
1791
+ medium=medium,
1792
+ address=address,
1793
+ room_id=room_id,
1794
+ inviter_user_id=user.to_string(),
1795
+ room_alias=canonical_room_alias,
1796
+ room_avatar_url=room_avatar_url,
1797
+ room_join_rules=room_join_rules,
1798
+ room_name=room_name,
1799
+ room_type=room_type,
1800
+ inviter_display_name=inviter_display_name,
1801
+ inviter_avatar_url=inviter_avatar_url,
1802
+ id_access_token=id_access_token,
1803
+ )
1804
+
1805
+ (
1806
+ event,
1807
+ stream_id,
1808
+ ) = await self.event_creation_handler.create_and_send_nonmember_event(
1809
+ requester,
1810
+ {
1811
+ "type": EventTypes.ThirdPartyInvite,
1812
+ "content": {
1813
+ "display_name": display_name,
1814
+ "public_keys": public_keys,
1815
+ # For backwards compatibility:
1816
+ "key_validity_url": fallback_public_key["key_validity_url"],
1817
+ "public_key": fallback_public_key["public_key"],
1818
+ },
1819
+ "room_id": room_id,
1820
+ "sender": user.to_string(),
1821
+ "state_key": token,
1822
+ },
1823
+ ratelimit=False,
1824
+ txn_id=txn_id,
1825
+ prev_event_ids=prev_event_ids,
1826
+ depth=depth,
1827
+ )
1828
+ return event, stream_id
1829
+
1830
+ async def _is_host_in_room(self, partial_current_state_ids: StateMap[str]) -> bool:
1831
+ """Returns whether the homeserver is in the room based on its current state.
1832
+
1833
+ Args:
1834
+ partial_current_state_ids: The current state of the room. May be full or
1835
+ partial state.
1836
+ """
1837
+ # Have we just created the room, and is this about to be the very
1838
+ # first member event?
1839
+ create_event_id = partial_current_state_ids.get(("m.room.create", ""))
1840
+ if len(partial_current_state_ids) == 1 and create_event_id:
1841
+ # We can only get here if we're in the process of creating the room
1842
+ return True
1843
+
1844
+ for etype, state_key in partial_current_state_ids:
1845
+ if etype != EventTypes.Member or not self.hs.is_mine_id(state_key):
1846
+ continue
1847
+
1848
+ event_id = partial_current_state_ids[(etype, state_key)]
1849
+ event = await self.store.get_event(event_id, allow_none=True)
1850
+ if not event:
1851
+ continue
1852
+
1853
+ if event.membership == Membership.JOIN:
1854
+ return True
1855
+
1856
+ return False
1857
+
1858
+
1859
+ class RoomMemberMasterHandler(RoomMemberHandler):
1860
+ def __init__(self, hs: "HomeServer"):
1861
+ super().__init__(hs)
1862
+
1863
+ self.distributor = hs.get_distributor()
1864
+ self.distributor.declare("user_left_room")
1865
+
1866
+ async def _is_remote_room_too_complex(
1867
+ self, room_id: str, remote_room_hosts: list[str]
1868
+ ) -> bool | None:
1869
+ """
1870
+ Check if complexity of a remote room is too great.
1871
+
1872
+ Args:
1873
+ room_id
1874
+ remote_room_hosts
1875
+
1876
+ Returns: bool of whether the complexity is too great, or None
1877
+ if unable to be fetched
1878
+ """
1879
+ max_complexity = self.hs.config.server.limit_remote_rooms.complexity
1880
+ complexity = await self.federation_handler.get_room_complexity(
1881
+ remote_room_hosts, room_id
1882
+ )
1883
+
1884
+ if complexity:
1885
+ return complexity["v1"] > max_complexity
1886
+ return None
1887
+
1888
+ async def _is_local_room_too_complex(self, room_id: str) -> bool:
1889
+ """
1890
+ Check if the complexity of a local room is too great.
1891
+
1892
+ Args:
1893
+ room_id: The room ID to check for complexity.
1894
+ """
1895
+ max_complexity = self.hs.config.server.limit_remote_rooms.complexity
1896
+ complexity = await self.store.get_room_complexity(room_id)
1897
+
1898
+ return complexity["v1"] > max_complexity
1899
+
1900
+ async def _remote_join(
1901
+ self,
1902
+ requester: Requester,
1903
+ remote_room_hosts: list[str],
1904
+ room_id: str,
1905
+ user: UserID,
1906
+ content: dict,
1907
+ ) -> tuple[str, int]:
1908
+ """Implements RoomMemberHandler._remote_join"""
1909
+ # filter ourselves out of remote_room_hosts: do_invite_join ignores it
1910
+ # and if it is the only entry we'd like to return a 404 rather than a
1911
+ # 500.
1912
+ remote_room_hosts = [
1913
+ host for host in remote_room_hosts if host != self.hs.hostname
1914
+ ]
1915
+
1916
+ if len(remote_room_hosts) == 0:
1917
+ raise NoKnownServersError(
1918
+ "Can't join remote room because no servers "
1919
+ "that are in the room have been provided.",
1920
+ )
1921
+
1922
+ check_complexity = self.hs.config.server.limit_remote_rooms.enabled
1923
+ if (
1924
+ check_complexity
1925
+ and self.hs.config.server.limit_remote_rooms.admins_can_join
1926
+ ):
1927
+ check_complexity = not await self.store.is_server_admin(user.to_string())
1928
+
1929
+ if check_complexity:
1930
+ # Fetch the room complexity
1931
+ too_complex = await self._is_remote_room_too_complex(
1932
+ room_id, remote_room_hosts
1933
+ )
1934
+ if too_complex is True:
1935
+ raise SynapseError(
1936
+ code=400,
1937
+ msg=self.hs.config.server.limit_remote_rooms.complexity_error,
1938
+ errcode=Codes.RESOURCE_LIMIT_EXCEEDED,
1939
+ )
1940
+
1941
+ # We don't do an auth check if we are doing an invite
1942
+ # join dance for now, since we're kinda implicitly checking
1943
+ # that we are allowed to join when we decide whether or not we
1944
+ # need to do the invite/join dance.
1945
+ event_id, stream_id = await self.federation_handler.do_invite_join(
1946
+ remote_room_hosts, room_id, user.to_string(), content
1947
+ )
1948
+
1949
+ # Check the room we just joined wasn't too large, if we didn't fetch the
1950
+ # complexity of it before.
1951
+ if check_complexity:
1952
+ if too_complex is False:
1953
+ # We checked, and we're under the limit.
1954
+ return event_id, stream_id
1955
+
1956
+ # Check again, but with the local state events
1957
+ too_complex = await self._is_local_room_too_complex(room_id)
1958
+
1959
+ if too_complex is False:
1960
+ # We're under the limit.
1961
+ return event_id, stream_id
1962
+
1963
+ # The room is too large. Leave.
1964
+ requester = types.create_requester(
1965
+ user, authenticated_entity=self._server_name
1966
+ )
1967
+ await self.update_membership(
1968
+ requester=requester, target=user, room_id=room_id, action="leave"
1969
+ )
1970
+ raise SynapseError(
1971
+ code=400,
1972
+ msg=self.hs.config.server.limit_remote_rooms.complexity_error,
1973
+ errcode=Codes.RESOURCE_LIMIT_EXCEEDED,
1974
+ )
1975
+
1976
+ return event_id, stream_id
1977
+
1978
+ async def remote_reject_invite(
1979
+ self,
1980
+ invite_event_id: str,
1981
+ txn_id: str | None,
1982
+ requester: Requester,
1983
+ content: JsonDict,
1984
+ ) -> tuple[str, int]:
1985
+ """
1986
+ Rejects an out-of-band invite received from a remote user
1987
+
1988
+ Implements RoomMemberHandler.remote_reject_invite
1989
+ """
1990
+ invite_event = await self.store.get_event(invite_event_id)
1991
+ room_id = invite_event.room_id
1992
+ target_user = invite_event.state_key
1993
+
1994
+ # first of all, try doing a rejection via the inviting server
1995
+ fed_handler = self.federation_handler
1996
+ try:
1997
+ inviter_id = UserID.from_string(invite_event.sender)
1998
+ event, stream_id = await fed_handler.do_remotely_reject_invite(
1999
+ [inviter_id.domain], room_id, target_user, content=content
2000
+ )
2001
+ return event.event_id, stream_id
2002
+ except Exception as e:
2003
+ # if we were unable to reject the invite, we will generate our own
2004
+ # leave event.
2005
+ #
2006
+ # The 'except' clause is very broad, but we need to
2007
+ # capture everything from DNS failures upwards
2008
+ #
2009
+ logger.warning("Failed to reject invite: %s", e)
2010
+
2011
+ return await self._generate_local_out_of_band_leave(
2012
+ invite_event, txn_id, requester, content
2013
+ )
2014
+
2015
+ async def remote_rescind_knock(
2016
+ self,
2017
+ knock_event_id: str,
2018
+ txn_id: str | None,
2019
+ requester: Requester,
2020
+ content: JsonDict,
2021
+ ) -> tuple[str, int]:
2022
+ """
2023
+ Rescinds a local knock made on a remote room
2024
+
2025
+ Args:
2026
+ knock_event_id: The ID of the knock event to rescind.
2027
+ txn_id: The transaction ID to use.
2028
+ requester: The originator of the request.
2029
+ content: The content of the leave event.
2030
+
2031
+ Implements RoomMemberHandler.remote_rescind_knock
2032
+ """
2033
+ # TODO: We don't yet support rescinding knocks over federation
2034
+ # as we don't know which homeserver to send it to. An obvious
2035
+ # candidate is the remote homeserver we originally knocked through,
2036
+ # however we don't currently store that information.
2037
+
2038
+ # Just rescind the knock locally
2039
+ knock_event = await self.store.get_event(knock_event_id)
2040
+ return await self._generate_local_out_of_band_leave(
2041
+ knock_event, txn_id, requester, content
2042
+ )
2043
+
2044
+ async def _generate_local_out_of_band_leave(
2045
+ self,
2046
+ previous_membership_event: EventBase,
2047
+ txn_id: str | None,
2048
+ requester: Requester,
2049
+ content: JsonDict,
2050
+ ) -> tuple[str, int]:
2051
+ """Generate a local leave event for a room
2052
+
2053
+ This can be called after we e.g fail to reject an invite via a remote server.
2054
+ It generates an out-of-band membership event locally.
2055
+
2056
+ Args:
2057
+ previous_membership_event: the previous membership event for this user
2058
+ txn_id: optional transaction ID supplied by the client
2059
+ requester: user making the request, according to the access token
2060
+ content: additional content to include in the leave event.
2061
+ Normally an empty dict.
2062
+
2063
+ Returns:
2064
+ A tuple containing (event_id, stream_id of the leave event)
2065
+ """
2066
+ room_id = previous_membership_event.room_id
2067
+ target_user = previous_membership_event.state_key
2068
+
2069
+ content["membership"] = Membership.LEAVE
2070
+
2071
+ event_dict = {
2072
+ "type": EventTypes.Member,
2073
+ "room_id": room_id,
2074
+ "sender": target_user,
2075
+ "content": content,
2076
+ "state_key": target_user,
2077
+ }
2078
+
2079
+ # the auth events for the new event are the same as that of the previous event, plus
2080
+ # the event itself.
2081
+ #
2082
+ # the prev_events consist solely of the previous membership event.
2083
+ prev_event_ids = [previous_membership_event.event_id]
2084
+ auth_event_ids = (
2085
+ list(previous_membership_event.auth_event_ids()) + prev_event_ids
2086
+ )
2087
+
2088
+ # Try several times, it could fail with PartialStateConflictError
2089
+ # in handle_new_client_event, cf comment in except block.
2090
+ max_retries = 5
2091
+ for i in range(max_retries):
2092
+ try:
2093
+ (
2094
+ event,
2095
+ unpersisted_context,
2096
+ ) = await self.event_creation_handler.create_event(
2097
+ requester,
2098
+ event_dict,
2099
+ txn_id=txn_id,
2100
+ prev_event_ids=prev_event_ids,
2101
+ auth_event_ids=auth_event_ids,
2102
+ outlier=True,
2103
+ )
2104
+ context = await unpersisted_context.persist(event)
2105
+ event.internal_metadata.out_of_band_membership = True
2106
+
2107
+ result_event = (
2108
+ await self.event_creation_handler.handle_new_client_event(
2109
+ requester,
2110
+ events_and_context=[(event, context)],
2111
+ extra_users=[UserID.from_string(target_user)],
2112
+ )
2113
+ )
2114
+
2115
+ break
2116
+ except PartialStateConflictError as e:
2117
+ # Persisting couldn't happen because the room got un-partial stated
2118
+ # in the meantime and context needs to be recomputed, so let's do so.
2119
+ if i == max_retries - 1:
2120
+ raise e
2121
+
2122
+ # we know it was persisted, so must have a stream ordering
2123
+ assert result_event.internal_metadata.stream_ordering
2124
+
2125
+ return result_event.event_id, result_event.internal_metadata.stream_ordering
2126
+
2127
+ async def remote_knock(
2128
+ self,
2129
+ requester: Requester,
2130
+ remote_room_hosts: list[str],
2131
+ room_id: str,
2132
+ user: UserID,
2133
+ content: dict,
2134
+ ) -> tuple[str, int]:
2135
+ """Sends a knock to a room. Attempts to do so via one remote out of a given list.
2136
+
2137
+ Args:
2138
+ remote_room_hosts: A list of homeservers to try knocking through.
2139
+ room_id: The ID of the room to knock on.
2140
+ user: The user to knock on behalf of.
2141
+ content: The content of the knock event.
2142
+
2143
+ Returns:
2144
+ A tuple of (event ID, stream ID).
2145
+ """
2146
+ # filter ourselves out of remote_room_hosts
2147
+ remote_room_hosts = [
2148
+ host for host in remote_room_hosts if host != self.hs.hostname
2149
+ ]
2150
+
2151
+ if len(remote_room_hosts) == 0:
2152
+ raise NoKnownServersError()
2153
+
2154
+ return await self.federation_handler.do_knock(
2155
+ remote_room_hosts, room_id, user.to_string(), content=content
2156
+ )
2157
+
2158
+ async def _user_left_room(self, target: UserID, room_id: str) -> None:
2159
+ """Implements RoomMemberHandler._user_left_room"""
2160
+ user_left_room(self.distributor, target, room_id)
2161
+
2162
+
2163
+ class RoomForgetterHandler(StateDeltasHandler):
2164
+ """Forgets rooms when they are left, when enabled in the homeserver config.
2165
+
2166
+ For the purposes of this feature, kicks, bans and "leaves" via state resolution
2167
+ weirdness are all considered to be leaves.
2168
+
2169
+ Derived from `StatsHandler` and `UserDirectoryHandler`.
2170
+ """
2171
+
2172
+ def __init__(self, hs: "HomeServer"):
2173
+ super().__init__(hs)
2174
+
2175
+ self._hs = hs
2176
+ self.server_name = hs.hostname
2177
+ self._store = hs.get_datastores().main
2178
+ self._storage_controllers = hs.get_storage_controllers()
2179
+ self._clock = hs.get_clock()
2180
+ self._notifier = hs.get_notifier()
2181
+ self._room_member_handler = hs.get_room_member_handler()
2182
+
2183
+ # The current position in the current_state_delta stream
2184
+ self.pos: int | None = None
2185
+
2186
+ # Guard to ensure we only process deltas one at a time
2187
+ self._is_processing = False
2188
+
2189
+ if hs.config.worker.run_background_tasks:
2190
+ self._notifier.add_replication_callback(self.notify_new_event)
2191
+
2192
+ # We kick this off to pick up outstanding work from before the last restart.
2193
+ self._clock.call_later(
2194
+ Duration(seconds=0),
2195
+ self.notify_new_event,
2196
+ )
2197
+
2198
+ def notify_new_event(self) -> None:
2199
+ """Called when there may be more deltas to process"""
2200
+ if self._is_processing:
2201
+ return
2202
+
2203
+ self._is_processing = True
2204
+
2205
+ async def process() -> None:
2206
+ try:
2207
+ await self._unsafe_process()
2208
+ finally:
2209
+ self._is_processing = False
2210
+
2211
+ self._hs.run_as_background_process("room_forgetter.notify_new_event", process)
2212
+
2213
+ async def _unsafe_process(self) -> None:
2214
+ # If self.pos is None then means we haven't fetched it from DB
2215
+ if self.pos is None:
2216
+ self.pos = await self._store.get_room_forgetter_stream_pos()
2217
+ room_max_stream_ordering = self._store.get_room_max_stream_ordering()
2218
+ if self.pos > room_max_stream_ordering:
2219
+ # apparently, we've processed more events than exist in the database!
2220
+ # this can happen if events are removed with history purge or similar.
2221
+ logger.warning(
2222
+ "Event stream ordering appears to have gone backwards (%i -> %i): "
2223
+ "rewinding room forgetter processor",
2224
+ self.pos,
2225
+ room_max_stream_ordering,
2226
+ )
2227
+ self.pos = room_max_stream_ordering
2228
+
2229
+ if not self._hs.config.room.forget_on_leave:
2230
+ # Update the processing position, so that if the server admin turns
2231
+ # the feature on at a later date, we don't decide to forget every
2232
+ # room that has ever been left in the past.
2233
+ #
2234
+ # We wait for a short time so that we don't "tight" loop just
2235
+ # keeping the table up to date.
2236
+ await self._clock.sleep(Duration(milliseconds=500))
2237
+
2238
+ self.pos = self._store.get_room_max_stream_ordering()
2239
+ await self._store.update_room_forgetter_stream_pos(self.pos)
2240
+ return
2241
+
2242
+ # Loop round handling deltas until we're up to date
2243
+
2244
+ while True:
2245
+ # Be sure to read the max stream_ordering *before* checking if there are any outstanding
2246
+ # deltas, since there is otherwise a chance that we could miss updates which arrive
2247
+ # after we check the deltas.
2248
+ room_max_stream_ordering = self._store.get_room_max_stream_ordering()
2249
+ if self.pos == room_max_stream_ordering:
2250
+ break
2251
+
2252
+ logger.debug(
2253
+ "Processing room forgetting %s->%s", self.pos, room_max_stream_ordering
2254
+ )
2255
+ (
2256
+ max_pos,
2257
+ deltas,
2258
+ ) = await self._storage_controllers.state.get_current_state_deltas(
2259
+ self.pos, room_max_stream_ordering
2260
+ )
2261
+
2262
+ logger.debug("Handling %d state deltas", len(deltas))
2263
+ await self._handle_deltas(deltas)
2264
+
2265
+ self.pos = max_pos
2266
+
2267
+ # Expose current event processing position to prometheus
2268
+ event_processing_positions.labels(
2269
+ name="room_forgetter", **{SERVER_NAME_LABEL: self.server_name}
2270
+ ).set(max_pos)
2271
+
2272
+ await self._store.update_room_forgetter_stream_pos(max_pos)
2273
+
2274
+ async def _handle_deltas(self, deltas: list[StateDelta]) -> None:
2275
+ """Called with the state deltas to process"""
2276
+ for delta in deltas:
2277
+ if delta.event_type != EventTypes.Member:
2278
+ continue
2279
+
2280
+ if not self._hs.is_mine_id(delta.state_key):
2281
+ continue
2282
+
2283
+ change = await self._get_key_change(
2284
+ delta.prev_event_id,
2285
+ delta.event_id,
2286
+ key_name="membership",
2287
+ public_value=Membership.JOIN,
2288
+ )
2289
+ is_leave = change is MatchChange.now_false
2290
+
2291
+ if is_leave:
2292
+ try:
2293
+ await self._room_member_handler.forget(
2294
+ UserID.from_string(delta.state_key), delta.room_id
2295
+ )
2296
+ except SynapseError as e:
2297
+ if e.code == 400:
2298
+ # The user is back in the room.
2299
+ pass
2300
+ else:
2301
+ raise
2302
+
2303
+
2304
+ def get_users_which_can_issue_invite(auth_events: StateMap[EventBase]) -> list[str]:
2305
+ """
2306
+ Return the list of users which can issue invites.
2307
+
2308
+ This is done by exploring the joined users and comparing their power levels
2309
+ to the necessyar power level to issue an invite.
2310
+
2311
+ Args:
2312
+ auth_events: state in force at this point in the room
2313
+
2314
+ Returns:
2315
+ The users which can issue invites.
2316
+ """
2317
+ invite_level = get_named_level(auth_events, "invite", 0)
2318
+ users_default_level = get_named_level(auth_events, "users_default", 0)
2319
+ power_level_event = get_power_level_event(auth_events)
2320
+
2321
+ # Custom power-levels for users.
2322
+ if power_level_event:
2323
+ users = power_level_event.content.get("users", {})
2324
+ else:
2325
+ users = {}
2326
+
2327
+ result = []
2328
+
2329
+ # Check which members are able to invite by ensuring they're joined and have
2330
+ # the necessary power level.
2331
+ create_event = auth_events[(EventTypes.Create, "")]
2332
+ for (event_type, state_key), event in auth_events.items():
2333
+ if event_type != EventTypes.Member:
2334
+ continue
2335
+
2336
+ if event.membership != Membership.JOIN:
2337
+ continue
2338
+
2339
+ if create_event.room_version.msc4289_creator_power_enabled and is_creator(
2340
+ create_event, state_key
2341
+ ):
2342
+ result.append(state_key)
2343
+ # Check if the user has a custom power level.
2344
+ elif users.get(state_key, users_default_level) >= invite_level:
2345
+ result.append(state_key)
2346
+
2347
+ return result
2348
+
2349
+
2350
+ def get_servers_from_users(users: list[str]) -> set[str]:
2351
+ """
2352
+ Resolve a list of users into their servers.
2353
+
2354
+ Args:
2355
+ users: A list of users.
2356
+
2357
+ Returns:
2358
+ A set of servers.
2359
+ """
2360
+ servers = set()
2361
+ for user in users:
2362
+ try:
2363
+ servers.add(get_domain_from_id(user))
2364
+ except SynapseError:
2365
+ pass
2366
+ return servers