{ _t('The default role for new room members is') }
-
+
{ _t('To send messages, you must be a') }
-
+
{ _t('To invite users into the room, you must be a') }
-
+
{ _t('To configure the room, you must be a') }
-
+
{ _t('To kick users, you must be a') }
-
+
{ _t('To ban users, you must be a') }
-
+
{ _t('To remove other users\' messages, you must be a') }
-
+
{ Object.keys(events_levels).map(function(event_type, i) {
@@ -944,7 +935,7 @@ module.exports = React.createClass({
return (
);
diff --git a/src/components/views/rooms/RoomTile.js b/src/components/views/rooms/RoomTile.js
index 90a763b6f1..8034dd0fa6 100644
--- a/src/components/views/rooms/RoomTile.js
+++ b/src/components/views/rooms/RoomTile.js
@@ -27,7 +27,6 @@ const ContextualMenu = require('../../structures/ContextualMenu');
const RoomNotifs = require('../../../RoomNotifs');
const FormattingUtils = require('../../../utils/FormattingUtils');
import AccessibleButton from '../elements/AccessibleButton';
-const UserSettingsStore = require('../../../UserSettingsStore');
import ActiveRoomObserver from '../../../ActiveRoomObserver';
import RoomViewStore from '../../../stores/RoomViewStore';
diff --git a/src/components/views/voip/VideoView.js b/src/components/views/voip/VideoView.js
index 748673f1a5..44e7a47f02 100644
--- a/src/components/views/voip/VideoView.js
+++ b/src/components/views/voip/VideoView.js
@@ -23,7 +23,7 @@ import classNames from 'classnames';
import sdk from '../../../index';
import dis from '../../../dispatcher';
-import UserSettingsStore from '../../../UserSettingsStore';
+import SettingsStore from "../../../settings/SettingsStore";
module.exports = React.createClass({
displayName: 'VideoView',
@@ -113,7 +113,7 @@ module.exports = React.createClass({
const maxVideoHeight = fullscreenElement ? null : this.props.maxHeight;
const localVideoFeedClasses = classNames("mx_VideoView_localVideoFeed",
{ "mx_VideoView_localVideoFeed_flipped":
- UserSettingsStore.getSyncedSetting('VideoView.flipVideoHorizontally', false),
+ SettingsStore.getValue('VideoView.flipVideoHorizontally'),
},
);
return (
diff --git a/src/i18n/strings/en_EN.json b/src/i18n/strings/en_EN.json
index 28ac9281f4..46646aca83 100644
--- a/src/i18n/strings/en_EN.json
+++ b/src/i18n/strings/en_EN.json
@@ -66,7 +66,7 @@
"This email address was not found": "This email address was not found",
"Your email address does not appear to be associated with a Matrix ID on this Homeserver.": "Your email address does not appear to be associated with a Matrix ID on this Homeserver.",
"Default": "Default",
- "User": "User",
+ "Restricted": "Restricted",
"Moderator": "Moderator",
"Admin": "Admin",
"Start a chat": "Start a chat",
@@ -154,6 +154,7 @@
"%(widgetName)s widget added by %(senderName)s": "%(widgetName)s widget added by %(senderName)s",
"%(widgetName)s widget removed by %(senderName)s": "%(widgetName)s widget removed by %(senderName)s",
"Message Pinning": "Message Pinning",
+ "Presence Management": "Presence Management",
"%(displayName)s is typing": "%(displayName)s is typing",
"%(names)s and %(count)s others are typing|other": "%(names)s and %(count)s others are typing",
"%(names)s and %(count)s others are typing|one": "%(names)s and one other is typing",
@@ -165,6 +166,11 @@
"Not a valid Riot keyfile": "Not a valid Riot keyfile",
"Authentication check failed: incorrect password?": "Authentication check failed: incorrect password?",
"Failed to join room": "Failed to join room",
+ "Hide avatar changes": "Hide avatar changes",
+ "Hide display name changes": "Hide display name changes",
+ "Enable inline URL previews by default": "Enable inline URL previews by default",
+ "Enable URL previews for this room (only affects you)": "Enable URL previews for this room (only affects you)",
+ "Enable URL previews by default for participants in this room": "Enable URL previews by default for participants in this room",
"Active call (%(roomName)s)": "Active call (%(roomName)s)",
"unknown caller": "unknown caller",
"Incoming voice call from %(name)s": "Incoming voice call from %(name)s",
@@ -205,6 +211,9 @@
"Delete": "Delete",
"Disable Notifications": "Disable Notifications",
"Enable Notifications": "Enable Notifications",
+ "You have
enabled URL previews by default.": "You have
enabled URL previews by default.",
+ "You have
disabled URL previews by default.": "You have
disabled URL previews by default.",
+ "URL Previews": "URL Previews",
"Cannot add any more widgets": "Cannot add any more widgets",
"The maximum permitted number of widgets have already been added to this room.": "The maximum permitted number of widgets have already been added to this room.",
"Add a widget": "Add a widget",
@@ -432,15 +441,6 @@
"Related communities for this room:": "Related communities for this room:",
"This room has no related communities": "This room has no related communities",
"New community ID (e.g. +foo:%(localDomain)s)": "New community ID (e.g. +foo:%(localDomain)s)",
- "Disable URL previews by default for participants in this room": "Disable URL previews by default for participants in this room",
- "URL previews are %(globalDisableUrlPreview)s by default for participants in this room.": "URL previews are %(globalDisableUrlPreview)s by default for participants in this room.",
- "disabled": "disabled",
- "enabled": "enabled",
- "You have
disabled URL previews by default.": "You have
disabled URL previews by default.",
- "You have
enabled URL previews by default.": "You have
enabled URL previews by default.",
- "URL Previews": "URL Previews",
- "Enable URL previews for this room (affects only you)": "Enable URL previews for this room (affects only you)",
- "Disable URL previews for this room (affects only you)": "Disable URL previews for this room (affects only you)",
"Error decrypting audio": "Error decrypting audio",
"Error decrypting attachment": "Error decrypting attachment",
"Decrypt %(text)s": "Decrypt %(text)s",
@@ -484,6 +484,7 @@
"Sign in with": "Sign in with",
"Email address": "Email address",
"Sign in": "Sign in",
+ "Sign in to get started": "Sign in to get started",
"If you don't specify an email address, you won't be able to reset your password. Are you sure?": "If you don't specify an email address, you won't be able to reset your password. Are you sure?",
"Email address (optional)": "Email address (optional)",
"You are registering with %(SelectedTeamName)s": "You are registering with %(SelectedTeamName)s",
@@ -583,6 +584,7 @@
"%(items)s and %(count)s others|other": "%(items)s and %(count)s others",
"%(items)s and %(count)s others|one": "%(items)s and one other",
"%(items)s and %(lastItem)s": "%(items)s and %(lastItem)s",
+ "Custom of %(powerLevel)s": "Custom of %(powerLevel)s",
"Custom level": "Custom level",
"Room directory": "Room directory",
"Start chat": "Start chat",
@@ -769,7 +771,6 @@
"Always show message timestamps": "Always show message timestamps",
"Show timestamps in 12 hour format (e.g. 2:30pm)": "Show timestamps in 12 hour format (e.g. 2:30pm)",
"Hide join/leave messages (invites/kicks/bans unaffected)": "Hide join/leave messages (invites/kicks/bans unaffected)",
- "Hide avatar and display name changes": "Hide avatar and display name changes",
"Use compact timeline layout": "Use compact timeline layout",
"Hide removed messages": "Hide removed messages",
"Enable automatic language detection for syntax highlighting": "Enable automatic language detection for syntax highlighting",
@@ -931,5 +932,8 @@
"This process allows you to import encryption keys that you had previously exported from another Matrix client. You will then be able to decrypt any messages that the other client could decrypt.": "This process allows you to import encryption keys that you had previously exported from another Matrix client. You will then be able to decrypt any messages that the other client could decrypt.",
"The export file will be protected with a passphrase. You should enter the passphrase here, to decrypt the file.": "The export file will be protected with a passphrase. You should enter the passphrase here, to decrypt the file.",
"File to import": "File to import",
- "Import": "Import"
+ "Import": "Import",
+ "Status.im theme": "Status.im theme",
+ "Please note you are logging into the %(hs)s server, not matrix.org.": "Please note you are logging into the %(hs)s server, not matrix.org.",
+ "Username on %(hs)s": "Username on %(hs)s"
}
diff --git a/src/languageHandler.js b/src/languageHandler.js
index da62bfee56..34b28e848f 100644
--- a/src/languageHandler.js
+++ b/src/languageHandler.js
@@ -19,8 +19,7 @@ import request from 'browser-request';
import counterpart from 'counterpart';
import Promise from 'bluebird';
import React from 'react';
-
-import UserSettingsStore from './UserSettingsStore';
+import SettingsStore, {SettingLevel} from "./settings/SettingsStore";
const i18nFolder = 'i18n/';
@@ -168,7 +167,7 @@ export function setLanguage(preferredLangs) {
}).then((langData) => {
counterpart.registerTranslations(langToUse, langData);
counterpart.setLocale(langToUse);
- UserSettingsStore.setLocalSetting('language', langToUse);
+ SettingsStore.setValue("language", null, SettingLevel.DEVICE, langToUse);
console.log("set language to " + langToUse);
// Set 'en' as fallback language:
diff --git a/src/settings/Settings.js b/src/settings/Settings.js
new file mode 100644
index 0000000000..bbd92abf01
--- /dev/null
+++ b/src/settings/Settings.js
@@ -0,0 +1,252 @@
+/*
+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';
+import {
+ AudioNotificationsEnabledController,
+ NotificationBodyEnabledController,
+ NotificationsEnabledController,
+} from "./controllers/NotificationControllers";
+
+
+// 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": {
+ // // Must be set to true for features. Default is 'false'.
+ // isFeature: false,
+ //
+ // // Display names are strongly recommended for clarity.
+ // displayName: _td("Cool Name"),
+ //
+ // // Display name can also be an object for different levels.
+ // //displayName: {
+ // // "device": _td("Name for when the setting is used at 'device'"),
+ // // "room": _td("Name for when the setting is used at 'room'"),
+ // // "default": _td("The name for all other levels"),
+ // //}
+ //
+ // // The supported levels are required. Preferably, use the preset arrays
+ // // at the top of this file to define this rather than a custom array.
+ // 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.
+ // ],
+ //
+ // // Required. Can be any data type. The value specified here should match
+ // // the data being stored (ie: if a boolean is used, the setting should
+ // // represent a boolean).
+ // default: {
+ // your: "value",
+ // },
+ //
+ // // Optional settings controller. See SettingsController for more information.
+ // controller: new MySettingController(),
+ //
+ // // Optional flag to make supportedLevels be respected as the order to handle
+ // // settings. The first element is treated as "most preferred". The "default"
+ // // level is always appended to the end.
+ // supportedLevelsAreOrdered: false,
+ // },
+ "feature_pinning": {
+ isFeature: true,
+ displayName: _td("Message Pinning"),
+ supportedLevels: LEVELS_FEATURE,
+ default: false,
+ },
+ "feature_presence_management": {
+ isFeature: true,
+ displayName: _td("Presence Management"),
+ supportedLevels: LEVELS_FEATURE,
+ default: false,
+ },
+ "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,
+ },
+ "hideAvatarChanges": {
+ supportedLevels: LEVELS_ROOM_SETTINGS_WITH_ROOM,
+ displayName: _td('Hide avatar changes'),
+ default: false,
+ },
+ "hideDisplaynameChanges": {
+ supportedLevels: LEVELS_ROOM_SETTINGS_WITH_ROOM,
+ displayName: _td('Hide 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,
+ default: null,
+ },
+ "webrtc_videoinput": {
+ supportedLevels: LEVELS_DEVICE_ONLY_SETTINGS,
+ default: null,
+ },
+ "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,
+ },
+ "blacklistUnverifiedDevices": {
+ // We specifically want to have room-device > device so that users may set a device default
+ // with a per-room override.
+ supportedLevels: ['room-device', 'device'],
+ supportedLevelsAreOrdered: true,
+ displayName: {
+ "default": _td('Never send encrypted messages to unverified devices from this device'),
+ "room-device": _td('Never send encrypted messages to unverified devices in this room 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,
+ },
+ "roomColor": {
+ supportedLevels: LEVELS_ROOM_SETTINGS_WITH_ROOM,
+ displayName: _td("Room Colour"),
+ default: {
+ primary_color: null, // Hex string, eg: #000000
+ secondary_color: null, // Hex string, eg: #000000
+ },
+ },
+ "notificationsEnabled": {
+ supportedLevels: LEVELS_DEVICE_ONLY_SETTINGS,
+ default: false,
+ controller: new NotificationsEnabledController(),
+ },
+ "notificationBodyEnabled": {
+ supportedLevels: LEVELS_DEVICE_ONLY_SETTINGS,
+ default: true,
+ controller: new NotificationBodyEnabledController(),
+ },
+ "audioNotificationsEnabled": {
+ supportedLevels: LEVELS_DEVICE_ONLY_SETTINGS,
+ default: true,
+ controller: new AudioNotificationsEnabledController(),
+ },
+};
diff --git a/src/settings/SettingsStore.js b/src/settings/SettingsStore.js
new file mode 100644
index 0000000000..b6343c4a96
--- /dev/null
+++ b/src/settings/SettingsStore.js
@@ -0,0 +1,347 @@
+/*
+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 DeviceSettingsHandler from "./handlers/DeviceSettingsHandler";
+import RoomDeviceSettingsHandler from "./handlers/RoomDeviceSettingsHandler";
+import DefaultSettingsHandler from "./handlers/DefaultSettingsHandler";
+import RoomAccountSettingsHandler from "./handlers/RoomAccountSettingsHandler";
+import AccountSettingsHandler from "./handlers/AccountSettingsHandler";
+import RoomSettingsHandler from "./handlers/RoomSettingsHandler";
+import ConfigSettingsHandler from "./handlers/ConfigSettingsHandler";
+import {_t} from '../languageHandler';
+import SdkConfig from "../SdkConfig";
+import {SETTINGS} from "./Settings";
+import LocalEchoWrapper from "./handlers/LocalEchoWrapper";
+
+/**
+ * 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 settings to easier to manage objects for the handlers
+const defaultSettings = {};
+const featureNames = [];
+for (const key of Object.keys(SETTINGS)) {
+ defaultSettings[key] = SETTINGS[key].default;
+ if (SETTINGS[key].isFeature) featureNames.push(key);
+}
+
+const LEVEL_HANDLERS = {
+ "device": new DeviceSettingsHandler(featureNames),
+ "room-device": new RoomDeviceSettingsHandler(),
+ "room-account": new RoomAccountSettingsHandler(),
+ "account": new AccountSettingsHandler(),
+ "room": new RoomSettingsHandler(),
+ "config": new ConfigSettingsHandler(),
+ "default": new DefaultSettingsHandler(defaultSettings),
+};
+
+// Wrap all the handlers with local echo
+for (const key of Object.keys(LEVEL_HANDLERS)) {
+ LEVEL_HANDLERS[key] = new LocalEchoWrapper(LEVEL_HANDLERS[key]);
+}
+
+const LEVEL_ORDER = [
+ 'device', 'room-device', 'room-account', 'account', 'room', 'config', 'default',
+];
+
+/**
+ * Controls and manages application settings by providing varying levels at which the
+ * setting value may be specified. The levels are then used to determine what the setting
+ * value should be given a set of circumstances. The levels, in priority order, are:
+ * - "device" - Values are determined by the current device
+ * - "room-device" - Values are determined by the current device for a particular room
+ * - "room-account" - Values are determined by the current account for a particular room
+ * - "account" - Values are determined by the current account
+ * - "room" - Values are determined by a particular room (by the room admins)
+ * - "config" - Values are determined by the config.json
+ * - "default" - Values are determined by the hardcoded defaults
+ *
+ * Each level has a different method to storing the setting value. For implementation
+ * specific details, please see the handlers. The "config" and "default" levels are
+ * both always supported on all platforms. All other settings should be guarded by
+ * isLevelSupported() prior to attempting to set the value.
+ *
+ * Settings can also represent features. Features are significant portions of the
+ * application that warrant a dedicated setting to toggle them on or off. Features are
+ * special-cased to ensure that their values respect the configuration (for example, a
+ * feature may be reported as disabled even though a user has specifically requested it
+ * be enabled).
+ */
+export default class SettingsStore {
+ /**
+ * Gets the translated display name for a given setting
+ * @param {string} settingName The setting to look up.
+ * @param {"device"|"room-device"|"room-account"|"account"|"room"|"config"|"default"} atLevel
+ * The level to get the display name for; Defaults to 'default'.
+ * @return {String} The display name for the setting, or null if not found.
+ */
+ static getDisplayName(settingName, atLevel = "default") {
+ if (!SETTINGS[settingName] || !SETTINGS[settingName].displayName) return null;
+
+ let displayName = SETTINGS[settingName].displayName;
+ if (displayName instanceof Object) {
+ if (displayName[atLevel]) displayName = displayName[atLevel];
+ else displayName = displayName["default"];
+ }
+
+ return _t(displayName);
+ }
+
+ /**
+ * Returns a list of all available labs feature names
+ * @returns {string[]} The list of available feature names
+ */
+ static getLabsFeatures() {
+ const possibleFeatures = Object.keys(SETTINGS).filter((s) => SettingsStore.isFeature(s));
+
+ const enableLabs = SdkConfig.get()["enableLabs"];
+ if (enableLabs) return possibleFeatures;
+
+ return possibleFeatures.filter((s) => SettingsStore._getFeatureState(s) === "labs");
+ }
+
+ /**
+ * Determines if a setting is also a feature.
+ * @param {string} settingName The setting to look up.
+ * @return {boolean} True if the setting is a feature.
+ */
+ static isFeature(settingName) {
+ if (!SETTINGS[settingName]) return false;
+ return SETTINGS[settingName].isFeature;
+ }
+
+ /**
+ * Determines if a given feature is enabled. The feature given must be a known
+ * feature.
+ * @param {string} settingName The name of the setting that is a feature.
+ * @param {String} roomId The optional room ID to validate in, may be null.
+ * @return {boolean} True if the feature is enabled, false otherwise
+ */
+ static isFeatureEnabled(settingName, roomId = null) {
+ if (!SettingsStore.isFeature(settingName)) {
+ throw new Error("Setting " + settingName + " is not a feature");
+ }
+
+ return SettingsStore.getValue(settingName, roomId);
+ }
+
+ /**
+ * Sets a feature as enabled or disabled on the current device.
+ * @param {string} settingName The name of the setting.
+ * @param {boolean} value True to enable the feature, false otherwise.
+ * @returns {Promise} Resolves when the setting has been set.
+ */
+ static setFeatureEnabled(settingName, value) {
+ // Verify that the setting is actually a setting
+ if (!SETTINGS[settingName]) {
+ throw new Error("Setting '" + settingName + "' does not appear to be a setting.");
+ }
+ if (!SettingsStore.isFeature(settingName)) {
+ throw new Error("Setting " + settingName + " is not a feature");
+ }
+
+ return SettingsStore.setValue(settingName, null, "device", value);
+ }
+
+ /**
+ * Gets the value of a setting. The room ID is optional if the setting is not to
+ * be applied to any particular room, otherwise it should be supplied.
+ * @param {string} settingName The name of the setting to read the value of.
+ * @param {String} roomId The room ID to read the setting value in, may be null.
+ * @param {boolean} excludeDefault True to disable using the default value.
+ * @return {*} The value, or null if not found
+ */
+ static getValue(settingName, roomId = null, excludeDefault = false) {
+ return SettingsStore.getValueAt(LEVEL_ORDER[0], settingName, roomId, false, excludeDefault);
+ }
+
+ /**
+ * Gets a setting's value at a particular level, ignoring all levels that are more specific.
+ * @param {"device"|"room-device"|"room-account"|"account"|"room"} level The level to
+ * look at.
+ * @param {string} settingName The name of the setting to read.
+ * @param {String} roomId The room ID to read the setting value in, may be null.
+ * @param {boolean} explicit If true, this method will not consider other levels, just the one
+ * provided. Defaults to false.
+ * @param {boolean} excludeDefault True to disable using the default value.
+ * @return {*} The value, or null if not found.
+ */
+ static getValueAt(level, settingName, roomId = null, explicit = false, excludeDefault = false) {
+ // Verify that the setting is actually a setting
+ if (!SETTINGS[settingName]) {
+ throw new Error("Setting '" + settingName + "' does not appear to be a setting.");
+ }
+
+ const setting = SETTINGS[settingName];
+ const levelOrder = (setting.supportedLevelsAreOrdered ? setting.supportedLevels : LEVEL_ORDER);
+ if (!levelOrder.includes("default")) levelOrder.push("default"); // always include default
+
+ const minIndex = levelOrder.indexOf(level);
+ if (minIndex === -1) throw new Error("Level " + level + " is not prioritized");
+
+ if (SettingsStore.isFeature(settingName)) {
+ const configValue = SettingsStore._getFeatureState(settingName);
+ if (configValue === "enable") return true;
+ if (configValue === "disable") return false;
+ // else let it fall through the default process
+ }
+
+ const handlers = SettingsStore._getHandlers(settingName);
+
+ if (explicit) {
+ const handler = handlers[level];
+ if (!handler) return SettingsStore._tryControllerOverride(settingName, level, roomId, null);
+ const value = handler.getValue(settingName, roomId);
+ return SettingsStore._tryControllerOverride(settingName, level, roomId, value);
+ }
+
+ for (let i = minIndex; i < levelOrder.length; i++) {
+ const handler = handlers[levelOrder[i]];
+ if (!handler) continue;
+ if (excludeDefault && levelOrder[i] === "default") continue;
+
+ const value = handler.getValue(settingName, roomId);
+ if (value === null || value === undefined) continue;
+ return SettingsStore._tryControllerOverride(settingName, level, roomId, value);
+ }
+
+ return SettingsStore._tryControllerOverride(settingName, level, roomId, null);
+ }
+
+ static _tryControllerOverride(settingName, level, roomId, calculatedValue) {
+ const controller = SETTINGS[settingName].controller;
+ if (!controller) return calculatedValue;
+
+ const actualValue = controller.getValueOverride(level, roomId, calculatedValue);
+ if (actualValue !== undefined && actualValue !== null) return actualValue;
+ return calculatedValue;
+ }
+
+ /**
+ * Sets the value for a setting. The room ID is optional if the setting is not being
+ * set for a particular room, otherwise it should be supplied. The value may be null
+ * to indicate that the level should no longer have an override.
+ * @param {string} settingName The name of the setting to change.
+ * @param {String} roomId The room ID to change the value in, may be null.
+ * @param {"device"|"room-device"|"room-account"|"account"|"room"} level The level
+ * to change the value at.
+ * @param {*} value The new value of the setting, may be null.
+ * @return {Promise} Resolves when the setting has been changed.
+ */
+ static setValue(settingName, roomId, level, value) {
+ // Verify that the setting is actually a setting
+ if (!SETTINGS[settingName]) {
+ throw new Error("Setting '" + settingName + "' does not appear to be a setting.");
+ }
+
+ const handler = SettingsStore._getHandler(settingName, level);
+ if (!handler) {
+ throw new Error("Setting " + settingName + " does not have a handler for " + level);
+ }
+
+ if (!handler.canSetValue(settingName, roomId)) {
+ throw new Error("User cannot set " + settingName + " at " + level + " in " + roomId);
+ }
+
+ return handler.setValue(settingName, roomId, value).then(() => {
+ const controller = SETTINGS[settingName].controller;
+ if (!controller) return;
+ controller.onChange(level, roomId, value);
+ });
+ }
+
+ /**
+ * Determines if the current user is permitted to set the given setting at the given
+ * level for a particular room. The room ID is optional if the setting is not being
+ * set for a particular room, otherwise it should be supplied.
+ * @param {string} settingName The name of the setting to check.
+ * @param {String} roomId The room ID to check in, may be null.
+ * @param {"device"|"room-device"|"room-account"|"account"|"room"} level The level to
+ * check at.
+ * @return {boolean} True if the user may set the setting, false otherwise.
+ */
+ static canSetValue(settingName, roomId, level) {
+ // Verify that the setting is actually a setting
+ if (!SETTINGS[settingName]) {
+ throw new Error("Setting '" + settingName + "' does not appear to be a setting.");
+ }
+
+ const handler = SettingsStore._getHandler(settingName, level);
+ if (!handler) return false;
+ return handler.canSetValue(settingName, roomId);
+ }
+
+ /**
+ * Determines if the given level is supported on this device.
+ * @param {"device"|"room-device"|"room-account"|"account"|"room"} level The level
+ * to check the feasibility of.
+ * @return {boolean} True if the level is supported, false otherwise.
+ */
+ static isLevelSupported(level) {
+ if (!LEVEL_HANDLERS[level]) return false;
+ return LEVEL_HANDLERS[level].isSupported();
+ }
+
+ static _getHandler(settingName, level) {
+ const handlers = SettingsStore._getHandlers(settingName);
+ if (!handlers[level]) return null;
+ return handlers[level];
+ }
+
+ static _getHandlers(settingName) {
+ if (!SETTINGS[settingName]) return {};
+
+ const handlers = {};
+ for (const level of SETTINGS[settingName].supportedLevels) {
+ if (!LEVEL_HANDLERS[level]) throw new Error("Unexpected level " + level);
+ handlers[level] = LEVEL_HANDLERS[level];
+ }
+
+ // Always support 'default'
+ if (!handlers['default']) handlers['default'] = LEVEL_HANDLERS['default'];
+
+ return handlers;
+ }
+
+ static _getFeatureState(settingName) {
+ const featuresConfig = SdkConfig.get()['features'];
+ const enableLabs = SdkConfig.get()['enableLabs']; // we'll honour the old flag
+
+ let featureState = enableLabs ? "labs" : "disable";
+ if (featuresConfig && featuresConfig[settingName] !== undefined) {
+ featureState = featuresConfig[settingName];
+ }
+
+ const allowedStates = ['enable', 'disable', 'labs'];
+ if (!allowedStates.includes(featureState)) {
+ console.warn("Feature state '" + featureState + "' is invalid for " + settingName);
+ featureState = "disable"; // to prevent accidental features.
+ }
+
+ return featureState;
+ }
+}
diff --git a/src/settings/controllers/NotificationControllers.js b/src/settings/controllers/NotificationControllers.js
new file mode 100644
index 0000000000..261e194d74
--- /dev/null
+++ b/src/settings/controllers/NotificationControllers.js
@@ -0,0 +1,49 @@
+/*
+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 SettingController from "./SettingController";
+
+export class NotificationsEnabledController extends SettingController {
+ getValueOverride(level, roomId, calculatedValue) {
+ const Notifier = require('../../Notifier'); // avoids cyclical references
+
+ return calculatedValue && Notifier.isPossible();
+ }
+
+ onChange(level, roomId, newValue) {
+ const Notifier = require('../../Notifier'); // avoids cyclical references
+
+ if (Notifier.supportsDesktopNotifications()) {
+ Notifier.setEnabled(newValue);
+ }
+ }
+}
+
+export class NotificationBodyEnabledController extends SettingController {
+ getValueOverride(level, roomId, calculatedValue) {
+ const Notifier = require('../../Notifier'); // avoids cyclical references
+
+ return calculatedValue && Notifier.isEnabled();
+ }
+}
+
+export class AudioNotificationsEnabledController extends SettingController {
+ getValueOverride(level, roomId, calculatedValue) {
+ const Notifier = require('../../Notifier'); // avoids cyclical references
+
+ return calculatedValue && Notifier.isEnabled();
+ }
+}
diff --git a/src/settings/controllers/SettingController.js b/src/settings/controllers/SettingController.js
new file mode 100644
index 0000000000..a91b616da9
--- /dev/null
+++ b/src/settings/controllers/SettingController.js
@@ -0,0 +1,49 @@
+/*
+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.
+*/
+
+/**
+ * Represents a controller for individual settings to alter the reading behaviour
+ * based upon environmental conditions, or to react to changes and therefore update
+ * the working environment.
+ *
+ * This is not intended to replace the functionality of a SettingsHandler, it is only
+ * intended to handle environmental factors for specific settings.
+ */
+export default class SettingController {
+
+ /**
+ * Gets the overridden value for the setting, if any. This must return null if the
+ * value is not to be overridden, otherwise it must return the new value.
+ * @param {string} level The level at which the value was requested at.
+ * @param {String} roomId The room ID, may be null.
+ * @param {*} calculatedValue The value that the handlers think the setting should be,
+ * may be null.
+ * @return {*} The value that should be used, or null if no override is applicable.
+ */
+ getValueOverride(level, roomId, calculatedValue) {
+ return null; // no override
+ }
+
+ /**
+ * Called when the setting value has been changed.
+ * @param {string} level The level at which the setting has been modified.
+ * @param {String} roomId The room ID, may be null.
+ * @param {*} newValue The new value for the setting, may be null.
+ */
+ onChange(level, roomId, newValue) {
+ // do nothing by default
+ }
+}
diff --git a/src/settings/handlers/AccountSettingsHandler.js b/src/settings/handlers/AccountSettingsHandler.js
new file mode 100644
index 0000000000..fe0ad2a500
--- /dev/null
+++ b/src/settings/handlers/AccountSettingsHandler.js
@@ -0,0 +1,73 @@
+/*
+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 SettingsHandler from "./SettingsHandler";
+import MatrixClientPeg from '../../MatrixClientPeg';
+
+/**
+ * Gets and sets settings at the "account" level for the current user.
+ * This handler does not make use of the roomId parameter.
+ */
+export default class AccountSettingHandler extends SettingsHandler {
+ getValue(settingName, roomId) {
+ // Special case URL previews
+ if (settingName === "urlPreviewsEnabled") {
+ const content = this._getSettings("org.matrix.preview_urls");
+ return !content['disable'];
+ }
+
+ let preferredValue = this._getSettings()[settingName];
+
+ if (preferredValue === null || preferredValue === undefined) {
+ // Honour the old setting on read only
+ if (settingName === "hideAvatarChanges" || settingName === "hideDisplaynameChanges") {
+ preferredValue = this._getSettings()["hideAvatarDisplaynameChanges"];
+ }
+ }
+
+ return preferredValue;
+ }
+
+ setValue(settingName, roomId, newValue) {
+ // Special case URL previews
+ if (settingName === "urlPreviewsEnabled") {
+ const content = this._getSettings("org.matrix.preview_urls");
+ content['disable'] = !newValue;
+ return MatrixClientPeg.get().setAccountData("org.matrix.preview_urls", content);
+ }
+
+ const content = this._getSettings();
+ content[settingName] = newValue;
+ return MatrixClientPeg.get().setAccountData("im.vector.web.settings", content);
+ }
+
+ canSetValue(settingName, roomId) {
+ return true; // It's their account, so they should be able to
+ }
+
+ isSupported() {
+ const cli = MatrixClientPeg.get();
+ return cli !== undefined && cli !== null;
+ }
+
+ _getSettings(eventType = "im.vector.web.settings") {
+ const cli = MatrixClientPeg.get();
+ if (!cli) return {};
+ const event = cli.getAccountData(eventType);
+ if (!event || !event.getContent()) return {};
+ return event.getContent();
+ }
+}
diff --git a/src/settings/handlers/ConfigSettingsHandler.js b/src/settings/handlers/ConfigSettingsHandler.js
new file mode 100644
index 0000000000..7a370249a7
--- /dev/null
+++ b/src/settings/handlers/ConfigSettingsHandler.js
@@ -0,0 +1,49 @@
+/*
+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 SettingsHandler from "./SettingsHandler";
+import SdkConfig from "../../SdkConfig";
+
+/**
+ * Gets and sets settings at the "config" level. This handler does not make use of the
+ * roomId parameter.
+ */
+export default class ConfigSettingsHandler extends SettingsHandler {
+ getValue(settingName, roomId) {
+ const config = SdkConfig.get() || {};
+
+ // Special case themes
+ if (settingName === "theme") {
+ return config["default_theme"];
+ }
+
+ const settingsConfig = config["settingDefaults"];
+ if (!settingsConfig || !settingsConfig[settingName]) return null;
+ return settingsConfig[settingName];
+ }
+
+ setValue(settingName, roomId, newValue) {
+ throw new Error("Cannot change settings at the config level");
+ }
+
+ canSetValue(settingName, roomId) {
+ return false;
+ }
+
+ isSupported() {
+ return true; // SdkConfig is always there
+ }
+}
diff --git a/src/settings/handlers/DefaultSettingsHandler.js b/src/settings/handlers/DefaultSettingsHandler.js
new file mode 100644
index 0000000000..cf2e660411
--- /dev/null
+++ b/src/settings/handlers/DefaultSettingsHandler.js
@@ -0,0 +1,48 @@
+/*
+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 SettingsHandler from "./SettingsHandler";
+
+/**
+ * Gets settings at the "default" level. This handler does not support setting values.
+ * This handler does not make use of the roomId parameter.
+ */
+export default class DefaultSettingsHandler extends SettingsHandler {
+ /**
+ * Creates a new default settings handler with the given defaults
+ * @param {object} defaults The default setting values, keyed by setting name.
+ */
+ constructor(defaults) {
+ super();
+ this._defaults = defaults;
+ }
+
+ getValue(settingName, roomId) {
+ return this._defaults[settingName];
+ }
+
+ setValue(settingName, roomId, newValue) {
+ throw new Error("Cannot set values on the default level handler");
+ }
+
+ canSetValue(settingName, roomId) {
+ return false;
+ }
+
+ isSupported() {
+ return true;
+ }
+}
diff --git a/src/settings/handlers/DeviceSettingsHandler.js b/src/settings/handlers/DeviceSettingsHandler.js
new file mode 100644
index 0000000000..7b5ec6a5dd
--- /dev/null
+++ b/src/settings/handlers/DeviceSettingsHandler.js
@@ -0,0 +1,108 @@
+/*
+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 Promise from 'bluebird';
+import SettingsHandler from "./SettingsHandler";
+import MatrixClientPeg from "../../MatrixClientPeg";
+
+/**
+ * Gets and sets settings at the "device" level for the current device.
+ * This handler does not make use of the roomId parameter. This handler
+ * will special-case features to support legacy settings.
+ */
+export default class DeviceSettingsHandler extends SettingsHandler {
+ /**
+ * Creates a new device settings handler
+ * @param {string[]} featureNames The names of known features.
+ */
+ constructor(featureNames) {
+ super();
+ this._featureNames = featureNames;
+ }
+
+ getValue(settingName, roomId) {
+ if (this._featureNames.includes(settingName)) {
+ return this._readFeature(settingName);
+ }
+
+ // Special case notifications
+ if (settingName === "notificationsEnabled") {
+ return localStorage.getItem("notifications_enabled") === "true";
+ } else if (settingName === "notificationBodyEnabled") {
+ return localStorage.getItem("notifications_body_enabled") === "true";
+ } else if (settingName === "audioNotificationsEnabled") {
+ return localStorage.getItem("audio_notifications_enabled") === "true";
+ }
+
+ return this._getSettings()[settingName];
+ }
+
+ setValue(settingName, roomId, newValue) {
+ if (this._featureNames.includes(settingName)) {
+ this._writeFeature(settingName, newValue);
+ return Promise.resolve();
+ }
+
+ // Special case notifications
+ if (settingName === "notificationsEnabled") {
+ localStorage.setItem("notifications_enabled", newValue);
+ return Promise.resolve();
+ } else if (settingName === "notificationBodyEnabled") {
+ localStorage.setItem("notifications_body_enabled", newValue);
+ return Promise.resolve();
+ } else if (settingName === "audioNotificationsEnabled") {
+ localStorage.setItem("audio_notifications_enabled", newValue);
+ return Promise.resolve();
+ }
+
+ const settings = this._getSettings();
+ settings[settingName] = newValue;
+ localStorage.setItem("mx_local_settings", JSON.stringify(settings));
+
+ return Promise.resolve();
+ }
+
+ canSetValue(settingName, roomId) {
+ return true; // It's their device, so they should be able to
+ }
+
+ isSupported() {
+ return localStorage !== undefined && localStorage !== null;
+ }
+
+ _getSettings() {
+ const value = localStorage.getItem("mx_local_settings");
+ if (!value) return {};
+ return JSON.parse(value);
+ }
+
+ // Note: features intentionally don't use the same key as settings to avoid conflicts
+ // and to be backwards compatible.
+
+ _readFeature(featureName) {
+ if (MatrixClientPeg.get() && MatrixClientPeg.get().isGuest()) {
+ // Guests should not have any labs features enabled.
+ return {enabled: false};
+ }
+
+ const value = localStorage.getItem("mx_labs_feature_" + featureName);
+ return value === "true";
+ }
+
+ _writeFeature(featureName, enabled) {
+ localStorage.setItem("mx_labs_feature_" + featureName, enabled);
+ }
+}
diff --git a/src/settings/handlers/LocalEchoWrapper.js b/src/settings/handlers/LocalEchoWrapper.js
new file mode 100644
index 0000000000..d616edd9fb
--- /dev/null
+++ b/src/settings/handlers/LocalEchoWrapper.js
@@ -0,0 +1,69 @@
+/*
+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 Promise from "bluebird";
+import SettingsHandler from "./SettingsHandler";
+
+/**
+ * A wrapper for a SettingsHandler that performs local echo on
+ * changes to settings. This wrapper will use the underlying
+ * handler as much as possible to ensure values are not stale.
+ */
+export default class LocalEchoWrapper extends SettingsHandler {
+ /**
+ * Creates a new local echo wrapper
+ * @param {SettingsHandler} handler The handler to wrap
+ */
+ constructor(handler) {
+ super();
+ this._handler = handler;
+ this._cache = {
+ // settingName: { roomId: value }
+ };
+ }
+
+ getValue(settingName, roomId) {
+ const cacheRoomId = roomId ? roomId : "UNDEFINED"; // avoid weird keys
+ const bySetting = this._cache[settingName];
+ if (bySetting && bySetting.hasOwnProperty(cacheRoomId)) {
+ return bySetting[roomId];
+ }
+
+ return this._handler.getValue(settingName, roomId);
+ }
+
+ setValue(settingName, roomId, newValue) {
+ if (!this._cache[settingName]) this._cache[settingName] = {};
+ const bySetting = this._cache[settingName];
+
+ const cacheRoomId = roomId ? roomId : "UNDEFINED"; // avoid weird keys
+ bySetting[cacheRoomId] = newValue;
+
+ const handlerPromise = this._handler.setValue(settingName, roomId, newValue);
+ return Promise.resolve(handlerPromise).finally(() => {
+ delete bySetting[cacheRoomId];
+ });
+ }
+
+
+ canSetValue(settingName, roomId) {
+ return this._handler.canSetValue(settingName, roomId);
+ }
+
+ isSupported() {
+ return this._handler.isSupported();
+ }
+}
diff --git a/src/settings/handlers/RoomAccountSettingsHandler.js b/src/settings/handlers/RoomAccountSettingsHandler.js
new file mode 100644
index 0000000000..503d5de6c4
--- /dev/null
+++ b/src/settings/handlers/RoomAccountSettingsHandler.js
@@ -0,0 +1,80 @@
+/*
+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 SettingsHandler from "./SettingsHandler";
+import MatrixClientPeg from '../../MatrixClientPeg';
+
+/**
+ * Gets and sets settings at the "room-account" level for the current user.
+ */
+export default class RoomAccountSettingsHandler extends SettingsHandler {
+ getValue(settingName, roomId) {
+ // Special case URL previews
+ if (settingName === "urlPreviewsEnabled") {
+ const content = this._getSettings(roomId, "org.matrix.room.preview_urls");
+ return !content['disable'];
+ }
+
+ // Special case room color
+ if (settingName === "roomColor") {
+ // The event content should already be in an appropriate format, we just need
+ // to get the right value.
+ return this._getSettings(roomId, "org.matrix.room.color_scheme");
+ }
+
+ return this._getSettings(roomId)[settingName];
+ }
+
+ setValue(settingName, roomId, newValue) {
+ // Special case URL previews
+ if (settingName === "urlPreviewsEnabled") {
+ const content = this._getSettings(roomId, "org.matrix.room.preview_urls");
+ content['disable'] = !newValue;
+ return MatrixClientPeg.get().setRoomAccountData(roomId, "org.matrix.room.preview_urls", content);
+ }
+
+ // Special case room color
+ if (settingName === "roomColor") {
+ // The new value should match our requirements, we just need to store it in the right place.
+ return MatrixClientPeg.get().setRoomAccountData(roomId, "org.matrix.room.color_scheme", newValue);
+ }
+
+ const content = this._getSettings(roomId);
+ content[settingName] = newValue;
+ return MatrixClientPeg.get().setRoomAccountData(roomId, "im.vector.web.settings", content);
+ }
+
+ canSetValue(settingName, roomId) {
+ const room = MatrixClientPeg.get().getRoom(roomId);
+
+ // If they have the room, they can set their own account data
+ return room !== undefined && room !== null;
+ }
+
+ isSupported() {
+ const cli = MatrixClientPeg.get();
+ return cli !== undefined && cli !== null;
+ }
+
+ _getSettings(roomId, eventType = "im.vector.settings") {
+ const room = MatrixClientPeg.get().getRoom(roomId);
+ if (!room) return {};
+
+ const event = room.getAccountData(eventType);
+ if (!event || !event.getContent()) return {};
+ return event.getContent();
+ }
+}
diff --git a/src/settings/handlers/RoomDeviceSettingsHandler.js b/src/settings/handlers/RoomDeviceSettingsHandler.js
new file mode 100644
index 0000000000..186be3041f
--- /dev/null
+++ b/src/settings/handlers/RoomDeviceSettingsHandler.js
@@ -0,0 +1,77 @@
+/*
+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 Promise from 'bluebird';
+import SettingsHandler from "./SettingsHandler";
+
+/**
+ * Gets and sets settings at the "room-device" level for the current device in a particular
+ * room.
+ */
+export default class RoomDeviceSettingsHandler extends SettingsHandler {
+ getValue(settingName, roomId) {
+ // Special case blacklist setting to use legacy values
+ if (settingName === "blacklistUnverifiedDevices") {
+ const value = this._read("mx_local_settings");
+ if (value && value['blacklistUnverifiedDevicesPerRoom']) {
+ return value['blacklistUnverifiedDevicesPerRoom'][roomId];
+ }
+ }
+
+ const value = this._read(this._getKey(settingName, roomId));
+ if (value) return value.value;
+ return null;
+ }
+
+ setValue(settingName, roomId, newValue) {
+ // Special case blacklist setting for legacy structure
+ if (settingName === "blacklistUnverifiedDevices") {
+ let value = this._read("mx_local_settings");
+ if (!value) value = {};
+ if (!value["blacklistUnverifiedDevicesPerRoom"]) value["blacklistUnverifiedDevicesPerRoom"] = {};
+ value["blacklistUnverifiedDevicesPerRoom"][roomId] = newValue;
+ localStorage.setItem("mx_local_settings", JSON.stringify(value));
+ return Promise.resolve();
+ }
+
+ if (newValue === null) {
+ localStorage.removeItem(this._getKey(settingName, roomId));
+ } else {
+ newValue = JSON.stringify({value: newValue});
+ localStorage.setItem(this._getKey(settingName, roomId), newValue);
+ }
+
+ return Promise.resolve();
+ }
+
+ canSetValue(settingName, roomId) {
+ return true; // It's their device, so they should be able to
+ }
+
+ isSupported() {
+ return localStorage !== undefined && localStorage !== null;
+ }
+
+ _read(key) {
+ const rawValue = localStorage.getItem(key);
+ if (!rawValue) return null;
+ return JSON.parse(rawValue);
+ }
+
+ _getKey(settingName, roomId) {
+ return "mx_setting_" + settingName + "_" + roomId;
+ }
+}
diff --git a/src/settings/handlers/RoomSettingsHandler.js b/src/settings/handlers/RoomSettingsHandler.js
new file mode 100644
index 0000000000..3aee0dd6eb
--- /dev/null
+++ b/src/settings/handlers/RoomSettingsHandler.js
@@ -0,0 +1,70 @@
+/*
+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 SettingsHandler from "./SettingsHandler";
+import MatrixClientPeg from '../../MatrixClientPeg';
+
+/**
+ * Gets and sets settings at the "room" level.
+ */
+export default class RoomSettingsHandler extends SettingsHandler {
+ getValue(settingName, roomId) {
+ // Special case URL previews
+ if (settingName === "urlPreviewsEnabled") {
+ const content = this._getSettings(roomId, "org.matrix.room.preview_urls");
+ return !content['disable'];
+ }
+
+ return this._getSettings(roomId)[settingName];
+ }
+
+ setValue(settingName, roomId, newValue) {
+ // Special case URL previews
+ if (settingName === "urlPreviewsEnabled") {
+ const content = this._getSettings(roomId, "org.matrix.room.preview_urls");
+ content['disable'] = !newValue;
+ return MatrixClientPeg.get().sendStateEvent(roomId, "org.matrix.room.preview_urls", content);
+ }
+
+ const content = this._getSettings(roomId);
+ content[settingName] = newValue;
+ return MatrixClientPeg.get().sendStateEvent(roomId, "im.vector.web.settings", content, "");
+ }
+
+ canSetValue(settingName, roomId) {
+ const cli = MatrixClientPeg.get();
+ const room = cli.getRoom(roomId);
+
+ let eventType = "im.vector.web.settings";
+ if (settingName === "urlPreviewsEnabled") eventType = "org.matrix.room.preview_urls";
+
+ if (!room) return false;
+ return room.currentState.maySendStateEvent(eventType, cli.getUserId());
+ }
+
+ isSupported() {
+ const cli = MatrixClientPeg.get();
+ return cli !== undefined && cli !== null;
+ }
+
+ _getSettings(roomId, eventType = "im.vector.web.settings") {
+ const room = MatrixClientPeg.get().getRoom(roomId);
+ if (!room) return {};
+ const event = room.currentState.getStateEvents(eventType, "");
+ if (!event || !event.getContent()) return {};
+ return event.getContent();
+ }
+}
diff --git a/src/settings/handlers/SettingsHandler.js b/src/settings/handlers/SettingsHandler.js
new file mode 100644
index 0000000000..69f633c650
--- /dev/null
+++ b/src/settings/handlers/SettingsHandler.js
@@ -0,0 +1,71 @@
+/*
+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 Promise from "bluebird";
+
+/**
+ * Represents the base class for all level handlers. This class performs no logic
+ * and should be overridden.
+ */
+export default class SettingsHandler {
+ /**
+ * Gets the value for a particular setting at this level for a particular room.
+ * If no room is applicable, the roomId may be null. The roomId may not be
+ * applicable to this level and may be ignored by the handler.
+ * @param {string} settingName The name of the setting.
+ * @param {String} roomId The room ID to read from, may be null.
+ * @returns {*} The setting value, or null if not found.
+ */
+ getValue(settingName, roomId) {
+ console.error("Invalid operation: getValue was not overridden");
+ return null;
+ }
+
+ /**
+ * Sets the value for a particular setting at this level for a particular room.
+ * If no room is applicable, the roomId may be null. The roomId may not be
+ * applicable to this level and may be ignored by the handler. Setting a value
+ * to null will cause the level to remove the value. The current user should be
+ * able to set the value prior to calling this.
+ * @param {string} settingName The name of the setting to change.
+ * @param {String} roomId The room ID to set the value in, may be null.
+ * @param {*} newValue The new value for the setting, may be null.
+ * @returns {Promise} Resolves when the setting has been saved.
+ */
+ setValue(settingName, roomId, newValue) {
+ console.error("Invalid operation: setValue was not overridden");
+ return Promise.reject();
+ }
+
+ /**
+ * Determines if the current user is able to set the value of the given setting
+ * in the given room at this level.
+ * @param {string} settingName The name of the setting to check.
+ * @param {String} roomId The room ID to check in, may be null
+ * @returns {boolean} True if the setting can be set by the user, false otherwise.
+ */
+ canSetValue(settingName, roomId) {
+ return false;
+ }
+
+ /**
+ * Determines if this level is supported on this device.
+ * @returns {boolean} True if this level is supported on the current device.
+ */
+ isSupported() {
+ return false;
+ }
+}
diff --git a/src/shouldHideEvent.js b/src/shouldHideEvent.js
index 1501e28875..1ecd1ac051 100644
--- a/src/shouldHideEvent.js
+++ b/src/shouldHideEvent.js
@@ -14,6 +14,8 @@
limitations under the License.
*/
+import SettingsStore from "./settings/SettingsStore";
+
function memberEventDiff(ev) {
const diff = {
isMemberEvent: ev.getType() === 'm.room.member',
@@ -34,16 +36,19 @@ function memberEventDiff(ev) {
return diff;
}
-export default function shouldHideEvent(ev, syncedSettings) {
+export default function shouldHideEvent(ev) {
+ // Wrap getValue() for readability
+ const isEnabled = (name) => SettingsStore.getValue(name, ev.getRoomId());
+
// Hide redacted events
- if (syncedSettings['hideRedactions'] && ev.isRedacted()) return true;
+ if (isEnabled('hideRedactions') && ev.isRedacted()) return true;
const eventDiff = memberEventDiff(ev);
if (eventDiff.isMemberEvent) {
- if (syncedSettings['hideJoinLeaves'] && (eventDiff.isJoin || eventDiff.isPart)) return true;
- const isMemberAvatarDisplaynameChange = eventDiff.isAvatarChange || eventDiff.isDisplaynameChange;
- if (syncedSettings['hideAvatarDisplaynameChanges'] && isMemberAvatarDisplaynameChange) return true;
+ if (isEnabled('hideJoinLeaves') && (eventDiff.isJoin || eventDiff.isPart)) return true;
+ if (isEnabled('hideAvatarChanges') && eventDiff.isAvatarChange) return true;
+ if (isEnabled('hideDisplaynameChanges') && eventDiff.isDisplaynameChange) return true;
}
return false;
diff --git a/test/components/structures/MessagePanel-test.js b/test/components/structures/MessagePanel-test.js
index 4de3b7626d..e7176e2c16 100644
--- a/test/components/structures/MessagePanel-test.js
+++ b/test/components/structures/MessagePanel-test.js
@@ -14,6 +14,8 @@ See the License for the specific language governing permissions and
limitations under the License.
*/
+import SettingsStore from "../../../src/settings/SettingsStore";
+
const React = require('react');
const ReactDOM = require("react-dom");
const TestUtils = require('react-addons-test-utils');
@@ -23,7 +25,6 @@ import sinon from 'sinon';
const sdk = require('matrix-react-sdk');
const MessagePanel = sdk.getComponent('structures.MessagePanel');
-import UserSettingsStore from '../../../src/UserSettingsStore';
import MatrixClientPeg from '../../../src/MatrixClientPeg';
const test_utils = require('test-utils');
@@ -59,7 +60,9 @@ describe('MessagePanel', function() {
sandbox = test_utils.stubClient();
client = MatrixClientPeg.get();
client.credentials = {userId: '@me:here'};
- UserSettingsStore.getSyncedSettings = sinon.stub().returns({});
+
+ // HACK: We assume all settings want to be disabled
+ SettingsStore.getValue = sinon.stub().returns(false);
});
afterEach(function() {
diff --git a/test/components/views/rooms/MessageComposerInput-test.js b/test/components/views/rooms/MessageComposerInput-test.js
index faf3f0f804..1f0ede6ae2 100644
--- a/test/components/views/rooms/MessageComposerInput-test.js
+++ b/test/components/views/rooms/MessageComposerInput-test.js
@@ -6,7 +6,6 @@ import sinon from 'sinon';
import Promise from 'bluebird';
import * as testUtils from '../../../test-utils';
import sdk from 'matrix-react-sdk';
-import UserSettingsStore from '../../../../src/UserSettingsStore';
const MessageComposerInput = sdk.getComponent('views.rooms.MessageComposerInput');
import MatrixClientPeg from '../../../../src/MatrixClientPeg';
import RoomMember from 'matrix-js-sdk';
should be a 'controlled' form element and updated by React
// to reflect the current value, rather than left freeform.
@@ -43,78 +45,98 @@ module.exports = React.createClass({
getInitialState: function() {
return {
- custom: (LEVEL_ROLE_MAP[this.props.value] === undefined),
+ levelRoleMap: {},
+ // List of power levels to show in the drop-down
+ options: [],
+ };
+ },
+
+ getDefaultProps: function() {
+ return {
+ maxValue: Infinity,
+ usersDefault: 0,
};
},
componentWillMount: function() {
- LEVEL_ROLE_MAP = Roles.levelRoleMap();
- Object.keys(LEVEL_ROLE_MAP).forEach(function(key) {
- reverseRoles[LEVEL_ROLE_MAP[key]] = key;
- });
+ this._initStateFromProps(this.props);
+ },
+
+ componentWillReceiveProps: function(newProps) {
+ this._initStateFromProps(newProps);
+ },
+
+ _initStateFromProps: function(newProps) {
+ // This needs to be done now because levelRoleMap has translated strings
+ const levelRoleMap = Roles.levelRoleMap(newProps.usersDefault);
+ const options = Object.keys(levelRoleMap).filter((l) => {
+ return l === undefined || l <= newProps.maxValue;
+ });
+
+ this.setState({
+ levelRoleMap,
+ options,
+ custom: levelRoleMap[newProps.value] === undefined,
+ });
},
onSelectChange: function(event) {
- this.setState({ custom: event.target.value === "Custom" });
- if (event.target.value !== "Custom") {
- this.props.onChange(this.getValue());
+ this.setState({ custom: event.target.value === "SELECT_VALUE_CUSTOM" });
+ if (event.target.value !== "SELECT_VALUE_CUSTOM") {
+ this.props.onChange(event.target.value);
}
},
onCustomBlur: function(event) {
- this.props.onChange(this.getValue());
+ this.props.onChange(parseInt(this.refs.custom.value));
},
onCustomKeyDown: function(event) {
if (event.key == "Enter") {
- this.props.onChange(this.getValue());
+ this.props.onChange(parseInt(this.refs.custom.value));
}
},
- getValue: function() {
- let value;
- if (this.refs.select) {
- value = reverseRoles[this.refs.select.value];
- if (this.refs.custom) {
- if (value === undefined) value = parseInt( this.refs.custom.value );
- }
- }
- return value;
- },
-
render: function() {
let customPicker;
if (this.state.custom) {
- let input;
if (this.props.disabled) {
- input = 
+