2014-08-12 08:10:52 -06:00
|
|
|
# -*- coding: utf-8 -*-
|
2016-01-06 21:26:29 -07:00
|
|
|
# Copyright 2014-2016 OpenMarket Ltd
|
2014-08-12 08:10:52 -06: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-12 20:14:34 -06:00
|
|
|
|
2014-08-12 08:10:52 -06:00
|
|
|
""" This module contains REST servlets to do with profile: /profile/<paths> """
|
|
|
|
from twisted.internet import defer
|
|
|
|
|
2016-03-11 09:41:03 -07:00
|
|
|
from synapse.http.servlet import parse_json_object_from_request
|
2018-07-09 00:09:20 -06:00
|
|
|
from synapse.types import UserID
|
|
|
|
|
|
|
|
from .base import ClientV1RestServlet, client_path_patterns
|
2014-08-12 08:10:52 -06:00
|
|
|
|
|
|
|
|
2015-01-23 07:09:51 -07:00
|
|
|
class ProfileDisplaynameRestServlet(ClientV1RestServlet):
|
2016-02-09 05:46:42 -07:00
|
|
|
PATTERNS = client_path_patterns("/profile/(?P<user_id>[^/]*)/displayname")
|
2014-08-12 08:10:52 -06:00
|
|
|
|
2016-08-12 03:03:19 -06:00
|
|
|
def __init__(self, hs):
|
|
|
|
super(ProfileDisplaynameRestServlet, self).__init__(hs)
|
2017-08-25 07:34:56 -06:00
|
|
|
self.profile_handler = hs.get_profile_handler()
|
2016-08-12 03:03:19 -06:00
|
|
|
|
2014-08-12 08:10:52 -06:00
|
|
|
@defer.inlineCallbacks
|
|
|
|
def on_GET(self, request, user_id):
|
2019-05-08 11:26:56 -06:00
|
|
|
requester_user = None
|
|
|
|
|
|
|
|
if self.hs.config.require_auth_for_profile_requests:
|
|
|
|
requester = yield self.auth.get_user_by_req(request)
|
|
|
|
requester_user = requester.user
|
|
|
|
|
2015-01-23 04:47:15 -07:00
|
|
|
user = UserID.from_string(user_id)
|
2014-08-12 08:10:52 -06:00
|
|
|
|
2019-05-08 11:26:56 -06:00
|
|
|
yield self.profile_handler.check_profile_query_allowed(user, requester_user)
|
|
|
|
|
|
|
|
displayname = yield self.profile_handler.get_displayname(user)
|
2014-08-12 08:10:52 -06:00
|
|
|
|
2016-02-03 07:59:19 -07:00
|
|
|
ret = {}
|
|
|
|
if displayname is not None:
|
|
|
|
ret["displayname"] = displayname
|
|
|
|
|
2016-02-03 08:04:51 -07:00
|
|
|
defer.returnValue((200, ret))
|
2014-08-12 08:10:52 -06:00
|
|
|
|
|
|
|
@defer.inlineCallbacks
|
|
|
|
def on_PUT(self, request, user_id):
|
2016-01-11 08:29:57 -07:00
|
|
|
requester = yield self.auth.get_user_by_req(request, allow_guest=True)
|
2015-01-23 04:47:15 -07:00
|
|
|
user = UserID.from_string(user_id)
|
2017-02-02 06:02:26 -07:00
|
|
|
is_admin = yield self.auth.is_server_admin(requester.user)
|
2014-08-12 08:10:52 -06:00
|
|
|
|
2016-03-11 09:41:03 -07:00
|
|
|
content = parse_json_object_from_request(request)
|
|
|
|
|
2014-08-12 08:10:52 -06:00
|
|
|
try:
|
|
|
|
new_name = content["displayname"]
|
2017-10-23 08:52:32 -06:00
|
|
|
except Exception:
|
2014-08-12 08:10:52 -06:00
|
|
|
defer.returnValue((400, "Unable to parse name"))
|
|
|
|
|
2017-08-25 07:34:56 -06:00
|
|
|
yield self.profile_handler.set_displayname(
|
2017-02-02 06:02:26 -07:00
|
|
|
user, requester, new_name, is_admin)
|
2014-08-12 08:10:52 -06:00
|
|
|
|
2014-09-04 11:09:17 -06:00
|
|
|
defer.returnValue((200, {}))
|
2014-08-12 08:10:52 -06:00
|
|
|
|
|
|
|
def on_OPTIONS(self, request, user_id):
|
|
|
|
return (200, {})
|
|
|
|
|
|
|
|
|
2015-01-23 07:09:51 -07:00
|
|
|
class ProfileAvatarURLRestServlet(ClientV1RestServlet):
|
2016-02-09 05:46:42 -07:00
|
|
|
PATTERNS = client_path_patterns("/profile/(?P<user_id>[^/]*)/avatar_url")
|
2014-08-12 08:10:52 -06:00
|
|
|
|
2016-08-12 03:03:19 -06:00
|
|
|
def __init__(self, hs):
|
|
|
|
super(ProfileAvatarURLRestServlet, self).__init__(hs)
|
2017-08-25 07:34:56 -06:00
|
|
|
self.profile_handler = hs.get_profile_handler()
|
2016-08-12 03:03:19 -06:00
|
|
|
|
2014-08-12 08:10:52 -06:00
|
|
|
@defer.inlineCallbacks
|
|
|
|
def on_GET(self, request, user_id):
|
2019-05-08 11:26:56 -06:00
|
|
|
requester_user = None
|
|
|
|
|
|
|
|
if self.hs.config.require_auth_for_profile_requests:
|
|
|
|
requester = yield self.auth.get_user_by_req(request)
|
|
|
|
requester_user = requester.user
|
|
|
|
|
2015-01-23 04:47:15 -07:00
|
|
|
user = UserID.from_string(user_id)
|
2014-08-12 08:10:52 -06:00
|
|
|
|
2019-05-08 11:26:56 -06:00
|
|
|
yield self.profile_handler.check_profile_query_allowed(user, requester_user)
|
|
|
|
|
|
|
|
avatar_url = yield self.profile_handler.get_avatar_url(user)
|
2014-08-12 08:10:52 -06:00
|
|
|
|
2016-02-03 07:59:19 -07:00
|
|
|
ret = {}
|
|
|
|
if avatar_url is not None:
|
|
|
|
ret["avatar_url"] = avatar_url
|
|
|
|
|
|
|
|
defer.returnValue((200, ret))
|
2014-08-12 08:10:52 -06:00
|
|
|
|
|
|
|
@defer.inlineCallbacks
|
|
|
|
def on_PUT(self, request, user_id):
|
2016-01-11 08:29:57 -07:00
|
|
|
requester = yield self.auth.get_user_by_req(request)
|
2015-01-23 04:47:15 -07:00
|
|
|
user = UserID.from_string(user_id)
|
2017-02-02 06:02:26 -07:00
|
|
|
is_admin = yield self.auth.is_server_admin(requester.user)
|
2014-08-12 08:10:52 -06:00
|
|
|
|
2016-03-11 09:41:03 -07:00
|
|
|
content = parse_json_object_from_request(request)
|
2014-08-12 08:10:52 -06:00
|
|
|
try:
|
|
|
|
new_name = content["avatar_url"]
|
2017-10-23 08:52:32 -06:00
|
|
|
except Exception:
|
2014-08-12 08:10:52 -06:00
|
|
|
defer.returnValue((400, "Unable to parse name"))
|
|
|
|
|
2017-08-25 07:34:56 -06:00
|
|
|
yield self.profile_handler.set_avatar_url(
|
2017-02-02 06:02:26 -07:00
|
|
|
user, requester, new_name, is_admin)
|
2014-08-12 08:10:52 -06:00
|
|
|
|
2014-09-04 11:09:17 -06:00
|
|
|
defer.returnValue((200, {}))
|
2014-08-12 08:10:52 -06:00
|
|
|
|
|
|
|
def on_OPTIONS(self, request, user_id):
|
|
|
|
return (200, {})
|
|
|
|
|
|
|
|
|
2015-01-23 07:09:51 -07:00
|
|
|
class ProfileRestServlet(ClientV1RestServlet):
|
2016-02-09 05:46:42 -07:00
|
|
|
PATTERNS = client_path_patterns("/profile/(?P<user_id>[^/]*)")
|
2014-09-02 05:53:36 -06:00
|
|
|
|
2016-08-12 03:03:19 -06:00
|
|
|
def __init__(self, hs):
|
|
|
|
super(ProfileRestServlet, self).__init__(hs)
|
2017-08-25 07:34:56 -06:00
|
|
|
self.profile_handler = hs.get_profile_handler()
|
2016-08-12 03:03:19 -06:00
|
|
|
|
2014-09-02 05:53:36 -06:00
|
|
|
@defer.inlineCallbacks
|
|
|
|
def on_GET(self, request, user_id):
|
2019-05-08 11:26:56 -06:00
|
|
|
requester_user = None
|
|
|
|
|
|
|
|
if self.hs.config.require_auth_for_profile_requests:
|
|
|
|
requester = yield self.auth.get_user_by_req(request)
|
|
|
|
requester_user = requester.user
|
|
|
|
|
2015-01-23 04:47:15 -07:00
|
|
|
user = UserID.from_string(user_id)
|
2014-09-02 05:53:36 -06:00
|
|
|
|
2019-05-08 11:26:56 -06:00
|
|
|
yield self.profile_handler.check_profile_query_allowed(user, requester_user)
|
|
|
|
|
|
|
|
displayname = yield self.profile_handler.get_displayname(user)
|
|
|
|
avatar_url = yield self.profile_handler.get_avatar_url(user)
|
2014-09-02 05:53:36 -06:00
|
|
|
|
2016-02-03 07:59:19 -07:00
|
|
|
ret = {}
|
|
|
|
if displayname is not None:
|
|
|
|
ret["displayname"] = displayname
|
|
|
|
if avatar_url is not None:
|
|
|
|
ret["avatar_url"] = avatar_url
|
|
|
|
|
|
|
|
defer.returnValue((200, ret))
|
2014-09-02 05:53:36 -06:00
|
|
|
|
|
|
|
|
2014-08-12 08:10:52 -06:00
|
|
|
def register_servlets(hs, http_server):
|
|
|
|
ProfileDisplaynameRestServlet(hs).register(http_server)
|
|
|
|
ProfileAvatarURLRestServlet(hs).register(http_server)
|
2014-09-02 05:53:36 -06:00
|
|
|
ProfileRestServlet(hs).register(http_server)
|