message.py 35 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904
  1. # -*- coding: utf-8 -*-
  2. # Copyright 2014-2016 OpenMarket Ltd
  3. # Copyright 2017-2018 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. import logging
  18. from six import iteritems, itervalues, string_types
  19. from canonicaljson import encode_canonical_json, json
  20. from twisted.internet import defer
  21. from twisted.internet.defer import succeed
  22. from synapse import event_auth
  23. from synapse.api.constants import EventTypes, Membership, RelationTypes
  24. from synapse.api.errors import (
  25. AuthError,
  26. Codes,
  27. ConsentNotGivenError,
  28. NotFoundError,
  29. SynapseError,
  30. )
  31. from synapse.api.room_versions import RoomVersions
  32. from synapse.api.urls import ConsentURIBuilder
  33. from synapse.events.validator import EventValidator
  34. from synapse.logging.context import run_in_background
  35. from synapse.metrics.background_process_metrics import run_as_background_process
  36. from synapse.replication.http.send_event import ReplicationSendEventRestServlet
  37. from synapse.storage.state import StateFilter
  38. from synapse.types import RoomAlias, UserID, create_requester
  39. from synapse.util.async_helpers import Linearizer
  40. from synapse.util.frozenutils import frozendict_json_encoder
  41. from synapse.util.metrics import measure_func
  42. from synapse.visibility import filter_events_for_client
  43. from ._base import BaseHandler
  44. logger = logging.getLogger(__name__)
  45. class MessageHandler(object):
  46. """Contains some read only APIs to get state about a room
  47. """
  48. def __init__(self, hs):
  49. self.auth = hs.get_auth()
  50. self.clock = hs.get_clock()
  51. self.state = hs.get_state_handler()
  52. self.store = hs.get_datastore()
  53. self._event_serializer = hs.get_event_client_serializer()
  54. @defer.inlineCallbacks
  55. def get_room_data(
  56. self, user_id=None, room_id=None, event_type=None, state_key="", is_guest=False
  57. ):
  58. """ Get data from a room.
  59. Args:
  60. event : The room path event
  61. Returns:
  62. The path data content.
  63. Raises:
  64. SynapseError if something went wrong.
  65. """
  66. membership, membership_event_id = yield self.auth.check_in_room_or_world_readable(
  67. room_id, user_id
  68. )
  69. if membership == Membership.JOIN:
  70. data = yield self.state.get_current_state(room_id, event_type, state_key)
  71. elif membership == Membership.LEAVE:
  72. key = (event_type, state_key)
  73. room_state = yield self.store.get_state_for_events(
  74. [membership_event_id], StateFilter.from_types([key])
  75. )
  76. data = room_state[membership_event_id].get(key)
  77. return data
  78. @defer.inlineCallbacks
  79. def get_state_events(
  80. self,
  81. user_id,
  82. room_id,
  83. state_filter=StateFilter.all(),
  84. at_token=None,
  85. is_guest=False,
  86. ):
  87. """Retrieve all state events for a given room. If the user is
  88. joined to the room then return the current state. If the user has
  89. left the room return the state events from when they left. If an explicit
  90. 'at' parameter is passed, return the state events as of that event, if
  91. visible.
  92. Args:
  93. user_id(str): The user requesting state events.
  94. room_id(str): The room ID to get all state events from.
  95. state_filter (StateFilter): The state filter used to fetch state
  96. from the database.
  97. at_token(StreamToken|None): the stream token of the at which we are requesting
  98. the stats. If the user is not allowed to view the state as of that
  99. stream token, we raise a 403 SynapseError. If None, returns the current
  100. state based on the current_state_events table.
  101. is_guest(bool): whether this user is a guest
  102. Returns:
  103. A list of dicts representing state events. [{}, {}, {}]
  104. Raises:
  105. NotFoundError (404) if the at token does not yield an event
  106. AuthError (403) if the user doesn't have permission to view
  107. members of this room.
  108. """
  109. if at_token:
  110. # FIXME this claims to get the state at a stream position, but
  111. # get_recent_events_for_room operates by topo ordering. This therefore
  112. # does not reliably give you the state at the given stream position.
  113. # (https://github.com/matrix-org/synapse/issues/3305)
  114. last_events, _ = yield self.store.get_recent_events_for_room(
  115. room_id, end_token=at_token.room_key, limit=1
  116. )
  117. if not last_events:
  118. raise NotFoundError("Can't find event for token %s" % (at_token,))
  119. visible_events = yield filter_events_for_client(
  120. self.store, user_id, last_events
  121. )
  122. event = last_events[0]
  123. if visible_events:
  124. room_state = yield self.store.get_state_for_events(
  125. [event.event_id], state_filter=state_filter
  126. )
  127. room_state = room_state[event.event_id]
  128. else:
  129. raise AuthError(
  130. 403,
  131. "User %s not allowed to view events in room %s at token %s"
  132. % (user_id, room_id, at_token),
  133. )
  134. else:
  135. membership, membership_event_id = (
  136. yield self.auth.check_in_room_or_world_readable(room_id, user_id)
  137. )
  138. if membership == Membership.JOIN:
  139. state_ids = yield self.store.get_filtered_current_state_ids(
  140. room_id, state_filter=state_filter
  141. )
  142. room_state = yield self.store.get_events(state_ids.values())
  143. elif membership == Membership.LEAVE:
  144. room_state = yield self.store.get_state_for_events(
  145. [membership_event_id], state_filter=state_filter
  146. )
  147. room_state = room_state[membership_event_id]
  148. now = self.clock.time_msec()
  149. events = yield self._event_serializer.serialize_events(
  150. room_state.values(),
  151. now,
  152. # We don't bother bundling aggregations in when asked for state
  153. # events, as clients won't use them.
  154. bundle_aggregations=False,
  155. )
  156. return events
  157. @defer.inlineCallbacks
  158. def get_joined_members(self, requester, room_id):
  159. """Get all the joined members in the room and their profile information.
  160. If the user has left the room return the state events from when they left.
  161. Args:
  162. requester(Requester): The user requesting state events.
  163. room_id(str): The room ID to get all state events from.
  164. Returns:
  165. A dict of user_id to profile info
  166. """
  167. user_id = requester.user.to_string()
  168. if not requester.app_service:
  169. # We check AS auth after fetching the room membership, as it
  170. # requires us to pull out all joined members anyway.
  171. membership, _ = yield self.auth.check_in_room_or_world_readable(
  172. room_id, user_id
  173. )
  174. if membership != Membership.JOIN:
  175. raise NotImplementedError(
  176. "Getting joined members after leaving is not implemented"
  177. )
  178. users_with_profile = yield self.state.get_current_users_in_room(room_id)
  179. # If this is an AS, double check that they are allowed to see the members.
  180. # This can either be because the AS user is in the room or because there
  181. # is a user in the room that the AS is "interested in"
  182. if requester.app_service and user_id not in users_with_profile:
  183. for uid in users_with_profile:
  184. if requester.app_service.is_interested_in_user(uid):
  185. break
  186. else:
  187. # Loop fell through, AS has no interested users in room
  188. raise AuthError(403, "Appservice not in room")
  189. return {
  190. user_id: {
  191. "avatar_url": profile.avatar_url,
  192. "display_name": profile.display_name,
  193. }
  194. for user_id, profile in iteritems(users_with_profile)
  195. }
  196. class EventCreationHandler(object):
  197. def __init__(self, hs):
  198. self.hs = hs
  199. self.auth = hs.get_auth()
  200. self.store = hs.get_datastore()
  201. self.state = hs.get_state_handler()
  202. self.clock = hs.get_clock()
  203. self.validator = EventValidator()
  204. self.profile_handler = hs.get_profile_handler()
  205. self.event_builder_factory = hs.get_event_builder_factory()
  206. self.server_name = hs.hostname
  207. self.ratelimiter = hs.get_ratelimiter()
  208. self.notifier = hs.get_notifier()
  209. self.config = hs.config
  210. self.require_membership_for_aliases = hs.config.require_membership_for_aliases
  211. self.send_event_to_master = ReplicationSendEventRestServlet.make_client(hs)
  212. # This is only used to get at ratelimit function, and maybe_kick_guest_users
  213. self.base_handler = BaseHandler(hs)
  214. self.pusher_pool = hs.get_pusherpool()
  215. # We arbitrarily limit concurrent event creation for a room to 5.
  216. # This is to stop us from diverging history *too* much.
  217. self.limiter = Linearizer(max_count=5, name="room_event_creation_limit")
  218. self.action_generator = hs.get_action_generator()
  219. self.spam_checker = hs.get_spam_checker()
  220. self.third_party_event_rules = hs.get_third_party_event_rules()
  221. self._block_events_without_consent_error = (
  222. self.config.block_events_without_consent_error
  223. )
  224. # we need to construct a ConsentURIBuilder here, as it checks that the necessary
  225. # config options, but *only* if we have a configuration for which we are
  226. # going to need it.
  227. if self._block_events_without_consent_error:
  228. self._consent_uri_builder = ConsentURIBuilder(self.config)
  229. if (
  230. not self.config.worker_app
  231. and self.config.cleanup_extremities_with_dummy_events
  232. ):
  233. self.clock.looping_call(
  234. lambda: run_as_background_process(
  235. "send_dummy_events_to_fill_extremities",
  236. self._send_dummy_events_to_fill_extremities,
  237. ),
  238. 5 * 60 * 1000,
  239. )
  240. @defer.inlineCallbacks
  241. def create_event(
  242. self,
  243. requester,
  244. event_dict,
  245. token_id=None,
  246. txn_id=None,
  247. prev_events_and_hashes=None,
  248. require_consent=True,
  249. ):
  250. """
  251. Given a dict from a client, create a new event.
  252. Creates an FrozenEvent object, filling out auth_events, prev_events,
  253. etc.
  254. Adds display names to Join membership events.
  255. Args:
  256. requester
  257. event_dict (dict): An entire event
  258. token_id (str)
  259. txn_id (str)
  260. prev_events_and_hashes (list[(str, dict[str, str], int)]|None):
  261. the forward extremities to use as the prev_events for the
  262. new event. For each event, a tuple of (event_id, hashes, depth)
  263. where *hashes* is a map from algorithm to hash.
  264. If None, they will be requested from the database.
  265. require_consent (bool): Whether to check if the requester has
  266. consented to privacy policy.
  267. Raises:
  268. ResourceLimitError if server is blocked to some resource being
  269. exceeded
  270. Returns:
  271. Tuple of created event (FrozenEvent), Context
  272. """
  273. yield self.auth.check_auth_blocking(requester.user.to_string())
  274. if event_dict["type"] == EventTypes.Create and event_dict["state_key"] == "":
  275. room_version = event_dict["content"]["room_version"]
  276. else:
  277. try:
  278. room_version = yield self.store.get_room_version(event_dict["room_id"])
  279. except NotFoundError:
  280. raise AuthError(403, "Unknown room")
  281. builder = self.event_builder_factory.new(room_version, event_dict)
  282. self.validator.validate_builder(builder)
  283. if builder.type == EventTypes.Member:
  284. membership = builder.content.get("membership", None)
  285. target = UserID.from_string(builder.state_key)
  286. if membership in {Membership.JOIN, Membership.INVITE}:
  287. # If event doesn't include a display name, add one.
  288. profile = self.profile_handler
  289. content = builder.content
  290. try:
  291. if "displayname" not in content:
  292. content["displayname"] = yield profile.get_displayname(target)
  293. if "avatar_url" not in content:
  294. content["avatar_url"] = yield profile.get_avatar_url(target)
  295. except Exception as e:
  296. logger.info(
  297. "Failed to get profile information for %r: %s", target, e
  298. )
  299. is_exempt = yield self._is_exempt_from_privacy_policy(builder, requester)
  300. if require_consent and not is_exempt:
  301. yield self.assert_accepted_privacy_policy(requester)
  302. if token_id is not None:
  303. builder.internal_metadata.token_id = token_id
  304. if txn_id is not None:
  305. builder.internal_metadata.txn_id = txn_id
  306. event, context = yield self.create_new_client_event(
  307. builder=builder,
  308. requester=requester,
  309. prev_events_and_hashes=prev_events_and_hashes,
  310. )
  311. # In an ideal world we wouldn't need the second part of this condition. However,
  312. # this behaviour isn't spec'd yet, meaning we should be able to deactivate this
  313. # behaviour. Another reason is that this code is also evaluated each time a new
  314. # m.room.aliases event is created, which includes hitting a /directory route.
  315. # Therefore not including this condition here would render the similar one in
  316. # synapse.handlers.directory pointless.
  317. if builder.type == EventTypes.Aliases and self.require_membership_for_aliases:
  318. # Ideally we'd do the membership check in event_auth.check(), which
  319. # describes a spec'd algorithm for authenticating events received over
  320. # federation as well as those created locally. As of room v3, aliases events
  321. # can be created by users that are not in the room, therefore we have to
  322. # tolerate them in event_auth.check().
  323. prev_state_ids = yield context.get_prev_state_ids(self.store)
  324. prev_event_id = prev_state_ids.get((EventTypes.Member, event.sender))
  325. prev_event = yield self.store.get_event(prev_event_id, allow_none=True)
  326. if not prev_event or prev_event.membership != Membership.JOIN:
  327. logger.warning(
  328. (
  329. "Attempt to send `m.room.aliases` in room %s by user %s but"
  330. " membership is %s"
  331. ),
  332. event.room_id,
  333. event.sender,
  334. prev_event.membership if prev_event else None,
  335. )
  336. raise AuthError(
  337. 403, "You must be in the room to create an alias for it"
  338. )
  339. self.validator.validate_new(event)
  340. return (event, context)
  341. def _is_exempt_from_privacy_policy(self, builder, requester):
  342. """"Determine if an event to be sent is exempt from having to consent
  343. to the privacy policy
  344. Args:
  345. builder (synapse.events.builder.EventBuilder): event being created
  346. requester (Requster): user requesting this event
  347. Returns:
  348. Deferred[bool]: true if the event can be sent without the user
  349. consenting
  350. """
  351. # the only thing the user can do is join the server notices room.
  352. if builder.type == EventTypes.Member:
  353. membership = builder.content.get("membership", None)
  354. if membership == Membership.JOIN:
  355. return self._is_server_notices_room(builder.room_id)
  356. elif membership == Membership.LEAVE:
  357. # the user is always allowed to leave (but not kick people)
  358. return builder.state_key == requester.user.to_string()
  359. return succeed(False)
  360. @defer.inlineCallbacks
  361. def _is_server_notices_room(self, room_id):
  362. if self.config.server_notices_mxid is None:
  363. return False
  364. user_ids = yield self.store.get_users_in_room(room_id)
  365. return self.config.server_notices_mxid in user_ids
  366. @defer.inlineCallbacks
  367. def assert_accepted_privacy_policy(self, requester):
  368. """Check if a user has accepted the privacy policy
  369. Called when the given user is about to do something that requires
  370. privacy consent. We see if the user is exempt and otherwise check that
  371. they have given consent. If they have not, a ConsentNotGiven error is
  372. raised.
  373. Args:
  374. requester (synapse.types.Requester):
  375. The user making the request
  376. Returns:
  377. Deferred[None]: returns normally if the user has consented or is
  378. exempt
  379. Raises:
  380. ConsentNotGivenError: if the user has not given consent yet
  381. """
  382. if self._block_events_without_consent_error is None:
  383. return
  384. # exempt AS users from needing consent
  385. if requester.app_service is not None:
  386. return
  387. user_id = requester.user.to_string()
  388. # exempt the system notices user
  389. if (
  390. self.config.server_notices_mxid is not None
  391. and user_id == self.config.server_notices_mxid
  392. ):
  393. return
  394. u = yield self.store.get_user_by_id(user_id)
  395. assert u is not None
  396. if u["appservice_id"] is not None:
  397. # users registered by an appservice are exempt
  398. return
  399. if u["consent_version"] == self.config.user_consent_version:
  400. return
  401. consent_uri = self._consent_uri_builder.build_user_consent_uri(
  402. requester.user.localpart
  403. )
  404. msg = self._block_events_without_consent_error % {"consent_uri": consent_uri}
  405. raise ConsentNotGivenError(msg=msg, consent_uri=consent_uri)
  406. @defer.inlineCallbacks
  407. def send_nonmember_event(self, requester, event, context, ratelimit=True):
  408. """
  409. Persists and notifies local clients and federation of an event.
  410. Args:
  411. event (FrozenEvent) the event to send.
  412. context (Context) the context of the event.
  413. ratelimit (bool): Whether to rate limit this send.
  414. is_guest (bool): Whether the sender is a guest.
  415. """
  416. if event.type == EventTypes.Member:
  417. raise SynapseError(
  418. 500, "Tried to send member event through non-member codepath"
  419. )
  420. user = UserID.from_string(event.sender)
  421. assert self.hs.is_mine(user), "User must be our own: %s" % (user,)
  422. if event.is_state():
  423. prev_state = yield self.deduplicate_state_event(event, context)
  424. if prev_state is not None:
  425. logger.info(
  426. "Not bothering to persist state event %s duplicated by %s",
  427. event.event_id,
  428. prev_state.event_id,
  429. )
  430. return prev_state
  431. yield self.handle_new_client_event(
  432. requester=requester, event=event, context=context, ratelimit=ratelimit
  433. )
  434. @defer.inlineCallbacks
  435. def deduplicate_state_event(self, event, context):
  436. """
  437. Checks whether event is in the latest resolved state in context.
  438. If so, returns the version of the event in context.
  439. Otherwise, returns None.
  440. """
  441. prev_state_ids = yield context.get_prev_state_ids(self.store)
  442. prev_event_id = prev_state_ids.get((event.type, event.state_key))
  443. prev_event = yield self.store.get_event(prev_event_id, allow_none=True)
  444. if not prev_event:
  445. return
  446. if prev_event and event.user_id == prev_event.user_id:
  447. prev_content = encode_canonical_json(prev_event.content)
  448. next_content = encode_canonical_json(event.content)
  449. if prev_content == next_content:
  450. return prev_event
  451. return
  452. @defer.inlineCallbacks
  453. def create_and_send_nonmember_event(
  454. self, requester, event_dict, ratelimit=True, txn_id=None
  455. ):
  456. """
  457. Creates an event, then sends it.
  458. See self.create_event and self.send_nonmember_event.
  459. """
  460. # We limit the number of concurrent event sends in a room so that we
  461. # don't fork the DAG too much. If we don't limit then we can end up in
  462. # a situation where event persistence can't keep up, causing
  463. # extremities to pile up, which in turn leads to state resolution
  464. # taking longer.
  465. with (yield self.limiter.queue(event_dict["room_id"])):
  466. event, context = yield self.create_event(
  467. requester, event_dict, token_id=requester.access_token_id, txn_id=txn_id
  468. )
  469. spam_error = self.spam_checker.check_event_for_spam(event)
  470. if spam_error:
  471. if not isinstance(spam_error, string_types):
  472. spam_error = "Spam is not permitted here"
  473. raise SynapseError(403, spam_error, Codes.FORBIDDEN)
  474. yield self.send_nonmember_event(
  475. requester, event, context, ratelimit=ratelimit
  476. )
  477. return event
  478. @measure_func("create_new_client_event")
  479. @defer.inlineCallbacks
  480. def create_new_client_event(
  481. self, builder, requester=None, prev_events_and_hashes=None
  482. ):
  483. """Create a new event for a local client
  484. Args:
  485. builder (EventBuilder):
  486. requester (synapse.types.Requester|None):
  487. prev_events_and_hashes (list[(str, dict[str, str], int)]|None):
  488. the forward extremities to use as the prev_events for the
  489. new event. For each event, a tuple of (event_id, hashes, depth)
  490. where *hashes* is a map from algorithm to hash.
  491. If None, they will be requested from the database.
  492. Returns:
  493. Deferred[(synapse.events.EventBase, synapse.events.snapshot.EventContext)]
  494. """
  495. if prev_events_and_hashes is not None:
  496. assert len(prev_events_and_hashes) <= 10, (
  497. "Attempting to create an event with %i prev_events"
  498. % (len(prev_events_and_hashes),)
  499. )
  500. else:
  501. prev_events_and_hashes = yield self.store.get_prev_events_for_room(
  502. builder.room_id
  503. )
  504. prev_events = [
  505. (event_id, prev_hashes)
  506. for event_id, prev_hashes, _ in prev_events_and_hashes
  507. ]
  508. event = yield builder.build(prev_event_ids=[p for p, _ in prev_events])
  509. context = yield self.state.compute_event_context(event)
  510. if requester:
  511. context.app_service = requester.app_service
  512. self.validator.validate_new(event)
  513. # If this event is an annotation then we check that that the sender
  514. # can't annotate the same way twice (e.g. stops users from liking an
  515. # event multiple times).
  516. relation = event.content.get("m.relates_to", {})
  517. if relation.get("rel_type") == RelationTypes.ANNOTATION:
  518. relates_to = relation["event_id"]
  519. aggregation_key = relation["key"]
  520. already_exists = yield self.store.has_user_annotated_event(
  521. relates_to, event.type, aggregation_key, event.sender
  522. )
  523. if already_exists:
  524. raise SynapseError(400, "Can't send same reaction twice")
  525. logger.debug("Created event %s", event.event_id)
  526. return (event, context)
  527. @measure_func("handle_new_client_event")
  528. @defer.inlineCallbacks
  529. def handle_new_client_event(
  530. self, requester, event, context, ratelimit=True, extra_users=[]
  531. ):
  532. """Processes a new event. This includes checking auth, persisting it,
  533. notifying users, sending to remote servers, etc.
  534. If called from a worker will hit out to the master process for final
  535. processing.
  536. Args:
  537. requester (Requester)
  538. event (FrozenEvent)
  539. context (EventContext)
  540. ratelimit (bool)
  541. extra_users (list(UserID)): Any extra users to notify about event
  542. """
  543. if event.is_state() and (event.type, event.state_key) == (
  544. EventTypes.Create,
  545. "",
  546. ):
  547. room_version = event.content.get("room_version", RoomVersions.V1.identifier)
  548. else:
  549. room_version = yield self.store.get_room_version(event.room_id)
  550. event_allowed = yield self.third_party_event_rules.check_event_allowed(
  551. event, context
  552. )
  553. if not event_allowed:
  554. raise SynapseError(
  555. 403, "This event is not allowed in this context", Codes.FORBIDDEN
  556. )
  557. try:
  558. yield self.auth.check_from_context(room_version, event, context)
  559. except AuthError as err:
  560. logger.warn("Denying new event %r because %s", event, err)
  561. raise err
  562. # Ensure that we can round trip before trying to persist in db
  563. try:
  564. dump = frozendict_json_encoder.encode(event.content)
  565. json.loads(dump)
  566. except Exception:
  567. logger.exception("Failed to encode content: %r", event.content)
  568. raise
  569. yield self.action_generator.handle_push_actions_for_event(event, context)
  570. # reraise does not allow inlineCallbacks to preserve the stacktrace, so we
  571. # hack around with a try/finally instead.
  572. success = False
  573. try:
  574. # If we're a worker we need to hit out to the master.
  575. if self.config.worker_app:
  576. yield self.send_event_to_master(
  577. event_id=event.event_id,
  578. store=self.store,
  579. requester=requester,
  580. event=event,
  581. context=context,
  582. ratelimit=ratelimit,
  583. extra_users=extra_users,
  584. )
  585. success = True
  586. return
  587. yield self.persist_and_notify_client_event(
  588. requester, event, context, ratelimit=ratelimit, extra_users=extra_users
  589. )
  590. success = True
  591. finally:
  592. if not success:
  593. # Ensure that we actually remove the entries in the push actions
  594. # staging area, if we calculated them.
  595. run_in_background(
  596. self.store.remove_push_actions_from_staging, event.event_id
  597. )
  598. @defer.inlineCallbacks
  599. def persist_and_notify_client_event(
  600. self, requester, event, context, ratelimit=True, extra_users=[]
  601. ):
  602. """Called when we have fully built the event, have already
  603. calculated the push actions for the event, and checked auth.
  604. This should only be run on master.
  605. """
  606. assert not self.config.worker_app
  607. if ratelimit:
  608. yield self.base_handler.ratelimit(requester)
  609. yield self.base_handler.maybe_kick_guest_users(event, context)
  610. if event.type == EventTypes.CanonicalAlias:
  611. # Check the alias is acually valid (at this time at least)
  612. room_alias_str = event.content.get("alias", None)
  613. if room_alias_str:
  614. room_alias = RoomAlias.from_string(room_alias_str)
  615. directory_handler = self.hs.get_handlers().directory_handler
  616. mapping = yield directory_handler.get_association(room_alias)
  617. if mapping["room_id"] != event.room_id:
  618. raise SynapseError(
  619. 400,
  620. "Room alias %s does not point to the room" % (room_alias_str,),
  621. )
  622. federation_handler = self.hs.get_handlers().federation_handler
  623. if event.type == EventTypes.Member:
  624. if event.content["membership"] == Membership.INVITE:
  625. def is_inviter_member_event(e):
  626. return e.type == EventTypes.Member and e.sender == event.sender
  627. current_state_ids = yield context.get_current_state_ids(self.store)
  628. state_to_include_ids = [
  629. e_id
  630. for k, e_id in iteritems(current_state_ids)
  631. if k[0] in self.hs.config.room_invite_state_types
  632. or k == (EventTypes.Member, event.sender)
  633. ]
  634. state_to_include = yield self.store.get_events(state_to_include_ids)
  635. event.unsigned["invite_room_state"] = [
  636. {
  637. "type": e.type,
  638. "state_key": e.state_key,
  639. "content": e.content,
  640. "sender": e.sender,
  641. }
  642. for e in itervalues(state_to_include)
  643. ]
  644. invitee = UserID.from_string(event.state_key)
  645. if not self.hs.is_mine(invitee):
  646. # TODO: Can we add signature from remote server in a nicer
  647. # way? If we have been invited by a remote server, we need
  648. # to get them to sign the event.
  649. returned_invite = yield federation_handler.send_invite(
  650. invitee.domain, event
  651. )
  652. event.unsigned.pop("room_state", None)
  653. # TODO: Make sure the signatures actually are correct.
  654. event.signatures.update(returned_invite.signatures)
  655. if event.type == EventTypes.Redaction:
  656. original_event = yield self.store.get_event(
  657. event.redacts,
  658. check_redacted=False,
  659. get_prev_content=False,
  660. allow_rejected=False,
  661. allow_none=True,
  662. check_room_id=event.room_id,
  663. )
  664. # we can make some additional checks now if we have the original event.
  665. if original_event:
  666. if original_event.type == EventTypes.Create:
  667. raise AuthError(403, "Redacting create events is not permitted")
  668. prev_state_ids = yield context.get_prev_state_ids(self.store)
  669. auth_events_ids = yield self.auth.compute_auth_events(
  670. event, prev_state_ids, for_verification=True
  671. )
  672. auth_events = yield self.store.get_events(auth_events_ids)
  673. auth_events = {(e.type, e.state_key): e for e in auth_events.values()}
  674. room_version = yield self.store.get_room_version(event.room_id)
  675. if event_auth.check_redaction(room_version, event, auth_events=auth_events):
  676. # this user doesn't have 'redact' rights, so we need to do some more
  677. # checks on the original event. Let's start by checking the original
  678. # event exists.
  679. if not original_event:
  680. raise NotFoundError("Could not find event %s" % (event.redacts,))
  681. if event.user_id != original_event.user_id:
  682. raise AuthError(403, "You don't have permission to redact events")
  683. # all the checks are done.
  684. event.internal_metadata.recheck_redaction = False
  685. if event.type == EventTypes.Create:
  686. prev_state_ids = yield context.get_prev_state_ids(self.store)
  687. if prev_state_ids:
  688. raise AuthError(403, "Changing the room create event is forbidden")
  689. (event_stream_id, max_stream_id) = yield self.store.persist_event(
  690. event, context=context
  691. )
  692. yield self.pusher_pool.on_new_notifications(event_stream_id, max_stream_id)
  693. def _notify():
  694. try:
  695. self.notifier.on_new_room_event(
  696. event, event_stream_id, max_stream_id, extra_users=extra_users
  697. )
  698. except Exception:
  699. logger.exception("Error notifying about new room event")
  700. run_in_background(_notify)
  701. if event.type == EventTypes.Message:
  702. # We don't want to block sending messages on any presence code. This
  703. # matters as sometimes presence code can take a while.
  704. run_in_background(self._bump_active_time, requester.user)
  705. @defer.inlineCallbacks
  706. def _bump_active_time(self, user):
  707. try:
  708. presence = self.hs.get_presence_handler()
  709. yield presence.bump_presence_active_time(user)
  710. except Exception:
  711. logger.exception("Error bumping presence active time")
  712. @defer.inlineCallbacks
  713. def _send_dummy_events_to_fill_extremities(self):
  714. """Background task to send dummy events into rooms that have a large
  715. number of extremities
  716. """
  717. room_ids = yield self.store.get_rooms_with_many_extremities(
  718. min_count=10, limit=5
  719. )
  720. for room_id in room_ids:
  721. # For each room we need to find a joined member we can use to send
  722. # the dummy event with.
  723. prev_events_and_hashes = yield self.store.get_prev_events_for_room(room_id)
  724. latest_event_ids = (event_id for (event_id, _, _) in prev_events_and_hashes)
  725. members = yield self.state.get_current_users_in_room(
  726. room_id, latest_event_ids=latest_event_ids
  727. )
  728. user_id = None
  729. for member in members:
  730. if self.hs.is_mine_id(member):
  731. user_id = member
  732. break
  733. if not user_id:
  734. # We don't have a joined user.
  735. # TODO: We should do something here to stop the room from
  736. # appearing next time.
  737. continue
  738. requester = create_requester(user_id)
  739. event, context = yield self.create_event(
  740. requester,
  741. {
  742. "type": "org.matrix.dummy_event",
  743. "content": {},
  744. "room_id": room_id,
  745. "sender": user_id,
  746. },
  747. prev_events_and_hashes=prev_events_and_hashes,
  748. )
  749. event.internal_metadata.proactively_send = False
  750. yield self.send_nonmember_event(requester, event, context, ratelimit=False)