matrix-synapse 1.145.0rc2__cp310-abi3-manylinux_2_28_x86_64.whl

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

Potentially problematic release.


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

Files changed (1636) hide show
  1. AUTHORS.rst +51 -0
  2. CHANGES.md +1732 -0
  3. CONTRIBUTING.md +3 -0
  4. Cargo.lock +1923 -0
  5. Cargo.toml +6 -0
  6. INSTALL.md +7 -0
  7. LICENSE-AGPL-3.0 +661 -0
  8. LICENSE-COMMERCIAL +6 -0
  9. UPGRADE.rst +7 -0
  10. book.toml +47 -0
  11. changelog.d/.gitignore +1 -0
  12. demo/.gitignore +4 -0
  13. demo/clean.sh +22 -0
  14. demo/start.sh +173 -0
  15. demo/stop.sh +14 -0
  16. docs/.sample_config_header.yaml +12 -0
  17. docs/CAPTCHA_SETUP.md +37 -0
  18. docs/README.md +86 -0
  19. docs/SUMMARY.md +126 -0
  20. docs/admin_api/README.rst +13 -0
  21. docs/admin_api/account_validity.md +47 -0
  22. docs/admin_api/client_server_api_extensions.md +67 -0
  23. docs/admin_api/event_reports.md +185 -0
  24. docs/admin_api/experimental_features.md +52 -0
  25. docs/admin_api/fetch_event.md +53 -0
  26. docs/admin_api/media_admin_api.md +372 -0
  27. docs/admin_api/purge_history_api.md +77 -0
  28. docs/admin_api/register_api.md +92 -0
  29. docs/admin_api/room_membership.md +35 -0
  30. docs/admin_api/rooms.md +1190 -0
  31. docs/admin_api/scheduled_tasks.md +54 -0
  32. docs/admin_api/server_notices.md +48 -0
  33. docs/admin_api/statistics.md +132 -0
  34. docs/admin_api/user_admin_api.md +1602 -0
  35. docs/admin_api/version_api.md +23 -0
  36. docs/ancient_architecture_notes.md +81 -0
  37. docs/application_services.md +36 -0
  38. docs/architecture.md +65 -0
  39. docs/auth_chain_diff.dot +32 -0
  40. docs/auth_chain_diff.dot.png +0 -0
  41. docs/auth_chain_difference_algorithm.md +141 -0
  42. docs/changelogs/CHANGES-2019.md +1039 -0
  43. docs/changelogs/CHANGES-2020.md +2145 -0
  44. docs/changelogs/CHANGES-2021.md +2573 -0
  45. docs/changelogs/CHANGES-2022.md +2766 -0
  46. docs/changelogs/CHANGES-2023.md +2202 -0
  47. docs/changelogs/CHANGES-2024.md +1586 -0
  48. docs/changelogs/CHANGES-pre-1.0.md +3641 -0
  49. docs/changelogs/README.md +1 -0
  50. docs/code_style.md +119 -0
  51. docs/consent_tracking.md +197 -0
  52. docs/delegate.md +111 -0
  53. docs/deprecation_policy.md +89 -0
  54. docs/development/cas.md +64 -0
  55. docs/development/contributing_guide.md +554 -0
  56. docs/development/database_schema.md +404 -0
  57. docs/development/demo.md +42 -0
  58. docs/development/dependencies.md +326 -0
  59. docs/development/experimental_features.md +37 -0
  60. docs/development/git.md +148 -0
  61. docs/development/img/git/branches.jpg +0 -0
  62. docs/development/img/git/clean.png +0 -0
  63. docs/development/img/git/squash.png +0 -0
  64. docs/development/internal_documentation/README.md +12 -0
  65. docs/development/internal_documentation/release_notes_review_checklist.md +12 -0
  66. docs/development/releases.md +37 -0
  67. docs/development/reviews.md +41 -0
  68. docs/development/room-dag-concepts.md +115 -0
  69. docs/development/saml.md +40 -0
  70. docs/development/synapse_architecture/cancellation.md +392 -0
  71. docs/development/synapse_architecture/faster_joins.md +375 -0
  72. docs/development/synapse_architecture/streams.md +198 -0
  73. docs/element_logo_white_bg.svg +94 -0
  74. docs/favicon.png +0 -0
  75. docs/favicon.svg +58 -0
  76. docs/federate.md +67 -0
  77. docs/jwt.md +105 -0
  78. docs/log_contexts.md +566 -0
  79. docs/manhole.md +101 -0
  80. docs/media_repository.md +78 -0
  81. docs/message_retention_policies.md +207 -0
  82. docs/metrics-howto.md +315 -0
  83. docs/modules/account_data_callbacks.md +106 -0
  84. docs/modules/account_validity_callbacks.md +57 -0
  85. docs/modules/add_extra_fields_to_client_events_unsigned.md +32 -0
  86. docs/modules/background_update_controller_callbacks.md +71 -0
  87. docs/modules/index.md +53 -0
  88. docs/modules/media_repository_callbacks.md +131 -0
  89. docs/modules/password_auth_provider_callbacks.md +270 -0
  90. docs/modules/porting_legacy_module.md +20 -0
  91. docs/modules/presence_router_callbacks.md +112 -0
  92. docs/modules/ratelimit_callbacks.md +43 -0
  93. docs/modules/spam_checker_callbacks.md +517 -0
  94. docs/modules/third_party_rules_callbacks.md +350 -0
  95. docs/modules/writing_a_module.md +141 -0
  96. docs/openid.md +783 -0
  97. docs/opentracing.md +99 -0
  98. docs/other/running_synapse_on_single_board_computers.md +75 -0
  99. docs/password_auth_providers.md +129 -0
  100. docs/postgres.md +269 -0
  101. docs/presence_router_module.md +247 -0
  102. docs/privacy_policy_templates/en/1.0.html +26 -0
  103. docs/privacy_policy_templates/en/success.html +11 -0
  104. docs/replication.md +36 -0
  105. docs/reverse_proxy.md +327 -0
  106. docs/room_and_user_statistics.md +22 -0
  107. docs/sample_config.yaml +47 -0
  108. docs/sample_log_config.yaml +75 -0
  109. docs/server_notices.md +66 -0
  110. docs/setup/forward_proxy.md +89 -0
  111. docs/setup/installation.md +656 -0
  112. docs/setup/security.md +41 -0
  113. docs/setup/turn/coturn.md +197 -0
  114. docs/setup/turn/eturnal.md +170 -0
  115. docs/spam_checker.md +122 -0
  116. docs/sso_mapping_providers.md +208 -0
  117. docs/structured_logging.md +80 -0
  118. docs/synctl_workers.md +36 -0
  119. docs/systemd-with-workers/README.md +101 -0
  120. docs/systemd-with-workers/system/matrix-synapse-worker@.service +26 -0
  121. docs/systemd-with-workers/system/matrix-synapse.service +23 -0
  122. docs/systemd-with-workers/system/matrix-synapse.target +6 -0
  123. docs/systemd-with-workers/workers/background_worker.yaml +4 -0
  124. docs/systemd-with-workers/workers/event_persister.yaml +20 -0
  125. docs/systemd-with-workers/workers/federation_sender.yaml +4 -0
  126. docs/systemd-with-workers/workers/generic_worker.yaml +11 -0
  127. docs/systemd-with-workers/workers/media_worker.yaml +11 -0
  128. docs/systemd-with-workers/workers/pusher_worker.yaml +4 -0
  129. docs/tcp_replication.md +258 -0
  130. docs/templates.md +254 -0
  131. docs/turn-howto.md +168 -0
  132. docs/upgrade.md +2876 -0
  133. docs/usage/administration/README.md +7 -0
  134. docs/usage/administration/admin_api/README.md +47 -0
  135. docs/usage/administration/admin_api/background_updates.md +109 -0
  136. docs/usage/administration/admin_api/federation.md +212 -0
  137. docs/usage/administration/admin_api/registration_tokens.md +298 -0
  138. docs/usage/administration/admin_faq.md +294 -0
  139. docs/usage/administration/backups.md +125 -0
  140. docs/usage/administration/database_maintenance_tools.md +18 -0
  141. docs/usage/administration/monitoring/reporting_homeserver_usage_statistics.md +77 -0
  142. docs/usage/administration/monthly_active_users.md +84 -0
  143. docs/usage/administration/request_log.md +44 -0
  144. docs/usage/administration/state_groups.md +25 -0
  145. docs/usage/administration/understanding_synapse_through_grafana_graphs.md +83 -0
  146. docs/usage/administration/useful_sql_for_admins.md +216 -0
  147. docs/usage/configuration/README.md +4 -0
  148. docs/usage/configuration/config_documentation.md +4768 -0
  149. docs/usage/configuration/homeserver_sample_config.md +17 -0
  150. docs/usage/configuration/logging_sample_config.md +19 -0
  151. docs/usage/configuration/user_authentication/README.md +15 -0
  152. docs/usage/configuration/user_authentication/refresh_tokens.md +139 -0
  153. docs/usage/configuration/user_authentication/single_sign_on/README.md +5 -0
  154. docs/usage/configuration/user_authentication/single_sign_on/cas.md +8 -0
  155. docs/usage/configuration/user_authentication/single_sign_on/saml.md +8 -0
  156. docs/user_directory.md +130 -0
  157. docs/website_files/README.md +35 -0
  158. docs/website_files/indent-section-headers.css +7 -0
  159. docs/website_files/remove-nav-buttons.css +8 -0
  160. docs/website_files/table-of-contents.css +47 -0
  161. docs/website_files/table-of-contents.js +148 -0
  162. docs/website_files/theme/index.hbs +324 -0
  163. docs/website_files/version-picker.css +78 -0
  164. docs/website_files/version-picker.js +147 -0
  165. docs/website_files/version.js +1 -0
  166. docs/welcome_and_overview.md +67 -0
  167. docs/workers.md +897 -0
  168. matrix_synapse-1.145.0rc2.dist-info/METADATA +260 -0
  169. matrix_synapse-1.145.0rc2.dist-info/RECORD +1636 -0
  170. matrix_synapse-1.145.0rc2.dist-info/WHEEL +5 -0
  171. matrix_synapse-1.145.0rc2.dist-info/entry_points.txt +13 -0
  172. matrix_synapse-1.145.0rc2.dist-info/licenses/AUTHORS.rst +51 -0
  173. matrix_synapse-1.145.0rc2.dist-info/licenses/LICENSE-AGPL-3.0 +661 -0
  174. matrix_synapse-1.145.0rc2.dist-info/licenses/LICENSE-COMMERCIAL +6 -0
  175. mypy.ini +115 -0
  176. rust/Cargo.toml +63 -0
  177. rust/build.rs +45 -0
  178. scripts-dev/build_debian_packages.py +228 -0
  179. scripts-dev/check-newsfragment.sh +62 -0
  180. scripts-dev/check_line_terminators.sh +29 -0
  181. scripts-dev/check_locked_deps_have_sdists.py +64 -0
  182. scripts-dev/check_schema_delta.py +240 -0
  183. scripts-dev/complement.sh +332 -0
  184. scripts-dev/config-lint.sh +15 -0
  185. scripts-dev/database-save.sh +15 -0
  186. scripts-dev/docker_update_debian_changelog.sh +70 -0
  187. scripts-dev/dump_macaroon.py +25 -0
  188. scripts-dev/federation_client.py +428 -0
  189. scripts-dev/gen_config_documentation.py +510 -0
  190. scripts-dev/generate_sample_config.sh +28 -0
  191. scripts-dev/lint.sh +141 -0
  192. scripts-dev/make_full_schema.sh +310 -0
  193. scripts-dev/mypy_synapse_plugin.py +918 -0
  194. scripts-dev/next_github_number.sh +9 -0
  195. scripts-dev/release.py +986 -0
  196. scripts-dev/schema_versions.py +182 -0
  197. scripts-dev/sign_json.py +172 -0
  198. synapse/__init__.py +97 -0
  199. synapse/_scripts/__init__.py +0 -0
  200. synapse/_scripts/export_signing_key.py +109 -0
  201. synapse/_scripts/generate_config.py +83 -0
  202. synapse/_scripts/generate_log_config.py +56 -0
  203. synapse/_scripts/generate_signing_key.py +55 -0
  204. synapse/_scripts/generate_workers_map.py +318 -0
  205. synapse/_scripts/hash_password.py +95 -0
  206. synapse/_scripts/move_remote_media_to_new_store.py +128 -0
  207. synapse/_scripts/register_new_matrix_user.py +402 -0
  208. synapse/_scripts/review_recent_signups.py +212 -0
  209. synapse/_scripts/synapse_port_db.py +1604 -0
  210. synapse/_scripts/synctl.py +365 -0
  211. synapse/_scripts/update_synapse_database.py +130 -0
  212. synapse/api/__init__.py +20 -0
  213. synapse/api/auth/__init__.py +207 -0
  214. synapse/api/auth/base.py +406 -0
  215. synapse/api/auth/internal.py +299 -0
  216. synapse/api/auth/mas.py +436 -0
  217. synapse/api/auth/msc3861_delegated.py +617 -0
  218. synapse/api/auth_blocking.py +144 -0
  219. synapse/api/constants.py +379 -0
  220. synapse/api/errors.py +913 -0
  221. synapse/api/filtering.py +537 -0
  222. synapse/api/presence.py +102 -0
  223. synapse/api/ratelimiting.py +481 -0
  224. synapse/api/room_versions.py +535 -0
  225. synapse/api/urls.py +118 -0
  226. synapse/app/__init__.py +62 -0
  227. synapse/app/_base.py +906 -0
  228. synapse/app/admin_cmd.py +388 -0
  229. synapse/app/appservice.py +30 -0
  230. synapse/app/client_reader.py +30 -0
  231. synapse/app/complement_fork_starter.py +206 -0
  232. synapse/app/event_creator.py +29 -0
  233. synapse/app/federation_reader.py +30 -0
  234. synapse/app/federation_sender.py +30 -0
  235. synapse/app/frontend_proxy.py +30 -0
  236. synapse/app/generic_worker.py +475 -0
  237. synapse/app/homeserver.py +505 -0
  238. synapse/app/media_repository.py +30 -0
  239. synapse/app/phone_stats_home.py +292 -0
  240. synapse/app/pusher.py +30 -0
  241. synapse/app/synchrotron.py +30 -0
  242. synapse/app/user_dir.py +31 -0
  243. synapse/appservice/__init__.py +458 -0
  244. synapse/appservice/api.py +567 -0
  245. synapse/appservice/scheduler.py +565 -0
  246. synapse/config/__init__.py +27 -0
  247. synapse/config/__main__.py +62 -0
  248. synapse/config/_base.py +1154 -0
  249. synapse/config/_base.pyi +216 -0
  250. synapse/config/_util.py +99 -0
  251. synapse/config/account_validity.py +116 -0
  252. synapse/config/api.py +141 -0
  253. synapse/config/appservice.py +210 -0
  254. synapse/config/auth.py +80 -0
  255. synapse/config/auto_accept_invites.py +43 -0
  256. synapse/config/background_updates.py +44 -0
  257. synapse/config/cache.py +231 -0
  258. synapse/config/captcha.py +90 -0
  259. synapse/config/cas.py +116 -0
  260. synapse/config/consent.py +73 -0
  261. synapse/config/database.py +184 -0
  262. synapse/config/emailconfig.py +367 -0
  263. synapse/config/experimental.py +601 -0
  264. synapse/config/federation.py +114 -0
  265. synapse/config/homeserver.py +141 -0
  266. synapse/config/jwt.py +55 -0
  267. synapse/config/key.py +447 -0
  268. synapse/config/logger.py +390 -0
  269. synapse/config/mas.py +192 -0
  270. synapse/config/matrixrtc.py +66 -0
  271. synapse/config/metrics.py +93 -0
  272. synapse/config/modules.py +40 -0
  273. synapse/config/oembed.py +185 -0
  274. synapse/config/oidc.py +509 -0
  275. synapse/config/password_auth_providers.py +82 -0
  276. synapse/config/push.py +64 -0
  277. synapse/config/ratelimiting.py +260 -0
  278. synapse/config/redis.py +74 -0
  279. synapse/config/registration.py +296 -0
  280. synapse/config/repository.py +311 -0
  281. synapse/config/retention.py +162 -0
  282. synapse/config/room.py +88 -0
  283. synapse/config/room_directory.py +165 -0
  284. synapse/config/saml2.py +251 -0
  285. synapse/config/server.py +1139 -0
  286. synapse/config/server_notices.py +84 -0
  287. synapse/config/spam_checker.py +66 -0
  288. synapse/config/sso.py +121 -0
  289. synapse/config/stats.py +54 -0
  290. synapse/config/third_party_event_rules.py +40 -0
  291. synapse/config/tls.py +192 -0
  292. synapse/config/tracer.py +71 -0
  293. synapse/config/user_directory.py +47 -0
  294. synapse/config/user_types.py +42 -0
  295. synapse/config/voip.py +59 -0
  296. synapse/config/workers.py +642 -0
  297. synapse/crypto/__init__.py +20 -0
  298. synapse/crypto/context_factory.py +278 -0
  299. synapse/crypto/event_signing.py +194 -0
  300. synapse/crypto/keyring.py +980 -0
  301. synapse/event_auth.py +1266 -0
  302. synapse/events/__init__.py +667 -0
  303. synapse/events/auto_accept_invites.py +216 -0
  304. synapse/events/builder.py +387 -0
  305. synapse/events/presence_router.py +243 -0
  306. synapse/events/snapshot.py +559 -0
  307. synapse/events/utils.py +924 -0
  308. synapse/events/validator.py +305 -0
  309. synapse/federation/__init__.py +22 -0
  310. synapse/federation/federation_base.py +382 -0
  311. synapse/federation/federation_client.py +2133 -0
  312. synapse/federation/federation_server.py +1543 -0
  313. synapse/federation/persistence.py +70 -0
  314. synapse/federation/send_queue.py +532 -0
  315. synapse/federation/sender/__init__.py +1165 -0
  316. synapse/federation/sender/per_destination_queue.py +886 -0
  317. synapse/federation/sender/transaction_manager.py +210 -0
  318. synapse/federation/transport/__init__.py +28 -0
  319. synapse/federation/transport/client.py +1199 -0
  320. synapse/federation/transport/server/__init__.py +334 -0
  321. synapse/federation/transport/server/_base.py +429 -0
  322. synapse/federation/transport/server/federation.py +910 -0
  323. synapse/federation/units.py +133 -0
  324. synapse/handlers/__init__.py +20 -0
  325. synapse/handlers/account.py +162 -0
  326. synapse/handlers/account_data.py +360 -0
  327. synapse/handlers/account_validity.py +362 -0
  328. synapse/handlers/admin.py +615 -0
  329. synapse/handlers/appservice.py +989 -0
  330. synapse/handlers/auth.py +2482 -0
  331. synapse/handlers/cas.py +413 -0
  332. synapse/handlers/deactivate_account.py +363 -0
  333. synapse/handlers/delayed_events.py +607 -0
  334. synapse/handlers/device.py +1869 -0
  335. synapse/handlers/devicemessage.py +399 -0
  336. synapse/handlers/directory.py +545 -0
  337. synapse/handlers/e2e_keys.py +1835 -0
  338. synapse/handlers/e2e_room_keys.py +455 -0
  339. synapse/handlers/event_auth.py +390 -0
  340. synapse/handlers/events.py +203 -0
  341. synapse/handlers/federation.py +2042 -0
  342. synapse/handlers/federation_event.py +2420 -0
  343. synapse/handlers/identity.py +812 -0
  344. synapse/handlers/initial_sync.py +528 -0
  345. synapse/handlers/jwt.py +120 -0
  346. synapse/handlers/message.py +2357 -0
  347. synapse/handlers/oidc.py +1801 -0
  348. synapse/handlers/pagination.py +811 -0
  349. synapse/handlers/password_policy.py +102 -0
  350. synapse/handlers/presence.py +2634 -0
  351. synapse/handlers/profile.py +656 -0
  352. synapse/handlers/push_rules.py +164 -0
  353. synapse/handlers/read_marker.py +79 -0
  354. synapse/handlers/receipts.py +351 -0
  355. synapse/handlers/register.py +1059 -0
  356. synapse/handlers/relations.py +623 -0
  357. synapse/handlers/reports.py +98 -0
  358. synapse/handlers/room.py +2449 -0
  359. synapse/handlers/room_list.py +632 -0
  360. synapse/handlers/room_member.py +2366 -0
  361. synapse/handlers/room_member_worker.py +146 -0
  362. synapse/handlers/room_policy.py +186 -0
  363. synapse/handlers/room_summary.py +1057 -0
  364. synapse/handlers/saml.py +524 -0
  365. synapse/handlers/search.py +723 -0
  366. synapse/handlers/send_email.py +209 -0
  367. synapse/handlers/set_password.py +71 -0
  368. synapse/handlers/sliding_sync/__init__.py +1961 -0
  369. synapse/handlers/sliding_sync/extensions.py +969 -0
  370. synapse/handlers/sliding_sync/room_lists.py +2317 -0
  371. synapse/handlers/sliding_sync/store.py +126 -0
  372. synapse/handlers/sso.py +1291 -0
  373. synapse/handlers/state_deltas.py +82 -0
  374. synapse/handlers/stats.py +322 -0
  375. synapse/handlers/sync.py +3096 -0
  376. synapse/handlers/thread_subscriptions.py +190 -0
  377. synapse/handlers/typing.py +612 -0
  378. synapse/handlers/ui_auth/__init__.py +48 -0
  379. synapse/handlers/ui_auth/checkers.py +332 -0
  380. synapse/handlers/user_directory.py +786 -0
  381. synapse/handlers/worker_lock.py +371 -0
  382. synapse/http/__init__.py +105 -0
  383. synapse/http/additional_resource.py +62 -0
  384. synapse/http/client.py +1377 -0
  385. synapse/http/connectproxyclient.py +316 -0
  386. synapse/http/federation/__init__.py +19 -0
  387. synapse/http/federation/matrix_federation_agent.py +490 -0
  388. synapse/http/federation/srv_resolver.py +196 -0
  389. synapse/http/federation/well_known_resolver.py +368 -0
  390. synapse/http/matrixfederationclient.py +1874 -0
  391. synapse/http/proxy.py +290 -0
  392. synapse/http/proxyagent.py +497 -0
  393. synapse/http/replicationagent.py +203 -0
  394. synapse/http/request_metrics.py +309 -0
  395. synapse/http/server.py +1111 -0
  396. synapse/http/servlet.py +1018 -0
  397. synapse/http/site.py +952 -0
  398. synapse/http/types.py +27 -0
  399. synapse/logging/__init__.py +31 -0
  400. synapse/logging/_remote.py +261 -0
  401. synapse/logging/_terse_json.py +95 -0
  402. synapse/logging/context.py +1209 -0
  403. synapse/logging/formatter.py +62 -0
  404. synapse/logging/handlers.py +99 -0
  405. synapse/logging/loggers.py +25 -0
  406. synapse/logging/opentracing.py +1132 -0
  407. synapse/logging/scopecontextmanager.py +160 -0
  408. synapse/media/_base.py +831 -0
  409. synapse/media/filepath.py +417 -0
  410. synapse/media/media_repository.py +1595 -0
  411. synapse/media/media_storage.py +703 -0
  412. synapse/media/oembed.py +277 -0
  413. synapse/media/preview_html.py +556 -0
  414. synapse/media/storage_provider.py +195 -0
  415. synapse/media/thumbnailer.py +833 -0
  416. synapse/media/url_previewer.py +884 -0
  417. synapse/metrics/__init__.py +748 -0
  418. synapse/metrics/_gc.py +219 -0
  419. synapse/metrics/_reactor_metrics.py +171 -0
  420. synapse/metrics/_types.py +38 -0
  421. synapse/metrics/background_process_metrics.py +555 -0
  422. synapse/metrics/common_usage_metrics.py +95 -0
  423. synapse/metrics/jemalloc.py +248 -0
  424. synapse/module_api/__init__.py +2131 -0
  425. synapse/module_api/callbacks/__init__.py +50 -0
  426. synapse/module_api/callbacks/account_validity_callbacks.py +106 -0
  427. synapse/module_api/callbacks/media_repository_callbacks.py +157 -0
  428. synapse/module_api/callbacks/ratelimit_callbacks.py +78 -0
  429. synapse/module_api/callbacks/spamchecker_callbacks.py +991 -0
  430. synapse/module_api/callbacks/third_party_event_rules_callbacks.py +592 -0
  431. synapse/module_api/errors.py +42 -0
  432. synapse/notifier.py +969 -0
  433. synapse/push/__init__.py +212 -0
  434. synapse/push/bulk_push_rule_evaluator.py +635 -0
  435. synapse/push/clientformat.py +126 -0
  436. synapse/push/emailpusher.py +334 -0
  437. synapse/push/httppusher.py +565 -0
  438. synapse/push/mailer.py +1009 -0
  439. synapse/push/presentable_names.py +216 -0
  440. synapse/push/push_tools.py +114 -0
  441. synapse/push/push_types.py +141 -0
  442. synapse/push/pusher.py +87 -0
  443. synapse/push/pusherpool.py +501 -0
  444. synapse/push/rulekinds.py +33 -0
  445. synapse/py.typed +0 -0
  446. synapse/replication/__init__.py +20 -0
  447. synapse/replication/http/__init__.py +68 -0
  448. synapse/replication/http/_base.py +469 -0
  449. synapse/replication/http/account_data.py +297 -0
  450. synapse/replication/http/deactivate_account.py +81 -0
  451. synapse/replication/http/delayed_events.py +62 -0
  452. synapse/replication/http/devices.py +254 -0
  453. synapse/replication/http/federation.py +334 -0
  454. synapse/replication/http/login.py +106 -0
  455. synapse/replication/http/membership.py +364 -0
  456. synapse/replication/http/presence.py +133 -0
  457. synapse/replication/http/push.py +156 -0
  458. synapse/replication/http/register.py +172 -0
  459. synapse/replication/http/send_events.py +182 -0
  460. synapse/replication/http/state.py +82 -0
  461. synapse/replication/http/streams.py +101 -0
  462. synapse/replication/tcp/__init__.py +56 -0
  463. synapse/replication/tcp/client.py +553 -0
  464. synapse/replication/tcp/commands.py +569 -0
  465. synapse/replication/tcp/context.py +41 -0
  466. synapse/replication/tcp/external_cache.py +156 -0
  467. synapse/replication/tcp/handler.py +922 -0
  468. synapse/replication/tcp/protocol.py +611 -0
  469. synapse/replication/tcp/redis.py +510 -0
  470. synapse/replication/tcp/resource.py +349 -0
  471. synapse/replication/tcp/streams/__init__.py +96 -0
  472. synapse/replication/tcp/streams/_base.py +765 -0
  473. synapse/replication/tcp/streams/events.py +287 -0
  474. synapse/replication/tcp/streams/federation.py +92 -0
  475. synapse/replication/tcp/streams/partial_state.py +80 -0
  476. synapse/res/providers.json +29 -0
  477. synapse/res/templates/_base.html +29 -0
  478. synapse/res/templates/account_previously_renewed.html +6 -0
  479. synapse/res/templates/account_renewed.html +6 -0
  480. synapse/res/templates/add_threepid.html +8 -0
  481. synapse/res/templates/add_threepid.txt +6 -0
  482. synapse/res/templates/add_threepid_failure.html +7 -0
  483. synapse/res/templates/add_threepid_success.html +6 -0
  484. synapse/res/templates/already_in_use.html +12 -0
  485. synapse/res/templates/already_in_use.txt +10 -0
  486. synapse/res/templates/auth_success.html +21 -0
  487. synapse/res/templates/invalid_token.html +6 -0
  488. synapse/res/templates/mail-Element.css +7 -0
  489. synapse/res/templates/mail-Vector.css +7 -0
  490. synapse/res/templates/mail-expiry.css +4 -0
  491. synapse/res/templates/mail.css +156 -0
  492. synapse/res/templates/notice_expiry.html +46 -0
  493. synapse/res/templates/notice_expiry.txt +7 -0
  494. synapse/res/templates/notif.html +51 -0
  495. synapse/res/templates/notif.txt +22 -0
  496. synapse/res/templates/notif_mail.html +59 -0
  497. synapse/res/templates/notif_mail.txt +10 -0
  498. synapse/res/templates/password_reset.html +10 -0
  499. synapse/res/templates/password_reset.txt +7 -0
  500. synapse/res/templates/password_reset_confirmation.html +15 -0
  501. synapse/res/templates/password_reset_failure.html +7 -0
  502. synapse/res/templates/password_reset_success.html +6 -0
  503. synapse/res/templates/recaptcha.html +42 -0
  504. synapse/res/templates/registration.html +12 -0
  505. synapse/res/templates/registration.txt +10 -0
  506. synapse/res/templates/registration_failure.html +6 -0
  507. synapse/res/templates/registration_success.html +6 -0
  508. synapse/res/templates/registration_token.html +18 -0
  509. synapse/res/templates/room.html +33 -0
  510. synapse/res/templates/room.txt +9 -0
  511. synapse/res/templates/sso.css +129 -0
  512. synapse/res/templates/sso_account_deactivated.html +25 -0
  513. synapse/res/templates/sso_auth_account_details.html +186 -0
  514. synapse/res/templates/sso_auth_account_details.js +116 -0
  515. synapse/res/templates/sso_auth_bad_user.html +26 -0
  516. synapse/res/templates/sso_auth_confirm.html +27 -0
  517. synapse/res/templates/sso_auth_success.html +26 -0
  518. synapse/res/templates/sso_error.html +71 -0
  519. synapse/res/templates/sso_footer.html +19 -0
  520. synapse/res/templates/sso_login_idp_picker.html +60 -0
  521. synapse/res/templates/sso_new_user_consent.html +30 -0
  522. synapse/res/templates/sso_partial_profile.html +19 -0
  523. synapse/res/templates/sso_redirect_confirm.html +39 -0
  524. synapse/res/templates/style.css +33 -0
  525. synapse/res/templates/terms.html +27 -0
  526. synapse/rest/__init__.py +197 -0
  527. synapse/rest/admin/__init__.py +395 -0
  528. synapse/rest/admin/_base.py +72 -0
  529. synapse/rest/admin/background_updates.py +171 -0
  530. synapse/rest/admin/devices.py +221 -0
  531. synapse/rest/admin/event_reports.py +173 -0
  532. synapse/rest/admin/events.py +69 -0
  533. synapse/rest/admin/experimental_features.py +137 -0
  534. synapse/rest/admin/federation.py +243 -0
  535. synapse/rest/admin/media.py +540 -0
  536. synapse/rest/admin/registration_tokens.py +358 -0
  537. synapse/rest/admin/rooms.py +1092 -0
  538. synapse/rest/admin/scheduled_tasks.py +70 -0
  539. synapse/rest/admin/server_notice_servlet.py +132 -0
  540. synapse/rest/admin/statistics.py +132 -0
  541. synapse/rest/admin/username_available.py +58 -0
  542. synapse/rest/admin/users.py +1634 -0
  543. synapse/rest/client/__init__.py +20 -0
  544. synapse/rest/client/_base.py +113 -0
  545. synapse/rest/client/account.py +937 -0
  546. synapse/rest/client/account_data.py +319 -0
  547. synapse/rest/client/account_validity.py +103 -0
  548. synapse/rest/client/appservice_ping.py +125 -0
  549. synapse/rest/client/auth.py +218 -0
  550. synapse/rest/client/auth_metadata.py +122 -0
  551. synapse/rest/client/capabilities.py +121 -0
  552. synapse/rest/client/delayed_events.py +165 -0
  553. synapse/rest/client/devices.py +587 -0
  554. synapse/rest/client/directory.py +211 -0
  555. synapse/rest/client/events.py +116 -0
  556. synapse/rest/client/filter.py +112 -0
  557. synapse/rest/client/initial_sync.py +65 -0
  558. synapse/rest/client/keys.py +678 -0
  559. synapse/rest/client/knock.py +104 -0
  560. synapse/rest/client/login.py +750 -0
  561. synapse/rest/client/login_token_request.py +127 -0
  562. synapse/rest/client/logout.py +93 -0
  563. synapse/rest/client/matrixrtc.py +52 -0
  564. synapse/rest/client/media.py +307 -0
  565. synapse/rest/client/mutual_rooms.py +145 -0
  566. synapse/rest/client/notifications.py +137 -0
  567. synapse/rest/client/openid.py +109 -0
  568. synapse/rest/client/password_policy.py +69 -0
  569. synapse/rest/client/presence.py +131 -0
  570. synapse/rest/client/profile.py +291 -0
  571. synapse/rest/client/push_rule.py +331 -0
  572. synapse/rest/client/pusher.py +181 -0
  573. synapse/rest/client/read_marker.py +104 -0
  574. synapse/rest/client/receipts.py +165 -0
  575. synapse/rest/client/register.py +1072 -0
  576. synapse/rest/client/relations.py +138 -0
  577. synapse/rest/client/rendezvous.py +76 -0
  578. synapse/rest/client/reporting.py +207 -0
  579. synapse/rest/client/room.py +1763 -0
  580. synapse/rest/client/room_keys.py +426 -0
  581. synapse/rest/client/room_upgrade_rest_servlet.py +112 -0
  582. synapse/rest/client/sendtodevice.py +85 -0
  583. synapse/rest/client/sync.py +1131 -0
  584. synapse/rest/client/tags.py +129 -0
  585. synapse/rest/client/thirdparty.py +130 -0
  586. synapse/rest/client/thread_subscriptions.py +247 -0
  587. synapse/rest/client/tokenrefresh.py +52 -0
  588. synapse/rest/client/transactions.py +150 -0
  589. synapse/rest/client/user_directory.py +99 -0
  590. synapse/rest/client/versions.py +193 -0
  591. synapse/rest/client/voip.py +88 -0
  592. synapse/rest/consent/__init__.py +0 -0
  593. synapse/rest/consent/consent_resource.py +210 -0
  594. synapse/rest/health.py +38 -0
  595. synapse/rest/key/__init__.py +20 -0
  596. synapse/rest/key/v2/__init__.py +40 -0
  597. synapse/rest/key/v2/local_key_resource.py +125 -0
  598. synapse/rest/key/v2/remote_key_resource.py +302 -0
  599. synapse/rest/media/__init__.py +0 -0
  600. synapse/rest/media/config_resource.py +53 -0
  601. synapse/rest/media/create_resource.py +90 -0
  602. synapse/rest/media/download_resource.py +110 -0
  603. synapse/rest/media/media_repository_resource.py +113 -0
  604. synapse/rest/media/preview_url_resource.py +77 -0
  605. synapse/rest/media/thumbnail_resource.py +142 -0
  606. synapse/rest/media/upload_resource.py +187 -0
  607. synapse/rest/media/v1/__init__.py +39 -0
  608. synapse/rest/media/v1/_base.py +23 -0
  609. synapse/rest/media/v1/media_storage.py +23 -0
  610. synapse/rest/media/v1/storage_provider.py +23 -0
  611. synapse/rest/synapse/__init__.py +20 -0
  612. synapse/rest/synapse/client/__init__.py +93 -0
  613. synapse/rest/synapse/client/federation_whitelist.py +66 -0
  614. synapse/rest/synapse/client/jwks.py +77 -0
  615. synapse/rest/synapse/client/new_user_consent.py +115 -0
  616. synapse/rest/synapse/client/oidc/__init__.py +45 -0
  617. synapse/rest/synapse/client/oidc/backchannel_logout_resource.py +42 -0
  618. synapse/rest/synapse/client/oidc/callback_resource.py +48 -0
  619. synapse/rest/synapse/client/password_reset.py +129 -0
  620. synapse/rest/synapse/client/pick_idp.py +107 -0
  621. synapse/rest/synapse/client/pick_username.py +153 -0
  622. synapse/rest/synapse/client/rendezvous.py +58 -0
  623. synapse/rest/synapse/client/saml2/__init__.py +42 -0
  624. synapse/rest/synapse/client/saml2/metadata_resource.py +46 -0
  625. synapse/rest/synapse/client/saml2/response_resource.py +52 -0
  626. synapse/rest/synapse/client/sso_register.py +56 -0
  627. synapse/rest/synapse/client/unsubscribe.py +88 -0
  628. synapse/rest/synapse/mas/__init__.py +71 -0
  629. synapse/rest/synapse/mas/_base.py +55 -0
  630. synapse/rest/synapse/mas/devices.py +239 -0
  631. synapse/rest/synapse/mas/users.py +469 -0
  632. synapse/rest/well_known.py +148 -0
  633. synapse/server.py +1279 -0
  634. synapse/server_notices/__init__.py +0 -0
  635. synapse/server_notices/consent_server_notices.py +136 -0
  636. synapse/server_notices/resource_limits_server_notices.py +215 -0
  637. synapse/server_notices/server_notices_manager.py +388 -0
  638. synapse/server_notices/server_notices_sender.py +67 -0
  639. synapse/server_notices/worker_server_notices_sender.py +46 -0
  640. synapse/spam_checker_api/__init__.py +31 -0
  641. synapse/state/__init__.py +1023 -0
  642. synapse/state/v1.py +369 -0
  643. synapse/state/v2.py +985 -0
  644. synapse/static/client/login/index.html +47 -0
  645. synapse/static/client/login/js/jquery-3.4.1.min.js +2 -0
  646. synapse/static/client/login/js/login.js +291 -0
  647. synapse/static/client/login/spinner.gif +0 -0
  648. synapse/static/client/login/style.css +79 -0
  649. synapse/static/index.html +63 -0
  650. synapse/storage/__init__.py +43 -0
  651. synapse/storage/_base.py +245 -0
  652. synapse/storage/admin_client_config.py +25 -0
  653. synapse/storage/background_updates.py +1189 -0
  654. synapse/storage/controllers/__init__.py +57 -0
  655. synapse/storage/controllers/persist_events.py +1237 -0
  656. synapse/storage/controllers/purge_events.py +456 -0
  657. synapse/storage/controllers/state.py +950 -0
  658. synapse/storage/controllers/stats.py +119 -0
  659. synapse/storage/database.py +2720 -0
  660. synapse/storage/databases/__init__.py +175 -0
  661. synapse/storage/databases/main/__init__.py +420 -0
  662. synapse/storage/databases/main/account_data.py +1073 -0
  663. synapse/storage/databases/main/appservice.py +473 -0
  664. synapse/storage/databases/main/cache.py +912 -0
  665. synapse/storage/databases/main/censor_events.py +226 -0
  666. synapse/storage/databases/main/client_ips.py +816 -0
  667. synapse/storage/databases/main/delayed_events.py +577 -0
  668. synapse/storage/databases/main/deviceinbox.py +1272 -0
  669. synapse/storage/databases/main/devices.py +2579 -0
  670. synapse/storage/databases/main/directory.py +212 -0
  671. synapse/storage/databases/main/e2e_room_keys.py +689 -0
  672. synapse/storage/databases/main/end_to_end_keys.py +1894 -0
  673. synapse/storage/databases/main/event_federation.py +2511 -0
  674. synapse/storage/databases/main/event_push_actions.py +1936 -0
  675. synapse/storage/databases/main/events.py +3765 -0
  676. synapse/storage/databases/main/events_bg_updates.py +2910 -0
  677. synapse/storage/databases/main/events_forward_extremities.py +126 -0
  678. synapse/storage/databases/main/events_worker.py +2787 -0
  679. synapse/storage/databases/main/experimental_features.py +130 -0
  680. synapse/storage/databases/main/filtering.py +231 -0
  681. synapse/storage/databases/main/keys.py +291 -0
  682. synapse/storage/databases/main/lock.py +554 -0
  683. synapse/storage/databases/main/media_repository.py +1068 -0
  684. synapse/storage/databases/main/metrics.py +461 -0
  685. synapse/storage/databases/main/monthly_active_users.py +443 -0
  686. synapse/storage/databases/main/openid.py +60 -0
  687. synapse/storage/databases/main/presence.py +509 -0
  688. synapse/storage/databases/main/profile.py +539 -0
  689. synapse/storage/databases/main/purge_events.py +521 -0
  690. synapse/storage/databases/main/push_rule.py +970 -0
  691. synapse/storage/databases/main/pusher.py +793 -0
  692. synapse/storage/databases/main/receipts.py +1341 -0
  693. synapse/storage/databases/main/registration.py +3071 -0
  694. synapse/storage/databases/main/rejections.py +37 -0
  695. synapse/storage/databases/main/relations.py +1116 -0
  696. synapse/storage/databases/main/room.py +2779 -0
  697. synapse/storage/databases/main/roommember.py +2132 -0
  698. synapse/storage/databases/main/search.py +939 -0
  699. synapse/storage/databases/main/session.py +152 -0
  700. synapse/storage/databases/main/signatures.py +94 -0
  701. synapse/storage/databases/main/sliding_sync.py +842 -0
  702. synapse/storage/databases/main/state.py +1002 -0
  703. synapse/storage/databases/main/state_deltas.py +360 -0
  704. synapse/storage/databases/main/stats.py +789 -0
  705. synapse/storage/databases/main/stream.py +2589 -0
  706. synapse/storage/databases/main/tags.py +360 -0
  707. synapse/storage/databases/main/task_scheduler.py +225 -0
  708. synapse/storage/databases/main/thread_subscriptions.py +589 -0
  709. synapse/storage/databases/main/transactions.py +676 -0
  710. synapse/storage/databases/main/ui_auth.py +420 -0
  711. synapse/storage/databases/main/user_directory.py +1330 -0
  712. synapse/storage/databases/main/user_erasure_store.py +117 -0
  713. synapse/storage/databases/state/__init__.py +22 -0
  714. synapse/storage/databases/state/bg_updates.py +497 -0
  715. synapse/storage/databases/state/deletion.py +557 -0
  716. synapse/storage/databases/state/store.py +948 -0
  717. synapse/storage/engines/__init__.py +70 -0
  718. synapse/storage/engines/_base.py +154 -0
  719. synapse/storage/engines/postgres.py +261 -0
  720. synapse/storage/engines/sqlite.py +199 -0
  721. synapse/storage/invite_rule.py +152 -0
  722. synapse/storage/keys.py +40 -0
  723. synapse/storage/prepare_database.py +730 -0
  724. synapse/storage/push_rule.py +28 -0
  725. synapse/storage/roommember.py +88 -0
  726. synapse/storage/schema/README.md +4 -0
  727. synapse/storage/schema/__init__.py +186 -0
  728. synapse/storage/schema/common/delta/25/00background_updates.sql +40 -0
  729. synapse/storage/schema/common/delta/35/00background_updates_add_col.sql +36 -0
  730. synapse/storage/schema/common/delta/58/00background_update_ordering.sql +38 -0
  731. synapse/storage/schema/common/full_schemas/72/full.sql.postgres +8 -0
  732. synapse/storage/schema/common/full_schemas/72/full.sql.sqlite +6 -0
  733. synapse/storage/schema/common/schema_version.sql +60 -0
  734. synapse/storage/schema/main/delta/12/v12.sql +82 -0
  735. synapse/storage/schema/main/delta/13/v13.sql +38 -0
  736. synapse/storage/schema/main/delta/14/v14.sql +42 -0
  737. synapse/storage/schema/main/delta/15/appservice_txns.sql +50 -0
  738. synapse/storage/schema/main/delta/15/presence_indices.sql +2 -0
  739. synapse/storage/schema/main/delta/15/v15.sql +24 -0
  740. synapse/storage/schema/main/delta/16/events_order_index.sql +4 -0
  741. synapse/storage/schema/main/delta/16/remote_media_cache_index.sql +2 -0
  742. synapse/storage/schema/main/delta/16/remove_duplicates.sql +9 -0
  743. synapse/storage/schema/main/delta/16/room_alias_index.sql +3 -0
  744. synapse/storage/schema/main/delta/16/unique_constraints.sql +72 -0
  745. synapse/storage/schema/main/delta/16/users.sql +56 -0
  746. synapse/storage/schema/main/delta/17/drop_indexes.sql +37 -0
  747. synapse/storage/schema/main/delta/17/server_keys.sql +43 -0
  748. synapse/storage/schema/main/delta/17/user_threepids.sql +9 -0
  749. synapse/storage/schema/main/delta/18/server_keys_bigger_ints.sql +51 -0
  750. synapse/storage/schema/main/delta/19/event_index.sql +38 -0
  751. synapse/storage/schema/main/delta/20/dummy.sql +1 -0
  752. synapse/storage/schema/main/delta/20/pushers.py +93 -0
  753. synapse/storage/schema/main/delta/21/end_to_end_keys.sql +53 -0
  754. synapse/storage/schema/main/delta/21/receipts.sql +57 -0
  755. synapse/storage/schema/main/delta/22/receipts_index.sql +41 -0
  756. synapse/storage/schema/main/delta/22/user_threepids_unique.sql +19 -0
  757. synapse/storage/schema/main/delta/24/stats_reporting.sql +37 -0
  758. synapse/storage/schema/main/delta/25/fts.py +81 -0
  759. synapse/storage/schema/main/delta/25/guest_access.sql +44 -0
  760. synapse/storage/schema/main/delta/25/history_visibility.sql +44 -0
  761. synapse/storage/schema/main/delta/25/tags.sql +57 -0
  762. synapse/storage/schema/main/delta/26/account_data.sql +36 -0
  763. synapse/storage/schema/main/delta/27/account_data.sql +55 -0
  764. synapse/storage/schema/main/delta/27/forgotten_memberships.sql +45 -0
  765. synapse/storage/schema/main/delta/27/ts.py +61 -0
  766. synapse/storage/schema/main/delta/28/event_push_actions.sql +46 -0
  767. synapse/storage/schema/main/delta/28/events_room_stream.sql +39 -0
  768. synapse/storage/schema/main/delta/28/public_roms_index.sql +39 -0
  769. synapse/storage/schema/main/delta/28/receipts_user_id_index.sql +41 -0
  770. synapse/storage/schema/main/delta/28/upgrade_times.sql +40 -0
  771. synapse/storage/schema/main/delta/28/users_is_guest.sql +41 -0
  772. synapse/storage/schema/main/delta/29/push_actions.sql +54 -0
  773. synapse/storage/schema/main/delta/30/alias_creator.sql +35 -0
  774. synapse/storage/schema/main/delta/30/as_users.py +82 -0
  775. synapse/storage/schema/main/delta/30/deleted_pushers.sql +44 -0
  776. synapse/storage/schema/main/delta/30/presence_stream.sql +49 -0
  777. synapse/storage/schema/main/delta/30/public_rooms.sql +42 -0
  778. synapse/storage/schema/main/delta/30/push_rule_stream.sql +57 -0
  779. synapse/storage/schema/main/delta/30/threepid_guest_access_tokens.sql +43 -0
  780. synapse/storage/schema/main/delta/31/invites.sql +61 -0
  781. synapse/storage/schema/main/delta/31/local_media_repository_url_cache.sql +46 -0
  782. synapse/storage/schema/main/delta/31/pushers_0.py +92 -0
  783. synapse/storage/schema/main/delta/31/pushers_index.sql +41 -0
  784. synapse/storage/schema/main/delta/31/search_update.py +65 -0
  785. synapse/storage/schema/main/delta/32/events.sql +35 -0
  786. synapse/storage/schema/main/delta/32/openid.sql +9 -0
  787. synapse/storage/schema/main/delta/32/pusher_throttle.sql +42 -0
  788. synapse/storage/schema/main/delta/32/remove_indices.sql +52 -0
  789. synapse/storage/schema/main/delta/32/reports.sql +44 -0
  790. synapse/storage/schema/main/delta/33/access_tokens_device_index.sql +36 -0
  791. synapse/storage/schema/main/delta/33/devices.sql +40 -0
  792. synapse/storage/schema/main/delta/33/devices_for_e2e_keys.sql +38 -0
  793. synapse/storage/schema/main/delta/33/devices_for_e2e_keys_clear_unknown_device.sql +39 -0
  794. synapse/storage/schema/main/delta/33/event_fields.py +61 -0
  795. synapse/storage/schema/main/delta/33/remote_media_ts.py +43 -0
  796. synapse/storage/schema/main/delta/33/user_ips_index.sql +36 -0
  797. synapse/storage/schema/main/delta/34/appservice_stream.sql +42 -0
  798. synapse/storage/schema/main/delta/34/cache_stream.py +50 -0
  799. synapse/storage/schema/main/delta/34/device_inbox.sql +43 -0
  800. synapse/storage/schema/main/delta/34/push_display_name_rename.sql +39 -0
  801. synapse/storage/schema/main/delta/34/received_txn_purge.py +36 -0
  802. synapse/storage/schema/main/delta/35/contains_url.sql +36 -0
  803. synapse/storage/schema/main/delta/35/device_outbox.sql +58 -0
  804. synapse/storage/schema/main/delta/35/device_stream_id.sql +40 -0
  805. synapse/storage/schema/main/delta/35/event_push_actions_index.sql +36 -0
  806. synapse/storage/schema/main/delta/35/public_room_list_change_stream.sql +52 -0
  807. synapse/storage/schema/main/delta/35/stream_order_to_extrem.sql +56 -0
  808. synapse/storage/schema/main/delta/36/readd_public_rooms.sql +45 -0
  809. synapse/storage/schema/main/delta/37/remove_auth_idx.py +89 -0
  810. synapse/storage/schema/main/delta/37/user_threepids.sql +71 -0
  811. synapse/storage/schema/main/delta/38/postgres_fts_gist.sql +38 -0
  812. synapse/storage/schema/main/delta/39/appservice_room_list.sql +48 -0
  813. synapse/storage/schema/main/delta/39/device_federation_stream_idx.sql +35 -0
  814. synapse/storage/schema/main/delta/39/event_push_index.sql +36 -0
  815. synapse/storage/schema/main/delta/39/federation_out_position.sql +41 -0
  816. synapse/storage/schema/main/delta/39/membership_profile.sql +39 -0
  817. synapse/storage/schema/main/delta/40/current_state_idx.sql +36 -0
  818. synapse/storage/schema/main/delta/40/device_inbox.sql +40 -0
  819. synapse/storage/schema/main/delta/40/device_list_streams.sql +79 -0
  820. synapse/storage/schema/main/delta/40/event_push_summary.sql +57 -0
  821. synapse/storage/schema/main/delta/40/pushers.sql +58 -0
  822. synapse/storage/schema/main/delta/41/device_list_stream_idx.sql +36 -0
  823. synapse/storage/schema/main/delta/41/device_outbound_index.sql +35 -0
  824. synapse/storage/schema/main/delta/41/event_search_event_id_idx.sql +36 -0
  825. synapse/storage/schema/main/delta/41/ratelimit.sql +41 -0
  826. synapse/storage/schema/main/delta/42/current_state_delta.sql +48 -0
  827. synapse/storage/schema/main/delta/42/device_list_last_id.sql +52 -0
  828. synapse/storage/schema/main/delta/42/event_auth_state_only.sql +36 -0
  829. synapse/storage/schema/main/delta/42/user_dir.py +88 -0
  830. synapse/storage/schema/main/delta/43/blocked_rooms.sql +40 -0
  831. synapse/storage/schema/main/delta/43/quarantine_media.sql +36 -0
  832. synapse/storage/schema/main/delta/43/url_cache.sql +35 -0
  833. synapse/storage/schema/main/delta/43/user_share.sql +52 -0
  834. synapse/storage/schema/main/delta/44/expire_url_cache.sql +60 -0
  835. synapse/storage/schema/main/delta/45/group_server.sql +186 -0
  836. synapse/storage/schema/main/delta/45/profile_cache.sql +47 -0
  837. synapse/storage/schema/main/delta/46/drop_refresh_tokens.sql +36 -0
  838. synapse/storage/schema/main/delta/46/drop_unique_deleted_pushers.sql +54 -0
  839. synapse/storage/schema/main/delta/46/group_server.sql +51 -0
  840. synapse/storage/schema/main/delta/46/local_media_repository_url_idx.sql +43 -0
  841. synapse/storage/schema/main/delta/46/user_dir_null_room_ids.sql +54 -0
  842. synapse/storage/schema/main/delta/46/user_dir_typos.sql +43 -0
  843. synapse/storage/schema/main/delta/47/last_access_media.sql +35 -0
  844. synapse/storage/schema/main/delta/47/postgres_fts_gin.sql +36 -0
  845. synapse/storage/schema/main/delta/47/push_actions_staging.sql +47 -0
  846. synapse/storage/schema/main/delta/48/add_user_consent.sql +37 -0
  847. synapse/storage/schema/main/delta/48/add_user_ips_last_seen_index.sql +36 -0
  848. synapse/storage/schema/main/delta/48/deactivated_users.sql +44 -0
  849. synapse/storage/schema/main/delta/48/group_unique_indexes.py +67 -0
  850. synapse/storage/schema/main/delta/48/groups_joinable.sql +41 -0
  851. synapse/storage/schema/main/delta/49/add_user_consent_server_notice_sent.sql +39 -0
  852. synapse/storage/schema/main/delta/49/add_user_daily_visits.sql +40 -0
  853. synapse/storage/schema/main/delta/49/add_user_ips_last_seen_only_index.sql +36 -0
  854. synapse/storage/schema/main/delta/50/add_creation_ts_users_index.sql +38 -0
  855. synapse/storage/schema/main/delta/50/erasure_store.sql +40 -0
  856. synapse/storage/schema/main/delta/50/make_event_content_nullable.py +102 -0
  857. synapse/storage/schema/main/delta/51/e2e_room_keys.sql +58 -0
  858. synapse/storage/schema/main/delta/51/monthly_active_users.sql +46 -0
  859. synapse/storage/schema/main/delta/52/add_event_to_state_group_index.sql +38 -0
  860. synapse/storage/schema/main/delta/52/device_list_streams_unique_idx.sql +55 -0
  861. synapse/storage/schema/main/delta/52/e2e_room_keys.sql +72 -0
  862. synapse/storage/schema/main/delta/53/add_user_type_to_users.sql +38 -0
  863. synapse/storage/schema/main/delta/53/drop_sent_transactions.sql +35 -0
  864. synapse/storage/schema/main/delta/53/event_format_version.sql +35 -0
  865. synapse/storage/schema/main/delta/53/user_dir_populate.sql +49 -0
  866. synapse/storage/schema/main/delta/53/user_ips_index.sql +49 -0
  867. synapse/storage/schema/main/delta/53/user_share.sql +63 -0
  868. synapse/storage/schema/main/delta/53/user_threepid_id.sql +48 -0
  869. synapse/storage/schema/main/delta/53/users_in_public_rooms.sql +47 -0
  870. synapse/storage/schema/main/delta/54/account_validity_with_renewal.sql +49 -0
  871. synapse/storage/schema/main/delta/54/add_validity_to_server_keys.sql +42 -0
  872. synapse/storage/schema/main/delta/54/delete_forward_extremities.sql +42 -0
  873. synapse/storage/schema/main/delta/54/drop_legacy_tables.sql +49 -0
  874. synapse/storage/schema/main/delta/54/drop_presence_list.sql +35 -0
  875. synapse/storage/schema/main/delta/54/relations.sql +46 -0
  876. synapse/storage/schema/main/delta/54/stats.sql +99 -0
  877. synapse/storage/schema/main/delta/54/stats2.sql +47 -0
  878. synapse/storage/schema/main/delta/55/access_token_expiry.sql +37 -0
  879. synapse/storage/schema/main/delta/55/track_threepid_validations.sql +50 -0
  880. synapse/storage/schema/main/delta/55/users_alter_deactivated.sql +38 -0
  881. synapse/storage/schema/main/delta/56/add_spans_to_device_lists.sql +39 -0
  882. synapse/storage/schema/main/delta/56/current_state_events_membership.sql +41 -0
  883. synapse/storage/schema/main/delta/56/current_state_events_membership_mk2.sql +43 -0
  884. synapse/storage/schema/main/delta/56/delete_keys_from_deleted_backups.sql +44 -0
  885. synapse/storage/schema/main/delta/56/destinations_failure_ts.sql +44 -0
  886. synapse/storage/schema/main/delta/56/destinations_retry_interval_type.sql.postgres +18 -0
  887. synapse/storage/schema/main/delta/56/device_stream_id_insert.sql +39 -0
  888. synapse/storage/schema/main/delta/56/devices_last_seen.sql +43 -0
  889. synapse/storage/schema/main/delta/56/drop_unused_event_tables.sql +39 -0
  890. synapse/storage/schema/main/delta/56/event_expiry.sql +40 -0
  891. synapse/storage/schema/main/delta/56/event_labels.sql +49 -0
  892. synapse/storage/schema/main/delta/56/event_labels_background_update.sql +36 -0
  893. synapse/storage/schema/main/delta/56/fix_room_keys_index.sql +37 -0
  894. synapse/storage/schema/main/delta/56/hidden_devices.sql +37 -0
  895. synapse/storage/schema/main/delta/56/hidden_devices_fix.sql.sqlite +42 -0
  896. synapse/storage/schema/main/delta/56/nuke_empty_communities_from_db.sql +48 -0
  897. synapse/storage/schema/main/delta/56/public_room_list_idx.sql +35 -0
  898. synapse/storage/schema/main/delta/56/redaction_censor.sql +35 -0
  899. synapse/storage/schema/main/delta/56/redaction_censor2.sql +41 -0
  900. synapse/storage/schema/main/delta/56/redaction_censor3_fix_update.sql.postgres +25 -0
  901. synapse/storage/schema/main/delta/56/redaction_censor4.sql +35 -0
  902. synapse/storage/schema/main/delta/56/remove_tombstoned_rooms_from_directory.sql +38 -0
  903. synapse/storage/schema/main/delta/56/room_key_etag.sql +36 -0
  904. synapse/storage/schema/main/delta/56/room_membership_idx.sql +37 -0
  905. synapse/storage/schema/main/delta/56/room_retention.sql +52 -0
  906. synapse/storage/schema/main/delta/56/signing_keys.sql +75 -0
  907. synapse/storage/schema/main/delta/56/signing_keys_nonunique_signatures.sql +41 -0
  908. synapse/storage/schema/main/delta/56/stats_separated.sql +175 -0
  909. synapse/storage/schema/main/delta/56/unique_user_filter_index.py +46 -0
  910. synapse/storage/schema/main/delta/56/user_external_ids.sql +43 -0
  911. synapse/storage/schema/main/delta/56/users_in_public_rooms_idx.sql +36 -0
  912. synapse/storage/schema/main/delta/57/delete_old_current_state_events.sql +41 -0
  913. synapse/storage/schema/main/delta/57/device_list_remote_cache_stale.sql +44 -0
  914. synapse/storage/schema/main/delta/57/local_current_membership.py +111 -0
  915. synapse/storage/schema/main/delta/57/remove_sent_outbound_pokes.sql +40 -0
  916. synapse/storage/schema/main/delta/57/rooms_version_column.sql +43 -0
  917. synapse/storage/schema/main/delta/57/rooms_version_column_2.sql.postgres +35 -0
  918. synapse/storage/schema/main/delta/57/rooms_version_column_2.sql.sqlite +22 -0
  919. synapse/storage/schema/main/delta/57/rooms_version_column_3.sql.postgres +39 -0
  920. synapse/storage/schema/main/delta/57/rooms_version_column_3.sql.sqlite +23 -0
  921. synapse/storage/schema/main/delta/58/02remove_dup_outbound_pokes.sql +41 -0
  922. synapse/storage/schema/main/delta/58/03persist_ui_auth.sql +55 -0
  923. synapse/storage/schema/main/delta/58/05cache_instance.sql.postgres +30 -0
  924. synapse/storage/schema/main/delta/58/06dlols_unique_idx.py +83 -0
  925. synapse/storage/schema/main/delta/58/07add_method_to_thumbnail_constraint.sql.postgres +33 -0
  926. synapse/storage/schema/main/delta/58/07add_method_to_thumbnail_constraint.sql.sqlite +44 -0
  927. synapse/storage/schema/main/delta/58/07persist_ui_auth_ips.sql +44 -0
  928. synapse/storage/schema/main/delta/58/08_media_safe_from_quarantine.sql.postgres +18 -0
  929. synapse/storage/schema/main/delta/58/08_media_safe_from_quarantine.sql.sqlite +18 -0
  930. synapse/storage/schema/main/delta/58/09shadow_ban.sql +37 -0
  931. synapse/storage/schema/main/delta/58/10_pushrules_enabled_delete_obsolete.sql +47 -0
  932. synapse/storage/schema/main/delta/58/10drop_local_rejections_stream.sql +41 -0
  933. synapse/storage/schema/main/delta/58/10federation_pos_instance_name.sql +41 -0
  934. synapse/storage/schema/main/delta/58/11dehydration.sql +39 -0
  935. synapse/storage/schema/main/delta/58/11fallback.sql +43 -0
  936. synapse/storage/schema/main/delta/58/11user_id_seq.py +38 -0
  937. synapse/storage/schema/main/delta/58/12room_stats.sql +51 -0
  938. synapse/storage/schema/main/delta/58/13remove_presence_allow_inbound.sql +36 -0
  939. synapse/storage/schema/main/delta/58/14events_instance_name.sql +35 -0
  940. synapse/storage/schema/main/delta/58/14events_instance_name.sql.postgres +28 -0
  941. synapse/storage/schema/main/delta/58/15_catchup_destination_rooms.sql +61 -0
  942. synapse/storage/schema/main/delta/58/15unread_count.sql +45 -0
  943. synapse/storage/schema/main/delta/58/16populate_stats_process_rooms_fix.sql +41 -0
  944. synapse/storage/schema/main/delta/58/17_catchup_last_successful.sql +40 -0
  945. synapse/storage/schema/main/delta/58/18stream_positions.sql +41 -0
  946. synapse/storage/schema/main/delta/58/19instance_map.sql.postgres +25 -0
  947. synapse/storage/schema/main/delta/58/19txn_id.sql +59 -0
  948. synapse/storage/schema/main/delta/58/20instance_name_event_tables.sql +36 -0
  949. synapse/storage/schema/main/delta/58/20user_daily_visits.sql +37 -0
  950. synapse/storage/schema/main/delta/58/21as_device_stream.sql +36 -0
  951. synapse/storage/schema/main/delta/58/21drop_device_max_stream_id.sql +1 -0
  952. synapse/storage/schema/main/delta/58/22puppet_token.sql +36 -0
  953. synapse/storage/schema/main/delta/58/22users_have_local_media.sql +2 -0
  954. synapse/storage/schema/main/delta/58/23e2e_cross_signing_keys_idx.sql +36 -0
  955. synapse/storage/schema/main/delta/58/24drop_event_json_index.sql +38 -0
  956. synapse/storage/schema/main/delta/58/25user_external_ids_user_id_idx.sql +36 -0
  957. synapse/storage/schema/main/delta/58/26access_token_last_validated.sql +37 -0
  958. synapse/storage/schema/main/delta/58/27local_invites.sql +37 -0
  959. synapse/storage/schema/main/delta/58/28drop_last_used_column.sql.postgres +16 -0
  960. synapse/storage/schema/main/delta/58/28drop_last_used_column.sql.sqlite +62 -0
  961. synapse/storage/schema/main/delta/59/01ignored_user.py +85 -0
  962. synapse/storage/schema/main/delta/59/02shard_send_to_device.sql +37 -0
  963. synapse/storage/schema/main/delta/59/03shard_send_to_device_sequence.sql.postgres +25 -0
  964. synapse/storage/schema/main/delta/59/04_event_auth_chains.sql +71 -0
  965. synapse/storage/schema/main/delta/59/04_event_auth_chains.sql.postgres +16 -0
  966. synapse/storage/schema/main/delta/59/04drop_account_data.sql +36 -0
  967. synapse/storage/schema/main/delta/59/05cache_invalidation.sql +36 -0
  968. synapse/storage/schema/main/delta/59/06chain_cover_index.sql +36 -0
  969. synapse/storage/schema/main/delta/59/06shard_account_data.sql +39 -0
  970. synapse/storage/schema/main/delta/59/06shard_account_data.sql.postgres +32 -0
  971. synapse/storage/schema/main/delta/59/07shard_account_data_fix.sql +37 -0
  972. synapse/storage/schema/main/delta/59/08delete_pushers_for_deactivated_accounts.sql +39 -0
  973. synapse/storage/schema/main/delta/59/08delete_stale_pushers.sql +39 -0
  974. synapse/storage/schema/main/delta/59/09rejected_events_metadata.sql +45 -0
  975. synapse/storage/schema/main/delta/59/10delete_purged_chain_cover.sql +36 -0
  976. synapse/storage/schema/main/delta/59/11add_knock_members_to_stats.sql +39 -0
  977. synapse/storage/schema/main/delta/59/11drop_thumbnail_constraint.sql.postgres +22 -0
  978. synapse/storage/schema/main/delta/59/12account_validity_token_used_ts_ms.sql +37 -0
  979. synapse/storage/schema/main/delta/59/12presence_stream_instance.sql +37 -0
  980. synapse/storage/schema/main/delta/59/12presence_stream_instance_seq.sql.postgres +20 -0
  981. synapse/storage/schema/main/delta/59/13users_to_send_full_presence_to.sql +53 -0
  982. synapse/storage/schema/main/delta/59/14refresh_tokens.sql +53 -0
  983. synapse/storage/schema/main/delta/59/15locks.sql +56 -0
  984. synapse/storage/schema/main/delta/59/16federation_inbound_staging.sql +51 -0
  985. synapse/storage/schema/main/delta/60/01recreate_stream_ordering.sql.postgres +45 -0
  986. synapse/storage/schema/main/delta/60/02change_stream_ordering_columns.sql.postgres +30 -0
  987. synapse/storage/schema/main/delta/61/01change_appservices_txns.sql.postgres +23 -0
  988. synapse/storage/schema/main/delta/61/01insertion_event_lookups.sql +68 -0
  989. synapse/storage/schema/main/delta/61/02drop_redundant_room_depth_index.sql +37 -0
  990. synapse/storage/schema/main/delta/61/03recreate_min_depth.py +74 -0
  991. synapse/storage/schema/main/delta/62/01insertion_event_extremities.sql +43 -0
  992. synapse/storage/schema/main/delta/63/01create_registration_tokens.sql +42 -0
  993. synapse/storage/schema/main/delta/63/02delete_unlinked_email_pushers.sql +39 -0
  994. synapse/storage/schema/main/delta/63/02populate-rooms-creator.sql +36 -0
  995. synapse/storage/schema/main/delta/63/03session_store.sql +42 -0
  996. synapse/storage/schema/main/delta/63/04add_presence_stream_not_offline_index.sql +37 -0
  997. synapse/storage/schema/main/delta/64/01msc2716_chunk_to_batch_rename.sql.postgres +23 -0
  998. synapse/storage/schema/main/delta/64/01msc2716_chunk_to_batch_rename.sql.sqlite +37 -0
  999. synapse/storage/schema/main/delta/65/01msc2716_insertion_event_edges.sql +38 -0
  1000. synapse/storage/schema/main/delta/65/03remove_hidden_devices_from_device_inbox.sql +41 -0
  1001. synapse/storage/schema/main/delta/65/04_local_group_updates.sql +37 -0
  1002. synapse/storage/schema/main/delta/65/05_remove_room_stats_historical_and_user_stats_historical.sql +38 -0
  1003. synapse/storage/schema/main/delta/65/06remove_deleted_devices_from_device_inbox.sql +53 -0
  1004. synapse/storage/schema/main/delta/65/07_arbitrary_relations.sql +37 -0
  1005. synapse/storage/schema/main/delta/65/08_device_inbox_background_updates.sql +37 -0
  1006. synapse/storage/schema/main/delta/65/10_expirable_refresh_tokens.sql +47 -0
  1007. synapse/storage/schema/main/delta/65/11_devices_auth_provider_session.sql +46 -0
  1008. synapse/storage/schema/main/delta/67/01drop_public_room_list_stream.sql +37 -0
  1009. synapse/storage/schema/main/delta/68/01event_columns.sql +45 -0
  1010. synapse/storage/schema/main/delta/68/02_msc2409_add_device_id_appservice_stream_type.sql +40 -0
  1011. synapse/storage/schema/main/delta/68/03_delete_account_data_for_deactivated_accounts.sql +39 -0
  1012. synapse/storage/schema/main/delta/68/04_refresh_tokens_index_next_token_id.sql +47 -0
  1013. synapse/storage/schema/main/delta/68/04partial_state_rooms.sql +60 -0
  1014. synapse/storage/schema/main/delta/68/05_delete_non_strings_from_event_search.sql.sqlite +22 -0
  1015. synapse/storage/schema/main/delta/68/05partial_state_rooms_triggers.py +80 -0
  1016. synapse/storage/schema/main/delta/68/06_msc3202_add_device_list_appservice_stream_type.sql +42 -0
  1017. synapse/storage/schema/main/delta/69/01as_txn_seq.py +54 -0
  1018. synapse/storage/schema/main/delta/69/01device_list_oubound_by_room.sql +57 -0
  1019. synapse/storage/schema/main/delta/69/02cache_invalidation_index.sql +37 -0
  1020. synapse/storage/schema/main/delta/70/01clean_table_purged_rooms.sql +39 -0
  1021. synapse/storage/schema/main/delta/71/01rebuild_event_edges.sql.postgres +43 -0
  1022. synapse/storage/schema/main/delta/71/01rebuild_event_edges.sql.sqlite +47 -0
  1023. synapse/storage/schema/main/delta/71/01remove_noop_background_updates.sql +80 -0
  1024. synapse/storage/schema/main/delta/71/02event_push_summary_unique.sql +37 -0
  1025. synapse/storage/schema/main/delta/72/01add_room_type_to_state_stats.sql +38 -0
  1026. synapse/storage/schema/main/delta/72/01event_push_summary_receipt.sql +54 -0
  1027. synapse/storage/schema/main/delta/72/02event_push_actions_index.sql +38 -0
  1028. synapse/storage/schema/main/delta/72/03bg_populate_events_columns.py +57 -0
  1029. synapse/storage/schema/main/delta/72/03drop_event_reference_hashes.sql +36 -0
  1030. synapse/storage/schema/main/delta/72/03remove_groups.sql +50 -0
  1031. synapse/storage/schema/main/delta/72/04drop_column_application_services_state_last_txn.sql.postgres +17 -0
  1032. synapse/storage/schema/main/delta/72/04drop_column_application_services_state_last_txn.sql.sqlite +40 -0
  1033. synapse/storage/schema/main/delta/72/05receipts_event_stream_ordering.sql +38 -0
  1034. synapse/storage/schema/main/delta/72/05remove_unstable_private_read_receipts.sql +38 -0
  1035. synapse/storage/schema/main/delta/72/06add_consent_ts_to_users.sql +35 -0
  1036. synapse/storage/schema/main/delta/72/06thread_notifications.sql +49 -0
  1037. synapse/storage/schema/main/delta/72/07force_update_current_state_events_membership.py +67 -0
  1038. synapse/storage/schema/main/delta/72/07thread_receipts.sql.postgres +30 -0
  1039. synapse/storage/schema/main/delta/72/07thread_receipts.sql.sqlite +70 -0
  1040. synapse/storage/schema/main/delta/72/08begin_cache_invalidation_seq_at_2.sql.postgres +23 -0
  1041. synapse/storage/schema/main/delta/72/08thread_receipts.sql +39 -0
  1042. synapse/storage/schema/main/delta/72/09partial_indices.sql.sqlite +56 -0
  1043. synapse/storage/schema/main/delta/73/01event_failed_pull_attempts.sql +48 -0
  1044. synapse/storage/schema/main/delta/73/02add_pusher_enabled.sql +35 -0
  1045. synapse/storage/schema/main/delta/73/02room_id_indexes_for_purging.sql +41 -0
  1046. synapse/storage/schema/main/delta/73/03pusher_device_id.sql +39 -0
  1047. synapse/storage/schema/main/delta/73/03users_approved_column.sql +39 -0
  1048. synapse/storage/schema/main/delta/73/04partial_join_details.sql +42 -0
  1049. synapse/storage/schema/main/delta/73/04pending_device_list_updates.sql +47 -0
  1050. synapse/storage/schema/main/delta/73/05old_push_actions.sql.postgres +22 -0
  1051. synapse/storage/schema/main/delta/73/05old_push_actions.sql.sqlite +24 -0
  1052. synapse/storage/schema/main/delta/73/06thread_notifications_thread_id_idx.sql +42 -0
  1053. synapse/storage/schema/main/delta/73/08thread_receipts_non_null.sql.postgres +23 -0
  1054. synapse/storage/schema/main/delta/73/08thread_receipts_non_null.sql.sqlite +76 -0
  1055. synapse/storage/schema/main/delta/73/09partial_joined_via_destination.sql +37 -0
  1056. synapse/storage/schema/main/delta/73/09threads_table.sql +49 -0
  1057. synapse/storage/schema/main/delta/73/10_update_sqlite_fts4_tokenizer.py +71 -0
  1058. synapse/storage/schema/main/delta/73/10login_tokens.sql +54 -0
  1059. synapse/storage/schema/main/delta/73/11event_search_room_id_n_distinct.sql.postgres +33 -0
  1060. synapse/storage/schema/main/delta/73/12refactor_device_list_outbound_pokes.sql +72 -0
  1061. synapse/storage/schema/main/delta/73/13add_device_lists_index.sql +39 -0
  1062. synapse/storage/schema/main/delta/73/20_un_partial_stated_room_stream.sql +51 -0
  1063. synapse/storage/schema/main/delta/73/21_un_partial_stated_room_stream_seq.sql.postgres +20 -0
  1064. synapse/storage/schema/main/delta/73/22_rebuild_user_dir_stats.sql +48 -0
  1065. synapse/storage/schema/main/delta/73/22_un_partial_stated_event_stream.sql +53 -0
  1066. synapse/storage/schema/main/delta/73/23_fix_thread_index.sql +52 -0
  1067. synapse/storage/schema/main/delta/73/23_un_partial_stated_room_stream_seq.sql.postgres +20 -0
  1068. synapse/storage/schema/main/delta/73/24_events_jump_to_date_index.sql +36 -0
  1069. synapse/storage/schema/main/delta/73/25drop_presence.sql +36 -0
  1070. synapse/storage/schema/main/delta/74/01_user_directory_stale_remote_users.sql +58 -0
  1071. synapse/storage/schema/main/delta/74/02_set_device_id_for_pushers_bg_update.sql +38 -0
  1072. synapse/storage/schema/main/delta/74/03_membership_tables_event_stream_ordering.sql.postgres +29 -0
  1073. synapse/storage/schema/main/delta/74/03_membership_tables_event_stream_ordering.sql.sqlite +23 -0
  1074. synapse/storage/schema/main/delta/74/03_room_membership_index.sql +38 -0
  1075. synapse/storage/schema/main/delta/74/04_delete_e2e_backup_keys_for_deactivated_users.sql +36 -0
  1076. synapse/storage/schema/main/delta/74/04_membership_tables_event_stream_ordering_triggers.py +87 -0
  1077. synapse/storage/schema/main/delta/74/05_events_txn_id_device_id.sql +72 -0
  1078. synapse/storage/schema/main/delta/74/90COMMENTS_destinations.sql.postgres +52 -0
  1079. synapse/storage/schema/main/delta/76/01_add_profiles_full_user_id_column.sql +39 -0
  1080. synapse/storage/schema/main/delta/76/02_add_user_filters_full_user_id_column.sql +39 -0
  1081. synapse/storage/schema/main/delta/76/03_per_user_experimental_features.sql +46 -0
  1082. synapse/storage/schema/main/delta/76/04_add_room_forgetter.sql +43 -0
  1083. synapse/storage/schema/main/delta/77/01_add_profiles_not_valid_check.sql.postgres +16 -0
  1084. synapse/storage/schema/main/delta/77/02_add_user_filters_not_valid_check.sql.postgres +16 -0
  1085. synapse/storage/schema/main/delta/77/03bg_populate_full_user_id_profiles.sql +35 -0
  1086. synapse/storage/schema/main/delta/77/04bg_populate_full_user_id_user_filters.sql +35 -0
  1087. synapse/storage/schema/main/delta/77/05thread_notifications_backfill.sql +67 -0
  1088. synapse/storage/schema/main/delta/77/06thread_notifications_not_null.sql.sqlite +102 -0
  1089. synapse/storage/schema/main/delta/77/06thread_notifications_not_null_event_push_actions.sql.postgres +27 -0
  1090. synapse/storage/schema/main/delta/77/06thread_notifications_not_null_event_push_actions_staging.sql.postgres +27 -0
  1091. synapse/storage/schema/main/delta/77/06thread_notifications_not_null_event_push_summary.sql.postgres +29 -0
  1092. synapse/storage/schema/main/delta/77/14bg_indices_event_stream_ordering.sql +39 -0
  1093. synapse/storage/schema/main/delta/78/01_validate_and_update_profiles.py +99 -0
  1094. synapse/storage/schema/main/delta/78/02_validate_and_update_user_filters.py +100 -0
  1095. synapse/storage/schema/main/delta/78/03_remove_unused_indexes_user_filters.py +72 -0
  1096. synapse/storage/schema/main/delta/78/03event_extremities_constraints.py +65 -0
  1097. synapse/storage/schema/main/delta/78/04_add_full_user_id_index_user_filters.py +32 -0
  1098. synapse/storage/schema/main/delta/79/03_read_write_locks_triggers.sql.postgres +102 -0
  1099. synapse/storage/schema/main/delta/79/03_read_write_locks_triggers.sql.sqlite +72 -0
  1100. synapse/storage/schema/main/delta/79/04_mitigate_stream_ordering_update_race.py +70 -0
  1101. synapse/storage/schema/main/delta/79/05_read_write_locks_triggers.sql.postgres +69 -0
  1102. synapse/storage/schema/main/delta/79/05_read_write_locks_triggers.sql.sqlite +65 -0
  1103. synapse/storage/schema/main/delta/80/01_users_alter_locked.sql +35 -0
  1104. synapse/storage/schema/main/delta/80/02_read_write_locks_unlogged.sql.postgres +30 -0
  1105. synapse/storage/schema/main/delta/80/02_scheduled_tasks.sql +47 -0
  1106. synapse/storage/schema/main/delta/80/03_read_write_locks_triggers.sql.postgres +37 -0
  1107. synapse/storage/schema/main/delta/80/04_read_write_locks_deadlock.sql.postgres +71 -0
  1108. synapse/storage/schema/main/delta/82/02_scheduled_tasks_index.sql +35 -0
  1109. synapse/storage/schema/main/delta/82/04_add_indices_for_purging_rooms.sql +39 -0
  1110. synapse/storage/schema/main/delta/82/05gaps.sql +44 -0
  1111. synapse/storage/schema/main/delta/83/01_drop_old_tables.sql +43 -0
  1112. synapse/storage/schema/main/delta/83/03_instance_name_receipts.sql.sqlite +17 -0
  1113. synapse/storage/schema/main/delta/83/05_cross_signing_key_update_grant.sql +34 -0
  1114. synapse/storage/schema/main/delta/83/06_event_push_summary_room.sql +36 -0
  1115. synapse/storage/schema/main/delta/84/01_auth_links_stats.sql.postgres +20 -0
  1116. synapse/storage/schema/main/delta/84/02_auth_links_index.sql +16 -0
  1117. synapse/storage/schema/main/delta/84/03_auth_links_analyze.sql.postgres +16 -0
  1118. synapse/storage/schema/main/delta/84/04_access_token_index.sql +15 -0
  1119. synapse/storage/schema/main/delta/85/01_add_suspended.sql +14 -0
  1120. synapse/storage/schema/main/delta/85/02_add_instance_names.sql +27 -0
  1121. synapse/storage/schema/main/delta/85/03_new_sequences.sql.postgres +54 -0
  1122. synapse/storage/schema/main/delta/85/04_cleanup_device_federation_outbox.sql +15 -0
  1123. synapse/storage/schema/main/delta/85/05_add_instance_names_converted_pos.sql +16 -0
  1124. synapse/storage/schema/main/delta/85/06_add_room_reports.sql +20 -0
  1125. synapse/storage/schema/main/delta/86/01_authenticate_media.sql +15 -0
  1126. synapse/storage/schema/main/delta/86/02_receipts_event_id_index.sql +15 -0
  1127. synapse/storage/schema/main/delta/87/01_sliding_sync_memberships.sql +169 -0
  1128. synapse/storage/schema/main/delta/87/02_per_connection_state.sql +81 -0
  1129. synapse/storage/schema/main/delta/87/03_current_state_index.sql +19 -0
  1130. synapse/storage/schema/main/delta/88/01_add_delayed_events.sql +43 -0
  1131. synapse/storage/schema/main/delta/88/01_custom_profile_fields.sql +15 -0
  1132. synapse/storage/schema/main/delta/88/02_fix_sliding_sync_membership_snapshots_forgotten_column.sql +21 -0
  1133. synapse/storage/schema/main/delta/88/03_add_otk_ts_added_index.sql +18 -0
  1134. synapse/storage/schema/main/delta/88/04_current_state_delta_index.sql +18 -0
  1135. synapse/storage/schema/main/delta/88/05_drop_old_otks.sql.postgres +19 -0
  1136. synapse/storage/schema/main/delta/88/05_drop_old_otks.sql.sqlite +19 -0
  1137. synapse/storage/schema/main/delta/88/05_sliding_sync_room_config_index.sql +20 -0
  1138. synapse/storage/schema/main/delta/88/06_events_received_ts_index.sql +17 -0
  1139. synapse/storage/schema/main/delta/89/01_sliding_sync_membership_snapshot_index.sql +15 -0
  1140. synapse/storage/schema/main/delta/90/01_add_column_participant_room_memberships_table.sql +16 -0
  1141. synapse/storage/schema/main/delta/91/01_media_hash.sql +28 -0
  1142. synapse/storage/schema/main/delta/92/01_remove_trigger.sql.postgres +16 -0
  1143. synapse/storage/schema/main/delta/92/01_remove_trigger.sql.sqlite +16 -0
  1144. synapse/storage/schema/main/delta/92/02_remove_populate_participant_bg_update.sql +17 -0
  1145. synapse/storage/schema/main/delta/92/04_ss_membership_snapshot_idx.sql +16 -0
  1146. synapse/storage/schema/main/delta/92/04_thread_subscriptions.sql +59 -0
  1147. synapse/storage/schema/main/delta/92/04_thread_subscriptions_seq.sql.postgres +19 -0
  1148. synapse/storage/schema/main/delta/92/05_fixup_max_depth_cap.sql +17 -0
  1149. synapse/storage/schema/main/delta/92/05_thread_subscriptions_comments.sql.postgres +18 -0
  1150. synapse/storage/schema/main/delta/92/06_device_federation_inbox_index.sql +16 -0
  1151. synapse/storage/schema/main/delta/92/06_threads_last_sent_stream_ordering_comments.sql.postgres +24 -0
  1152. synapse/storage/schema/main/delta/92/07_add_user_reports.sql +22 -0
  1153. synapse/storage/schema/main/delta/92/07_event_txn_id_device_id_txn_id2.sql +15 -0
  1154. synapse/storage/schema/main/delta/92/08_room_ban_redactions.sql +21 -0
  1155. synapse/storage/schema/main/delta/92/08_thread_subscriptions_seq_fixup.sql.postgres +19 -0
  1156. synapse/storage/schema/main/delta/92/09_thread_subscriptions_update.sql +20 -0
  1157. synapse/storage/schema/main/delta/92/09_thread_subscriptions_update.sql.postgres +18 -0
  1158. synapse/storage/schema/main/delta/93/01_add_delayed_events.sql +15 -0
  1159. synapse/storage/schema/main/delta/93/02_sliding_sync_members.sql +60 -0
  1160. synapse/storage/schema/main/delta/93/03_sss_pos_last_used.sql +27 -0
  1161. synapse/storage/schema/main/full_schemas/72/full.sql.postgres +1344 -0
  1162. synapse/storage/schema/main/full_schemas/72/full.sql.sqlite +646 -0
  1163. synapse/storage/schema/state/delta/23/drop_state_index.sql +35 -0
  1164. synapse/storage/schema/state/delta/32/remove_state_indices.sql +38 -0
  1165. synapse/storage/schema/state/delta/35/add_state_index.sql +36 -0
  1166. synapse/storage/schema/state/delta/35/state.sql +41 -0
  1167. synapse/storage/schema/state/delta/35/state_dedupe.sql +36 -0
  1168. synapse/storage/schema/state/delta/47/state_group_seq.py +38 -0
  1169. synapse/storage/schema/state/delta/56/state_group_room_idx.sql +36 -0
  1170. synapse/storage/schema/state/delta/61/02state_groups_state_n_distinct.sql.postgres +34 -0
  1171. synapse/storage/schema/state/delta/70/08_state_group_edges_unique.sql +36 -0
  1172. synapse/storage/schema/state/delta/89/01_state_groups_deletion.sql +39 -0
  1173. synapse/storage/schema/state/delta/90/02_delete_unreferenced_state_groups.sql +16 -0
  1174. synapse/storage/schema/state/delta/90/03_remove_old_deletion_bg_update.sql +15 -0
  1175. synapse/storage/schema/state/full_schemas/72/full.sql.postgres +30 -0
  1176. synapse/storage/schema/state/full_schemas/72/full.sql.sqlite +20 -0
  1177. synapse/storage/types.py +183 -0
  1178. synapse/storage/util/__init__.py +20 -0
  1179. synapse/storage/util/id_generators.py +928 -0
  1180. synapse/storage/util/partial_state_events_tracker.py +194 -0
  1181. synapse/storage/util/sequence.py +315 -0
  1182. synapse/streams/__init__.py +43 -0
  1183. synapse/streams/config.py +91 -0
  1184. synapse/streams/events.py +203 -0
  1185. synapse/synapse_rust/__init__.pyi +3 -0
  1186. synapse/synapse_rust/acl.pyi +20 -0
  1187. synapse/synapse_rust/events.pyi +136 -0
  1188. synapse/synapse_rust/http_client.pyi +32 -0
  1189. synapse/synapse_rust/push.pyi +86 -0
  1190. synapse/synapse_rust/rendezvous.pyi +30 -0
  1191. synapse/synapse_rust/segmenter.pyi +1 -0
  1192. synapse/synapse_rust.abi3.so +0 -0
  1193. synapse/types/__init__.py +1600 -0
  1194. synapse/types/handlers/__init__.py +93 -0
  1195. synapse/types/handlers/policy_server.py +16 -0
  1196. synapse/types/handlers/sliding_sync.py +1004 -0
  1197. synapse/types/rest/__init__.py +25 -0
  1198. synapse/types/rest/client/__init__.py +413 -0
  1199. synapse/types/state.py +634 -0
  1200. synapse/types/storage/__init__.py +66 -0
  1201. synapse/util/__init__.py +160 -0
  1202. synapse/util/async_helpers.py +1048 -0
  1203. synapse/util/background_queue.py +142 -0
  1204. synapse/util/batching_queue.py +203 -0
  1205. synapse/util/caches/__init__.py +300 -0
  1206. synapse/util/caches/cached_call.py +143 -0
  1207. synapse/util/caches/deferred_cache.py +530 -0
  1208. synapse/util/caches/descriptors.py +692 -0
  1209. synapse/util/caches/dictionary_cache.py +346 -0
  1210. synapse/util/caches/expiringcache.py +250 -0
  1211. synapse/util/caches/lrucache.py +976 -0
  1212. synapse/util/caches/response_cache.py +323 -0
  1213. synapse/util/caches/stream_change_cache.py +370 -0
  1214. synapse/util/caches/treecache.py +189 -0
  1215. synapse/util/caches/ttlcache.py +197 -0
  1216. synapse/util/cancellation.py +63 -0
  1217. synapse/util/check_dependencies.py +335 -0
  1218. synapse/util/clock.py +592 -0
  1219. synapse/util/daemonize.py +165 -0
  1220. synapse/util/distributor.py +157 -0
  1221. synapse/util/duration.py +117 -0
  1222. synapse/util/events.py +134 -0
  1223. synapse/util/file_consumer.py +164 -0
  1224. synapse/util/frozenutils.py +57 -0
  1225. synapse/util/gai_resolver.py +178 -0
  1226. synapse/util/hash.py +38 -0
  1227. synapse/util/httpresourcetree.py +108 -0
  1228. synapse/util/iterutils.py +190 -0
  1229. synapse/util/json.py +56 -0
  1230. synapse/util/linked_list.py +156 -0
  1231. synapse/util/logcontext.py +46 -0
  1232. synapse/util/logformatter.py +28 -0
  1233. synapse/util/macaroons.py +325 -0
  1234. synapse/util/manhole.py +191 -0
  1235. synapse/util/metrics.py +339 -0
  1236. synapse/util/module_loader.py +116 -0
  1237. synapse/util/msisdn.py +51 -0
  1238. synapse/util/patch_inline_callbacks.py +250 -0
  1239. synapse/util/pydantic_models.py +63 -0
  1240. synapse/util/ratelimitutils.py +422 -0
  1241. synapse/util/retryutils.py +339 -0
  1242. synapse/util/rlimit.py +42 -0
  1243. synapse/util/rust.py +164 -0
  1244. synapse/util/sentinel.py +21 -0
  1245. synapse/util/stringutils.py +293 -0
  1246. synapse/util/task_scheduler.py +494 -0
  1247. synapse/util/templates.py +126 -0
  1248. synapse/util/threepids.py +123 -0
  1249. synapse/util/wheel_timer.py +112 -0
  1250. synapse/visibility.py +869 -0
  1251. synmark/__init__.py +47 -0
  1252. synmark/__main__.py +128 -0
  1253. synmark/suites/__init__.py +9 -0
  1254. synmark/suites/logging.py +154 -0
  1255. synmark/suites/lrucache.py +48 -0
  1256. synmark/suites/lrucache_evict.py +49 -0
  1257. sytest-blacklist +33 -0
  1258. tests/__init__.py +29 -0
  1259. tests/api/__init__.py +0 -0
  1260. tests/api/test_auth.py +548 -0
  1261. tests/api/test_errors.py +46 -0
  1262. tests/api/test_filtering.py +622 -0
  1263. tests/api/test_ratelimiting.py +505 -0
  1264. tests/api/test_urls.py +81 -0
  1265. tests/app/__init__.py +0 -0
  1266. tests/app/test_homeserver_shutdown.py +271 -0
  1267. tests/app/test_homeserver_start.py +49 -0
  1268. tests/app/test_openid_listener.py +139 -0
  1269. tests/app/test_phone_stats_home.py +248 -0
  1270. tests/appservice/__init__.py +20 -0
  1271. tests/appservice/test_api.py +253 -0
  1272. tests/appservice/test_appservice.py +259 -0
  1273. tests/appservice/test_scheduler.py +477 -0
  1274. tests/config/__init__.py +20 -0
  1275. tests/config/test___main__.py +38 -0
  1276. tests/config/test_api.py +146 -0
  1277. tests/config/test_appservice.py +48 -0
  1278. tests/config/test_background_update.py +65 -0
  1279. tests/config/test_base.py +151 -0
  1280. tests/config/test_cache.py +193 -0
  1281. tests/config/test_database.py +42 -0
  1282. tests/config/test_generate.py +72 -0
  1283. tests/config/test_load.py +322 -0
  1284. tests/config/test_oauth_delegation.py +454 -0
  1285. tests/config/test_ratelimiting.py +77 -0
  1286. tests/config/test_registration_config.py +203 -0
  1287. tests/config/test_room_directory.py +203 -0
  1288. tests/config/test_server.py +248 -0
  1289. tests/config/test_tls.py +209 -0
  1290. tests/config/test_util.py +59 -0
  1291. tests/config/test_workers.py +332 -0
  1292. tests/config/utils.py +66 -0
  1293. tests/crypto/__init__.py +20 -0
  1294. tests/crypto/test_event_signing.py +109 -0
  1295. tests/crypto/test_keyring.py +737 -0
  1296. tests/events/__init__.py +0 -0
  1297. tests/events/test_auto_accept_invites.py +827 -0
  1298. tests/events/test_presence_router.py +540 -0
  1299. tests/events/test_snapshot.py +121 -0
  1300. tests/events/test_utils.py +986 -0
  1301. tests/federation/__init__.py +0 -0
  1302. tests/federation/test_complexity.py +257 -0
  1303. tests/federation/test_federation_catch_up.py +585 -0
  1304. tests/federation/test_federation_client.py +316 -0
  1305. tests/federation/test_federation_devices.py +161 -0
  1306. tests/federation/test_federation_media.py +295 -0
  1307. tests/federation/test_federation_out_of_band_membership.py +671 -0
  1308. tests/federation/test_federation_sender.py +956 -0
  1309. tests/federation/test_federation_server.py +631 -0
  1310. tests/federation/transport/__init__.py +0 -0
  1311. tests/federation/transport/server/__init__.py +20 -0
  1312. tests/federation/transport/server/test__base.py +156 -0
  1313. tests/federation/transport/test_client.py +157 -0
  1314. tests/federation/transport/test_knocking.py +323 -0
  1315. tests/federation/transport/test_server.py +74 -0
  1316. tests/handlers/__init__.py +0 -0
  1317. tests/handlers/oidc_test_key.p8 +5 -0
  1318. tests/handlers/oidc_test_key.pub.pem +4 -0
  1319. tests/handlers/test_admin.py +361 -0
  1320. tests/handlers/test_appservice.py +1336 -0
  1321. tests/handlers/test_auth.py +248 -0
  1322. tests/handlers/test_cas.py +239 -0
  1323. tests/handlers/test_deactivate_account.py +485 -0
  1324. tests/handlers/test_device.py +665 -0
  1325. tests/handlers/test_directory.py +613 -0
  1326. tests/handlers/test_e2e_keys.py +2025 -0
  1327. tests/handlers/test_e2e_room_keys.py +569 -0
  1328. tests/handlers/test_federation.py +794 -0
  1329. tests/handlers/test_federation_event.py +1181 -0
  1330. tests/handlers/test_message.py +322 -0
  1331. tests/handlers/test_oauth_delegation.py +1314 -0
  1332. tests/handlers/test_oidc.py +1688 -0
  1333. tests/handlers/test_password_providers.py +987 -0
  1334. tests/handlers/test_presence.py +2144 -0
  1335. tests/handlers/test_profile.py +401 -0
  1336. tests/handlers/test_receipts.py +342 -0
  1337. tests/handlers/test_register.py +880 -0
  1338. tests/handlers/test_room.py +108 -0
  1339. tests/handlers/test_room_list.py +93 -0
  1340. tests/handlers/test_room_member.py +764 -0
  1341. tests/handlers/test_room_policy.py +468 -0
  1342. tests/handlers/test_room_summary.py +1248 -0
  1343. tests/handlers/test_saml.py +427 -0
  1344. tests/handlers/test_send_email.py +230 -0
  1345. tests/handlers/test_sliding_sync.py +5065 -0
  1346. tests/handlers/test_sso.py +152 -0
  1347. tests/handlers/test_stats.py +594 -0
  1348. tests/handlers/test_sync.py +1275 -0
  1349. tests/handlers/test_typing.py +557 -0
  1350. tests/handlers/test_user_directory.py +1435 -0
  1351. tests/handlers/test_worker_lock.py +126 -0
  1352. tests/http/__init__.py +196 -0
  1353. tests/http/ca.crt +19 -0
  1354. tests/http/ca.key +27 -0
  1355. tests/http/federation/__init__.py +19 -0
  1356. tests/http/federation/test_matrix_federation_agent.py +1855 -0
  1357. tests/http/federation/test_srv_resolver.py +220 -0
  1358. tests/http/server/__init__.py +20 -0
  1359. tests/http/server/_base.py +621 -0
  1360. tests/http/server.key +27 -0
  1361. tests/http/test_additional_resource.py +76 -0
  1362. tests/http/test_client.py +422 -0
  1363. tests/http/test_endpoint.py +62 -0
  1364. tests/http/test_matrixfederationclient.py +1092 -0
  1365. tests/http/test_proxy.py +75 -0
  1366. tests/http/test_proxyagent.py +1008 -0
  1367. tests/http/test_servlet.py +145 -0
  1368. tests/http/test_simple_client.py +188 -0
  1369. tests/http/test_site.py +247 -0
  1370. tests/logging/__init__.py +42 -0
  1371. tests/logging/test_loggers.py +127 -0
  1372. tests/logging/test_opentracing.py +524 -0
  1373. tests/logging/test_remote_handler.py +184 -0
  1374. tests/logging/test_terse_json.py +253 -0
  1375. tests/media/__init__.py +20 -0
  1376. tests/media/test_base.py +88 -0
  1377. tests/media/test_filepath.py +602 -0
  1378. tests/media/test_html_preview.py +565 -0
  1379. tests/media/test_media_retention.py +299 -0
  1380. tests/media/test_media_storage.py +1401 -0
  1381. tests/media/test_oembed.py +172 -0
  1382. tests/media/test_url_previewer.py +120 -0
  1383. tests/metrics/__init__.py +0 -0
  1384. tests/metrics/test_background_process_metrics.py +21 -0
  1385. tests/metrics/test_metrics.py +407 -0
  1386. tests/metrics/test_phone_home_stats.py +263 -0
  1387. tests/module_api/__init__.py +0 -0
  1388. tests/module_api/test_account_data_manager.py +171 -0
  1389. tests/module_api/test_api.py +1035 -0
  1390. tests/module_api/test_event_unsigned_addition.py +66 -0
  1391. tests/module_api/test_spamchecker.py +286 -0
  1392. tests/push/__init__.py +0 -0
  1393. tests/push/test_bulk_push_rule_evaluator.py +652 -0
  1394. tests/push/test_email.py +570 -0
  1395. tests/push/test_http.py +1247 -0
  1396. tests/push/test_presentable_names.py +238 -0
  1397. tests/push/test_push_rule_evaluator.py +1069 -0
  1398. tests/replication/__init__.py +20 -0
  1399. tests/replication/_base.py +619 -0
  1400. tests/replication/http/__init__.py +20 -0
  1401. tests/replication/http/test__base.py +113 -0
  1402. tests/replication/storage/__init__.py +20 -0
  1403. tests/replication/storage/_base.py +85 -0
  1404. tests/replication/storage/test_events.py +299 -0
  1405. tests/replication/tcp/__init__.py +19 -0
  1406. tests/replication/tcp/streams/__init__.py +19 -0
  1407. tests/replication/tcp/streams/test_account_data.py +133 -0
  1408. tests/replication/tcp/streams/test_events.py +565 -0
  1409. tests/replication/tcp/streams/test_federation.py +117 -0
  1410. tests/replication/tcp/streams/test_partial_state.py +72 -0
  1411. tests/replication/tcp/streams/test_receipts.py +110 -0
  1412. tests/replication/tcp/streams/test_thread_subscriptions.py +157 -0
  1413. tests/replication/tcp/streams/test_to_device.py +112 -0
  1414. tests/replication/tcp/streams/test_typing.py +223 -0
  1415. tests/replication/tcp/test_commands.py +50 -0
  1416. tests/replication/tcp/test_handler.py +211 -0
  1417. tests/replication/test_auth.py +120 -0
  1418. tests/replication/test_client_reader_shard.py +101 -0
  1419. tests/replication/test_federation_ack.py +88 -0
  1420. tests/replication/test_federation_sender_shard.py +352 -0
  1421. tests/replication/test_module_cache_invalidation.py +89 -0
  1422. tests/replication/test_multi_media_repo.py +496 -0
  1423. tests/replication/test_pusher_shard.py +192 -0
  1424. tests/replication/test_sharded_event_persister.py +332 -0
  1425. tests/replication/test_sharded_receipts.py +250 -0
  1426. tests/rest/__init__.py +20 -0
  1427. tests/rest/admin/__init__.py +19 -0
  1428. tests/rest/admin/test_admin.py +614 -0
  1429. tests/rest/admin/test_background_updates.py +375 -0
  1430. tests/rest/admin/test_device.py +600 -0
  1431. tests/rest/admin/test_event.py +74 -0
  1432. tests/rest/admin/test_event_reports.py +781 -0
  1433. tests/rest/admin/test_federation.py +863 -0
  1434. tests/rest/admin/test_jwks.py +106 -0
  1435. tests/rest/admin/test_media.py +1091 -0
  1436. tests/rest/admin/test_registration_tokens.py +729 -0
  1437. tests/rest/admin/test_room.py +3626 -0
  1438. tests/rest/admin/test_scheduled_tasks.py +192 -0
  1439. tests/rest/admin/test_server_notice.py +753 -0
  1440. tests/rest/admin/test_statistics.py +523 -0
  1441. tests/rest/admin/test_user.py +6061 -0
  1442. tests/rest/admin/test_username_available.py +82 -0
  1443. tests/rest/client/__init__.py +20 -0
  1444. tests/rest/client/sliding_sync/__init__.py +13 -0
  1445. tests/rest/client/sliding_sync/test_connection_tracking.py +505 -0
  1446. tests/rest/client/sliding_sync/test_extension_account_data.py +1056 -0
  1447. tests/rest/client/sliding_sync/test_extension_e2ee.py +459 -0
  1448. tests/rest/client/sliding_sync/test_extension_receipts.py +934 -0
  1449. tests/rest/client/sliding_sync/test_extension_thread_subscriptions.py +497 -0
  1450. tests/rest/client/sliding_sync/test_extension_to_device.py +294 -0
  1451. tests/rest/client/sliding_sync/test_extension_typing.py +500 -0
  1452. tests/rest/client/sliding_sync/test_extensions.py +306 -0
  1453. tests/rest/client/sliding_sync/test_lists_filters.py +1975 -0
  1454. tests/rest/client/sliding_sync/test_room_subscriptions.py +303 -0
  1455. tests/rest/client/sliding_sync/test_rooms_invites.py +528 -0
  1456. tests/rest/client/sliding_sync/test_rooms_meta.py +1338 -0
  1457. tests/rest/client/sliding_sync/test_rooms_required_state.py +2247 -0
  1458. tests/rest/client/sliding_sync/test_rooms_timeline.py +718 -0
  1459. tests/rest/client/sliding_sync/test_sliding_sync.py +1688 -0
  1460. tests/rest/client/test_account.py +1543 -0
  1461. tests/rest/client/test_account_data.py +81 -0
  1462. tests/rest/client/test_auth.py +1508 -0
  1463. tests/rest/client/test_auth_metadata.py +145 -0
  1464. tests/rest/client/test_capabilities.py +318 -0
  1465. tests/rest/client/test_consent.py +138 -0
  1466. tests/rest/client/test_delayed_events.py +553 -0
  1467. tests/rest/client/test_devices.py +634 -0
  1468. tests/rest/client/test_directory.py +249 -0
  1469. tests/rest/client/test_ephemeral_message.py +113 -0
  1470. tests/rest/client/test_events.py +165 -0
  1471. tests/rest/client/test_filter.py +124 -0
  1472. tests/rest/client/test_identity.py +67 -0
  1473. tests/rest/client/test_keys.py +516 -0
  1474. tests/rest/client/test_login.py +1881 -0
  1475. tests/rest/client/test_login_token_request.py +175 -0
  1476. tests/rest/client/test_matrixrtc.py +105 -0
  1477. tests/rest/client/test_media.py +3156 -0
  1478. tests/rest/client/test_models.py +83 -0
  1479. tests/rest/client/test_mutual_rooms.py +235 -0
  1480. tests/rest/client/test_notifications.py +231 -0
  1481. tests/rest/client/test_owned_state.py +308 -0
  1482. tests/rest/client/test_password_policy.py +186 -0
  1483. tests/rest/client/test_power_levels.py +295 -0
  1484. tests/rest/client/test_presence.py +149 -0
  1485. tests/rest/client/test_profile.py +925 -0
  1486. tests/rest/client/test_push_rule_attrs.py +510 -0
  1487. tests/rest/client/test_read_marker.py +151 -0
  1488. tests/rest/client/test_receipts.py +287 -0
  1489. tests/rest/client/test_redactions.py +657 -0
  1490. tests/rest/client/test_register.py +1314 -0
  1491. tests/rest/client/test_relations.py +1954 -0
  1492. tests/rest/client/test_rendezvous.py +468 -0
  1493. tests/rest/client/test_reporting.py +324 -0
  1494. tests/rest/client/test_retention.py +389 -0
  1495. tests/rest/client/test_rooms.py +5486 -0
  1496. tests/rest/client/test_sendtodevice.py +271 -0
  1497. tests/rest/client/test_shadow_banned.py +335 -0
  1498. tests/rest/client/test_sync.py +1147 -0
  1499. tests/rest/client/test_tags.py +161 -0
  1500. tests/rest/client/test_third_party_rules.py +1076 -0
  1501. tests/rest/client/test_thread_subscriptions.py +351 -0
  1502. tests/rest/client/test_transactions.py +204 -0
  1503. tests/rest/client/test_typing.py +114 -0
  1504. tests/rest/client/test_upgrade_room.py +433 -0
  1505. tests/rest/client/utils.py +985 -0
  1506. tests/rest/key/__init__.py +0 -0
  1507. tests/rest/key/v2/__init__.py +0 -0
  1508. tests/rest/key/v2/test_remote_key_resource.py +282 -0
  1509. tests/rest/media/__init__.py +19 -0
  1510. tests/rest/media/test_domain_blocking.py +148 -0
  1511. tests/rest/media/test_url_preview.py +1445 -0
  1512. tests/rest/synapse/__init__.py +12 -0
  1513. tests/rest/synapse/client/__init__.py +12 -0
  1514. tests/rest/synapse/client/test_federation_whitelist.py +118 -0
  1515. tests/rest/synapse/mas/__init__.py +12 -0
  1516. tests/rest/synapse/mas/_base.py +43 -0
  1517. tests/rest/synapse/mas/test_devices.py +693 -0
  1518. tests/rest/synapse/mas/test_users.py +1399 -0
  1519. tests/rest/test_health.py +35 -0
  1520. tests/rest/test_well_known.py +155 -0
  1521. tests/scripts/__init__.py +0 -0
  1522. tests/scripts/test_new_matrix_user.py +172 -0
  1523. tests/server.py +1374 -0
  1524. tests/server_notices/__init__.py +241 -0
  1525. tests/server_notices/test_consent.py +111 -0
  1526. tests/server_notices/test_resource_limits_server_notices.py +409 -0
  1527. tests/state/__init__.py +0 -0
  1528. tests/state/test_v2.py +1096 -0
  1529. tests/state/test_v21.py +506 -0
  1530. tests/storage/__init__.py +0 -0
  1531. tests/storage/databases/__init__.py +20 -0
  1532. tests/storage/databases/main/__init__.py +20 -0
  1533. tests/storage/databases/main/test_cache.py +124 -0
  1534. tests/storage/databases/main/test_deviceinbox.py +323 -0
  1535. tests/storage/databases/main/test_end_to_end_keys.py +127 -0
  1536. tests/storage/databases/main/test_events_worker.py +594 -0
  1537. tests/storage/databases/main/test_lock.py +499 -0
  1538. tests/storage/databases/main/test_metrics.py +88 -0
  1539. tests/storage/databases/main/test_receipts.py +218 -0
  1540. tests/storage/databases/main/test_room.py +192 -0
  1541. tests/storage/test__base.py +178 -0
  1542. tests/storage/test_account_data.py +186 -0
  1543. tests/storage/test_appservice.py +568 -0
  1544. tests/storage/test_background_update.py +671 -0
  1545. tests/storage/test_base.py +813 -0
  1546. tests/storage/test_cleanup_extrems.py +396 -0
  1547. tests/storage/test_client_ips.py +788 -0
  1548. tests/storage/test_database.py +288 -0
  1549. tests/storage/test_devices.py +353 -0
  1550. tests/storage/test_directory.py +74 -0
  1551. tests/storage/test_e2e_room_keys.py +87 -0
  1552. tests/storage/test_end_to_end_keys.py +120 -0
  1553. tests/storage/test_event_chain.py +826 -0
  1554. tests/storage/test_event_federation.py +1433 -0
  1555. tests/storage/test_event_push_actions.py +809 -0
  1556. tests/storage/test_events.py +591 -0
  1557. tests/storage/test_events_bg_updates.py +156 -0
  1558. tests/storage/test_id_generators.py +791 -0
  1559. tests/storage/test_invite_rule.py +171 -0
  1560. tests/storage/test_main.py +56 -0
  1561. tests/storage/test_monthly_active_users.py +500 -0
  1562. tests/storage/test_profile.py +134 -0
  1563. tests/storage/test_purge.py +459 -0
  1564. tests/storage/test_receipts.py +309 -0
  1565. tests/storage/test_redaction.py +462 -0
  1566. tests/storage/test_registration.py +277 -0
  1567. tests/storage/test_relations.py +118 -0
  1568. tests/storage/test_rollback_worker.py +132 -0
  1569. tests/storage/test_room.py +69 -0
  1570. tests/storage/test_room_search.py +383 -0
  1571. tests/storage/test_roommember.py +812 -0
  1572. tests/storage/test_sliding_sync_tables.py +5187 -0
  1573. tests/storage/test_state.py +959 -0
  1574. tests/storage/test_state_deletion.py +475 -0
  1575. tests/storage/test_stream.py +1533 -0
  1576. tests/storage/test_thread_subscriptions.py +369 -0
  1577. tests/storage/test_transactions.py +77 -0
  1578. tests/storage/test_txn_limit.py +49 -0
  1579. tests/storage/test_unsafe_locale.py +67 -0
  1580. tests/storage/test_user_directory.py +691 -0
  1581. tests/storage/test_user_filters.py +101 -0
  1582. tests/storage/util/__init__.py +20 -0
  1583. tests/storage/util/test_partial_state_events_tracker.py +181 -0
  1584. tests/synapse_rust/__init__.py +11 -0
  1585. tests/synapse_rust/test_http_client.py +225 -0
  1586. tests/test_distributor.py +74 -0
  1587. tests/test_event_auth.py +921 -0
  1588. tests/test_mau.py +347 -0
  1589. tests/test_phone_home.py +102 -0
  1590. tests/test_rust.py +11 -0
  1591. tests/test_server.py +557 -0
  1592. tests/test_state.py +902 -0
  1593. tests/test_terms_auth.py +128 -0
  1594. tests/test_types.py +201 -0
  1595. tests/test_utils/__init__.py +161 -0
  1596. tests/test_utils/event_injection.py +150 -0
  1597. tests/test_utils/html_parsers.py +59 -0
  1598. tests/test_utils/logging_setup.py +74 -0
  1599. tests/test_utils/oidc.py +370 -0
  1600. tests/test_visibility.py +712 -0
  1601. tests/types/__init__.py +0 -0
  1602. tests/types/test_init.py +51 -0
  1603. tests/types/test_state.py +627 -0
  1604. tests/unittest.py +1108 -0
  1605. tests/util/__init__.py +20 -0
  1606. tests/util/caches/__init__.py +20 -0
  1607. tests/util/caches/test_cached_call.py +168 -0
  1608. tests/util/caches/test_deferred_cache.py +317 -0
  1609. tests/util/caches/test_descriptors.py +1110 -0
  1610. tests/util/caches/test_response_cache.py +225 -0
  1611. tests/util/caches/test_ttlcache.py +90 -0
  1612. tests/util/test_async_helpers.py +808 -0
  1613. tests/util/test_background_queue.py +117 -0
  1614. tests/util/test_batching_queue.py +252 -0
  1615. tests/util/test_check_dependencies.py +243 -0
  1616. tests/util/test_dict_cache.py +130 -0
  1617. tests/util/test_events.py +118 -0
  1618. tests/util/test_expiring_cache.py +113 -0
  1619. tests/util/test_file_consumer.py +199 -0
  1620. tests/util/test_itertools.py +190 -0
  1621. tests/util/test_linearizer.py +264 -0
  1622. tests/util/test_logcontext.py +715 -0
  1623. tests/util/test_logformatter.py +44 -0
  1624. tests/util/test_lrucache.py +479 -0
  1625. tests/util/test_macaroons.py +126 -0
  1626. tests/util/test_mutable_overlay_mapping.py +189 -0
  1627. tests/util/test_ratelimitutils.py +146 -0
  1628. tests/util/test_retryutils.py +314 -0
  1629. tests/util/test_rwlock.py +401 -0
  1630. tests/util/test_stream_change_cache.py +304 -0
  1631. tests/util/test_stringutils.py +86 -0
  1632. tests/util/test_task_scheduler.py +227 -0
  1633. tests/util/test_threepids.py +55 -0
  1634. tests/util/test_treecache.py +93 -0
  1635. tests/util/test_wheel_timer.py +82 -0
  1636. tests/utils.py +342 -0
