matrix-synapse 1.143.0__cp310-abi3-manylinux_2_28_aarch64.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Potentially problematic release.


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

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