Add new admin APIs to remove media by media ID from quarantine.

[dklimpel]

Related to: #6681, #5956, #10040

Pull Request Checklist

• Pull request is based on the develop branch
• Pull request includes a changelog file. The entry should:
  • Be a short description of your change which makes sense to users. "Fixed a bug that prevented receiving messages from other servers." instead of "Moved X method from EventStore to EventWorkerStore.".
  • Use markdown where necessary, mostly for code blocks.
  • End with either a period (.) or an exclamation mark (!).
  • Start with a capital letter.
• Pull request includes a sign off
• Code style is correct (run the linters)

Signed-off-by: Dirk Klimpel dirk@klimpel.org

[richvdh]

lgtm, though as with #10040 I question whether we should use DELETE or POST .../unquarantine/....

Let's keep the discussion at #10040 for now.

[dklimpel]

I think the part for discussion in this PR is this. This is nearly a clone of _quarantine_media_txn only without parameter quarantined_by an a SQL query without AND safe_from_quarantine = ?

synapse/synapse/storage/databases/main/room.py

Lines 860 to 900 in c89da79

	def _quarantine_media_txn(
	self,
	txn,
	local_mxcs: List[str],
	remote_mxcs: List[Tuple[str, str]],
	quarantined_by: str,
	) -> int:
	"""Quarantine local and remote media items
	Args:
	txn (cursor)
	local_mxcs: A list of local mxc URLs
	remote_mxcs: A list of (remote server, media id) tuples representing
	remote mxc URLs
	quarantined_by: The ID of the user who initiated the quarantine request
	Returns:
	The total number of media items quarantined
	"""
	# Update all the tables to set the quarantined_by flag
	txn.executemany(
	"""
	UPDATE local_media_repository
	SET quarantined_by = ?
	WHERE media_id = ? AND safe_from_quarantine = ?
	""",
	((quarantined_by, media_id, False) for media_id in local_mxcs),
	)
	# Note that a rowcount of -1 can be used to indicate no rows were affected.
	total_media_quarantined = txn.rowcount if txn.rowcount > 0 else 0
	txn.executemany(
	"""
	UPDATE remote_media_cache
	SET quarantined_by = ?
	WHERE media_origin = ? AND media_id = ?
	""",
	((quarantined_by, origin, media_id) for origin, media_id in remote_mxcs),
	)
	total_media_quarantined += txn.rowcount if txn.rowcount > 0 else 0
	return total_media_quarantined

I can change it to one function if you like. Then I will make parameter quarantined_by to Optional[str]

[richvdh]

well, I did wonder about that, but didn't want to insist that you change it.

Yes, I think that combining the functions would be an improvement, if you have time to do so. Thanks.

[dklimpel]

I have made an update.

[richvdh]

Thank you!

[anoadragon453]

/me grumbles at flaky tests.