MatrixSynapse/synapse/storage/room.py

230 lines
6.8 KiB
Python
Raw Normal View History

2014-08-12 16:10:52 +02:00
# -*- coding: utf-8 -*-
2015-01-06 14:21:39 +01:00
# Copyright 2014, 2015 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.
2014-08-12 16:10:52 +02:00
from twisted.internet import defer
from synapse.api.errors import StoreError
from ._base import SQLBaseStore, cached
2014-08-12 16:10:52 +02:00
import collections
import logging
logger = logging.getLogger(__name__)
2015-03-20 16:05:44 +01:00
OpsLevel = collections.namedtuple(
"OpsLevel",
("ban_level", "kick_level", "redact_level",)
2014-11-20 18:26:36 +01:00
)
2014-09-01 17:15:34 +02:00
2014-08-12 16:10:52 +02:00
class RoomStore(SQLBaseStore):
@defer.inlineCallbacks
def store_room(self, room_id, room_creator_user_id, is_public):
"""Stores a room.
Args:
room_id (str): The desired room ID, can be None.
room_creator_user_id (str): The user ID of the room creator.
is_public (bool): True to indicate that this room should appear in
public room lists.
Raises:
StoreError if the room could not be stored.
"""
try:
2015-03-20 16:05:44 +01:00
yield self._simple_insert(
RoomsTable.table_name,
{
"room_id": room_id,
"creator": room_creator_user_id,
"is_public": is_public,
},
desc="store_room",
2015-03-20 16:05:44 +01:00
)
2014-08-12 16:10:52 +02:00
except Exception as e:
logger.error("store_room with room_id=%s failed: %s", room_id, e)
raise StoreError(500, "Problem creating room.")
def get_room(self, room_id):
"""Retrieve a room.
Args:
room_id (str): The ID of the room to retrieve.
Returns:
A namedtuple containing the room information, or an empty list.
"""
2015-03-20 16:05:44 +01:00
return self._simple_select_one(
table=RoomsTable.table_name,
keyvalues={"room_id": room_id},
retcols=RoomsTable.fields,
desc="get_room",
2015-03-25 18:15:20 +01:00
allow_none=True,
2014-08-12 16:10:52 +02:00
)
def get_public_room_ids(self):
return self._simple_select_onecol(
table="rooms",
keyvalues={
"is_public": True,
},
retcol="room_id",
desc="get_public_room_ids",
)
2014-08-12 16:10:52 +02:00
@defer.inlineCallbacks
def get_rooms(self, is_public):
2014-08-12 16:10:52 +02:00
"""Retrieve a list of all public rooms.
Args:
is_public (bool): True if the rooms returned should be public.
Returns:
A list of room dicts containing at least a "room_id" key, a
"topic" key if one is set, and a "name" key if one is set
2014-08-12 16:10:52 +02:00
"""
def f(txn):
topic_subquery = (
"SELECT topics.event_id as event_id, "
"topics.room_id as room_id, topic "
"FROM topics "
"INNER JOIN current_state_events as c "
"ON c.event_id = topics.event_id "
)
name_subquery = (
"SELECT room_names.event_id as event_id, "
"room_names.room_id as room_id, name "
"FROM room_names "
"INNER JOIN current_state_events as c "
"ON c.event_id = room_names.event_id "
)
2015-03-24 17:31:52 +01:00
# We use non printing ascii character US (\x1F) as a separator
sql = (
"SELECT r.room_id, max(n.name), max(t.topic)"
" FROM rooms AS r"
" LEFT JOIN (%(topic)s) AS t ON t.room_id = r.room_id"
" LEFT JOIN (%(name)s) AS n ON n.room_id = r.room_id"
" WHERE r.is_public = ?"
" GROUP BY r.room_id"
) % {
"topic": topic_subquery,
"name": name_subquery,
}
2014-08-12 16:10:52 +02:00
txn.execute(sql, (is_public,))
2014-08-12 16:10:52 +02:00
rows = txn.fetchall()
for i, row in enumerate(rows):
room_id = row[0]
aliases = self._simple_select_onecol_txn(
txn,
table="room_aliases",
keyvalues={
"room_id": room_id
},
retcol="room_alias",
)
rows[i] = list(row) + [aliases]
return rows
rows = yield self.runInteraction(
"get_rooms", f
)
ret = [
{
"room_id": r[0],
"name": r[1],
"topic": r[2],
"aliases": r[3],
}
for r in rows
if r[3] # We only return rooms that have at least one alias.
]
defer.returnValue(ret)
def _store_room_topic_txn(self, txn, event):
if hasattr(event, "content") and "topic" in event.content:
self._simple_insert_txn(
txn,
"topics",
{
"event_id": event.event_id,
"room_id": event.room_id,
"topic": event.content["topic"],
},
)
2014-08-12 16:10:52 +02:00
def _store_room_name_txn(self, txn, event):
if hasattr(event, "content") and "name" in event.content:
self._simple_insert_txn(
txn,
"room_names",
{
"event_id": event.event_id,
"room_id": event.room_id,
"name": event.content["name"],
}
)
2014-08-12 16:10:52 +02:00
@cached()
2015-03-20 14:52:56 +01:00
@defer.inlineCallbacks
def get_room_name_and_aliases(self, room_id):
def f(txn):
sql = (
2015-04-30 19:44:47 +02:00
"SELECT event_id FROM current_state_events "
"WHERE room_id = ? "
)
2015-03-20 14:52:56 +01:00
sql += " AND ((type = 'm.room.name' AND state_key = '')"
sql += " OR type = 'm.room.aliases')"
2015-03-20 14:52:56 +01:00
txn.execute(sql, (room_id,))
results = self.cursor_to_dict(txn)
2015-03-20 14:52:56 +01:00
return self._parse_events_txn(txn, results)
2015-03-20 14:52:56 +01:00
events = yield self.runInteraction("get_room_name_and_aliases", f)
2015-03-20 14:52:56 +01:00
name = None
aliases = []
for e in events:
if e.type == 'm.room.name':
if 'name' in e.content:
name = e.content['name']
elif e.type == 'm.room.aliases':
if 'aliases' in e.content:
aliases.extend(e.content['aliases'])
defer.returnValue((name, aliases))
2014-08-12 16:10:52 +02:00
2015-03-20 16:05:44 +01:00
class RoomsTable(object):
2014-08-12 16:10:52 +02:00
table_name = "rooms"
fields = [
"room_id",
"is_public",
"creator"
]