#
# This file is licensed under the Affero General Public License (AGPL) version 3.
#
# Copyright 2019, 2022 The Matrix.org Foundation C.I.C.
# Copyright 2014-2016 OpenMarket Ltd
# 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]
#
#

import logging
from dataclasses import dataclass
from enum import Enum
from typing import (
    TYPE_CHECKING,
    AbstractSet,
    Any,
    Collection,
    Mapping,
    cast,
)

import attr

from synapse.api.constants import (
    Direction,
    EventContentFields,
    EventTypes,
    JoinRules,
    PublicRoomsFilterFields,
)
from synapse.api.errors import StoreError
from synapse.api.room_versions import RoomVersion, RoomVersions
from synapse.config.homeserver import HomeServerConfig
from synapse.events import EventBase
from synapse.replication.tcp.streams._base import QuarantinedMediaStream
from synapse.replication.tcp.streams.partial_state import UnPartialStatedRoomStream
from synapse.storage._base import (
    db_to_json,
    make_in_list_sql_clause,
)
from synapse.storage.database import (
    DatabasePool,
    LoggingDatabaseConnection,
    LoggingTransaction,
    make_tuple_in_list_sql_clause,
)
from synapse.storage.databases.main.cache import CacheInvalidationWorkerStore
from synapse.storage.types import Cursor
from synapse.storage.util.id_generators import IdGenerator, MultiWriterIdGenerator
from synapse.types import (
    JsonDict,
    MultiWriterStreamToken,
    RetentionPolicy,
    StrCollection,
    ThirdPartyInstanceID,
)
from synapse.util.caches.descriptors import cached, cachedList
from synapse.util.json import json_encoder
from synapse.util.stringutils import MXC_REGEX

if TYPE_CHECKING:
    from synapse.server import HomeServer

logger = logging.getLogger(__name__)


@attr.s(slots=True, frozen=True, auto_attribs=True)
class RatelimitOverride:
    # n.b. elsewhere in Synapse messages_per_second is represented as a float, but it is
    # an integer in the database
    messages_per_second: int
    burst_count: int


@attr.s(slots=True, frozen=True, auto_attribs=True)
class LargestRoomStats:
    room_id: str
    name: str | None
    canonical_alias: str | None
    joined_members: int
    join_rules: str | None
    guest_access: str | None
    history_visibility: str | None
    state_events: int
    avatar: str | None
    topic: str | None
    room_type: str | None


@attr.s(slots=True, frozen=True, auto_attribs=True)
class RoomStats(LargestRoomStats):
    joined_local_members: int
    version: str | None
    creator: str | None
    encryption: str | None
    federatable: bool
    public: bool


@dataclass(frozen=True)
class QuarantinedMediaUpdate:
    stream_id: int  # for the quarantined_media_changes stream
    origin: str
    media_id: str
    quarantined: bool


class RoomSortOrder(Enum):
    """
    Enum to define the sorting method used when returning rooms with get_rooms_paginate

    NAME = sort rooms alphabetically by name
    JOINED_MEMBERS = sort rooms by membership size, highest to lowest
    """

    # ALPHABETICAL and SIZE are deprecated.
    # ALPHABETICAL is the same as NAME.
    ALPHABETICAL = "alphabetical"
    # SIZE is the same as JOINED_MEMBERS.
    SIZE = "size"
    NAME = "name"
    CANONICAL_ALIAS = "canonical_alias"
    JOINED_MEMBERS = "joined_members"
    JOINED_LOCAL_MEMBERS = "joined_local_members"
    VERSION = "version"
    CREATOR = "creator"
    ENCRYPTION = "encryption"
    FEDERATABLE = "federatable"
    PUBLIC = "public"
    JOIN_RULES = "join_rules"
    GUEST_ACCESS = "guest_access"
    HISTORY_VISIBILITY = "history_visibility"
    STATE_EVENTS = "state_events"


@attr.s(slots=True, frozen=True, auto_attribs=True)
class PartialStateResyncInfo:
    joined_via: str | None
    servers_in_room: set[str] = attr.ib(factory=set)


