First attempt alpha room list sorting

Signed-off-by: Michael Telatynski <7t3chguy@gmail.com>

src/settings/Settings.js

@@ -26,6 +26,7 @@ import CustomStatusController from "./controllers/CustomStatusController";
 import ThemeController from './controllers/ThemeController';
 import ReloadOnChangeController from "./controllers/ReloadOnChangeController";
 import {RIGHT_PANEL_PHASES} from "../stores/RightPanelStorePhases";
+import RoomListOrderingController from "./controllers/RoomListOrderingController";
 
 // 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'];
@@ -433,14 +434,20 @@ export const SETTINGS = {
             deny: [],
         },
     },
+    "RoomList.orderingAlgorithm": {
+        supportedLevels: LEVELS_ACCOUNT_SETTINGS,
+        displayName: _td("Order rooms by message activity instead of by name"),
+        default: "recent", // XXX controller maps boolean onto algorithm for future flexibility
+        controller: new RoomListOrderingController(),
+    },
     "RoomList.orderByImportance": {
         supportedLevels: LEVELS_ACCOUNT_SETTINGS,
-        displayName: _td('Order rooms in the room list by most important first instead of most recent'),
+        displayName: _td("Show rooms with unread notifications first"),
         default: true,
     },
     "breadcrumbs": {
         supportedLevels: LEVELS_ACCOUNT_SETTINGS,
-        displayName: _td("Show recently visited rooms above the room list"),
+        displayName: _td("Show shortcuts to recently viewed rooms above the room list"),
         default: true,
     },
     "showHiddenEventsInTimeline": {

src/settings/SettingsStore.js

@@ -420,9 +420,13 @@ export default class SettingsStore {
             throw new Error("User cannot set " + settingName + " at " + level + " in " + roomId);
         }
 
+        const controller = setting.controller;
+        if (controller) {
+            value = controller.augmentValue(level, roomId, value);
+        }
+
         await handler.setValue(settingName, roomId, value);
 
-        const controller = setting.controller;
         if (controller) {
             controller.onChange(level, roomId, value);
         }

src/settings/controllers/RoomListOrderingController.js

@@ -0,0 +1,25 @@
+/*
+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";
+
+export default class RoomListOrderingController extends SettingController {
+    augmentValue(level, roomId, newValue): * {
+        // currently we expose algorithm as a boolean but store it as a string for future flexibility
+        // where we may want >2 algorithms available for the user to choose between.
+        return newValue ? "recent" : "alphabetic";
+    }
+}

src/settings/controllers/SettingController.js

@@ -47,4 +47,15 @@ export default class SettingController {
     onChange(level, roomId, newValue) {
         // do nothing by default
     }
+
+    /**
+     * Gets the value which should actually get written into the store based on the input value from setValue.
+     * @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.
+     * @return {*} The value that should be used, may be null.
+     */
+    augmentValue(level, roomId, newValue) {
+        return newValue;
+    }
 }