2014-08-12 10:10:52 -04:00
|
|
|
# -*- coding: utf-8 -*-
|
2016-01-05 13:12:37 -05:00
|
|
|
# Copyright 2014 - 2016 OpenMarket Ltd
|
2014-08-12 10:10:52 -04:00
|
|
|
#
|
|
|
|
# Licensed under the Apache License, Version 2.0 (the "License");
|
|
|
|
# you may not use this file except in compliance with the License.
|
|
|
|
# You may obtain a copy of the License at
|
|
|
|
#
|
|
|
|
# http://www.apache.org/licenses/LICENSE-2.0
|
|
|
|
#
|
|
|
|
# Unless required by applicable law or agreed to in writing, software
|
|
|
|
# distributed under the License is distributed on an "AS IS" BASIS,
|
|
|
|
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
|
|
# See the License for the specific language governing permissions and
|
|
|
|
# limitations under the License.
|
|
|
|
|
2014-08-26 13:49:51 -04:00
|
|
|
from twisted.internet import defer
|
2014-08-12 22:14:34 -04:00
|
|
|
|
2016-05-11 04:09:20 -04:00
|
|
|
from synapse.api.errors import LimitExceededError
|
2014-12-04 06:27:59 -05:00
|
|
|
from synapse.api.constants import Membership, EventTypes
|
2016-05-11 04:09:20 -04:00
|
|
|
from synapse.types import UserID, Requester
|
2014-11-03 06:33:28 -05:00
|
|
|
|
2016-05-11 04:09:20 -04:00
|
|
|
from synapse.util.logcontext import preserve_fn
|
2015-05-08 14:53:34 -04:00
|
|
|
|
2014-11-05 06:07:54 -05:00
|
|
|
import logging
|
|
|
|
|
|
|
|
|
|
|
|
logger = logging.getLogger(__name__)
|
|
|
|
|
|
|
|
|
2016-03-04 11:54:32 -05:00
|
|
|
VISIBILITY_PRIORITY = (
|
|
|
|
"world_readable",
|
|
|
|
"shared",
|
|
|
|
"invited",
|
|
|
|
"joined",
|
|
|
|
)
|
|
|
|
|
|
|
|
|
2016-04-06 10:19:45 -04:00
|
|
|
MEMBERSHIP_PRIORITY = (
|
|
|
|
Membership.JOIN,
|
|
|
|
Membership.INVITE,
|
|
|
|
Membership.KNOCK,
|
|
|
|
Membership.LEAVE,
|
|
|
|
Membership.BAN,
|
|
|
|
)
|
|
|
|
|
|
|
|
|
2014-08-12 10:10:52 -04:00
|
|
|
class BaseHandler(object):
|
2015-11-13 05:31:15 -05:00
|
|
|
"""
|
|
|
|
Common base class for the event handlers.
|
|
|
|
|
2016-04-01 11:08:59 -04:00
|
|
|
Attributes:
|
|
|
|
store (synapse.storage.events.StateStore):
|
|
|
|
state_handler (synapse.state.StateHandler):
|
2015-11-13 05:31:15 -05:00
|
|
|
"""
|
2014-08-12 10:10:52 -04:00
|
|
|
|
|
|
|
def __init__(self, hs):
|
|
|
|
self.store = hs.get_datastore()
|
|
|
|
self.auth = hs.get_auth()
|
|
|
|
self.notifier = hs.get_notifier()
|
|
|
|
self.state_handler = hs.get_state_handler()
|
2014-08-21 09:38:22 -04:00
|
|
|
self.distributor = hs.get_distributor()
|
2014-09-02 12:57:04 -04:00
|
|
|
self.ratelimiter = hs.get_ratelimiter()
|
|
|
|
self.clock = hs.get_clock()
|
2014-08-12 10:10:52 -04:00
|
|
|
self.hs = hs
|
2014-08-26 13:49:51 -04:00
|
|
|
|
2014-11-03 06:33:28 -05:00
|
|
|
self.server_name = hs.hostname
|
|
|
|
|
2014-12-04 10:50:01 -05:00
|
|
|
self.event_builder_factory = hs.get_event_builder_factory()
|
|
|
|
|
2015-10-16 09:52:48 -04:00
|
|
|
@defer.inlineCallbacks
|
2016-02-19 06:41:02 -05:00
|
|
|
def filter_events_for_clients(self, user_tuples, events, event_id_to_state):
|
2016-01-18 05:45:09 -05:00
|
|
|
""" Returns dict of user_id -> list of events that user is allowed to
|
|
|
|
see.
|
2016-02-19 06:41:02 -05:00
|
|
|
|
2016-04-01 11:08:59 -04:00
|
|
|
Args:
|
|
|
|
user_tuples (str, bool): (user id, is_peeking) for each user to be
|
|
|
|
checked. is_peeking should be true if:
|
|
|
|
* the user is not currently a member of the room, and:
|
|
|
|
* the user has not been a member of the room since the
|
|
|
|
given events
|
2016-04-06 10:19:45 -04:00
|
|
|
events ([synapse.events.EventBase]): list of events to filter
|
2016-01-18 05:45:09 -05:00
|
|
|
"""
|
|
|
|
forgotten = yield defer.gatherResults([
|
2016-05-03 11:01:24 -04:00
|
|
|
preserve_fn(self.store.who_forgot_in_room)(
|
2016-01-18 05:45:09 -05:00
|
|
|
room_id,
|
|
|
|
)
|
|
|
|
for room_id in frozenset(e.room_id for e in events)
|
|
|
|
], consumeErrors=True)
|
|
|
|
|
|
|
|
# Set of membership event_ids that have been forgotten
|
|
|
|
event_id_forgotten = frozenset(
|
|
|
|
row["event_id"] for rows in forgotten for row in rows
|
|
|
|
)
|
|
|
|
|
2016-05-05 04:51:03 -04:00
|
|
|
ignore_dict_content = yield self.store.get_global_account_data_by_type_for_users(
|
|
|
|
"m.ignored_user_list", user_ids=[user_id for user_id, _ in user_tuples]
|
|
|
|
)
|
2016-05-03 11:01:24 -04:00
|
|
|
|
|
|
|
# FIXME: This will explode if people upload something incorrect.
|
|
|
|
ignore_dict = {
|
|
|
|
user_id: frozenset(
|
|
|
|
content.get("ignored_users", {}).keys() if content else []
|
|
|
|
)
|
|
|
|
for user_id, content in ignore_dict_content.items()
|
|
|
|
}
|
|
|
|
|
|
|
|
def allowed(event, user_id, is_peeking, ignore_list):
|
2016-04-06 10:19:45 -04:00
|
|
|
"""
|
|
|
|
Args:
|
|
|
|
event (synapse.events.EventBase): event to check
|
|
|
|
user_id (str)
|
|
|
|
is_peeking (bool)
|
2016-05-03 11:01:24 -04:00
|
|
|
ignore_list (list): list of users to ignore
|
2016-04-06 10:19:45 -04:00
|
|
|
"""
|
2016-05-03 11:01:24 -04:00
|
|
|
if not event.is_state() and event.sender in ignore_list:
|
|
|
|
return False
|
|
|
|
|
2016-01-18 05:45:09 -05:00
|
|
|
state = event_id_to_state[event.event_id]
|
|
|
|
|
2016-02-19 06:41:02 -05:00
|
|
|
# get the room_visibility at the time of the event.
|
2016-01-18 05:45:09 -05:00
|
|
|
visibility_event = state.get((EventTypes.RoomHistoryVisibility, ""), None)
|
|
|
|
if visibility_event:
|
|
|
|
visibility = visibility_event.content.get("history_visibility", "shared")
|
|
|
|
else:
|
|
|
|
visibility = "shared"
|
2015-10-16 09:52:48 -04:00
|
|
|
|
2016-03-04 11:54:32 -05:00
|
|
|
if visibility not in VISIBILITY_PRIORITY:
|
|
|
|
visibility = "shared"
|
|
|
|
|
2016-02-19 06:41:02 -05:00
|
|
|
# if it was world_readable, it's easy: everyone can read it
|
2015-11-04 12:29:07 -05:00
|
|
|
if visibility == "world_readable":
|
2015-10-16 09:52:48 -04:00
|
|
|
return True
|
|
|
|
|
2016-03-04 11:54:32 -05:00
|
|
|
# Always allow history visibility events on boundaries. This is done
|
|
|
|
# by setting the effective visibility to the least restrictive
|
|
|
|
# of the old vs new.
|
|
|
|
if event.type == EventTypes.RoomHistoryVisibility:
|
|
|
|
prev_content = event.unsigned.get("prev_content", {})
|
|
|
|
prev_visibility = prev_content.get("history_visibility", None)
|
|
|
|
|
|
|
|
if prev_visibility not in VISIBILITY_PRIORITY:
|
|
|
|
prev_visibility = "shared"
|
|
|
|
|
|
|
|
new_priority = VISIBILITY_PRIORITY.index(visibility)
|
|
|
|
old_priority = VISIBILITY_PRIORITY.index(prev_visibility)
|
|
|
|
if old_priority < new_priority:
|
|
|
|
visibility = prev_visibility
|
|
|
|
|
2016-04-06 10:19:45 -04:00
|
|
|
# likewise, if the event is the user's own membership event, use
|
|
|
|
# the 'most joined' membership
|
|
|
|
membership = None
|
|
|
|
if event.type == EventTypes.Member and event.state_key == user_id:
|
|
|
|
membership = event.content.get("membership", None)
|
|
|
|
if membership not in MEMBERSHIP_PRIORITY:
|
|
|
|
membership = "leave"
|
|
|
|
|
|
|
|
prev_content = event.unsigned.get("prev_content", {})
|
|
|
|
prev_membership = prev_content.get("membership", None)
|
|
|
|
if prev_membership not in MEMBERSHIP_PRIORITY:
|
|
|
|
prev_membership = "leave"
|
|
|
|
|
|
|
|
new_priority = MEMBERSHIP_PRIORITY.index(membership)
|
|
|
|
old_priority = MEMBERSHIP_PRIORITY.index(prev_membership)
|
|
|
|
if old_priority < new_priority:
|
|
|
|
membership = prev_membership
|
|
|
|
|
|
|
|
# otherwise, get the user's membership at the time of the event.
|
|
|
|
if membership is None:
|
|
|
|
membership_event = state.get((EventTypes.Member, user_id), None)
|
|
|
|
if membership_event:
|
|
|
|
if membership_event.event_id not in event_id_forgotten:
|
|
|
|
membership = membership_event.membership
|
2016-01-18 05:45:09 -05:00
|
|
|
|
2016-02-19 06:41:02 -05:00
|
|
|
# if the user was a member of the room at the time of the event,
|
|
|
|
# they can see it.
|
2015-10-16 09:52:48 -04:00
|
|
|
if membership == Membership.JOIN:
|
|
|
|
return True
|
|
|
|
|
2016-02-19 12:11:11 -05:00
|
|
|
if visibility == "joined":
|
|
|
|
# we weren't a member at the time of the event, so we can't
|
|
|
|
# see this event.
|
|
|
|
return False
|
|
|
|
|
2015-10-16 09:52:48 -04:00
|
|
|
elif visibility == "invited":
|
2016-02-22 10:27:44 -05:00
|
|
|
# user can also see the event if they were *invited* at the time
|
2016-02-19 06:41:02 -05:00
|
|
|
# of the event.
|
2015-10-16 09:52:48 -04:00
|
|
|
return membership == Membership.INVITE
|
|
|
|
|
2016-02-19 12:11:11 -05:00
|
|
|
else:
|
2016-02-22 10:27:44 -05:00
|
|
|
# visibility is shared: user can also see the event if they have
|
2016-02-19 12:11:11 -05:00
|
|
|
# become a member since the event
|
|
|
|
#
|
|
|
|
# XXX: if the user has subsequently joined and then left again,
|
|
|
|
# ideally we would share history up to the point they left. But
|
|
|
|
# we don't know when they left.
|
|
|
|
return not is_peeking
|
2015-10-16 09:52:48 -04:00
|
|
|
|
2016-01-18 05:45:09 -05:00
|
|
|
defer.returnValue({
|
|
|
|
user_id: [
|
|
|
|
event
|
|
|
|
for event in events
|
2016-05-03 11:01:24 -04:00
|
|
|
if allowed(event, user_id, is_peeking, ignore_dict.get(user_id, []))
|
2016-01-18 05:45:09 -05:00
|
|
|
]
|
2016-01-20 10:34:07 -05:00
|
|
|
for user_id, is_peeking in user_tuples
|
2016-01-18 05:45:09 -05:00
|
|
|
})
|
2015-11-04 12:29:07 -05:00
|
|
|
|
2016-01-18 05:45:09 -05:00
|
|
|
@defer.inlineCallbacks
|
2016-04-27 12:50:49 -04:00
|
|
|
def filter_events_for_client(self, user_id, events, is_peeking=False):
|
2016-02-19 06:41:02 -05:00
|
|
|
"""
|
|
|
|
Check which events a user is allowed to see
|
|
|
|
|
2016-04-01 11:08:59 -04:00
|
|
|
Args:
|
|
|
|
user_id(str): user id to be checked
|
|
|
|
events([synapse.events.EventBase]): list of events to be checked
|
|
|
|
is_peeking(bool): should be True if:
|
2016-02-19 06:41:02 -05:00
|
|
|
* the user is not currently a member of the room, and:
|
|
|
|
* the user has not been a member of the room since the given
|
|
|
|
events
|
2016-04-01 11:08:59 -04:00
|
|
|
|
|
|
|
Returns:
|
|
|
|
[synapse.events.EventBase]
|
2016-02-19 06:41:02 -05:00
|
|
|
"""
|
2016-02-09 11:01:40 -05:00
|
|
|
types = (
|
|
|
|
(EventTypes.RoomHistoryVisibility, ""),
|
|
|
|
(EventTypes.Member, user_id),
|
|
|
|
)
|
|
|
|
event_id_to_state = yield self.store.get_state_for_events(
|
|
|
|
frozenset(e.event_id for e in events),
|
|
|
|
types=types
|
|
|
|
)
|
2016-02-19 06:41:02 -05:00
|
|
|
res = yield self.filter_events_for_clients(
|
2016-02-09 11:01:40 -05:00
|
|
|
[(user_id, is_peeking)], events, event_id_to_state
|
|
|
|
)
|
2016-01-18 05:45:09 -05:00
|
|
|
defer.returnValue(res.get(user_id, []))
|
2015-10-16 09:52:48 -04:00
|
|
|
|
2016-03-03 11:43:42 -05:00
|
|
|
def ratelimit(self, requester):
|
2014-09-02 12:57:04 -04:00
|
|
|
time_now = self.clock.time()
|
|
|
|
allowed, time_allowed = self.ratelimiter.send_message(
|
2016-03-03 11:43:42 -05:00
|
|
|
requester.user.to_string(), time_now,
|
2014-09-02 12:57:04 -04:00
|
|
|
msg_rate_hz=self.hs.config.rc_messages_per_second,
|
2014-09-02 13:22:15 -04:00
|
|
|
burst_count=self.hs.config.rc_message_burst_count,
|
2014-09-02 12:57:04 -04:00
|
|
|
)
|
|
|
|
if not allowed:
|
2014-09-03 03:58:48 -04:00
|
|
|
raise LimitExceededError(
|
2016-02-02 12:18:50 -05:00
|
|
|
retry_after_ms=int(1000 * (time_allowed - time_now)),
|
2014-09-02 12:57:04 -04:00
|
|
|
)
|
|
|
|
|
2016-02-17 10:25:12 -05:00
|
|
|
def is_host_in_room(self, current_state):
|
|
|
|
room_members = [
|
|
|
|
(state_key, event.membership)
|
|
|
|
for ((event_type, state_key), event) in current_state.items()
|
|
|
|
if event_type == EventTypes.Member
|
|
|
|
]
|
|
|
|
if len(room_members) == 0:
|
2016-02-18 06:02:14 -05:00
|
|
|
# Have we just created the room, and is this about to be the very
|
|
|
|
# first member event?
|
2016-02-17 10:25:12 -05:00
|
|
|
create_event = current_state.get(("m.room.create", ""))
|
|
|
|
if create_event:
|
|
|
|
return True
|
|
|
|
for (state_key, membership) in room_members:
|
|
|
|
if (
|
2016-05-09 05:36:03 -04:00
|
|
|
self.hs.is_mine_id(state_key)
|
2016-02-17 10:25:12 -05:00
|
|
|
and membership == Membership.JOIN
|
|
|
|
):
|
|
|
|
return True
|
|
|
|
return False
|
|
|
|
|
2015-11-10 11:57:13 -05:00
|
|
|
@defer.inlineCallbacks
|
|
|
|
def maybe_kick_guest_users(self, event, current_state):
|
|
|
|
# Technically this function invalidates current_state by changing it.
|
|
|
|
# Hopefully this isn't that important to the caller.
|
|
|
|
if event.type == EventTypes.GuestAccess:
|
|
|
|
guest_access = event.content.get("guest_access", "forbidden")
|
|
|
|
if guest_access != "can_join":
|
|
|
|
yield self.kick_guest_users(current_state)
|
|
|
|
|
|
|
|
@defer.inlineCallbacks
|
|
|
|
def kick_guest_users(self, current_state):
|
|
|
|
for member_event in current_state:
|
|
|
|
try:
|
|
|
|
if member_event.type != EventTypes.Member:
|
|
|
|
continue
|
|
|
|
|
2016-02-15 11:40:22 -05:00
|
|
|
target_user = UserID.from_string(member_event.state_key)
|
|
|
|
if not self.hs.is_mine(target_user):
|
2015-11-10 11:57:13 -05:00
|
|
|
continue
|
|
|
|
|
|
|
|
if member_event.content["membership"] not in {
|
|
|
|
Membership.JOIN,
|
|
|
|
Membership.INVITE
|
|
|
|
}:
|
|
|
|
continue
|
|
|
|
|
|
|
|
if (
|
|
|
|
"kind" not in member_event.content
|
|
|
|
or member_event.content["kind"] != "guest"
|
|
|
|
):
|
|
|
|
continue
|
|
|
|
|
|
|
|
# We make the user choose to leave, rather than have the
|
|
|
|
# event-sender kick them. This is partially because we don't
|
|
|
|
# need to worry about power levels, and partially because guest
|
|
|
|
# users are a concept which doesn't hugely work over federation,
|
|
|
|
# and having homeservers have their own users leave keeps more
|
|
|
|
# of that decision-making and control local to the guest-having
|
|
|
|
# homeserver.
|
2016-02-15 11:40:22 -05:00
|
|
|
requester = Requester(target_user, "", True)
|
|
|
|
handler = self.hs.get_handlers().room_member_handler
|
|
|
|
yield handler.update_membership(
|
|
|
|
requester,
|
|
|
|
target_user,
|
|
|
|
member_event.room_id,
|
|
|
|
"leave",
|
2015-11-10 11:57:13 -05:00
|
|
|
ratelimit=False,
|
|
|
|
)
|
|
|
|
except Exception as e:
|
|
|
|
logger.warn("Error kicking guest user: %s" % (e,))
|