summary refs log tree commit diff
path: root/synapse/rest/admin/event_reports.py
diff options
context:
space:
mode:
authorAndrew Morgan <andrew@amorgan.xyz>2020-12-31 13:40:07 +0000
committerAndrew Morgan <andrew@amorgan.xyz>2020-12-31 13:40:07 +0000
commit47c25048c551570c97fa71db60c41d3dffa23773 (patch)
tree0ab55796a669536f110b3d2ee022ae73c3f2c13f /synapse/rest/admin/event_reports.py
parentMerge commit 'fedfdfd75' into anoa/dinsic_release_1_23_1 (diff)
parentMerge branch 'master' into develop (diff)
downloadsynapse-47c25048c551570c97fa71db60c41d3dffa23773.tar.xz
Merge commit '24229fac0' into anoa/dinsic_release_1_23_1
Diffstat (limited to 'synapse/rest/admin/event_reports.py')
-rw-r--r--synapse/rest/admin/event_reports.py46
1 files changed, 45 insertions, 1 deletions
diff --git a/synapse/rest/admin/event_reports.py b/synapse/rest/admin/event_reports.py

index 5b8d0594cd..fd482f0e32 100644 --- a/synapse/rest/admin/event_reports.py +++ b/synapse/rest/admin/event_reports.py
@@ -15,7 +15,7 @@ import logging -from synapse.api.errors import Codes, SynapseError +from synapse.api.errors import Codes, NotFoundError, SynapseError from synapse.http.servlet import RestServlet, parse_integer, parse_string from synapse.rest.admin._base import admin_patterns, assert_requester_is_admin @@ -86,3 +86,47 @@ class EventReportsRestServlet(RestServlet): ret["next_token"] = start + len(event_reports) return 200, ret + + +class EventReportDetailRestServlet(RestServlet): + """ + Get a specific reported event that is known to the homeserver. Results are returned + in a dictionary containing report information. + The requester must have administrator access in Synapse. + + GET /_synapse/admin/v1/event_reports/<report_id> + returns: + 200 OK with details report if success otherwise an error. + + Args: + The parameter `report_id` is the ID of the event report in the database. + Returns: + JSON blob of information about the event report + """ + + PATTERNS = admin_patterns("/event_reports/(?P<report_id>[^/]*)$") + + def __init__(self, hs): + self.hs = hs + self.auth = hs.get_auth() + self.store = hs.get_datastore() + + async def on_GET(self, request, report_id): + await assert_requester_is_admin(self.auth, request) + + message = ( + "The report_id parameter must be a string representing a positive integer." + ) + try: + report_id = int(report_id) + except ValueError: + raise SynapseError(400, message, errcode=Codes.INVALID_PARAM) + + if report_id < 0: + raise SynapseError(400, message, errcode=Codes.INVALID_PARAM) + + ret = await self.store.get_event_report(report_id) + if not ret: + raise NotFoundError("Event report not found") + + return 200, ret