class RoomWorkerStore(CacheInvalidationWorkerStore):
    def __init__(
        self,
        database: DatabasePool,
        db_conn: LoggingDatabaseConnection,
        hs: "HomeServer",
    ):
        super().__init__(database, db_conn, hs)

        self.config: HomeServerConfig = hs.config

        self._un_partial_stated_rooms_stream_id_gen: MultiWriterIdGenerator

        self._un_partial_stated_rooms_stream_id_gen = MultiWriterIdGenerator(
            db_conn=db_conn,
            db=database,
            notifier=hs.get_replication_notifier(),
            stream_name="un_partial_stated_room_stream",
            server_name=self.server_name,
            instance_name=self._instance_name,
            tables=[("un_partial_stated_room_stream", "instance_name", "stream_id")],
            sequence_name="un_partial_stated_room_stream_sequence",
            # TODO(faster_joins, multiple writers) Support multiple writers.
            writers=["master"],
        )

        self._can_write_quarantined_media_changes = (
            self._instance_name in hs.config.worker.writers.quarantined_media_changes
        )

        self._quarantined_media_changes_id_gen: MultiWriterIdGenerator = (
            MultiWriterIdGenerator(
                db_conn=db_conn,
                db=database,
                notifier=hs.get_replication_notifier(),
                stream_name=QuarantinedMediaStream.NAME,
                server_name=self.server_name,
                instance_name=self._instance_name,
                tables=[("quarantined_media_changes", "instance_name", "stream_id")],
                sequence_name="quarantined_media_id_seq",
                writers=hs.config.worker.writers.quarantined_media_changes,
            )
        )

        # Register a background update to flag already-quarantined media in the quarantine
        # media changes table. This is to populate the API endpoint which consumes the
        # table with initial data that callers expect (namely, a list of currently
        # quarantined media).
        self.db_pool.updates.register_background_update_handler(
            _BackgroundUpdates.FLAG_EXISTING_QUARANTINED_MEDIA,
            self._flag_existing_quarantined_media,
        )

    async def _flag_existing_quarantined_media(
        self, progress: JsonDict, batch_size: int
    ) -> int:
        """Background update function to flag existing already-quarantined media in
        the new `quarantine_media_changes` table.

        This only flags quarantined media as the API which reads the table is only
        concerned with *changes* to the quarantined state - media does not start as
        quarantined, so if it's already quarantined then it has changed state at
        some point. Media which isn't quarantined has not changed state (as far as
        this function can tell).

        We don't know when the media was originally quarantined, so this inserts as if
        the media was quarantined now and are processed in an arbitrary order.

        Further, due to lack of timestamp or history, media which was quarantined then
        unquarantined will not be picked up by this background task.

        Function signature is as per `register_background_update_handler` requirements.

        Args:
            progress: The progress dictionary from the background update.
            batch_size: The number of rows to process in each batch.

        Returns:
              The number of rows inserted.
        """
        # Note: we actually process 2x the batch_size per batch because we use it twice:
        # once for the local_media_repository table, and once for the remote_media_cache
        # table. This is fine though - we're still doing the work in batches.

        # We track the progress for the local and remote tables separately just in case
        # there are media ID collisions that would make a mess of `ORDER BY media_id
        # LIMIT ?`. If there are collisions towards the end of the returned set, the LIMIT
        # might cut off some rows and make a future call with `WHERE media_id > ?` miss
        # them too. By tracking each table separately, we avoid this kind of issue.
        last_local_media_id = progress.get("last_local_media_id", "")
        last_remote_media_id = progress.get("last_remote_media_id", "")
        last_remote_origin = progress.get("last_remote_origin", "")

        # Once a table has been fully processed we record it in the progress so that
        # we stop re-running its (now empty) query on every subsequent iteration while
        # the other table is still being worked through.
        local_done = progress.get("local_done", False)
        remote_done = progress.get("remote_done", False)

        # The `ORDER BY` here would normally miss records if the admin (un)quarantined a
        # record, but that doesn't affect the background update because we also insert
        # into the stream table upon quarantine status changing. Worst case is the admin
        # newly quarantines some media, adding a row to the stream table, then we run
        # over it again in the background update, adding a second row. Duplicate rows are
        # non-issues for us.
        #
        # Another similar issue is if Synapse is downgraded partway through the background
        # update then has more media quarantined. If Synapse is later upgraded again, the
        # media that was quarantined while downgraded will only be imported if the media
        # IDs are ordered higher than the last processed media ID. Media that has a lower
        # ID will be skipped by the background update.
        #
        # Note: Already-quarantined media is indicated by the `quarantined_by` field being
        # non-null. We only want quarantined media, per docstring above.
        #
        # This background update is considered *best effort* for the reasons above. Data
        # might be missing or duplicated, and that's just going to have to be okay. This
        # is further reinforced by not all changes being captured by the table anyway.
        # See https://github.com/element-hq/synapse/issues/19672 for more details.
        def flag_quarantined(txn: LoggingTransaction) -> int:
            local_media_result: list[tuple[str | None, str]] = []
            remote_media_result: list[tuple[str | None, str]] = []

            # It doesn't matter which order we do these in, as long as we do both of
            # them. We skip a table once it's been fully processed so we don't keep
            # running an empty query for it every iteration until the other finishes.
            if not local_done:
                txn.execute(
                    """
                    SELECT NULL AS media_origin, media_id
                    FROM local_media_repository
                    WHERE quarantined_by IS NOT NULL
                        AND media_id > ?
                    ORDER BY media_id
                    LIMIT ?
                """,
                    (last_local_media_id, batch_size),
                )
                local_media_result = cast(list[tuple[str | None, str]], txn.fetchall())
                if len(local_media_result) > 0:
                    self._insert_quarantine_changes_txn(txn, local_media_result, True)

            # We page through `remote_media_cache` with a tuple comparison on
            # `(media_origin, media_id)`. This matches a unique index, and so
            # will a) page through all rows, and b) will be fast.
            #
            # Comparing the columns independently (e.g. `media_origin >= ? AND
            # media_id > ?`) would incorrectly skip rows in a newly-reached
            # origin whose media_id is <= the last processed media_id.
            if not remote_done:
                txn.execute(
                    """
                    SELECT media_origin, media_id
                    FROM remote_media_cache
                    WHERE quarantined_by IS NOT NULL
                        AND (media_origin, media_id) > (?, ?)
                    ORDER BY media_origin, media_id
                    LIMIT ?
                """,
                    (last_remote_origin, last_remote_media_id, batch_size),
                )
                remote_media_result = cast(list[tuple[str | None, str]], txn.fetchall())
                if len(remote_media_result) > 0:
                    self._insert_quarantine_changes_txn(txn, remote_media_result, True)

            # Carry the previous progress forward, then for each table advance its
            # cursor to the last row we fetched, or mark it done if its query (which
            # only runs while it isn't already done) came back empty.
            new_progress = {
                "last_local_media_id": last_local_media_id,
                "last_remote_media_id": last_remote_media_id,
                "last_remote_origin": last_remote_origin,
                "local_done": local_done,
                "remote_done": remote_done,
            }
            if local_media_result:
                new_progress["last_local_media_id"] = local_media_result[-1][1]
            else:
                new_progress["local_done"] = True
            if remote_media_result:
                new_progress["last_remote_origin"] = remote_media_result[-1][0]
                new_progress["last_remote_media_id"] = remote_media_result[-1][1]
            else:
                new_progress["remote_done"] = True

            self.db_pool.updates._background_update_progress_txn(
                txn,
                _BackgroundUpdates.FLAG_EXISTING_QUARANTINED_MEDIA,
                new_progress,
            )

            return len(local_media_result) + len(remote_media_result)

        logger.info(
            "Flagging existing quarantined media with local offset %s and remote offset %s/%s",
            last_local_media_id,
            last_remote_origin,
            last_remote_media_id,
        )
        num_flagged = await self.db_pool.runInteraction(
            "_flag_existing_quarantined_media.flag_quarantined",
            flag_quarantined,
        )
        if num_flagged <= 0:  # probably never negative, but why trust computers?
            await self.db_pool.updates._end_background_update(
                _BackgroundUpdates.FLAG_EXISTING_QUARANTINED_MEDIA
            )
        return num_flagged

    def process_replication_position(
        self, stream_name: str, instance_name: str, token: int
    ) -> None:
        if stream_name == UnPartialStatedRoomStream.NAME:
            self._un_partial_stated_rooms_stream_id_gen.advance(instance_name, token)
        elif stream_name == QuarantinedMediaStream.NAME:
            self._quarantined_media_changes_id_gen.advance(instance_name, token)
        return super().process_replication_position(stream_name, instance_name, token)

    async def store_room(
        self,
        room_id: str,
        room_creator_user_id: str,
        is_public: bool,
        room_version: RoomVersion,
    ) -> None:
        """Stores a room.

        Args:
            room_id: The desired room ID, can be None.
            room_creator_user_id: The user ID of the room creator.
            is_public: True to indicate that this room should appear in
                public room lists.
            room_version: The version of the room
        Raises:
            StoreError if the room could not be stored.
        """
        try:
            await self.db_pool.simple_insert(
                "rooms",
                {
                    "room_id": room_id,
                    "creator": room_creator_user_id,
                    "is_public": is_public,
                    "room_version": room_version.identifier,
                    "has_auth_chain_index": True,
                },
                desc="store_room",
            )
        except Exception as e:
            logger.error("store_room with room_id=%s failed: %s", room_id, e)
            raise StoreError(500, "Problem creating room.")

    async def get_room(self, room_id: str) -> tuple[bool, bool] | None:
        """Retrieve a room.

        Args:
            room_id: The ID of the room to retrieve.
        Returns:
            A tuple containing the room information:
                * True if the room is public
                * True if the room has an auth chain index

            or None if the room is unknown.
        """
        row = cast(
            tuple[int | bool | None, int | bool | None] | None,
            await self.db_pool.simple_select_one(
                table="rooms",
                keyvalues={"room_id": room_id},
                retcols=("is_public", "has_auth_chain_index"),
                desc="get_room",
                allow_none=True,
            ),
        )
        if row is None:
            return row
        return bool(row[0]), bool(row[1])

    async def get_room_with_stats(self, room_id: str) -> RoomStats | None:
        """Retrieve room with statistics.

        Args:
            room_id: The ID of the room to retrieve.
        Returns:
            A dict containing the room information, or None if the room is unknown.
        """

        def get_room_with_stats_txn(
            txn: LoggingTransaction, room_id: str
        ) -> RoomStats | None:
            sql = """
                SELECT room_id, state.name, state.canonical_alias, curr.joined_members,
                  curr.local_users_in_room AS joined_local_members, rooms.room_version AS version,
                  rooms.creator, state.encryption, state.is_federatable AS federatable,
                  rooms.is_public AS public, state.join_rules, state.guest_access,
                  state.history_visibility, curr.current_state_events AS state_events,
                  state.avatar, state.topic, state.room_type
                FROM rooms
                LEFT JOIN room_stats_state state USING (room_id)
                LEFT JOIN room_stats_current curr USING (room_id)
                WHERE room_id = ?
                """
            txn.execute(sql, [room_id])
            row = txn.fetchone()
            if not row:
                return None
            return RoomStats(
                room_id=row[0],
                name=row[1],
                canonical_alias=row[2],
                joined_members=row[3],
                joined_local_members=row[4],
                version=row[5],
                creator=row[6],
                encryption=row[7],
                federatable=bool(row[8]),
                public=bool(row[9]),
                join_rules=row[10],
                guest_access=row[11],
                history_visibility=row[12],
                state_events=row[13],
                avatar=row[14],
                topic=row[15],
                room_type=row[16],
            )

        return await self.db_pool.runInteraction(
            "get_room_with_stats", get_room_with_stats_txn, room_id
        )

    async def get_public_room_ids(self) -> list[str]:
        return await self.db_pool.simple_select_onecol(
            table="rooms",
            keyvalues={"is_public": True},
            retcol="room_id",
            desc="get_public_room_ids",
        )

    def _construct_room_type_where_clause(
        self, room_types: list[str | None] | None
    ) -> tuple[str | None, list]:
        if not room_types:
            return None, []

        # Since None is used to represent a room without a type, care needs to
        # be taken into account when constructing the where clause.
        clauses = []
        args: list = []

        room_types_set = set(room_types)

        # We use None to represent a room without a type.
        if None in room_types_set:
            clauses.append("room_type IS NULL")
            room_types_set.remove(None)

        # If there are other room types, generate the proper clause.
        if room_types:
            list_clause, args = make_in_list_sql_clause(
                self.database_engine, "room_type", room_types_set
            )
            clauses.append(list_clause)

        return f"({' OR '.join(clauses)})", args

    async def count_public_rooms(
        self,
        network_tuple: ThirdPartyInstanceID | None,
        ignore_non_federatable: bool,
        search_filter: dict | None,
    ) -> int:
        """Counts the number of public rooms as tracked in the room_stats_current
        and room_stats_state table.

        Args:
            network_tuple
            ignore_non_federatable: If true filters out non-federatable rooms
            search_filter
        """

        def _count_public_rooms_txn(txn: LoggingTransaction) -> int:
            query_args = []

            if network_tuple:
                if network_tuple.appservice_id:
                    published_sql = """
                        SELECT room_id from appservice_room_list
                        WHERE appservice_id = ? AND network_id = ?
                    """
                    query_args.append(network_tuple.appservice_id)
                    assert network_tuple.network_id is not None
                    query_args.append(network_tuple.network_id)
                else:
                    published_sql = """
                        SELECT room_id FROM rooms WHERE is_public
                    """
            else:
                published_sql = """
                    SELECT room_id FROM rooms WHERE is_public
                    UNION SELECT room_id from appservice_room_list
            """

            room_type_clause, args = self._construct_room_type_where_clause(
                search_filter.get(PublicRoomsFilterFields.ROOM_TYPES, None)
                if search_filter
                else None
            )
            room_type_clause = f" AND {room_type_clause}" if room_type_clause else ""
            query_args += args

            sql = f"""
                SELECT
                    COUNT(*)
                FROM (
                    {published_sql}
                ) published
                INNER JOIN room_stats_state USING (room_id)
                INNER JOIN room_stats_current USING (room_id)
                WHERE
                    (
                        join_rules = '{JoinRules.PUBLIC}'
                        OR join_rules = '{JoinRules.KNOCK}'
                        OR join_rules = '{JoinRules.KNOCK_RESTRICTED}'
                        OR history_visibility = 'world_readable'
                    )
                    {room_type_clause}
                    AND joined_members > 0
            """

            txn.execute(sql, query_args)
            return cast(tuple[int], txn.fetchone())[0]

        return await self.db_pool.runInteraction(
            "count_public_rooms", _count_public_rooms_txn
        )

    async def get_room_count(self) -> int:
        """Retrieve the total number of rooms."""

        def f(txn: LoggingTransaction) -> int:
            sql = "SELECT count(*)  FROM rooms"
            txn.execute(sql)
            row = cast(tuple[int], txn.fetchone())
            return row[0]

        return await self.db_pool.runInteraction("get_rooms", f)

    async def get_largest_public_rooms(
        self,
        network_tuple: ThirdPartyInstanceID | None,
        search_filter: dict | None,
        limit: int | None,
        bounds: tuple[int, str] | None,
        forwards: bool,
        ignore_non_federatable: bool = False,
    ) -> list[LargestRoomStats]:
        """Gets the largest public rooms (where largest is in terms of joined
        members, as tracked in the statistics table).

        Args:
            network_tuple
            search_filter
            limit: Maxmimum number of rows to return, unlimited otherwise.
            bounds: An uppoer or lower bound to apply to result set if given,
                consists of a joined member count and room_id (these are
                excluded from result set).
            forwards: true iff going forwards, going backwards otherwise
            ignore_non_federatable: If true filters out non-federatable rooms.

        Returns:
            Rooms in order: biggest number of joined users first.
            We then arbitrarily use the room_id as a tie breaker.

        """

        where_clauses = []
        query_args: list[str | int] = []

        if network_tuple:
            if network_tuple.appservice_id:
                published_sql = """
                    SELECT room_id from appservice_room_list
                    WHERE appservice_id = ? AND network_id = ?
                """
                query_args.append(network_tuple.appservice_id)
                assert network_tuple.network_id is not None
                query_args.append(network_tuple.network_id)
            else:
                published_sql = """
                    SELECT room_id FROM rooms WHERE is_public
                """
        else:
            published_sql = """
                SELECT room_id FROM rooms WHERE is_public
                UNION SELECT room_id from appservice_room_list
            """

        # Work out the bounds if we're given them, these bounds look slightly
        # odd, but are designed to help query planner use indices by pulling
        # out a common bound.
        if bounds:
            last_joined_members, last_room_id = bounds
            if forwards:
                where_clauses.append(
                    """
                        joined_members <= ? AND (
                            joined_members < ? OR room_id < ?
                        )
                    """
                )
            else:
                where_clauses.append(
                    """
                        joined_members >= ? AND (
                            joined_members > ? OR room_id > ?
                        )
                    """
                )

            query_args += [last_joined_members, last_joined_members, last_room_id]

        if ignore_non_federatable:
            where_clauses.append("is_federatable")

        if search_filter and search_filter.get(
            PublicRoomsFilterFields.GENERIC_SEARCH_TERM, None
        ):
            search_term = (
                "%" + search_filter[PublicRoomsFilterFields.GENERIC_SEARCH_TERM] + "%"
            )

            where_clauses.append(
                """
                    (
                        LOWER(name) LIKE ?
                        OR LOWER(topic) LIKE ?
                        OR LOWER(canonical_alias) LIKE ?
                    )
                """
            )
            query_args += [
                search_term.lower(),
                search_term.lower(),
                search_term.lower(),
            ]

        room_type_clause, args = self._construct_room_type_where_clause(
            search_filter.get(PublicRoomsFilterFields.ROOM_TYPES, None)
            if search_filter
            else None
        )
        if room_type_clause:
            where_clauses.append(room_type_clause)
        query_args += args

        where_clause = ""
        if where_clauses:
            where_clause = " AND " + " AND ".join(where_clauses)

        dir = "DESC" if forwards else "ASC"
        sql = f"""
            SELECT
                room_id, name, topic, canonical_alias, joined_members,
                avatar, history_visibility, guest_access, join_rules, room_type
            FROM (
                {published_sql}
            ) published
            INNER JOIN room_stats_state USING (room_id)
            INNER JOIN room_stats_current USING (room_id)
            WHERE
                (
                    join_rules = '{JoinRules.PUBLIC}'
                    OR join_rules = '{JoinRules.KNOCK}'
                    OR join_rules = '{JoinRules.KNOCK_RESTRICTED}'
                    OR history_visibility = 'world_readable'
                )
                AND joined_members > 0
                {where_clause}
            ORDER BY
                joined_members {dir},
                room_id {dir}
        """

        if limit is not None:
            query_args.append(limit)

            sql += """
                LIMIT ?
            """

        def _get_largest_public_rooms_txn(
            txn: LoggingTransaction,
        ) -> list[LargestRoomStats]:
            txn.execute(sql, query_args)

            results = [
                LargestRoomStats(
                    room_id=r[0],
                    name=r[1],
                    canonical_alias=r[3],
                    joined_members=r[4],
                    join_rules=r[8],
                    guest_access=r[7],
                    history_visibility=r[6],
                    state_events=0,
                    avatar=r[5],
                    topic=r[2],
                    room_type=r[9],
                )
                for r in txn
            ]

            if not forwards:
                results.reverse()

            return results

        return await self.db_pool.runInteraction(
            "get_largest_public_rooms", _get_largest_public_rooms_txn
        )

    @cached(max_entries=10000)
    async def is_room_blocked(self, room_id: str) -> bool | None:
        return await self.db_pool.simple_select_one_onecol(
            table="blocked_rooms",
            keyvalues={"room_id": room_id},
            retcol="1",
            allow_none=True,
            desc="is_room_blocked",
        )

    async def room_is_blocked_by(self, room_id: str) -> str | None:
        """
        Function to retrieve user who has blocked the room.
        user_id is non-nullable
        It returns None if the room is not blocked.
        """
        return await self.db_pool.simple_select_one_onecol(
            table="blocked_rooms",
            keyvalues={"room_id": room_id},
            retcol="user_id",
            allow_none=True,
            desc="room_is_blocked_by",
        )

    async def get_rooms_paginate(
        self,
        start: int,
        limit: int,
        order_by: str,
        reverse_order: bool,
        search_term: str | None,
        public_rooms: bool | None,
        empty_rooms: bool | None,
    ) -> tuple[list[dict[str, Any]], int]:
        """Function to retrieve a paginated list of rooms as json.

        Args:
            start: offset in the list
            limit: maximum amount of rooms to retrieve
            order_by: the sort order of the returned list
            reverse_order: whether to reverse the room list
            search_term: a string to filter room names,
                canonical alias and room ids by.
                Room ID must match exactly. Canonical alias must match a substring of the local part.
            public_rooms: Optional flag to filter public and non-public rooms. If true, public rooms are queried.
                    if false, public rooms are excluded from the query. When it is
                    none (the default), both public rooms and none-public-rooms are queried.
            empty_rooms: Optional flag to filter empty and non-empty rooms.
                    A room is empty if joined_members is zero.
                    If true, empty rooms are queried.
                    if false, empty rooms are excluded from the query. When it is
                    none (the default), both empty rooms and none-empty rooms are queried.
        Returns:
            A list of room dicts and an integer representing the total number of
            rooms that exist given this query
        """
        # Filter room names by a string
        filter_ = []
        where_args = []
        if search_term:
            filter_ = [
                "LOWER(state.name) LIKE ? OR "
                "LOWER(state.canonical_alias) LIKE ? OR "
                "state.room_id = ?"
            ]

            # Our postgres db driver converts ? -> %s in SQL strings as that's the
            # placeholder for postgres.
            # HOWEVER, if you put a % into your SQL then everything goes wibbly.
            # To get around this, we're going to surround search_term with %'s
            # before giving it to the database in python instead
            where_args = [
                f"%{search_term.lower()}%",
                f"#%{search_term.lower()}%:%",
                search_term,
            ]
        if public_rooms is not None:
            filter_arg = "1" if public_rooms else "0"
            filter_.append(f"rooms.is_public = '{filter_arg}'")

        if empty_rooms is not None:
            if empty_rooms:
                filter_.append("curr.joined_members = 0")
            else:
                filter_.append("curr.joined_members <> 0")

        where_clause = "WHERE " + " AND ".join(filter_) if len(filter_) > 0 else ""

        # Set ordering
        if RoomSortOrder(order_by) == RoomSortOrder.SIZE:
            # Deprecated in favour of RoomSortOrder.JOINED_MEMBERS
            order_by_column = "curr.joined_members"
            order_by_asc = False
        elif RoomSortOrder(order_by) == RoomSortOrder.ALPHABETICAL:
            # Deprecated in favour of RoomSortOrder.NAME
            order_by_column = "state.name"
            order_by_asc = True
        elif RoomSortOrder(order_by) == RoomSortOrder.NAME:
            order_by_column = "state.name"
            order_by_asc = True
        elif RoomSortOrder(order_by) == RoomSortOrder.CANONICAL_ALIAS:
            order_by_column = "state.canonical_alias"
            order_by_asc = True
        elif RoomSortOrder(order_by) == RoomSortOrder.JOINED_MEMBERS:
            order_by_column = "curr.joined_members"
            order_by_asc = False
        elif RoomSortOrder(order_by) == RoomSortOrder.JOINED_LOCAL_MEMBERS:
            order_by_column = "curr.local_users_in_room"
            order_by_asc = False
        elif RoomSortOrder(order_by) == RoomSortOrder.VERSION:
            order_by_column = "rooms.room_version"
            order_by_asc = False
        elif RoomSortOrder(order_by) == RoomSortOrder.CREATOR:
            order_by_column = "rooms.creator"
            order_by_asc = True
        elif RoomSortOrder(order_by) == RoomSortOrder.ENCRYPTION:
            order_by_column = "state.encryption"
            order_by_asc = True
        elif RoomSortOrder(order_by) == RoomSortOrder.FEDERATABLE:
            order_by_column = "state.is_federatable"
            order_by_asc = True
        elif RoomSortOrder(order_by) == RoomSortOrder.PUBLIC:
            order_by_column = "rooms.is_public"
            order_by_asc = True
        elif RoomSortOrder(order_by) == RoomSortOrder.JOIN_RULES:
            order_by_column = "state.join_rules"
            order_by_asc = True
        elif RoomSortOrder(order_by) == RoomSortOrder.GUEST_ACCESS:
            order_by_column = "state.guest_access"
            order_by_asc = True
        elif RoomSortOrder(order_by) == RoomSortOrder.HISTORY_VISIBILITY:
            order_by_column = "state.history_visibility"
            order_by_asc = True
        elif RoomSortOrder(order_by) == RoomSortOrder.STATE_EVENTS:
            order_by_column = "curr.current_state_events"
            order_by_asc = False
        else:
            raise StoreError(
                500, "Incorrect value for order_by provided: %s" % order_by
            )

        # Whether to return the list in reverse order
        if reverse_order:
            # Flip the boolean
            order_by_asc = not order_by_asc

        # Create one query for getting the limited number of events that the user asked
        # for, and another query for getting the total number of events that could be
        # returned. Thus allowing us to see if there are more events to paginate through
        info_sql = """
            SELECT state.room_id, state.name, state.canonical_alias, curr.joined_members,
              curr.local_users_in_room, rooms.room_version, rooms.creator,
              state.encryption, state.is_federatable, rooms.is_public, state.join_rules,
              state.guest_access, state.history_visibility, curr.current_state_events,
              state.room_type
            FROM room_stats_state state
            INNER JOIN room_stats_current curr USING (room_id)
            INNER JOIN rooms USING (room_id)
            {where}
            ORDER BY {order_by} {direction}, state.room_id {direction}
            LIMIT ?
            OFFSET ?
        """.format(
            where=where_clause,
            order_by=order_by_column,
            direction="ASC" if order_by_asc else "DESC",
        )

        # Use a nested SELECT statement as SQL can't count(*) with an OFFSET
        count_sql = """
            SELECT count(*) FROM (
              SELECT room_id FROM room_stats_state state
              INNER JOIN room_stats_current curr USING (room_id)
              INNER JOIN rooms USING (room_id)
              {where}
            ) AS get_room_ids
        """.format(
            where=where_clause,
        )

        def _get_rooms_paginate_txn(
            txn: LoggingTransaction,
        ) -> tuple[list[dict[str, Any]], int]:
            # Add the search term into the WHERE clause
            # and execute the data query
            txn.execute(info_sql, where_args + [limit, start])

            # Refactor room query data into a structured dictionary
            rooms = []
            for room in txn:
                rooms.append(
                    {
                        "room_id": room[0],
                        "name": room[1],
                        "canonical_alias": room[2],
                        "joined_members": room[3],
                        "joined_local_members": room[4],
                        "version": room[5],
                        "creator": room[6],
                        "encryption": room[7],
                        # room_stats_state.federatable is an integer on sqlite.
                        "federatable": bool(room[8]),
                        # rooms.is_public is an integer on sqlite.
                        "public": bool(room[9]),
                        "join_rules": room[10],
                        "guest_access": room[11],
                        "history_visibility": room[12],
                        "state_events": room[13],
                        "room_type": room[14],
                    }
                )

            # Execute the count query

            # Add the search term into the WHERE clause if present
            txn.execute(count_sql, where_args)

            room_count = cast(tuple[int], txn.fetchone())
            return rooms, room_count[0]

        return await self.db_pool.runInteraction(
            "get_rooms_paginate",
            _get_rooms_paginate_txn,
        )

    @cached(max_entries=10000)
    async def get_ratelimit_for_user(self, user_id: str) -> RatelimitOverride | None:
        """Check if there are any overrides for ratelimiting for the given user

        Args:
            user_id: user ID of the user
        Returns:
            RatelimitOverride if there is an override, else None. If the contents
            of RatelimitOverride are None or 0 then ratelimitng has been
            disabled for that user entirely.
        """
        row = await self.db_pool.simple_select_one(
            table="ratelimit_override",
            keyvalues={"user_id": user_id},
            retcols=("messages_per_second", "burst_count"),
            allow_none=True,
            desc="get_ratelimit_for_user",
        )

        if row:
            return RatelimitOverride(messages_per_second=row[0], burst_count=row[1])
        else:
            return None

    async def set_ratelimit_for_user(
        self, user_id: str, messages_per_second: int, burst_count: int
    ) -> None:
        """Sets whether a user is set an overridden ratelimit.
        Args:
            user_id: user ID of the user
            messages_per_second: The number of actions that can be performed in a second.
            burst_count: How many actions that can be performed before being limited.
        """

        def set_ratelimit_txn(txn: LoggingTransaction) -> None:
            self.db_pool.simple_upsert_txn(
                txn,
                table="ratelimit_override",
                keyvalues={"user_id": user_id},
                values={
                    "messages_per_second": messages_per_second,
                    "burst_count": burst_count,
                },
            )

            self._invalidate_cache_and_stream(
                txn, self.get_ratelimit_for_user, (user_id,)
            )

        await self.db_pool.runInteraction("set_ratelimit", set_ratelimit_txn)

    async def delete_ratelimit_for_user(self, user_id: str) -> None:
        """Delete an overridden ratelimit for a user.
        Args:
            user_id: user ID of the user
        """

        def delete_ratelimit_txn(txn: LoggingTransaction) -> None:
            row = self.db_pool.simple_select_one_txn(
                txn,
                table="ratelimit_override",
                keyvalues={"user_id": user_id},
                retcols=["user_id"],
                allow_none=True,
            )

            if not row:
                return

            # They are there, delete them.
            self.db_pool.simple_delete_one_txn(
                txn, "ratelimit_override", keyvalues={"user_id": user_id}
            )

            self._invalidate_cache_and_stream(
                txn, self.get_ratelimit_for_user, (user_id,)
            )

        await self.db_pool.runInteraction("delete_ratelimit", delete_ratelimit_txn)

    @cached()
    async def get_retention_policy_for_room(self, room_id: str) -> RetentionPolicy:
        """Get the retention policy for a given room.

        If no retention policy has been found for this room, returns a policy defined
        by the configured default policy (which has None as both the 'min_lifetime' and
        the 'max_lifetime' if no default policy has been defined in the server's
        configuration).

        If support for retention policies is disabled, a policy with a 'min_lifetime' and
        'max_lifetime' of None is returned.

        Args:
            room_id: The ID of the room to get the retention policy of.

        Returns:
            A dict containing "min_lifetime" and "max_lifetime" for this room.
        """
        # If the room retention feature is disabled, return a policy with no minimum nor
        # maximum. This prevents incorrectly filtering out events when sending to
        # the client.
        if not self.config.retention.retention_enabled:
            return RetentionPolicy()

        def get_retention_policy_for_room_txn(
            txn: LoggingTransaction,
        ) -> tuple[int | None, int | None] | None:
            txn.execute(
                """
                SELECT min_lifetime, max_lifetime FROM room_retention
                INNER JOIN current_state_events USING (event_id, room_id)
                WHERE room_id = ?;
                """,
                (room_id,),
            )

            return cast(tuple[int | None, int | None] | None, txn.fetchone())

        ret = await self.db_pool.runInteraction(
            "get_retention_policy_for_room",
            get_retention_policy_for_room_txn,
        )

        # If we don't know this room ID, ret will be None, in this case return the default
        # policy.
        if not ret:
            return RetentionPolicy(
                min_lifetime=self.config.retention.retention_default_min_lifetime,
                max_lifetime=self.config.retention.retention_default_max_lifetime,
            )

        min_lifetime, max_lifetime = ret

        # If one of the room's policy's attributes isn't defined, use the matching
        # attribute from the default policy.
        # The default values will be None if no default policy has been defined, or if one
        # of the attributes is missing from the default policy.
        if min_lifetime is None:
            min_lifetime = self.config.retention.retention_default_min_lifetime

        if max_lifetime is None:
            max_lifetime = self.config.retention.retention_default_max_lifetime

        return RetentionPolicy(
            min_lifetime=min_lifetime,
            max_lifetime=max_lifetime,
        )

    async def get_media_mxcs_in_room(self, room_id: str) -> tuple[list[str], list[str]]:
        """Retrieves all the local and remote media MXC URIs in a given room

        Args:
            room_id

        Returns:
            The local and remote media as a lists of the media IDs.
        """

        def _get_media_mxcs_in_room_txn(
            txn: LoggingTransaction,
        ) -> tuple[list[str], list[str]]:
            local_mxcs, remote_mxcs = self._get_media_mxcs_in_room_txn(txn, room_id)
            local_media_mxcs = []
            remote_media_mxcs = []

            # Convert the IDs to MXC URIs
            for media_id in local_mxcs:
                local_media_mxcs.append("mxc://%s/%s" % (self.hs.hostname, media_id))
            for hostname, media_id in remote_mxcs:
                remote_media_mxcs.append("mxc://%s/%s" % (hostname, media_id))

            return local_media_mxcs, remote_media_mxcs

        return await self.db_pool.runInteraction(
            "get_media_ids_in_room", _get_media_mxcs_in_room_txn
        )

    async def quarantine_media_ids_in_room(
        self, room_id: str, quarantined_by: str
    ) -> int:
        """For a room loops through all events with media and quarantines
        the associated media
        """

        logger.info("Quarantining media in room: %s", room_id)

        def _quarantine_media_in_room_txn(txn: LoggingTransaction) -> int:
            local_mxcs, remote_mxcs = self._get_media_mxcs_in_room_txn(txn, room_id)
            return self._quarantine_media_txn(
                txn, local_mxcs, remote_mxcs, quarantined_by
            )

        return await self.db_pool.runInteraction(
            "quarantine_media_in_room", _quarantine_media_in_room_txn
        )

    def _get_media_mxcs_in_room_txn(
        self, txn: LoggingTransaction, room_id: str
    ) -> tuple[list[str], list[tuple[str, str]]]:
        """Retrieves all the local and remote media MXC URIs in a given room

        Returns:
            The local and remote media as a lists of tuples where the key is
            the hostname and the value is the media ID.
        """
        sql = """
            SELECT stream_ordering, json FROM events
            JOIN event_json USING (room_id, event_id)
            WHERE room_id = ?
                %(where_clause)s
                AND contains_url = TRUE AND outlier = FALSE
            ORDER BY stream_ordering DESC
            LIMIT ?
        """
        txn.execute(sql % {"where_clause": ""}, (room_id, 100))

        local_media_mxcs = []
        remote_media_mxcs = []

        while True:
            next_token = None
            for stream_ordering, content_json in txn:
                next_token = stream_ordering
                event_json = db_to_json(content_json)
                content = event_json["content"]
                content_url = content.get("url")
                info = content.get("info")
                if isinstance(info, dict):
                    thumbnail_url = info.get("thumbnail_url")
                else:
                    thumbnail_url = None

                for url in (content_url, thumbnail_url):
                    if not url:
                        continue
                    matches = MXC_REGEX.match(url)
                    if matches:
                        hostname = matches.group(1)
                        media_id = matches.group(2)
                        if hostname == self.hs.hostname:
                            local_media_mxcs.append(media_id)
                        else:
                            remote_media_mxcs.append((hostname, media_id))

            if next_token is None:
                # We've gone through the whole room, so we're finished.
                break

            txn.execute(
                sql % {"where_clause": "AND stream_ordering < ?"},
                (room_id, next_token, 100),
            )

        return local_media_mxcs, remote_media_mxcs

    async def quarantine_media_by_id(
        self,
        server_name: str,
        media_id: str,
        quarantined_by: str | None,
    ) -> int:
        """quarantines or unquarantines a single local or remote media id

        Args:
            server_name: The name of the server that holds this media
            media_id: The ID of the media to be quarantined
            quarantined_by: The user ID that initiated the quarantine request
                If it is `None` media will be removed from quarantine
        """
        logger.info("Quarantining media: %s/%s", server_name, media_id)
        is_local = self.hs.is_mine_server_name(server_name)

        def _quarantine_media_by_id_txn(txn: LoggingTransaction) -> int:
            local_mxcs = [media_id] if is_local else []
            remote_mxcs = [(server_name, media_id)] if not is_local else []

            return self._quarantine_media_txn(
                txn, local_mxcs, remote_mxcs, quarantined_by
            )

        return await self.db_pool.runInteraction(
            "quarantine_media_by_user", _quarantine_media_by_id_txn
        )

    async def quarantine_media_ids_by_user(
        self, user_id: str, quarantined_by: str
    ) -> int:
        """quarantines all local media associated with a single user

        Args:
            user_id: The ID of the user to quarantine media of
            quarantined_by: The ID of the user who made the quarantine request
        """

        def _quarantine_media_by_user_txn(txn: LoggingTransaction) -> int:
            local_media_ids = self._get_media_ids_by_user_txn(txn, user_id)
            return self._quarantine_media_txn(txn, local_media_ids, [], quarantined_by)

        return await self.db_pool.runInteraction(
            "quarantine_media_by_user", _quarantine_media_by_user_txn
        )

    def _get_media_ids_by_user_txn(
        self, txn: LoggingTransaction, user_id: str, filter_quarantined: bool = True
    ) -> list[str]:
        """Retrieves local media IDs by a given user

        Args:
            txn (cursor)
            user_id: The ID of the user to retrieve media IDs of

        Returns:
            The local and remote media as a lists of tuples where the key is
            the hostname and the value is the media ID.
        """
        # Local media
        sql = """
            SELECT media_id
            FROM local_media_repository
            WHERE user_id = ?
            """
        if filter_quarantined:
            sql += "AND quarantined_by IS NULL"
        txn.execute(sql, (user_id,))

        local_media_ids = [row[0] for row in txn]

        # TODO: Figure out all remote media a user has referenced in a message

        return local_media_ids

    def get_quarantined_media_stream_token(self) -> MultiWriterStreamToken:
        return MultiWriterStreamToken.from_generator(
            self._quarantined_media_changes_id_gen
        )

    def get_quarantined_media_stream_id_generator(self) -> MultiWriterIdGenerator:
        return self._quarantined_media_changes_id_gen

    def get_current_quarantined_media_stream_id(self) -> int:
        """Gets the position of the quarantined media changes stream.

        Returns:
            int - the current stream ID
        """
        return self._quarantined_media_changes_id_gen.get_current_token()

    async def get_max_allocated_quarantined_media_stream_id(self) -> int:
        """Gets the maximum allocated position of the quarantined media changes stream.

        Returns:
            int - the maximum stream ID
        """
        return await self._quarantined_media_changes_id_gen.get_max_allocated_token()

    async def get_quarantined_media_changes(
        self, *, from_id: int, to_id: int, limit: int
    ) -> list[QuarantinedMediaUpdate]:
        """
        Get updates to quarantined media in stream ordering since `from_id`.

        Paginating forwards: from_id < x <= to_id, (ascending order)

        Args:
            from_id: The starting stream ID (exclusive)
            to_id: The ending stream ID (inclusive)
            limit: The maximum number of rows to return

        Returns:
            List of `QuarantinedMediaUpdate` update rows in stream ordering (ascending order).

        Raises:
            SynapseError: If waiting for `to_id` took too long.
        """
        if to_id < from_id:
            # the to_id is behind the from_id, which means no results
            return []

        return await self.db_pool.runInteraction(
            "get_quarantined_media_changes",
            self._get_quarantined_media_changes_txn,
            from_id,
            to_id,
            limit,
        )

    def _get_quarantined_media_changes_txn(
        self, txn: LoggingTransaction, from_id: int, to_id: int, limit: int
    ) -> list[QuarantinedMediaUpdate]:
        txn.execute(
            """
            SELECT stream_id, origin, media_id, quarantined
            FROM quarantined_media_changes
            WHERE ? < stream_id AND stream_id <= ?
            ORDER BY stream_id ASC
            LIMIT ?
            """,
            (from_id, to_id, limit),
        )
        return [
            QuarantinedMediaUpdate(
                stream_id=stream_id,
                origin=origin,
                media_id=media_id,
                quarantined=quarantined,
            )
            for stream_id, origin, media_id, quarantined in txn
        ]

    def _insert_quarantine_changes_txn(
        self,
        txn: LoggingTransaction,
        origins_and_media_ids: list[tuple[str | None, str]],
        quarantined: bool,
    ) -> None:
        """Records media being (un)quarantined in the stream.

        Args:
            txn (cursor)
            origins_and_media_ids: The [origin, media_id] tuples to record. The origin
                may be None if the media is local.
            quarantined: Whether the media is being quarantined or unquarantined.
        """
        assert self._can_write_quarantined_media_changes
        medias_with_stream_ids = zip(
            origins_and_media_ids,
            self._quarantined_media_changes_id_gen.get_next_mult_txn(
                txn, len(origins_and_media_ids)
            ),
            strict=True,
        )
        self.db_pool.simple_insert_many_txn(
            txn,
            "quarantined_media_changes",
            keys=(
                "instance_name",
                "stream_id",
                "origin",
                "media_id",
                "quarantined",
            ),
            values=[
                (
                    self._instance_name,
                    stream_id,
                    origin,
                    media_id,
                    quarantined,
                )
                for (origin, media_id), stream_id in medias_with_stream_ids
            ],
        )

    def _quarantine_local_media_txn(
        self,
        txn: LoggingTransaction,
        hashes: set[str],
        media_ids: set[str],
        quarantined_by: str | None,
    ) -> int:
        """Quarantine and unquarantine local media items.

        Args:
            txn (cursor)
            hashes: A set of sha256 hashes for any media that should be quarantined
            media_ids: A set of media IDs for any media that should be quarantined
            quarantined_by: The ID of the user who initiated the quarantine request
                If it is `None` media will be removed from quarantine
        Returns:
            The total number of media items quarantined
        """
        total_media_quarantined = 0

        # Effectively a legacy path, update any media that was explicitly named.
        if media_ids:
            sql_many_clause_sql, sql_many_clause_args = make_in_list_sql_clause(
                txn.database_engine, "media_id", media_ids
            )
            sql = f"""
                UPDATE local_media_repository
                SET quarantined_by = ?
                WHERE {sql_many_clause_sql}"""

            if quarantined_by is not None:
                sql += " AND safe_from_quarantine = FALSE"

            sql += " RETURNING media_id"

            txn.execute(sql, [quarantined_by] + sql_many_clause_args)
            media_ids_affected = txn.fetchall()
            # We use `len(media_ids_affected)` here and below because both queries may
            # affect fewer or more rows than the `media_ids` input. For example, if the
            # media_ids point to already-quarantined media, then nothing was updated.
            # Similarly, the below query might find more media than the `media_ids`
            # because it's searching for hashes instead.
            total_media_quarantined += len(media_ids_affected)
            if len(media_ids_affected) > 0:
                # Flag media that was newly (un)quarantined in the changes table.
                self._insert_quarantine_changes_txn(
                    txn,
                    [(None, media_id) for (media_id,) in media_ids_affected],
                    quarantined_by is not None,
                )

        # Update any media that was identified via hash.
        if hashes:
            sql_many_clause_sql, sql_many_clause_args = make_in_list_sql_clause(
                txn.database_engine, "sha256", hashes
            )
            sql = f"""
                UPDATE local_media_repository
                SET quarantined_by = ?
                WHERE {sql_many_clause_sql}"""

            if quarantined_by is not None:
                sql += " AND safe_from_quarantine = FALSE"

            sql += " RETURNING media_id"

            txn.execute(sql, [quarantined_by] + sql_many_clause_args)
            media_ids_affected = txn.fetchall()
            total_media_quarantined += len(media_ids_affected)
            if len(media_ids_affected) > 0:
                self._insert_quarantine_changes_txn(
                    txn,
                    [(None, media_id) for (media_id,) in media_ids_affected],
                    quarantined_by is not None,
                )

        return total_media_quarantined

    def _quarantine_remote_media_txn(
        self,
        txn: LoggingTransaction,
        hashes: set[str],
        media: set[tuple[str, str]],
        quarantined_by: str | None,
    ) -> int:
        """Quarantine and unquarantine remote items

        Args:
            txn (cursor)
            hashes: A set of sha256 hashes for any media that should be quarantined
            media_ids: A set of tuples (media_origin, media_id) for any media that should be quarantined
            quarantined_by: The ID of the user who initiated the quarantine request
                If it is `None` media will be removed from quarantine
        Returns:
            The total number of media items quarantined
        """
        total_media_quarantined = 0

        if media:
            sql_in_list_clause, sql_args = make_tuple_in_list_sql_clause(
                txn.database_engine,
                ("media_origin", "media_id"),
                media,
            )
            sql = f"""
                UPDATE remote_media_cache
                SET quarantined_by = ?
                WHERE {sql_in_list_clause}
                RETURNING media_origin, media_id"""

            txn.execute(sql, [quarantined_by] + sql_args)
            media_ids_affected = cast(list[tuple[str | None, str]], txn.fetchall())
            total_media_quarantined += len(media_ids_affected)
            if len(media_ids_affected) > 0:
                self._insert_quarantine_changes_txn(
                    txn,
                    media_ids_affected,
                    quarantined_by is not None,
                )

        if hashes:
            sql_many_clause_sql, sql_many_clause_args = make_in_list_sql_clause(
                txn.database_engine, "sha256", hashes
            )
            sql = f"""
                UPDATE remote_media_cache
                SET quarantined_by = ?
                WHERE {sql_many_clause_sql}
                RETURNING media_origin, media_id"""
            txn.execute(sql, [quarantined_by] + sql_many_clause_args)
            media_ids_affected = cast(list[tuple[str | None, str]], txn.fetchall())
            total_media_quarantined += len(media_ids_affected)
            if len(media_ids_affected) > 0:
                self._insert_quarantine_changes_txn(
                    txn,
                    media_ids_affected,
                    quarantined_by is not None,
                )

        return total_media_quarantined

    def _quarantine_media_txn(
        self,
        txn: LoggingTransaction,
        local_mxcs: list[str],
        remote_mxcs: list[tuple[str, str]],
        quarantined_by: str | None,
    ) -> int:
        """Quarantine and unquarantine 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
                If it is `None` media will be removed from quarantine
        Returns:
            The total number of media items quarantined
        """
        hashes = set()
        media_ids = set()
        remote_media = set()

        # First, determine the hashes of the media we want to delete.
        # We also want the media_ids for any media that lacks a hash.
        if local_mxcs:
            hash_sql_many_clause_sql, hash_sql_many_clause_args = (
                make_in_list_sql_clause(txn.database_engine, "media_id", local_mxcs)
            )
            hash_sql = f"SELECT sha256, media_id FROM local_media_repository WHERE {hash_sql_many_clause_sql}"
            if quarantined_by is not None:
                hash_sql += " AND safe_from_quarantine = FALSE"

            txn.execute(hash_sql, hash_sql_many_clause_args)
            for sha256, media_id in txn:
                if sha256:
                    hashes.add(sha256)
                else:
                    media_ids.add(media_id)

        # Do the same for remote media
        if remote_mxcs:
            hash_sql_in_list_clause, hash_sql_args = make_tuple_in_list_sql_clause(
                txn.database_engine,
                ("media_origin", "media_id"),
                remote_mxcs,
            )

            hash_sql = f"SELECT sha256, media_origin, media_id FROM remote_media_cache WHERE {hash_sql_in_list_clause}"
            txn.execute(hash_sql, hash_sql_args)
            for sha256, media_origin, media_id in txn:
                if sha256:
                    hashes.add(sha256)
                else:
                    remote_media.add((media_origin, media_id))

        count = self._quarantine_local_media_txn(txn, hashes, media_ids, quarantined_by)
        count += self._quarantine_remote_media_txn(
            txn, hashes, remote_media, quarantined_by
        )

        return count

    async def block_room(self, room_id: str, user_id: str) -> None:
        """Marks the room as blocked.

        Can be called multiple times (though we'll only track the last user to
        block this room).

        Can be called on a room unknown to this homeserver.

        Args:
            room_id: Room to block
            user_id: Who blocked it
        """
        await self.db_pool.simple_upsert(
            table="blocked_rooms",
            keyvalues={"room_id": room_id},
            values={},
            insertion_values={"user_id": user_id},
            desc="block_room",
        )
        await self.db_pool.runInteraction(
            "block_room_invalidation",
            self._invalidate_cache_and_stream,
            self.is_room_blocked,
            (room_id,),
        )

    async def unblock_room(self, room_id: str) -> None:
        """Remove the room from blocking list.

        Args:
            room_id: Room to unblock
        """
        await self.db_pool.simple_delete(
            table="blocked_rooms",
            keyvalues={"room_id": room_id},
            desc="unblock_room",
        )
        await self.db_pool.runInteraction(
            "block_room_invalidation",
            self._invalidate_cache_and_stream,
            self.is_room_blocked,
            (room_id,),
        )

    async def get_rooms_for_retention_period_in_range(
        self, min_ms: int | None, max_ms: int | None, include_null: bool = False
    ) -> dict[str, RetentionPolicy]:
        """Retrieves all of the rooms within the given retention range.

        Optionally includes the rooms which don't have a retention policy.

        Args:
            min_ms: Duration in milliseconds that define the lower limit of
                the range to handle (exclusive). If None, doesn't set a lower limit.
            max_ms: Duration in milliseconds that define the upper limit of
                the range to handle (inclusive). If None, doesn't set an upper limit.
            include_null: Whether to include rooms which retention policy is NULL
                in the returned set.

        Returns:
            The rooms within this range, along with their retention
            policy. The key is "room_id", and maps to a dict describing the retention
            policy associated with this room ID. The keys for this nested dict are
            "min_lifetime" (int|None), and "max_lifetime" (int|None).
        """

        def get_rooms_for_retention_period_in_range_txn(
            txn: LoggingTransaction,
        ) -> dict[str, RetentionPolicy]:
            range_conditions = []
            args = []

            if min_ms is not None:
                range_conditions.append("max_lifetime > ?")
                args.append(min_ms)

            if max_ms is not None:
                range_conditions.append("max_lifetime <= ?")
                args.append(max_ms)

            # Do a first query which will retrieve the rooms that have a retention policy
            # in their current state.
            sql = """
                SELECT room_id, min_lifetime, max_lifetime FROM room_retention
                INNER JOIN current_state_events USING (event_id, room_id)
                """

            if len(range_conditions):
                sql += " WHERE (" + " AND ".join(range_conditions) + ")"

                if include_null:
                    sql += " OR max_lifetime IS NULL"

            txn.execute(sql, args)

            rooms_dict = {
                room_id: RetentionPolicy(
                    min_lifetime=min_lifetime,
                    max_lifetime=max_lifetime,
                )
                for room_id, min_lifetime, max_lifetime in txn
            }

            if include_null:
                # If required, do a second query that retrieves all of the rooms we know
                # of so we can handle rooms with no retention policy.
                sql = "SELECT DISTINCT room_id FROM current_state_events"

                txn.execute(sql)

                # If a room isn't already in the dict (i.e. it doesn't have a retention
                # policy in its state), add it with a null policy.
                for (room_id,) in txn:
                    if room_id not in rooms_dict:
                        rooms_dict[room_id] = RetentionPolicy()

            return rooms_dict

        return await self.db_pool.runInteraction(
            "get_rooms_for_retention_period_in_range",
            get_rooms_for_retention_period_in_range_txn,
        )

    async def get_partial_state_servers_at_join(
        self, room_id: str
    ) -> AbstractSet[str] | None:
        """Gets the set of servers in a partial state room at the time we joined it.

        Returns:
            The `servers_in_room` list from the `/send_join` response for partial state
            rooms. May not be accurate or complete, as it comes from a remote
            homeserver.
            `None` for full state rooms.
        """
        servers_in_room = await self._get_partial_state_servers_at_join(room_id)

        if len(servers_in_room) == 0:
            return None

        return servers_in_room

    @cached(iterable=True)
    async def _get_partial_state_servers_at_join(
        self, room_id: str
    ) -> AbstractSet[str]:
        return frozenset(
            await self.db_pool.simple_select_onecol(
                "partial_state_rooms_servers",
                keyvalues={"room_id": room_id},
                retcol="server_name",
                desc="get_partial_state_servers_at_join",
            )
        )

    async def get_partial_state_room_resync_info(
        self,
    ) -> Mapping[str, PartialStateResyncInfo]:
        """Get all rooms containing events with partial state, and the information
        needed to restart a "resync" of those rooms.

        Returns:
            A dictionary of rooms with partial state, with room IDs as keys and
            lists of servers in rooms as values.
        """
        room_servers: dict[str, PartialStateResyncInfo] = {}

        rows = cast(
            list[tuple[str, str]],
            await self.db_pool.simple_select_list(
                table="partial_state_rooms",
                keyvalues={},
                retcols=("room_id", "joined_via"),
                desc="get_server_which_served_partial_join",
            ),
        )

        for room_id, joined_via in rows:
            room_servers[room_id] = PartialStateResyncInfo(joined_via=joined_via)

        rows = cast(
            list[tuple[str, str]],
            await self.db_pool.simple_select_list(
                "partial_state_rooms_servers",
                keyvalues=None,
                retcols=("room_id", "server_name"),
                desc="get_partial_state_rooms",
            ),
        )

        for room_id, server_name in rows:
            entry = room_servers.get(room_id)
            if entry is None:
                # There is a foreign key constraint which enforces that every room_id in
                # partial_state_rooms_servers appears in partial_state_rooms. So we
                # expect `entry` to be non-null. (This reasoning fails if we've
                # partial-joined between the two SELECTs, but this is unlikely to happen
                # in practice.)
                continue
            entry.servers_in_room.add(server_name)

        return room_servers

    @cached(max_entries=10000)
    async def is_partial_state_room(self, room_id: str) -> bool:
        """Checks if this room has partial state.

        Returns true if this is a "partial-state" room, which means that the state
        at events in the room, and `current_state_events`, may not yet be
        complete.
        """

        entry = await self.db_pool.simple_select_one_onecol(
            table="partial_state_rooms",
            keyvalues={"room_id": room_id},
            retcol="room_id",
            allow_none=True,
            desc="is_partial_state_room",
        )

        return entry is not None

    @cachedList(cached_method_name="is_partial_state_room", list_name="room_ids")
    async def is_partial_state_room_batched(
        self, room_ids: StrCollection
    ) -> Mapping[str, bool]:
        """Checks if the given rooms have partial state.

        Returns true for "partial-state" rooms, which means that the state
        at events in the room, and `current_state_events`, may not yet be
        complete.
        """

        rows = cast(
            list[tuple[str]],
            await self.db_pool.simple_select_many_batch(
                table="partial_state_rooms",
                column="room_id",
                iterable=room_ids,
                retcols=("room_id",),
                desc="is_partial_state_room_batched",
            ),
        )
        partial_state_rooms = {row[0] for row in rows}
        return {room_id: room_id in partial_state_rooms for room_id in room_ids}

    @cached(max_entries=10000, iterable=True)
    async def get_partial_rooms(self) -> AbstractSet[str]:
        """Get any "partial-state" rooms which the user is in.

        This is fast as the set of partially stated rooms at any point across
        the whole server is small, and so such a query is fast. This is also
        faster than looking up whether a set of room ID's are partially stated
        via `is_partial_state_room_batched(...)` because of the sheer amount of
        CPU time looking all the rooms up in the cache.
        """

        def _get_partial_rooms_for_user_txn(
            txn: LoggingTransaction,
        ) -> AbstractSet[str]:
            sql = """
                SELECT room_id FROM partial_state_rooms
            """
            txn.execute(sql)
            return {room_id for (room_id,) in txn}

        return await self.db_pool.runInteraction(
            "get_partial_rooms_for_user", _get_partial_rooms_for_user_txn
        )

    async def get_join_event_id_and_device_lists_stream_id_for_partial_state(
        self, room_id: str
    ) -> tuple[str, int]:
        """Get the event ID of the initial join that started the partial
        join, and the device list stream ID at the point we started the partial
        join.

        This only returns the minimum device list stream ID at the time of
        joining, not the full device list stream token. The only impact of this
        is that we may be sending again device list updates that we've already
        sent to some destinations, which is harmless.
        """

        return cast(
            tuple[str, int],
            await self.db_pool.simple_select_one(
                table="partial_state_rooms",
                keyvalues={"room_id": room_id},
                retcols=("join_event_id", "device_lists_stream_id"),
                desc="get_join_event_id_for_partial_state",
            ),
        )

    def get_un_partial_stated_rooms_token(self, instance_name: str) -> int:
        return self._un_partial_stated_rooms_stream_id_gen.get_current_token_for_writer(
            instance_name
        )

    def get_un_partial_stated_rooms_id_generator(self) -> MultiWriterIdGenerator:
        return self._un_partial_stated_rooms_stream_id_gen

    async def get_un_partial_stated_rooms_between(
        self, last_id: int, current_id: int, room_ids: Collection[str]
    ) -> set[str]:
        """Get all rooms that got un partial stated between `last_id` exclusive and
        `current_id` inclusive.

        Returns:
            The list of room ids.
        """

        if last_id == current_id:
            return set()

        def _get_un_partial_stated_rooms_between_txn(
            txn: LoggingTransaction,
        ) -> set[str]:
            sql = """
                SELECT DISTINCT room_id FROM un_partial_stated_room_stream
                WHERE ? < stream_id AND stream_id <= ? AND
            """

            clause, args = make_in_list_sql_clause(
                self.database_engine, "room_id", room_ids
            )

            txn.execute(sql + clause, [last_id, current_id] + args)

            return {r[0] for r in txn}

        return await self.db_pool.runInteraction(
            "get_un_partial_stated_rooms_between",
            _get_un_partial_stated_rooms_between_txn,
        )

    async def get_un_partial_stated_rooms_from_stream(
        self, instance_name: str, last_id: int, current_id: int, limit: int
    ) -> tuple[list[tuple[int, tuple[str]]], int, bool]:
        """Get updates for un partial stated rooms replication stream.

        Args:
            instance_name: The writer we want to fetch updates from. Unused
                here since there is only ever one writer.
            last_id: The token to fetch updates from. Exclusive.
            current_id: The token to fetch updates up to. Inclusive.
            limit: The requested limit for the number of rows to return. The
                function may return more or fewer rows.

        Returns:
            A tuple consisting of: the updates, a token to use to fetch
            subsequent updates, and whether we returned fewer rows than exists
            between the requested tokens due to the limit.

            The token returned can be used in a subsequent call to this
            function to get further updatees.

            The updates are a list of 2-tuples of stream ID and the row data
        """

        if last_id == current_id:
            return [], current_id, False

        def get_un_partial_stated_rooms_from_stream_txn(
            txn: LoggingTransaction,
        ) -> tuple[list[tuple[int, tuple[str]]], int, bool]:
            sql = """
                SELECT stream_id, room_id
                FROM un_partial_stated_room_stream
                WHERE ? < stream_id AND stream_id <= ? AND instance_name = ?
                ORDER BY stream_id ASC
                LIMIT ?
            """
            txn.execute(sql, (last_id, current_id, instance_name, limit))
            updates = [(row[0], (row[1],)) for row in txn]
            limited = False
            upto_token = current_id
            if len(updates) >= limit:
                upto_token = updates[-1][0]
                limited = True

            return updates, upto_token, limited

        return await self.db_pool.runInteraction(
            "get_un_partial_stated_rooms_from_stream",
            get_un_partial_stated_rooms_from_stream_txn,
        )

    async def get_event_report(self, report_id: int) -> dict[str, Any] | None:
        """Retrieve an event report

        Args:
            report_id: ID of reported event in database
        Returns:
            JSON dict of information from an event report or None if the
            report does not exist.
        """

        def _get_event_report_txn(
            txn: LoggingTransaction, report_id: int
        ) -> dict[str, Any] | None:
            sql = """
                SELECT
                    er.id,
                    er.received_ts,
                    er.room_id,
                    er.event_id,
                    er.user_id,
                    er.content,
                    events.sender,
                    room_stats_state.canonical_alias,
                    room_stats_state.name,
                    event_json.json AS event_json
                FROM event_reports AS er
                LEFT JOIN events
                    ON events.event_id = er.event_id
                JOIN event_json
                    ON event_json.event_id = er.event_id
                JOIN room_stats_state
                    ON room_stats_state.room_id = er.room_id
                WHERE er.id = ?
            """

            txn.execute(sql, [report_id])
            row = txn.fetchone()

            if not row:
                return None

            event_report = {
                "id": row[0],
                "received_ts": row[1],
                "room_id": row[2],
                "event_id": row[3],
                "user_id": row[4],
                "score": db_to_json(row[5]).get("score"),
                "reason": db_to_json(row[5]).get("reason"),
                "sender": row[6],
                "canonical_alias": row[7],
                "name": row[8],
                "event_json": db_to_json(row[9]),
            }

            return event_report

        return await self.db_pool.runInteraction(
            "get_event_report", _get_event_report_txn, report_id
        )

    async def get_event_reports_paginate(
        self,
        start: int,
        limit: int,
        direction: Direction = Direction.BACKWARDS,
        user_id: str | None = None,
        room_id: str | None = None,
        event_sender_user_id: str | None = None,
    ) -> tuple[list[dict[str, Any]], int]:
        """Retrieve a paginated list of event reports

        Args:
            start: event offset to begin the query from
            limit: number of rows to retrieve
            direction: Whether to fetch the most recent first (backwards) or the
                oldest first (forwards)
            user_id: search for user_id. Ignored if user_id is None
            room_id: search for room_id. Ignored if room_id is None
                event_sender_user_id: search for the sender of the reported event. Ignored if
                event_sender_user_id is None
        Returns:
            Tuple of:
                json list of event reports
                total number of event reports matching the filter criteria
        """

        def _get_event_reports_paginate_txn(
            txn: LoggingTransaction,
        ) -> tuple[list[dict[str, Any]], int]:
            filters = []
            args: list[object] = []

            if user_id:
                filters.append("er.user_id LIKE ?")
                args.extend(["%" + user_id + "%"])
            if room_id:
                filters.append("er.room_id LIKE ?")
                args.extend(["%" + room_id + "%"])

            if event_sender_user_id:
                filters.append("events.sender = ?")
                args.extend([event_sender_user_id])

            if direction == Direction.BACKWARDS:
                order = "DESC"
            else:
                order = "ASC"

            where_clause = "WHERE " + " AND ".join(filters) if len(filters) > 0 else ""

            # We join on room_stats_state despite not using any columns from it
            # because the join can influence the number of rows returned;
            # e.g. a room that doesn't have state, maybe because it was deleted.
            # The query returning the total count should be consistent with
            # the query returning the results.
            sql = """
                SELECT COUNT(*) as total_event_reports
                FROM event_reports AS er
                LEFT JOIN events USING(event_id)
                JOIN room_stats_state ON room_stats_state.room_id = er.room_id
                {}
                """.format(where_clause)
            txn.execute(sql, args)
            count = cast(tuple[int], txn.fetchone())[0]

            sql = """
                SELECT
                    er.id,
                    er.received_ts,
                    er.room_id,
                    er.event_id,
                    er.user_id,
                    er.content,
                    events.sender,
                    room_stats_state.canonical_alias,
                    room_stats_state.name
                FROM event_reports AS er
                LEFT JOIN events USING(event_id)
                JOIN room_stats_state
                    ON room_stats_state.room_id = er.room_id
                {where_clause}
                ORDER BY er.received_ts {order}
                LIMIT ?
                OFFSET ?
            """.format(
                where_clause=where_clause,
                order=order,
            )

            args += [limit, start]
            txn.execute(sql, args)

            event_reports = []
            for row in txn:
                try:
                    s = db_to_json(row[5]).get("score")
                    r = db_to_json(row[5]).get("reason")
                except Exception:
                    logger.error("Unable to parse json from event_reports: %s", row[0])
                    continue
                event_reports.append(
                    {
                        "id": row[0],
                        "received_ts": row[1],
                        "room_id": row[2],
                        "event_id": row[3],
                        "user_id": row[4],
                        "score": s,
                        "reason": r,
                        "sender": row[6],
                        "canonical_alias": row[7],
                        "name": row[8],
                    }
                )

            return event_reports, count

        return await self.db_pool.runInteraction(
            "get_event_reports_paginate", _get_event_reports_paginate_txn
        )

    async def delete_event_report(self, report_id: int) -> bool:
        """Remove an event report from database.

        Args:
            report_id: Report to delete

        Returns:
            Whether the report was successfully deleted or not.
        """
        try:
            await self.db_pool.simple_delete_one(
                table="event_reports",
                keyvalues={"id": report_id},
                desc="delete_event_report",
            )
        except StoreError:
            # Deletion failed because report does not exist
            return False

        return True

    async def get_user_report(
        self, report_id: int
    ) -> tuple[int, int, str, str, str] | None:
        """Retrieve a user report

        Args:
            report_id: ID of user report in database
        Returns:
            JSON dict of information from a user report or None if the
            report does not exist.
        """

        return await self.db_pool.simple_select_one(
            table="user_reports",
            keyvalues={"id": report_id},
            retcols=("id", "received_ts", "target_user_id", "user_id", "reason"),
            allow_none=True,
            desc="get_user_report",
        )

    async def get_user_reports_paginate(
        self,
        start: int,
        limit: int,
        direction: Direction = Direction.BACKWARDS,
        user_id: str | None = None,
        target_user_id: str | None = None,
    ) -> tuple[list[JsonDict], int]:
        """Retrieve a paginated list of user reports

        Args:
            start: event offset to begin the query from
            limit: number of rows to retrieve
            direction: Whether to fetch the most recent first (backwards) or the
                oldest first (forwards)
            user_id: search for user_id of the reporter. Ignored if user_id is None
            target_user_id: search for user_id of the target. Ignored if target_user_id is None
        Returns:
            Tuple of:
                json list of user reports
                total number of user reports matching the filter criteria
        """

        def _get_user_reports_paginate_txn(
            txn: LoggingTransaction,
        ) -> tuple[list[dict[str, Any]], int]:
            filters = []
            args: list[object] = []

            if user_id:
                filters.append("user_id LIKE ?")
                args.extend(["%" + user_id + "%"])
            if target_user_id:
                filters.append("target_user_id LIKE ?")
                args.extend(["%" + target_user_id + "%"])

            if direction == Direction.BACKWARDS:
                order = "DESC"
            else:
                order = "ASC"

            where_clause = "WHERE " + " AND ".join(filters) if len(filters) > 0 else ""

            sql = f"""
                SELECT COUNT(*) as total_user_reports
                FROM user_reports {where_clause}
            """
            txn.execute(sql, args)
            count = cast(tuple[int], txn.fetchone())[0]

            sql = f"""
                SELECT
                    id,
                    received_ts,
                    target_user_id,
                    user_id,
                    reason
                FROM user_reports
                {where_clause}
                ORDER BY received_ts {order}
                LIMIT ?
                OFFSET ?
            """

            args += [limit, start]
            txn.execute(sql, args)

            user_reports = []
            for row in txn:
                user_reports.append(
                    {
                        "id": row[0],
                        "received_ts": row[1],
                        "target_user_id": row[2],
                        "user_id": row[3],
                        "reason": row[4],
                    }
                )

            return user_reports, count

        return await self.db_pool.runInteraction(
            "get_user_reports_paginate", _get_user_reports_paginate_txn
        )

    async def delete_user_report(self, report_id: int) -> bool:
        """Remove a user report from database.

        Args:
            report_id: Report to delete

        Returns:
            Whether the report was successfully deleted or not.
        """
        try:
            await self.db_pool.simple_delete_one(
                table="user_reports",
                keyvalues={"id": report_id},
                desc="delete_user_report",
            )
        except StoreError:
            # Deletion failed because report does not exist
            return False

        return True

    async def set_room_is_public(self, room_id: str, is_public: bool) -> None:
        await self.db_pool.simple_update_one(
            table="rooms",
            keyvalues={"room_id": room_id},
            updatevalues={"is_public": is_public},
            desc="set_room_is_public",
        )

    async def set_room_is_public_appservice(
        self, room_id: str, appservice_id: str, network_id: str, is_public: bool
    ) -> None:
        """Edit the appservice/network specific public room list.

        Each appservice can have a number of published room lists associated
        with them, keyed off of an appservice defined `network_id`, which
        basically represents a single instance of a bridge to a third party
        network.

        Args:
            room_id
            appservice_id
            network_id
            is_public: Whether to publish or unpublish the room from the list.
        """

        if is_public:
            await self.db_pool.simple_upsert(
                table="appservice_room_list",
                keyvalues={
                    "appservice_id": appservice_id,
                    "network_id": network_id,
                    "room_id": room_id,
                },
                values={},
                insertion_values={
                    "appservice_id": appservice_id,
                    "network_id": network_id,
                    "room_id": room_id,
                },
                desc="set_room_is_public_appservice_true",
            )
        else:
            await self.db_pool.simple_delete(
                table="appservice_room_list",
                keyvalues={
                    "appservice_id": appservice_id,
                    "network_id": network_id,
                    "room_id": room_id,
                },
                desc="set_room_is_public_appservice_false",
            )

    async def has_auth_chain_index(self, room_id: str) -> bool:
        """Check if the room has (or can have) a chain cover index.

        Defaults to True if we don't have an entry in `rooms` table nor any
        events for the room.
        """

        has_auth_chain_index = await self.db_pool.simple_select_one_onecol(
            table="rooms",
            keyvalues={"room_id": room_id},
            retcol="has_auth_chain_index",
            desc="has_auth_chain_index",
            allow_none=True,
        )

        if has_auth_chain_index:
            return True

        # It's possible that we already have events for the room in our DB
        # without a corresponding room entry. If we do then we don't want to
        # mark the room as having an auth chain cover index.
        max_ordering = await self.db_pool.simple_select_one_onecol(
            table="events",
            keyvalues={"room_id": room_id},
            retcol="MAX(stream_ordering)",
            allow_none=True,
            desc="has_auth_chain_index_fallback",
        )

        return max_ordering is None

    async def maybe_store_room_on_outlier_membership(
        self, room_id: str, room_version: RoomVersion
    ) -> None:
        """
        When we receive an invite or any other event over federation that may relate to a room
        we are not in, store the version of the room if we don't already know the room version.
        """
        # It's possible that we already have events for the room in our DB
        # without a corresponding room entry. If we do then we don't want to
        # mark the room as having an auth chain cover index.
        has_auth_chain_index = await self.has_auth_chain_index(room_id)

        await self.db_pool.simple_upsert(
            desc="maybe_store_room_on_outlier_membership",
            table="rooms",
            keyvalues={"room_id": room_id},
            values={},
            insertion_values={
                "room_version": room_version.identifier,
                "is_public": False,
                # We don't worry about setting the `creator` here because
                # we don't process any messages in a room while a user is
                # invited (only after the join).
                "creator": "",
                "has_auth_chain_index": has_auth_chain_index,
            },
        )


