MatrixSynapse/synapse/handlers/profile.py

331 lines
12 KiB
Python
Raw Normal View History

2014-08-12 16:10:52 +02:00
# -*- coding: utf-8 -*-
2016-01-07 05:26:29 +01:00
# Copyright 2014-2016 OpenMarket Ltd
2014-08-12 16:10:52 +02: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.
import logging
2014-08-12 16:10:52 +02:00
from twisted.internet import defer
from synapse.api.errors import (
AuthError,
CodeMessageException,
Codes,
StoreError,
SynapseError,
)
from synapse.metrics.background_process_metrics import run_as_background_process
2017-08-25 12:21:34 +02:00
from synapse.types import UserID, get_domain_from_id
2018-07-09 08:09:20 +02:00
2014-08-12 16:10:52 +02:00
from ._base import BaseHandler
logger = logging.getLogger(__name__)
2017-08-25 15:45:20 +02:00
class ProfileHandler(BaseHandler):
2017-08-25 12:21:34 +02:00
PROFILE_UPDATE_MS = 60 * 1000
PROFILE_UPDATE_EVERY_MS = 24 * 60 * 60 * 1000
2014-08-12 16:10:52 +02:00
def __init__(self, hs):
2017-08-25 15:45:20 +02:00
super(ProfileHandler, self).__init__(hs)
2017-08-25 12:21:34 +02:00
self.federation = hs.get_federation_client()
hs.get_federation_registry().register_query_handler(
"profile", self.on_profile_query
)
2014-08-12 16:10:52 +02:00
2017-11-29 19:27:05 +01:00
self.user_directory_handler = hs.get_user_directory_handler()
if hs.config.worker_app is None:
self.clock.looping_call(
self._start_update_remote_profile_cache, self.PROFILE_UPDATE_MS,
)
2017-08-25 12:21:34 +02:00
@defer.inlineCallbacks
def get_profile(self, user_id):
target_user = UserID.from_string(user_id)
if self.hs.is_mine(target_user):
try:
displayname = yield self.store.get_profile_displayname(
target_user.localpart
)
avatar_url = yield self.store.get_profile_avatar_url(
target_user.localpart
)
except StoreError as e:
if e.code == 404:
raise SynapseError(404, "Profile was not found", Codes.NOT_FOUND)
raise
2017-08-25 12:21:34 +02:00
defer.returnValue({
"displayname": displayname,
"avatar_url": avatar_url,
})
else:
try:
result = yield self.federation.make_query(
destination=target_user.domain,
query_type="profile",
args={
"user_id": user_id,
},
ignore_backoff=True,
)
defer.returnValue(result)
except CodeMessageException as e:
if e.code != 404:
logger.exception("Failed to get displayname")
raise
@defer.inlineCallbacks
def get_profile_from_cache(self, user_id):
"""Get the profile information from our local cache. If the user is
ours then the profile information will always be corect. Otherwise,
it may be out of date/missing.
"""
target_user = UserID.from_string(user_id)
if self.hs.is_mine(target_user):
try:
displayname = yield self.store.get_profile_displayname(
target_user.localpart
)
avatar_url = yield self.store.get_profile_avatar_url(
target_user.localpart
)
except StoreError as e:
if e.code == 404:
raise SynapseError(404, "Profile was not found", Codes.NOT_FOUND)
raise
defer.returnValue({
"displayname": displayname,
"avatar_url": avatar_url,
})
else:
profile = yield self.store.get_from_remote_profile_cache(user_id)
defer.returnValue(profile or {})
2014-08-12 16:10:52 +02:00
@defer.inlineCallbacks
def get_displayname(self, target_user):
if self.hs.is_mine(target_user):
try:
displayname = yield self.store.get_profile_displayname(
target_user.localpart
)
except StoreError as e:
if e.code == 404:
raise SynapseError(404, "Profile was not found", Codes.NOT_FOUND)
raise
2014-08-12 16:10:52 +02:00
defer.returnValue(displayname)
else:
2014-08-12 16:10:52 +02:00
try:
result = yield self.federation.make_query(
2014-08-12 16:10:52 +02:00
destination=target_user.domain,
query_type="profile",
args={
"user_id": target_user.to_string(),
"field": "displayname",
},
ignore_backoff=True,
2014-08-12 16:10:52 +02:00
)
except CodeMessageException as e:
if e.code != 404:
logger.exception("Failed to get displayname")
raise
except Exception:
2014-08-12 16:10:52 +02:00
logger.exception("Failed to get displayname")
else:
defer.returnValue(result["displayname"])
2014-08-12 16:10:52 +02:00
@defer.inlineCallbacks
def set_displayname(self, target_user, requester, new_displayname, by_admin=False):
2014-08-12 16:10:52 +02:00
"""target_user is the user whose displayname is to be changed;
auth_user is the user attempting to make this change."""
if not self.hs.is_mine(target_user):
2014-08-12 16:10:52 +02:00
raise SynapseError(400, "User is not hosted on this Home Server")
if not by_admin and target_user != requester.user:
2014-08-12 16:10:52 +02:00
raise AuthError(400, "Cannot set another user's displayname")
if new_displayname == '':
new_displayname = None
2014-08-12 16:10:52 +02:00
yield self.store.set_profile_displayname(
target_user.localpart, new_displayname
)
if self.hs.config.user_directory_search_all_users:
2017-11-29 19:27:05 +01:00
profile = yield self.store.get_profileinfo(target_user.localpart)
yield self.user_directory_handler.handle_local_profile_change(
target_user.to_string(), profile
)
yield self._update_join_states(requester, target_user)
2014-08-12 16:10:52 +02:00
@defer.inlineCallbacks
def get_avatar_url(self, target_user):
if self.hs.is_mine(target_user):
try:
avatar_url = yield self.store.get_profile_avatar_url(
target_user.localpart
)
except StoreError as e:
if e.code == 404:
raise SynapseError(404, "Profile was not found", Codes.NOT_FOUND)
raise
2014-08-12 16:10:52 +02:00
defer.returnValue(avatar_url)
else:
2014-08-12 16:10:52 +02:00
try:
result = yield self.federation.make_query(
destination=target_user.domain,
query_type="profile",
args={
"user_id": target_user.to_string(),
"field": "avatar_url",
},
ignore_backoff=True,
2014-08-12 16:10:52 +02:00
)
except CodeMessageException as e:
if e.code != 404:
logger.exception("Failed to get avatar_url")
raise
except Exception:
2014-08-12 16:10:52 +02:00
logger.exception("Failed to get avatar_url")
defer.returnValue(result["avatar_url"])
@defer.inlineCallbacks
def set_avatar_url(self, target_user, requester, new_avatar_url, by_admin=False):
2014-08-12 16:10:52 +02:00
"""target_user is the user whose avatar_url is to be changed;
auth_user is the user attempting to make this change."""
if not self.hs.is_mine(target_user):
2014-08-12 16:10:52 +02:00
raise SynapseError(400, "User is not hosted on this Home Server")
if not by_admin and target_user != requester.user:
2014-08-12 16:10:52 +02:00
raise AuthError(400, "Cannot set another user's avatar_url")
yield self.store.set_profile_avatar_url(
target_user.localpart, new_avatar_url
)
if self.hs.config.user_directory_search_all_users:
2017-11-29 19:27:05 +01:00
profile = yield self.store.get_profileinfo(target_user.localpart)
yield self.user_directory_handler.handle_local_profile_change(
2017-12-04 16:11:38 +01:00
target_user.to_string(), profile
2017-11-29 19:27:05 +01:00
)
yield self._update_join_states(requester, target_user)
@defer.inlineCallbacks
def on_profile_query(self, args):
user = UserID.from_string(args["user_id"])
if not self.hs.is_mine(user):
raise SynapseError(400, "User is not hosted on this Home Server")
just_field = args.get("field", None)
response = {}
try:
if just_field is None or just_field == "displayname":
response["displayname"] = yield self.store.get_profile_displayname(
user.localpart
)
if just_field is None or just_field == "avatar_url":
response["avatar_url"] = yield self.store.get_profile_avatar_url(
user.localpart
)
except StoreError as e:
if e.code == 404:
raise SynapseError(404, "Profile was not found", Codes.NOT_FOUND)
raise
defer.returnValue(response)
@defer.inlineCallbacks
def _update_join_states(self, requester, target_user):
if not self.hs.is_mine(target_user):
return
2017-08-25 15:45:20 +02:00
yield self.ratelimit(requester)
2017-03-16 12:51:46 +01:00
room_ids = yield self.store.get_rooms_for_user(
target_user.to_string(),
)
2017-03-16 12:51:46 +01:00
for room_id in room_ids:
2018-03-01 11:54:37 +01:00
handler = self.hs.get_room_member_handler()
try:
# Assume the target_user isn't a guest,
# because we don't let guests set profile or avatar data.
yield handler.update_membership(
requester,
target_user,
2017-03-16 12:51:46 +01:00
room_id,
"join", # We treat a profile update like a join.
2016-02-16 12:52:46 +01:00
ratelimit=False, # Try to hide that these events aren't atomic.
)
except Exception as e:
logger.warn(
"Failed to update join event for room %s - %s",
2017-03-16 12:51:46 +01:00
room_id, str(e.message)
)
2017-08-25 12:21:34 +02:00
def _start_update_remote_profile_cache(self):
return run_as_background_process(
"Update remote profile", self._update_remote_profile_cache,
)
@defer.inlineCallbacks
2017-08-25 12:21:34 +02:00
def _update_remote_profile_cache(self):
2017-08-25 15:45:20 +02:00
"""Called periodically to check profiles of remote users we haven't
2017-08-25 12:21:34 +02:00
checked in a while.
"""
entries = yield self.store.get_remote_profile_cache_entries_that_expire(
last_checked=self.clock.time_msec() - self.PROFILE_UPDATE_EVERY_MS
)
for user_id, displayname, avatar_url in entries:
2017-08-25 15:45:20 +02:00
is_subscribed = yield self.store.is_subscribed_remote_profile_for_user(
2017-08-25 12:21:34 +02:00
user_id,
)
2017-08-25 15:45:20 +02:00
if not is_subscribed:
2017-08-25 12:21:34 +02:00
yield self.store.maybe_delete_remote_profile_cache(user_id)
continue
try:
profile = yield self.federation.make_query(
destination=get_domain_from_id(user_id),
query_type="profile",
args={
"user_id": user_id,
},
ignore_backoff=True,
)
except Exception:
2017-08-25 12:21:34 +02:00
logger.exception("Failed to get avatar_url")
yield self.store.update_remote_profile_cache(
user_id, displayname, avatar_url
)
continue
new_name = profile.get("displayname")
new_avatar = profile.get("avatar_url")
# We always hit update to update the last_check timestamp
yield self.store.update_remote_profile_cache(
user_id, new_name, new_avatar
)