Merge pull request #5238 from matrix-org/travis/uifeat/paranoia

Add a UI feature to disable advanced encryption options

src/settings/Settings.ts

@@ -34,6 +34,7 @@ import SettingController from "./controllers/SettingController";
 import { RightPanelPhases } from "../stores/RightPanelStorePhases";
 import UIFeatureController from "./controllers/UIFeatureController";
 import { UIFeature } from "./UIFeature";
+import { OrderedMultiController } from "./controllers/OrderedMultiController";
 
 // These are just a bunch of helper arrays to avoid copy/pasting a bunch of times
 const LEVELS_ROOM_SETTINGS = [
@@ -436,6 +437,7 @@ export const SETTINGS: {[setting: string]: ISetting} = {
             "room-device": _td('Never send encrypted messages to unverified sessions in this room from this session'),
         },
         default: false,
+        controller: new UIFeatureController(UIFeature.AdvancedEncryption),
     },
     "urlPreviewsEnabled": {
         supportedLevels: LEVELS_ROOM_SETTINGS_WITH_ROOM,
@@ -591,9 +593,15 @@ export const SETTINGS: {[setting: string]: ISetting} = {
         supportedLevels: LEVELS_DEVICE_ONLY_SETTINGS,
         displayName: _td("Manually verify all remote sessions"),
         default: false,
-        controller: new PushToMatrixClientController(
-            MatrixClient.prototype.setCryptoTrustCrossSignedDevices, true,
-        ),
+        controller: new OrderedMultiController([
+            // Apply the feature controller first to ensure that the setting doesn't
+            // show up and can't be toggled. PushToMatrixClientController doesn't
+            // do any overrides anyways.
+            new UIFeatureController(UIFeature.AdvancedEncryption),
+            new PushToMatrixClientController(
+                MatrixClient.prototype.setCryptoTrustCrossSignedDevices, true,
+            ),
+        ]),
     },
     "ircDisplayNameWidth": {
         // We specifically want to have room-device > device so that users may set a device default
@@ -612,6 +620,10 @@ export const SETTINGS: {[setting: string]: ISetting} = {
         supportedLevels: LEVELS_ROOM_OR_ACCOUNT,
         default: {},
     },
+    [UIFeature.AdvancedEncryption]: {
+        supportedLevels: LEVELS_UI_FEATURE,
+        default: true,
+    },
     [UIFeature.URLPreviews]: {
         supportedLevels: LEVELS_UI_FEATURE,
         default: true,

src/settings/UIFeature.ts

@@ -16,6 +16,7 @@ limitations under the License.
 
 // see settings.md for documentation on conventions
 export enum UIFeature {
+    AdvancedEncryption = "UIFeature.advancedEncryption",
     URLPreviews = "UIFeature.urlPreviews",
     Widgets = "UIFeature.widgets",
     Voip = "UIFeature.voip",

src/settings/controllers/OrderedMultiController.ts

@@ -0,0 +1,59 @@
+/*
+Copyright 2020 The Matrix.org Foundation C.I.C.
+
+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";
+import { SettingLevel } from "../SettingLevel";
+
+/**
+ * Allows for multiple controllers to affect a setting. The first controller
+ * provided to this class which overrides the setting value will affect
+ * the value - other controllers are not called. Change notification handlers
+ * are proxied through to all controllers.
+ *
+ * Similarly, the first controller which indicates that a setting is disabled
+ * will be used - other controllers will not be considered.
+ */
+export class OrderedMultiController extends SettingController {
+    constructor(public readonly controllers: SettingController[]) {
+        super();
+    }
+
+    public getValueOverride(
+        level: SettingLevel,
+        roomId: string,
+        calculatedValue: any,
+        calculatedAtLevel: SettingLevel,
+    ): any {
+        for (const controller of this.controllers) {
+            const override = controller.getValueOverride(level, roomId, calculatedValue, calculatedAtLevel);
+            if (override !== undefined && override !== null) return override;
+        }
+        return null; // no override
+    }
+
+    public onChange(level: SettingLevel, roomId: string, newValue: any) {
+        for (const controller of this.controllers) {
+            controller.onChange(level, roomId, newValue);
+        }
+    }
+
+    public get settingDisabled(): boolean {
+        for (const controller of this.controllers) {
+            if (controller.settingDisabled) return true;
+        }
+        return false;
+    }
+}