class _BackgroundUpdates:
    REMOVE_TOMESTONED_ROOMS_BG_UPDATE = "remove_tombstoned_rooms_from_directory"
    ADD_ROOMS_ROOM_VERSION_COLUMN = "add_rooms_room_version_column"
    POPULATE_ROOM_DEPTH_MIN_DEPTH2 = "populate_room_depth_min_depth2"
    REPLACE_ROOM_DEPTH_MIN_DEPTH = "replace_room_depth_min_depth"
    POPULATE_ROOMS_CREATOR_COLUMN = "populate_rooms_creator_column"
    ADD_ROOM_TYPE_COLUMN = "add_room_type_column"
    FLAG_EXISTING_QUARANTINED_MEDIA = "flag_existing_quarantined_media"


_REPLACE_ROOM_DEPTH_SQL_COMMANDS = (
    "DROP TRIGGER populate_min_depth2_trigger ON room_depth",
    "DROP FUNCTION populate_min_depth2()",
    "ALTER TABLE room_depth DROP COLUMN min_depth",
    "ALTER TABLE room_depth RENAME COLUMN min_depth2 TO min_depth",
)


class RoomBackgroundUpdateStore(RoomWorkerStore):
    def __init__(
        self,
        database: DatabasePool,
        db_conn: LoggingDatabaseConnection,
        hs: "HomeServer",
    ):
        super().__init__(database, db_conn, hs)

        self.db_pool.updates.register_background_update_handler(
            "insert_room_retention",
            self._background_insert_retention,
        )

        self.db_pool.updates.register_background_update_handler(
            _BackgroundUpdates.REMOVE_TOMESTONED_ROOMS_BG_UPDATE,
            self._remove_tombstoned_rooms_from_directory,
        )

        self.db_pool.updates.register_background_update_handler(
            _BackgroundUpdates.ADD_ROOMS_ROOM_VERSION_COLUMN,
            self._background_add_rooms_room_version_column,
        )

        self.db_pool.updates.register_background_update_handler(
            _BackgroundUpdates.ADD_ROOM_TYPE_COLUMN,
            self._background_add_room_type_column,
        )

        # BG updates to change the type of room_depth.min_depth
        self.db_pool.updates.register_background_update_handler(
            _BackgroundUpdates.POPULATE_ROOM_DEPTH_MIN_DEPTH2,
            self._background_populate_room_depth_min_depth2,
        )
        self.db_pool.updates.register_background_update_handler(
            _BackgroundUpdates.REPLACE_ROOM_DEPTH_MIN_DEPTH,
            self._background_replace_room_depth_min_depth,
        )

        self.db_pool.updates.register_background_update_handler(
            _BackgroundUpdates.POPULATE_ROOMS_CREATOR_COLUMN,
            self._background_populate_rooms_creator_column,
        )

    async def _background_insert_retention(
        self, progress: JsonDict, batch_size: int
    ) -> int:
        """Retrieves a list of all rooms within a range and inserts an entry for each of
        them into the room_retention table.
        NULLs the property's columns if missing from the retention event in the room's
        state (or NULLs all of them if there's no retention event in the room's state),
        so that we fall back to the server's retention policy.
        """

        last_room = progress.get("room_id", "")

        def _background_insert_retention_txn(txn: LoggingTransaction) -> bool:
            txn.execute(
                """
                SELECT state.room_id, state.event_id, events.json
                FROM current_state_events as state
                LEFT JOIN event_json AS events ON (state.event_id = events.event_id)
                WHERE state.room_id > ? AND state.type = '%s'
                ORDER BY state.room_id ASC
                LIMIT ?;
                """
                % EventTypes.Retention,
                (last_room, batch_size),
            )

            rows = txn.fetchall()

            if not rows:
                return True

            for room_id, event_id, json in rows:
                if not json:
                    retention_policy = {}
                else:
                    ev = db_to_json(json)
                    retention_policy = ev["content"]

                self.db_pool.simple_insert_txn(
                    txn=txn,
                    table="room_retention",
                    values={
                        "room_id": room_id,
                        "event_id": event_id,
                        "min_lifetime": retention_policy.get("min_lifetime"),
                        "max_lifetime": retention_policy.get("max_lifetime"),
                    },
                )

            logger.info("Inserted %d rows into room_retention", len(rows))

            self.db_pool.updates._background_update_progress_txn(
                txn, "insert_room_retention", {"room_id": rows[-1][0]}
            )

            if batch_size > len(rows):
                return True
            else:
                return False

        end = await self.db_pool.runInteraction(
            "insert_room_retention",
            _background_insert_retention_txn,
        )

        if end:
            await self.db_pool.updates._end_background_update("insert_room_retention")

        return batch_size

    async def _background_add_rooms_room_version_column(
        self, progress: JsonDict, batch_size: int
    ) -> int:
        """Background update to go and add room version information to `rooms`
        table from `current_state_events` table.
        """

        last_room_id = progress.get("room_id", "")

        def _background_add_rooms_room_version_column_txn(
            txn: LoggingTransaction,
        ) -> bool:
            sql = """
                SELECT room_id, json FROM current_state_events
                INNER JOIN event_json USING (room_id, event_id)
                WHERE room_id > ? AND type = 'm.room.create' AND state_key = ''
                ORDER BY room_id
                LIMIT ?
            """

            txn.execute(sql, (last_room_id, batch_size))

            updates = []
            for room_id, event_json in txn:
                event_dict = db_to_json(event_json)
                room_version_id = event_dict.get("content", {}).get(
                    "room_version", RoomVersions.V1.identifier
                )

                creator = event_dict.get("content").get("creator")

                updates.append((room_id, creator, room_version_id))

            if not updates:
                return True

            new_last_room_id = ""
            for room_id, creator, room_version_id in updates:
                # We upsert here just in case we don't already have a row,
                # mainly for paranoia as much badness would happen if we don't
                # insert the row and then try and get the room version for the
                # room.
                self.db_pool.simple_upsert_txn(
                    txn,
                    table="rooms",
                    keyvalues={"room_id": room_id},
                    values={"room_version": room_version_id},
                    insertion_values={"is_public": False, "creator": creator},
                )
                new_last_room_id = room_id

            self.db_pool.updates._background_update_progress_txn(
                txn,
                _BackgroundUpdates.ADD_ROOMS_ROOM_VERSION_COLUMN,
                {"room_id": new_last_room_id},
            )

            return False

        end = await self.db_pool.runInteraction(
            "_background_add_rooms_room_version_column",
            _background_add_rooms_room_version_column_txn,
        )

        if end:
            await self.db_pool.updates._end_background_update(
                _BackgroundUpdates.ADD_ROOMS_ROOM_VERSION_COLUMN
            )

        return batch_size

    async def _remove_tombstoned_rooms_from_directory(
        self, progress: JsonDict, batch_size: int
    ) -> int:
        """Removes any rooms with tombstone events from the room directory

        Nowadays this is handled by the room upgrade handler, but we may have some
        that got left behind
        """

        last_room = progress.get("room_id", "")

        def _get_rooms(txn: LoggingTransaction) -> list[str]:
            txn.execute(
                """
                SELECT room_id
                FROM rooms r
                INNER JOIN current_state_events cse USING (room_id)
                WHERE room_id > ? AND r.is_public
                AND cse.type = '%s' AND cse.state_key = ''
                ORDER BY room_id ASC
                LIMIT ?;
                """
                % EventTypes.Tombstone,
                (last_room, batch_size),
            )

            return [row[0] for row in txn]

        rooms = await self.db_pool.runInteraction(
            "get_tombstoned_directory_rooms", _get_rooms
        )

        if not rooms:
            await self.db_pool.updates._end_background_update(
                _BackgroundUpdates.REMOVE_TOMESTONED_ROOMS_BG_UPDATE
            )
            return 0

        for room_id in rooms:
            logger.info("Removing tombstoned room %s from the directory", room_id)
            await self.set_room_is_public(room_id, False)

        await self.db_pool.updates._background_update_progress(
            _BackgroundUpdates.REMOVE_TOMESTONED_ROOMS_BG_UPDATE, {"room_id": rooms[-1]}
        )

        return len(rooms)

    async def _background_populate_room_depth_min_depth2(
        self, progress: JsonDict, batch_size: int
    ) -> int:
        """Populate room_depth.min_depth2

        This is to deal with the fact that min_depth was initially created as a
        32-bit integer field.
        """

        def process(txn: LoggingTransaction) -> int:
            last_room = progress.get("last_room", "")
            txn.execute(
                """
                UPDATE room_depth SET min_depth2=min_depth
                WHERE room_id IN (
                   SELECT room_id FROM room_depth WHERE room_id > ?
                   ORDER BY room_id LIMIT ?
                )
                RETURNING room_id;
                """,
                (last_room, batch_size),
            )
            row_count = txn.rowcount
            if row_count == 0:
                return 0
            last_room = max(row[0] for row in txn)
            logger.info("populated room_depth up to %s", last_room)

            self.db_pool.updates._background_update_progress_txn(
                txn,
                _BackgroundUpdates.POPULATE_ROOM_DEPTH_MIN_DEPTH2,
                {"last_room": last_room},
            )
            return row_count

        result = await self.db_pool.runInteraction(
            "_background_populate_min_depth2", process
        )

        if result != 0:
            return result

        await self.db_pool.updates._end_background_update(
            _BackgroundUpdates.POPULATE_ROOM_DEPTH_MIN_DEPTH2
        )
        return 0

    async def _background_replace_room_depth_min_depth(
        self, progress: JsonDict, batch_size: int
    ) -> int:
        """Drop the old 'min_depth' column and rename 'min_depth2' into its place."""

        def process(txn: Cursor) -> None:
            for sql in _REPLACE_ROOM_DEPTH_SQL_COMMANDS:
                logger.info("completing room_depth migration: %s", sql)
                txn.execute(sql)

        await self.db_pool.runInteraction("_background_replace_room_depth", process)

        await self.db_pool.updates._end_background_update(
            _BackgroundUpdates.REPLACE_ROOM_DEPTH_MIN_DEPTH,
        )

        return 0

    async def _background_populate_rooms_creator_column(
        self, progress: JsonDict, batch_size: int
    ) -> int:
        """Background update to go and add creator information to `rooms`
        table from `current_state_events` table.
        """

        last_room_id = progress.get("room_id", "")

        def _background_populate_rooms_creator_column_txn(
            txn: LoggingTransaction,
        ) -> bool:
            sql = """
                SELECT room_id, json FROM event_json
                INNER JOIN rooms AS room USING (room_id)
                INNER JOIN current_state_events AS state_event USING (room_id, event_id)
                WHERE room_id > ? AND (room.creator IS NULL OR room.creator = '') AND state_event.type = 'm.room.create' AND state_event.state_key = ''
                ORDER BY room_id
                LIMIT ?
            """

            txn.execute(sql, (last_room_id, batch_size))
            room_id_to_create_event_results = txn.fetchall()

            new_last_room_id = ""
            for room_id, event_json in room_id_to_create_event_results:
                event_dict = db_to_json(event_json)

                # The creator property might not exist in newer room versions, but
                # for those versions the creator column should be properly populate
                # during room creation.
                creator = event_dict.get("content").get(EventContentFields.ROOM_CREATOR)

                self.db_pool.simple_update_txn(
                    txn,
                    table="rooms",
                    keyvalues={"room_id": room_id},
                    updatevalues={"creator": creator},
                )
                new_last_room_id = room_id

            if new_last_room_id == "":
                return True

            self.db_pool.updates._background_update_progress_txn(
                txn,
                _BackgroundUpdates.POPULATE_ROOMS_CREATOR_COLUMN,
                {"room_id": new_last_room_id},
            )

            return False

        end = await self.db_pool.runInteraction(
            "_background_populate_rooms_creator_column",
            _background_populate_rooms_creator_column_txn,
        )

        if end:
            await self.db_pool.updates._end_background_update(
                _BackgroundUpdates.POPULATE_ROOMS_CREATOR_COLUMN
            )

        return batch_size

    async def _background_add_room_type_column(
        self, progress: JsonDict, batch_size: int
    ) -> int:
        """Background update to go and add room_type information to `room_stats_state`
        table from `event_json` table.
        """

        last_room_id = progress.get("room_id", "")

        def _background_add_room_type_column_txn(
            txn: LoggingTransaction,
        ) -> bool:
            sql = """
                SELECT state.room_id, json FROM event_json
                INNER JOIN current_state_events AS state USING (event_id)
                WHERE state.room_id > ? AND type = 'm.room.create'
                ORDER BY state.room_id
                LIMIT ?
            """

            txn.execute(sql, (last_room_id, batch_size))
            room_id_to_create_event_results = txn.fetchall()

            new_last_room_id = None
            for room_id, event_json in room_id_to_create_event_results:
                event_dict = db_to_json(event_json)

                room_type = event_dict.get("content", {}).get(
                    EventContentFields.ROOM_TYPE, None
                )
                if isinstance(room_type, str):
                    self.db_pool.simple_update_txn(
                        txn,
                        table="room_stats_state",
                        keyvalues={"room_id": room_id},
                        updatevalues={"room_type": room_type},
                    )

                new_last_room_id = room_id

            if new_last_room_id is None:
                return True

            self.db_pool.updates._background_update_progress_txn(
                txn,
                _BackgroundUpdates.ADD_ROOM_TYPE_COLUMN,
                {"room_id": new_last_room_id},
            )

            return False

        end = await self.db_pool.runInteraction(
            "_background_add_room_type_column",
            _background_add_room_type_column_txn,
        )

        if end:
            await self.db_pool.updates._end_background_update(
                _BackgroundUpdates.ADD_ROOM_TYPE_COLUMN
            )

        return batch_size


