summaryrefslogtreecommitdiff
path: root/synapse/rest/client/receipts.py
diff options
context:
space:
mode:
Diffstat (limited to 'synapse/rest/client/receipts.py')
-rw-r--r--synapse/rest/client/receipts.py71
1 files changed, 71 insertions, 0 deletions
diff --git a/synapse/rest/client/receipts.py b/synapse/rest/client/receipts.py
new file mode 100644
index 00000000..d9ab836c
--- /dev/null
+++ b/synapse/rest/client/receipts.py
@@ -0,0 +1,71 @@
+# Copyright 2015, 2016 OpenMarket Ltd
+#
+# 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.
+
+import logging
+
+from synapse.api.constants import ReadReceiptEventFields
+from synapse.api.errors import Codes, SynapseError
+from synapse.http.servlet import RestServlet, parse_json_object_from_request
+
+from ._base import client_patterns
+
+logger = logging.getLogger(__name__)
+
+
+class ReceiptRestServlet(RestServlet):
+ PATTERNS = client_patterns(
+ "/rooms/(?P<room_id>[^/]*)"
+ "/receipt/(?P<receipt_type>[^/]*)"
+ "/(?P<event_id>[^/]*)$"
+ )
+
+ def __init__(self, hs):
+ super().__init__()
+ self.hs = hs
+ self.auth = hs.get_auth()
+ self.receipts_handler = hs.get_receipts_handler()
+ self.presence_handler = hs.get_presence_handler()
+
+ async def on_POST(self, request, room_id, receipt_type, event_id):
+ requester = await self.auth.get_user_by_req(request)
+
+ if receipt_type != "m.read":
+ raise SynapseError(400, "Receipt type must be 'm.read'")
+
+ body = parse_json_object_from_request(request, allow_empty_body=True)
+ 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,
+ )
+
+ await self.presence_handler.bump_presence_active_time(requester.user)
+
+ await self.receipts_handler.received_client_receipt(
+ room_id,
+ receipt_type,
+ user_id=requester.user.to_string(),
+ event_id=event_id,
+ hidden=hidden,
+ )
+
+ return 200, {}
+
+
+def register_servlets(hs, http_server):
+ ReceiptRestServlet(hs).register(http_server)