synapse-product/synapse/storage/room.py

242 lines
7.7 KiB
Python
Raw Normal View History

2014-08-12 10:10:52 -04:00
# -*- coding: utf-8 -*-
2016-01-06 23:26:29 -05:00
# Copyright 2014-2016 OpenMarket Ltd
2014-08-12 10:10:52 -04: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 10:10:52 -04:00
from twisted.internet import defer
from synapse.api.errors import StoreError
from ._base import SQLBaseStore
2016-02-03 05:30:56 -05:00
from synapse.util.caches.descriptors import cachedInlineCallbacks
2015-10-16 11:58:00 -04:00
from .engines import PostgresEngine, Sqlite3Engine
2014-08-12 10:10:52 -04:00
import collections
import logging
2016-05-04 06:28:10 -04:00
import ujson as json
2014-08-12 10:10:52 -04:00
logger = logging.getLogger(__name__)
2015-03-20 11:05:44 -04:00
OpsLevel = collections.namedtuple(
"OpsLevel",
("ban_level", "kick_level", "redact_level",)
2014-11-20 12:26:36 -05:00
)
2014-09-01 11:15:34 -04:00
2014-08-12 10:10:52 -04: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 11:05:44 -04:00
yield self._simple_insert(
2016-01-13 06:07:32 -05:00
"rooms",
2015-03-20 11:05:44 -04:00
{
"room_id": room_id,
"creator": room_creator_user_id,
"is_public": is_public,
},
desc="store_room",
2015-03-20 11:05:44 -04:00
)
2014-08-12 10:10:52 -04: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 11:05:44 -04:00
return self._simple_select_one(
2016-01-13 06:07:32 -05:00
table="rooms",
2015-03-20 11:05:44 -04:00
keyvalues={"room_id": room_id},
2016-01-13 06:07:32 -05:00
retcols=("room_id", "is_public", "creator"),
desc="get_room",
2015-03-25 13:15:20 -04:00
allow_none=True,
2014-08-12 10:10:52 -04:00
)
2016-03-21 10:03:20 -04:00
def set_room_is_public(self, room_id, is_public):
return self._simple_update_one(
table="rooms",
keyvalues={"room_id": room_id},
updatevalues={"is_public": is_public},
desc="set_room_is_public",
)
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",
)
2016-02-03 08:23:32 -05:00
def get_room_count(self):
"""Retrieve a list of all rooms
2014-08-12 10:10:52 -04:00
"""
def f(txn):
2016-02-03 08:23:32 -05:00
sql = "SELECT count(*) FROM rooms"
txn.execute(sql)
row = txn.fetchone()
return row[0] or 0
2014-08-12 10:10:52 -04:00
2016-02-03 08:23:32 -05:00
return self.runInteraction(
"get_rooms", f
)
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 10:10:52 -04:00
self._store_event_search_txn(
txn, event, "content.topic", event.content["topic"]
)
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 10:10:52 -04:00
self._store_event_search_txn(
txn, event, "content.name", event.content["name"]
)
def _store_room_message_txn(self, txn, event):
if hasattr(event, "content") and "body" in event.content:
self._store_event_search_txn(
txn, event, "content.body", event.content["body"]
)
def _store_history_visibility_txn(self, txn, event):
self._store_content_index_txn(txn, event, "history_visibility")
def _store_guest_access_txn(self, txn, event):
self._store_content_index_txn(txn, event, "guest_access")
def _store_content_index_txn(self, txn, event, key):
if hasattr(event, "content") and key in event.content:
sql = (
"INSERT INTO %(key)s"
" (event_id, room_id, %(key)s)"
" VALUES (?, ?, ?)" % {"key": key}
)
txn.execute(sql, (
event.event_id,
event.room_id,
event.content[key]
))
def _store_event_search_txn(self, txn, event, key, value):
2015-10-14 04:52:40 -04:00
if isinstance(self.database_engine, PostgresEngine):
sql = (
2016-04-21 11:41:39 -04:00
"INSERT INTO event_search"
" (event_id, room_id, key, vector, stream_ordering, origin_server_ts)"
" VALUES (?,?,?,to_tsvector('english', ?),?,?)"
)
txn.execute(
sql,
(
event.event_id, event.room_id, key, value,
event.internal_metadata.stream_ordering,
event.origin_server_ts,
)
2015-10-14 04:52:40 -04:00
)
2015-10-16 11:58:00 -04:00
elif isinstance(self.database_engine, Sqlite3Engine):
2015-10-14 04:52:40 -04:00
sql = (
"INSERT INTO event_search (event_id, room_id, key, value)"
" VALUES (?,?,?,?)"
)
2016-04-21 11:41:39 -04:00
txn.execute(sql, (event.event_id, event.room_id, key, value,))
2015-10-16 11:58:00 -04:00
else:
# This should be unreachable.
raise Exception("Unrecognized database engine")
@cachedInlineCallbacks()
2015-03-20 09:52:56 -04:00
def get_room_name_and_aliases(self, room_id):
def f(txn):
sql = (
2015-04-30 13:44:47 -04:00
"SELECT event_id FROM current_state_events "
"WHERE room_id = ? "
)
2015-03-20 09:52:56 -04:00
sql += " AND ((type = 'm.room.name' AND state_key = '')"
sql += " OR type = 'm.room.aliases')"
2015-03-20 09:52:56 -04:00
txn.execute(sql, (room_id,))
results = self.cursor_to_dict(txn)
2015-03-20 09:52:56 -04:00
return self._parse_events_txn(txn, results)
2015-03-20 09:52:56 -04:00
events = yield self.runInteraction("get_room_name_and_aliases", f)
2015-03-20 09:52:56 -04: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))
2016-05-04 06:28:10 -04:00
2016-05-04 10:19:12 -04:00
def add_event_report(self, room_id, event_id, user_id, reason, content,
received_ts):
next_id = self._event_reports_id_gen.get_next()
2016-05-04 06:28:10 -04:00
return self._simple_insert(
table="event_reports",
values={
2016-05-04 10:19:12 -04:00
"id": next_id,
"received_ts": received_ts,
2016-05-04 06:28:10 -04:00
"room_id": room_id,
"event_id": event_id,
"user_id": user_id,
"reason": reason,
"content": json.dumps(content),
},
desc="add_event_report"
)