class RoomStore(RoomBackgroundUpdateStore, RoomWorkerStore):
    def __init__(
        self,
        database: DatabasePool,
        db_conn: LoggingDatabaseConnection,
        hs: "HomeServer",
    ):
        super().__init__(database, db_conn, hs)

        self._event_reports_id_gen = IdGenerator(db_conn, "event_reports", "id")
        self._room_reports_id_gen = IdGenerator(db_conn, "room_reports", "id")
        self._user_reports_id_gen = IdGenerator(db_conn, "user_reports", "id")

        self._instance_name = hs.get_instance_name()

    async def upsert_room_on_join(
        self, room_id: str, room_version: RoomVersion, state_events: list[EventBase]
    ) -> None:
        """Ensure that the room is stored in the table

        Called when we join a room over federation, and overwrites any room version
        currently in the table.
        """
        # It's possible that we already have events for the room in our DB
        # without a corresponding room entry. If we do then we don't want to
        # mark the room as having an auth chain cover index.
        has_auth_chain_index = await self.has_auth_chain_index(room_id)

        create_event = None
        for e in state_events:
            if (e.type, e.state_key) == (EventTypes.Create, ""):
                create_event = e
                break

        if create_event is None:
            # If the state doesn't have a create event then the room is
            # invalid, and it would fail auth checks anyway.
            raise StoreError(400, "No create event in state")

        # Before MSC2175, the room creator was a separate field.
        if not room_version.implicit_room_creator:
            room_creator = create_event.content.get(EventContentFields.ROOM_CREATOR)

            if not isinstance(room_creator, str):
                # If the create event does not have a creator then the room is
                # invalid, and it would fail auth checks anyway.
                raise StoreError(400, "No creator defined on the create event")
        else:
            room_creator = create_event.sender

        await self.db_pool.simple_upsert(
            desc="upsert_room_on_join",
            table="rooms",
            keyvalues={"room_id": room_id},
            values={"room_version": room_version.identifier},
            insertion_values={
                "is_public": False,
                "creator": room_creator,
                "has_auth_chain_index": has_auth_chain_index,
            },
        )

    async def store_partial_state_room(
        self,
        room_id: str,
        servers: AbstractSet[str],
        device_lists_stream_id: int,
        joined_via: str,
    ) -> None:
        """Mark the given room as containing events with partial state.

        We also store additional data that describes _when_ we first partial-joined this
        room, which helps us to keep other homeservers in sync when we finally fully
        join this room.

        We do not include a `join_event_id` here---we need to wait for the join event
        to be persisted first.

        Args:
            room_id: the ID of the room
            servers: other servers known to be in the room. must include `joined_via`.
            device_lists_stream_id: the device_lists stream ID at the time when we first
                joined the room.
            joined_via: the server name we requested a partial join from.
        """
        assert joined_via in servers

        await self.db_pool.runInteraction(
            "store_partial_state_room",
            self._store_partial_state_room_txn,
            room_id,
            servers,
            device_lists_stream_id,
            joined_via,
        )

    def _store_partial_state_room_txn(
        self,
        txn: LoggingTransaction,
        room_id: str,
        servers: AbstractSet[str],
        device_lists_stream_id: int,
        joined_via: str,
    ) -> None:
        DatabasePool.simple_insert_txn(
            txn,
            table="partial_state_rooms",
            values={
                "room_id": room_id,
                "device_lists_stream_id": device_lists_stream_id,
                # To be updated later once the join event is persisted.
                "join_event_id": None,
                "joined_via": joined_via,
            },
        )
        DatabasePool.simple_insert_many_txn(
            txn,
            table="partial_state_rooms_servers",
            keys=("room_id", "server_name"),
            values=[(room_id, s) for s in servers],
        )
        self._invalidate_cache_and_stream(txn, self.is_partial_state_room, (room_id,))
        self._invalidate_cache_and_stream(
            txn, self._get_partial_state_servers_at_join, (room_id,)
        )
        self._invalidate_all_cache_and_stream(txn, self.get_partial_rooms)

    async def write_partial_state_rooms_join_event_id(
        self,
        room_id: str,
        join_event_id: str,
    ) -> None:
        """Record the join event which resulted from a partial join.

        We do this separately to `store_partial_state_room` because we need to wait for
        the join event to be persisted. Otherwise we violate a foreign key constraint.
        """
        await self.db_pool.runInteraction(
            "write_partial_state_rooms_join_event_id",
            self._write_partial_state_rooms_join_event_id,
            room_id,
            join_event_id,
        )

    def _write_partial_state_rooms_join_event_id(
        self,
        txn: LoggingTransaction,
        room_id: str,
        join_event_id: str,
    ) -> None:
        DatabasePool.simple_update_txn(
            txn,
            table="partial_state_rooms",
            keyvalues={"room_id": room_id},
            updatevalues={"join_event_id": join_event_id},
        )

    async def add_event_report(
        self,
        room_id: str,
        event_id: str,
        user_id: str,
        reason: str | None,
        content: JsonDict,
        received_ts: int,
    ) -> int:
        """Add an event report

        Args:
            room_id: Room that contains the reported event.
            event_id: The reported event.
            user_id: User who reports the event.
            reason: Description that the user specifies.
            content: Report request body (score and reason).
            received_ts: Time when the user submitted the report (milliseconds).
        Returns:
            Id of the event report.
        """
        next_id = self._event_reports_id_gen.get_next()
        await self.db_pool.simple_insert(
            table="event_reports",
            values={
                "id": next_id,
                "received_ts": received_ts,
                "room_id": room_id,
                "event_id": event_id,
                "user_id": user_id,
                "reason": reason,
                "content": json_encoder.encode(content),
            },
            desc="add_event_report",
        )
        return next_id

    async def add_room_report(
        self,
        room_id: str,
        user_id: str,
        reason: str,
        received_ts: int,
    ) -> int:
        """Add a room report

        Args:
            room_id: The room ID being reported.
            user_id: User who reports the room.
            reason: Description that the user specifies.
            received_ts: Time when the user submitted the report (milliseconds).
        Returns:
            Id of the room report.
        """
        next_id = self._room_reports_id_gen.get_next()
        await self.db_pool.simple_insert(
            table="room_reports",
            values={
                "id": next_id,
                "received_ts": received_ts,
                "room_id": room_id,
                "user_id": user_id,
                "reason": reason,
            },
            desc="add_room_report",
        )
        return next_id

    async def add_user_report(
        self,
        target_user_id: str,
        user_id: str,
        reason: str,
        received_ts: int,
    ) -> int:
        """Add a user report

        Args:
            target_user_id: The user ID being reported.
            user_id: User who reported the user.
            reason: Description that the user specifies.
            received_ts: Time when the user submitted the report (milliseconds).
        Returns:
            ID of the room report.
        """
        next_id = self._user_reports_id_gen.get_next()
        await self.db_pool.simple_insert(
            table="user_reports",
            values={
                "id": next_id,
                "received_ts": received_ts,
                "target_user_id": target_user_id,
                "user_id": user_id,
                "reason": reason,
            },
            desc="add_user_report",
        )
        return next_id

    async def clear_partial_state_room(self, room_id: str) -> int | None:
        """Clears the partial state flag for a room.

        Args:
            room_id: The room whose partial state flag is to be cleared.

        Returns:
            The corresponding stream id for the un-partial-stated rooms stream.

            `None` if the partial state flag could not be cleared because the room
            still contains events with partial state.
        """
        try:
            async with (
                self._un_partial_stated_rooms_stream_id_gen.get_next() as un_partial_state_room_stream_id
            ):
                await self.db_pool.runInteraction(
                    "clear_partial_state_room",
                    self._clear_partial_state_room_txn,
                    room_id,
                    un_partial_state_room_stream_id,
                )
                return un_partial_state_room_stream_id
        except self.db_pool.engine.module.IntegrityError as e:
            # Assume that any `IntegrityError`s are due to partial state events.
            logger.info(
                "Exception while clearing lazy partial-state-room %s, retrying: %s",
                room_id,
                e,
            )
            return None

    def _clear_partial_state_room_txn(
        self,
        txn: LoggingTransaction,
        room_id: str,
        un_partial_state_room_stream_id: int,
    ) -> None:
        DatabasePool.simple_delete_txn(
            txn,
            table="partial_state_rooms_servers",
            keyvalues={"room_id": room_id},
        )
        DatabasePool.simple_delete_one_txn(
            txn,
            table="partial_state_rooms",
            keyvalues={"room_id": room_id},
        )
        self._invalidate_cache_and_stream(txn, self.is_partial_state_room, (room_id,))
        self._invalidate_cache_and_stream(
            txn, self._get_partial_state_servers_at_join, (room_id,)
        )
        self._invalidate_all_cache_and_stream(txn, self.get_partial_rooms)

        DatabasePool.simple_insert_txn(
            txn,
            "un_partial_stated_room_stream",
            {
                "stream_id": un_partial_state_room_stream_id,
                "instance_name": self._instance_name,
                "room_id": room_id,
            },
        )

        # We now delete anything from `device_lists_remote_pending` with a
        # stream ID less than the minimum
        # `partial_state_rooms.device_lists_stream_id`, as we no longer need them.
        device_lists_stream_id = DatabasePool.simple_select_one_onecol_txn(
            txn,
            table="partial_state_rooms",
            keyvalues={},
            retcol="MIN(device_lists_stream_id)",
            allow_none=True,
        )
        if device_lists_stream_id is None:
            # There are no rooms being currently partially joined, so we delete everything.
            txn.execute("DELETE FROM device_lists_remote_pending")
        else:
            sql = """
                DELETE FROM device_lists_remote_pending
                WHERE stream_id <= ?
            """
            txn.execute(sql, (device_lists_stream_id,))
