Wrap ban list build in a logging context

This commit is contained in:
Travis Ralston 2019-11-13 14:31:31 -07:00
parent f72b68dc7c
commit 83fffd322e

View File

@ -16,6 +16,7 @@
import logging import logging
from .list_rule import ListRule, ALL_RULE_TYPES, USER_RULE_TYPES, SERVER_RULE_TYPES, ROOM_RULE_TYPES from .list_rule import ListRule, ALL_RULE_TYPES, USER_RULE_TYPES, SERVER_RULE_TYPES, ROOM_RULE_TYPES
from twisted.internet import defer from twisted.internet import defer
from synapse.logging.context import LoggingContext
logger = logging.getLogger("synapse.contrib." + __name__) logger = logging.getLogger("synapse.contrib." + __name__)
@ -28,45 +29,49 @@ class BanList(object):
self.room_rules = [] self.room_rules = []
self.build() self.build()
@defer.inlineCallbacks def build(with_event=None):
def build(self, with_event=None): @defer.inlineCallbacks
events = yield self.get_relevant_state_events() def run(self, with_event=None):
if with_event is not None: events = yield self.get_relevant_state_events()
events = [*events, with_event]
self.server_rules = []
self.user_rules = []
self.room_rules = []
for event in events:
event_type = event.get("type", "")
state_key = event.get("state_key", "")
content = event.get("content", {})
if state_key is None:
continue # Some message event got in here?
# Skip over events which are replaced by with_event. We do this
# to ensure that when we rebuild the list we're using updated rules.
if with_event is not None: if with_event is not None:
w_event_type = with_event.get("type", "") events = [*events, with_event]
w_state_key = with_event.get("state_key", "") self.server_rules = []
w_event_id = with_event.event_id self.user_rules = []
event_id = event.event_id self.room_rules = []
if w_event_type == event_type and w_state_key == state_key and w_event_id != event_id: for event in events:
continue event_type = event.get("type", "")
state_key = event.get("state_key", "")
content = event.get("content", {})
if state_key is None:
continue # Some message event got in here?
entity = content.get("entity", None) # Skip over events which are replaced by with_event. We do this
recommendation = content.get("recommendation", None) # to ensure that when we rebuild the list we're using updated rules.
reason = content.get("reason", None) if with_event is not None:
if entity is None or recommendation is None or reason is None: w_event_type = with_event.get("type", "")
continue # invalid event w_state_key = with_event.get("state_key", "")
w_event_id = with_event.event_id
event_id = event.event_id
if w_event_type == event_type and w_state_key == state_key and w_event_id != event_id:
continue
logger.info("Adding rule %s/%s with action %s" % (event_type, entity, recommendation)) entity = content.get("entity", None)
rule = ListRule(entity=entity, action=recommendation, reason=reason, kind=event_type) recommendation = content.get("recommendation", None)
if event_type in USER_RULE_TYPES: reason = content.get("reason", None)
self.user_rules.append(rule) if entity is None or recommendation is None or reason is None:
elif event_type in ROOM_RULE_TYPES: continue # invalid event
self.room_rules.append(rule)
elif event_type in SERVER_RULE_TYPES: logger.info("Adding rule %s/%s with action %s" % (event_type, entity, recommendation))
self.server_rules.append(rule) rule = ListRule(entity=entity, action=recommendation, reason=reason, kind=event_type)
if event_type in USER_RULE_TYPES:
self.user_rules.append(rule)
elif event_type in ROOM_RULE_TYPES:
self.room_rules.append(rule)
elif event_type in SERVER_RULE_TYPES:
self.server_rules.append(rule)
with LoggingContext("mjolnir_ban_list_build"):
run(with_event=with_event)
def get_relevant_state_events(self): def get_relevant_state_events(self):
return self.api.get_state_events_in_room(self.room_id, [(t, None) for t in ALL_RULE_TYPES]) return self.api.get_state_events_in_room(self.room_id, [(t, None) for t in ALL_RULE_TYPES])