mirror of
https://github.com/vector-im/element-web.git
synced 2024-11-18 14:44:58 +08:00
cb6f415a05
Fixes https://github.com/vector-im/riot-web/issues/6435 This is done through an on-the-fly inverter for the settings. All the settings changed are boolean values, so this should be more than safe to just let happen throughout the SettingsStore. Typically a change like this would be done in the individual handlers (similar to how setting names are remapped to different properties or even different storage locations on the fly), however doing that for this many settings would be a huge nightmare and involve changing *all* the layers. By putting a global "invert this" flag on the setting, we can get away with doing the inversion as the last possible step during a read (or write). To speed up calculations of the default values, we cache all the inverted values into a lookup table similar to how we represent the defaults already. Without this, the DefaultHandler would need to iterate the setting list and invert the values, slowing things down over time. We invert the value up front so we can keep the generic inversion logic without checking the level ahead of time. It is fully intended that a default value represents the new setting name, not the legacy name. This commit also includes a debugger for settings because it was hard to visualize what the SettingsStore was doing during development. Some added information is included as it may be helpful for when someone has a problem with their settings and we need to debug it. Typically the debugger would be run in conjunction with `mxSendRageshake`: `mxSettingsStore.debugSetting('showJoinLeaves') && mxSendRageshake('Debugging showJoinLeaves setting')`.
59 lines
2.2 KiB
JavaScript
59 lines
2.2 KiB
JavaScript
/*
|
|
Copyright 2017 Michael Telatynski <7t3chguy@gmail.com>
|
|
|
|
Licensed under the Apache License, Version 2.0 (the "License");
|
|
you may not use this file except in compliance with the License.
|
|
You may obtain a copy of the License at
|
|
|
|
http://www.apache.org/licenses/LICENSE-2.0
|
|
|
|
Unless required by applicable law or agreed to in writing, software
|
|
distributed under the License is distributed on an "AS IS" BASIS,
|
|
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
See the License for the specific language governing permissions and
|
|
limitations under the License.
|
|
*/
|
|
|
|
import SettingsStore from "./settings/SettingsStore";
|
|
|
|
function memberEventDiff(ev) {
|
|
const diff = {
|
|
isMemberEvent: ev.getType() === 'm.room.member',
|
|
};
|
|
|
|
// If is not a Member Event then the other checks do not apply, so bail early.
|
|
if (!diff.isMemberEvent) return diff;
|
|
|
|
const content = ev.getContent();
|
|
const prevContent = ev.getPrevContent();
|
|
|
|
const isMembershipChanged = content.membership !== prevContent.membership;
|
|
diff.isJoin = isMembershipChanged && content.membership === 'join';
|
|
diff.isPart = isMembershipChanged && content.membership === 'leave' && ev.getStateKey() === ev.getSender();
|
|
|
|
const isJoinToJoin = !isMembershipChanged && content.membership === 'join';
|
|
diff.isDisplaynameChange = isJoinToJoin && content.displayname !== prevContent.displayname;
|
|
diff.isAvatarChange = isJoinToJoin && content.avatar_url !== prevContent.avatar_url;
|
|
return diff;
|
|
}
|
|
|
|
export default function shouldHideEvent(ev) {
|
|
// Wrap getValue() for readability. Calling the SettingsStore can be
|
|
// fairly resource heavy, so the checks below should avoid hitting it
|
|
// where possible.
|
|
const isEnabled = (name) => SettingsStore.getValue(name, ev.getRoomId());
|
|
|
|
// Hide redacted events
|
|
if (ev.isRedacted() && !isEnabled('showRedactions')) return true;
|
|
|
|
const eventDiff = memberEventDiff(ev);
|
|
|
|
if (eventDiff.isMemberEvent) {
|
|
if ((eventDiff.isJoin || eventDiff.isPart) && !isEnabled('showJoinLeaves')) return true;
|
|
if (eventDiff.isAvatarChange && !isEnabled('showAvatarChanges')) return true;
|
|
if (eventDiff.isDisplaynameChange && !isEnabled('showDisplaynameChanges')) return true;
|
|
}
|
|
|
|
return false;
|
|
}
|