@@ -0,0 +1,3626 @@
1
+ #
2
+ # This file is licensed under the Affero General Public License (AGPL) version 3.
3
+ #
4
+ # Copyright 2020 Dirk Klimpel
5
+ # Copyright (C) 2023 New Vector, Ltd
6
+ #
7
+ # This program is free software: you can redistribute it and/or modify
8
+ # it under the terms of the GNU Affero General Public License as
9
+ # published by the Free Software Foundation, either version 3 of the
10
+ # License, or (at your option) any later version.
11
+ #
12
+ # See the GNU Affero General Public License for more details:
13
+ # <https://www.gnu.org/licenses/agpl-3.0.html>.
14
+ #
15
+ # Originally licensed under the Apache License, Version 2.0:
16
+ # <http://www.apache.org/licenses/LICENSE-2.0>.
17
+ #
18
+ # [This file includes modifications made by New Vector Limited]
19
+ #
20
+ #
21
+ import json
22
+ import time
23
+ import urllib.parse
24
+ from http import HTTPStatus
25
+ from unittest.mock import AsyncMock, Mock
26
+
27
+ from parameterized import parameterized
28
+
29
+ from twisted.internet.testing import MemoryReactor
30
+
31
+ import synapse.rest.admin
32
+ from synapse.api.constants import EventContentFields, EventTypes, Membership, RoomTypes
33
+ from synapse.api.errors import Codes
34
+ from synapse.api.room_versions import RoomVersions
35
+ from synapse.handlers.pagination import (
36
+ PURGE_ROOM_ACTION_NAME,
37
+ SHUTDOWN_AND_PURGE_ROOM_ACTION_NAME,
38
+ )
39
+ from synapse.rest.client import directory, events, knock, login, room, sync
40
+ from synapse.server import HomeServer
41
+ from synapse.storage.databases.main.purge_events import (
42
+ purge_room_tables_with_event_id_index,
43
+ purge_room_tables_with_room_id_column,
44
+ )
45
+ from synapse.types import UserID
46
+ from synapse.util.clock import Clock
47
+ from synapse.util.duration import Duration
48
+ from synapse.util.task_scheduler import TaskScheduler
49
+
50
+ from tests import unittest
51
+
52
+ """Tests admin REST events for /rooms paths."""
53
+
54
+
55
+ ONE_HOUR_IN_S = 3600
56
+
57
+
58
+ class AdminHierarchyTestCase(unittest.HomeserverTestCase):
59
+ servlets = [
60
+ synapse.rest.admin.register_servlets,
61
+ login.register_servlets,
62
+ room.register_servlets,
63
+ ]
64
+
65
+ def prepare(self, reactor: MemoryReactor, clock: Clock, hs: HomeServer) -> None:
66
+ # create some users
67
+ self.admin_user = self.register_user("admin", "pass", admin=True)
68
+ self.admin_user_tok = self.login("admin", "pass")
69
+
70
+ self.other_user = self.register_user("user", "pass")
71
+ self.other_user_tok = self.login("user", "pass")
72
+
73
+ self.third_user = self.register_user("third_user", "pass")
74
+ self.third_user_tok = self.login("third_user", "pass")
75
+
76
+ # mock out the function which pulls room information in over federation.
77
+ self._room_summary_handler = hs.get_room_summary_handler()
78
+ self._room_summary_handler._summarize_remote_room_hierarchy = Mock() # type: ignore[method-assign]
79
+
80
+ # create some rooms with different options
81
+ self.room_id1 = self.helper.create_room_as(
82
+ self.other_user,
83
+ is_public=False,
84
+ tok=self.other_user_tok,
85
+ extra_content={"name": "nefarious", "topic": "being bad"},
86
+ )
87
+
88
+ self.room_id2 = self.helper.create_room_as(
89
+ self.third_user,
90
+ tok=self.third_user_tok,
91
+ extra_content={"name": "also nefarious"},
92
+ )
93
+
94
+ self.room_id3 = self.helper.create_room_as(
95
+ self.admin_user,
96
+ is_public=False,
97
+ tok=self.admin_user_tok,
98
+ extra_content={
99
+ "name": "not nefarious",
100
+ "topic": "happy things",
101
+ "creation_content": {
102
+ "additional_creators": [self.other_user, self.third_user]
103
+ },
104
+ },
105
+ room_version="12",
106
+ )
107
+
108
+ self.not_in_space_room_id = self.helper.create_room_as(
109
+ self.other_user,
110
+ tok=self.other_user_tok,
111
+ extra_content={"name": "not related to other rooms"},
112
+ )
113
+
114
+ # create a space room
115
+ self.space_room_id = self.helper.create_room_as(
116
+ self.other_user,
117
+ is_public=True,
118
+ extra_content={
119
+ "visibility": "public",
120
+ "creation_content": {EventContentFields.ROOM_TYPE: RoomTypes.SPACE},
121
+ "name": "space_room",
122
+ },
123
+ tok=self.other_user_tok,
124
+ )
125
+
126
+ # and an unjoined remote room
127
+ self.remote_room_id = "!remote_room"
128
+
129
+ self.room_id_to_human_name_map = {
130
+ self.room_id1: "room1",
131
+ self.room_id2: "room2",
132
+ self.room_id3: "room3",
133
+ self.not_in_space_room_id: "room4",
134
+ self.space_room_id: "space_room",
135
+ self.remote_room_id: "remote_room",
136
+ }
137
+
138
+ # add three of the rooms to space
139
+ for state_key in [self.room_id1, self.room_id2, self.room_id3]:
140
+ self.helper.send_state(
141
+ self.space_room_id,
142
+ EventTypes.SpaceChild,
143
+ body={"via": ["local_test_server"]},
144
+ tok=self.other_user_tok,
145
+ state_key=state_key,
146
+ )
147
+
148
+ # and add remote room to space - ideally we'd add an actual remote
149
+ # space with rooms in it but the test framework doesn't currently
150
+ # support that. Instead we add a room which the server would have to
151
+ # reach out over federation to get details about and assert that the
152
+ # federation call was not made
153
+ self.helper.send_state(
154
+ self.space_room_id,
155
+ EventTypes.SpaceChild,
156
+ body={"via": ["remote_test_server"]},
157
+ tok=self.other_user_tok,
158
+ state_key=self.remote_room_id,
159
+ )
160
+
161
+ def test_no_auth(self) -> None:
162
+ """
163
+ If the requester does not provide authentication, a 401 is returned
164
+ """
165
+
166
+ channel = self.make_request(
167
+ "GET",
168
+ f"/_synapse/admin/v1/rooms/{self.space_room_id}/hierarchy",
169
+ )
170
+
171
+ self.assertEqual(401, channel.code, msg=channel.json_body)
172
+ self.assertEqual(Codes.MISSING_TOKEN, channel.json_body["errcode"])
173
+
174
+ def test_requester_is_no_admin(self) -> None:
175
+ """
176
+ If the requester is not a server admin, an error 403 is returned.
177
+ """
178
+
179
+ channel = self.make_request(
180
+ "GET",
181
+ f"/_synapse/admin/v1/rooms/{self.space_room_id}/hierarchy",
182
+ access_token=self.other_user_tok,
183
+ )
184
+
185
+ self.assertEqual(403, channel.code, msg=channel.json_body)
186
+ self.assertEqual(Codes.FORBIDDEN, channel.json_body["errcode"])
187
+
188
+ def test_bad_request(self) -> None:
189
+ """
190
+ Test that invalid param values raise an error
191
+ """
192
+ channel = self.make_request(
193
+ "GET",
194
+ f"/_synapse/admin/v1/rooms/{self.space_room_id}/hierarchy?limit=ten",
195
+ access_token=self.admin_user_tok,
196
+ )
197
+ self.assertEqual(400, channel.code, msg=channel.json_body)
198
+ self.assertEqual(Codes.INVALID_PARAM, channel.json_body["errcode"])
199
+
200
+ channel = self.make_request(
201
+ "GET",
202
+ f"/_synapse/admin/v1/rooms/{self.space_room_id}/hierarchy?max_depth=four",
203
+ access_token=self.admin_user_tok,
204
+ )
205
+ self.assertEqual(400, channel.code, msg=channel.json_body)
206
+ self.assertEqual(Codes.INVALID_PARAM, channel.json_body["errcode"])
207
+
208
+ def test_room_summary(self) -> None:
209
+ """
210
+ Test that details of room and details of children of room are
211
+ provided correctly
212
+ """
213
+
214
+ channel = self.make_request(
215
+ "GET",
216
+ f"/_synapse/admin/v1/rooms/{self.space_room_id}/hierarchy",
217
+ access_token=self.admin_user_tok,
218
+ )
219
+ self.assertEqual(channel.code, 200, msg=channel.json_body)
220
+ rooms = channel.json_body["rooms"]
221
+ self.assertCountEqual(
222
+ {
223
+ self.room_id_to_human_name_map.get(
224
+ room["room_id"], f"Unknown room: {room['room_id']}"
225
+ )
226
+ for room in rooms
227
+ },
228
+ {"space_room", "room1", "room2", "room3"},
229
+ )
230
+
231
+ for room_result in rooms:
232
+ room_id = room_result["room_id"]
233
+ if room_id == self.room_id1:
234
+ self.assertEqual(room_result["name"], "nefarious")
235
+ self.assertEqual(room_result["topic"], "being bad")
236
+ self.assertEqual(room_result["join_rule"], "invite")
237
+ self.assertEqual(len(room_result["children_state"]), 0)
238
+ self.assertEqual(room_result["world_readable"], False)
239
+ self.assertEqual(room_result["guest_can_join"], True)
240
+ self.assertEqual(room_result["num_joined_members"], 1)
241
+ elif room_id == self.room_id2:
242
+ self.assertEqual(room_result["name"], "also nefarious")
243
+ self.assertEqual(room_result["join_rule"], "public")
244
+ self.assertEqual(len(room_result["children_state"]), 0)
245
+ self.assertEqual(room_result["world_readable"], False)
246
+ self.assertEqual(room_result["guest_can_join"], False)
247
+ self.assertEqual(room_result["num_joined_members"], 1)
248
+ elif room_id == self.room_id3:
249
+ self.assertEqual(room_result["name"], "not nefarious")
250
+ self.assertEqual(room_result["join_rule"], "invite")
251
+ self.assertEqual(room_result["topic"], "happy things")
252
+ self.assertEqual(len(room_result["children_state"]), 0)
253
+ self.assertEqual(room_result["world_readable"], False)
254
+ self.assertEqual(room_result["guest_can_join"], True)
255
+ self.assertEqual(room_result["num_joined_members"], 1)
256
+ elif room_id == self.not_in_space_room_id:
257
+ self.fail("this room should not have been returned")
258
+ elif room_id == self.space_room_id:
259
+ self.assertEqual(room_result["join_rule"], "public")
260
+ self.assertEqual(len(room_result["children_state"]), 4)
261
+ self.assertEqual(room_result["room_type"], "m.space")
262
+ self.assertEqual(room_result["world_readable"], False)
263
+ self.assertEqual(room_result["guest_can_join"], False)
264
+ self.assertEqual(room_result["num_joined_members"], 1)
265
+ self.assertEqual(room_result["name"], "space_room")
266
+ else:
267
+ self.fail("unknown room returned")
268
+
269
+ # Assert that a federation function to look up details about
270
+ # this room has not been called. We never expect the admin
271
+ # hierarchy endpoint to reach out over federation.
272
+ self._room_summary_handler._summarize_remote_room_hierarchy.assert_not_called() # type: ignore[attr-defined]
273
+
274
+ def test_room_summary_pagination(self) -> None:
275
+ """
276
+ Test that details of room and details of children of room are provided
277
+ correctly when paginating
278
+ """
279
+
280
+ channel = self.make_request(
281
+ "GET",
282
+ f"/_synapse/admin/v1/rooms/{self.space_room_id}/hierarchy?limit=2",
283
+ access_token=self.admin_user_tok,
284
+ )
285
+ self.assertEqual(channel.code, 200, msg=channel.json_body)
286
+ rooms = channel.json_body["rooms"]
287
+ self.assertCountEqual(
288
+ {
289
+ self.room_id_to_human_name_map.get(
290
+ room["room_id"], f"Unknown room: {room['room_id']}"
291
+ )
292
+ for room in rooms
293
+ },
294
+ {"space_room", "room1"},
295
+ )
296
+ next_batch = channel.json_body["next_batch"]
297
+
298
+ channel2 = self.make_request(
299
+ "GET",
300
+ f"/_synapse/admin/v1/rooms/{self.space_room_id}/hierarchy?from={next_batch}",
301
+ access_token=self.admin_user_tok,
302
+ )
303
+ self.assertEqual(channel2.code, 200, msg=channel2.json_body)
304
+ new_rooms = channel2.json_body["rooms"]
305
+ self.assertCountEqual(
306
+ {
307
+ self.room_id_to_human_name_map.get(
308
+ room["room_id"], f"Unknown room: {room['room_id']}"
309
+ )
310
+ for room in new_rooms
311
+ },
312
+ {"room2", "room3"},
313
+ )
314
+
315
+ rooms_to_check = rooms + new_rooms
316
+ for room_result in rooms_to_check:
317
+ room_id = room_result["room_id"]
318
+ if room_id == self.room_id1:
319
+ self.assertEqual(room_result["name"], "nefarious")
320
+ self.assertEqual(room_result["topic"], "being bad")
321
+ self.assertEqual(room_result["join_rule"], "invite")
322
+ self.assertEqual(len(room_result["children_state"]), 0)
323
+ self.assertEqual(room_result["world_readable"], False)
324
+ self.assertEqual(room_result["guest_can_join"], True)
325
+ self.assertEqual(room_result["num_joined_members"], 1)
326
+ elif room_id == self.room_id2:
327
+ self.assertEqual(room_result["name"], "also nefarious")
328
+ self.assertEqual(room_result["join_rule"], "public")
329
+ self.assertEqual(len(room_result["children_state"]), 0)
330
+ self.assertEqual(room_result["world_readable"], False)
331
+ self.assertEqual(room_result["guest_can_join"], False)
332
+ self.assertEqual(room_result["num_joined_members"], 1)
333
+ elif room_id == self.room_id3:
334
+ self.assertEqual(room_result["name"], "not nefarious")
335
+ self.assertEqual(room_result["join_rule"], "invite")
336
+ self.assertEqual(room_result["topic"], "happy things")
337
+ self.assertEqual(len(room_result["children_state"]), 0)
338
+ self.assertEqual(room_result["world_readable"], False)
339
+ self.assertEqual(room_result["guest_can_join"], True)
340
+ self.assertEqual(room_result["num_joined_members"], 1)
341
+ elif room_id == self.not_in_space_room_id:
342
+ self.fail("this room should not have been returned")
343
+ elif room_id == self.space_room_id:
344
+ self.assertEqual(room_result["join_rule"], "public")
345
+ self.assertEqual(len(room_result["children_state"]), 4)
346
+ self.assertEqual(room_result["room_type"], "m.space")
347
+ self.assertEqual(room_result["world_readable"], False)
348
+ self.assertEqual(room_result["guest_can_join"], False)
349
+ self.assertEqual(room_result["num_joined_members"], 1)
350
+ self.assertEqual(room_result["name"], "space_room")
351
+ else:
352
+ self.fail("unknown room returned")
353
+
354
+ # Assert that a federation function to look up details about
355
+ # this room has not been called. We never expect the admin
356
+ # hierarchy endpoint to reach out over federation.
357
+ self._room_summary_handler._summarize_remote_room_hierarchy.assert_not_called() # type: ignore[attr-defined]
358
+
359
+
360
+ class DeleteRoomTestCase(unittest.HomeserverTestCase):
361
+ servlets = [
362
+ synapse.rest.admin.register_servlets,
363
+ login.register_servlets,
364
+ events.register_servlets,
365
+ room.register_servlets,
366
+ knock.register_servlets,
367
+ sync.register_servlets,
368
+ room.register_deprecated_servlets,
369
+ ]
370
+
371
+ def prepare(self, reactor: MemoryReactor, clock: Clock, hs: HomeServer) -> None:
372
+ self.event_creation_handler = hs.get_event_creation_handler()
373
+ self.task_scheduler = hs.get_task_scheduler()
374
+ hs.config.consent.user_consent_version = "1"
375
+
376
+ consent_uri_builder = Mock()
377
+ consent_uri_builder.build_user_consent_uri.return_value = "http://example.com"
378
+ self.event_creation_handler._consent_uri_builder = consent_uri_builder
379
+
380
+ self.store = hs.get_datastores().main
381
+
382
+ self.admin_user = self.register_user("admin", "pass", admin=True)
383
+ self.admin_user_tok = self.login("admin", "pass")
384
+
385
+ self.other_user = self.register_user("user", "pass")
386
+ self.other_user_tok = self.login("user", "pass")
387
+
388
+ # Mark the admin user as having consented
389
+ self.get_success(self.store.user_set_consent_version(self.admin_user, "1"))
390
+
391
+ self.room_id = self.helper.create_room_as(
392
+ self.other_user, tok=self.other_user_tok
393
+ )
394
+ self.url = "/_synapse/admin/v1/rooms/%s" % self.room_id
395
+
396
+ def test_requester_is_no_admin(self) -> None:
397
+ """
398
+ If the user is not a server admin, an error 403 is returned.
399
+ """
400
+
401
+ channel = self.make_request(
402
+ "DELETE",
403
+ self.url,
404
+ {},
405
+ access_token=self.other_user_tok,
406
+ )
407
+
408
+ self.assertEqual(403, channel.code, msg=channel.json_body)
409
+ self.assertEqual(Codes.FORBIDDEN, channel.json_body["errcode"])
410
+
411
+ def test_room_does_not_exist(self) -> None:
412
+ """
413
+ Check that unknown rooms/server return 200
414
+ """
415
+ url = "/_synapse/admin/v1/rooms/%s" % "!unknown:test"
416
+
417
+ channel = self.make_request(
418
+ "DELETE",
419
+ url,
420
+ {},
421
+ access_token=self.admin_user_tok,
422
+ )
423
+
424
+ self.assertEqual(200, channel.code, msg=channel.json_body)
425
+
426
+ def test_room_is_not_valid(self) -> None:
427
+ """
428
+ Check that invalid room names, return an error 400.
429
+ """
430
+ url = "/_synapse/admin/v1/rooms/%s" % "invalidroom"
431
+
432
+ channel = self.make_request(
433
+ "DELETE",
434
+ url,
435
+ {},
436
+ access_token=self.admin_user_tok,
437
+ )
438
+
439
+ self.assertEqual(400, channel.code, msg=channel.json_body)
440
+ self.assertEqual(
441
+ "invalidroom is not a legal room ID",
442
+ channel.json_body["error"],
443
+ )
444
+
445
+ def test_new_room_user_does_not_exist(self) -> None:
446
+ """
447
+ Tests that the user ID must be from local server but it does not have to exist.
448
+ """
449
+
450
+ channel = self.make_request(
451
+ "DELETE",
452
+ self.url,
453
+ content={"new_room_user_id": "@unknown:test"},
454
+ access_token=self.admin_user_tok,
455
+ )
456
+
457
+ self.assertEqual(200, channel.code, msg=channel.json_body)
458
+ self.assertIn("new_room_id", channel.json_body)
459
+ self.assertIn("kicked_users", channel.json_body)
460
+ self.assertIn("failed_to_kick_users", channel.json_body)
461
+ self.assertIn("local_aliases", channel.json_body)
462
+
463
+ def test_new_room_user_is_not_local(self) -> None:
464
+ """
465
+ Check that only local users can create new room to move members.
466
+ """
467
+
468
+ channel = self.make_request(
469
+ "DELETE",
470
+ self.url,
471
+ content={"new_room_user_id": "@not:exist.bla"},
472
+ access_token=self.admin_user_tok,
473
+ )
474
+
475
+ self.assertEqual(400, channel.code, msg=channel.json_body)
476
+ self.assertEqual(
477
+ "User must be our own: @not:exist.bla",
478
+ channel.json_body["error"],
479
+ )
480
+
481
+ def test_block_is_not_bool(self) -> None:
482
+ """
483
+ If parameter `block` is not boolean, return an error
484
+ """
485
+
486
+ channel = self.make_request(
487
+ "DELETE",
488
+ self.url,
489
+ content={"block": "NotBool"},
490
+ access_token=self.admin_user_tok,
491
+ )
492
+
493
+ self.assertEqual(400, channel.code, msg=channel.json_body)
494
+ self.assertEqual(Codes.BAD_JSON, channel.json_body["errcode"])
495
+
496
+ def test_purge_is_not_bool(self) -> None:
497
+ """
498
+ If parameter `purge` is not boolean, return an error
499
+ """
500
+
501
+ channel = self.make_request(
502
+ "DELETE",
503
+ self.url,
504
+ content={"purge": "NotBool"},
505
+ access_token=self.admin_user_tok,
506
+ )
507
+
508
+ self.assertEqual(400, channel.code, msg=channel.json_body)
509
+ self.assertEqual(Codes.BAD_JSON, channel.json_body["errcode"])
510
+
511
+ def test_purge_room_and_block(self) -> None:
512
+ """Test to purge a room and block it.
513
+ Members will not be moved to a new room and will not receive a message.
514
+ """
515
+ # Test that room is not purged
516
+ with self.assertRaises(AssertionError):
517
+ self._is_purged(self.room_id)
518
+
519
+ # Test that room is not blocked
520
+ self._is_blocked(self.room_id, expect=False)
521
+
522
+ # Assert one user in room
523
+ self._is_member(room_id=self.room_id, user_id=self.other_user)
524
+
525
+ channel = self.make_request(
526
+ "DELETE",
527
+ self.url.encode("ascii"),
528
+ content={"block": True, "purge": True},
529
+ access_token=self.admin_user_tok,
530
+ )
531
+
532
+ self.assertEqual(200, channel.code, msg=channel.json_body)
533
+ self.assertEqual(None, channel.json_body["new_room_id"])
534
+ self.assertEqual(self.other_user, channel.json_body["kicked_users"][0])
535
+ self.assertIn("failed_to_kick_users", channel.json_body)
536
+ self.assertIn("local_aliases", channel.json_body)
537
+
538
+ self._is_purged(self.room_id)
539
+ self._is_blocked(self.room_id, expect=True)
540
+ self._has_no_members(self.room_id)
541
+
542
+ def test_purge_room_and_not_block(self) -> None:
543
+ """Test to purge a room and do not block it.
544
+ Members will not be moved to a new room and will not receive a message.
545
+ """
546
+ # Test that room is not purged
547
+ with self.assertRaises(AssertionError):
548
+ self._is_purged(self.room_id)
549
+
550
+ # Test that room is not blocked
551
+ self._is_blocked(self.room_id, expect=False)
552
+
553
+ # Assert one user in room
554
+ self._is_member(room_id=self.room_id, user_id=self.other_user)
555
+
556
+ channel = self.make_request(
557
+ "DELETE",
558
+ self.url.encode("ascii"),
559
+ content={"block": False, "purge": True},
560
+ access_token=self.admin_user_tok,
561
+ )
562
+
563
+ self.assertEqual(200, channel.code, msg=channel.json_body)
564
+ self.assertEqual(None, channel.json_body["new_room_id"])
565
+ self.assertEqual(self.other_user, channel.json_body["kicked_users"][0])
566
+ self.assertIn("failed_to_kick_users", channel.json_body)
567
+ self.assertIn("local_aliases", channel.json_body)
568
+
569
+ self._is_purged(self.room_id)
570
+ self._is_blocked(self.room_id, expect=False)
571
+ self._has_no_members(self.room_id)
572
+
573
+ def test_purge_room_unjoined(self) -> None:
574
+ """Test to purge a room when there are invited or knocked users."""
575
+ # Test that room is not purged
576
+ with self.assertRaises(AssertionError):
577
+ self._is_purged(self.room_id)
578
+
579
+ # Test that room is not blocked
580
+ self._is_blocked(self.room_id, expect=False)
581
+
582
+ # Assert one user in room
583
+ self._is_member(room_id=self.room_id, user_id=self.other_user)
584
+ self.helper.send_state(
585
+ self.room_id,
586
+ EventTypes.JoinRules,
587
+ {"join_rule": "knock"},
588
+ tok=self.other_user_tok,
589
+ )
590
+
591
+ # Invite a user.
592
+ invited_user = self.register_user("invited", "pass")
593
+ self.helper.invite(
594
+ self.room_id, self.other_user, invited_user, tok=self.other_user_tok
595
+ )
596
+
597
+ # Have a user knock.
598
+ knocked_user = self.register_user("knocked", "pass")
599
+ knocked_user_tok = self.login("knocked", "pass")
600
+ self.helper.knock(self.room_id, knocked_user, tok=knocked_user_tok)
601
+
602
+ channel = self.make_request(
603
+ "DELETE",
604
+ self.url.encode("ascii"),
605
+ content={"block": False, "purge": True},
606
+ access_token=self.admin_user_tok,
607
+ )
608
+
609
+ self.assertEqual(200, channel.code, msg=channel.json_body)
610
+ self.assertEqual(None, channel.json_body["new_room_id"])
611
+ self.assertCountEqual(
612
+ [self.other_user, invited_user, knocked_user],
613
+ channel.json_body["kicked_users"],
614
+ )
615
+ self.assertIn("failed_to_kick_users", channel.json_body)
616
+ self.assertIn("local_aliases", channel.json_body)
617
+
618
+ self._is_purged(self.room_id)
619
+ self._is_blocked(self.room_id, expect=False)
620
+ self._has_no_members(self.room_id)
621
+
622
+ def test_block_room_and_not_purge(self) -> None:
623
+ """Test to block a room without purging it.
624
+ Members will not be moved to a new room and will not receive a message.
625
+ The room will not be purged.
626
+ """
627
+ # Test that room is not purged
628
+ with self.assertRaises(AssertionError):
629
+ self._is_purged(self.room_id)
630
+
631
+ # Test that room is not blocked
632
+ self._is_blocked(self.room_id, expect=False)
633
+
634
+ # Assert one user in room
635
+ self._is_member(room_id=self.room_id, user_id=self.other_user)
636
+
637
+ channel = self.make_request(
638
+ "DELETE",
639
+ self.url.encode("ascii"),
640
+ content={"block": True, "purge": False},
641
+ access_token=self.admin_user_tok,
642
+ )
643
+
644
+ self.assertEqual(200, channel.code, msg=channel.json_body)
645
+ self.assertEqual(None, channel.json_body["new_room_id"])
646
+ self.assertEqual(self.other_user, channel.json_body["kicked_users"][0])
647
+ self.assertIn("failed_to_kick_users", channel.json_body)
648
+ self.assertIn("local_aliases", channel.json_body)
649
+
650
+ with self.assertRaises(AssertionError):
651
+ self._is_purged(self.room_id)
652
+ self._is_blocked(self.room_id, expect=True)
653
+ self._has_no_members(self.room_id)
654
+
655
+ @parameterized.expand([(True,), (False,)])
656
+ def test_block_unknown_room(self, purge: bool) -> None:
657
+ """
658
+ We can block an unknown room. In this case, the `purge` argument
659
+ should be ignored.
660
+ """
661
+ room_id = "!unknown:test"
662
+
663
+ # The room isn't already in the blocked rooms table
664
+ self._is_blocked(room_id, expect=False)
665
+
666
+ # Request the room be blocked.
667
+ channel = self.make_request(
668
+ "DELETE",
669
+ f"/_synapse/admin/v1/rooms/{room_id}",
670
+ {"block": True, "purge": purge},
671
+ access_token=self.admin_user_tok,
672
+ )
673
+
674
+ # The room is now blocked.
675
+ self.assertEqual(200, channel.code, msg=channel.json_body)
676
+ self._is_blocked(room_id)
677
+
678
+ def test_invited_users_not_joined_to_new_room(self) -> None:
679
+ """
680
+ Test that when a new room id is provided, users who are only invited
681
+ but have not joined original room are not moved to new room.
682
+ """
683
+ invitee = self.register_user("invitee", "pass")
684
+
685
+ self.helper.invite(
686
+ self.room_id, self.other_user, invitee, tok=self.other_user_tok
687
+ )
688
+
689
+ # verify that user is invited
690
+ channel = self.make_request(
691
+ "GET",
692
+ f"/_matrix/client/v3/rooms/{self.room_id}/members?membership=invite",
693
+ access_token=self.other_user_tok,
694
+ )
695
+ self.assertEqual(channel.code, 200)
696
+ self.assertEqual(len(channel.json_body["chunk"]), 1)
697
+ invite = channel.json_body["chunk"][0]
698
+ self.assertEqual(invite["state_key"], invitee)
699
+
700
+ # shutdown room
701
+ channel = self.make_request(
702
+ "DELETE",
703
+ self.url,
704
+ {"new_room_user_id": self.admin_user},
705
+ access_token=self.admin_user_tok,
706
+ )
707
+ self.assertEqual(200, channel.code, msg=channel.json_body)
708
+ self.assertEqual(len(channel.json_body["kicked_users"]), 2)
709
+
710
+ # joined member is moved to new room but invited user is not
711
+ users_in_room = self.get_success(
712
+ self.store.get_users_in_room(channel.json_body["new_room_id"])
713
+ )
714
+ self.assertNotIn(invitee, users_in_room)
715
+ self.assertIn(self.other_user, users_in_room)
716
+ self._is_purged(self.room_id)
717
+ self._has_no_members(self.room_id)
718
+
719
+ def test_shutdown_room_consent(self) -> None:
720
+ """Test that we can shutdown rooms with local users who have not
721
+ yet accepted the privacy policy. This used to fail when we tried to
722
+ force part the user from the old room.
723
+ Members will be moved to a new room and will receive a message.
724
+ """
725
+ self.event_creation_handler._block_events_without_consent_error = None
726
+
727
+ # Assert one user in room
728
+ users_in_room = self.get_success(self.store.get_users_in_room(self.room_id))
729
+ self.assertEqual([self.other_user], users_in_room)
730
+
731
+ # Enable require consent to send events
732
+ self.event_creation_handler._block_events_without_consent_error = "Error"
733
+
734
+ # Assert that the user is getting consent error
735
+ self.helper.send(
736
+ self.room_id,
737
+ body="foo",
738
+ tok=self.other_user_tok,
739
+ expect_code=403,
740
+ )
741
+
742
+ # Test that room is not purged
743
+ with self.assertRaises(AssertionError):
744
+ self._is_purged(self.room_id)
745
+
746
+ # Assert one user in room
747
+ self._is_member(room_id=self.room_id, user_id=self.other_user)
748
+
749
+ # Test that the admin can still send shutdown
750
+ channel = self.make_request(
751
+ "DELETE",
752
+ self.url,
753
+ {"new_room_user_id": self.admin_user},
754
+ access_token=self.admin_user_tok,
755
+ )
756
+
757
+ self.assertEqual(200, channel.code, msg=channel.json_body)
758
+ self.assertEqual(self.other_user, channel.json_body["kicked_users"][0])
759
+ self.assertIn("new_room_id", channel.json_body)
760
+ self.assertIn("failed_to_kick_users", channel.json_body)
761
+ self.assertIn("local_aliases", channel.json_body)
762
+
763
+ # Test that member has moved to new room
764
+ self._is_member(
765
+ room_id=channel.json_body["new_room_id"], user_id=self.other_user
766
+ )
767
+
768
+ self._is_purged(self.room_id)
769
+ self._has_no_members(self.room_id)
770
+
771
+ def test_shutdown_room_block_peek(self) -> None:
772
+ """Test that a world_readable room can no longer be peeked into after
773
+ it has been shut down.
774
+ Members will be moved to a new room and will receive a message.
775
+ """
776
+ self.event_creation_handler._block_events_without_consent_error = None
777
+
778
+ # Enable world readable
779
+ url = "rooms/%s/state/m.room.history_visibility" % (self.room_id,)
780
+ channel = self.make_request(
781
+ "PUT",
782
+ url.encode("ascii"),
783
+ {"history_visibility": "world_readable"},
784
+ access_token=self.other_user_tok,
785
+ )
786
+ self.assertEqual(200, channel.code, msg=channel.json_body)
787
+
788
+ # Test that room is not purged
789
+ with self.assertRaises(AssertionError):
790
+ self._is_purged(self.room_id)
791
+
792
+ # Assert one user in room
793
+ self._is_member(room_id=self.room_id, user_id=self.other_user)
794
+
795
+ # Test that the admin can still send shutdown
796
+ channel = self.make_request(
797
+ "DELETE",
798
+ self.url,
799
+ {"new_room_user_id": self.admin_user},
800
+ access_token=self.admin_user_tok,
801
+ )
802
+
803
+ self.assertEqual(200, channel.code, msg=channel.json_body)
804
+ self.assertEqual(self.other_user, channel.json_body["kicked_users"][0])
805
+ self.assertIn("new_room_id", channel.json_body)
806
+ self.assertIn("failed_to_kick_users", channel.json_body)
807
+ self.assertIn("local_aliases", channel.json_body)
808
+
809
+ # Test that member has moved to new room
810
+ self._is_member(
811
+ room_id=channel.json_body["new_room_id"], user_id=self.other_user
812
+ )
813
+
814
+ self._is_purged(self.room_id)
815
+ self._has_no_members(self.room_id)
816
+
817
+ # Assert we can no longer peek into the room
818
+ self._assert_peek(self.room_id, expect_code=403)
819
+
820
+ def test_room_delete_send(self) -> None:
821
+ """Test that sending into a deleted room returns a 403"""
822
+ channel = self.make_request(
823
+ "DELETE",
824
+ self.url,
825
+ content={},
826
+ access_token=self.admin_user_tok,
827
+ )
828
+
829
+ self.assertEqual(200, channel.code, msg=channel.json_body)
830
+
831
+ self.helper.send(
832
+ self.room_id, "test message", expect_code=403, tok=self.other_user_tok
833
+ )
834
+
835
+ def _is_blocked(self, room_id: str, expect: bool = True) -> None:
836
+ """Assert that the room is blocked or not"""
837
+ d = self.store.is_room_blocked(room_id)
838
+ if expect:
839
+ self.assertTrue(self.get_success(d))
840
+ else:
841
+ self.assertIsNone(self.get_success(d))
842
+
843
+ def _has_no_members(self, room_id: str) -> None:
844
+ """Assert there is now no longer anyone in the room"""
845
+ users_in_room = self.get_success(self.store.get_users_in_room(room_id))
846
+ self.assertEqual([], users_in_room)
847
+
848
+ def _is_member(self, room_id: str, user_id: str) -> None:
849
+ """Test that user is member of the room"""
850
+ users_in_room = self.get_success(self.store.get_users_in_room(room_id))
851
+ self.assertIn(user_id, users_in_room)
852
+
853
+ def _is_purged(self, room_id: str) -> None:
854
+ """Test that the following tables have been purged of all rows related to the room."""
855
+ for table in purge_room_tables_with_room_id_column:
856
+ count = self.get_success(
857
+ self.store.db_pool.simple_select_one_onecol(
858
+ table=table,
859
+ keyvalues={"room_id": room_id},
860
+ retcol="COUNT(*)",
861
+ desc="test_purge_room",
862
+ )
863
+ )
864
+ self.assertEqual(count, 0, msg=f"Rows not purged in {table}")
865
+
866
+ for table in purge_room_tables_with_event_id_index:
867
+ rows = self.get_success(
868
+ self.store.db_pool.execute(
869
+ "find_event_count_for_table",
870
+ f"""
871
+ SELECT COUNT(*) FROM {table} WHERE event_id IN (
872
+ SELECT event_id FROM events WHERE room_id=?
873
+ )
874
+ """,
875
+ room_id,
876
+ )
877
+ )
878
+ count = rows[0][0]
879
+ self.assertEqual(count, 0, msg=f"Rows not purged in {table}")
880
+
881
+ def _assert_peek(self, room_id: str, expect_code: int) -> None:
882
+ """Assert that the admin user can (or cannot) peek into the room."""
883
+
884
+ url = "rooms/%s/initialSync" % (room_id,)
885
+ channel = self.make_request(
886
+ "GET", url.encode("ascii"), access_token=self.admin_user_tok
887
+ )
888
+ self.assertEqual(expect_code, channel.code, msg=channel.json_body)
889
+
890
+ url = "events?timeout=0&room_id=" + room_id
891
+ channel = self.make_request(
892
+ "GET", url.encode("ascii"), access_token=self.admin_user_tok
893
+ )
894
+ self.assertEqual(expect_code, channel.code, msg=channel.json_body)
895
+
896
+
897
+ class DeleteRoomV2TestCase(unittest.HomeserverTestCase):
898
+ servlets = [
899
+ synapse.rest.admin.register_servlets,
900
+ login.register_servlets,
901
+ events.register_servlets,
902
+ room.register_servlets,
903
+ room.register_deprecated_servlets,
904
+ ]
905
+
906
+ def prepare(self, reactor: MemoryReactor, clock: Clock, hs: HomeServer) -> None:
907
+ self.event_creation_handler = hs.get_event_creation_handler()
908
+ self.task_scheduler = hs.get_task_scheduler()
909
+ hs.config.consent.user_consent_version = "1"
910
+
911
+ consent_uri_builder = Mock()
912
+ consent_uri_builder.build_user_consent_uri.return_value = "http://example.com"
913
+ self.event_creation_handler._consent_uri_builder = consent_uri_builder
914
+
915
+ self.store = hs.get_datastores().main
916
+
917
+ self.admin_user = self.register_user("admin", "pass", admin=True)
918
+ self.admin_user_tok = self.login("admin", "pass")
919
+
920
+ self.other_user = self.register_user("user", "pass")
921
+ self.other_user_tok = self.login("user", "pass")
922
+
923
+ # Mark the admin user as having consented
924
+ self.get_success(self.store.user_set_consent_version(self.admin_user, "1"))
925
+
926
+ self.room_id = self.helper.create_room_as(
927
+ self.other_user, tok=self.other_user_tok
928
+ )
929
+ self.url = f"/_synapse/admin/v2/rooms/{self.room_id}"
930
+ self.url_status_by_room_id = (
931
+ f"/_synapse/admin/v2/rooms/{self.room_id}/delete_status"
932
+ )
933
+ self.url_status_by_delete_id = "/_synapse/admin/v2/rooms/delete_status/"
934
+
935
+ self.room_member_handler = hs.get_room_member_handler()
936
+ self.pagination_handler = hs.get_pagination_handler()
937
+
938
+ @parameterized.expand(
939
+ [
940
+ ("DELETE", "/_synapse/admin/v2/rooms/%s"),
941
+ ("GET", "/_synapse/admin/v2/rooms/%s/delete_status"),
942
+ ("GET", "/_synapse/admin/v2/rooms/delete_status/%s"),
943
+ ]
944
+ )
945
+ def test_requester_is_no_admin(self, method: str, url: str) -> None:
946
+ """
947
+ If the user is not a server admin, an error 403 is returned.
948
+ """
949
+
950
+ channel = self.make_request(
951
+ method,
952
+ url % self.room_id,
953
+ content={},
954
+ access_token=self.other_user_tok,
955
+ )
956
+
957
+ self.assertEqual(403, channel.code, msg=channel.json_body)
958
+ self.assertEqual(Codes.FORBIDDEN, channel.json_body["errcode"])
959
+
960
+ def test_room_does_not_exist(self) -> None:
961
+ """
962
+ Check that unknown rooms/server return 200
963
+
964
+ This is important, as it allows incomplete vestiges of rooms to be cleared up
965
+ even if the create event/etc is missing.
966
+ """
967
+ room_id = "!unknown:test"
968
+ channel = self.make_request(
969
+ "DELETE",
970
+ f"/_synapse/admin/v2/rooms/{room_id}",
971
+ content={},
972
+ access_token=self.admin_user_tok,
973
+ )
974
+
975
+ self.assertEqual(200, channel.code, msg=channel.json_body)
976
+ self.assertIn("delete_id", channel.json_body)
977
+ delete_id = channel.json_body["delete_id"]
978
+
979
+ # get status
980
+ channel = self.make_request(
981
+ "GET",
982
+ f"/_synapse/admin/v2/rooms/{room_id}/delete_status",
983
+ access_token=self.admin_user_tok,
984
+ )
985
+
986
+ self.assertEqual(200, channel.code, msg=channel.json_body)
987
+ self.assertEqual(1, len(channel.json_body["results"]))
988
+ self.assertEqual("complete", channel.json_body["results"][0]["status"])
989
+ self.assertEqual(delete_id, channel.json_body["results"][0]["delete_id"])
990
+
991
+ @parameterized.expand(
992
+ [
993
+ ("DELETE", "/_synapse/admin/v2/rooms/%s"),
994
+ ("GET", "/_synapse/admin/v2/rooms/%s/delete_status"),
995
+ ]
996
+ )
997
+ def test_room_is_not_valid(self, method: str, url: str) -> None:
998
+ """
999
+ Check that invalid room names, return an error 400.
1000
+ """
1001
+
1002
+ channel = self.make_request(
1003
+ method,
1004
+ url % "invalidroom",
1005
+ content={},
1006
+ access_token=self.admin_user_tok,
1007
+ )
1008
+
1009
+ self.assertEqual(400, channel.code, msg=channel.json_body)
1010
+ self.assertEqual(
1011
+ "invalidroom is not a legal room ID",
1012
+ channel.json_body["error"],
1013
+ )
1014
+
1015
+ def test_new_room_user_does_not_exist(self) -> None:
1016
+ """
1017
+ Tests that the user ID must be from local server but it does not have to exist.
1018
+ """
1019
+
1020
+ channel = self.make_request(
1021
+ "DELETE",
1022
+ self.url,
1023
+ content={"new_room_user_id": "@unknown:test"},
1024
+ access_token=self.admin_user_tok,
1025
+ )
1026
+
1027
+ self.assertEqual(200, channel.code, msg=channel.json_body)
1028
+ self.assertIn("delete_id", channel.json_body)
1029
+ delete_id = channel.json_body["delete_id"]
1030
+
1031
+ self._test_result(delete_id, self.other_user, expect_new_room=True)
1032
+
1033
+ def test_new_room_user_is_not_local(self) -> None:
1034
+ """
1035
+ Check that only local users can create new room to move members.
1036
+ """
1037
+
1038
+ channel = self.make_request(
1039
+ "DELETE",
1040
+ self.url,
1041
+ content={"new_room_user_id": "@not:exist.bla"},
1042
+ access_token=self.admin_user_tok,
1043
+ )
1044
+
1045
+ self.assertEqual(400, channel.code, msg=channel.json_body)
1046
+ self.assertEqual(
1047
+ "User must be our own: @not:exist.bla",
1048
+ channel.json_body["error"],
1049
+ )
1050
+
1051
+ def test_block_is_not_bool(self) -> None:
1052
+ """
1053
+ If parameter `block` is not boolean, return an error
1054
+ """
1055
+
1056
+ channel = self.make_request(
1057
+ "DELETE",
1058
+ self.url,
1059
+ content={"block": "NotBool"},
1060
+ access_token=self.admin_user_tok,
1061
+ )
1062
+
1063
+ self.assertEqual(400, channel.code, msg=channel.json_body)
1064
+ self.assertEqual(Codes.BAD_JSON, channel.json_body["errcode"])
1065
+
1066
+ def test_purge_is_not_bool(self) -> None:
1067
+ """
1068
+ If parameter `purge` is not boolean, return an error
1069
+ """
1070
+
1071
+ channel = self.make_request(
1072
+ "DELETE",
1073
+ self.url,
1074
+ content={"purge": "NotBool"},
1075
+ access_token=self.admin_user_tok,
1076
+ )
1077
+
1078
+ self.assertEqual(400, channel.code, msg=channel.json_body)
1079
+ self.assertEqual(Codes.BAD_JSON, channel.json_body["errcode"])
1080
+
1081
+ def test_delete_expired_status(self) -> None:
1082
+ """Test that the task status is removed after expiration."""
1083
+
1084
+ # first task, do not purge, that we can create a second task
1085
+ channel = self.make_request(
1086
+ "DELETE",
1087
+ self.url.encode("ascii"),
1088
+ content={"purge": False},
1089
+ access_token=self.admin_user_tok,
1090
+ )
1091
+
1092
+ self.assertEqual(200, channel.code, msg=channel.json_body)
1093
+ self.assertIn("delete_id", channel.json_body)
1094
+ delete_id1 = channel.json_body["delete_id"]
1095
+
1096
+ # go ahead
1097
+ self.reactor.advance(TaskScheduler.KEEP_TASKS_FOR_MS / 1000 / 2)
1098
+
1099
+ # second task
1100
+ channel = self.make_request(
1101
+ "DELETE",
1102
+ self.url.encode("ascii"),
1103
+ content={"purge": True},
1104
+ access_token=self.admin_user_tok,
1105
+ )
1106
+
1107
+ self.assertEqual(200, channel.code, msg=channel.json_body)
1108
+ self.assertIn("delete_id", channel.json_body)
1109
+ delete_id2 = channel.json_body["delete_id"]
1110
+
1111
+ # get status
1112
+ channel = self.make_request(
1113
+ "GET",
1114
+ self.url_status_by_room_id,
1115
+ access_token=self.admin_user_tok,
1116
+ )
1117
+
1118
+ self.assertEqual(200, channel.code, msg=channel.json_body)
1119
+ self.assertEqual(2, len(channel.json_body["results"]))
1120
+ self.assertEqual("complete", channel.json_body["results"][0]["status"])
1121
+ self.assertEqual("complete", channel.json_body["results"][1]["status"])
1122
+ self.assertEqual(self.room_id, channel.json_body["results"][0]["room_id"])
1123
+ self.assertEqual(self.room_id, channel.json_body["results"][1]["room_id"])
1124
+ delete_ids = {delete_id1, delete_id2}
1125
+ self.assertTrue(channel.json_body["results"][0]["delete_id"] in delete_ids)
1126
+ delete_ids.remove(channel.json_body["results"][0]["delete_id"])
1127
+ self.assertTrue(channel.json_body["results"][1]["delete_id"] in delete_ids)
1128
+
1129
+ # get status after more than clearing time for first task
1130
+ # second task is not cleared
1131
+ self.reactor.advance(TaskScheduler.KEEP_TASKS_FOR_MS / 1000 / 2)
1132
+
1133
+ channel = self.make_request(
1134
+ "GET",
1135
+ self.url_status_by_room_id,
1136
+ access_token=self.admin_user_tok,
1137
+ )
1138
+
1139
+ self.assertEqual(200, channel.code, msg=channel.json_body)
1140
+ self.assertEqual(1, len(channel.json_body["results"]))
1141
+ self.assertEqual("complete", channel.json_body["results"][0]["status"])
1142
+ self.assertEqual(delete_id2, channel.json_body["results"][0]["delete_id"])
1143
+ self.assertEqual(self.room_id, channel.json_body["results"][0]["room_id"])
1144
+
1145
+ # get status after more than clearing time for all tasks
1146
+ self.reactor.advance(TaskScheduler.KEEP_TASKS_FOR_MS / 1000 / 2)
1147
+
1148
+ channel = self.make_request(
1149
+ "GET",
1150
+ self.url_status_by_room_id,
1151
+ access_token=self.admin_user_tok,
1152
+ )
1153
+
1154
+ self.assertEqual(404, channel.code, msg=channel.json_body)
1155
+ self.assertEqual(Codes.NOT_FOUND, channel.json_body["errcode"])
1156
+
1157
+ def test_delete_same_room_twice(self) -> None:
1158
+ """Test that the call for delete a room at second time gives an exception."""
1159
+
1160
+ body = {"new_room_user_id": self.admin_user}
1161
+
1162
+ # Mock PaginationHandler.purge_room to sleep for 100s, so we have time to do a second call
1163
+ # before the purge is over. Note that it doesn't purge anymore, but we don't care.
1164
+ async def purge_room(room_id: str, force: bool) -> None:
1165
+ await self.hs.get_clock().sleep(Duration(seconds=100))
1166
+
1167
+ self.pagination_handler.purge_room = AsyncMock(side_effect=purge_room) # type: ignore[method-assign]
1168
+
1169
+ # first call to delete room
1170
+ # and do not wait for finish the task
1171
+ first_channel = self.make_request(
1172
+ "DELETE",
1173
+ self.url.encode("ascii"),
1174
+ content=body,
1175
+ access_token=self.admin_user_tok,
1176
+ )
1177
+
1178
+ # second call to delete room
1179
+ second_channel = self.make_request(
1180
+ "DELETE",
1181
+ self.url.encode("ascii"),
1182
+ content=body,
1183
+ access_token=self.admin_user_tok,
1184
+ )
1185
+
1186
+ self.assertEqual(400, second_channel.code, msg=second_channel.json_body)
1187
+ self.assertEqual(Codes.UNKNOWN, second_channel.json_body["errcode"])
1188
+ self.assertEqual(
1189
+ f"Purge already in progress for {self.room_id}",
1190
+ second_channel.json_body["error"],
1191
+ )
1192
+
1193
+ # get result of first call
1194
+ first_channel.await_result()
1195
+ self.assertEqual(200, first_channel.code, msg=first_channel.json_body)
1196
+ self.assertIn("delete_id", first_channel.json_body)
1197
+
1198
+ # wait for purge_room to finish
1199
+ self.pump(1)
1200
+
1201
+ # check status after finish the task
1202
+ self._test_result(
1203
+ first_channel.json_body["delete_id"],
1204
+ self.other_user,
1205
+ expect_new_room=True,
1206
+ )
1207
+
1208
+ def test_purge_room_and_block(self) -> None:
1209
+ """Test to purge a room and block it.
1210
+ Members will not be moved to a new room and will not receive a message.
1211
+ """
1212
+ # Test that room is not purged
1213
+ with self.assertRaises(AssertionError):
1214
+ self._is_purged(self.room_id)
1215
+
1216
+ # Test that room is not blocked
1217
+ self._is_blocked(self.room_id, expect=False)
1218
+
1219
+ # Assert one user in room
1220
+ self._is_member(room_id=self.room_id, user_id=self.other_user)
1221
+
1222
+ channel = self.make_request(
1223
+ "DELETE",
1224
+ self.url.encode("ascii"),
1225
+ content={"block": True, "purge": True},
1226
+ access_token=self.admin_user_tok,
1227
+ )
1228
+
1229
+ self.assertEqual(200, channel.code, msg=channel.json_body)
1230
+ self.assertIn("delete_id", channel.json_body)
1231
+ delete_id = channel.json_body["delete_id"]
1232
+
1233
+ self._test_result(delete_id, self.other_user)
1234
+
1235
+ self._is_purged(self.room_id)
1236
+ self._is_blocked(self.room_id, expect=True)
1237
+ self._has_no_members(self.room_id)
1238
+
1239
+ def test_purge_room_and_not_block(self) -> None:
1240
+ """Test to purge a room and do not block it.
1241
+ Members will not be moved to a new room and will not receive a message.
1242
+ """
1243
+ # Test that room is not purged
1244
+ with self.assertRaises(AssertionError):
1245
+ self._is_purged(self.room_id)
1246
+
1247
+ # Test that room is not blocked
1248
+ self._is_blocked(self.room_id, expect=False)
1249
+
1250
+ # Assert one user in room
1251
+ self._is_member(room_id=self.room_id, user_id=self.other_user)
1252
+
1253
+ channel = self.make_request(
1254
+ "DELETE",
1255
+ self.url.encode("ascii"),
1256
+ content={"block": False, "purge": True},
1257
+ access_token=self.admin_user_tok,
1258
+ )
1259
+
1260
+ self.assertEqual(200, channel.code, msg=channel.json_body)
1261
+ self.assertIn("delete_id", channel.json_body)
1262
+ delete_id = channel.json_body["delete_id"]
1263
+
1264
+ self._test_result(delete_id, self.other_user)
1265
+
1266
+ self._is_purged(self.room_id)
1267
+ self._is_blocked(self.room_id, expect=False)
1268
+ self._has_no_members(self.room_id)
1269
+
1270
+ def test_block_room_and_not_purge(self) -> None:
1271
+ """Test to block a room without purging it.
1272
+ Members will not be moved to a new room and will not receive a message.
1273
+ The room will not be purged.
1274
+ """
1275
+ # Test that room is not purged
1276
+ with self.assertRaises(AssertionError):
1277
+ self._is_purged(self.room_id)
1278
+
1279
+ # Test that room is not blocked
1280
+ self._is_blocked(self.room_id, expect=False)
1281
+
1282
+ # Assert one user in room
1283
+ self._is_member(room_id=self.room_id, user_id=self.other_user)
1284
+
1285
+ channel = self.make_request(
1286
+ "DELETE",
1287
+ self.url.encode("ascii"),
1288
+ content={"block": True, "purge": False},
1289
+ access_token=self.admin_user_tok,
1290
+ )
1291
+
1292
+ self.assertEqual(200, channel.code, msg=channel.json_body)
1293
+ self.assertIn("delete_id", channel.json_body)
1294
+ delete_id = channel.json_body["delete_id"]
1295
+
1296
+ self._test_result(delete_id, self.other_user)
1297
+
1298
+ with self.assertRaises(AssertionError):
1299
+ self._is_purged(self.room_id)
1300
+ self._is_blocked(self.room_id, expect=True)
1301
+ self._has_no_members(self.room_id)
1302
+
1303
+ def test_shutdown_room_consent(self) -> None:
1304
+ """Test that we can shutdown rooms with local users who have not
1305
+ yet accepted the privacy policy. This used to fail when we tried to
1306
+ force part the user from the old room.
1307
+ Members will be moved to a new room and will receive a message.
1308
+ """
1309
+ self.event_creation_handler._block_events_without_consent_error = None
1310
+
1311
+ # Assert one user in room
1312
+ users_in_room = self.get_success(self.store.get_users_in_room(self.room_id))
1313
+ self.assertEqual([self.other_user], users_in_room)
1314
+
1315
+ # Enable require consent to send events
1316
+ self.event_creation_handler._block_events_without_consent_error = "Error"
1317
+
1318
+ # Assert that the user is getting consent error
1319
+ self.helper.send(
1320
+ self.room_id,
1321
+ body="foo",
1322
+ tok=self.other_user_tok,
1323
+ expect_code=403,
1324
+ )
1325
+
1326
+ # Test that room is not purged
1327
+ with self.assertRaises(AssertionError):
1328
+ self._is_purged(self.room_id)
1329
+
1330
+ # Assert one user in room
1331
+ self._is_member(room_id=self.room_id, user_id=self.other_user)
1332
+
1333
+ # Test that the admin can still send shutdown
1334
+ channel = self.make_request(
1335
+ "DELETE",
1336
+ self.url,
1337
+ content={"new_room_user_id": self.admin_user},
1338
+ access_token=self.admin_user_tok,
1339
+ )
1340
+
1341
+ self.assertEqual(200, channel.code, msg=channel.json_body)
1342
+ self.assertIn("delete_id", channel.json_body)
1343
+ delete_id = channel.json_body["delete_id"]
1344
+
1345
+ self._test_result(delete_id, self.other_user, expect_new_room=True)
1346
+
1347
+ channel = self.make_request(
1348
+ "GET",
1349
+ self.url_status_by_room_id,
1350
+ access_token=self.admin_user_tok,
1351
+ )
1352
+ self.assertEqual(200, channel.code, msg=channel.json_body)
1353
+ self.assertEqual(1, len(channel.json_body["results"]))
1354
+
1355
+ # Test that member has moved to new room
1356
+ self._is_member(
1357
+ room_id=channel.json_body["results"][0]["shutdown_room"]["new_room_id"],
1358
+ user_id=self.other_user,
1359
+ )
1360
+
1361
+ self._is_purged(self.room_id)
1362
+ self._has_no_members(self.room_id)
1363
+
1364
+ def test_shutdown_room_block_peek(self) -> None:
1365
+ """Test that a world_readable room can no longer be peeked into after
1366
+ it has been shut down.
1367
+ Members will be moved to a new room and will receive a message.
1368
+ """
1369
+ self.event_creation_handler._block_events_without_consent_error = None
1370
+
1371
+ # Enable world readable
1372
+ url = "rooms/%s/state/m.room.history_visibility" % (self.room_id,)
1373
+ channel = self.make_request(
1374
+ "PUT",
1375
+ url.encode("ascii"),
1376
+ content={"history_visibility": "world_readable"},
1377
+ access_token=self.other_user_tok,
1378
+ )
1379
+ self.assertEqual(200, channel.code, msg=channel.json_body)
1380
+
1381
+ # Test that room is not purged
1382
+ with self.assertRaises(AssertionError):
1383
+ self._is_purged(self.room_id)
1384
+
1385
+ # Assert one user in room
1386
+ self._is_member(room_id=self.room_id, user_id=self.other_user)
1387
+
1388
+ # Test that the admin can still send shutdown
1389
+ channel = self.make_request(
1390
+ "DELETE",
1391
+ self.url,
1392
+ content={"new_room_user_id": self.admin_user},
1393
+ access_token=self.admin_user_tok,
1394
+ )
1395
+
1396
+ self.assertEqual(200, channel.code, msg=channel.json_body)
1397
+ self.assertIn("delete_id", channel.json_body)
1398
+ delete_id = channel.json_body["delete_id"]
1399
+
1400
+ self._test_result(delete_id, self.other_user, expect_new_room=True)
1401
+
1402
+ channel = self.make_request(
1403
+ "GET",
1404
+ self.url_status_by_room_id,
1405
+ access_token=self.admin_user_tok,
1406
+ )
1407
+ self.assertEqual(200, channel.code, msg=channel.json_body)
1408
+ self.assertEqual(1, len(channel.json_body["results"]))
1409
+
1410
+ # Test that member has moved to new room
1411
+ self._is_member(
1412
+ room_id=channel.json_body["results"][0]["shutdown_room"]["new_room_id"],
1413
+ user_id=self.other_user,
1414
+ )
1415
+
1416
+ self._is_purged(self.room_id)
1417
+ self._has_no_members(self.room_id)
1418
+
1419
+ # Assert we can no longer peek into the room
1420
+ self._assert_peek(self.room_id, expect_code=403)
1421
+
1422
+ @unittest.override_config({"forgotten_room_retention_period": "1d"})
1423
+ def test_purge_forgotten_room(self) -> None:
1424
+ # Create a test room
1425
+ room_id = self.helper.create_room_as(
1426
+ self.admin_user,
1427
+ tok=self.admin_user_tok,
1428
+ )
1429
+
1430
+ self.helper.leave(room_id, user=self.admin_user, tok=self.admin_user_tok)
1431
+ self.get_success(
1432
+ self.room_member_handler.forget(
1433
+ UserID.from_string(self.admin_user), room_id
1434
+ )
1435
+ )
1436
+
1437
+ # Test that room is not yet purged
1438
+ with self.assertRaises(AssertionError):
1439
+ self._is_purged(room_id)
1440
+
1441
+ # Advance 24 hours in the future, past the `forgotten_room_retention_period`
1442
+ self.reactor.advance(24 * ONE_HOUR_IN_S)
1443
+
1444
+ self._is_purged(room_id)
1445
+
1446
+ def test_scheduled_purge_room(self) -> None:
1447
+ # Create a test room
1448
+ room_id = self.helper.create_room_as(
1449
+ self.admin_user,
1450
+ tok=self.admin_user_tok,
1451
+ )
1452
+ self.helper.leave(room_id, user=self.admin_user, tok=self.admin_user_tok)
1453
+
1454
+ # Schedule a purge 10 seconds in the future
1455
+ self.get_success(
1456
+ self.task_scheduler.schedule_task(
1457
+ PURGE_ROOM_ACTION_NAME,
1458
+ resource_id=room_id,
1459
+ timestamp=self.clock.time_msec() + 10 * 1000,
1460
+ )
1461
+ )
1462
+
1463
+ # Test that room is not yet purged
1464
+ with self.assertRaises(AssertionError):
1465
+ self._is_purged(room_id)
1466
+
1467
+ # Wait for next scheduler run
1468
+ self.reactor.advance(TaskScheduler.SCHEDULE_INTERVAL.as_secs())
1469
+
1470
+ self._is_purged(room_id)
1471
+
1472
+ def test_schedule_shutdown_room(self) -> None:
1473
+ # Create a test room
1474
+ room_id = self.helper.create_room_as(
1475
+ self.other_user,
1476
+ tok=self.other_user_tok,
1477
+ )
1478
+
1479
+ # Schedule a shutdown 10 seconds in the future
1480
+ delete_id = self.get_success(
1481
+ self.task_scheduler.schedule_task(
1482
+ SHUTDOWN_AND_PURGE_ROOM_ACTION_NAME,
1483
+ resource_id=room_id,
1484
+ params={
1485
+ "requester_user_id": self.admin_user,
1486
+ "new_room_user_id": self.admin_user,
1487
+ "new_room_name": None,
1488
+ "message": None,
1489
+ "block": False,
1490
+ "purge": True,
1491
+ "force_purge": True,
1492
+ },
1493
+ timestamp=self.clock.time_msec() + 10 * 1000,
1494
+ )
1495
+ )
1496
+
1497
+ # Test that room is not yet shutdown
1498
+ self._is_member(room_id, self.other_user)
1499
+
1500
+ # Test that room is not yet purged
1501
+ with self.assertRaises(AssertionError):
1502
+ self._is_purged(room_id)
1503
+
1504
+ # Wait for next scheduler run
1505
+ self.reactor.advance(TaskScheduler.SCHEDULE_INTERVAL.as_secs())
1506
+
1507
+ # Test that all users has been kicked (room is shutdown)
1508
+ self._has_no_members(room_id)
1509
+
1510
+ self._is_purged(room_id)
1511
+
1512
+ # Retrieve delete results
1513
+ result = self.make_request(
1514
+ "GET",
1515
+ self.url_status_by_delete_id + delete_id,
1516
+ access_token=self.admin_user_tok,
1517
+ )
1518
+ self.assertEqual(200, result.code, msg=result.json_body)
1519
+
1520
+ # Check that the user is in kicked_users
1521
+ self.assertIn(
1522
+ self.other_user, result.json_body["shutdown_room"]["kicked_users"]
1523
+ )
1524
+
1525
+ new_room_id = result.json_body["shutdown_room"]["new_room_id"]
1526
+ self.assertTrue(new_room_id)
1527
+
1528
+ # Check that the user is actually in the new room
1529
+ self._is_member(new_room_id, self.other_user)
1530
+
1531
+ def _is_blocked(self, room_id: str, expect: bool = True) -> None:
1532
+ """Assert that the room is blocked or not"""
1533
+ d = self.store.is_room_blocked(room_id)
1534
+ if expect:
1535
+ self.assertTrue(self.get_success(d))
1536
+ else:
1537
+ self.assertIsNone(self.get_success(d))
1538
+
1539
+ def _has_no_members(self, room_id: str) -> None:
1540
+ """Assert there is now no longer anyone in the room"""
1541
+ users_in_room = self.get_success(self.store.get_users_in_room(room_id))
1542
+ self.assertEqual([], users_in_room)
1543
+
1544
+ def _is_member(self, room_id: str, user_id: str) -> None:
1545
+ """Test that user is member of the room"""
1546
+ users_in_room = self.get_success(self.store.get_users_in_room(room_id))
1547
+ self.assertIn(user_id, users_in_room)
1548
+
1549
+ def _is_purged(self, room_id: str) -> None:
1550
+ """Test that the following tables have been purged of all rows related to the room."""
1551
+ for table in purge_room_tables_with_room_id_column:
1552
+ count = self.get_success(
1553
+ self.store.db_pool.simple_select_one_onecol(
1554
+ table=table,
1555
+ keyvalues={"room_id": room_id},
1556
+ retcol="COUNT(*)",
1557
+ desc="test_purge_room",
1558
+ )
1559
+ )
1560
+ self.assertEqual(count, 0, msg=f"Rows not purged in {table}")
1561
+
1562
+ for table in purge_room_tables_with_event_id_index:
1563
+ rows = self.get_success(
1564
+ self.store.db_pool.execute(
1565
+ "find_event_count_for_table",
1566
+ f"""
1567
+ SELECT COUNT(*) FROM {table} WHERE event_id IN (
1568
+ SELECT event_id FROM events WHERE room_id=?
1569
+ )
1570
+ """,
1571
+ room_id,
1572
+ )
1573
+ )
1574
+ count = rows[0][0]
1575
+ self.assertEqual(count, 0, msg=f"Rows not purged in {table}")
1576
+
1577
+ def _assert_peek(self, room_id: str, expect_code: int) -> None:
1578
+ """Assert that the admin user can (or cannot) peek into the room."""
1579
+
1580
+ url = f"rooms/{room_id}/initialSync"
1581
+ channel = self.make_request(
1582
+ "GET", url.encode("ascii"), access_token=self.admin_user_tok
1583
+ )
1584
+ self.assertEqual(expect_code, channel.code, msg=channel.json_body)
1585
+
1586
+ url = "events?timeout=0&room_id=" + room_id
1587
+ channel = self.make_request(
1588
+ "GET", url.encode("ascii"), access_token=self.admin_user_tok
1589
+ )
1590
+ self.assertEqual(expect_code, channel.code, msg=channel.json_body)
1591
+
1592
+ def _test_result(
1593
+ self,
1594
+ delete_id: str,
1595
+ kicked_user: str,
1596
+ expect_new_room: bool = False,
1597
+ ) -> None:
1598
+ """
1599
+ Test that the result is the expected.
1600
+ Uses both APIs (status by room_id and delete_id)
1601
+
1602
+ Args:
1603
+ delete_id: id of this purge
1604
+ kicked_user: a user_id which is kicked from the room
1605
+ expect_new_room: if we expect that a new room was created
1606
+ """
1607
+ # get information by room_id
1608
+ channel_room_id = self.make_request(
1609
+ "GET",
1610
+ self.url_status_by_room_id,
1611
+ access_token=self.admin_user_tok,
1612
+ )
1613
+ self.assertEqual(200, channel_room_id.code, msg=channel_room_id.json_body)
1614
+ self.assertEqual(1, len(channel_room_id.json_body["results"]))
1615
+ self.assertEqual(
1616
+ delete_id, channel_room_id.json_body["results"][0]["delete_id"]
1617
+ )
1618
+ self.assertEqual(
1619
+ self.room_id, channel_room_id.json_body["results"][0]["room_id"]
1620
+ )
1621
+
1622
+ # get information by delete_id
1623
+ channel_delete_id = self.make_request(
1624
+ "GET",
1625
+ self.url_status_by_delete_id + delete_id,
1626
+ access_token=self.admin_user_tok,
1627
+ )
1628
+ self.assertEqual(
1629
+ 200,
1630
+ channel_delete_id.code,
1631
+ msg=channel_delete_id.json_body,
1632
+ )
1633
+ self.assertEqual(self.room_id, channel_delete_id.json_body["room_id"])
1634
+
1635
+ # test values that are the same in both responses
1636
+ for content in [
1637
+ channel_room_id.json_body["results"][0],
1638
+ channel_delete_id.json_body,
1639
+ ]:
1640
+ self.assertEqual("complete", content["status"])
1641
+ self.assertEqual(kicked_user, content["shutdown_room"]["kicked_users"][0])
1642
+ self.assertIn("failed_to_kick_users", content["shutdown_room"])
1643
+ self.assertIn("local_aliases", content["shutdown_room"])
1644
+ self.assertNotIn("error", content)
1645
+
1646
+ if expect_new_room:
1647
+ self.assertIsNotNone(content["shutdown_room"]["new_room_id"])
1648
+ else:
1649
+ self.assertIsNone(content["shutdown_room"]["new_room_id"])
1650
+
1651
+
1652
+ class RoomTestCase(unittest.HomeserverTestCase):
1653
+ """Test /room admin API."""
1654
+
1655
+ servlets = [
1656
+ synapse.rest.admin.register_servlets,
1657
+ login.register_servlets,
1658
+ room.register_servlets,
1659
+ directory.register_servlets,
1660
+ ]
1661
+
1662
+ def prepare(self, reactor: MemoryReactor, clock: Clock, hs: HomeServer) -> None:
1663
+ # Create user
1664
+ self.admin_user = self.register_user("admin", "pass", admin=True)
1665
+ self.admin_user_tok = self.login("admin", "pass")
1666
+
1667
+ @unittest.override_config({"room_list_publication_rules": [{"action": "allow"}]})
1668
+ def test_list_rooms(self) -> None:
1669
+ """Test that we can list rooms"""
1670
+ # Create 3 test rooms
1671
+ total_rooms = 3
1672
+ room_ids = []
1673
+ for _ in range(total_rooms):
1674
+ room_id = self.helper.create_room_as(
1675
+ self.admin_user,
1676
+ tok=self.admin_user_tok,
1677
+ is_public=True,
1678
+ )
1679
+ room_ids.append(room_id)
1680
+
1681
+ room_ids.sort()
1682
+
1683
+ # Request the list of rooms
1684
+ url = "/_synapse/admin/v1/rooms"
1685
+ channel = self.make_request(
1686
+ "GET",
1687
+ url.encode("ascii"),
1688
+ access_token=self.admin_user_tok,
1689
+ )
1690
+
1691
+ # Check request completed successfully
1692
+ self.assertEqual(200, channel.code, msg=channel.json_body)
1693
+
1694
+ # Check that response json body contains a "rooms" key
1695
+ self.assertTrue(
1696
+ "rooms" in channel.json_body,
1697
+ msg="Response body does not contain a 'rooms' key",
1698
+ )
1699
+
1700
+ # Check that 3 rooms were returned
1701
+ self.assertEqual(3, len(channel.json_body["rooms"]), msg=channel.json_body)
1702
+
1703
+ # Check their room_ids match
1704
+ returned_room_ids = [room["room_id"] for room in channel.json_body["rooms"]]
1705
+ self.assertEqual(room_ids, returned_room_ids)
1706
+
1707
+ # Check that all fields are available
1708
+ for r in channel.json_body["rooms"]:
1709
+ self.assertIn("name", r)
1710
+ self.assertIn("canonical_alias", r)
1711
+ self.assertIn("joined_members", r)
1712
+ self.assertIn("joined_local_members", r)
1713
+ self.assertIn("version", r)
1714
+ self.assertIn("creator", r)
1715
+ self.assertIn("encryption", r)
1716
+ self.assertIs(r["federatable"], True)
1717
+ self.assertIs(r["public"], True)
1718
+ self.assertIn("join_rules", r)
1719
+ self.assertIn("guest_access", r)
1720
+ self.assertIn("history_visibility", r)
1721
+ self.assertIn("state_events", r)
1722
+ self.assertIn("room_type", r)
1723
+ self.assertIsNone(r["room_type"])
1724
+
1725
+ # Check that the correct number of total rooms was returned
1726
+ self.assertEqual(channel.json_body["total_rooms"], total_rooms)
1727
+
1728
+ # Check that the offset is correct
1729
+ # Should be 0 as we aren't paginating
1730
+ self.assertEqual(channel.json_body["offset"], 0)
1731
+
1732
+ # Check that the prev_batch parameter is not present
1733
+ self.assertNotIn("prev_batch", channel.json_body)
1734
+
1735
+ # We shouldn't receive a next token here as there's no further rooms to show
1736
+ self.assertNotIn("next_batch", channel.json_body)
1737
+
1738
+ def test_list_rooms_pagination(self) -> None:
1739
+ """Test that we can get a full list of rooms through pagination"""
1740
+ # Create 5 test rooms
1741
+ total_rooms = 5
1742
+ room_ids = []
1743
+ for _ in range(total_rooms):
1744
+ room_id = self.helper.create_room_as(
1745
+ self.admin_user, tok=self.admin_user_tok
1746
+ )
1747
+ room_ids.append(room_id)
1748
+
1749
+ # Set the name of the rooms so we get a consistent returned ordering
1750
+ for idx, room_id in enumerate(room_ids):
1751
+ self.helper.send_state(
1752
+ room_id,
1753
+ "m.room.name",
1754
+ {"name": str(idx)},
1755
+ tok=self.admin_user_tok,
1756
+ )
1757
+
1758
+ # Request the list of rooms
1759
+ returned_room_ids = []
1760
+ start = 0
1761
+ limit = 2
1762
+
1763
+ run_count = 0
1764
+ should_repeat = True
1765
+ while should_repeat:
1766
+ run_count += 1
1767
+
1768
+ url = "/_synapse/admin/v1/rooms?from=%d&limit=%d&order_by=%s" % (
1769
+ start,
1770
+ limit,
1771
+ "name",
1772
+ )
1773
+ channel = self.make_request(
1774
+ "GET",
1775
+ url.encode("ascii"),
1776
+ access_token=self.admin_user_tok,
1777
+ )
1778
+ self.assertEqual(200, channel.code, msg=channel.json_body)
1779
+
1780
+ self.assertTrue("rooms" in channel.json_body)
1781
+ for r in channel.json_body["rooms"]:
1782
+ returned_room_ids.append(r["room_id"])
1783
+
1784
+ # Check that the correct number of total rooms was returned
1785
+ self.assertEqual(channel.json_body["total_rooms"], total_rooms)
1786
+
1787
+ # Check that the offset is correct
1788
+ # We're only getting 2 rooms each page, so should be 2 * last run_count
1789
+ self.assertEqual(channel.json_body["offset"], 2 * (run_count - 1))
1790
+
1791
+ if run_count > 1:
1792
+ # Check the value of prev_batch is correct
1793
+ self.assertEqual(channel.json_body["prev_batch"], 2 * (run_count - 2))
1794
+
1795
+ if "next_batch" not in channel.json_body:
1796
+ # We have reached the end of the list
1797
+ should_repeat = False
1798
+ else:
1799
+ # Make another query with an updated start value
1800
+ start = channel.json_body["next_batch"]
1801
+
1802
+ # We should've queried the endpoint 3 times
1803
+ self.assertEqual(
1804
+ run_count,
1805
+ 3,
1806
+ msg="Should've queried 3 times for 5 rooms with limit 2 per query",
1807
+ )
1808
+
1809
+ # Check that we received all of the room ids
1810
+ self.assertEqual(room_ids, returned_room_ids)
1811
+
1812
+ url = "/_synapse/admin/v1/rooms?from=%d&limit=%d" % (start, limit)
1813
+ channel = self.make_request(
1814
+ "GET",
1815
+ url.encode("ascii"),
1816
+ access_token=self.admin_user_tok,
1817
+ )
1818
+ self.assertEqual(200, channel.code, msg=channel.json_body)
1819
+
1820
+ def test_correct_room_attributes(self) -> None:
1821
+ """Test the correct attributes for a room are returned"""
1822
+ # Create a test room
1823
+ room_id = self.helper.create_room_as(
1824
+ self.admin_user,
1825
+ tok=self.admin_user_tok,
1826
+ extra_content={"creation_content": {"type": RoomTypes.SPACE}},
1827
+ )
1828
+
1829
+ test_alias = "#test:test"
1830
+ test_room_name = "something"
1831
+
1832
+ # Have another user join the room
1833
+ user_2 = self.register_user("user4", "pass")
1834
+ user_tok_2 = self.login("user4", "pass")
1835
+ self.helper.join(room_id, user_2, tok=user_tok_2)
1836
+
1837
+ # Create a new alias to this room
1838
+ url = "/_matrix/client/r0/directory/room/%s" % (urllib.parse.quote(test_alias),)
1839
+ channel = self.make_request(
1840
+ "PUT",
1841
+ url.encode("ascii"),
1842
+ {"room_id": room_id},
1843
+ access_token=self.admin_user_tok,
1844
+ )
1845
+ self.assertEqual(200, channel.code, msg=channel.json_body)
1846
+
1847
+ # Set this new alias as the canonical alias for this room
1848
+ self.helper.send_state(
1849
+ room_id,
1850
+ "m.room.aliases",
1851
+ {"aliases": [test_alias]},
1852
+ tok=self.admin_user_tok,
1853
+ state_key="test",
1854
+ )
1855
+ self.helper.send_state(
1856
+ room_id,
1857
+ "m.room.canonical_alias",
1858
+ {"alias": test_alias},
1859
+ tok=self.admin_user_tok,
1860
+ )
1861
+
1862
+ # Set a name for the room
1863
+ self.helper.send_state(
1864
+ room_id,
1865
+ "m.room.name",
1866
+ {"name": test_room_name},
1867
+ tok=self.admin_user_tok,
1868
+ )
1869
+
1870
+ # Request the list of rooms
1871
+ url = "/_synapse/admin/v1/rooms"
1872
+ channel = self.make_request(
1873
+ "GET",
1874
+ url.encode("ascii"),
1875
+ access_token=self.admin_user_tok,
1876
+ )
1877
+ self.assertEqual(200, channel.code, msg=channel.json_body)
1878
+
1879
+ # Check that rooms were returned
1880
+ self.assertTrue("rooms" in channel.json_body)
1881
+ rooms = channel.json_body["rooms"]
1882
+
1883
+ # Check that only one room was returned
1884
+ self.assertEqual(len(rooms), 1)
1885
+
1886
+ # And that the value of the total_rooms key was correct
1887
+ self.assertEqual(channel.json_body["total_rooms"], 1)
1888
+
1889
+ # Check that the offset is correct
1890
+ # We're not paginating, so should be 0
1891
+ self.assertEqual(channel.json_body["offset"], 0)
1892
+
1893
+ # Check that there is no `prev_batch`
1894
+ self.assertNotIn("prev_batch", channel.json_body)
1895
+
1896
+ # Check that there is no `next_batch`
1897
+ self.assertNotIn("next_batch", channel.json_body)
1898
+
1899
+ # Check that all provided attributes are set
1900
+ r = rooms[0]
1901
+ self.assertEqual(room_id, r["room_id"])
1902
+ self.assertEqual(test_room_name, r["name"])
1903
+ self.assertEqual(test_alias, r["canonical_alias"])
1904
+ self.assertEqual(RoomTypes.SPACE, r["room_type"])
1905
+
1906
+ def test_room_list_sort_order(self) -> None:
1907
+ """Test room list sort ordering. alphabetical name versus number of members,
1908
+ reversing the order, etc.
1909
+ """
1910
+
1911
+ def _order_test(
1912
+ order_type: str,
1913
+ expected_room_list: list[str],
1914
+ reverse: bool = False,
1915
+ ) -> None:
1916
+ """Request the list of rooms in a certain order. Assert that order is what
1917
+ we expect
1918
+
1919
+ Args:
1920
+ order_type: The type of ordering to give the server
1921
+ expected_room_list: The list of room_ids in the order we expect to get
1922
+ back from the server
1923
+ """
1924
+ # Request the list of rooms in the given order
1925
+ url = "/_synapse/admin/v1/rooms?order_by=%s" % (order_type,)
1926
+ if reverse:
1927
+ url += "&dir=b"
1928
+ channel = self.make_request(
1929
+ "GET",
1930
+ url.encode("ascii"),
1931
+ access_token=self.admin_user_tok,
1932
+ )
1933
+ self.assertEqual(200, channel.code, msg=channel.json_body)
1934
+
1935
+ # Check that rooms were returned
1936
+ self.assertTrue("rooms" in channel.json_body)
1937
+ rooms = channel.json_body["rooms"]
1938
+
1939
+ # Check for the correct total_rooms value
1940
+ self.assertEqual(channel.json_body["total_rooms"], 3)
1941
+
1942
+ # Check that the offset is correct
1943
+ # We're not paginating, so should be 0
1944
+ self.assertEqual(channel.json_body["offset"], 0)
1945
+
1946
+ # Check that there is no `prev_batch`
1947
+ self.assertNotIn("prev_batch", channel.json_body)
1948
+
1949
+ # Check that there is no `next_batch`
1950
+ self.assertNotIn("next_batch", channel.json_body)
1951
+
1952
+ # Check that rooms were returned in alphabetical order
1953
+ returned_order = [r["room_id"] for r in rooms]
1954
+ self.assertListEqual(expected_room_list, returned_order) # order is checked
1955
+
1956
+ # Create 3 test rooms
1957
+ room_id_1 = self.helper.create_room_as(self.admin_user, tok=self.admin_user_tok)
1958
+ room_id_2 = self.helper.create_room_as(self.admin_user, tok=self.admin_user_tok)
1959
+ room_id_3 = self.helper.create_room_as(self.admin_user, tok=self.admin_user_tok)
1960
+
1961
+ # Also create a list sorted by IDs for properties that are equal (and thus sorted by room_id)
1962
+ sorted_by_room_id_asc = [room_id_1, room_id_2, room_id_3]
1963
+ sorted_by_room_id_asc.sort()
1964
+ sorted_by_room_id_desc = sorted_by_room_id_asc.copy()
1965
+ sorted_by_room_id_desc.reverse()
1966
+
1967
+ # Set room names in alphabetical order. room 1 -> A, 2 -> B, 3 -> C
1968
+ self.helper.send_state(
1969
+ room_id_1,
1970
+ "m.room.name",
1971
+ {"name": "A"},
1972
+ tok=self.admin_user_tok,
1973
+ )
1974
+ self.helper.send_state(
1975
+ room_id_2,
1976
+ "m.room.name",
1977
+ {"name": "B"},
1978
+ tok=self.admin_user_tok,
1979
+ )
1980
+ self.helper.send_state(
1981
+ room_id_3,
1982
+ "m.room.name",
1983
+ {"name": "C"},
1984
+ tok=self.admin_user_tok,
1985
+ )
1986
+
1987
+ # Set room canonical room aliases
1988
+ self._set_canonical_alias(room_id_1, "#A_alias:test", self.admin_user_tok)
1989
+ self._set_canonical_alias(room_id_2, "#B_alias:test", self.admin_user_tok)
1990
+ self._set_canonical_alias(room_id_3, "#C_alias:test", self.admin_user_tok)
1991
+
1992
+ # Set room member size in the reverse order. room 1 -> 1 member, 2 -> 2, 3 -> 3
1993
+ user_1 = self.register_user("bob1", "pass")
1994
+ user_1_tok = self.login("bob1", "pass")
1995
+ self.helper.join(room_id_2, user_1, tok=user_1_tok)
1996
+
1997
+ user_2 = self.register_user("bob2", "pass")
1998
+ user_2_tok = self.login("bob2", "pass")
1999
+ self.helper.join(room_id_3, user_2, tok=user_2_tok)
2000
+
2001
+ user_3 = self.register_user("bob3", "pass")
2002
+ user_3_tok = self.login("bob3", "pass")
2003
+ self.helper.join(room_id_3, user_3, tok=user_3_tok)
2004
+
2005
+ # Test different sort orders, with forward and reverse directions
2006
+ _order_test("name", [room_id_1, room_id_2, room_id_3])
2007
+ _order_test("name", [room_id_3, room_id_2, room_id_1], reverse=True)
2008
+
2009
+ _order_test("canonical_alias", [room_id_1, room_id_2, room_id_3])
2010
+ _order_test("canonical_alias", [room_id_3, room_id_2, room_id_1], reverse=True)
2011
+
2012
+ # Note: joined_member counts are sorted in descending order when dir=f
2013
+ _order_test("joined_members", [room_id_3, room_id_2, room_id_1])
2014
+ _order_test("joined_members", [room_id_1, room_id_2, room_id_3], reverse=True)
2015
+
2016
+ # Note: joined_local_member counts are sorted in descending order when dir=f
2017
+ _order_test("joined_local_members", [room_id_3, room_id_2, room_id_1])
2018
+ _order_test(
2019
+ "joined_local_members", [room_id_1, room_id_2, room_id_3], reverse=True
2020
+ )
2021
+
2022
+ # Note: versions are sorted in descending order when dir=f
2023
+ _order_test("version", sorted_by_room_id_asc, reverse=True)
2024
+ _order_test("version", sorted_by_room_id_desc)
2025
+
2026
+ _order_test("creator", sorted_by_room_id_asc)
2027
+ _order_test("creator", sorted_by_room_id_desc, reverse=True)
2028
+
2029
+ _order_test("encryption", sorted_by_room_id_asc)
2030
+ _order_test("encryption", sorted_by_room_id_desc, reverse=True)
2031
+
2032
+ _order_test("federatable", sorted_by_room_id_asc)
2033
+ _order_test("federatable", sorted_by_room_id_desc, reverse=True)
2034
+
2035
+ _order_test("public", sorted_by_room_id_asc)
2036
+ _order_test("public", sorted_by_room_id_desc, reverse=True)
2037
+
2038
+ _order_test("join_rules", sorted_by_room_id_asc)
2039
+ _order_test("join_rules", sorted_by_room_id_desc, reverse=True)
2040
+
2041
+ _order_test("guest_access", sorted_by_room_id_asc)
2042
+ _order_test("guest_access", sorted_by_room_id_desc, reverse=True)
2043
+
2044
+ _order_test("history_visibility", sorted_by_room_id_asc)
2045
+ _order_test("history_visibility", sorted_by_room_id_desc, reverse=True)
2046
+
2047
+ # Note: state_event counts are sorted in descending order when dir=f
2048
+ _order_test("state_events", [room_id_3, room_id_2, room_id_1])
2049
+ _order_test("state_events", [room_id_1, room_id_2, room_id_3], reverse=True)
2050
+
2051
+ def test_search_term(self) -> None:
2052
+ """Test that searching for a room works correctly"""
2053
+ # Create two test rooms
2054
+ room_id_1 = self.helper.create_room_as(self.admin_user, tok=self.admin_user_tok)
2055
+ room_id_2 = self.helper.create_room_as(self.admin_user, tok=self.admin_user_tok)
2056
+
2057
+ room_name_1 = "something"
2058
+ room_name_2 = "LoremIpsum"
2059
+
2060
+ # Set the name for each room
2061
+ self.helper.send_state(
2062
+ room_id_1,
2063
+ "m.room.name",
2064
+ {"name": room_name_1},
2065
+ tok=self.admin_user_tok,
2066
+ )
2067
+ self.helper.send_state(
2068
+ room_id_2,
2069
+ "m.room.name",
2070
+ {"name": room_name_2},
2071
+ tok=self.admin_user_tok,
2072
+ )
2073
+
2074
+ self._set_canonical_alias(room_id_1, "#Room_Alias1:test", self.admin_user_tok)
2075
+
2076
+ def _search_test(
2077
+ expected_room_id: str | None,
2078
+ search_term: str,
2079
+ expected_http_code: int = 200,
2080
+ ) -> None:
2081
+ """Search for a room and check that the returned room's id is a match
2082
+
2083
+ Args:
2084
+ expected_room_id: The room_id expected to be returned by the API. Set
2085
+ to None to expect zero results for the search
2086
+ search_term: The term to search for room names with
2087
+ expected_http_code: The expected http code for the request
2088
+ """
2089
+ url = "/_synapse/admin/v1/rooms?search_term=%s" % (search_term,)
2090
+ channel = self.make_request(
2091
+ "GET",
2092
+ url.encode("ascii"),
2093
+ access_token=self.admin_user_tok,
2094
+ )
2095
+ self.assertEqual(expected_http_code, channel.code, msg=channel.json_body)
2096
+
2097
+ if expected_http_code != 200:
2098
+ return
2099
+
2100
+ # Check that rooms were returned
2101
+ self.assertTrue("rooms" in channel.json_body)
2102
+ rooms = channel.json_body["rooms"]
2103
+
2104
+ # Check that the expected number of rooms were returned
2105
+ expected_room_count = 1 if expected_room_id else 0
2106
+ self.assertEqual(len(rooms), expected_room_count)
2107
+ self.assertEqual(channel.json_body["total_rooms"], expected_room_count)
2108
+
2109
+ # Check that the offset is correct
2110
+ # We're not paginating, so should be 0
2111
+ self.assertEqual(channel.json_body["offset"], 0)
2112
+
2113
+ # Check that there is no `prev_batch`
2114
+ self.assertNotIn("prev_batch", channel.json_body)
2115
+
2116
+ # Check that there is no `next_batch`
2117
+ self.assertNotIn("next_batch", channel.json_body)
2118
+
2119
+ if expected_room_id:
2120
+ # Check that the first returned room id is correct
2121
+ r = rooms[0]
2122
+ self.assertEqual(expected_room_id, r["room_id"])
2123
+
2124
+ # Test searching by room name
2125
+ _search_test(room_id_1, "something")
2126
+ _search_test(room_id_1, "thing")
2127
+
2128
+ _search_test(room_id_2, "LoremIpsum")
2129
+ _search_test(room_id_2, "lorem")
2130
+
2131
+ # Test case insensitive
2132
+ _search_test(room_id_1, "SOMETHING")
2133
+ _search_test(room_id_1, "THING")
2134
+
2135
+ _search_test(room_id_2, "LOREMIPSUM")
2136
+ _search_test(room_id_2, "LOREM")
2137
+
2138
+ _search_test(None, "foo")
2139
+ _search_test(None, "bar")
2140
+ _search_test(None, "", expected_http_code=400)
2141
+
2142
+ # Test that the whole room id returns the room
2143
+ _search_test(room_id_1, room_id_1)
2144
+ # Test that the search by room_id is case sensitive
2145
+ _search_test(None, room_id_1.lower())
2146
+ # Test search part of local part of room id do not match
2147
+ _search_test(None, room_id_1[1:10])
2148
+
2149
+ # Test that whole room alias return no result, because of domain
2150
+ _search_test(None, "#Room_Alias1:test")
2151
+ # Test search local part of alias
2152
+ _search_test(room_id_1, "alias1")
2153
+
2154
+ def test_search_term_non_ascii(self) -> None:
2155
+ """Test that searching for a room with non-ASCII characters works correctly"""
2156
+
2157
+ # Create test room
2158
+ room_id = self.helper.create_room_as(self.admin_user, tok=self.admin_user_tok)
2159
+ room_name = "ж"
2160
+
2161
+ # Set the name for the room
2162
+ self.helper.send_state(
2163
+ room_id,
2164
+ "m.room.name",
2165
+ {"name": room_name},
2166
+ tok=self.admin_user_tok,
2167
+ )
2168
+
2169
+ # make the request and test that the response is what we wanted
2170
+ search_term = urllib.parse.quote("ж", "utf-8")
2171
+ url = "/_synapse/admin/v1/rooms?search_term=%s" % (search_term,)
2172
+ channel = self.make_request(
2173
+ "GET",
2174
+ url.encode("ascii"),
2175
+ access_token=self.admin_user_tok,
2176
+ )
2177
+ self.assertEqual(200, channel.code, msg=channel.json_body)
2178
+ self.assertEqual(room_id, channel.json_body["rooms"][0].get("room_id"))
2179
+ self.assertEqual("ж", channel.json_body["rooms"][0].get("name"))
2180
+
2181
+ @unittest.override_config({"room_list_publication_rules": [{"action": "allow"}]})
2182
+ def test_filter_public_rooms(self) -> None:
2183
+ self.helper.create_room_as(
2184
+ self.admin_user, tok=self.admin_user_tok, is_public=True
2185
+ )
2186
+ self.helper.create_room_as(
2187
+ self.admin_user, tok=self.admin_user_tok, is_public=True
2188
+ )
2189
+ self.helper.create_room_as(
2190
+ self.admin_user, tok=self.admin_user_tok, is_public=False
2191
+ )
2192
+
2193
+ response = self.make_request(
2194
+ "GET",
2195
+ "/_synapse/admin/v1/rooms",
2196
+ access_token=self.admin_user_tok,
2197
+ )
2198
+ self.assertEqual(200, response.code, msg=response.json_body)
2199
+ self.assertEqual(3, response.json_body["total_rooms"])
2200
+ self.assertEqual(3, len(response.json_body["rooms"]))
2201
+
2202
+ response = self.make_request(
2203
+ "GET",
2204
+ "/_synapse/admin/v1/rooms?public_rooms=true",
2205
+ access_token=self.admin_user_tok,
2206
+ )
2207
+ self.assertEqual(200, response.code, msg=response.json_body)
2208
+ self.assertEqual(2, response.json_body["total_rooms"])
2209
+ self.assertEqual(2, len(response.json_body["rooms"]))
2210
+
2211
+ response = self.make_request(
2212
+ "GET",
2213
+ "/_synapse/admin/v1/rooms?public_rooms=false",
2214
+ access_token=self.admin_user_tok,
2215
+ )
2216
+ self.assertEqual(200, response.code, msg=response.json_body)
2217
+ self.assertEqual(1, response.json_body["total_rooms"])
2218
+ self.assertEqual(1, len(response.json_body["rooms"]))
2219
+
2220
+ def test_filter_empty_rooms(self) -> None:
2221
+ self.helper.create_room_as(
2222
+ self.admin_user, tok=self.admin_user_tok, is_public=True
2223
+ )
2224
+ self.helper.create_room_as(
2225
+ self.admin_user, tok=self.admin_user_tok, is_public=True
2226
+ )
2227
+ room_id = self.helper.create_room_as(
2228
+ self.admin_user, tok=self.admin_user_tok, is_public=False
2229
+ )
2230
+ self.helper.leave(room_id, self.admin_user, tok=self.admin_user_tok)
2231
+
2232
+ response = self.make_request(
2233
+ "GET",
2234
+ "/_synapse/admin/v1/rooms",
2235
+ access_token=self.admin_user_tok,
2236
+ )
2237
+ self.assertEqual(200, response.code, msg=response.json_body)
2238
+ self.assertEqual(3, response.json_body["total_rooms"])
2239
+ self.assertEqual(3, len(response.json_body["rooms"]))
2240
+
2241
+ response = self.make_request(
2242
+ "GET",
2243
+ "/_synapse/admin/v1/rooms?empty_rooms=false",
2244
+ access_token=self.admin_user_tok,
2245
+ )
2246
+ self.assertEqual(200, response.code, msg=response.json_body)
2247
+ self.assertEqual(2, response.json_body["total_rooms"])
2248
+ self.assertEqual(2, len(response.json_body["rooms"]))
2249
+
2250
+ response = self.make_request(
2251
+ "GET",
2252
+ "/_synapse/admin/v1/rooms?empty_rooms=true",
2253
+ access_token=self.admin_user_tok,
2254
+ )
2255
+ self.assertEqual(200, response.code, msg=response.json_body)
2256
+ self.assertEqual(1, response.json_body["total_rooms"])
2257
+ self.assertEqual(1, len(response.json_body["rooms"]))
2258
+
2259
+ @unittest.override_config({"room_list_publication_rules": [{"action": "allow"}]})
2260
+ def test_single_room(self) -> None:
2261
+ """Test that a single room can be requested correctly"""
2262
+ # Create two test rooms
2263
+ room_id_1 = self.helper.create_room_as(
2264
+ self.admin_user, tok=self.admin_user_tok, is_public=True
2265
+ )
2266
+ room_id_2 = self.helper.create_room_as(
2267
+ self.admin_user, tok=self.admin_user_tok, is_public=False
2268
+ )
2269
+
2270
+ room_name_1 = "something"
2271
+ room_name_2 = "else"
2272
+
2273
+ # Set the name for each room
2274
+ self.helper.send_state(
2275
+ room_id_1,
2276
+ "m.room.name",
2277
+ {"name": room_name_1},
2278
+ tok=self.admin_user_tok,
2279
+ )
2280
+ self.helper.send_state(
2281
+ room_id_2,
2282
+ "m.room.name",
2283
+ {"name": room_name_2},
2284
+ tok=self.admin_user_tok,
2285
+ )
2286
+
2287
+ url = "/_synapse/admin/v1/rooms/%s" % (room_id_1,)
2288
+ channel = self.make_request(
2289
+ "GET",
2290
+ url.encode("ascii"),
2291
+ access_token=self.admin_user_tok,
2292
+ )
2293
+ self.assertEqual(200, channel.code, msg=channel.json_body)
2294
+
2295
+ self.assertIn("room_id", channel.json_body)
2296
+ self.assertIn("name", channel.json_body)
2297
+ self.assertIn("topic", channel.json_body)
2298
+ self.assertIn("avatar", channel.json_body)
2299
+ self.assertIn("canonical_alias", channel.json_body)
2300
+ self.assertIn("joined_members", channel.json_body)
2301
+ self.assertIn("joined_local_members", channel.json_body)
2302
+ self.assertIn("joined_local_devices", channel.json_body)
2303
+ self.assertIn("version", channel.json_body)
2304
+ self.assertIn("creator", channel.json_body)
2305
+ self.assertIn("encryption", channel.json_body)
2306
+ self.assertIn("federatable", channel.json_body)
2307
+ self.assertIn("public", channel.json_body)
2308
+ self.assertIn("join_rules", channel.json_body)
2309
+ self.assertIn("guest_access", channel.json_body)
2310
+ self.assertIn("history_visibility", channel.json_body)
2311
+ self.assertIn("state_events", channel.json_body)
2312
+ self.assertIn("room_type", channel.json_body)
2313
+ self.assertIn("forgotten", channel.json_body)
2314
+
2315
+ self.assertEqual(room_id_1, channel.json_body["room_id"])
2316
+ self.assertIs(True, channel.json_body["federatable"])
2317
+ self.assertIs(True, channel.json_body["public"])
2318
+
2319
+ def test_single_room_devices(self) -> None:
2320
+ """Test that `joined_local_devices` can be requested correctly"""
2321
+ room_id_1 = self.helper.create_room_as(self.admin_user, tok=self.admin_user_tok)
2322
+
2323
+ url = "/_synapse/admin/v1/rooms/%s" % (room_id_1,)
2324
+ channel = self.make_request(
2325
+ "GET",
2326
+ url.encode("ascii"),
2327
+ access_token=self.admin_user_tok,
2328
+ )
2329
+ self.assertEqual(200, channel.code, msg=channel.json_body)
2330
+ self.assertEqual(1, channel.json_body["joined_local_devices"])
2331
+
2332
+ # Have another user join the room
2333
+ user_1 = self.register_user("foo", "pass")
2334
+ user_tok_1 = self.login("foo", "pass")
2335
+ self.helper.join(room_id_1, user_1, tok=user_tok_1)
2336
+
2337
+ url = "/_synapse/admin/v1/rooms/%s" % (room_id_1,)
2338
+ channel = self.make_request(
2339
+ "GET",
2340
+ url.encode("ascii"),
2341
+ access_token=self.admin_user_tok,
2342
+ )
2343
+ self.assertEqual(200, channel.code, msg=channel.json_body)
2344
+ self.assertEqual(2, channel.json_body["joined_local_devices"])
2345
+
2346
+ # leave room
2347
+ self.helper.leave(room_id_1, self.admin_user, tok=self.admin_user_tok)
2348
+ self.helper.leave(room_id_1, user_1, tok=user_tok_1)
2349
+ url = "/_synapse/admin/v1/rooms/%s" % (room_id_1,)
2350
+ channel = self.make_request(
2351
+ "GET",
2352
+ url.encode("ascii"),
2353
+ access_token=self.admin_user_tok,
2354
+ )
2355
+ self.assertEqual(200, channel.code, msg=channel.json_body)
2356
+ self.assertEqual(0, channel.json_body["joined_local_devices"])
2357
+
2358
+ def test_room_members(self) -> None:
2359
+ """Test that room members can be requested correctly"""
2360
+ # Create two test rooms
2361
+ room_id_1 = self.helper.create_room_as(self.admin_user, tok=self.admin_user_tok)
2362
+ room_id_2 = self.helper.create_room_as(self.admin_user, tok=self.admin_user_tok)
2363
+
2364
+ # Have another user join the room
2365
+ user_1 = self.register_user("foo", "pass")
2366
+ user_tok_1 = self.login("foo", "pass")
2367
+ self.helper.join(room_id_1, user_1, tok=user_tok_1)
2368
+
2369
+ # Have another user join the room
2370
+ user_2 = self.register_user("bar", "pass")
2371
+ user_tok_2 = self.login("bar", "pass")
2372
+ self.helper.join(room_id_1, user_2, tok=user_tok_2)
2373
+ self.helper.join(room_id_2, user_2, tok=user_tok_2)
2374
+
2375
+ # Have another user join the room
2376
+ user_3 = self.register_user("foobar", "pass")
2377
+ user_tok_3 = self.login("foobar", "pass")
2378
+ self.helper.join(room_id_2, user_3, tok=user_tok_3)
2379
+
2380
+ url = "/_synapse/admin/v1/rooms/%s/members" % (room_id_1,)
2381
+ channel = self.make_request(
2382
+ "GET",
2383
+ url.encode("ascii"),
2384
+ access_token=self.admin_user_tok,
2385
+ )
2386
+ self.assertEqual(200, channel.code, msg=channel.json_body)
2387
+
2388
+ self.assertCountEqual(
2389
+ ["@admin:test", "@foo:test", "@bar:test"], channel.json_body["members"]
2390
+ )
2391
+ self.assertEqual(channel.json_body["total"], 3)
2392
+
2393
+ url = "/_synapse/admin/v1/rooms/%s/members" % (room_id_2,)
2394
+ channel = self.make_request(
2395
+ "GET",
2396
+ url.encode("ascii"),
2397
+ access_token=self.admin_user_tok,
2398
+ )
2399
+ self.assertEqual(200, channel.code, msg=channel.json_body)
2400
+
2401
+ self.assertCountEqual(
2402
+ ["@admin:test", "@bar:test", "@foobar:test"], channel.json_body["members"]
2403
+ )
2404
+ self.assertEqual(channel.json_body["total"], 3)
2405
+
2406
+ def test_room_state(self) -> None:
2407
+ """Test that room state can be requested correctly"""
2408
+ # Create two test rooms
2409
+ room_id = self.helper.create_room_as(self.admin_user, tok=self.admin_user_tok)
2410
+
2411
+ url = "/_synapse/admin/v1/rooms/%s/state" % (room_id,)
2412
+ channel = self.make_request(
2413
+ "GET",
2414
+ url.encode("ascii"),
2415
+ access_token=self.admin_user_tok,
2416
+ )
2417
+ self.assertEqual(200, channel.code, msg=channel.json_body)
2418
+ self.assertIn("state", channel.json_body)
2419
+ # testing that the state events match is painful and not done here. We assume that
2420
+ # the create_room already does the right thing, so no need to verify that we got
2421
+ # the state events it created.
2422
+
2423
+ def test_room_state_param(self) -> None:
2424
+ """Test that filtering by state event type works when requesting state"""
2425
+ room_id = self.helper.create_room_as(self.admin_user, tok=self.admin_user_tok)
2426
+
2427
+ channel = self.make_request(
2428
+ "GET",
2429
+ f"/_synapse/admin/v1/rooms/{room_id}/state?type=m.room.member",
2430
+ access_token=self.admin_user_tok,
2431
+ )
2432
+ self.assertEqual(200, channel.code)
2433
+ state = channel.json_body["state"]
2434
+ # only one member has joined so there should be one membership event
2435
+ self.assertEqual(1, len(state))
2436
+ event = state[0]
2437
+ self.assertEqual(event["type"], "m.room.member")
2438
+ self.assertEqual(event["state_key"], self.admin_user)
2439
+
2440
+ def test_room_state_param_empty(self) -> None:
2441
+ """Test that passing an empty string as state filter param returns no state events"""
2442
+ room_id = self.helper.create_room_as(self.admin_user, tok=self.admin_user_tok)
2443
+
2444
+ channel = self.make_request(
2445
+ "GET",
2446
+ f"/_synapse/admin/v1/rooms/{room_id}/state?type=",
2447
+ access_token=self.admin_user_tok,
2448
+ )
2449
+ self.assertEqual(200, channel.code)
2450
+ state = channel.json_body["state"]
2451
+ self.assertEqual(5, len(state))
2452
+
2453
+ def test_room_state_param_not_in_room(self) -> None:
2454
+ """
2455
+ Test that passing a state filter param for a state event not in the room
2456
+ returns no state events
2457
+ """
2458
+ room_id = self.helper.create_room_as(self.admin_user, tok=self.admin_user_tok)
2459
+
2460
+ channel = self.make_request(
2461
+ "GET",
2462
+ f"/_synapse/admin/v1/rooms/{room_id}/state?type=m.room.custom",
2463
+ access_token=self.admin_user_tok,
2464
+ )
2465
+ self.assertEqual(200, channel.code)
2466
+ state = channel.json_body["state"]
2467
+ self.assertEqual(0, len(state))
2468
+
2469
+ def _set_canonical_alias(
2470
+ self, room_id: str, test_alias: str, admin_user_tok: str
2471
+ ) -> None:
2472
+ # Create a new alias to this room
2473
+ url = "/_matrix/client/r0/directory/room/%s" % (urllib.parse.quote(test_alias),)
2474
+ channel = self.make_request(
2475
+ "PUT",
2476
+ url.encode("ascii"),
2477
+ {"room_id": room_id},
2478
+ access_token=admin_user_tok,
2479
+ )
2480
+ self.assertEqual(200, channel.code, msg=channel.json_body)
2481
+
2482
+ # Set this new alias as the canonical alias for this room
2483
+ self.helper.send_state(
2484
+ room_id,
2485
+ "m.room.aliases",
2486
+ {"aliases": [test_alias]},
2487
+ tok=admin_user_tok,
2488
+ state_key="test",
2489
+ )
2490
+ self.helper.send_state(
2491
+ room_id,
2492
+ "m.room.canonical_alias",
2493
+ {"alias": test_alias},
2494
+ tok=admin_user_tok,
2495
+ )
2496
+
2497
+ def test_get_joined_members_after_leave_room(self) -> None:
2498
+ """Test that requesting room members after leaving the room raises a 403 error."""
2499
+
2500
+ # create the room
2501
+ user = self.register_user("foo", "pass")
2502
+ user_tok = self.login("foo", "pass")
2503
+ room_id = self.helper.create_room_as(user, tok=user_tok)
2504
+ self.helper.leave(room_id, user, tok=user_tok)
2505
+
2506
+ # delete the rooms and get joined roomed membership
2507
+ url = f"/_matrix/client/r0/rooms/{room_id}/joined_members"
2508
+ channel = self.make_request("GET", url.encode("ascii"), access_token=user_tok)
2509
+ self.assertEqual(403, channel.code, msg=channel.json_body)
2510
+ self.assertEqual(Codes.FORBIDDEN, channel.json_body["errcode"])
2511
+
2512
+
2513
+ class RoomMessagesTestCase(unittest.HomeserverTestCase):
2514
+ servlets = [
2515
+ synapse.rest.admin.register_servlets,
2516
+ login.register_servlets,
2517
+ room.register_servlets,
2518
+ ]
2519
+
2520
+ def prepare(self, reactor: MemoryReactor, clock: Clock, hs: HomeServer) -> None:
2521
+ self.admin_user = self.register_user("admin", "pass", admin=True)
2522
+ self.admin_user_tok = self.login("admin", "pass")
2523
+
2524
+ self.user = self.register_user("foo", "pass")
2525
+ self.user_tok = self.login("foo", "pass")
2526
+ self.room_id = self.helper.create_room_as(self.user, tok=self.user_tok)
2527
+
2528
+ def test_timestamp_to_event(self) -> None:
2529
+ """Test that providing the current timestamp can get the last event."""
2530
+ self.helper.send(self.room_id, body="message 1", tok=self.user_tok)
2531
+ second_event_id = self.helper.send(
2532
+ self.room_id, body="message 2", tok=self.user_tok
2533
+ )["event_id"]
2534
+ ts = str(round(time.time() * 1000))
2535
+
2536
+ channel = self.make_request(
2537
+ "GET",
2538
+ "/_synapse/admin/v1/rooms/%s/timestamp_to_event?dir=b&ts=%s"
2539
+ % (self.room_id, ts),
2540
+ access_token=self.admin_user_tok,
2541
+ )
2542
+ self.assertEqual(200, channel.code)
2543
+ self.assertIn("event_id", channel.json_body)
2544
+ self.assertEqual(second_event_id, channel.json_body["event_id"])
2545
+
2546
+ def test_topo_token_is_accepted(self) -> None:
2547
+ """Test Topo Token is accepted."""
2548
+ token = "t1-0_0_0_0_0_0_0_0_0_0_0"
2549
+ channel = self.make_request(
2550
+ "GET",
2551
+ "/_synapse/admin/v1/rooms/%s/messages?from=%s" % (self.room_id, token),
2552
+ access_token=self.admin_user_tok,
2553
+ )
2554
+ self.assertEqual(200, channel.code)
2555
+ self.assertIn("start", channel.json_body)
2556
+ self.assertEqual(token, channel.json_body["start"])
2557
+ self.assertIn("chunk", channel.json_body)
2558
+ self.assertIn("end", channel.json_body)
2559
+
2560
+ def test_stream_token_is_accepted_for_fwd_pagianation(self) -> None:
2561
+ """Test that stream token is accepted for forward pagination."""
2562
+ token = "s0_0_0_0_0_0_0_0_0_0_0"
2563
+ channel = self.make_request(
2564
+ "GET",
2565
+ "/_synapse/admin/v1/rooms/%s/messages?from=%s" % (self.room_id, token),
2566
+ access_token=self.admin_user_tok,
2567
+ )
2568
+ self.assertEqual(200, channel.code)
2569
+ self.assertIn("start", channel.json_body)
2570
+ self.assertEqual(token, channel.json_body["start"])
2571
+ self.assertIn("chunk", channel.json_body)
2572
+ self.assertIn("end", channel.json_body)
2573
+
2574
+ def test_room_messages_backward(self) -> None:
2575
+ """Test room messages can be retrieved by an admin that isn't in the room."""
2576
+ latest_event_id = self.helper.send(
2577
+ self.room_id, body="message 1", tok=self.user_tok
2578
+ )["event_id"]
2579
+
2580
+ # Check that we get the first and second message when querying /messages.
2581
+ channel = self.make_request(
2582
+ "GET",
2583
+ "/_synapse/admin/v1/rooms/%s/messages?dir=b" % (self.room_id,),
2584
+ access_token=self.admin_user_tok,
2585
+ )
2586
+ self.assertEqual(channel.code, 200, channel.json_body)
2587
+
2588
+ chunk = channel.json_body["chunk"]
2589
+ self.assertEqual(len(chunk), 6, [event["content"] for event in chunk])
2590
+
2591
+ # in backwards, this is the first event
2592
+ self.assertEqual(chunk[0]["event_id"], latest_event_id)
2593
+
2594
+ def test_room_messages_forward(self) -> None:
2595
+ """Test room messages can be retrieved by an admin that isn't in the room."""
2596
+ latest_event_id = self.helper.send(
2597
+ self.room_id, body="message 1", tok=self.user_tok
2598
+ )["event_id"]
2599
+
2600
+ # Check that we get the first and second message when querying /messages.
2601
+ channel = self.make_request(
2602
+ "GET",
2603
+ "/_synapse/admin/v1/rooms/%s/messages?dir=f" % (self.room_id,),
2604
+ access_token=self.admin_user_tok,
2605
+ )
2606
+ self.assertEqual(channel.code, 200, channel.json_body)
2607
+
2608
+ chunk = channel.json_body["chunk"]
2609
+ self.assertEqual(len(chunk), 6, [event["content"] for event in chunk])
2610
+
2611
+ # in forward, this is the last event
2612
+ self.assertEqual(chunk[5]["event_id"], latest_event_id)
2613
+
2614
+ def test_room_messages_purge(self) -> None:
2615
+ """Test room messages can be retrieved by an admin that isn't in the room."""
2616
+ store = self.hs.get_datastores().main
2617
+ pagination_handler = self.hs.get_pagination_handler()
2618
+
2619
+ # Send a first message in the room, which will be removed by the purge.
2620
+ first_event_id = self.helper.send(
2621
+ self.room_id, body="message 1", tok=self.user_tok
2622
+ )["event_id"]
2623
+ first_token = self.get_success(
2624
+ store.get_topological_token_for_event(first_event_id)
2625
+ )
2626
+ first_token_str = self.get_success(first_token.to_string(store))
2627
+
2628
+ # Send a second message in the room, which won't be removed, and which we'll
2629
+ # use as the marker to purge events before.
2630
+ second_event_id = self.helper.send(
2631
+ self.room_id, body="message 2", tok=self.user_tok
2632
+ )["event_id"]
2633
+ second_token = self.get_success(
2634
+ store.get_topological_token_for_event(second_event_id)
2635
+ )
2636
+ second_token_str = self.get_success(second_token.to_string(store))
2637
+
2638
+ # Send a third event in the room to ensure we don't fall under any edge case
2639
+ # due to our marker being the latest forward extremity in the room.
2640
+ self.helper.send(self.room_id, body="message 3", tok=self.user_tok)
2641
+
2642
+ # Check that we get the first and second message when querying /messages.
2643
+ channel = self.make_request(
2644
+ "GET",
2645
+ "/_synapse/admin/v1/rooms/%s/messages?from=%s&dir=b&filter=%s"
2646
+ % (
2647
+ self.room_id,
2648
+ second_token_str,
2649
+ json.dumps({"types": [EventTypes.Message]}),
2650
+ ),
2651
+ access_token=self.admin_user_tok,
2652
+ )
2653
+ self.assertEqual(channel.code, 200, channel.json_body)
2654
+
2655
+ chunk = channel.json_body["chunk"]
2656
+ self.assertEqual(len(chunk), 2, [event["content"] for event in chunk])
2657
+
2658
+ # Purge every event before the second event.
2659
+ self.get_success(
2660
+ pagination_handler.purge_history(
2661
+ room_id=self.room_id,
2662
+ token=second_token_str,
2663
+ delete_local_events=True,
2664
+ )
2665
+ )
2666
+
2667
+ # Check that we only get the second message through /message now that the first
2668
+ # has been purged.
2669
+ channel = self.make_request(
2670
+ "GET",
2671
+ "/_synapse/admin/v1/rooms/%s/messages?from=%s&dir=b&filter=%s"
2672
+ % (
2673
+ self.room_id,
2674
+ second_token_str,
2675
+ json.dumps({"types": [EventTypes.Message]}),
2676
+ ),
2677
+ access_token=self.admin_user_tok,
2678
+ )
2679
+ self.assertEqual(channel.code, 200, channel.json_body)
2680
+
2681
+ chunk = channel.json_body["chunk"]
2682
+ self.assertEqual(len(chunk), 1, [event["content"] for event in chunk])
2683
+
2684
+ # Check that we get no event, but also no error, when querying /messages with
2685
+ # the token that was pointing at the first event, because we don't have it
2686
+ # anymore.
2687
+ channel = self.make_request(
2688
+ "GET",
2689
+ "/_synapse/admin/v1/rooms/%s/messages?from=%s&dir=b&filter=%s"
2690
+ % (
2691
+ self.room_id,
2692
+ first_token_str,
2693
+ json.dumps({"types": [EventTypes.Message]}),
2694
+ ),
2695
+ access_token=self.admin_user_tok,
2696
+ )
2697
+ self.assertEqual(channel.code, 200, channel.json_body)
2698
+
2699
+ chunk = channel.json_body["chunk"]
2700
+ self.assertEqual(len(chunk), 0, [event["content"] for event in chunk])
2701
+
2702
+ def test_room_message_filter_query_validation(self) -> None:
2703
+ # Test json validation in (filter) query parameter.
2704
+ # Does not test the validity of the filter, only the json validation.
2705
+
2706
+ # Check Get with valid json filter parameter, expect 200.
2707
+ valid_filter_str = '{"types": ["m.room.message"]}'
2708
+ channel = self.make_request(
2709
+ "GET",
2710
+ f"/_synapse/admin/v1/rooms/{self.room_id}/messages?dir=b&filter={valid_filter_str}",
2711
+ access_token=self.admin_user_tok,
2712
+ )
2713
+
2714
+ self.assertEqual(channel.code, HTTPStatus.OK, channel.json_body)
2715
+
2716
+ # Check Get with invalid json filter parameter, expect 400 NOT_JSON.
2717
+ invalid_filter_str = "}}}{}"
2718
+ channel = self.make_request(
2719
+ "GET",
2720
+ f"/_synapse/admin/v1/rooms/{self.room_id}/messages?dir=b&filter={invalid_filter_str}",
2721
+ access_token=self.admin_user_tok,
2722
+ )
2723
+
2724
+ self.assertEqual(channel.code, HTTPStatus.BAD_REQUEST, channel.json_body)
2725
+ self.assertEqual(
2726
+ channel.json_body["errcode"], Codes.NOT_JSON, channel.json_body
2727
+ )
2728
+
2729
+
2730
+ class JoinAliasRoomTestCase(unittest.HomeserverTestCase):
2731
+ servlets = [
2732
+ synapse.rest.admin.register_servlets,
2733
+ room.register_servlets,
2734
+ login.register_servlets,
2735
+ ]
2736
+
2737
+ def prepare(self, reactor: MemoryReactor, clock: Clock, hs: HomeServer) -> None:
2738
+ self.admin_user = self.register_user("admin", "pass", admin=True)
2739
+ self.admin_user_tok = self.login("admin", "pass")
2740
+
2741
+ self.creator = self.register_user("creator", "test")
2742
+ self.creator_tok = self.login("creator", "test")
2743
+
2744
+ self.second_user_id = self.register_user("second", "test")
2745
+ self.second_tok = self.login("second", "test")
2746
+
2747
+ self.public_room_id = self.helper.create_room_as(
2748
+ self.creator, tok=self.creator_tok, is_public=True
2749
+ )
2750
+ self.url = f"/_synapse/admin/v1/join/{self.public_room_id}"
2751
+
2752
+ def test_requester_is_no_admin(self) -> None:
2753
+ """
2754
+ If the user is not a server admin, an error 403 is returned.
2755
+ """
2756
+
2757
+ channel = self.make_request(
2758
+ "POST",
2759
+ self.url,
2760
+ content={"user_id": self.second_user_id},
2761
+ access_token=self.second_tok,
2762
+ )
2763
+
2764
+ self.assertEqual(403, channel.code, msg=channel.json_body)
2765
+ self.assertEqual(Codes.FORBIDDEN, channel.json_body["errcode"])
2766
+
2767
+ def test_invalid_parameter(self) -> None:
2768
+ """
2769
+ If a parameter is missing, return an error
2770
+ """
2771
+
2772
+ channel = self.make_request(
2773
+ "POST",
2774
+ self.url,
2775
+ content={"unknown_parameter": "@unknown:test"},
2776
+ access_token=self.admin_user_tok,
2777
+ )
2778
+
2779
+ self.assertEqual(400, channel.code, msg=channel.json_body)
2780
+ self.assertEqual(Codes.MISSING_PARAM, channel.json_body["errcode"])
2781
+
2782
+ def test_local_user_does_not_exist(self) -> None:
2783
+ """
2784
+ Tests that a lookup for a user that does not exist returns a 404
2785
+ """
2786
+
2787
+ channel = self.make_request(
2788
+ "POST",
2789
+ self.url,
2790
+ content={"user_id": "@unknown:test"},
2791
+ access_token=self.admin_user_tok,
2792
+ )
2793
+
2794
+ self.assertEqual(404, channel.code, msg=channel.json_body)
2795
+ self.assertEqual(Codes.NOT_FOUND, channel.json_body["errcode"])
2796
+
2797
+ def test_remote_user(self) -> None:
2798
+ """
2799
+ Check that only local user can join rooms.
2800
+ """
2801
+
2802
+ channel = self.make_request(
2803
+ "POST",
2804
+ self.url,
2805
+ content={"user_id": "@not:exist.bla"},
2806
+ access_token=self.admin_user_tok,
2807
+ )
2808
+
2809
+ self.assertEqual(400, channel.code, msg=channel.json_body)
2810
+ self.assertEqual(
2811
+ "This endpoint can only be used with local users",
2812
+ channel.json_body["error"],
2813
+ )
2814
+
2815
+ def test_room_does_not_exist(self) -> None:
2816
+ """
2817
+ Check that unknown rooms/server return error 404.
2818
+ """
2819
+ url = "/_synapse/admin/v1/join/!unknown:test"
2820
+
2821
+ channel = self.make_request(
2822
+ "POST",
2823
+ url,
2824
+ content={"user_id": self.second_user_id},
2825
+ access_token=self.admin_user_tok,
2826
+ )
2827
+
2828
+ self.assertEqual(404, channel.code, msg=channel.json_body)
2829
+ self.assertEqual(
2830
+ "Can't join remote room because no servers that are in the room have been provided.",
2831
+ channel.json_body["error"],
2832
+ )
2833
+
2834
+ def test_room_is_not_valid(self) -> None:
2835
+ """
2836
+ Check that invalid room names, return an error 400.
2837
+ """
2838
+ url = "/_synapse/admin/v1/join/invalidroom"
2839
+
2840
+ channel = self.make_request(
2841
+ "POST",
2842
+ url,
2843
+ content={"user_id": self.second_user_id},
2844
+ access_token=self.admin_user_tok,
2845
+ )
2846
+
2847
+ self.assertEqual(400, channel.code, msg=channel.json_body)
2848
+ self.assertEqual(
2849
+ "invalidroom was not legal room ID or room alias",
2850
+ channel.json_body["error"],
2851
+ )
2852
+
2853
+ def test_join_public_room(self) -> None:
2854
+ """
2855
+ Test joining a local user to a public room with "JoinRules.PUBLIC"
2856
+ """
2857
+
2858
+ channel = self.make_request(
2859
+ "POST",
2860
+ self.url,
2861
+ content={"user_id": self.second_user_id},
2862
+ access_token=self.admin_user_tok,
2863
+ )
2864
+
2865
+ self.assertEqual(200, channel.code, msg=channel.json_body)
2866
+ self.assertEqual(self.public_room_id, channel.json_body["room_id"])
2867
+
2868
+ # Validate if user is a member of the room
2869
+
2870
+ channel = self.make_request(
2871
+ "GET",
2872
+ "/_matrix/client/r0/joined_rooms",
2873
+ access_token=self.second_tok,
2874
+ )
2875
+ self.assertEqual(200, channel.code, msg=channel.json_body)
2876
+ self.assertEqual(self.public_room_id, channel.json_body["joined_rooms"][0])
2877
+
2878
+ def test_join_private_room_if_not_member(self) -> None:
2879
+ """
2880
+ Test joining a local user to a private room with "JoinRules.INVITE"
2881
+ when server admin is not member of this room.
2882
+ """
2883
+ private_room_id = self.helper.create_room_as(
2884
+ self.creator, tok=self.creator_tok, is_public=False
2885
+ )
2886
+ url = f"/_synapse/admin/v1/join/{private_room_id}"
2887
+
2888
+ channel = self.make_request(
2889
+ "POST",
2890
+ url,
2891
+ content={"user_id": self.second_user_id},
2892
+ access_token=self.admin_user_tok,
2893
+ )
2894
+
2895
+ self.assertEqual(403, channel.code, msg=channel.json_body)
2896
+ self.assertEqual(Codes.FORBIDDEN, channel.json_body["errcode"])
2897
+
2898
+ def test_join_private_room_if_member(self) -> None:
2899
+ """
2900
+ Test joining a local user to a private room with "JoinRules.INVITE",
2901
+ when server admin is member of this room.
2902
+ """
2903
+ private_room_id = self.helper.create_room_as(
2904
+ self.creator, tok=self.creator_tok, is_public=False
2905
+ )
2906
+ self.helper.invite(
2907
+ room=private_room_id,
2908
+ src=self.creator,
2909
+ targ=self.admin_user,
2910
+ tok=self.creator_tok,
2911
+ )
2912
+ self.helper.join(
2913
+ room=private_room_id, user=self.admin_user, tok=self.admin_user_tok
2914
+ )
2915
+
2916
+ # Validate if server admin is a member of the room
2917
+
2918
+ channel = self.make_request(
2919
+ "GET",
2920
+ "/_matrix/client/r0/joined_rooms",
2921
+ access_token=self.admin_user_tok,
2922
+ )
2923
+ self.assertEqual(200, channel.code, msg=channel.json_body)
2924
+ self.assertEqual(private_room_id, channel.json_body["joined_rooms"][0])
2925
+
2926
+ # Join user to room.
2927
+
2928
+ url = f"/_synapse/admin/v1/join/{private_room_id}"
2929
+
2930
+ channel = self.make_request(
2931
+ "POST",
2932
+ url,
2933
+ content={"user_id": self.second_user_id},
2934
+ access_token=self.admin_user_tok,
2935
+ )
2936
+ self.assertEqual(200, channel.code, msg=channel.json_body)
2937
+ self.assertEqual(private_room_id, channel.json_body["room_id"])
2938
+
2939
+ # Validate if user is a member of the room
2940
+
2941
+ channel = self.make_request(
2942
+ "GET",
2943
+ "/_matrix/client/r0/joined_rooms",
2944
+ access_token=self.second_tok,
2945
+ )
2946
+ self.assertEqual(200, channel.code, msg=channel.json_body)
2947
+ self.assertEqual(private_room_id, channel.json_body["joined_rooms"][0])
2948
+
2949
+ def test_join_private_room_if_owner(self) -> None:
2950
+ """
2951
+ Test joining a local user to a private room with "JoinRules.INVITE",
2952
+ when server admin is owner of this room.
2953
+ """
2954
+ private_room_id = self.helper.create_room_as(
2955
+ self.admin_user, tok=self.admin_user_tok, is_public=False
2956
+ )
2957
+ url = f"/_synapse/admin/v1/join/{private_room_id}"
2958
+
2959
+ channel = self.make_request(
2960
+ "POST",
2961
+ url,
2962
+ content={"user_id": self.second_user_id},
2963
+ access_token=self.admin_user_tok,
2964
+ )
2965
+
2966
+ self.assertEqual(200, channel.code, msg=channel.json_body)
2967
+ self.assertEqual(private_room_id, channel.json_body["room_id"])
2968
+
2969
+ # Validate if user is a member of the room
2970
+
2971
+ channel = self.make_request(
2972
+ "GET",
2973
+ "/_matrix/client/r0/joined_rooms",
2974
+ access_token=self.second_tok,
2975
+ )
2976
+ self.assertEqual(200, channel.code, msg=channel.json_body)
2977
+ self.assertEqual(private_room_id, channel.json_body["joined_rooms"][0])
2978
+
2979
+ def test_joined_rooms(self) -> None:
2980
+ """
2981
+ Test joined_rooms admin endpoint.
2982
+ """
2983
+
2984
+ channel = self.make_request(
2985
+ "POST",
2986
+ f"/_matrix/client/v3/join/{self.public_room_id}",
2987
+ content={"user_id": self.second_user_id},
2988
+ access_token=self.second_tok,
2989
+ )
2990
+
2991
+ self.assertEqual(200, channel.code, msg=channel.json_body)
2992
+ self.assertEqual(self.public_room_id, channel.json_body["room_id"])
2993
+
2994
+ channel = self.make_request(
2995
+ "GET",
2996
+ f"/_synapse/admin/v1/users/{self.second_user_id}/joined_rooms",
2997
+ access_token=self.admin_user_tok,
2998
+ )
2999
+ self.assertEqual(200, channel.code, msg=channel.json_body)
3000
+ self.assertEqual(self.public_room_id, channel.json_body["joined_rooms"][0])
3001
+
3002
+ def test_memberships(self) -> None:
3003
+ """
3004
+ Test user memberships admin endpoint.
3005
+ """
3006
+
3007
+ channel = self.make_request(
3008
+ "POST",
3009
+ f"/_matrix/client/v3/join/{self.public_room_id}",
3010
+ content={"user_id": self.second_user_id},
3011
+ access_token=self.second_tok,
3012
+ )
3013
+ self.assertEqual(200, channel.code, msg=channel.json_body)
3014
+
3015
+ other_room_id = self.helper.create_room_as(
3016
+ self.admin_user, tok=self.admin_user_tok
3017
+ )
3018
+
3019
+ channel = self.make_request(
3020
+ "POST",
3021
+ f"/_matrix/client/v3/join/{other_room_id}",
3022
+ content={"user_id": self.second_user_id},
3023
+ access_token=self.second_tok,
3024
+ )
3025
+ self.assertEqual(200, channel.code, msg=channel.json_body)
3026
+
3027
+ channel = self.make_request(
3028
+ "GET",
3029
+ f"/_synapse/admin/v1/users/{self.second_user_id}/memberships",
3030
+ access_token=self.admin_user_tok,
3031
+ )
3032
+
3033
+ self.assertEqual(200, channel.code, msg=channel.json_body)
3034
+ self.assertEqual(
3035
+ {
3036
+ "memberships": {
3037
+ self.public_room_id: Membership.JOIN,
3038
+ other_room_id: Membership.JOIN,
3039
+ }
3040
+ },
3041
+ channel.json_body,
3042
+ )
3043
+
3044
+ channel = self.make_request(
3045
+ "POST",
3046
+ f"/_matrix/client/v3/rooms/{other_room_id}/leave",
3047
+ content={"user_id": self.second_user_id},
3048
+ access_token=self.second_tok,
3049
+ )
3050
+ self.assertEqual(200, channel.code, msg=channel.json_body)
3051
+
3052
+ invited_room_id = self.helper.create_room_as(
3053
+ self.admin_user, tok=self.admin_user_tok
3054
+ )
3055
+ channel = self.make_request(
3056
+ "POST",
3057
+ f"/_matrix/client/v3/rooms/{invited_room_id}/invite",
3058
+ content={"user_id": self.second_user_id},
3059
+ access_token=self.admin_user_tok,
3060
+ )
3061
+ self.assertEqual(200, channel.code, msg=channel.json_body)
3062
+
3063
+ banned_room_id = self.helper.create_room_as(
3064
+ self.admin_user, tok=self.admin_user_tok
3065
+ )
3066
+ channel = self.make_request(
3067
+ "POST",
3068
+ f"/_matrix/client/v3/rooms/{banned_room_id}/ban",
3069
+ content={"user_id": self.second_user_id},
3070
+ access_token=self.admin_user_tok,
3071
+ )
3072
+ self.assertEqual(200, channel.code, msg=channel.json_body)
3073
+
3074
+ channel = self.make_request(
3075
+ "GET",
3076
+ f"/_synapse/admin/v1/users/{self.second_user_id}/memberships",
3077
+ access_token=self.admin_user_tok,
3078
+ )
3079
+
3080
+ self.assertEqual(200, channel.code, msg=channel.json_body)
3081
+ self.assertEqual(
3082
+ {
3083
+ "memberships": {
3084
+ self.public_room_id: Membership.JOIN,
3085
+ other_room_id: Membership.LEAVE,
3086
+ invited_room_id: Membership.INVITE,
3087
+ banned_room_id: Membership.BAN,
3088
+ }
3089
+ },
3090
+ channel.json_body,
3091
+ )
3092
+
3093
+ def test_context_as_non_admin(self) -> None:
3094
+ """
3095
+ Test that, without being admin, one cannot use the context admin API
3096
+ """
3097
+ # Create a room.
3098
+ user_id = self.register_user("test", "test")
3099
+ user_tok = self.login("test", "test")
3100
+
3101
+ self.register_user("test_2", "test")
3102
+ user_tok_2 = self.login("test_2", "test")
3103
+
3104
+ room_id = self.helper.create_room_as(user_id, tok=user_tok)
3105
+
3106
+ # Populate the room with events.
3107
+ events = []
3108
+ for i in range(30):
3109
+ events.append(
3110
+ self.helper.send_event(
3111
+ room_id, "com.example.test", content={"index": i}, tok=user_tok
3112
+ )
3113
+ )
3114
+
3115
+ # Now attempt to find the context using the admin API without being admin.
3116
+ midway = (len(events) - 1) // 2
3117
+ for tok in [user_tok, user_tok_2]:
3118
+ channel = self.make_request(
3119
+ "GET",
3120
+ "/_synapse/admin/v1/rooms/%s/context/%s"
3121
+ % (room_id, events[midway]["event_id"]),
3122
+ access_token=tok,
3123
+ )
3124
+ self.assertEqual(403, channel.code, msg=channel.json_body)
3125
+ self.assertEqual(Codes.FORBIDDEN, channel.json_body["errcode"])
3126
+
3127
+ def test_context_as_admin(self) -> None:
3128
+ """
3129
+ Test that, as admin, we can find the context of an event without having joined the room.
3130
+ """
3131
+
3132
+ # Create a room. We're not part of it.
3133
+ user_id = self.register_user("test", "test")
3134
+ user_tok = self.login("test", "test")
3135
+ room_id = self.helper.create_room_as(user_id, tok=user_tok)
3136
+
3137
+ # Populate the room with events.
3138
+ events = []
3139
+ for i in range(30):
3140
+ events.append(
3141
+ self.helper.send_event(
3142
+ room_id, "com.example.test", content={"index": i}, tok=user_tok
3143
+ )
3144
+ )
3145
+
3146
+ # Now let's fetch the context for this room.
3147
+ midway = (len(events) - 1) // 2
3148
+ channel = self.make_request(
3149
+ "GET",
3150
+ "/_synapse/admin/v1/rooms/%s/context/%s"
3151
+ % (room_id, events[midway]["event_id"]),
3152
+ access_token=self.admin_user_tok,
3153
+ )
3154
+ self.assertEqual(200, channel.code, msg=channel.json_body)
3155
+ self.assertEqual(
3156
+ channel.json_body["event"]["event_id"], events[midway]["event_id"]
3157
+ )
3158
+
3159
+ for found_event in channel.json_body["events_before"]:
3160
+ for j, posted_event in enumerate(events):
3161
+ if found_event["event_id"] == posted_event["event_id"]:
3162
+ self.assertTrue(j < midway)
3163
+ break
3164
+ else:
3165
+ self.fail("Event %s from events_before not found" % j)
3166
+
3167
+ for found_event in channel.json_body["events_after"]:
3168
+ for j, posted_event in enumerate(events):
3169
+ if found_event["event_id"] == posted_event["event_id"]:
3170
+ self.assertTrue(j > midway)
3171
+ break
3172
+ else:
3173
+ self.fail("Event %s from events_after not found" % j)
3174
+
3175
+ def test_room_event_context_filter_query_validation(self) -> None:
3176
+ # Test json validation in (filter) query parameter.
3177
+ # Does not test the validity of the filter, only the json validation.
3178
+
3179
+ # Create a user with room and event_id.
3180
+ user_id = self.register_user("test", "test")
3181
+ user_tok = self.login("test", "test")
3182
+ room_id = self.helper.create_room_as(user_id, tok=user_tok)
3183
+ event_id = self.helper.send(room_id, "message 1", tok=user_tok)["event_id"]
3184
+
3185
+ # Check Get with valid json filter parameter, expect 200.
3186
+ valid_filter_str = '{"types": ["m.room.message"]}'
3187
+ channel = self.make_request(
3188
+ "GET",
3189
+ f"/_synapse/admin/v1/rooms/{room_id}/context/{event_id}?filter={valid_filter_str}",
3190
+ access_token=self.admin_user_tok,
3191
+ )
3192
+
3193
+ self.assertEqual(channel.code, HTTPStatus.OK, channel.json_body)
3194
+
3195
+ # Check Get with invalid json filter parameter, expect 400 NOT_JSON.
3196
+ invalid_filter_str = "}}}{}"
3197
+ channel = self.make_request(
3198
+ "GET",
3199
+ f"/_synapse/admin/v1/rooms/{room_id}/context/{event_id}?filter={invalid_filter_str}",
3200
+ access_token=self.admin_user_tok,
3201
+ )
3202
+
3203
+ self.assertEqual(channel.code, HTTPStatus.BAD_REQUEST, channel.json_body)
3204
+ self.assertEqual(
3205
+ channel.json_body["errcode"], Codes.NOT_JSON, channel.json_body
3206
+ )
3207
+
3208
+
3209
+ class MakeRoomAdminTestCase(unittest.HomeserverTestCase):
3210
+ servlets = [
3211
+ synapse.rest.admin.register_servlets,
3212
+ room.register_servlets,
3213
+ login.register_servlets,
3214
+ ]
3215
+
3216
+ def prepare(self, reactor: MemoryReactor, clock: Clock, hs: HomeServer) -> None:
3217
+ self.admin_user = self.register_user("admin", "pass", admin=True)
3218
+ self.admin_user_tok = self.login("admin", "pass")
3219
+
3220
+ self.creator = self.register_user("creator", "test")
3221
+ self.creator_tok = self.login("creator", "test")
3222
+
3223
+ self.second_user_id = self.register_user("second", "test")
3224
+ self.second_tok = self.login("second", "test")
3225
+
3226
+ self.public_room_id = self.helper.create_room_as(
3227
+ self.creator, tok=self.creator_tok, is_public=True
3228
+ )
3229
+ self.url = "/_synapse/admin/v1/rooms/{}/make_room_admin".format(
3230
+ self.public_room_id
3231
+ )
3232
+
3233
+ def test_public_room(self) -> None:
3234
+ """Test that getting admin in a public room works."""
3235
+ room_id = self.helper.create_room_as(
3236
+ self.creator, tok=self.creator_tok, is_public=True
3237
+ )
3238
+
3239
+ channel = self.make_request(
3240
+ "POST",
3241
+ f"/_synapse/admin/v1/rooms/{room_id}/make_room_admin",
3242
+ content={},
3243
+ access_token=self.admin_user_tok,
3244
+ )
3245
+
3246
+ self.assertEqual(200, channel.code, msg=channel.json_body)
3247
+
3248
+ # Now we test that we can join the room and ban a user.
3249
+ self.helper.join(room_id, self.admin_user, tok=self.admin_user_tok)
3250
+ self.helper.change_membership(
3251
+ room_id,
3252
+ self.admin_user,
3253
+ "@test:test",
3254
+ Membership.BAN,
3255
+ tok=self.admin_user_tok,
3256
+ )
3257
+
3258
+ def test_private_room(self) -> None:
3259
+ """Test that getting admin in a private room works and we get invited."""
3260
+ room_id = self.helper.create_room_as(
3261
+ self.creator,
3262
+ tok=self.creator_tok,
3263
+ is_public=False,
3264
+ )
3265
+
3266
+ channel = self.make_request(
3267
+ "POST",
3268
+ f"/_synapse/admin/v1/rooms/{room_id}/make_room_admin",
3269
+ content={},
3270
+ access_token=self.admin_user_tok,
3271
+ )
3272
+
3273
+ self.assertEqual(200, channel.code, msg=channel.json_body)
3274
+
3275
+ # Now we test that we can join the room (we should have received an
3276
+ # invite) and can ban a user.
3277
+ self.helper.join(room_id, self.admin_user, tok=self.admin_user_tok)
3278
+ self.helper.change_membership(
3279
+ room_id,
3280
+ self.admin_user,
3281
+ "@test:test",
3282
+ Membership.BAN,
3283
+ tok=self.admin_user_tok,
3284
+ )
3285
+
3286
+ def test_other_user(self) -> None:
3287
+ """Test that giving admin in a public room works to a non-admin user works."""
3288
+ room_id = self.helper.create_room_as(
3289
+ self.creator, tok=self.creator_tok, is_public=True
3290
+ )
3291
+
3292
+ channel = self.make_request(
3293
+ "POST",
3294
+ f"/_synapse/admin/v1/rooms/{room_id}/make_room_admin",
3295
+ content={"user_id": self.second_user_id},
3296
+ access_token=self.admin_user_tok,
3297
+ )
3298
+
3299
+ self.assertEqual(200, channel.code, msg=channel.json_body)
3300
+
3301
+ # Now we test that we can join the room and ban a user.
3302
+ self.helper.join(room_id, self.second_user_id, tok=self.second_tok)
3303
+ self.helper.change_membership(
3304
+ room_id,
3305
+ self.second_user_id,
3306
+ "@test:test",
3307
+ Membership.BAN,
3308
+ tok=self.second_tok,
3309
+ )
3310
+
3311
+ def test_not_enough_power(self) -> None:
3312
+ """Test that we get a sensible error if there are no local room admins."""
3313
+ room_id = self.helper.create_room_as(
3314
+ self.creator, tok=self.creator_tok, is_public=True
3315
+ )
3316
+
3317
+ # The creator drops admin rights in the room.
3318
+ pl = self.helper.get_state(
3319
+ room_id, EventTypes.PowerLevels, tok=self.creator_tok
3320
+ )
3321
+ pl["users"][self.creator] = 0
3322
+ self.helper.send_state(
3323
+ room_id, EventTypes.PowerLevels, body=pl, tok=self.creator_tok
3324
+ )
3325
+
3326
+ channel = self.make_request(
3327
+ "POST",
3328
+ f"/_synapse/admin/v1/rooms/{room_id}/make_room_admin",
3329
+ content={},
3330
+ access_token=self.admin_user_tok,
3331
+ )
3332
+
3333
+ # We expect this to fail with a 400 as there are no room admins.
3334
+ #
3335
+ # (Note we assert the error message to ensure that it's not denied for
3336
+ # some other reason)
3337
+ self.assertEqual(400, channel.code, msg=channel.json_body)
3338
+ self.assertEqual(
3339
+ channel.json_body["error"],
3340
+ "No local admin user in room with power to update power levels.",
3341
+ )
3342
+
3343
+ def test_v12_room(self) -> None:
3344
+ """Test that you can be promoted to admin in v12 rooms which won't have the admin the PL event."""
3345
+ room_id = self.helper.create_room_as(
3346
+ self.creator,
3347
+ tok=self.creator_tok,
3348
+ room_version=RoomVersions.V12.identifier,
3349
+ )
3350
+
3351
+ channel = self.make_request(
3352
+ "POST",
3353
+ f"/_synapse/admin/v1/rooms/{room_id}/make_room_admin",
3354
+ content={},
3355
+ access_token=self.admin_user_tok,
3356
+ )
3357
+
3358
+ self.assertEqual(200, channel.code, msg=channel.json_body)
3359
+
3360
+ # Now we test that we can join the room and that the admin user has PL 100.
3361
+ self.helper.join(room_id, self.admin_user, tok=self.admin_user_tok)
3362
+ pl = self.helper.get_state(
3363
+ room_id, EventTypes.PowerLevels, tok=self.creator_tok
3364
+ )
3365
+ self.assertEquals(pl["users"][self.admin_user], 100)
3366
+
3367
+ def test_v12_room_with_many_user_pls(self) -> None:
3368
+ """Test that you can be promoted to the admin user's PL in v12 rooms that contain a range of user PLs."""
3369
+ room_id = self.helper.create_room_as(
3370
+ self.creator,
3371
+ tok=self.creator_tok,
3372
+ room_version=RoomVersions.V12.identifier,
3373
+ is_public=True,
3374
+ extra_content={
3375
+ "power_level_content_override": {
3376
+ "users": {
3377
+ self.second_user_id: 50,
3378
+ },
3379
+ },
3380
+ },
3381
+ )
3382
+
3383
+ self.helper.join(room_id, self.admin_user, tok=self.admin_user_tok)
3384
+ self.helper.join(room_id, self.second_user_id, tok=self.second_tok)
3385
+
3386
+ channel = self.make_request(
3387
+ "POST",
3388
+ f"/_synapse/admin/v1/rooms/{room_id}/make_room_admin",
3389
+ content={},
3390
+ access_token=self.admin_user_tok,
3391
+ )
3392
+
3393
+ self.assertEqual(200, channel.code, msg=channel.json_body)
3394
+
3395
+ pl = self.helper.get_state(
3396
+ room_id, EventTypes.PowerLevels, tok=self.creator_tok
3397
+ )
3398
+ self.assertEquals(pl["users"][self.admin_user], 100)
3399
+
3400
+
3401
+ class BlockRoomTestCase(unittest.HomeserverTestCase):
3402
+ servlets = [
3403
+ synapse.rest.admin.register_servlets,
3404
+ room.register_servlets,
3405
+ login.register_servlets,
3406
+ ]
3407
+
3408
+ def prepare(self, reactor: MemoryReactor, clock: Clock, hs: HomeServer) -> None:
3409
+ self._store = hs.get_datastores().main
3410
+
3411
+ self.admin_user = self.register_user("admin", "pass", admin=True)
3412
+ self.admin_user_tok = self.login("admin", "pass")
3413
+
3414
+ self.other_user = self.register_user("user", "pass")
3415
+ self.other_user_tok = self.login("user", "pass")
3416
+
3417
+ self.room_id = self.helper.create_room_as(
3418
+ self.other_user, tok=self.other_user_tok
3419
+ )
3420
+ self.url = "/_synapse/admin/v1/rooms/%s/block"
3421
+
3422
+ @parameterized.expand([("PUT",), ("GET",)])
3423
+ def test_requester_is_no_admin(self, method: str) -> None:
3424
+ """If the user is not a server admin, an error 403 is returned."""
3425
+
3426
+ channel = self.make_request(
3427
+ method,
3428
+ self.url % self.room_id,
3429
+ content={},
3430
+ access_token=self.other_user_tok,
3431
+ )
3432
+
3433
+ self.assertEqual(403, channel.code, msg=channel.json_body)
3434
+ self.assertEqual(Codes.FORBIDDEN, channel.json_body["errcode"])
3435
+
3436
+ @parameterized.expand([("PUT",), ("GET",)])
3437
+ def test_room_is_not_valid(self, method: str) -> None:
3438
+ """Check that invalid room names, return an error 400."""
3439
+
3440
+ channel = self.make_request(
3441
+ method,
3442
+ self.url % "invalidroom",
3443
+ content={},
3444
+ access_token=self.admin_user_tok,
3445
+ )
3446
+
3447
+ self.assertEqual(400, channel.code, msg=channel.json_body)
3448
+ self.assertEqual(
3449
+ "invalidroom is not a legal room ID",
3450
+ channel.json_body["error"],
3451
+ )
3452
+
3453
+ def test_block_is_not_valid(self) -> None:
3454
+ """If parameter `block` is not valid, return an error."""
3455
+
3456
+ # `block` is not valid
3457
+ channel = self.make_request(
3458
+ "PUT",
3459
+ self.url % self.room_id,
3460
+ content={"block": "NotBool"},
3461
+ access_token=self.admin_user_tok,
3462
+ )
3463
+
3464
+ self.assertEqual(400, channel.code, msg=channel.json_body)
3465
+ self.assertEqual(Codes.BAD_JSON, channel.json_body["errcode"])
3466
+
3467
+ # `block` is not set
3468
+ channel = self.make_request(
3469
+ "PUT",
3470
+ self.url % self.room_id,
3471
+ content={},
3472
+ access_token=self.admin_user_tok,
3473
+ )
3474
+
3475
+ self.assertEqual(400, channel.code, msg=channel.json_body)
3476
+ self.assertEqual(Codes.MISSING_PARAM, channel.json_body["errcode"])
3477
+
3478
+ # no content is send
3479
+ channel = self.make_request(
3480
+ "PUT",
3481
+ self.url % self.room_id,
3482
+ access_token=self.admin_user_tok,
3483
+ )
3484
+
3485
+ self.assertEqual(400, channel.code, msg=channel.json_body)
3486
+ self.assertEqual(Codes.NOT_JSON, channel.json_body["errcode"])
3487
+
3488
+ def test_block_room(self) -> None:
3489
+ """Test that block a room is successful."""
3490
+
3491
+ def _request_and_test_block_room(room_id: str) -> None:
3492
+ self._is_blocked(room_id, expect=False)
3493
+ channel = self.make_request(
3494
+ "PUT",
3495
+ self.url % room_id,
3496
+ content={"block": True},
3497
+ access_token=self.admin_user_tok,
3498
+ )
3499
+ self.assertEqual(200, channel.code, msg=channel.json_body)
3500
+ self.assertTrue(channel.json_body["block"])
3501
+ self._is_blocked(room_id, expect=True)
3502
+
3503
+ # known internal room
3504
+ _request_and_test_block_room(self.room_id)
3505
+
3506
+ # unknown internal room
3507
+ _request_and_test_block_room("!unknown:test")
3508
+
3509
+ # unknown remote room
3510
+ _request_and_test_block_room("!unknown:remote")
3511
+
3512
+ def test_block_room_twice(self) -> None:
3513
+ """Test that block a room that is already blocked is successful."""
3514
+
3515
+ self._is_blocked(self.room_id, expect=False)
3516
+ for _ in range(2):
3517
+ channel = self.make_request(
3518
+ "PUT",
3519
+ self.url % self.room_id,
3520
+ content={"block": True},
3521
+ access_token=self.admin_user_tok,
3522
+ )
3523
+ self.assertEqual(200, channel.code, msg=channel.json_body)
3524
+ self.assertTrue(channel.json_body["block"])
3525
+ self._is_blocked(self.room_id, expect=True)
3526
+
3527
+ def test_unblock_room(self) -> None:
3528
+ """Test that unblock a room is successful."""
3529
+
3530
+ def _request_and_test_unblock_room(room_id: str) -> None:
3531
+ self._block_room(room_id)
3532
+
3533
+ channel = self.make_request(
3534
+ "PUT",
3535
+ self.url % room_id,
3536
+ content={"block": False},
3537
+ access_token=self.admin_user_tok,
3538
+ )
3539
+ self.assertEqual(200, channel.code, msg=channel.json_body)
3540
+ self.assertFalse(channel.json_body["block"])
3541
+ self._is_blocked(room_id, expect=False)
3542
+
3543
+ # known internal room
3544
+ _request_and_test_unblock_room(self.room_id)
3545
+
3546
+ # unknown internal room
3547
+ _request_and_test_unblock_room("!unknown:test")
3548
+
3549
+ # unknown remote room
3550
+ _request_and_test_unblock_room("!unknown:remote")
3551
+
3552
+ def test_unblock_room_twice(self) -> None:
3553
+ """Test that unblock a room that is not blocked is successful."""
3554
+
3555
+ self._block_room(self.room_id)
3556
+ for _ in range(2):
3557
+ channel = self.make_request(
3558
+ "PUT",
3559
+ self.url % self.room_id,
3560
+ content={"block": False},
3561
+ access_token=self.admin_user_tok,
3562
+ )
3563
+ self.assertEqual(200, channel.code, msg=channel.json_body)
3564
+ self.assertFalse(channel.json_body["block"])
3565
+ self._is_blocked(self.room_id, expect=False)
3566
+
3567
+ def test_get_blocked_room(self) -> None:
3568
+ """Test get status of a blocked room"""
3569
+
3570
+ def _request_blocked_room(room_id: str) -> None:
3571
+ self._block_room(room_id)
3572
+
3573
+ channel = self.make_request(
3574
+ "GET",
3575
+ self.url % room_id,
3576
+ access_token=self.admin_user_tok,
3577
+ )
3578
+ self.assertEqual(200, channel.code, msg=channel.json_body)
3579
+ self.assertTrue(channel.json_body["block"])
3580
+ self.assertEqual(self.other_user, channel.json_body["user_id"])
3581
+
3582
+ # known internal room
3583
+ _request_blocked_room(self.room_id)
3584
+
3585
+ # unknown internal room
3586
+ _request_blocked_room("!unknown:test")
3587
+
3588
+ # unknown remote room
3589
+ _request_blocked_room("!unknown:remote")
3590
+
3591
+ def test_get_unblocked_room(self) -> None:
3592
+ """Test get status of a unblocked room"""
3593
+
3594
+ def _request_unblocked_room(room_id: str) -> None:
3595
+ self._is_blocked(room_id, expect=False)
3596
+
3597
+ channel = self.make_request(
3598
+ "GET",
3599
+ self.url % room_id,
3600
+ access_token=self.admin_user_tok,
3601
+ )
3602
+ self.assertEqual(200, channel.code, msg=channel.json_body)
3603
+ self.assertFalse(channel.json_body["block"])
3604
+ self.assertNotIn("user_id", channel.json_body)
3605
+
3606
+ # known internal room
3607
+ _request_unblocked_room(self.room_id)
3608
+
3609
+ # unknown internal room
3610
+ _request_unblocked_room("!unknown:test")
3611
+
3612
+ # unknown remote room
3613
+ _request_unblocked_room("!unknown:remote")
3614
+
3615
+ def _is_blocked(self, room_id: str, expect: bool = True) -> None:
3616
+ """Assert that the room is blocked or not"""
3617
+ d = self._store.is_room_blocked(room_id)
3618
+ if expect:
3619
+ self.assertTrue(self.get_success(d))
3620
+ else:
3621
+ self.assertIsNone(self.get_success(d))
3622
+
3623
+ def _block_room(self, room_id: str) -> None:
3624
+ """Block a room in database"""
3625
+ self.get_success(self._store.block_room(room_id, self.other_user))
3626
+ self._is_blocked(room_id, expect=True)