synapse-old/synapse/rest/client/v1/presence.py

164 lines
5.4 KiB
Python
Raw Normal View History

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 08:10:52 -06:00
""" This module contains REST servlets to do with presence: /presence/<paths>
"""
2018-07-09 00:09:20 -06:00
import logging
from six import string_types
2014-08-12 08:10:52 -06:00
from twisted.internet import defer
2018-07-09 00:09:20 -06:00
from synapse.api.errors import AuthError, SynapseError
from synapse.handlers.presence import format_user_presence_state
from synapse.http.servlet import parse_json_object_from_request
2018-07-09 00:09:20 -06:00
from synapse.types import UserID
2018-07-09 00:09:20 -06:00
from .base import ClientV1RestServlet, client_path_patterns
2014-08-12 08:10:52 -06:00
logger = logging.getLogger(__name__)
class PresenceStatusRestServlet(ClientV1RestServlet):
PATTERNS = client_path_patterns("/presence/(?P<user_id>[^/]*)/status")
2014-08-12 08:10:52 -06:00
def __init__(self, hs):
super(PresenceStatusRestServlet, self).__init__(hs)
self.presence_handler = hs.get_presence_handler()
self.clock = hs.get_clock()
2014-08-12 08:10:52 -06:00
@defer.inlineCallbacks
def on_GET(self, request, user_id):
requester = yield self.auth.get_user_by_req(request)
user = UserID.from_string(user_id)
2014-08-12 08:10:52 -06:00
2016-02-15 10:10:40 -07:00
if requester.user != user:
allowed = yield self.presence_handler.is_visible(
2016-02-15 10:10:40 -07:00
observed_user=user, observer_user=requester.user,
)
if not allowed:
2016-02-18 10:01:53 -07:00
raise AuthError(403, "You are not allowed to see their presence.")
2016-02-15 10:10:40 -07:00
state = yield self.presence_handler.get_state(target_user=user)
state = format_user_presence_state(state, self.clock.time_msec())
2014-08-12 08:10:52 -06:00
defer.returnValue((200, state))
@defer.inlineCallbacks
def on_PUT(self, request, user_id):
requester = yield self.auth.get_user_by_req(request)
user = UserID.from_string(user_id)
2014-08-12 08:10:52 -06:00
2016-02-15 10:10:40 -07:00
if requester.user != user:
raise AuthError(403, "Can only set your own presence state")
2014-08-12 08:10:52 -06:00
state = {}
content = parse_json_object_from_request(request)
try:
state["presence"] = content.pop("presence")
2014-08-12 08:10:52 -06:00
if "status_msg" in content:
state["status_msg"] = content.pop("status_msg")
if not isinstance(state["status_msg"], string_types):
raise SynapseError(400, "status_msg must be a string.")
2014-08-12 08:10:52 -06:00
if content:
raise KeyError()
except SynapseError as e:
raise e
except Exception:
raise SynapseError(400, "Unable to parse state")
2014-08-12 08:10:52 -06:00
yield self.presence_handler.set_state(user, state)
2014-08-12 08:10:52 -06:00
defer.returnValue((200, {}))
2014-08-12 08:10:52 -06:00
def on_OPTIONS(self, request):
return (200, {})
class PresenceListRestServlet(ClientV1RestServlet):
PATTERNS = client_path_patterns("/presence/list/(?P<user_id>[^/]*)")
2014-08-12 08:10:52 -06:00
def __init__(self, hs):
super(PresenceListRestServlet, self).__init__(hs)
self.presence_handler = hs.get_presence_handler()
2014-08-12 08:10:52 -06:00
@defer.inlineCallbacks
def on_GET(self, request, user_id):
requester = yield self.auth.get_user_by_req(request)
user = UserID.from_string(user_id)
2014-08-12 08:10:52 -06:00
if not self.hs.is_mine(user):
raise SynapseError(400, "User not hosted on this Home Server")
2014-08-12 08:10:52 -06:00
if requester.user != user:
raise SynapseError(400, "Cannot get another user's presence list")
2014-08-12 08:10:52 -06:00
presence = yield self.presence_handler.get_presence_list(
2016-02-15 10:10:40 -07:00
observer_user=user, accepted=True
)
2014-08-12 08:10:52 -06:00
defer.returnValue((200, presence))
@defer.inlineCallbacks
def on_POST(self, request, user_id):
requester = yield self.auth.get_user_by_req(request)
user = UserID.from_string(user_id)
2014-08-12 08:10:52 -06:00
if not self.hs.is_mine(user):
raise SynapseError(400, "User not hosted on this Home Server")
2014-08-12 08:10:52 -06:00
if requester.user != user:
raise SynapseError(
400, "Cannot modify another user's presence list")
2014-08-12 08:10:52 -06:00
content = parse_json_object_from_request(request)
2014-08-12 08:10:52 -06:00
if "invite" in content:
for u in content["invite"]:
if not isinstance(u, string_types):
raise SynapseError(400, "Bad invite value.")
if len(u) == 0:
continue
invited_user = UserID.from_string(u)
yield self.presence_handler.send_presence_invite(
observer_user=user, observed_user=invited_user
)
2014-08-12 08:10:52 -06:00
if "drop" in content:
for u in content["drop"]:
if not isinstance(u, string_types):
raise SynapseError(400, "Bad drop value.")
if len(u) == 0:
continue
dropped_user = UserID.from_string(u)
yield self.presence_handler.drop(
observer_user=user, observed_user=dropped_user
)
2014-08-12 08:10:52 -06:00
defer.returnValue((200, {}))
2014-08-12 08:10:52 -06:00
def on_OPTIONS(self, request):
return (200, {})
def register_servlets(hs, http_server):
PresenceStatusRestServlet(hs).register(http_server)
PresenceListRestServlet(hs).register(http_server)