forked-synapse/synapse/handlers/search.py

320 lines
11 KiB
Python
Raw Normal View History

2015-10-09 10:48:31 -04: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 BaseHandler
2015-10-16 10:32:51 -04:00
from synapse.api.constants import Membership
2015-10-20 12:09:53 -04:00
from synapse.api.filtering import Filter
2015-10-09 10:48:31 -04:00
from synapse.api.errors import SynapseError
from synapse.events.utils import serialize_event
from unpaddedbase64 import decode_base64, encode_base64
2015-10-09 10:48:31 -04:00
import logging
logger = logging.getLogger(__name__)
class SearchHandler(BaseHandler):
def __init__(self, hs):
super(SearchHandler, self).__init__(hs)
@defer.inlineCallbacks
def search(self, user, content, batch=None):
2015-10-16 06:52:16 -04:00
"""Performs a full text search for a user.
Args:
user (UserID)
content (dict): Search parameters
batch (str): The next_batch parameter. Used for pagination.
2015-10-16 06:52:16 -04:00
Returns:
dict to be returned to the client with results of search
"""
batch_group = None
batch_group_key = None
batch_token = None
if batch:
try:
b = decode_base64(batch)
batch_group, batch_group_key, batch_token = b.split("\n")
assert batch_group is not None
assert batch_group_key is not None
assert batch_token is not None
except:
raise SynapseError(400, "Invalid batch")
try:
2015-11-04 12:57:44 -05:00
room_cat = content["search_categories"]["room_events"]
2015-11-05 11:29:16 -05:00
# The actual thing to query in FTS
2015-11-04 12:57:44 -05:00
search_term = room_cat["search_term"]
2015-11-05 11:29:16 -05:00
# Which "keys" to search over in FTS query
2015-11-04 12:57:44 -05:00
keys = room_cat.get("keys", [
2015-10-14 05:35:50 -04:00
"content.body", "content.name", "content.topic",
])
2015-11-05 11:29:16 -05:00
# Filter to apply to results
2015-11-04 12:57:44 -05:00
filter_dict = room_cat.get("filter", {})
2015-11-05 11:29:16 -05:00
# What to order results by (impacts whether pagination can be doen)
2015-11-04 12:57:44 -05:00
order_by = room_cat.get("order_by", "rank")
2015-11-05 11:29:16 -05:00
# Include context around each event?
2015-11-04 12:57:44 -05:00
event_context = room_cat.get(
"event_context", None
)
2015-11-05 11:29:16 -05:00
# Group results together? May allow clients to paginate within a
# group
2015-11-04 12:57:44 -05:00
group_by = room_cat.get("groupings", {}).get("group_by", {})
group_keys = [g["key"] for g in group_by]
if event_context is not None:
before_limit = int(event_context.get(
"before_limit", 5
))
after_limit = int(event_context.get(
"after_limit", 5
))
except KeyError:
raise SynapseError(400, "Invalid search query")
2015-10-09 10:48:31 -04:00
2015-11-04 12:57:44 -05:00
if order_by not in ("rank", "recent"):
raise SynapseError(400, "Invalid order by: %r" % (order_by,))
if set(group_keys) - {"room_id", "sender"}:
raise SynapseError(
400,
"Invalid group by keys: %r" % (set(group_keys) - {"room_id", "sender"},)
)
2015-10-22 11:19:53 -04:00
search_filter = Filter(filter_dict)
2015-10-20 12:09:53 -04:00
2015-10-14 04:46:31 -04:00
# TODO: Search through left rooms too
2015-10-13 05:36:36 -04:00
rooms = yield self.store.get_rooms_for_user_where_membership_is(
user.to_string(),
membership_list=[Membership.JOIN],
# membership_list=[Membership.JOIN, Membership.LEAVE, Membership.Ban],
)
room_ids = set(r.room_id for r in rooms)
2015-10-09 10:48:31 -04:00
2015-10-22 11:19:53 -04:00
room_ids = search_filter.filter_rooms(room_ids)
2015-10-14 04:46:31 -04:00
if batch_group == "room_id":
2015-11-05 12:26:19 -05:00
room_ids.intersection_update({batch_group_key})
2015-11-05 11:29:16 -05:00
rank_map = {} # event_id -> rank of event
2015-11-04 12:57:44 -05:00
allowed_events = []
2015-11-05 11:29:16 -05:00
room_groups = {} # Holds result of grouping by room, if applicable
sender_group = {} # Holds result of grouping by sender, if applicable
# Holds the next_batch for the entire result set if one of those exists
global_next_batch = None
2015-11-04 12:57:44 -05:00
if order_by == "rank":
results = yield self.store.search_msgs(
2015-11-04 12:57:44 -05:00
room_ids, search_term, keys
)
2015-10-20 12:09:53 -04:00
results_map = {r["event"].event_id: r for r in results}
rank_map.update({r["event"].event_id: r["rank"] for r in results})
filtered_events = search_filter.filter([r["event"] for r in results])
2015-11-04 12:57:44 -05:00
events = yield self._filter_events_for_client(
user.to_string(), filtered_events
)
events.sort(key=lambda e: -rank_map[e.event_id])
allowed_events = events[:search_filter.limit()]
for e in allowed_events:
rm = room_groups.setdefault(e.room_id, {
"results": [],
"order": rank_map[e.event_id],
})
rm["results"].append(e.event_id)
s = sender_group.setdefault(e.sender, {
"results": [],
"order": rank_map[e.event_id],
})
s["results"].append(e.event_id)
elif order_by == "recent":
2015-11-05 11:29:16 -05:00
# In this case we specifically loop through each room as the given
# limit applies to each room, rather than a global list.
# This is not necessarilly a good idea.
2015-11-04 12:57:44 -05:00
for room_id in room_ids:
room_events = []
if batch_group == "room_id" and batch_group_key == room_id:
pagination_token = batch_token
else:
pagination_token = None
2015-11-04 12:57:44 -05:00
i = 0
2015-11-05 11:29:16 -05:00
# We keep looping and we keep filtering until we reach the limit
# or we run out of things.
# But only go around 5 times since otherwise synapse will be sad.
2015-11-04 12:57:44 -05:00
while len(room_events) < search_filter.limit() and i < 5:
2015-11-05 12:25:33 -05:00
i += 1
results = yield self.store.search_room(
2015-11-04 12:57:44 -05:00
room_id, search_term, keys, search_filter.limit() * 2,
pagination_token=pagination_token,
)
results_map = {r["event"].event_id: r for r in results}
rank_map.update({r["event"].event_id: r["rank"] for r in results})
filtered_events = search_filter.filter([
r["event"] for r in results
])
2015-11-04 12:57:44 -05:00
events = yield self._filter_events_for_client(
user.to_string(), filtered_events
)
room_events.extend(events)
room_events = room_events[:search_filter.limit()]
if len(results) < search_filter.limit() * 2:
pagination_token = None
2015-11-04 12:57:44 -05:00
break
else:
pagination_token = results[-1]["pagination_token"]
if room_events:
res = results_map[room_events[-1].event_id]
pagination_token = res["pagination_token"]
2015-11-04 12:57:44 -05:00
group = room_groups.setdefault(room_id, {})
if pagination_token:
next_batch = encode_base64("%s\n%s\n%s" % (
"room_id", room_id, pagination_token
))
group["next_batch"] = next_batch
if batch_token:
global_next_batch = next_batch
2015-11-04 12:57:44 -05:00
group["results"] = [e.event_id for e in room_events]
group["order"] = max(
e.origin_server_ts/1000 for e in room_events
if hasattr(e, "origin_server_ts")
)
allowed_events.extend(room_events)
2015-11-05 11:29:16 -05:00
# Normalize the group orders
2015-11-04 12:57:44 -05:00
if room_groups:
if len(room_groups) > 1:
mx = max(g["order"] for g in room_groups.values())
mn = min(g["order"] for g in room_groups.values())
2015-11-04 12:57:44 -05:00
for g in room_groups.values():
g["order"] = (g["order"] - mn) * 1.0 / (mx - mn)
else:
room_groups.values()[0]["order"] = 1
2015-11-04 12:57:44 -05:00
else:
# We should never get here due to the guard earlier.
raise NotImplementedError()
2015-11-05 11:29:16 -05:00
# If client has asked for "context" for each event (i.e. some surrounding
# events and state), fetch that
if event_context is not None:
now_token = yield self.hs.get_event_sources().get_current_token()
contexts = {}
for event in allowed_events:
res = yield self.store.get_events_around(
event.room_id, event.event_id, before_limit, after_limit
)
res["events_before"] = yield self._filter_events_for_client(
user.to_string(), res["events_before"]
)
res["events_after"] = yield self._filter_events_for_client(
user.to_string(), res["events_after"]
)
res["start"] = now_token.copy_and_replace(
"room_key", res["start"]
).to_string()
res["end"] = now_token.copy_and_replace(
"room_key", res["end"]
).to_string()
contexts[event.event_id] = res
else:
contexts = {}
2015-10-14 04:49:00 -04:00
# TODO: Add a limit
time_now = self.clock.time_msec()
for context in contexts.values():
context["events_before"] = [
serialize_event(e, time_now)
for e in context["events_before"]
]
context["events_after"] = [
serialize_event(e, time_now)
for e in context["events_after"]
]
results = {
e.event_id: {
"rank": rank_map[e.event_id],
"result": serialize_event(e, time_now),
"context": contexts.get(e.event_id, {}),
2015-10-09 10:48:31 -04:00
}
for e in allowed_events
}
2015-10-09 10:48:31 -04:00
2015-10-14 04:46:31 -04:00
logger.info("Found %d results", len(results))
2015-10-09 10:48:31 -04:00
2015-11-04 12:57:44 -05:00
rooms_cat_res = {
"results": results,
"count": len(results)
}
if room_groups and "room_id" in group_keys:
rooms_cat_res.setdefault("groups", {})["room_id"] = room_groups
if sender_group and "sender" in group_keys:
rooms_cat_res.setdefault("groups", {})["sender"] = sender_group
if global_next_batch:
rooms_cat_res["next_batch"] = global_next_batch
defer.returnValue({
"search_categories": {
2015-11-04 12:57:44 -05:00
"room_events": rooms_cat_res
}
})