2014-08-12 14:10:52 +00:00
|
|
|
#
|
2023-11-21 20:29:58 +00:00
|
|
|
# This file is licensed under the Affero General Public License (AGPL) version 3.
|
|
|
|
#
|
2024-01-23 11:26:48 +00:00
|
|
|
# Copyright 2014-2016 OpenMarket Ltd
|
2023-11-21 20:29:58 +00:00
|
|
|
# Copyright (C) 2023 New Vector, Ltd
|
|
|
|
#
|
|
|
|
# This program is free software: you can redistribute it and/or modify
|
|
|
|
# it under the terms of the GNU Affero General Public License as
|
|
|
|
# published by the Free Software Foundation, either version 3 of the
|
|
|
|
# License, or (at your option) any later version.
|
|
|
|
#
|
|
|
|
# See the GNU Affero General Public License for more details:
|
|
|
|
# <https://www.gnu.org/licenses/agpl-3.0.html>.
|
|
|
|
#
|
|
|
|
# Originally licensed under the Apache License, Version 2.0:
|
|
|
|
# <http://www.apache.org/licenses/LICENSE-2.0>.
|
|
|
|
#
|
|
|
|
# [This file includes modifications made by New Vector Limited]
|
2014-08-12 14:10:52 +00:00
|
|
|
#
|
|
|
|
#
|
2014-08-13 02:14:34 +00:00
|
|
|
|
2014-08-12 14:10:52 +00:00
|
|
|
""" This module contains REST servlets to do with presence: /presence/<paths>
|
|
|
|
"""
|
2018-07-09 06:09:20 +00:00
|
|
|
import logging
|
2021-08-26 11:53:52 +00:00
|
|
|
from typing import TYPE_CHECKING, Tuple
|
2018-07-09 06:09:20 +00:00
|
|
|
|
|
|
|
from synapse.api.errors import AuthError, SynapseError
|
2017-03-15 14:27:34 +00:00
|
|
|
from synapse.handlers.presence import format_user_presence_state
|
2021-08-26 11:53:52 +00:00
|
|
|
from synapse.http.server import HttpServer
|
2019-06-03 11:28:59 +00:00
|
|
|
from synapse.http.servlet import RestServlet, parse_json_object_from_request
|
2021-08-26 11:53:52 +00:00
|
|
|
from synapse.http.site import SynapseRequest
|
2021-08-17 11:57:58 +00:00
|
|
|
from synapse.rest.client._base import client_patterns
|
2021-08-26 11:53:52 +00:00
|
|
|
from synapse.types import JsonDict, UserID
|
|
|
|
|
|
|
|
if TYPE_CHECKING:
|
|
|
|
from synapse.server import HomeServer
|
2018-04-15 19:43:35 +00:00
|
|
|
|
2014-08-12 14:10:52 +00:00
|
|
|
logger = logging.getLogger(__name__)
|
|
|
|
|
|
|
|
|
2019-06-03 11:28:59 +00:00
|
|
|
class PresenceStatusRestServlet(RestServlet):
|
|
|
|
PATTERNS = client_patterns("/presence/(?P<user_id>[^/]*)/status", v1=True)
|
2023-03-23 12:11:14 +00:00
|
|
|
CATEGORY = "Presence requests"
|
2014-08-12 14:10:52 +00:00
|
|
|
|
2021-08-26 11:53:52 +00:00
|
|
|
def __init__(self, hs: "HomeServer"):
|
2020-09-18 13:56:44 +00:00
|
|
|
super().__init__()
|
2019-06-03 11:28:59 +00:00
|
|
|
self.hs = hs
|
2016-05-16 17:56:37 +00:00
|
|
|
self.presence_handler = hs.get_presence_handler()
|
2017-03-15 14:27:34 +00:00
|
|
|
self.clock = hs.get_clock()
|
2019-06-03 11:28:59 +00:00
|
|
|
self.auth = hs.get_auth()
|
2016-05-16 17:56:37 +00:00
|
|
|
|
2021-08-26 11:53:52 +00:00
|
|
|
async def on_GET(
|
|
|
|
self, request: SynapseRequest, user_id: str
|
|
|
|
) -> Tuple[int, JsonDict]:
|
2019-12-05 15:53:06 +00:00
|
|
|
requester = await self.auth.get_user_by_req(request)
|
2015-01-23 11:47:15 +00:00
|
|
|
user = UserID.from_string(user_id)
|
2014-08-12 14:10:52 +00:00
|
|
|
|
2023-10-26 19:11:24 +00:00
|
|
|
if not self.hs.config.server.presence_enabled:
|
2021-04-23 11:21:55 +00:00
|
|
|
return 200, {"presence": "offline"}
|
|
|
|
|
2016-02-15 17:10:40 +00:00
|
|
|
if requester.user != user:
|
2019-12-05 15:53:06 +00:00
|
|
|
allowed = await self.presence_handler.is_visible(
|
2019-06-20 09:32:02 +00:00
|
|
|
observed_user=user, observer_user=requester.user
|
2016-02-15 17:10:40 +00:00
|
|
|
)
|
|
|
|
|
|
|
|
if not allowed:
|
2016-02-18 17:01:53 +00:00
|
|
|
raise AuthError(403, "You are not allowed to see their presence.")
|
2016-02-15 17:10:40 +00:00
|
|
|
|
2019-12-05 15:53:06 +00:00
|
|
|
state = await self.presence_handler.get_state(target_user=user)
|
2021-08-26 11:53:52 +00:00
|
|
|
result = format_user_presence_state(
|
2020-06-11 18:13:53 +00:00
|
|
|
state, self.clock.time_msec(), include_user_id=False
|
|
|
|
)
|
2014-08-12 14:10:52 +00:00
|
|
|
|
2021-08-26 11:53:52 +00:00
|
|
|
return 200, result
|
2014-08-12 14:10:52 +00:00
|
|
|
|
2021-08-26 11:53:52 +00:00
|
|
|
async def on_PUT(
|
|
|
|
self, request: SynapseRequest, user_id: str
|
|
|
|
) -> Tuple[int, JsonDict]:
|
2019-12-05 15:53:06 +00:00
|
|
|
requester = await self.auth.get_user_by_req(request)
|
2015-01-23 11:47:15 +00:00
|
|
|
user = UserID.from_string(user_id)
|
2014-08-12 14:10:52 +00:00
|
|
|
|
2016-02-15 17:10:40 +00:00
|
|
|
if requester.user != user:
|
|
|
|
raise AuthError(403, "Can only set your own presence state")
|
|
|
|
|
2014-08-12 14:10:52 +00:00
|
|
|
state = {}
|
|
|
|
|
2016-03-11 16:41:03 +00:00
|
|
|
content = parse_json_object_from_request(request)
|
|
|
|
|
|
|
|
try:
|
2014-09-03 14:37:10 +00:00
|
|
|
state["presence"] = content.pop("presence")
|
2014-08-12 14:10:52 +00:00
|
|
|
|
|
|
|
if "status_msg" in content:
|
|
|
|
state["status_msg"] = content.pop("status_msg")
|
2020-06-16 12:51:47 +00:00
|
|
|
if not isinstance(state["status_msg"], str):
|
2014-09-03 10:56:47 +00:00
|
|
|
raise SynapseError(400, "status_msg must be a string.")
|
2014-08-12 14:10:52 +00:00
|
|
|
|
|
|
|
if content:
|
|
|
|
raise KeyError()
|
2014-09-03 10:56:47 +00:00
|
|
|
except SynapseError as e:
|
|
|
|
raise e
|
2017-10-23 14:52:32 +00:00
|
|
|
except Exception:
|
2014-09-03 10:56:47 +00:00
|
|
|
raise SynapseError(400, "Unable to parse state")
|
2014-08-12 14:10:52 +00:00
|
|
|
|
2023-10-26 19:11:24 +00:00
|
|
|
if self.hs.config.server.track_presence:
|
2023-08-28 17:08:49 +00:00
|
|
|
await self.presence_handler.set_state(user, requester.device_id, state)
|
2014-08-12 14:10:52 +00:00
|
|
|
|
2019-08-30 15:28:26 +00:00
|
|
|
return 200, {}
|
2014-08-12 14:10:52 +00:00
|
|
|
|
|
|
|
|
2021-08-26 11:53:52 +00:00
|
|
|
def register_servlets(hs: "HomeServer", http_server: HttpServer) -> None:
|
2014-08-12 14:10:52 +00:00
|
|
|
PresenceStatusRestServlet(hs).register(http_server)
|