room.py 40 KB

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