mirror of
https://github.com/element-hq/synapse
synced 2024-08-19 04:30:53 +00:00
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
This commit is contained in:
parent
02a9a93bde
commit
2a98ba0ed3
2 changed files with 15 additions and 16 deletions
|
@ -1,5 +1,6 @@
|
||||||
# -*- coding: utf-8 -*-
|
# -*- coding: utf-8 -*-
|
||||||
# Copyright 2015, 2016 OpenMarket Ltd
|
# Copyright 2015, 2016 OpenMarket Ltd
|
||||||
|
# Copyright 2017 New Vector Ltd
|
||||||
#
|
#
|
||||||
# Licensed under the Apache License, Version 2.0 (the "License");
|
# Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
# you may not use this file except in compliance with 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):
|
class PushConfig(Config):
|
||||||
def read_config(self, config):
|
def read_config(self, config):
|
||||||
self.push_redact_content = False
|
self.push_include_content = True
|
||||||
|
|
||||||
push_config = config.get("email", {})
|
push_config = config.get("push", {})
|
||||||
self.push_redact_content = push_config.get("redact_content", False)
|
self.push_include_content = push_config.get("include_content", True)
|
||||||
|
|
||||||
def default_config(self, config_dir_path, server_name, **kwargs):
|
def default_config(self, config_dir_path, server_name, **kwargs):
|
||||||
return """
|
return """
|
||||||
# Control how push messages are sent to google/apple to notifications.
|
# Clients requesting push notifications can either have the body of
|
||||||
# Normally every message said in a room with one or more people using
|
# the message sent in the notification poke along with other details
|
||||||
# mobile devices will be posted to a push server hosted by matrix.org
|
# like the sender, or just the event ID and room ID (`event_id_only`).
|
||||||
# which is registered with google and apple in order to allow push
|
# If clients choose the former, this option controls whether the
|
||||||
# notifications to be sent to these mobile devices.
|
# notification request includes the content of the event (other details
|
||||||
#
|
# like the sender are still included). For `event_id_only` push, it
|
||||||
# Setting redact_content to true will make the push messages contain no
|
# has no effect.
|
||||||
# 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.
|
|
||||||
#
|
|
||||||
# For modern android devices the notification content will still appear
|
# For modern android devices the notification content will still appear
|
||||||
# because it is loaded by the app. iPhone, however will send a
|
# because it is loaded by the app. iPhone, however will send a
|
||||||
# notification saying only that a message arrived and who it came from.
|
# notification saying only that a message arrived and who it came from.
|
||||||
#
|
#
|
||||||
#push:
|
#push:
|
||||||
# redact_content: false
|
# include_content: false
|
||||||
"""
|
"""
|
||||||
|
|
|
@ -1,5 +1,6 @@
|
||||||
# -*- coding: utf-8 -*-
|
# -*- coding: utf-8 -*-
|
||||||
# Copyright 2015, 2016 OpenMarket Ltd
|
# Copyright 2015, 2016 OpenMarket Ltd
|
||||||
|
# Copyright 2017 New Vector Ltd
|
||||||
#
|
#
|
||||||
# Licensed under the Apache License, Version 2.0 (the "License");
|
# Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
# you may not use this file except in compliance with the License.
|
# you may not use this file except in compliance with the License.
|
||||||
|
@ -295,7 +296,7 @@ class HttpPusher(object):
|
||||||
if event.type == 'm.room.member':
|
if event.type == 'm.room.member':
|
||||||
d['notification']['membership'] = event.content['membership']
|
d['notification']['membership'] = event.content['membership']
|
||||||
d['notification']['user_is_target'] = event.state_key == self.user_id
|
d['notification']['user_is_target'] = event.state_key == self.user_id
|
||||||
if not self.hs.config.push_redact_content and 'content' in event:
|
if self.hs.config.push_include_content and 'content' in event:
|
||||||
d['notification']['content'] = event.content
|
d['notification']['content'] = event.content
|
||||||
|
|
||||||
# We no longer send aliases separately, instead, we send the human
|
# We no longer send aliases separately, instead, we send the human
|
||||||
|
|
Loading…
Reference in a new issue