Add SettingsLevel enum; Move settings to own file.
Signed-off-by: Travis Ralston <travpc@gmail.com>
This commit is contained in:
Travis Ralston
parent
893c39bfbe
commit
8282534f87
16 changed files with 259 additions and 213 deletions
|
|
@ -50,7 +50,8 @@ export default class AccountSettingHandler extends SettingsHandler {
|
|||
}
|
||||
|
||||
isSupported() {
|
||||
return !!MatrixClientPeg.get();
|
||||
const cli = MatrixClientPeg.get();
|
||||
return cli !== undefined && cli !== null;
|
||||
}
|
||||
|
||||
_getSettings(eventType = "im.vector.web.settings") {
|
||||
|
|
|
|||
|
|
@ -59,7 +59,7 @@ export default class DeviceSettingsHandler extends SettingsHandler {
|
|||
}
|
||||
|
||||
isSupported() {
|
||||
return !!localStorage;
|
||||
return localStorage !== undefined && localStorage !== null;
|
||||
}
|
||||
|
||||
_getSettings() {
|
||||
|
|
|
|||
|
|
@ -46,11 +46,14 @@ export default class RoomAccountSettingsHandler extends SettingsHandler {
|
|||
|
||||
canSetValue(settingName, roomId) {
|
||||
const room = MatrixClientPeg.get().getRoom(roomId);
|
||||
return !!room; // If they have the room, they can set their own account data
|
||||
|
||||
// If they have the room, they can set their own account data
|
||||
return room !== undefined && room !== null;
|
||||
}
|
||||
|
||||
isSupported() {
|
||||
return !!MatrixClientPeg.get();
|
||||
const cli = MatrixClientPeg.get();
|
||||
return cli !== undefined && cli !== null;
|
||||
}
|
||||
|
||||
_getSettings(roomId, eventType = "im.vector.settings") {
|
||||
|
|
|
|||
|
|
@ -44,7 +44,7 @@ export default class RoomDeviceSettingsHandler extends SettingsHandler {
|
|||
}
|
||||
|
||||
isSupported() {
|
||||
return !!localStorage;
|
||||
return localStorage !== undefined && localStorage !== null;
|
||||
}
|
||||
|
||||
_getKey(settingName, roomId) {
|
||||
|
|
|
|||
|
|
@ -53,7 +53,8 @@ export default class RoomSettingsHandler extends SettingsHandler {
|
|||
}
|
||||
|
||||
isSupported() {
|
||||
return !!MatrixClientPeg.get();
|
||||
const cli = MatrixClientPeg.get();
|
||||
return cli !== undefined && cli !== null;
|
||||
}
|
||||
|
||||
_getSettings(roomId, eventType = "im.vector.web.settings") {
|
||||
|
|
|
|||
198
src/settings/Settings.js
Normal file
198
src/settings/Settings.js
Normal file
|
|
@ -0,0 +1,198 @@
|
|||
/*
|
||||
Copyright 2017 Travis Ralston
|
||||
|
||||
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 {_td} from '../languageHandler';
|
||||
|
||||
|
||||
// These are just a bunch of helper arrays to avoid copy/pasting a bunch of times
|
||||
const LEVELS_ROOM_SETTINGS = ['device', 'room-device', 'room-account', 'account', 'config'];
|
||||
const LEVELS_ROOM_SETTINGS_WITH_ROOM = ['device', 'room-device', 'room-account', 'account', 'config', 'room'];
|
||||
const LEVELS_ACCOUNT_SETTINGS = ['device', 'account', 'config'];
|
||||
const LEVELS_FEATURE = ['device', 'config'];
|
||||
const LEVELS_DEVICE_ONLY_SETTINGS = ['device'];
|
||||
const LEVELS_DEVICE_ONLY_SETTINGS_WITH_CONFIG = ['device', 'config'];
|
||||
|
||||
export const SETTINGS = {
|
||||
// EXAMPLE SETTING:
|
||||
// "my-setting": {
|
||||
// // Required by features, optional otherwise
|
||||
// isFeature: false,
|
||||
//
|
||||
// // Recommended.
|
||||
// displayName: _td("Cool Name"),
|
||||
//
|
||||
// // Required.
|
||||
// supportedLevels: [
|
||||
// // The order does not matter.
|
||||
//
|
||||
// "device", // Affects the current device only
|
||||
// "room-device", // Affects the current room on the current device
|
||||
// "room-account", // Affects the current room for the current account
|
||||
// "account", // Affects the current account
|
||||
// "room", // Affects the current room (controlled by room admins)
|
||||
// "config", // Affects the current application
|
||||
//
|
||||
// // "default" is always supported and does not get listed here.
|
||||
// ],
|
||||
//
|
||||
// // Optional. Any data type.
|
||||
// default: {
|
||||
// your: "value",
|
||||
// },
|
||||
// },
|
||||
"feature_groups": {
|
||||
isFeature: true,
|
||||
displayName: _td("Communities"),
|
||||
supportedLevels: LEVELS_FEATURE,
|
||||
},
|
||||
"feature_pinning": {
|
||||
isFeature: true,
|
||||
displayName: _td("Message Pinning"),
|
||||
supportedLevels: LEVELS_FEATURE,
|
||||
},
|
||||
"MessageComposerInput.dontSuggestEmoji": {
|
||||
supportedLevels: LEVELS_ACCOUNT_SETTINGS,
|
||||
displayName: _td('Disable Emoji suggestions while typing'),
|
||||
default: false,
|
||||
},
|
||||
"useCompactLayout": {
|
||||
supportedLevels: LEVELS_ACCOUNT_SETTINGS,
|
||||
displayName: _td('Use compact timeline layout'),
|
||||
default: false,
|
||||
},
|
||||
"hideRedactions": {
|
||||
supportedLevels: LEVELS_ROOM_SETTINGS_WITH_ROOM,
|
||||
displayName: _td('Hide removed messages'),
|
||||
default: false,
|
||||
},
|
||||
"hideJoinLeaves": {
|
||||
supportedLevels: LEVELS_ROOM_SETTINGS_WITH_ROOM,
|
||||
displayName: _td('Hide join/leave messages (invites/kicks/bans unaffected)'),
|
||||
default: false,
|
||||
},
|
||||
"hideAvatarDisplaynameChanges": {
|
||||
supportedLevels: LEVELS_ROOM_SETTINGS_WITH_ROOM,
|
||||
displayName: _td('Hide avatar and display name changes'),
|
||||
default: false,
|
||||
},
|
||||
"hideReadReceipts": {
|
||||
supportedLevels: LEVELS_ROOM_SETTINGS,
|
||||
displayName: _td('Hide read receipts'),
|
||||
default: false,
|
||||
},
|
||||
"showTwelveHourTimestamps": {
|
||||
supportedLevels: LEVELS_ACCOUNT_SETTINGS,
|
||||
displayName: _td('Show timestamps in 12 hour format (e.g. 2:30pm)'),
|
||||
default: false,
|
||||
},
|
||||
"alwaysShowTimestamps": {
|
||||
supportedLevels: LEVELS_ACCOUNT_SETTINGS,
|
||||
displayName: _td('Always show message timestamps'),
|
||||
default: false,
|
||||
},
|
||||
"autoplayGifsAndVideos": {
|
||||
supportedLevels: LEVELS_ACCOUNT_SETTINGS,
|
||||
displayName: _td('Autoplay GIFs and videos'),
|
||||
default: false,
|
||||
},
|
||||
"enableSyntaxHighlightLanguageDetection": {
|
||||
supportedLevels: LEVELS_ACCOUNT_SETTINGS,
|
||||
displayName: _td('Enable automatic language detection for syntax highlighting'),
|
||||
default: false,
|
||||
},
|
||||
"Pill.shouldHidePillAvatar": {
|
||||
supportedLevels: LEVELS_ACCOUNT_SETTINGS,
|
||||
displayName: _td('Hide avatars in user and room mentions'),
|
||||
default: false,
|
||||
},
|
||||
"TextualBody.disableBigEmoji": {
|
||||
supportedLevels: LEVELS_ACCOUNT_SETTINGS,
|
||||
displayName: _td('Disable big emoji in chat'),
|
||||
default: false,
|
||||
},
|
||||
"MessageComposerInput.isRichTextEnabled": {
|
||||
supportedLevels: LEVELS_ACCOUNT_SETTINGS,
|
||||
default: false,
|
||||
},
|
||||
"MessageComposer.showFormatting": {
|
||||
supportedLevels: LEVELS_ACCOUNT_SETTINGS,
|
||||
default: false,
|
||||
},
|
||||
"dontSendTypingNotifications": {
|
||||
supportedLevels: LEVELS_ACCOUNT_SETTINGS,
|
||||
displayName: _td("Don't send typing notifications"),
|
||||
default: false,
|
||||
},
|
||||
"MessageComposerInput.autoReplaceEmoji": {
|
||||
supportedLevels: LEVELS_ACCOUNT_SETTINGS,
|
||||
displayName: _td('Automatically replace plain text Emoji'),
|
||||
default: false,
|
||||
},
|
||||
"VideoView.flipVideoHorizontally": {
|
||||
supportedLevels: LEVELS_ACCOUNT_SETTINGS,
|
||||
displayName: _td('Mirror local video feed'),
|
||||
default: false,
|
||||
},
|
||||
"theme": {
|
||||
supportedLevels: LEVELS_ACCOUNT_SETTINGS,
|
||||
default: "light",
|
||||
},
|
||||
"webRtcForceTURN": {
|
||||
supportedLevels: LEVELS_DEVICE_ONLY_SETTINGS_WITH_CONFIG,
|
||||
displayName: _td('Disable Peer-to-Peer for 1:1 calls'),
|
||||
default: false,
|
||||
},
|
||||
"webrtc_audioinput": {
|
||||
supportedLevels: LEVELS_DEVICE_ONLY_SETTINGS,
|
||||
},
|
||||
"webrtc_videoinput": {
|
||||
supportedLevels: LEVELS_DEVICE_ONLY_SETTINGS,
|
||||
},
|
||||
"language": {
|
||||
supportedLevels: LEVELS_DEVICE_ONLY_SETTINGS_WITH_CONFIG,
|
||||
default: "en"
|
||||
},
|
||||
"analyticsOptOut": {
|
||||
supportedLevels: LEVELS_DEVICE_ONLY_SETTINGS_WITH_CONFIG,
|
||||
displayName: _td('Opt out of analytics'),
|
||||
default: false,
|
||||
},
|
||||
"autocompleteDelay": {
|
||||
supportedLevels: LEVELS_DEVICE_ONLY_SETTINGS_WITH_CONFIG,
|
||||
default: 200,
|
||||
},
|
||||
"blacklistUnverifiedDevicesPerRoom": {
|
||||
// TODO: {Travis} Write a migration path to support blacklistUnverifiedDevices
|
||||
supportedLevels: LEVELS_DEVICE_ONLY_SETTINGS,
|
||||
displayName: _td('Never send encrypted messages to unverified devices from this device'),
|
||||
default: {},
|
||||
},
|
||||
"blacklistUnverifiedDevices": {
|
||||
// TODO: {Travis} Write a migration path to support blacklistUnverifiedDevices
|
||||
supportedLevels: LEVELS_DEVICE_ONLY_SETTINGS,
|
||||
displayName: _td('Never send encrypted messages to unverified devices from this device'),
|
||||
default: false,
|
||||
},
|
||||
"urlPreviewsEnabled": {
|
||||
supportedLevels: LEVELS_ROOM_SETTINGS_WITH_ROOM,
|
||||
displayName: {
|
||||
"default": _td('Enable inline URL previews by default'),
|
||||
"room-account": _td("Enable URL previews for this room (only affects you)"),
|
||||
"room": _td("Enable URL previews by default for participants in this room"),
|
||||
},
|
||||
default: true,
|
||||
},
|
||||
};
|
||||
|
|
@ -22,190 +22,27 @@ import RoomAccountSettingsHandler from "./RoomAccountSettingsHandler";
|
|||
import AccountSettingsHandler from "./AccountSettingsHandler";
|
||||
import RoomSettingsHandler from "./RoomSettingsHandler";
|
||||
import ConfigSettingsHandler from "./ConfigSettingsHandler";
|
||||
import {_t, _td} from '../languageHandler';
|
||||
import {_t} from '../languageHandler';
|
||||
import SdkConfig from "../SdkConfig";
|
||||
import {SETTINGS} from "./Settings";
|
||||
|
||||
// Preset levels for room-based settings (eg: URL previews).
|
||||
// Doesn't include 'room' because most settings don't need it. Use .concat('room') to add.
|
||||
const LEVELS_PRESET_ROOM = ['device', 'room-device', 'room-account', 'account', 'config'];
|
||||
|
||||
// Preset levels for account-based settings (eg: interface language).
|
||||
const LEVELS_PRESET_ACCOUNT = ['device', 'account', 'config'];
|
||||
|
||||
// Preset levels for features (labs) settings.
|
||||
const LEVELS_PRESET_FEATURE = ['device', 'config'];
|
||||
|
||||
const SETTINGS = {
|
||||
// EXAMPLE SETTING:
|
||||
// "my-setting": {
|
||||
// // Required by features, optional otherwise
|
||||
// isFeature: false,
|
||||
// displayName: _td("Cool Name"),
|
||||
//
|
||||
// // Required.
|
||||
// supportedLevels: [
|
||||
// // The order does not matter.
|
||||
//
|
||||
// "device", // Affects the current device only
|
||||
// "room-device", // Affects the current room on the current device
|
||||
// "room-account", // Affects the current room for the current account
|
||||
// "account", // Affects the current account
|
||||
// "room", // Affects the current room (controlled by room admins)
|
||||
// "config", // Affects the current application
|
||||
//
|
||||
// // "default" is always supported and does not get listed here.
|
||||
// ],
|
||||
//
|
||||
// // Optional. Any data type.
|
||||
// default: {
|
||||
// your: "value",
|
||||
// },
|
||||
// },
|
||||
"feature_groups": {
|
||||
isFeature: true,
|
||||
displayName: _td("Communities"),
|
||||
supportedLevels: LEVELS_PRESET_FEATURE,
|
||||
},
|
||||
"feature_pinning": {
|
||||
isFeature: true,
|
||||
displayName: _td("Message Pinning"),
|
||||
supportedLevels: LEVELS_PRESET_FEATURE,
|
||||
},
|
||||
"MessageComposerInput.dontSuggestEmoji": {
|
||||
supportedLevels: LEVELS_PRESET_ACCOUNT,
|
||||
default: false,
|
||||
displayName: _td('Disable Emoji suggestions while typing'),
|
||||
},
|
||||
"useCompactLayout": {
|
||||
supportedLevels: LEVELS_PRESET_ACCOUNT,
|
||||
default: false,
|
||||
displayName: _td('Use compact timeline layout'),
|
||||
},
|
||||
"hideRedactions": {
|
||||
supportedLevels: LEVELS_PRESET_ROOM.concat("room"),
|
||||
default: false,
|
||||
displayName: _td('Hide removed messages'),
|
||||
},
|
||||
"hideJoinLeaves": {
|
||||
supportedLevels: LEVELS_PRESET_ROOM.concat("room"),
|
||||
default: false,
|
||||
displayName: _td('Hide join/leave messages (invites/kicks/bans unaffected)'),
|
||||
},
|
||||
"hideAvatarDisplaynameChanges": {
|
||||
supportedLevels: LEVELS_PRESET_ROOM.concat("room"),
|
||||
default: false,
|
||||
displayName: _td('Hide avatar and display name changes'),
|
||||
},
|
||||
"hideReadReceipts": {
|
||||
supportedLevels: LEVELS_PRESET_ROOM,
|
||||
default: false,
|
||||
displayName: _td('Hide read receipts'),
|
||||
},
|
||||
"showTwelveHourTimestamps": {
|
||||
supportedLevels: LEVELS_PRESET_ACCOUNT,
|
||||
default: false,
|
||||
displayName: _td('Show timestamps in 12 hour format (e.g. 2:30pm)'),
|
||||
},
|
||||
"alwaysShowTimestamps": {
|
||||
supportedLevels: LEVELS_PRESET_ACCOUNT,
|
||||
default: false,
|
||||
displayName: _td('Always show message timestamps'),
|
||||
},
|
||||
"autoplayGifsAndVideos": {
|
||||
supportedLevels: LEVELS_PRESET_ACCOUNT,
|
||||
default: false,
|
||||
displayName: _td('Autoplay GIFs and videos'),
|
||||
},
|
||||
"enableSyntaxHighlightLanguageDetection": {
|
||||
supportedLevels: LEVELS_PRESET_ACCOUNT,
|
||||
default: false,
|
||||
displayName: _td('Enable automatic language detection for syntax highlighting'),
|
||||
},
|
||||
"Pill.shouldHidePillAvatar": {
|
||||
supportedLevels: LEVELS_PRESET_ACCOUNT,
|
||||
default: false,
|
||||
displayName: _td('Hide avatars in user and room mentions'),
|
||||
},
|
||||
"TextualBody.disableBigEmoji": {
|
||||
supportedLevels: LEVELS_PRESET_ACCOUNT,
|
||||
default: false,
|
||||
displayName: _td('Disable big emoji in chat'),
|
||||
},
|
||||
"MessageComposerInput.isRichTextEnabled": {
|
||||
supportedLevels: LEVELS_PRESET_ACCOUNT,
|
||||
default: false,
|
||||
},
|
||||
"MessageComposer.showFormatting": {
|
||||
supportedLevels: LEVELS_PRESET_ACCOUNT,
|
||||
default: false,
|
||||
},
|
||||
"dontSendTypingNotifications": {
|
||||
supportedLevels: LEVELS_PRESET_ACCOUNT,
|
||||
default: false,
|
||||
displayName: _td("Don't send typing notifications"),
|
||||
},
|
||||
"MessageComposerInput.autoReplaceEmoji": {
|
||||
supportedLevels: LEVELS_PRESET_ACCOUNT,
|
||||
default: false,
|
||||
displayName: _td('Automatically replace plain text Emoji'),
|
||||
},
|
||||
"VideoView.flipVideoHorizontally": {
|
||||
supportedLevels: LEVELS_PRESET_ACCOUNT,
|
||||
default: false,
|
||||
displayName: _td('Mirror local video feed'),
|
||||
},
|
||||
"theme": {
|
||||
supportedLevels: LEVELS_PRESET_ACCOUNT,
|
||||
default: "light",
|
||||
},
|
||||
"webRtcForceTURN": {
|
||||
supportedLevels: ['device', 'config'],
|
||||
default: false,
|
||||
displayName: _td('Disable Peer-to-Peer for 1:1 calls'),
|
||||
},
|
||||
"webrtc_audioinput": {
|
||||
supportedLevels: ['device'],
|
||||
},
|
||||
"webrtc_videoinput": {
|
||||
supportedLevels: ['device'],
|
||||
},
|
||||
"language": {
|
||||
supportedLevels: ['device', 'config'],
|
||||
default: "en"
|
||||
},
|
||||
"analyticsOptOut": {
|
||||
supportedLevels: ['device', 'config'],
|
||||
default: false,
|
||||
displayName: _td('Opt out of analytics'),
|
||||
},
|
||||
"autocompleteDelay": {
|
||||
supportedLevels: ['device', 'config'],
|
||||
default: 200,
|
||||
},
|
||||
"blacklistUnverifiedDevicesPerRoom": {
|
||||
// TODO: {Travis} Write a migration path to support blacklistUnverifiedDevices
|
||||
supportedLevels: ['device'],
|
||||
default: {},
|
||||
displayName: _td('Never send encrypted messages to unverified devices from this device'),
|
||||
},
|
||||
"blacklistUnverifiedDevices": {
|
||||
// TODO: {Travis} Write a migration path to support blacklistUnverifiedDevices
|
||||
supportedLevels: ['device'],
|
||||
default: false,
|
||||
displayName: _td('Never send encrypted messages to unverified devices from this device'),
|
||||
},
|
||||
"urlPreviewsEnabled": {
|
||||
supportedLevels: LEVELS_PRESET_ROOM.concat("room"),
|
||||
default: true,
|
||||
displayName: {
|
||||
"default": _td('Enable inline URL previews by default'),
|
||||
"room-account": _td("Enable URL previews for this room (only affects you)"),
|
||||
"room": _td("Enable URL previews by default for participants in this room"),
|
||||
},
|
||||
},
|
||||
/**
|
||||
* Represents the various setting levels supported by the SettingsStore.
|
||||
*/
|
||||
export const SettingLevel = {
|
||||
// Note: This enum is not used in this class or in the Settings file
|
||||
// This should always be used elsewhere in the project.
|
||||
DEVICE: "device",
|
||||
ROOM_DEVICE: "room-device",
|
||||
ROOM_ACCOUNT: "room-account",
|
||||
ACCOUNT: "account",
|
||||
ROOM: "room",
|
||||
CONFIG: "config",
|
||||
DEFAULT: "default",
|
||||
};
|
||||
|
||||
// Convert the above into simpler formats for the handlers
|
||||
|
||||
// Convert the settings to easier to manage objects for the handlers
|
||||
const defaultSettings = {};
|
||||
const featureNames = [];
|
||||
for (const key of Object.keys(SETTINGS)) {
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue