Initial support for notification settings

Signed-off-by: Travis Ralston <travpc@gmail.com>

src/settings/Settings.js

@@ -62,6 +62,9 @@ export const SETTINGS = {
     //     default: {
     //         your: "value",
     //     },
+    //
+    //     // Optional settings controller. See SettingsController for more information.
+    //     controller: new MySettingController(),
     // },
     "feature_groups": {
         isFeature: true,
@@ -213,4 +216,23 @@ export const SETTINGS = {
             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: false,
+        //controller: new NotificationBodyEnabledController(),
+    },
+    "audioNotificationsEnabled": {
+        supportedLevels: LEVELS_DEVICE_ONLY_SETTINGS,
+        default: false,
+        //controller: new AudioNotificationsEnabledController(),
+    },
+    "notificationToolbarHidden": {
+        supportedLevels: LEVELS_DEVICE_ONLY_SETTINGS,
+        default: false,
+    },
 };

src/settings/SettingsStore.js

@@ -15,17 +15,17 @@ limitations under the License.
 */
 
 import Promise from 'bluebird';
-import DeviceSettingsHandler from "./DeviceSettingsHandler";
-import RoomDeviceSettingsHandler from "./RoomDeviceSettingsHandler";
-import DefaultSettingsHandler from "./DefaultSettingsHandler";
-import RoomAccountSettingsHandler from "./RoomAccountSettingsHandler";
-import AccountSettingsHandler from "./AccountSettingsHandler";
-import RoomSettingsHandler from "./RoomSettingsHandler";
-import ConfigSettingsHandler from "./ConfigSettingsHandler";
+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 "./LocalEchoWrapper";
+import LocalEchoWrapper from "./handlers/LocalEchoWrapper";
 
 /**
  * Represents the various setting levels supported by the SettingsStore.
@@ -208,8 +208,9 @@ export default class SettingsStore {
 
         if (explicit) {
             let handler = handlers[level];
-            if (!handler) return null;
-            return handler.getValue(settingName, roomId);
+            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 < LEVEL_ORDER.length; i++) {
@@ -219,10 +220,19 @@ export default class SettingsStore {
 
             const value = handler.getValue(settingName, roomId);
             if (value === null || value === undefined) continue;
-            return value;
+            return SettingsStore._tryControllerOverride(settingName, level, roomId, value);
         }
 
-        return null;
+        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;
     }
 
     /**
@@ -251,7 +261,11 @@ export default class SettingsStore {
             throw new Error("User cannot set " + settingName + " at " + level + " in " + roomId);
         }
 
-        return handler.setValue(settingName, roomId, value);
+        return handler.setValue(settingName, roomId, value).finally((() => {
+            const controller = SETTINGS[settingName].controller;
+            if (!controller) return;
+            controller.onChange(level, roomId, value);
+        }));
     }
 
     /**

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.setBodyEnabled(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();
+//     }
+// }

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
+    }
+}

src/settings/handlers/AccountSettingsHandler.js

@@ -15,7 +15,7 @@ limitations under the License.
 */
 
 import SettingsHandler from "./SettingsHandler";
-import MatrixClientPeg from '../MatrixClientPeg';
+import MatrixClientPeg from '../../MatrixClientPeg';
 
 /**
  * Gets and sets settings at the "account" level for the current user.

src/settings/handlers/ConfigSettingsHandler.js

@@ -16,7 +16,7 @@ limitations under the License.
 
 import Promise from 'bluebird';
 import SettingsHandler from "./SettingsHandler";
-import SdkConfig from "../SdkConfig";
+import SdkConfig from "../../SdkConfig";
 
 /**
  * Gets and sets settings at the "config" level. This handler does not make use of the

src/settings/handlers/DeviceSettingsHandler.js

@@ -16,7 +16,7 @@ limitations under the License.
 
 import Promise from 'bluebird';
 import SettingsHandler from "./SettingsHandler";
-import MatrixClientPeg from "../MatrixClientPeg";
+import MatrixClientPeg from "../../MatrixClientPeg";
 
 /**
  * Gets and sets settings at the "device" level for the current device.
@@ -38,6 +38,17 @@ export default class DeviceSettingsHandler extends SettingsHandler {
             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";
+        } else if (settingName === "notificationToolbarHidden") {
+            return localStorage.getItem("notifications_hidden") === "true";
+        }
+
         return this._getSettings()[settingName];
     }
 
@@ -47,6 +58,21 @@ export default class DeviceSettingsHandler extends SettingsHandler {
             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();
+        } else if (settingName === "notificationToolbarHidden") {
+            localStorage.setItem("notifications_hidden", newValue);
+            return Promise.resolve();
+        }
+
         const settings = this._getSettings();
         settings[settingName] = newValue;
         localStorage.setItem("mx_local_settings", JSON.stringify(settings));

src/settings/handlers/RoomAccountSettingsHandler.js

@@ -15,7 +15,7 @@ limitations under the License.
 */
 
 import SettingsHandler from "./SettingsHandler";
-import MatrixClientPeg from '../MatrixClientPeg';
+import MatrixClientPeg from '../../MatrixClientPeg';
 
 /**
  * Gets and sets settings at the "room-account" level for the current user.

src/settings/handlers/RoomSettingsHandler.js

@@ -15,7 +15,7 @@ limitations under the License.
 */
 
 import SettingsHandler from "./SettingsHandler";
-import MatrixClientPeg from '../MatrixClientPeg';
+import MatrixClientPeg from '../../MatrixClientPeg';
 
 /**
  * Gets and sets settings at the "room" level.