v1.7.26

Remove Debian dependency libappindicator3-1

CHANGELOG.md

@@ -1,3 +1,74 @@
+Changes in [1.7.26](https://github.com/vector-im/element-desktop/releases/tag/v1.7.26) (2021-04-26)
+===================================================================================================
+[Full Changelog](https://github.com/vector-im/element-desktop/compare/v1.7.26-rc.1...v1.7.26)
+
+ * No changes since rc.1
+
+Changes in [1.7.26-rc.1](https://github.com/vector-im/element-desktop/releases/tag/v1.7.26-rc.1) (2021-04-21)
+=============================================================================================================
+[Full Changelog](https://github.com/vector-im/element-desktop/compare/v1.7.25...v1.7.26-rc.1)
+
+ * Remove Debian dependency libappindicator3-1
+   [\#170](https://github.com/vector-im/element-desktop/pull/170)
+ * Fix exit shortcuts for non QWERTY keyboards
+   [\#185](https://github.com/vector-im/element-desktop/pull/185)
+ * Fix using yarn run fetch with a specific version
+   [\#182](https://github.com/vector-im/element-desktop/pull/182)
+ * Switch nightly to not-staging Scalar by default
+   [\#181](https://github.com/vector-im/element-desktop/pull/181)
+
+Changes in [1.7.25](https://github.com/vector-im/element-desktop/releases/tag/v1.7.25) (2021-04-12)
+===================================================================================================
+[Full Changelog](https://github.com/vector-im/element-desktop/compare/v1.7.25-rc.1...v1.7.25)
+
+ * No changes since rc.1
+
+Changes in [1.7.25-rc.1](https://github.com/vector-im/element-desktop/releases/tag/v1.7.25-rc.1) (2021-04-07)
+=============================================================================================================
+[Full Changelog](https://github.com/vector-im/element-desktop/compare/v1.7.24...v1.7.25-rc.1)
+
+ * Fix disabling spellchecker
+   [\#179](https://github.com/vector-im/element-desktop/pull/179)
+ * Upgrade to Electron 12.0.2
+   [\#178](https://github.com/vector-im/element-desktop/pull/178)
+ * Avoid exit listener to hijack other application shortcuts
+   [\#177](https://github.com/vector-im/element-desktop/pull/177)
+ * Migrate native-node-modules docs to element-desktop
+   [\#176](https://github.com/vector-im/element-desktop/pull/176)
+ * Add prompt to warn before quitting the application
+   [\#173](https://github.com/vector-im/element-desktop/pull/173)
+ * Upgrade to Electron 11.4.1
+   [\#172](https://github.com/vector-im/element-desktop/pull/172)
+ * Fix docker:build:native documentation typo
+   [\#174](https://github.com/vector-im/element-desktop/pull/174)
+
+Changes in [1.7.24](https://github.com/vector-im/element-desktop/releases/tag/v1.7.24) (2021-03-29)
+===================================================================================================
+[Full Changelog](https://github.com/vector-im/element-desktop/compare/v1.7.24-rc.1...v1.7.24)
+
+ * No changes since rc.1
+
+Changes in [1.7.24-rc.1](https://github.com/vector-im/element-desktop/releases/tag/v1.7.24-rc.1) (2021-03-25)
+=============================================================================================================
+[Full Changelog](https://github.com/vector-im/element-desktop/compare/v1.7.23...v1.7.24-rc.1)
+
+ * No changes since 1.7.23
+
+Changes in [1.7.23](https://github.com/vector-im/element-desktop/releases/tag/v1.7.23) (2021-03-15)
+===================================================================================================
+[Full Changelog](https://github.com/vector-im/element-desktop/compare/v1.7.23-rc.1...v1.7.23)
+
+ * No changes since rc.1
+
+Changes in [1.7.23-rc.1](https://github.com/vector-im/element-desktop/releases/tag/v1.7.23-rc.1) (2021-03-11)
+=============================================================================================================
+[Full Changelog](https://github.com/vector-im/element-desktop/compare/v1.7.22...v1.7.23-rc.1)
+
+ * Fix disabling spell-checker
+   [\#171](https://github.com/vector-im/element-desktop/pull/171)
+ * Add multi language spell check
+   [\#154](https://github.com/vector-im/element-desktop/pull/154)
+
 Changes in [1.7.22](https://github.com/vector-im/element-desktop/releases/tag/v1.7.22) (2021-03-01)
 ===================================================================================================
 [Full Changelog](https://github.com/vector-im/element-desktop/compare/v1.7.22-rc.1...v1.7.22)

README.md

@@ -96,7 +96,7 @@ yarn run docker:setup
 
 yarn run docker:install
 # if you want to build the native modules (this will take a while)
-yarn run docker:buildnative
+yarn run docker:build:native
 yarn run docker:build
 ```
 

docs/native-node-modules.md

@@ -0,0 +1,61 @@
+# Native Node Modules
+
+For some features, the desktop version of Element can make use of native Node
+modules. These allow Element to integrate with the desktop in ways that a browser
+cannot.
+
+While native modules enable powerful new features, they must be complied for
+each operating system. For official Element releases, we will always build these
+modules from source to ensure we can trust the compiled output. In the future,
+we may offer a pre-compiled path for those who want to use these features in a
+custom build of Element without installing the various build tools required.
+
+Do note that compiling a module for a particular operating system
+(Linux/macOS/Windows) will need to be done on that operating system.
+Cross-compiling from a host OS for a different target OS may be possible, but
+we don't support this flow with Element dependencies at this time.
+
+The process is automated by [vector-im/element-builder](https://github.com/vector-im/element-builder)
+when releasing. 
+The following sections explain the manual steps you can use with a custom build of Element to enable
+these features if you'd like to try them out.
+It is possible to [build those native modules locally automatically](https://github.com/vector-im/element-desktop#building).
+
+```
+yarn run build:native
+```
+## Adding Seshat for search in E2E encrypted rooms
+
+Seshat is a native Node module that adds support for local event indexing and
+full text search in E2E encrypted rooms.
+
+Since Seshat is written in Rust, the Rust compiler and related tools need to be
+installed before installing Seshat itself. To install Rust please consult the
+official Rust [documentation](https://www.rust-lang.org/tools/install).
+
+Seshat also depends on the SQLCipher library to store its data in encrypted form
+on disk. You'll need to install it via your OS package manager.
+
+After installing the Rust compiler and SQLCipher, Seshat support can be added
+using yarn at the root of this project:
+
+    yarn add matrix-seshat
+
+You will have to rebuild the native libraries against electron's version of
+of node rather than your system node, using the `electron-build-env` tool.
+This is also needed to when pulling in changes to Seshat using `yarn link`.
+
+    yarn add electron-build-env
+
+Recompiling Seshat itself can be done like so:
+
+    yarn run electron-build-env -- --electron 6.1.1 -- neon build matrix-seshat --release
+
+Please make sure to include all the `--` as well as the `--release` command line
+switch at the end. Modify your electron version accordingly depending on the
+version that is installed on your system.
+
+After this is done the Electron version of Element can be run from the main folder
+as usual using:
+
+    yarn start

element.io/nightly/config.json

@@ -2,8 +2,8 @@
     "update_base_url": "https://packages.riot.im/nightly/update/",
     "default_server_name": "matrix.org",
     "brand": "Element Nightly",
-    "integrations_ui_url": "https://scalar-staging.vector.im/",
+    "integrations_ui_url": "https://scalar.vector.im/",
-    "integrations_rest_url": "https://scalar-staging.vector.im/api",
+    "integrations_rest_url": "https://scalar.vector.im/api",
     "integrations_widgets_urls": [
         "https://scalar.vector.im/_matrix/integrations/v1",
         "https://scalar.vector.im/api",

element.io/nightly/control.template

@@ -3,7 +3,8 @@ License: Apache-2.0
 Vendor: support@element.io
 Architecture: amd64
 Maintainer: support@element.io
-Depends: libgtk-3-0, libnotify4, libnss3, libxss1, libxtst6, xdg-utils, libatspi2.0-0, libuuid1, libappindicator3-1, libsecret-1-0, libsqlcipher0
+Depends: libgtk-3-0, libnotify4, libnss3, libxss1, libxtst6, xdg-utils, libatspi2.0-0, libuuid1, libsecret-1-0, libsqlcipher0
+Recommends: libappindicator3-1
 Section: net
 Priority: extra
 Homepage: https://element.io/

element.io/release/control.template

@@ -3,7 +3,8 @@ License: Apache-2.0
 Vendor: support@element.io
 Architecture: amd64
 Maintainer: support@element.io
-Depends: libgtk-3-0, libnotify4, libnss3, libxss1, libxtst6, xdg-utils, libatspi2.0-0, libuuid1, libappindicator3-1, libsecret-1-0, libsqlcipher0
+Depends: libgtk-3-0, libnotify4, libnss3, libxss1, libxtst6, xdg-utils, libatspi2.0-0, libuuid1, libsecret-1-0, libsqlcipher0
+Recommends: libappindicator3-1
 Replaces: riot-desktop (<< 1.7.0), riot-web (<< 1.7.0)
 Breaks: riot-desktop (<< 1.7.0), riot-web (<< 1.7.0)
 Section: net

package.json

@@ -2,7 +2,7 @@
   "name": "element-desktop",
   "productName": "Element",
   "main": "src/electron-main.js",
-  "version": "1.7.22",
+  "version": "1.7.26",
   "description": "A feature-rich client for Matrix.org",
   "author": "Element",
   "repository": {
@@ -39,8 +39,8 @@
   },
   "devDependencies": {
     "asar": "^2.0.1",
-    "electron-builder": "22.9.1",
+    "electron-builder": "22.10.5",
-    "electron-builder-squirrel-windows": "22.9.1",
+    "electron-builder-squirrel-windows": "22.10.5",
     "electron-devtools-installer": "^3.1.1",
     "electron-notarize": "^1.0.0",
     "eslint": "7.3.1",
@@ -62,7 +62,7 @@
   },
   "build": {
     "appId": "im.riot.app",
-    "electronVersion": "11.2.3",
+    "electronVersion": "12.0.2",
     "files": [
       "package.json",
       {

scripts/fetch-package.js

@@ -15,7 +15,7 @@ const PUB_KEY_URL = "https://packages.riot.im/element-release-key.asc";
 const PACKAGE_URL_PREFIX = "https://github.com/vector-im/element-web/releases/download/";
 const ASAR_PATH = 'webapp.asar';
 
-const {setPackageVersion, setDebVersion} = require('./set-version.js');
+const {setPackageVersion} = require('./set-version.js');
 
 async function getLatestDevelopUrl(bkToken) {
     const buildsResult = await needle('get',
@@ -283,7 +283,6 @@ async function main() {
         const semVer = targetVersion.slice(1);
         console.log("Updating version to " + semVer);
         await setPackageVersion(semVer);
-        await setDebVersion(semVer);
     }
 
     console.log("Done!");

src/electron-main.js

@@ -27,7 +27,9 @@ const argv = require('minimist')(process.argv, {
     alias: {help: "h"},
 });
 
-const {app, ipcMain, powerSaveBlocker, BrowserWindow, Menu, autoUpdater, protocol} = require('electron');
+const {
+    app, ipcMain, powerSaveBlocker, BrowserWindow, Menu, autoUpdater, protocol, dialog,
+} = require('electron');
 const AutoLaunch = require('auto-launch');
 const path = require('path');
 
@@ -253,6 +255,30 @@ let eventIndex = null;
 let mainWindow = null;
 global.appQuitting = false;
 
+const exitShortcuts = [
+    (input, platform) => platform !== 'darwin' && input.alt && input.key.toUpperCase() === 'F4',
+    (input, platform) => platform !== 'darwin' && input.control && input.key.toUpperCase() === 'Q',
+    (input, platform) => platform === 'darwin' && input.meta && input.key.toUpperCase() === 'Q',
+];
+
+const warnBeforeExit = (event, input) => {
+    const shouldWarnBeforeExit = store.get('warnBeforeExit', true);
+    const exitShortcutPressed = exitShortcuts.some(shortcutFn => shortcutFn(input, process.platform));
+
+    if (shouldWarnBeforeExit && exitShortcutPressed) {
+        const shouldCancelCloseRequest = dialog.showMessageBoxSync(mainWindow, {
+            type: "question",
+            buttons: ["Cancel", "Close Element"],
+            message: "Are you sure you want to quit?",
+            defaultId: 1,
+            cancelId: 0,
+        }) === 0;
+
+        if (shouldCancelCloseRequest) {
+            event.preventDefault();
+        }
+    }
+};
 
 const deleteContents = async (p) => {
     for (const entry of await afs.readdir(p)) {
@@ -340,6 +366,12 @@ ipcMain.on('ipcCall', async function(ev, payload) {
                 launcher.disable();
             }
             break;
+        case 'shouldWarnBeforeExit':
+            ret = store.get('warnBeforeExit', true);
+            break;
+        case 'setWarnBeforeExit':
+            store.set('warnBeforeExit', args[0]);
+            break;
         case 'getMinimizeToTrayEnabled':
             ret = tray.hasTray();
             break;
@@ -385,50 +417,32 @@ ipcMain.on('ipcCall', async function(ev, payload) {
                 mainWindow.webContents.goForward();
             }
             break;
-        case 'setLanguage': {
+        case 'setSpellCheckLanguages':
-            // work around `setSpellCheckerLanguages` being case-sensitive by converting to expected case
+            if (args[0] && args[0].length > 0) {
-            const caseMap = {};
+                mainWindow.webContents.session.setSpellCheckerEnabled(true);
-            const availableLanguages = mainWindow.webContents.session.availableSpellCheckerLanguages;
+                store.set("spellCheckerEnabled", true);
-            availableLanguages.forEach(lang => {
-                caseMap[lang.toLowerCase()] = lang;
-            });
 
-            if (!caseMap["en"]) {
+                try {
-                // default special-case for `en` as in Riot is actually implies `en-GB`. `en-US` is distinct.
+                    mainWindow.webContents.session.setSpellCheckerLanguages(args[0]);
-                // this way if `en` is requested and not available and `en-GB` is available it'll be used.
+                } catch (er) {
-                caseMap["en"] = caseMap["en-gb"];
+                    console.log("There were problems setting the spellcheck languages", er);
-            }
-
-            const languages = new Set();
-            args[0].forEach(lang => {
-                const lcLang = lang.toLowerCase();
-                if (caseMap[lcLang]) {
-                    languages.add(caseMap[lcLang]);
-                    return;
                 }
-
+            } else {
-                // as a fallback if the language is unknown check if the language group is known, e.g en for en-AU
+                mainWindow.webContents.session.setSpellCheckerEnabled(false);
-                const langGroup = lcLang.split("-")[0];
+                store.set("spellCheckerEnabled", false);
-                if (caseMap[langGroup]) {
-                    languages.add(caseMap[langGroup]);
-                    return;
-                }
-
-                // as a further fallback, pick all other matching variants from the same language group
-                // this means that if we cannot find `ar-dz` or `ar` for example, we will pick `ar-*` to
-                // offer a spellcheck which is least likely to wrongly red underline something.
-                availableLanguages.forEach(availableLang => {
-                    if (availableLang.startsWith(langGroup)) {
-                        languages.add(availableLang);
-                    }
-                });
-            });
-
-            if (languages.size > 0) {
-                mainWindow.webContents.session.setSpellCheckerLanguages([...languages]);
             }
             break;
-        }
+        case 'getSpellCheckLanguages':
+            if (store.get("spellCheckerEnabled", true)) {
+                ret = mainWindow.webContents.session.getSpellCheckerLanguages();
+            } else {
+                ret = [];
+            }
+            break;
+        case 'getAvailableSpellCheckLanguages':
+            ret = mainWindow.webContents.session.availableSpellCheckerLanguages;
+            break;
+
         case 'startSSOFlow':
             recordSSOSession(args[0]);
             break;
@@ -923,12 +937,15 @@ app.on('ready', async () => {
             enableRemoteModule: false,
             contextIsolation: true,
             webgl: false,
-            spellcheck: true,
         },
     });
     mainWindow.loadURL('vector://vector/webapp/');
     Menu.setApplicationMenu(vectorMenu);
 
+    // Handle spellchecker
+    // For some reason spellCheckerEnabled isn't persisted so we have to use the store here
+    mainWindow.webContents.session.setSpellCheckerEnabled(store.get("spellCheckerEnabled", true));
+
     // Create trayIcon icon
     if (store.get('minimizeToTray', true)) tray.create(trayConfig);
 
@@ -943,10 +960,12 @@ app.on('ready', async () => {
         }
     });
 
+    mainWindow.webContents.on('before-input-event', warnBeforeExit);
+
     mainWindow.on('closed', () => {
         mainWindow = global.mainWindow = null;
     });
-    mainWindow.on('close', (e) => {
+    mainWindow.on('close', async (e) => {
         // If we are not quitting and have a tray icon then minimize to tray
         if (!global.appQuitting && (tray.hasTray() || process.platform === 'darwin')) {
             // On Mac, closing the window just hides it