Abstract electron settings properly to avoid boilerplate-hell (#8798)

* Remove unused method `BasePlatform::screenCaptureErrorString`

* Improve platform typescripting

* Remove redundant awaits

* Abstract electron settings properly to avoid boilerplate-hell

* i18n

* Fix stray semi-colons

* Fix setting level order for Platform settings

src/settings/SettingLevel.ts

@@ -24,6 +24,7 @@ export enum SettingLevel {
     ROOM_ACCOUNT = "room-account",
     ACCOUNT = "account",
     ROOM = "room",
+    PLATFORM = "platform",
     CONFIG = "config",
     DEFAULT = "default",
 }

src/settings/Settings.tsx

@@ -1042,4 +1042,32 @@ export const SETTINGS: {[setting: string]: ISetting} = {
         supportedLevels: LEVELS_UI_FEATURE,
         default: true,
     },
+
+    // Electron-specific settings, they are stored by Electron and set/read over an IPC.
+    // We store them over there are they are necessary to know before the renderer process launches.
+    "Electron.autoLaunch": {
+        supportedLevels: [SettingLevel.PLATFORM],
+        displayName: _td("Start automatically after system login"),
+        default: false,
+    },
+    "Electron.warnBeforeExit": {
+        supportedLevels: [SettingLevel.PLATFORM],
+        displayName: _td("Warn before quitting"),
+        default: true,
+    },
+    "Electron.alwaysShowMenuBar": {
+        supportedLevels: [SettingLevel.PLATFORM],
+        displayName: _td("Always show the window menu bar"),
+        default: false,
+    },
+    "Electron.showTrayIcon": {
+        supportedLevels: [SettingLevel.PLATFORM],
+        displayName: _td("Show tray icon and minimise window to it on close"),
+        default: true,
+    },
+    "Electron.enableHardwareAcceleration": {
+        supportedLevels: [SettingLevel.PLATFORM],
+        displayName: _td("Enable hardware acceleration"),
+        default: true,
+    },
 };

src/settings/SettingsStore.ts

@@ -34,6 +34,7 @@ import { SettingLevel } from "./SettingLevel";
 import SettingsHandler from "./handlers/SettingsHandler";
 import { SettingUpdatedPayload } from "../dispatcher/payloads/SettingUpdatedPayload";
 import { Action } from "../dispatcher/actions";
+import PlatformSettingsHandler from "./handlers/PlatformSettingsHandler";
 
 const defaultWatchManager = new WatchManager();
 
@@ -61,6 +62,7 @@ const LEVEL_HANDLERS = {
     ),
     [SettingLevel.ACCOUNT]: new LocalEchoWrapper(new AccountSettingsHandler(defaultWatchManager), SettingLevel.ACCOUNT),
     [SettingLevel.ROOM]: new LocalEchoWrapper(new RoomSettingsHandler(defaultWatchManager), SettingLevel.ROOM),
+    [SettingLevel.PLATFORM]: new LocalEchoWrapper(new PlatformSettingsHandler(), SettingLevel.PLATFORM),
     [SettingLevel.CONFIG]: new ConfigSettingsHandler(featureNames),
     [SettingLevel.DEFAULT]: new DefaultSettingsHandler(defaultSettings, invertedDefaultSettings),
 };
@@ -75,6 +77,14 @@ export const LEVEL_ORDER = [
     SettingLevel.DEFAULT,
 ];
 
+function getLevelOrder(setting: ISetting): SettingLevel[] {
+    // Settings which support only a single setting level are inherently ordered
+    if (setting.supportedLevelsAreOrdered || setting.supportedLevels.length === 1) {
+        return setting.supportedLevels;
+    }
+    return LEVEL_ORDER;
+}
+
 export type CallbackFn = (
     settingName: string,
     roomId: string,
@@ -316,7 +326,7 @@ export default class SettingsStore {
         }
 
         const setting = SETTINGS[settingName];
-        const levelOrder = (setting.supportedLevelsAreOrdered ? setting.supportedLevels : LEVEL_ORDER);
+        const levelOrder = getLevelOrder(setting);
 
         return SettingsStore.getValueAt(levelOrder[0], settingName, roomId, false, excludeDefault);
     }
@@ -345,7 +355,7 @@ export default class SettingsStore {
             throw new Error("Setting '" + settingName + "' does not appear to be a setting.");
         }
 
-        const levelOrder = (setting.supportedLevelsAreOrdered ? setting.supportedLevels : LEVEL_ORDER);
+        const levelOrder = getLevelOrder(setting);
         if (!levelOrder.includes(SettingLevel.DEFAULT)) levelOrder.push(SettingLevel.DEFAULT); // always include default
 
         const minIndex = levelOrder.indexOf(level);
@@ -518,7 +528,7 @@ export default class SettingsStore {
             throw new Error("Setting '" + settingName + "' does not appear to be a setting.");
         }
 
-        const levelOrder = (setting.supportedLevelsAreOrdered ? setting.supportedLevels : LEVEL_ORDER);
+        const levelOrder = getLevelOrder(setting);
         if (!levelOrder.includes(SettingLevel.DEFAULT)) levelOrder.push(SettingLevel.DEFAULT); // always include default
 
         const handlers = SettingsStore.getHandlers(settingName);

src/settings/handlers/PlatformSettingsHandler.ts

@@ -0,0 +1,40 @@
+/*
+Copyright 2022 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 SettingsHandler from "./SettingsHandler";
+import PlatformPeg from "../../PlatformPeg";
+
+/**
+ * Gets and sets settings at the "platform" level for the current device.
+ * This handler does not make use of the roomId parameter.
+ */
+export default class PlatformSettingsHandler extends SettingsHandler {
+    public canSetValue(settingName: string, roomId: string): boolean {
+        return PlatformPeg.get().supportsSetting(settingName);
+    }
+
+    public getValue(settingName: string, roomId: string): any {
+        return PlatformPeg.get().getSettingValue(settingName);
+    }
+
+    public setValue(settingName: string, roomId: string, newValue: any): Promise<void> {
+        return PlatformPeg.get().setSettingValue(settingName, newValue);
+    }
+
+    public isSupported(): boolean {
+        return PlatformPeg.get().supportsSetting();
+    }
+}