forked-synapse/synapse/push/bulk_push_rule_evaluator.py

163 lines
5.2 KiB
Python
Raw Normal View History

# -*- 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.
import logging
2016-01-18 09:09:47 -05:00
import ujson as json
from twisted.internet import defer
import baserules
2016-01-18 09:09:47 -05:00
from push_rule_evaluator import PushRuleEvaluatorForEvent
from synapse.api.constants import EventTypes
logger = logging.getLogger(__name__)
def decode_rule_json(rule):
rule['conditions'] = json.loads(rule['conditions'])
rule['actions'] = json.loads(rule['actions'])
return rule
@defer.inlineCallbacks
2016-01-18 09:09:47 -05:00
def _get_rules(room_id, user_ids, store):
rules_by_user = yield store.bulk_get_push_rules(user_ids)
rules_enabled_by_user = yield store.bulk_get_push_rules_enabled(user_ids)
rules_by_user = {
2016-01-18 05:09:14 -05:00
uid: baserules.list_with_base_rules([
decode_rule_json(rule_list)
for rule_list in rules_by_user.get(uid, [])
])
2016-01-18 09:09:47 -05:00
for uid in user_ids
}
# We apply the rules-enabled map here: bulk_get_push_rules doesn't
# fetch disabled rules, but this won't account for any server default
# rules the user has disabled, so we need to do this too.
for uid in user_ids:
if uid not in rules_enabled_by_user:
continue
user_enabled_map = rules_enabled_by_user[uid]
2016-01-22 11:03:55 -05:00
for i, rule in enumerate(rules_by_user[uid]):
rule_id = rule['rule_id']
if rule_id in user_enabled_map:
2016-01-22 11:03:55 -05:00
if rule.get('enabled', True) != bool(user_enabled_map[rule_id]):
# Rules are cached across users.
rule = dict(rule)
rule['enabled'] = bool(user_enabled_map[rule_id])
rules_by_user[uid][i] = rule
2016-01-18 09:09:47 -05:00
defer.returnValue(rules_by_user)
@defer.inlineCallbacks
def evaluator_for_room_id(room_id, hs, store):
results = yield store.get_receipts_for_room(room_id, "m.read")
user_ids = [
row["user_id"] for row in results
if hs.is_mine_id(row["user_id"])
]
rules_by_user = yield _get_rules(room_id, user_ids, store)
defer.returnValue(BulkPushRuleEvaluator(
room_id, rules_by_user, user_ids, store
))
class BulkPushRuleEvaluator:
"""
Runs push rules for all users in a room.
This is faster than running PushRuleEvaluator for each user because it
fetches all the rules for all the users in one (batched) db query
2016-01-05 08:32:39 -05:00
rather than doing multiple queries per-user. It currently uses
the same logic to run the actual rules, but could be optimised further
(see https://matrix.org/jira/browse/SYN-562)
"""
2016-01-18 09:09:47 -05:00
def __init__(self, room_id, rules_by_user, users_in_room, store):
self.room_id = room_id
self.rules_by_user = rules_by_user
self.users_in_room = users_in_room
self.store = store
@defer.inlineCallbacks
def action_for_event_by_user(self, event, handler, current_state):
actions_by_user = {}
2016-01-18 09:09:47 -05:00
users_dict = yield self.store.are_guests(self.rules_by_user.keys())
filtered_by_user = yield handler._filter_events_for_clients(
users_dict.items(), [event], {event.event_id: current_state}
2016-01-18 09:09:47 -05:00
)
evaluator = PushRuleEvaluatorForEvent(event, len(self.users_in_room))
2016-01-18 09:09:47 -05:00
condition_cache = {}
display_names = {}
for ev in current_state.values():
2016-01-18 09:09:47 -05:00
nm = ev.content.get("displayname", None)
if nm and ev.type == EventTypes.Member:
display_names[ev.state_key] = nm
for uid, rules in self.rules_by_user.items():
2016-01-18 09:09:47 -05:00
display_name = display_names.get(uid, None)
filtered = filtered_by_user[uid]
if len(filtered) == 0:
continue
2016-01-20 08:44:04 -05:00
if filtered[0].sender == uid:
continue
for rule in rules:
if 'enabled' in rule and not rule['enabled']:
continue
2016-01-18 09:09:47 -05:00
matches = _condition_checker(
2016-01-18 05:09:14 -05:00
evaluator, rule['conditions'], uid, display_name, condition_cache
2016-01-18 09:09:47 -05:00
)
if matches:
actions = [x for x in rule['actions'] if x != 'dont_notify']
if actions and 'notify' in actions:
actions_by_user[uid] = actions
break
defer.returnValue(actions_by_user)
2016-01-18 09:09:47 -05:00
2016-01-18 05:09:14 -05:00
def _condition_checker(evaluator, conditions, uid, display_name, cache):
2016-01-18 09:09:47 -05:00
for cond in conditions:
_id = cond.get("_id", None)
if _id:
res = cache.get(_id, None)
if res is False:
2016-01-19 09:24:59 -05:00
return False
2016-01-18 09:09:47 -05:00
elif res is True:
continue
2016-01-18 05:09:14 -05:00
res = evaluator.matches(cond, uid, display_name, None)
2016-01-18 09:09:47 -05:00
if _id:
cache[_id] = bool(res)
2016-01-18 09:09:47 -05:00
2016-01-19 09:22:02 -05:00
if not res:
2016-01-18 09:09:47 -05:00
return False
return True