summary refs log tree commit diff
path: root/synapse/config/push.py
diff options
context:
space:
mode:
authorDavid Baker <dave@matrix.org>2017-11-08 10:35:30 +0000
committerDavid Baker <dave@matrix.org>2017-11-08 10:35:30 +0000
commit2a98ba0ed31bdd51ea43c0867bee2a5256f2a289 (patch)
tree80eee55ad6dd5dc1ea9d319278d2c8bacb3edcf6 /synapse/config/push.py
parentMerge pull request #2649 from matrix-org/rav/fix_delta_on_state_res (diff)
downloadsynapse-2a98ba0ed31bdd51ea43c0867bee2a5256f2a289.tar.xz
Rename redact_content option to include_content
The redact_content option never worked because it read the wrong config
section. The PR introducing it
(https://github.com/matrix-org/synapse/pull/2301) had feedback suggesting the
name be changed to not re-use the term 'redact' but this wasn't
incorporated.

This reanmes the option to give it a less confusing name, and also
means that people who've set the redact_content option won't suddenly
see a behaviour change when upgrading synapse, but instead can set
include_content if they want to.

This PR also updates the wording of the config comment to clarify
that this has no effect on event_id_only push.

Includes https://github.com/matrix-org/synapse/pull/2422
Diffstat (limited to '')
-rw-r--r--synapse/config/push.py28
1 files changed, 13 insertions, 15 deletions
diff --git a/synapse/config/push.py b/synapse/config/push.py
index 9c68318b40..01d4a49784 100644
--- a/synapse/config/push.py
+++ b/synapse/config/push.py
@@ -1,5 +1,6 @@
 # -*- coding: utf-8 -*-
 # Copyright 2015, 2016 OpenMarket Ltd
+# Copyright 2017 New Vector Ltd
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -18,28 +19,25 @@ from ._base import Config
 
 class PushConfig(Config):
     def read_config(self, config):
-        self.push_redact_content = False
+        self.push_include_content = True
 
-        push_config = config.get("email", {})
-        self.push_redact_content = push_config.get("redact_content", False)
+        push_config = config.get("push", {})
+        self.push_include_content = push_config.get("include_content", True)
 
     def default_config(self, config_dir_path, server_name, **kwargs):
         return """
-        # Control how push messages are sent to google/apple to notifications.
-        # Normally every message said in a room with one or more people using
-        # mobile devices will be posted to a push server hosted by matrix.org
-        # which is registered with google and apple in order to allow push
-        # notifications to be sent to these mobile devices.
-        #
-        # Setting redact_content to true will make the push messages contain no
-        # message content which will provide increased privacy. This is a
-        # temporary solution pending improvements to Android and iPhone apps
-        # to get content from the app rather than the notification.
-        #
+        # Clients requesting push notifications can either have the body of
+        # the message sent in the notification poke along with other details
+        # like the sender, or just the event ID and room ID (`event_id_only`).
+        # If clients choose the former, this option controls whether the
+        # notification request includes the content of the event (other details
+        # like the sender are still included). For `event_id_only` push, it
+        # has no effect.
+
         # For modern android devices the notification content will still appear
         # because it is loaded by the app. iPhone, however will send a
         # notification saying only that a message arrived and who it came from.
         #
         #push:
-        #   redact_content: false
+        #   include_content: false
         """