MatrixSynapse/synapse/storage/databases/main/directory.py

197 lines
6.3 KiB
Python
Raw Normal View History

2016-01-07 05:26:29 +01:00
# Copyright 2014-2016 OpenMarket Ltd
2014-08-12 16:10:52 +02:00
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
2018-07-09 08:09:20 +02:00
from collections import namedtuple
from typing import Iterable, List, Optional
2014-08-12 16:10:52 +02:00
2018-07-09 08:09:20 +02:00
from synapse.api.errors import SynapseError
from synapse.storage._base import SQLBaseStore
from synapse.types import RoomAlias
2018-07-09 08:09:20 +02:00
from synapse.util.caches.descriptors import cached
2014-08-12 16:10:52 +02:00
RoomAliasMapping = namedtuple("RoomAliasMapping", ("room_id", "room_alias", "servers"))
2014-08-12 16:10:52 +02:00
2018-03-05 16:11:30 +01:00
class DirectoryWorkerStore(SQLBaseStore):
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
2014-08-12 16:10:52 +02:00
Args:
room_alias: The alias to translate to an ID.
2014-08-12 16:10:52 +02:00
Returns:
The room alias mapping or None if no association can be found.
2014-08-12 16:10:52 +02:00
"""
room_id = await self.db_pool.simple_select_one_onecol(
2014-08-12 16:10:52 +02:00
"room_aliases",
{"room_alias": room_alias.to_string()},
"room_id",
allow_none=True,
desc="get_association_from_room_alias",
2014-08-12 16:10:52 +02:00
)
if not room_id:
return None
2014-08-12 16:10:52 +02:00
servers = await self.db_pool.simple_select_onecol(
2014-08-12 16:10:52 +02:00
"room_alias_servers",
{"room_alias": room_alias.to_string()},
"server",
desc="get_association_from_room_alias",
2014-08-12 16:10:52 +02:00
)
if not servers:
return None
2014-08-12 16:10:52 +02:00
return RoomAliasMapping(room_id, room_alias.to_string(), servers)
2014-08-12 16:10:52 +02:00
async def get_room_alias_creator(self, room_alias: str) -> str:
return await self.db_pool.simple_select_one_onecol(
2018-03-05 16:11:30 +01:00
table="room_aliases",
keyvalues={"room_alias": room_alias},
2018-03-05 16:11:30 +01:00
retcol="creator",
desc="get_room_alias_creator",
)
@cached(max_entries=5000)
async def get_aliases_for_room(self, room_id: str) -> List[str]:
return await self.db_pool.simple_select_onecol(
2018-03-05 16:11:30 +01:00
"room_aliases",
{"room_id": room_id},
"room_alias",
desc="get_aliases_for_room",
)
class DirectoryStore(DirectoryWorkerStore):
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
2014-08-12 16:10:52 +02:00
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.
2014-08-12 16:10:52 +02:00
"""
def alias_txn(txn):
self.db_pool.simple_insert_txn(
txn,
"room_aliases",
{
"room_alias": room_alias.to_string(),
"room_id": room_id,
2016-03-01 15:46:31 +01:00
"creator": creator,
},
)
2014-08-12 16:10:52 +02:00
self.db_pool.simple_insert_many_txn(
txn,
table="room_alias_servers",
values=[
{"room_alias": room_alias.to_string(), "server": 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()
2014-08-12 16:10:52 +02:00
)
async def delete_room_alias(self, room_alias: RoomAlias) -> str:
room_id = await self.db_pool.runInteraction(
"delete_room_alias", self._delete_room_alias_txn, room_alias
)
return room_id
2015-03-20 20:21:13 +01:00
def _delete_room_alias_txn(self, txn, room_alias: RoomAlias) -> 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,))
2018-03-05 16:12:22 +01:00
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.
"""
2017-06-19 13:36:28 +02:00
def _update_aliases_for_room_txn(txn):
update_creator_sql = ""
sql_params = (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)
2017-06-19 13:36:28 +02:00
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(
2017-06-19 13:36:28 +02:00
"_update_aliases_for_room_txn", _update_aliases_for_room_txn
)