summary refs log tree commit diff
path: root/synapse/handlers/search.py
blob: 71182a8fe0048b0112988813133dcc9bf8ede682 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
# -*- 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

from synapse.api.constants import (
    EventTypes, KnownRoomEventKeys, Membership, SearchConstraintTypes
)
from synapse.api.errors import SynapseError
from synapse.events.utils import serialize_event

import logging


logger = logging.getLogger(__name__)


KEYS_TO_ALLOWED_CONSTRAINT_TYPES = {
    KnownRoomEventKeys.CONTENT_BODY: [SearchConstraintTypes.FTS],
    KnownRoomEventKeys.CONTENT_MSGTYPE: [SearchConstraintTypes.EXACT],
    KnownRoomEventKeys.CONTENT_NAME: [
        SearchConstraintTypes.FTS,
        SearchConstraintTypes.EXACT,
        SearchConstraintTypes.SUBSTRING,
    ],
    KnownRoomEventKeys.CONTENT_TOPIC: [SearchConstraintTypes.FTS],
    KnownRoomEventKeys.SENDER: [SearchConstraintTypes.EXACT],
    KnownRoomEventKeys.ORIGIN_SERVER_TS: [SearchConstraintTypes.RANGE],
    KnownRoomEventKeys.ROOM_ID: [SearchConstraintTypes.EXACT],
}


class RoomConstraint(object):
    def __init__(self, search_type, keys, value):
        self.search_type = search_type
        self.keys = keys
        self.value = value

    @classmethod
    def from_dict(cls, d):
        search_type = d["type"]
        keys = d["keys"]

        for key in keys:
            if key not in KEYS_TO_ALLOWED_CONSTRAINT_TYPES:
                raise SynapseError(400, "Unrecognized key %r", key)

            if search_type not in KEYS_TO_ALLOWED_CONSTRAINT_TYPES[key]:
                raise SynapseError(
                    400,
                    "Disallowed constraint type %r for key %r", search_type, key
                )

        return cls(search_type, keys, d["value"])


class SearchHandler(BaseHandler):

    def __init__(self, hs):
        super(SearchHandler, self).__init__(hs)

    @defer.inlineCallbacks
    def _filter_events_for_client(self, user_id, room_id, events):
        event_id_to_state = yield self.store.get_state_for_events(
            frozenset(e.event_id for e in events),
            types=(
                (EventTypes.RoomHistoryVisibility, ""),
                (EventTypes.Member, user_id),
            )
        )

        def allowed(event, state):
            if event.type == EventTypes.RoomHistoryVisibility:
                return True

            membership_ev = state.get((EventTypes.Member, user_id), None)
            if membership_ev:
                membership = membership_ev.membership
            else:
                membership = Membership.LEAVE

            if membership == Membership.JOIN:
                return True

            history = state.get((EventTypes.RoomHistoryVisibility, ''), None)
            if history:
                visibility = history.content.get("history_visibility", "shared")
            else:
                visibility = "shared"

            if visibility == "public":
                return True
            elif visibility == "shared":
                return True
            elif visibility == "joined":
                return membership == Membership.JOIN
            elif visibility == "invited":
                return membership == Membership.INVITE

            return True

        defer.returnValue([
            event
            for event in events
            if allowed(event, event_id_to_state[event.event_id])
        ])

    @defer.inlineCallbacks
    def search(self, user, content):
        constraint_dicts = content["search_categories"]["room_events"]["constraints"]
        constraints = [RoomConstraint.from_dict(c)for c in constraint_dicts]

        fts = False
        for c in constraints:
            if c.search_type == SearchConstraintTypes.FTS:
                if fts:
                    raise SynapseError(400, "Only one constraint can be FTS")
                fts = True

        rooms = yield self.store.get_rooms_for_user(
            user.to_string(),
        )

        # For some reason the list of events contains duplicates
        # TODO(paul): work out why because I really don't think it should
        room_ids = set(r.room_id for r in rooms)

        res = yield self.store.search_msgs(room_ids, constraints)

        time_now = self.clock.time_msec()

        results = {
            r["result"].event_id: {
                "rank": r["rank"],
                "result": serialize_event(r["result"], time_now)
            }
            for r in res
        }

        logger.info("returning: %r", results)

        defer.returnValue({
            "search_categories": {
                "room_events": {
                    "results": results,
                    "count": len(results)
                }
            }
        })