room.py 40 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093
  1. # -*- coding: utf-8 -*-
  2. # Copyright 2014 - 2016 OpenMarket Ltd
  3. # Copyright 2018-2019 New Vector Ltd
  4. # Copyright 2019 The Matrix.org Foundation C.I.C.
  5. #
  6. # Licensed under the Apache License, Version 2.0 (the "License");
  7. # you may not use this file except in compliance with the License.
  8. # You may obtain a copy of the License at
  9. #
  10. # http://www.apache.org/licenses/LICENSE-2.0
  11. #
  12. # Unless required by applicable law or agreed to in writing, software
  13. # distributed under the License is distributed on an "AS IS" BASIS,
  14. # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  15. # See the License for the specific language governing permissions and
  16. # limitations under the License.
  17. """Contains functions for performing events on rooms."""
  18. import itertools
  19. import logging
  20. import math
  21. import string
  22. from collections import OrderedDict
  23. from typing import Tuple
  24. from six import iteritems, string_types
  25. from synapse.api.constants import (
  26. EventTypes,
  27. JoinRules,
  28. RoomCreationPreset,
  29. RoomEncryptionAlgorithms,
  30. )
  31. from synapse.api.errors import AuthError, Codes, NotFoundError, StoreError, SynapseError
  32. from synapse.api.room_versions import KNOWN_ROOM_VERSIONS, RoomVersion
  33. from synapse.events.utils import copy_power_levels_contents
  34. from synapse.http.endpoint import parse_and_validate_server_name
  35. from synapse.storage.state import StateFilter
  36. from synapse.types import (
  37. Requester,
  38. RoomAlias,
  39. RoomID,
  40. RoomStreamToken,
  41. StateMap,
  42. StreamToken,
  43. UserID,
  44. )
  45. from synapse.util import stringutils
  46. from synapse.util.async_helpers import Linearizer
  47. from synapse.util.caches.response_cache import ResponseCache
  48. from synapse.visibility import filter_events_for_client
  49. from ._base import BaseHandler
  50. logger = logging.getLogger(__name__)
  51. id_server_scheme = "https://"
  52. FIVE_MINUTES_IN_MS = 5 * 60 * 1000
  53. class RoomCreationHandler(BaseHandler):
  54. def __init__(self, hs):
  55. super(RoomCreationHandler, self).__init__(hs)
  56. self.spam_checker = hs.get_spam_checker()
  57. self.event_creation_handler = hs.get_event_creation_handler()
  58. self.room_member_handler = hs.get_room_member_handler()
  59. self.config = hs.config
  60. # Room state based off defined presets
  61. self._presets_dict = {
  62. RoomCreationPreset.PRIVATE_CHAT: {
  63. "join_rules": JoinRules.INVITE,
  64. "history_visibility": "shared",
  65. "original_invitees_have_ops": False,
  66. "guest_can_join": True,
  67. "power_level_content_override": {"invite": 0},
  68. },
  69. RoomCreationPreset.TRUSTED_PRIVATE_CHAT: {
  70. "join_rules": JoinRules.INVITE,
  71. "history_visibility": "shared",
  72. "original_invitees_have_ops": True,
  73. "guest_can_join": True,
  74. "power_level_content_override": {"invite": 0},
  75. },
  76. RoomCreationPreset.PUBLIC_CHAT: {
  77. "join_rules": JoinRules.PUBLIC,
  78. "history_visibility": "shared",
  79. "original_invitees_have_ops": False,
  80. "guest_can_join": False,
  81. "power_level_content_override": {},
  82. },
  83. }
  84. # Modify presets to selectively enable encryption by default per homeserver config
  85. for preset_name, preset_config in self._presets_dict.items():
  86. encrypted = (
  87. preset_name
  88. in self.config.encryption_enabled_by_default_for_room_presets
  89. )
  90. preset_config["encrypted"] = encrypted
  91. self._replication = hs.get_replication_data_handler()
  92. # linearizer to stop two upgrades happening at once
  93. self._upgrade_linearizer = Linearizer("room_upgrade_linearizer")
  94. # If a user tries to update the same room multiple times in quick
  95. # succession, only process the first attempt and return its result to
  96. # subsequent requests
  97. self._upgrade_response_cache = ResponseCache(
  98. hs, "room_upgrade", timeout_ms=FIVE_MINUTES_IN_MS
  99. )
  100. self._server_notices_mxid = hs.config.server_notices_mxid
  101. self.third_party_event_rules = hs.get_third_party_event_rules()
  102. async def upgrade_room(
  103. self, requester: Requester, old_room_id: str, new_version: RoomVersion
  104. ):
  105. """Replace a room with a new room with a different version
  106. Args:
  107. requester: the user requesting the upgrade
  108. old_room_id: the id of the room to be replaced
  109. new_version: the new room version to use
  110. Returns:
  111. Deferred[unicode]: the new room id
  112. """
  113. await self.ratelimit(requester)
  114. user_id = requester.user.to_string()
  115. # Check if this room is already being upgraded by another person
  116. for key in self._upgrade_response_cache.pending_result_cache:
  117. if key[0] == old_room_id and key[1] != user_id:
  118. # Two different people are trying to upgrade the same room.
  119. # Send the second an error.
  120. #
  121. # Note that this of course only gets caught if both users are
  122. # on the same homeserver.
  123. raise SynapseError(
  124. 400, "An upgrade for this room is currently in progress"
  125. )
  126. # Upgrade the room
  127. #
  128. # If this user has sent multiple upgrade requests for the same room
  129. # and one of them is not complete yet, cache the response and
  130. # return it to all subsequent requests
  131. ret = await self._upgrade_response_cache.wrap(
  132. (old_room_id, user_id),
  133. self._upgrade_room,
  134. requester,
  135. old_room_id,
  136. new_version, # args for _upgrade_room
  137. )
  138. return ret
  139. async def _upgrade_room(
  140. self, requester: Requester, old_room_id: str, new_version: RoomVersion
  141. ):
  142. user_id = requester.user.to_string()
  143. # start by allocating a new room id
  144. r = await self.store.get_room(old_room_id)
  145. if r is None:
  146. raise NotFoundError("Unknown room id %s" % (old_room_id,))
  147. new_room_id = await self._generate_room_id(
  148. creator_id=user_id, is_public=r["is_public"], room_version=new_version,
  149. )
  150. logger.info("Creating new room %s to replace %s", new_room_id, old_room_id)
  151. # we create and auth the tombstone event before properly creating the new
  152. # room, to check our user has perms in the old room.
  153. (
  154. tombstone_event,
  155. tombstone_context,
  156. ) = await self.event_creation_handler.create_event(
  157. requester,
  158. {
  159. "type": EventTypes.Tombstone,
  160. "state_key": "",
  161. "room_id": old_room_id,
  162. "sender": user_id,
  163. "content": {
  164. "body": "This room has been replaced",
  165. "replacement_room": new_room_id,
  166. },
  167. },
  168. token_id=requester.access_token_id,
  169. )
  170. old_room_version = await self.store.get_room_version_id(old_room_id)
  171. await self.auth.check_from_context(
  172. old_room_version, tombstone_event, tombstone_context
  173. )
  174. await self.clone_existing_room(
  175. requester,
  176. old_room_id=old_room_id,
  177. new_room_id=new_room_id,
  178. new_room_version=new_version,
  179. tombstone_event_id=tombstone_event.event_id,
  180. )
  181. # now send the tombstone
  182. await self.event_creation_handler.send_nonmember_event(
  183. requester, tombstone_event, tombstone_context
  184. )
  185. old_room_state = await tombstone_context.get_current_state_ids()
  186. # update any aliases
  187. await self._move_aliases_to_new_room(
  188. requester, old_room_id, new_room_id, old_room_state
  189. )
  190. # Copy over user push rules, tags and migrate room directory state
  191. await self.room_member_handler.transfer_room_state_on_room_upgrade(
  192. old_room_id, new_room_id
  193. )
  194. # finally, shut down the PLs in the old room, and update them in the new
  195. # room.
  196. await self._update_upgraded_room_pls(
  197. requester, old_room_id, new_room_id, old_room_state,
  198. )
  199. return new_room_id
  200. async def _update_upgraded_room_pls(
  201. self,
  202. requester: Requester,
  203. old_room_id: str,
  204. new_room_id: str,
  205. old_room_state: StateMap[str],
  206. ):
  207. """Send updated power levels in both rooms after an upgrade
  208. Args:
  209. requester: the user requesting the upgrade
  210. old_room_id: the id of the room to be replaced
  211. new_room_id: the id of the replacement room
  212. old_room_state: the state map for the old room
  213. Returns:
  214. Deferred
  215. """
  216. old_room_pl_event_id = old_room_state.get((EventTypes.PowerLevels, ""))
  217. if old_room_pl_event_id is None:
  218. logger.warning(
  219. "Not supported: upgrading a room with no PL event. Not setting PLs "
  220. "in old room."
  221. )
  222. return
  223. old_room_pl_state = await self.store.get_event(old_room_pl_event_id)
  224. # we try to stop regular users from speaking by setting the PL required
  225. # to send regular events and invites to 'Moderator' level. That's normally
  226. # 50, but if the default PL in a room is 50 or more, then we set the
  227. # required PL above that.
  228. pl_content = dict(old_room_pl_state.content)
  229. users_default = int(pl_content.get("users_default", 0))
  230. restricted_level = max(users_default + 1, 50)
  231. updated = False
  232. for v in ("invite", "events_default"):
  233. current = int(pl_content.get(v, 0))
  234. if current < restricted_level:
  235. logger.debug(
  236. "Setting level for %s in %s to %i (was %i)",
  237. v,
  238. old_room_id,
  239. restricted_level,
  240. current,
  241. )
  242. pl_content[v] = restricted_level
  243. updated = True
  244. else:
  245. logger.debug("Not setting level for %s (already %i)", v, current)
  246. if updated:
  247. try:
  248. await self.event_creation_handler.create_and_send_nonmember_event(
  249. requester,
  250. {
  251. "type": EventTypes.PowerLevels,
  252. "state_key": "",
  253. "room_id": old_room_id,
  254. "sender": requester.user.to_string(),
  255. "content": pl_content,
  256. },
  257. ratelimit=False,
  258. )
  259. except AuthError as e:
  260. logger.warning("Unable to update PLs in old room: %s", e)
  261. await self.event_creation_handler.create_and_send_nonmember_event(
  262. requester,
  263. {
  264. "type": EventTypes.PowerLevels,
  265. "state_key": "",
  266. "room_id": new_room_id,
  267. "sender": requester.user.to_string(),
  268. "content": old_room_pl_state.content,
  269. },
  270. ratelimit=False,
  271. )
  272. async def clone_existing_room(
  273. self,
  274. requester: Requester,
  275. old_room_id: str,
  276. new_room_id: str,
  277. new_room_version: RoomVersion,
  278. tombstone_event_id: str,
  279. ):
  280. """Populate a new room based on an old room
  281. Args:
  282. requester: the user requesting the upgrade
  283. old_room_id : the id of the room to be replaced
  284. new_room_id: the id to give the new room (should already have been
  285. created with _gemerate_room_id())
  286. new_room_version: the new room version to use
  287. tombstone_event_id: the ID of the tombstone event in the old room.
  288. Returns:
  289. Deferred
  290. """
  291. user_id = requester.user.to_string()
  292. if not self.spam_checker.user_may_create_room(user_id):
  293. raise SynapseError(403, "You are not permitted to create rooms")
  294. creation_content = {
  295. "room_version": new_room_version.identifier,
  296. "predecessor": {"room_id": old_room_id, "event_id": tombstone_event_id},
  297. }
  298. # Check if old room was non-federatable
  299. # Get old room's create event
  300. old_room_create_event = await self.store.get_create_event_for_room(old_room_id)
  301. # Check if the create event specified a non-federatable room
  302. if not old_room_create_event.content.get("m.federate", True):
  303. # If so, mark the new room as non-federatable as well
  304. creation_content["m.federate"] = False
  305. initial_state = {}
  306. # Replicate relevant room events
  307. types_to_copy = (
  308. (EventTypes.JoinRules, ""),
  309. (EventTypes.Name, ""),
  310. (EventTypes.Topic, ""),
  311. (EventTypes.RoomHistoryVisibility, ""),
  312. (EventTypes.GuestAccess, ""),
  313. (EventTypes.RoomAvatar, ""),
  314. (EventTypes.RoomEncryption, ""),
  315. (EventTypes.ServerACL, ""),
  316. (EventTypes.RelatedGroups, ""),
  317. (EventTypes.PowerLevels, ""),
  318. )
  319. old_room_state_ids = await self.store.get_filtered_current_state_ids(
  320. old_room_id, StateFilter.from_types(types_to_copy)
  321. )
  322. # map from event_id to BaseEvent
  323. old_room_state_events = await self.store.get_events(old_room_state_ids.values())
  324. for k, old_event_id in iteritems(old_room_state_ids):
  325. old_event = old_room_state_events.get(old_event_id)
  326. if old_event:
  327. initial_state[k] = old_event.content
  328. # deep-copy the power-levels event before we start modifying it
  329. # note that if frozen_dicts are enabled, `power_levels` will be a frozen
  330. # dict so we can't just copy.deepcopy it.
  331. initial_state[
  332. (EventTypes.PowerLevels, "")
  333. ] = power_levels = copy_power_levels_contents(
  334. initial_state[(EventTypes.PowerLevels, "")]
  335. )
  336. # Resolve the minimum power level required to send any state event
  337. # We will give the upgrading user this power level temporarily (if necessary) such that
  338. # they are able to copy all of the state events over, then revert them back to their
  339. # original power level afterwards in _update_upgraded_room_pls
  340. # Copy over user power levels now as this will not be possible with >100PL users once
  341. # the room has been created
  342. # Calculate the minimum power level needed to clone the room
  343. event_power_levels = power_levels.get("events", {})
  344. state_default = power_levels.get("state_default", 0)
  345. ban = power_levels.get("ban")
  346. needed_power_level = max(state_default, ban, max(event_power_levels.values()))
  347. # Raise the requester's power level in the new room if necessary
  348. current_power_level = power_levels["users"][user_id]
  349. if current_power_level < needed_power_level:
  350. power_levels["users"][user_id] = needed_power_level
  351. await self._send_events_for_new_room(
  352. requester,
  353. new_room_id,
  354. # we expect to override all the presets with initial_state, so this is
  355. # somewhat arbitrary.
  356. preset_config=RoomCreationPreset.PRIVATE_CHAT,
  357. invite_list=[],
  358. initial_state=initial_state,
  359. creation_content=creation_content,
  360. )
  361. # Transfer membership events
  362. old_room_member_state_ids = await self.store.get_filtered_current_state_ids(
  363. old_room_id, StateFilter.from_types([(EventTypes.Member, None)])
  364. )
  365. # map from event_id to BaseEvent
  366. old_room_member_state_events = await self.store.get_events(
  367. old_room_member_state_ids.values()
  368. )
  369. for k, old_event in iteritems(old_room_member_state_events):
  370. # Only transfer ban events
  371. if (
  372. "membership" in old_event.content
  373. and old_event.content["membership"] == "ban"
  374. ):
  375. await self.room_member_handler.update_membership(
  376. requester,
  377. UserID.from_string(old_event["state_key"]),
  378. new_room_id,
  379. "ban",
  380. ratelimit=False,
  381. content=old_event.content,
  382. )
  383. # XXX invites/joins
  384. # XXX 3pid invites
  385. async def _move_aliases_to_new_room(
  386. self,
  387. requester: Requester,
  388. old_room_id: str,
  389. new_room_id: str,
  390. old_room_state: StateMap[str],
  391. ):
  392. # check to see if we have a canonical alias.
  393. canonical_alias_event = None
  394. canonical_alias_event_id = old_room_state.get((EventTypes.CanonicalAlias, ""))
  395. if canonical_alias_event_id:
  396. canonical_alias_event = await self.store.get_event(canonical_alias_event_id)
  397. await self.store.update_aliases_for_room(old_room_id, new_room_id)
  398. if not canonical_alias_event:
  399. return
  400. # If there is a canonical alias we need to update the one in the old
  401. # room and set one in the new one.
  402. old_canonical_alias_content = dict(canonical_alias_event.content)
  403. new_canonical_alias_content = {}
  404. canonical = canonical_alias_event.content.get("alias")
  405. if canonical and self.hs.is_mine_id(canonical):
  406. new_canonical_alias_content["alias"] = canonical
  407. old_canonical_alias_content.pop("alias", None)
  408. # We convert to a list as it will be a Tuple.
  409. old_alt_aliases = list(old_canonical_alias_content.get("alt_aliases", []))
  410. if old_alt_aliases:
  411. old_canonical_alias_content["alt_aliases"] = old_alt_aliases
  412. new_alt_aliases = new_canonical_alias_content.setdefault("alt_aliases", [])
  413. for alias in canonical_alias_event.content.get("alt_aliases", []):
  414. try:
  415. if self.hs.is_mine_id(alias):
  416. new_alt_aliases.append(alias)
  417. old_alt_aliases.remove(alias)
  418. except Exception:
  419. logger.info(
  420. "Invalid alias %s in canonical alias event %s",
  421. alias,
  422. canonical_alias_event_id,
  423. )
  424. if not old_alt_aliases:
  425. old_canonical_alias_content.pop("alt_aliases")
  426. # If a canonical alias event existed for the old room, fire a canonical
  427. # alias event for the new room with a copy of the information.
  428. try:
  429. await self.event_creation_handler.create_and_send_nonmember_event(
  430. requester,
  431. {
  432. "type": EventTypes.CanonicalAlias,
  433. "state_key": "",
  434. "room_id": old_room_id,
  435. "sender": requester.user.to_string(),
  436. "content": old_canonical_alias_content,
  437. },
  438. ratelimit=False,
  439. )
  440. except SynapseError as e:
  441. # again I'm not really expecting this to fail, but if it does, I'd rather
  442. # we returned the new room to the client at this point.
  443. logger.error("Unable to send updated alias events in old room: %s", e)
  444. try:
  445. await self.event_creation_handler.create_and_send_nonmember_event(
  446. requester,
  447. {
  448. "type": EventTypes.CanonicalAlias,
  449. "state_key": "",
  450. "room_id": new_room_id,
  451. "sender": requester.user.to_string(),
  452. "content": new_canonical_alias_content,
  453. },
  454. ratelimit=False,
  455. )
  456. except SynapseError as e:
  457. # again I'm not really expecting this to fail, but if it does, I'd rather
  458. # we returned the new room to the client at this point.
  459. logger.error("Unable to send updated alias events in new room: %s", e)
  460. async def create_room(
  461. self, requester, config, ratelimit=True, creator_join_profile=None
  462. ) -> Tuple[dict, int]:
  463. """ Creates a new room.
  464. Args:
  465. requester (synapse.types.Requester):
  466. The user who requested the room creation.
  467. config (dict) : A dict of configuration options.
  468. ratelimit (bool): set to False to disable the rate limiter
  469. creator_join_profile (dict|None):
  470. Set to override the displayname and avatar for the creating
  471. user in this room. If unset, displayname and avatar will be
  472. derived from the user's profile. If set, should contain the
  473. values to go in the body of the 'join' event (typically
  474. `avatar_url` and/or `displayname`.
  475. Returns:
  476. First, a dict containing the keys `room_id` and, if an alias
  477. was, requested, `room_alias`. Secondly, the stream_id of the
  478. last persisted event.
  479. Raises:
  480. SynapseError if the room ID couldn't be stored, or something went
  481. horribly wrong.
  482. ResourceLimitError if server is blocked to some resource being
  483. exceeded
  484. """
  485. user_id = requester.user.to_string()
  486. await self.auth.check_auth_blocking(user_id)
  487. if (
  488. self._server_notices_mxid is not None
  489. and requester.user.to_string() == self._server_notices_mxid
  490. ):
  491. # allow the server notices mxid to create rooms
  492. is_requester_admin = True
  493. else:
  494. is_requester_admin = await self.auth.is_server_admin(requester.user)
  495. # Check whether the third party rules allows/changes the room create
  496. # request.
  497. event_allowed = await self.third_party_event_rules.on_create_room(
  498. requester, config, is_requester_admin=is_requester_admin
  499. )
  500. if not event_allowed:
  501. raise SynapseError(
  502. 403, "You are not permitted to create rooms", Codes.FORBIDDEN
  503. )
  504. if not is_requester_admin and not self.spam_checker.user_may_create_room(
  505. user_id
  506. ):
  507. raise SynapseError(403, "You are not permitted to create rooms")
  508. if ratelimit:
  509. await self.ratelimit(requester)
  510. room_version_id = config.get(
  511. "room_version", self.config.default_room_version.identifier
  512. )
  513. if not isinstance(room_version_id, string_types):
  514. raise SynapseError(400, "room_version must be a string", Codes.BAD_JSON)
  515. room_version = KNOWN_ROOM_VERSIONS.get(room_version_id)
  516. if room_version is None:
  517. raise SynapseError(
  518. 400,
  519. "Your homeserver does not support this room version",
  520. Codes.UNSUPPORTED_ROOM_VERSION,
  521. )
  522. if "room_alias_name" in config:
  523. for wchar in string.whitespace:
  524. if wchar in config["room_alias_name"]:
  525. raise SynapseError(400, "Invalid characters in room alias")
  526. room_alias = RoomAlias(config["room_alias_name"], self.hs.hostname)
  527. mapping = await self.store.get_association_from_room_alias(room_alias)
  528. if mapping:
  529. raise SynapseError(400, "Room alias already taken", Codes.ROOM_IN_USE)
  530. else:
  531. room_alias = None
  532. invite_list = config.get("invite", [])
  533. for i in invite_list:
  534. try:
  535. uid = UserID.from_string(i)
  536. parse_and_validate_server_name(uid.domain)
  537. except Exception:
  538. raise SynapseError(400, "Invalid user_id: %s" % (i,))
  539. await self.event_creation_handler.assert_accepted_privacy_policy(requester)
  540. power_level_content_override = config.get("power_level_content_override")
  541. if (
  542. power_level_content_override
  543. and "users" in power_level_content_override
  544. and user_id not in power_level_content_override["users"]
  545. ):
  546. raise SynapseError(
  547. 400,
  548. "Not a valid power_level_content_override: 'users' did not contain %s"
  549. % (user_id,),
  550. )
  551. invite_3pid_list = config.get("invite_3pid", [])
  552. visibility = config.get("visibility", None)
  553. is_public = visibility == "public"
  554. room_id = await self._generate_room_id(
  555. creator_id=user_id, is_public=is_public, room_version=room_version,
  556. )
  557. directory_handler = self.hs.get_handlers().directory_handler
  558. if room_alias:
  559. await directory_handler.create_association(
  560. requester=requester,
  561. room_id=room_id,
  562. room_alias=room_alias,
  563. servers=[self.hs.hostname],
  564. check_membership=False,
  565. )
  566. if is_public:
  567. if not self.config.is_publishing_room_allowed(user_id, room_id, room_alias):
  568. # Lets just return a generic message, as there may be all sorts of
  569. # reasons why we said no. TODO: Allow configurable error messages
  570. # per alias creation rule?
  571. raise SynapseError(403, "Not allowed to publish room")
  572. preset_config = config.get(
  573. "preset",
  574. RoomCreationPreset.PRIVATE_CHAT
  575. if visibility == "private"
  576. else RoomCreationPreset.PUBLIC_CHAT,
  577. )
  578. raw_initial_state = config.get("initial_state", [])
  579. initial_state = OrderedDict()
  580. for val in raw_initial_state:
  581. initial_state[(val["type"], val.get("state_key", ""))] = val["content"]
  582. creation_content = config.get("creation_content", {})
  583. # override any attempt to set room versions via the creation_content
  584. creation_content["room_version"] = room_version.identifier
  585. last_stream_id = await self._send_events_for_new_room(
  586. requester,
  587. room_id,
  588. preset_config=preset_config,
  589. invite_list=invite_list,
  590. initial_state=initial_state,
  591. creation_content=creation_content,
  592. room_alias=room_alias,
  593. power_level_content_override=power_level_content_override,
  594. creator_join_profile=creator_join_profile,
  595. )
  596. if "name" in config:
  597. name = config["name"]
  598. (
  599. _,
  600. last_stream_id,
  601. ) = await self.event_creation_handler.create_and_send_nonmember_event(
  602. requester,
  603. {
  604. "type": EventTypes.Name,
  605. "room_id": room_id,
  606. "sender": user_id,
  607. "state_key": "",
  608. "content": {"name": name},
  609. },
  610. ratelimit=False,
  611. )
  612. if "topic" in config:
  613. topic = config["topic"]
  614. (
  615. _,
  616. last_stream_id,
  617. ) = await self.event_creation_handler.create_and_send_nonmember_event(
  618. requester,
  619. {
  620. "type": EventTypes.Topic,
  621. "room_id": room_id,
  622. "sender": user_id,
  623. "state_key": "",
  624. "content": {"topic": topic},
  625. },
  626. ratelimit=False,
  627. )
  628. for invitee in invite_list:
  629. content = {}
  630. is_direct = config.get("is_direct", None)
  631. if is_direct:
  632. content["is_direct"] = is_direct
  633. _, last_stream_id = await self.room_member_handler.update_membership(
  634. requester,
  635. UserID.from_string(invitee),
  636. room_id,
  637. "invite",
  638. ratelimit=False,
  639. content=content,
  640. )
  641. for invite_3pid in invite_3pid_list:
  642. id_server = invite_3pid["id_server"]
  643. id_access_token = invite_3pid.get("id_access_token") # optional
  644. address = invite_3pid["address"]
  645. medium = invite_3pid["medium"]
  646. last_stream_id = await self.hs.get_room_member_handler().do_3pid_invite(
  647. room_id,
  648. requester.user,
  649. medium,
  650. address,
  651. id_server,
  652. requester,
  653. txn_id=None,
  654. id_access_token=id_access_token,
  655. )
  656. result = {"room_id": room_id}
  657. if room_alias:
  658. result["room_alias"] = room_alias.to_string()
  659. # Always wait for room creation to progate before returning
  660. await self._replication.wait_for_stream_position(
  661. self.hs.config.worker.writers.events, "events", last_stream_id
  662. )
  663. return result, last_stream_id
  664. async def _send_events_for_new_room(
  665. self,
  666. creator, # A Requester object.
  667. room_id,
  668. preset_config,
  669. invite_list,
  670. initial_state,
  671. creation_content,
  672. room_alias=None,
  673. power_level_content_override=None, # Doesn't apply when initial state has power level state event content
  674. creator_join_profile=None,
  675. ) -> int:
  676. """Sends the initial events into a new room.
  677. Returns:
  678. The stream_id of the last event persisted.
  679. """
  680. def create(etype, content, **kwargs):
  681. e = {"type": etype, "content": content}
  682. e.update(event_keys)
  683. e.update(kwargs)
  684. return e
  685. async def send(etype, content, **kwargs) -> int:
  686. event = create(etype, content, **kwargs)
  687. logger.debug("Sending %s in new room", etype)
  688. (
  689. _,
  690. last_stream_id,
  691. ) = await self.event_creation_handler.create_and_send_nonmember_event(
  692. creator, event, ratelimit=False
  693. )
  694. return last_stream_id
  695. config = self._presets_dict[preset_config]
  696. creator_id = creator.user.to_string()
  697. event_keys = {"room_id": room_id, "sender": creator_id, "state_key": ""}
  698. creation_content.update({"creator": creator_id})
  699. await send(etype=EventTypes.Create, content=creation_content)
  700. logger.debug("Sending %s in new room", EventTypes.Member)
  701. await self.room_member_handler.update_membership(
  702. creator,
  703. creator.user,
  704. room_id,
  705. "join",
  706. ratelimit=False,
  707. content=creator_join_profile,
  708. )
  709. # We treat the power levels override specially as this needs to be one
  710. # of the first events that get sent into a room.
  711. pl_content = initial_state.pop((EventTypes.PowerLevels, ""), None)
  712. if pl_content is not None:
  713. last_sent_stream_id = await send(
  714. etype=EventTypes.PowerLevels, content=pl_content
  715. )
  716. else:
  717. power_level_content = {
  718. "users": {creator_id: 100},
  719. "users_default": 0,
  720. "events": {
  721. EventTypes.Name: 50,
  722. EventTypes.PowerLevels: 100,
  723. EventTypes.RoomHistoryVisibility: 100,
  724. EventTypes.CanonicalAlias: 50,
  725. EventTypes.RoomAvatar: 50,
  726. EventTypes.Tombstone: 100,
  727. EventTypes.ServerACL: 100,
  728. EventTypes.RoomEncryption: 100,
  729. },
  730. "events_default": 0,
  731. "state_default": 50,
  732. "ban": 50,
  733. "kick": 50,
  734. "redact": 50,
  735. "invite": 50,
  736. }
  737. if config["original_invitees_have_ops"]:
  738. for invitee in invite_list:
  739. power_level_content["users"][invitee] = 100
  740. # Power levels overrides are defined per chat preset
  741. power_level_content.update(config["power_level_content_override"])
  742. if power_level_content_override:
  743. power_level_content.update(power_level_content_override)
  744. last_sent_stream_id = await send(
  745. etype=EventTypes.PowerLevels, content=power_level_content
  746. )
  747. if room_alias and (EventTypes.CanonicalAlias, "") not in initial_state:
  748. last_sent_stream_id = await send(
  749. etype=EventTypes.CanonicalAlias,
  750. content={"alias": room_alias.to_string()},
  751. )
  752. if (EventTypes.JoinRules, "") not in initial_state:
  753. last_sent_stream_id = await send(
  754. etype=EventTypes.JoinRules, content={"join_rule": config["join_rules"]}
  755. )
  756. if (EventTypes.RoomHistoryVisibility, "") not in initial_state:
  757. last_sent_stream_id = await send(
  758. etype=EventTypes.RoomHistoryVisibility,
  759. content={"history_visibility": config["history_visibility"]},
  760. )
  761. if config["guest_can_join"]:
  762. if (EventTypes.GuestAccess, "") not in initial_state:
  763. last_sent_stream_id = await send(
  764. etype=EventTypes.GuestAccess, content={"guest_access": "can_join"}
  765. )
  766. for (etype, state_key), content in initial_state.items():
  767. last_sent_stream_id = await send(
  768. etype=etype, state_key=state_key, content=content
  769. )
  770. if config["encrypted"]:
  771. last_sent_stream_id = await send(
  772. etype=EventTypes.RoomEncryption,
  773. state_key="",
  774. content={"algorithm": RoomEncryptionAlgorithms.DEFAULT},
  775. )
  776. return last_sent_stream_id
  777. async def _generate_room_id(
  778. self, creator_id: str, is_public: str, room_version: RoomVersion,
  779. ):
  780. # autogen room IDs and try to create it. We may clash, so just
  781. # try a few times till one goes through, giving up eventually.
  782. attempts = 0
  783. while attempts < 5:
  784. try:
  785. random_string = stringutils.random_string(18)
  786. gen_room_id = RoomID(random_string, self.hs.hostname).to_string()
  787. if isinstance(gen_room_id, bytes):
  788. gen_room_id = gen_room_id.decode("utf-8")
  789. await self.store.store_room(
  790. room_id=gen_room_id,
  791. room_creator_user_id=creator_id,
  792. is_public=is_public,
  793. room_version=room_version,
  794. )
  795. return gen_room_id
  796. except StoreError:
  797. attempts += 1
  798. raise StoreError(500, "Couldn't generate a room ID.")
  799. class RoomContextHandler(object):
  800. def __init__(self, hs):
  801. self.hs = hs
  802. self.store = hs.get_datastore()
  803. self.storage = hs.get_storage()
  804. self.state_store = self.storage.state
  805. async def get_event_context(self, user, room_id, event_id, limit, event_filter):
  806. """Retrieves events, pagination tokens and state around a given event
  807. in a room.
  808. Args:
  809. user (UserID)
  810. room_id (str)
  811. event_id (str)
  812. limit (int): The maximum number of events to return in total
  813. (excluding state).
  814. event_filter (Filter|None): the filter to apply to the events returned
  815. (excluding the target event_id)
  816. Returns:
  817. dict, or None if the event isn't found
  818. """
  819. before_limit = math.floor(limit / 2.0)
  820. after_limit = limit - before_limit
  821. users = await self.store.get_users_in_room(room_id)
  822. is_peeking = user.to_string() not in users
  823. def filter_evts(events):
  824. return filter_events_for_client(
  825. self.storage, user.to_string(), events, is_peeking=is_peeking
  826. )
  827. event = await self.store.get_event(
  828. event_id, get_prev_content=True, allow_none=True
  829. )
  830. if not event:
  831. return None
  832. filtered = await filter_evts([event])
  833. if not filtered:
  834. raise AuthError(403, "You don't have permission to access that event.")
  835. results = await self.store.get_events_around(
  836. room_id, event_id, before_limit, after_limit, event_filter
  837. )
  838. if event_filter:
  839. results["events_before"] = event_filter.filter(results["events_before"])
  840. results["events_after"] = event_filter.filter(results["events_after"])
  841. results["events_before"] = await filter_evts(results["events_before"])
  842. results["events_after"] = await filter_evts(results["events_after"])
  843. # filter_evts can return a pruned event in case the user is allowed to see that
  844. # there's something there but not see the content, so use the event that's in
  845. # `filtered` rather than the event we retrieved from the datastore.
  846. results["event"] = filtered[0]
  847. if results["events_after"]:
  848. last_event_id = results["events_after"][-1].event_id
  849. else:
  850. last_event_id = event_id
  851. if event_filter and event_filter.lazy_load_members():
  852. state_filter = StateFilter.from_lazy_load_member_list(
  853. ev.sender
  854. for ev in itertools.chain(
  855. results["events_before"],
  856. (results["event"],),
  857. results["events_after"],
  858. )
  859. )
  860. else:
  861. state_filter = StateFilter.all()
  862. # XXX: why do we return the state as of the last event rather than the
  863. # first? Shouldn't we be consistent with /sync?
  864. # https://github.com/matrix-org/matrix-doc/issues/687
  865. state = await self.state_store.get_state_for_events(
  866. [last_event_id], state_filter=state_filter
  867. )
  868. state_events = list(state[last_event_id].values())
  869. if event_filter:
  870. state_events = event_filter.filter(state_events)
  871. results["state"] = await filter_evts(state_events)
  872. # We use a dummy token here as we only care about the room portion of
  873. # the token, which we replace.
  874. token = StreamToken.START
  875. results["start"] = token.copy_and_replace(
  876. "room_key", results["start"]
  877. ).to_string()
  878. results["end"] = token.copy_and_replace("room_key", results["end"]).to_string()
  879. return results
  880. class RoomEventSource(object):
  881. def __init__(self, hs):
  882. self.store = hs.get_datastore()
  883. async def get_new_events(
  884. self, user, from_key, limit, room_ids, is_guest, explicit_room_id=None
  885. ):
  886. # We just ignore the key for now.
  887. to_key = await self.get_current_key()
  888. from_token = RoomStreamToken.parse(from_key)
  889. if from_token.topological:
  890. logger.warning("Stream has topological part!!!! %r", from_key)
  891. from_key = "s%s" % (from_token.stream,)
  892. app_service = self.store.get_app_service_by_user_id(user.to_string())
  893. if app_service:
  894. # We no longer support AS users using /sync directly.
  895. # See https://github.com/matrix-org/matrix-doc/issues/1144
  896. raise NotImplementedError()
  897. else:
  898. room_events = await self.store.get_membership_changes_for_user(
  899. user.to_string(), from_key, to_key
  900. )
  901. room_to_events = await self.store.get_room_events_stream_for_rooms(
  902. room_ids=room_ids,
  903. from_key=from_key,
  904. to_key=to_key,
  905. limit=limit or 10,
  906. order="ASC",
  907. )
  908. events = list(room_events)
  909. events.extend(e for evs, _ in room_to_events.values() for e in evs)
  910. events.sort(key=lambda e: e.internal_metadata.order)
  911. if limit:
  912. events[:] = events[:limit]
  913. if events:
  914. end_key = events[-1].internal_metadata.after
  915. else:
  916. end_key = to_key
  917. return (events, end_key)
  918. def get_current_key(self):
  919. return self.store.get_room_events_max_id()
  920. def get_current_key_for_room(self, room_id):
  921. return self.store.get_room_events_max_id(room_id)