2015-10-09 14:48:31 +00: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 13:37:14 +00:00
|
|
|
from synapse.storage.engines import PostgresEngine, Sqlite3Engine
|
2015-10-09 14:48:31 +00:00
|
|
|
|
|
|
|
|
|
|
|
class SearchStore(SQLBaseStore):
|
|
|
|
@defer.inlineCallbacks
|
2015-10-13 14:22:14 +00:00
|
|
|
def search_msgs(self, room_ids, search_term, keys):
|
2015-10-16 15:46:48 +00:00
|
|
|
"""Performs a full text search over events with given keys.
|
2015-10-16 10:28:12 +00: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 15:46:48 +00:00
|
|
|
"content.body", "content.name", "content.topic"
|
2015-10-16 10:28:12 +00:00
|
|
|
|
|
|
|
Returns:
|
|
|
|
2-tuple of (dict event_id -> rank, dict event_id -> event)
|
|
|
|
"""
|
2015-10-09 14:48:31 +00:00
|
|
|
clauses = []
|
|
|
|
args = []
|
|
|
|
|
2015-10-22 12:25:22 +00:00
|
|
|
# Make sure we don't explode because the person is in too many rooms.
|
|
|
|
if len(room_ids) > 500:
|
|
|
|
clauses.append(
|
|
|
|
"room_id IN (%s)" % (",".join(["?"] * len(room_ids)),)
|
|
|
|
)
|
|
|
|
args.extend(room_ids)
|
2015-10-12 09:49:53 +00:00
|
|
|
|
2015-10-13 14:22:14 +00:00
|
|
|
local_clauses = []
|
|
|
|
for key in keys:
|
|
|
|
local_clauses.append("key = ?")
|
|
|
|
args.append(key)
|
|
|
|
|
|
|
|
clauses.append(
|
|
|
|
"(%s)" % (" OR ".join(local_clauses),)
|
|
|
|
)
|
2015-10-09 14:48:31 +00:00
|
|
|
|
2015-10-13 12:47:50 +00:00
|
|
|
if isinstance(self.database_engine, PostgresEngine):
|
|
|
|
sql = (
|
|
|
|
"SELECT ts_rank_cd(vector, query) AS rank, event_id"
|
|
|
|
" FROM plainto_tsquery('english', ?) as query, event_search"
|
|
|
|
" WHERE vector @@ query"
|
|
|
|
)
|
2015-10-16 13:37:14 +00:00
|
|
|
elif isinstance(self.database_engine, Sqlite3Engine):
|
2015-10-13 12:47:50 +00:00
|
|
|
sql = (
|
|
|
|
"SELECT 0 as rank, event_id FROM event_search"
|
|
|
|
" WHERE value MATCH ?"
|
|
|
|
)
|
2015-10-16 13:37:14 +00:00
|
|
|
else:
|
|
|
|
# This should be unreachable.
|
|
|
|
raise Exception("Unrecognized database engine")
|
2015-10-09 14:48:31 +00:00
|
|
|
|
|
|
|
for clause in clauses:
|
|
|
|
sql += " AND " + clause
|
|
|
|
|
2015-10-16 10:24:02 +00:00
|
|
|
# We add an arbitrary limit here to ensure we don't try to pull the
|
|
|
|
# entire table from the database.
|
2015-10-13 14:50:56 +00:00
|
|
|
sql += " ORDER BY rank DESC LIMIT 500"
|
2015-10-09 14:48:31 +00:00
|
|
|
|
|
|
|
results = yield self._execute(
|
2015-10-13 14:22:14 +00:00
|
|
|
"search_msgs", self.cursor_to_dict, sql, *([search_term] + args)
|
2015-10-09 14:48:31 +00:00
|
|
|
)
|
|
|
|
|
|
|
|
events = yield self._get_events([r["event_id"] for r in results])
|
|
|
|
|
|
|
|
event_map = {
|
|
|
|
ev.event_id: ev
|
|
|
|
for ev in events
|
|
|
|
}
|
|
|
|
|
2015-10-12 14:52:55 +00:00
|
|
|
defer.returnValue((
|
2015-10-09 14:48:31 +00:00
|
|
|
{
|
2015-10-12 14:52:55 +00:00
|
|
|
r["event_id"]: r["rank"]
|
|
|
|
for r in results
|
|
|
|
if r["event_id"] in event_map
|
|
|
|
},
|
|
|
|
event_map
|
|
|
|
))
|