diff --git a/synapse/rest/client/v1/push_rule.py b/synapse/rest/client/v1/push_rule.py
index 3d6326fe2f..e635efb420 100644
--- a/synapse/rest/client/v1/push_rule.py
+++ b/synapse/rest/client/v1/push_rule.py
@@ -21,7 +21,11 @@ from synapse.api.errors import (
SynapseError,
UnrecognizedRequestError,
)
-from synapse.http.servlet import RestServlet, parse_json_value_from_request, parse_string
+from synapse.http.servlet import (
+ RestServlet,
+ parse_json_value_from_request,
+ parse_string,
+)
from synapse.push.baserules import BASE_RULE_IDS
from synapse.push.clientformat import format_push_rules_for_user
from synapse.push.rulekinds import PRIORITY_CLASS_MAP
@@ -32,7 +36,8 @@ from synapse.storage.push_rule import InconsistentRuleException, RuleNotFoundExc
class PushRuleRestServlet(RestServlet):
PATTERNS = client_patterns("/(?P<path>pushrules/.*)$", v1=True)
SLIGHTLY_PEDANTIC_TRAILING_SLASH_ERROR = (
- "Unrecognised request: You probably wanted a trailing slash")
+ "Unrecognised request: You probably wanted a trailing slash"
+ )
def __init__(self, hs):
super(PushRuleRestServlet, self).__init__()
@@ -54,27 +59,25 @@ class PushRuleRestServlet(RestServlet):
requester = yield self.auth.get_user_by_req(request)
- if '/' in spec['rule_id'] or '\\' in spec['rule_id']:
+ if "/" in spec["rule_id"] or "\\" in spec["rule_id"]:
raise SynapseError(400, "rule_id may not contain slashes")
content = parse_json_value_from_request(request)
user_id = requester.user.to_string()
- if 'attr' in spec:
+ if "attr" in spec:
yield self.set_rule_attr(user_id, spec, content)
self.notify_user(user_id)
defer.returnValue((200, {}))
- if spec['rule_id'].startswith('.'):
+ if spec["rule_id"].startswith("."):
# Rule ids starting with '.' are reserved for server default rules.
raise SynapseError(400, "cannot add new rule_ids that start with '.'")
try:
(conditions, actions) = _rule_tuple_from_request_object(
- spec['template'],
- spec['rule_id'],
- content,
+ spec["template"], spec["rule_id"], content
)
except InvalidRuleException as e:
raise SynapseError(400, str(e))
@@ -95,7 +98,7 @@ class PushRuleRestServlet(RestServlet):
conditions=conditions,
actions=actions,
before=before,
- after=after
+ after=after,
)
self.notify_user(user_id)
except InconsistentRuleException as e:
@@ -118,9 +121,7 @@ class PushRuleRestServlet(RestServlet):
namespaced_rule_id = _namespaced_rule_id_from_spec(spec)
try:
- yield self.store.delete_push_rule(
- user_id, namespaced_rule_id
- )
+ yield self.store.delete_push_rule(user_id, namespaced_rule_id)
self.notify_user(user_id)
defer.returnValue((200, {}))
except StoreError as e:
@@ -149,10 +150,10 @@ class PushRuleRestServlet(RestServlet):
PushRuleRestServlet.SLIGHTLY_PEDANTIC_TRAILING_SLASH_ERROR
)
- if path[0] == '':
+ if path[0] == "":
defer.returnValue((200, rules))
- elif path[0] == 'global':
- result = _filter_ruleset_with_path(rules['global'], path[1:])
+ elif path[0] == "global":
+ result = _filter_ruleset_with_path(rules["global"], path[1:])
defer.returnValue((200, result))
else:
raise UnrecognizedRequestError()
@@ -162,12 +163,10 @@ class PushRuleRestServlet(RestServlet):
def notify_user(self, user_id):
stream_id, _ = self.store.get_push_rules_stream_token()
- self.notifier.on_new_event(
- "push_rules_key", stream_id, users=[user_id]
- )
+ self.notifier.on_new_event("push_rules_key", stream_id, users=[user_id])
def set_rule_attr(self, user_id, spec, val):
- if spec['attr'] == 'enabled':
+ if spec["attr"] == "enabled":
if isinstance(val, dict) and "enabled" in val:
val = val["enabled"]
if not isinstance(val, bool):
@@ -176,14 +175,12 @@ class PushRuleRestServlet(RestServlet):
# bools directly, so let's not break them.
raise SynapseError(400, "Value for 'enabled' must be boolean")
namespaced_rule_id = _namespaced_rule_id_from_spec(spec)
- return self.store.set_push_rule_enabled(
- user_id, namespaced_rule_id, val
- )
- elif spec['attr'] == 'actions':
- actions = val.get('actions')
+ return self.store.set_push_rule_enabled(user_id, namespaced_rule_id, val)
+ elif spec["attr"] == "actions":
+ actions = val.get("actions")
_check_actions(actions)
namespaced_rule_id = _namespaced_rule_id_from_spec(spec)
- rule_id = spec['rule_id']
+ rule_id = spec["rule_id"]
is_default_rule = rule_id.startswith(".")
if is_default_rule:
if namespaced_rule_id not in BASE_RULE_IDS:
@@ -210,12 +207,12 @@ def _rule_spec_from_path(path):
"""
if len(path) < 2:
raise UnrecognizedRequestError()
- if path[0] != 'pushrules':
+ if path[0] != "pushrules":
raise UnrecognizedRequestError()
scope = path[1]
path = path[2:]
- if scope != 'global':
+ if scope != "global":
raise UnrecognizedRequestError()
if len(path) == 0:
@@ -229,56 +226,40 @@ def _rule_spec_from_path(path):
rule_id = path[0]
- spec = {
- 'scope': scope,
- 'template': template,
- 'rule_id': rule_id
- }
+ spec = {"scope": scope, "template": template, "rule_id": rule_id}
path = path[1:]
if len(path) > 0 and len(path[0]) > 0:
- spec['attr'] = path[0]
+ spec["attr"] = path[0]
return spec
def _rule_tuple_from_request_object(rule_template, rule_id, req_obj):
- if rule_template in ['override', 'underride']:
- if 'conditions' not in req_obj:
+ if rule_template in ["override", "underride"]:
+ if "conditions" not in req_obj:
raise InvalidRuleException("Missing 'conditions'")
- conditions = req_obj['conditions']
+ conditions = req_obj["conditions"]
for c in conditions:
- if 'kind' not in c:
+ if "kind" not in c:
raise InvalidRuleException("Condition without 'kind'")
- elif rule_template == 'room':
- conditions = [{
- 'kind': 'event_match',
- 'key': 'room_id',
- 'pattern': rule_id
- }]
- elif rule_template == 'sender':
- conditions = [{
- 'kind': 'event_match',
- 'key': 'user_id',
- 'pattern': rule_id
- }]
- elif rule_template == 'content':
- if 'pattern' not in req_obj:
+ elif rule_template == "room":
+ conditions = [{"kind": "event_match", "key": "room_id", "pattern": rule_id}]
+ elif rule_template == "sender":
+ conditions = [{"kind": "event_match", "key": "user_id", "pattern": rule_id}]
+ elif rule_template == "content":
+ if "pattern" not in req_obj:
raise InvalidRuleException("Content rule missing 'pattern'")
- pat = req_obj['pattern']
+ pat = req_obj["pattern"]
- conditions = [{
- 'kind': 'event_match',
- 'key': 'content.body',
- 'pattern': pat
- }]
+ conditions = [{"kind": "event_match", "key": "content.body", "pattern": pat}]
else:
raise InvalidRuleException("Unknown rule template: %s" % (rule_template,))
- if 'actions' not in req_obj:
+ if "actions" not in req_obj:
raise InvalidRuleException("No actions found")
- actions = req_obj['actions']
+ actions = req_obj["actions"]
_check_actions(actions)
@@ -290,9 +271,9 @@ def _check_actions(actions):
raise InvalidRuleException("No actions found")
for a in actions:
- if a in ['notify', 'dont_notify', 'coalesce']:
+ if a in ["notify", "dont_notify", "coalesce"]:
pass
- elif isinstance(a, dict) and 'set_tweak' in a:
+ elif isinstance(a, dict) and "set_tweak" in a:
pass
else:
raise InvalidRuleException("Unrecognised action")
@@ -304,7 +285,7 @@ def _filter_ruleset_with_path(ruleset, path):
PushRuleRestServlet.SLIGHTLY_PEDANTIC_TRAILING_SLASH_ERROR
)
- if path[0] == '':
+ if path[0] == "":
return ruleset
template_kind = path[0]
if template_kind not in ruleset:
@@ -314,13 +295,13 @@ def _filter_ruleset_with_path(ruleset, path):
raise UnrecognizedRequestError(
PushRuleRestServlet.SLIGHTLY_PEDANTIC_TRAILING_SLASH_ERROR
)
- if path[0] == '':
+ if path[0] == "":
return ruleset[template_kind]
rule_id = path[0]
the_rule = None
for r in ruleset[template_kind]:
- if r['rule_id'] == rule_id:
+ if r["rule_id"] == rule_id:
the_rule = r
if the_rule is None:
raise NotFoundError
@@ -339,19 +320,19 @@ def _filter_ruleset_with_path(ruleset, path):
def _priority_class_from_spec(spec):
- if spec['template'] not in PRIORITY_CLASS_MAP.keys():
- raise InvalidRuleException("Unknown template: %s" % (spec['template']))
- pc = PRIORITY_CLASS_MAP[spec['template']]
+ if spec["template"] not in PRIORITY_CLASS_MAP.keys():
+ raise InvalidRuleException("Unknown template: %s" % (spec["template"]))
+ pc = PRIORITY_CLASS_MAP[spec["template"]]
return pc
def _namespaced_rule_id_from_spec(spec):
- return _namespaced_rule_id(spec, spec['rule_id'])
+ return _namespaced_rule_id(spec, spec["rule_id"])
def _namespaced_rule_id(spec, rule_id):
- return "global/%s/%s" % (spec['template'], rule_id)
+ return "global/%s/%s" % (spec["template"], rule_id)
class InvalidRuleException(Exception):
|
