MatrixSynapse/synapse/rest/client/presence.py

105 lines
3.5 KiB
Python
Raw Normal View History

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.
2014-08-12 16:10:52 +02:00
""" This module contains REST servlets to do with presence: /presence/<paths>
"""
2018-07-09 08:09:20 +02:00
import logging
from typing import TYPE_CHECKING, Tuple
2018-07-09 08:09:20 +02:00
from synapse.api.errors import AuthError, SynapseError
from synapse.handlers.presence import format_user_presence_state
from synapse.http.server import HttpServer
from synapse.http.servlet import RestServlet, parse_json_object_from_request
from synapse.http.site import SynapseRequest
from synapse.rest.client._base import client_patterns
from synapse.types import JsonDict, UserID
if TYPE_CHECKING:
from synapse.server import HomeServer
2014-08-12 16:10:52 +02:00
logger = logging.getLogger(__name__)
class PresenceStatusRestServlet(RestServlet):
PATTERNS = client_patterns("/presence/(?P<user_id>[^/]*)/status", v1=True)
CATEGORY = "Presence requests"
2014-08-12 16:10:52 +02:00
def __init__(self, hs: "HomeServer"):
super().__init__()
self.hs = hs
self.presence_handler = hs.get_presence_handler()
self.clock = hs.get_clock()
self.auth = hs.get_auth()
async def on_GET(
self, request: SynapseRequest, user_id: str
) -> Tuple[int, JsonDict]:
2019-12-05 16:53:06 +01:00
requester = await self.auth.get_user_by_req(request)
user = UserID.from_string(user_id)
2014-08-12 16:10:52 +02:00
if not self.hs.config.server.presence_enabled:
2021-04-23 13:21:55 +02:00
return 200, {"presence": "offline"}
2016-02-15 18:10:40 +01:00
if requester.user != user:
2019-12-05 16:53:06 +01:00
allowed = await self.presence_handler.is_visible(
2019-06-20 11:32:02 +02:00
observed_user=user, observer_user=requester.user
2016-02-15 18:10:40 +01:00
)
if not allowed:
2016-02-18 18:01:53 +01:00
raise AuthError(403, "You are not allowed to see their presence.")
2016-02-15 18:10:40 +01:00
2019-12-05 16:53:06 +01:00
state = await self.presence_handler.get_state(target_user=user)
result = format_user_presence_state(
state, self.clock.time_msec(), include_user_id=False
)
2014-08-12 16:10:52 +02:00
return 200, result
2014-08-12 16:10:52 +02:00
async def on_PUT(
self, request: SynapseRequest, user_id: str
) -> Tuple[int, JsonDict]:
2019-12-05 16:53:06 +01:00
requester = await self.auth.get_user_by_req(request)
user = UserID.from_string(user_id)
2014-08-12 16:10:52 +02:00
2016-02-15 18:10:40 +01:00
if requester.user != user:
raise AuthError(403, "Can only set your own presence state")
2014-08-12 16:10:52 +02:00
state = {}
content = parse_json_object_from_request(request)
try:
state["presence"] = content.pop("presence")
2014-08-12 16:10:52 +02:00
if "status_msg" in content:
state["status_msg"] = content.pop("status_msg")
if not isinstance(state["status_msg"], str):
raise SynapseError(400, "status_msg must be a string.")
2014-08-12 16:10:52 +02:00
if content:
raise KeyError()
except SynapseError as e:
raise e
except Exception:
raise SynapseError(400, "Unable to parse state")
2014-08-12 16:10:52 +02:00
if self.hs.config.server.track_presence:
await self.presence_handler.set_state(user, requester.device_id, state)
2014-08-12 16:10:52 +02:00
return 200, {}
2014-08-12 16:10:52 +02:00
def register_servlets(hs: "HomeServer", http_server: HttpServer) -> None:
2014-08-12 16:10:52 +02:00
PresenceStatusRestServlet(hs).register(http_server)