MatrixSynapse/synapse/storage/search.py

191 lines
6.2 KiB
Python
Raw Normal View History

2015-10-09 16:48:31 +02:00
# -*- coding: utf-8 -*-
# Copyright 2015 OpenMarket Ltd
#
# 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.
from twisted.internet import defer
from _base import SQLBaseStore
2015-10-16 15:37:14 +02:00
from synapse.storage.engines import PostgresEngine, Sqlite3Engine
2015-10-09 16:48:31 +02:00
2015-11-04 18:57:44 +01:00
import logging
logger = logging.getLogger(__name__)
2015-10-09 16:48:31 +02:00
class SearchStore(SQLBaseStore):
@defer.inlineCallbacks
def search_msgs(self, room_ids, search_term, keys):
2015-10-16 17:46:48 +02:00
"""Performs a full text search over events with given keys.
2015-10-16 12:28:12 +02:00
Args:
room_ids (list): List of room ids to search in
search_term (str): Search term to search for
keys (list): List of keys to search in, currently supports
2015-10-16 17:46:48 +02:00
"content.body", "content.name", "content.topic"
2015-10-16 12:28:12 +02:00
Returns:
list of dicts
2015-10-16 12:28:12 +02:00
"""
2015-10-09 16:48:31 +02:00
clauses = []
args = []
2015-10-22 14:25:22 +02:00
# Make sure we don't explode because the person is in too many rooms.
2015-10-22 17:54:56 +02:00
# We filter the results below regardless.
2015-10-22 17:18:35 +02:00
if len(room_ids) < 500:
2015-10-22 14:25:22 +02:00
clauses.append(
"room_id IN (%s)" % (",".join(["?"] * len(room_ids)),)
)
args.extend(room_ids)
local_clauses = []
for key in keys:
local_clauses.append("key = ?")
args.append(key)
clauses.append(
"(%s)" % (" OR ".join(local_clauses),)
)
2015-10-09 16:48:31 +02:00
2015-10-13 14:47:50 +02:00
if isinstance(self.database_engine, PostgresEngine):
sql = (
2015-10-22 17:54:56 +02:00
"SELECT ts_rank_cd(vector, query) AS rank, room_id, event_id"
2015-10-13 14:47:50 +02:00
" FROM plainto_tsquery('english', ?) as query, event_search"
" WHERE vector @@ query"
)
2015-10-16 15:37:14 +02:00
elif isinstance(self.database_engine, Sqlite3Engine):
2015-10-13 14:47:50 +02:00
sql = (
2015-10-23 14:23:48 +02:00
"SELECT rank(matchinfo(event_search)) as rank, room_id, event_id"
" FROM event_search"
2015-10-13 14:47:50 +02:00
" WHERE value MATCH ?"
)
2015-10-16 15:37:14 +02:00
else:
# This should be unreachable.
raise Exception("Unrecognized database engine")
2015-10-09 16:48:31 +02:00
for clause in clauses:
sql += " AND " + clause
2015-10-16 12:24:02 +02:00
# We add an arbitrary limit here to ensure we don't try to pull the
# entire table from the database.
2015-10-13 16:50:56 +02:00
sql += " ORDER BY rank DESC LIMIT 500"
2015-10-09 16:48:31 +02:00
results = yield self._execute(
"search_msgs", self.cursor_to_dict, sql, *([search_term] + args)
2015-10-09 16:48:31 +02:00
)
2015-10-22 17:54:56 +02:00
results = filter(lambda row: row["room_id"] in room_ids, results)
2015-10-09 16:48:31 +02:00
events = yield self._get_events([r["event_id"] for r in results])
event_map = {
ev.event_id: ev
for ev in events
}
defer.returnValue([
2015-10-09 16:48:31 +02:00
{
"event": event_map[r["event_id"]],
"rank": r["rank"],
}
for r in results
if r["event_id"] in event_map
])
2015-11-04 18:57:44 +01:00
@defer.inlineCallbacks
def search_room(self, room_id, search_term, keys, limit, pagination_token=None):
"""Performs a full text search over events with given keys.
Args:
room_id (str): The room_id to search in
search_term (str): Search term to search for
keys (list): List of keys to search in, currently supports
"content.body", "content.name", "content.topic"
pagination_token (str): A pagination token previously returned
Returns:
list of dicts
2015-11-04 18:57:44 +01:00
"""
clauses = []
args = [search_term, room_id]
local_clauses = []
for key in keys:
local_clauses.append("key = ?")
args.append(key)
clauses.append(
"(%s)" % (" OR ".join(local_clauses),)
)
if pagination_token:
topo, stream = pagination_token.split(",")
clauses.append(
"(topological_ordering < ?"
" OR (topological_ordering = ? AND stream_ordering < ?))"
)
args.extend([topo, topo, stream])
if isinstance(self.database_engine, PostgresEngine):
sql = (
"SELECT ts_rank_cd(vector, query) as rank,"
" topological_ordering, stream_ordering, room_id, event_id"
" FROM plainto_tsquery('english', ?) as query, event_search"
" NATURAL JOIN events"
" WHERE vector @@ query AND room_id = ?"
)
elif isinstance(self.database_engine, Sqlite3Engine):
sql = (
"SELECT rank(matchinfo(event_search)) as rank, room_id, event_id"
" topological_ordering, stream_ordering"
" FROM event_search"
" NATURAL JOIN events"
" WHERE value MATCH ? AND room_id = ?"
)
else:
# This should be unreachable.
raise Exception("Unrecognized database engine")
for clause in clauses:
sql += " AND " + clause
# We add an arbitrary limit here to ensure we don't try to pull the
# entire table from the database.
sql += " ORDER BY topological_ordering DESC, stream_ordering DESC LIMIT ?"
args.append(limit)
results = yield self._execute(
"search_rooms", self.cursor_to_dict, sql, *args
)
events = yield self._get_events([r["event_id"] for r in results])
event_map = {
ev.event_id: ev
for ev in events
}
defer.returnValue([
2015-11-04 18:57:44 +01:00
{
"event": event_map[r["event_id"]],
"rank": r["rank"],
"pagination_token": "%s,%s" % (
r["topological_ordering"], r["stream_ordering"]
),
}
for r in results
if r["event_id"] in event_map
])