diff options
author | Erik Johnston <erik@matrix.org> | 2019-06-17 15:48:57 +0100 |
---|---|---|
committer | Erik Johnston <erik@matrix.org> | 2019-06-17 16:41:19 +0100 |
commit | 187d2837a9fc9d5b9e585f3a7f0f54f2ceac7d1b (patch) | |
tree | 5cd6861229237cffa715f4b7556230f8f56ae1c4 /synapse/events/third_party_rules.py | |
parent | Merge pull request #5385 from matrix-org/erikj/reduce_http_exceptions (diff) | |
download | synapse-187d2837a9fc9d5b9e585f3a7f0f54f2ceac7d1b.tar.xz |
Add third party rules hook into create room
Diffstat (limited to 'synapse/events/third_party_rules.py')
-rw-r--r-- | synapse/events/third_party_rules.py | 27 |
1 files changed, 24 insertions, 3 deletions
diff --git a/synapse/events/third_party_rules.py b/synapse/events/third_party_rules.py index 9f98d51523..ee7b97ad39 100644 --- a/synapse/events/third_party_rules.py +++ b/synapse/events/third_party_rules.py @@ -17,8 +17,8 @@ from twisted.internet import defer class ThirdPartyEventRules(object): - """Allows server admins to provide a Python module implementing an extra set of rules - to apply when processing events. + """Allows server admins to provide a Python module implementing an extra + set of rules to apply when processing events. This is designed to help admins of closed federations with enforcing custom behaviours. @@ -46,7 +46,7 @@ class ThirdPartyEventRules(object): context (synapse.events.snapshot.EventContext): The context of the event. Returns: - defer.Deferred(bool), True if the event should be allowed, False if not. + defer.Deferred[bool]: True if the event should be allowed, False if not. """ if self.third_party_rules is None: defer.returnValue(True) @@ -60,3 +60,24 @@ class ThirdPartyEventRules(object): ret = yield self.third_party_rules.check_event_allowed(event, state_events) defer.returnValue(ret) + + @defer.inlineCallbacks + def on_create_room(self, requester, config, is_requester_admin): + """Intercept requests to create room to allow, deny or update the + request config. + + Args: + requester (Requester) + config (dict): The creation config from the client. + is_requester_admin (bool): If the requester is an admin + + Returns: + defer.Deferred + """ + + if self.third_party_rules is None: + return + + yield self.third_party_rules.on_create_room( + requester, config, is_requester_admin + ) |