2016-01-06 21:26:29 -07:00
|
|
|
# Copyright 2015, 2016 OpenMarket Ltd
|
2015-07-07 03:55:12 -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.
|
|
|
|
|
2018-07-09 00:09:20 -06:00
|
|
|
import logging
|
2021-08-31 11:22:29 -06:00
|
|
|
from typing import TYPE_CHECKING, Tuple
|
2018-07-09 00:09:20 -06:00
|
|
|
|
2021-07-28 02:05:11 -06:00
|
|
|
from synapse.api.constants import ReadReceiptEventFields
|
|
|
|
from synapse.api.errors import Codes, SynapseError
|
2021-08-31 11:22:29 -06:00
|
|
|
from synapse.http.server import HttpServer
|
2021-07-28 02:05:11 -06:00
|
|
|
from synapse.http.servlet import RestServlet, parse_json_object_from_request
|
2021-08-31 11:22:29 -06:00
|
|
|
from synapse.http.site import SynapseRequest
|
|
|
|
from synapse.types import JsonDict
|
2015-07-07 03:55:12 -06:00
|
|
|
|
2019-06-03 05:28:59 -06:00
|
|
|
from ._base import client_patterns
|
2015-07-07 03:55:12 -06:00
|
|
|
|
2021-08-31 11:22:29 -06:00
|
|
|
if TYPE_CHECKING:
|
|
|
|
from synapse.server import HomeServer
|
|
|
|
|
2015-07-07 03:55:12 -06:00
|
|
|
logger = logging.getLogger(__name__)
|
|
|
|
|
|
|
|
|
|
|
|
class ReceiptRestServlet(RestServlet):
|
2019-06-03 05:28:59 -06:00
|
|
|
PATTERNS = client_patterns(
|
2015-07-07 03:55:12 -06:00
|
|
|
"/rooms/(?P<room_id>[^/]*)"
|
|
|
|
"/receipt/(?P<receipt_type>[^/]*)"
|
2015-07-07 08:25:30 -06:00
|
|
|
"/(?P<event_id>[^/]*)$"
|
2015-07-07 03:55:12 -06:00
|
|
|
)
|
|
|
|
|
2021-08-31 11:22:29 -06:00
|
|
|
def __init__(self, hs: "HomeServer"):
|
2020-09-18 07:56:44 -06:00
|
|
|
super().__init__()
|
2015-07-07 03:55:12 -06:00
|
|
|
self.hs = hs
|
|
|
|
self.auth = hs.get_auth()
|
2016-11-23 08:14:24 -07:00
|
|
|
self.receipts_handler = hs.get_receipts_handler()
|
2016-05-16 11:56:37 -06:00
|
|
|
self.presence_handler = hs.get_presence_handler()
|
2015-07-07 03:55:12 -06:00
|
|
|
|
2021-08-31 11:22:29 -06:00
|
|
|
async def on_POST(
|
|
|
|
self, request: SynapseRequest, room_id: str, receipt_type: str, event_id: str
|
|
|
|
) -> Tuple[int, JsonDict]:
|
2019-10-29 09:08:22 -06:00
|
|
|
requester = await self.auth.get_user_by_req(request)
|
2015-07-07 03:55:12 -06:00
|
|
|
|
2015-10-01 07:01:52 -06:00
|
|
|
if receipt_type != "m.read":
|
|
|
|
raise SynapseError(400, "Receipt type must be 'm.read'")
|
|
|
|
|
2021-08-04 08:13:24 -06:00
|
|
|
body = parse_json_object_from_request(request, allow_empty_body=True)
|
2021-07-28 02:05:11 -06:00
|
|
|
hidden = body.get(ReadReceiptEventFields.MSC2285_HIDDEN, False)
|
|
|
|
|
|
|
|
if not isinstance(hidden, bool):
|
|
|
|
raise SynapseError(
|
|
|
|
400,
|
|
|
|
"Param %s must be a boolean, if given"
|
|
|
|
% ReadReceiptEventFields.MSC2285_HIDDEN,
|
|
|
|
Codes.BAD_JSON,
|
|
|
|
)
|
|
|
|
|
2019-10-29 09:08:22 -06:00
|
|
|
await self.presence_handler.bump_presence_active_time(requester.user)
|
2016-02-15 10:10:40 -07:00
|
|
|
|
2019-10-29 09:08:22 -06:00
|
|
|
await self.receipts_handler.received_client_receipt(
|
2021-07-28 02:05:11 -06:00
|
|
|
room_id,
|
|
|
|
receipt_type,
|
|
|
|
user_id=requester.user.to_string(),
|
|
|
|
event_id=event_id,
|
|
|
|
hidden=hidden,
|
2015-07-07 03:55:12 -06:00
|
|
|
)
|
|
|
|
|
2019-08-30 09:28:26 -06:00
|
|
|
return 200, {}
|
2015-07-07 03:55:12 -06:00
|
|
|
|
|
|
|
|
2021-08-31 11:22:29 -06:00
|
|
|
def register_servlets(hs: "HomeServer", http_server: HttpServer) -> None:
|
2015-07-07 03:55:12 -06:00
|
|
|
ReceiptRestServlet(hs).register(http_server)
|