mirror of
https://mau.dev/maunium/synapse.git
synced 2024-09-06 01:22:16 +00:00
![Erik Johnston](/assets/img/avatar_default.png)
During the migration the automated script to update the copyright headers accidentally got rid of some of the existing copyright lines. Reinstate them.
213 lines
6.6 KiB
Python
213 lines
6.6 KiB
Python
#
|
|
# This file is licensed under the Affero General Public License (AGPL) version 3.
|
|
#
|
|
# 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]
|
|
#
|
|
#
|
|
|
|
from typing import Iterable, List, Optional, Sequence, Tuple
|
|
|
|
import attr
|
|
|
|
from synapse.api.errors import SynapseError
|
|
from synapse.storage.database import LoggingTransaction
|
|
from synapse.storage.databases.main import CacheInvalidationWorkerStore
|
|
from synapse.types import RoomAlias
|
|
from synapse.util.caches.descriptors import cached
|
|
|
|
|
|
@attr.s(slots=True, frozen=True, auto_attribs=True)
|
|
class RoomAliasMapping:
|
|
room_id: str
|
|
room_alias: str
|
|
servers: List[str]
|
|
|
|
|
|
class DirectoryWorkerStore(CacheInvalidationWorkerStore):
|
|
async def get_association_from_room_alias(
|
|
self, room_alias: RoomAlias
|
|
) -> Optional[RoomAliasMapping]:
|
|
"""Gets the room_id and server list for a given room_alias
|
|
|
|
Args:
|
|
room_alias: The alias to translate to an ID.
|
|
|
|
Returns:
|
|
The room alias mapping or None if no association can be found.
|
|
"""
|
|
room_id = await self.db_pool.simple_select_one_onecol(
|
|
"room_aliases",
|
|
{"room_alias": room_alias.to_string()},
|
|
"room_id",
|
|
allow_none=True,
|
|
desc="get_association_from_room_alias",
|
|
)
|
|
|
|
if not room_id:
|
|
return None
|
|
|
|
servers = await self.db_pool.simple_select_onecol(
|
|
"room_alias_servers",
|
|
{"room_alias": room_alias.to_string()},
|
|
"server",
|
|
desc="get_association_from_room_alias",
|
|
)
|
|
|
|
if not servers:
|
|
return None
|
|
|
|
return RoomAliasMapping(room_id, room_alias.to_string(), servers)
|
|
|
|
async def get_room_alias_creator(self, room_alias: str) -> str:
|
|
return await self.db_pool.simple_select_one_onecol(
|
|
table="room_aliases",
|
|
keyvalues={"room_alias": room_alias},
|
|
retcol="creator",
|
|
desc="get_room_alias_creator",
|
|
)
|
|
|
|
@cached(max_entries=5000)
|
|
async def get_aliases_for_room(self, room_id: str) -> Sequence[str]:
|
|
return await self.db_pool.simple_select_onecol(
|
|
"room_aliases",
|
|
{"room_id": room_id},
|
|
"room_alias",
|
|
desc="get_aliases_for_room",
|
|
)
|
|
|
|
async def create_room_alias_association(
|
|
self,
|
|
room_alias: RoomAlias,
|
|
room_id: str,
|
|
servers: Iterable[str],
|
|
creator: Optional[str] = None,
|
|
) -> None:
|
|
"""Creates an association between a room alias and room_id/servers
|
|
|
|
Args:
|
|
room_alias: The alias to create.
|
|
room_id: The target of the alias.
|
|
servers: A list of servers through which it may be possible to join the room
|
|
creator: Optional user_id of creator.
|
|
"""
|
|
|
|
def alias_txn(txn: LoggingTransaction) -> None:
|
|
self.db_pool.simple_insert_txn(
|
|
txn,
|
|
"room_aliases",
|
|
{
|
|
"room_alias": room_alias.to_string(),
|
|
"room_id": room_id,
|
|
"creator": creator,
|
|
},
|
|
)
|
|
|
|
self.db_pool.simple_insert_many_txn(
|
|
txn,
|
|
table="room_alias_servers",
|
|
keys=("room_alias", "server"),
|
|
values=[(room_alias.to_string(), server) for server in servers],
|
|
)
|
|
|
|
self._invalidate_cache_and_stream(
|
|
txn, self.get_aliases_for_room, (room_id,)
|
|
)
|
|
|
|
try:
|
|
await self.db_pool.runInteraction(
|
|
"create_room_alias_association", alias_txn
|
|
)
|
|
except self.database_engine.module.IntegrityError:
|
|
raise SynapseError(
|
|
409, "Room alias %s already exists" % room_alias.to_string()
|
|
)
|
|
|
|
async def delete_room_alias(self, room_alias: RoomAlias) -> Optional[str]:
|
|
room_id = await self.db_pool.runInteraction(
|
|
"delete_room_alias", self._delete_room_alias_txn, room_alias
|
|
)
|
|
|
|
return room_id
|
|
|
|
def _delete_room_alias_txn(
|
|
self, txn: LoggingTransaction, room_alias: RoomAlias
|
|
) -> Optional[str]:
|
|
txn.execute(
|
|
"SELECT room_id FROM room_aliases WHERE room_alias = ?",
|
|
(room_alias.to_string(),),
|
|
)
|
|
|
|
res = txn.fetchone()
|
|
if res:
|
|
room_id = res[0]
|
|
else:
|
|
return None
|
|
|
|
txn.execute(
|
|
"DELETE FROM room_aliases WHERE room_alias = ?", (room_alias.to_string(),)
|
|
)
|
|
|
|
txn.execute(
|
|
"DELETE FROM room_alias_servers WHERE room_alias = ?",
|
|
(room_alias.to_string(),),
|
|
)
|
|
|
|
self._invalidate_cache_and_stream(txn, self.get_aliases_for_room, (room_id,))
|
|
|
|
return room_id
|
|
|
|
async def update_aliases_for_room(
|
|
self,
|
|
old_room_id: str,
|
|
new_room_id: str,
|
|
creator: Optional[str] = None,
|
|
) -> None:
|
|
"""Repoint all of the aliases for a given room, to a different room.
|
|
|
|
Args:
|
|
old_room_id:
|
|
new_room_id:
|
|
creator: The user to record as the creator of the new mapping.
|
|
If None, the creator will be left unchanged.
|
|
"""
|
|
|
|
def _update_aliases_for_room_txn(txn: LoggingTransaction) -> None:
|
|
update_creator_sql = ""
|
|
sql_params: Tuple[str, ...] = (new_room_id, old_room_id)
|
|
if creator:
|
|
update_creator_sql = ", creator = ?"
|
|
sql_params = (new_room_id, creator, old_room_id)
|
|
|
|
sql = "UPDATE room_aliases SET room_id = ? %s WHERE room_id = ?" % (
|
|
update_creator_sql,
|
|
)
|
|
txn.execute(sql, sql_params)
|
|
self._invalidate_cache_and_stream(
|
|
txn, self.get_aliases_for_room, (old_room_id,)
|
|
)
|
|
self._invalidate_cache_and_stream(
|
|
txn, self.get_aliases_for_room, (new_room_id,)
|
|
)
|
|
|
|
await self.db_pool.runInteraction(
|
|
"_update_aliases_for_room_txn", _update_aliases_for_room_txn
|
|
)
|
|
|
|
|
|
class DirectoryStore(DirectoryWorkerStore):
|
|
pass
|