+ {this.state.message}
+
+ 
+
+ 
;
+ } else {
+ image = 
;
+ }
return (
+
+
;
+ image = ;
} else {
image = ;
}
From 4c8ff0955db14c78d73a2db43d7ca7a8de7a3b6c Mon Sep 17 00:00:00 2001
From: Michael Telatynski <7t3chguy@gmail.com>
Date: Sun, 11 Jun 2017 16:43:20 +0100
Subject: [PATCH 10/19] move electron update logic into own file, tidy tidy
tidy
Signed-off-by: Michael Telatynski <7t3chguy@gmail.com>
---
electron_app/src/electron-main.js | 72 +++----------------------------
electron_app/src/updater.js | 65 ++++++++++++++++++++++++++++
2 files changed, 70 insertions(+), 67 deletions(-)
create mode 100644 electron_app/src/updater.js
diff --git a/electron_app/src/electron-main.js b/electron_app/src/electron-main.js
index f1a9e37a73..d793ab9be9 100644
--- a/electron_app/src/electron-main.js
+++ b/electron_app/src/electron-main.js
@@ -28,6 +28,7 @@ const AutoLaunch = require('auto-launch');
const tray = require('./tray');
const vectorMenu = require('./vectormenu');
const webContentsHandler = require('./webcontents-handler');
+const updater = require('./updater');
const windowStateKeeper = require('electron-window-state');
@@ -45,69 +46,9 @@ try {
// Continue with the defaults (ie. an empty config)
}
-const UPDATE_POLL_INTERVAL_MS = 60 * 60 * 1000;
-const INITIAL_UPDATE_DELAY_MS = 30 * 1000;
-
let mainWindow = null;
-let appQuitting = false;
+global.appQuitting = false;
-function installUpdate() {
- // for some reason, quitAndInstall does not fire the
- // before-quit event, so we need to set the flag here.
- appQuitting = true;
- electron.autoUpdater.quitAndInstall();
-}
-
-function pollForUpdates() {
- try {
- electron.autoUpdater.checkForUpdates();
- } catch (e) {
- console.log('Couldn\'t check for update', e);
- }
-}
-
-function startAutoUpdate(updateBaseUrl) {
- if (updateBaseUrl.slice(-1) !== '/') {
- updateBaseUrl = updateBaseUrl + '/';
- }
- try {
- // For reasons best known to Squirrel, the way it checks for updates
- // is completely different between macOS and windows. On macOS, it
- // hits a URL that either gives it a 200 with some json or
- // 204 No Content. On windows it takes a base path and looks for
- // files under that path.
- if (process.platform === 'darwin') {
- // include the current version in the URL we hit. Electron doesn't add
- // it anywhere (apart from the User-Agent) so it's up to us. We could
- // (and previously did) just use the User-Agent, but this doesn't
- // rely on NSURLConnection setting the User-Agent to what we expect,
- // and also acts as a convenient cache-buster to ensure that when the
- // app updates it always gets a fresh value to avoid update-looping.
- electron.autoUpdater.setFeedURL(
- `${updateBaseUrl}macos/?localVersion=${encodeURIComponent(electron.app.getVersion())}`);
-
- } else if (process.platform === 'win32') {
- electron.autoUpdater.setFeedURL(`${updateBaseUrl}win32/${process.arch}/`);
- } else {
- // Squirrel / electron only supports auto-update on these two platforms.
- // I'm not even going to try to guess which feed style they'd use if they
- // implemented it on Linux, or if it would be different again.
- console.log('Auto update not supported on this platform');
- }
- // We check for updates ourselves rather than using 'updater' because we need to
- // do it in the main process (and we don't really need to check every 10 minutes:
- // every hour should be just fine for a desktop app)
- // However, we still let the main window listen for the update events.
- // We also wait a short time before checking for updates the first time because
- // of squirrel on windows and it taking a small amount of time to release a
- // lock file.
- setTimeout(pollForUpdates, INITIAL_UPDATE_DELAY_MS);
- setInterval(pollForUpdates, UPDATE_POLL_INTERVAL_MS);
- } catch (err) {
- // will fail if running in debug mode
- console.log('Couldn\'t enable update checking', err);
- }
-}
// handle uncaught errors otherwise it displays
// stack traces in popup dialogs, which is terrible (which
@@ -119,9 +60,6 @@ process.on('uncaughtException', function(error) {
console.log('Unhandled exception', error);
});
-electron.ipcMain.on('install_update', installUpdate);
-electron.ipcMain.on('checkForUpdates', pollForUpdates);
-
let focusHandlerAttached = false;
electron.ipcMain.on('setBadgeCount', function(ev, count) {
electron.app.setBadgeCount(count);
@@ -219,7 +157,7 @@ electron.ipcMain.on('settings_set', function(ev, key, value) {
electron.app.on('ready', () => {
if (vectorConfig.update_base_url) {
console.log(`Starting auto update with base URL: ${vectorConfig.update_base_url}`);
- startAutoUpdate(vectorConfig.update_base_url);
+ updater.start(vectorConfig.update_base_url)
} else {
console.log('No update_base_url is defined: auto update is disabled');
}
@@ -265,7 +203,7 @@ electron.app.on('ready', () => {
mainWindow = null;
});
mainWindow.on('close', (e) => {
- if (!appQuitting && (tray.hasTray() || process.platform === 'darwin')) {
+ if (!global.appQuitting && (tray.hasTray() || process.platform === 'darwin')) {
// On Mac, closing the window just hides it
// (this is generally how single-window Mac apps
// behave, eg. Mail.app)
@@ -288,7 +226,7 @@ electron.app.on('activate', () => {
});
electron.app.on('before-quit', () => {
- appQuitting = true;
+ global.appQuitting = true;
});
// Set the App User Model ID to match what the squirrel
diff --git a/electron_app/src/updater.js b/electron_app/src/updater.js
new file mode 100644
index 0000000000..ea7b259fb4
--- /dev/null
+++ b/electron_app/src/updater.js
@@ -0,0 +1,65 @@
+const { app, autoUpdater, ipcMain } = require('electron');
+
+const UPDATE_POLL_INTERVAL_MS = 60 * 60 * 1000;
+const INITIAL_UPDATE_DELAY_MS = 30 * 1000;
+
+function installUpdate() {
+ // for some reason, quitAndInstall does not fire the
+ // before-quit event, so we need to set the flag here.
+ global.appQuitting = true;
+ autoUpdater.quitAndInstall();
+}
+
+function pollForUpdates() {
+ try {
+ autoUpdater.checkForUpdates();
+ } catch (e) {
+ console.log('Couldn\'t check for update', e);
+ }
+}
+
+module.exports = {};
+module.exports.start = function startAutoUpdate(updateBaseUrl) {
+ if (updateBaseUrl.slice(-1) !== '/') {
+ updateBaseUrl = updateBaseUrl + '/';
+ }
+ try {
+ // For reasons best known to Squirrel, the way it checks for updates
+ // is completely different between macOS and windows. On macOS, it
+ // hits a URL that either gives it a 200 with some json or
+ // 204 No Content. On windows it takes a base path and looks for
+ // files under that path.
+ if (process.platform === 'darwin') {
+ // include the current version in the URL we hit. Electron doesn't add
+ // it anywhere (apart from the User-Agent) so it's up to us. We could
+ // (and previously did) just use the User-Agent, but this doesn't
+ // rely on NSURLConnection setting the User-Agent to what we expect,
+ // and also acts as a convenient cache-buster to ensure that when the
+ // app updates it always gets a fresh value to avoid update-looping.
+ autoUpdater.setFeedURL(`${updateBaseUrl}macos/?localVersion=${encodeURIComponent(app.getVersion())}`);
+
+ } else if (process.platform === 'win32') {
+ autoUpdater.setFeedURL(`${updateBaseUrl}win32/${process.arch}/`);
+ } else {
+ // Squirrel / electron only supports auto-update on these two platforms.
+ // I'm not even going to try to guess which feed style they'd use if they
+ // implemented it on Linux, or if it would be different again.
+ console.log('Auto update not supported on this platform');
+ }
+ // We check for updates ourselves rather than using 'updater' because we need to
+ // do it in the main process (and we don't really need to check every 10 minutes:
+ // every hour should be just fine for a desktop app)
+ // However, we still let the main window listen for the update events.
+ // We also wait a short time before checking for updates the first time because
+ // of squirrel on windows and it taking a small amount of time to release a
+ // lock file.
+ setTimeout(pollForUpdates, INITIAL_UPDATE_DELAY_MS);
+ setInterval(pollForUpdates, UPDATE_POLL_INTERVAL_MS);
+ } catch (err) {
+ // will fail if running in debug mode
+ console.log('Couldn\'t enable update checking', err);
+ }
+}
+
+ipcMain.on('install_update', installUpdate);
+ipcMain.on('checkForUpdates', pollForUpdates);
From c4fd139586f14449bb830f2dc62c6b053c41dcdd Mon Sep 17 00:00:00 2001
From: Michael Telatynski <7t3chguy@gmail.com>
Date: Sun, 11 Jun 2017 16:46:47 +0100
Subject: [PATCH 11/19] get rid of pointless interval and timeout on linux
Signed-off-by: Michael Telatynski <7t3chguy@gmail.com>
---
electron_app/src/updater.js | 27 ++++++++++++++++-----------
1 file changed, 16 insertions(+), 11 deletions(-)
diff --git a/electron_app/src/updater.js b/electron_app/src/updater.js
index ea7b259fb4..e585dc977d 100644
--- a/electron_app/src/updater.js
+++ b/electron_app/src/updater.js
@@ -24,6 +24,7 @@ module.exports.start = function startAutoUpdate(updateBaseUrl) {
updateBaseUrl = updateBaseUrl + '/';
}
try {
+ let url;
// For reasons best known to Squirrel, the way it checks for updates
// is completely different between macOS and windows. On macOS, it
// hits a URL that either gives it a 200 with some json or
@@ -36,25 +37,29 @@ module.exports.start = function startAutoUpdate(updateBaseUrl) {
// rely on NSURLConnection setting the User-Agent to what we expect,
// and also acts as a convenient cache-buster to ensure that when the
// app updates it always gets a fresh value to avoid update-looping.
- autoUpdater.setFeedURL(`${updateBaseUrl}macos/?localVersion=${encodeURIComponent(app.getVersion())}`);
+ url = `${updateBaseUrl}macos/?localVersion=${encodeURIComponent(app.getVersion())}`;
} else if (process.platform === 'win32') {
- autoUpdater.setFeedURL(`${updateBaseUrl}win32/${process.arch}/`);
+ url = `${updateBaseUrl}win32/${process.arch}/`;
} else {
// Squirrel / electron only supports auto-update on these two platforms.
// I'm not even going to try to guess which feed style they'd use if they
// implemented it on Linux, or if it would be different again.
console.log('Auto update not supported on this platform');
}
- // We check for updates ourselves rather than using 'updater' because we need to
- // do it in the main process (and we don't really need to check every 10 minutes:
- // every hour should be just fine for a desktop app)
- // However, we still let the main window listen for the update events.
- // We also wait a short time before checking for updates the first time because
- // of squirrel on windows and it taking a small amount of time to release a
- // lock file.
- setTimeout(pollForUpdates, INITIAL_UPDATE_DELAY_MS);
- setInterval(pollForUpdates, UPDATE_POLL_INTERVAL_MS);
+
+ if (url) {
+ autoUpdater.setFeedURL(url);
+ // We check for updates ourselves rather than using 'updater' because we need to
+ // do it in the main process (and we don't really need to check every 10 minutes:
+ // every hour should be just fine for a desktop app)
+ // However, we still let the main window listen for the update events.
+ // We also wait a short time before checking for updates the first time because
+ // of squirrel on windows and it taking a small amount of time to release a
+ // lock file.
+ setTimeout(pollForUpdates, INITIAL_UPDATE_DELAY_MS);
+ setInterval(pollForUpdates, UPDATE_POLL_INTERVAL_MS);
+ }
} catch (err) {
// will fail if running in debug mode
console.log('Couldn\'t enable update checking', err);
From a520f0bfedade23ecd532c2293d677bb790d1170 Mon Sep 17 00:00:00 2001
From: Michael Telatynski <7t3chguy@gmail.com>
Date: Sun, 11 Jun 2017 19:19:17 +0100
Subject: [PATCH 12/19] move all logic, make bar more generic pass through
actual errors and tidy needs testing
Signed-off-by: Michael Telatynski <7t3chguy@gmail.com>
---
electron_app/src/updater.js | 22 +++++-
.../views/globals/UpdateCheckBar.js | 74 ++++++-------------
src/i18n/strings/en_EN.json | 5 +-
src/vector/platform/ElectronPlatform.js | 70 ++++++++++--------
src/vector/platform/VectorBasePlatform.js | 29 +++++++-
src/vector/platform/WebPlatform.js | 34 +++++++--
6 files changed, 138 insertions(+), 96 deletions(-)
diff --git a/electron_app/src/updater.js b/electron_app/src/updater.js
index e585dc977d..106e3d2f23 100644
--- a/electron_app/src/updater.js
+++ b/electron_app/src/updater.js
@@ -67,4 +67,24 @@ module.exports.start = function startAutoUpdate(updateBaseUrl) {
}
ipcMain.on('install_update', installUpdate);
-ipcMain.on('checkForUpdates', pollForUpdates);
+
+let ipcChannel;
+ipcMain.on('check_updates', function(event) {
+ ipcChannel = event.sender;
+ pollForUpdates();
+ // event.sender.send('check_updates') // true/false/error = available(downloading)/notAvailable/error
+});
+
+function ipcChannelSendUpdateStatus(status) {
+ if (ipcChannel) {
+ ipcChannel.send('check_updates', status);
+ }
+}
+
+autoUpdater.on('update-available', function() {
+ ipcChannelSendUpdateStatus(true);
+}).on('update-not-available', function() {
+ ipcChannelSendUpdateStatus(false);
+}).on('error', function(error) {
+ ipcChannelSendUpdateStatus(error.message);
+});
diff --git a/src/components/views/globals/UpdateCheckBar.js b/src/components/views/globals/UpdateCheckBar.js
index 4949c4426d..557698c711 100644
--- a/src/components/views/globals/UpdateCheckBar.js
+++ b/src/components/views/globals/UpdateCheckBar.js
@@ -17,76 +17,50 @@ limitations under the License.
'use strict';
import React from 'react';
-import dis from 'matrix-react-sdk/lib/dispatcher';
import { _t } from 'matrix-react-sdk/lib/languageHandler';
import PlatformPeg from 'matrix-react-sdk/lib/PlatformPeg';
-import {updateStateEnum} from '../../../vector/platform/VectorBasePlatform';
+import {updateCheckStatusEnum} from '../../../vector/platform/VectorBasePlatform';
import AccessibleButton from 'matrix-react-sdk/lib/components/views/elements/AccessibleButton';
+const statusText = {
+ CHECKING: 'Checking for an update...',
+ ERROR: 'Error encountered (%(errorDetail)s).',
+ NOTAVAILABLE: 'No update available.',
+ DOWNLOADING: 'Downloading update...',
+};
+
+const doneStatuses = [
+ updateCheckStatusEnum.ERROR,
+ updateCheckStatusEnum.NOTAVAILABLE,
+];
+
export default React.createClass({
-
- getInitialState: function() {
- return {
- message: _t('Checking for an update...'),
- done: false,
- };
- },
-
- componentWillMount: function() {
- PlatformPeg.get().checkForUpdate().done((state) => {
- if (this._unmounted) return;
-
- console.log('checkForUpdate done, ', state);
-
- // We will be replaced by NewVersionBar
- if (state === updateStateEnum.READY) return;
-
- let done = true;
- let message;
- switch (state) {
- case updateStateEnum.ERROR:
- message = _t('Error encountered when checking for an update.');
- break;
- case updateStateEnum.TIMEOUT:
- message = _t('Update Check timed out, try again later.');
- break;
- case updateStateEnum.NOTAVAILABLE:
- message = _t('No update found.');
- break;
- case updateStateEnum.DOWNLOADING:
- message = _t('Update is being downloaded.');
- done = false;
- break;
- }
-
- this.setState({message, done});
- });
- },
-
- componentWillUnmount: function() {
- this._unmounted = true;
+ propTypes: {
+ status: React.PropTypes.oneOf(Object.values(updateCheckStatusEnum)).isRequired,
+ // Currently for error detail but will be usable for download progress
+ // once that is a thing that squirrel passes through electron.
+ detail: React.PropTypes.string,
},
hideToolbar: function() {
- dis.dispatch({
- action: 'check_updates',
- value: false,
- });
+ PlatformPeg.get().stopUpdateCheck();
},
render: function() {
+ const message = _t(statusText[this.props.status], { errorDetail: this.props.detail });
+
let image;
- if (this.state.done) {
+ if (doneStatuses.includes(this.props.status)) {
image = ;
} else {
- image = ;
+ image = 
;
}
return (
diff --git a/src/i18n/strings/en_EN.json b/src/i18n/strings/en_EN.json
index 2bce407061..1755fd620b 100644
--- a/src/i18n/strings/en_EN.json
+++ b/src/i18n/strings/en_EN.json
@@ -159,8 +159,9 @@
"Yesterday": "Yesterday",
"OK": "OK",
"Checking for an update...": "Checking for an update...",
- "Error encountered when checking for an update.": "Error encountered when checking for an update.",
- "Update Check timed out, try again later.": "Update Check timed out, try again later.",
+ "Error encountered (%(errorDetail)s).": "Error encountered (%(errorDetail)s).",
+ "No update available.": "No update available.",
+ "Downloading update...": "Downloading update...",
"No update found.": "No update found.",
"Update is being downloaded.": "Update is being downloaded.",
"You need to be using HTTPS to place a screen-sharing call.": "You need to be using HTTPS to place a screen-sharing call.",
diff --git a/src/vector/platform/ElectronPlatform.js b/src/vector/platform/ElectronPlatform.js
index 519cadc09d..7a1bf58292 100644
--- a/src/vector/platform/ElectronPlatform.js
+++ b/src/vector/platform/ElectronPlatform.js
@@ -17,11 +17,11 @@ See the License for the specific language governing permissions and
limitations under the License.
*/
-import VectorBasePlatform, {updateStateEnum} from './VectorBasePlatform';
+import VectorBasePlatform, {updateCheckStatusEnum} from './VectorBasePlatform';
import dis from 'matrix-react-sdk/lib/dispatcher';
import { _t } from 'matrix-react-sdk/lib/languageHandler';
import q from 'q';
-import electron, {remote, ipcRenderer} from 'electron';
+import {remote, ipcRenderer} from 'electron';
remote.autoUpdater.on('update-downloaded', onUpdateDownloaded);
@@ -62,11 +62,42 @@ function _onAction(payload: Object) {
}
}
+function getUpdateCheckStatus(status) {
+ if (status === true) {
+ return { status: updateCheckStatusEnum.DOWNLOADING };
+ } else if (status === false) {
+ return { status: updateCheckStatusEnum.NOTAVAILABLE };
+ } else {
+ return {
+ status: updateCheckStatusEnum.ERROR,
+ detail: status,
+ };
+ }
+}
+
export default class ElectronPlatform extends VectorBasePlatform {
constructor() {
super();
dis.register(_onAction);
this.updatable = Boolean(remote.autoUpdater.getFeedURL());
+
+ /*
+ IPC Call `check_updates` returns:
+ true if there is an update available
+ false if there is not
+ or the error if one is encountered
+ */
+ ipcRenderer.on('check_updates', (event, status) => {
+ if (!this.showUpdateCheck) return;
+ dis.dispatch({
+ action: 'check_updates',
+ value: getUpdateCheckStatus(status),
+ });
+ this.showUpdateCheck = false;
+ });
+
+ this.startUpdateCheck = this.startUpdateCheck.bind(this);
+ this.stopUpdateCheck = this.stopUpdateCheck.bind(this);
}
getHumanReadableName(): string {
@@ -138,43 +169,18 @@ export default class ElectronPlatform extends VectorBasePlatform {
return q(remote.app.getVersion());
}
- checkForUpdate() { // manual update check for this platform
- const deferred = q.defer();
+ startUpdateCheck() {
+ if (this.showUpdateCheck) return;
+ super.startUpdateCheck();
- const _onUpdateAvailable = function() {
- remote.autoUpdater.removeListener('update-not-available', _onUpdateNotAvailable);
- remote.autoUpdater.removeListener('error', _onError);
- deferred.resolve(updateStateEnum.DOWNLOADING);
- }
- const _onUpdateNotAvailable = function() {
- remote.autoUpdater.removeListener('update-available', _onUpdateAvailable);
- remote.autoUpdater.removeListener('error', _onError);
- deferred.resolve(updateStateEnum.NOTAVAILABLE);
- }
- const _onError = function() {
- remote.autoUpdater.removeListener('update-not-available', _onUpdateNotAvailable);
- remote.autoUpdater.removeListener('update-available', _onUpdateAvailable);
- deferred.resolve(updateStateEnum.ERROR);
- }
-
- remote.autoUpdater.once('update-available', _onUpdateAvailable);
- remote.autoUpdater.once('update-not-available', _onUpdateNotAvailable);
- remote.autoUpdater.once('error', _onError);
-
- remote.ipcRenderer.send('checkForUpdates');
- return deferred.promise.timeout(10000).catch(() => {
- remote.autoUpdater.removeListener('update-not-available', _onUpdateNotAvailable);
- remote.autoUpdater.removeListener('update-available', _onUpdateAvailable);
- remote.autoUpdater.removeListener('error', _onError);
- return updateStateEnum.TIMEOUT;
- });
+ ipcRenderer.send('check_updates');
}
installUpdate() {
// IPC to the main process to install the update, since quitAndInstall
// doesn't fire the before-quit event so the main process needs to know
// it should exit.
- electron.ipcRenderer.send('install_update');
+ ipcRenderer.send('install_update');
}
getDefaultDeviceDisplayName(): string {
diff --git a/src/vector/platform/VectorBasePlatform.js b/src/vector/platform/VectorBasePlatform.js
index 074be91c83..0e84e5fcd5 100644
--- a/src/vector/platform/VectorBasePlatform.js
+++ b/src/vector/platform/VectorBasePlatform.js
@@ -19,12 +19,13 @@ limitations under the License.
import BasePlatform from 'matrix-react-sdk/lib/BasePlatform';
import { _t } from 'matrix-react-sdk/lib/languageHandler';
+import dis from 'matrix-react-sdk/lib/dispatcher';
import Favico from 'favico.js';
-export const updateStateEnum = {
+export const updateCheckStatusEnum = {
+ CHECKING: 'CHECKING',
ERROR: 'ERROR',
- TIMEOUT: 'TIMEOUT',
NOTAVAILABLE: 'NOTAVAILABLE',
DOWNLOADING: 'DOWNLOADING',
READY: 'READY',
@@ -42,8 +43,12 @@ export default class VectorBasePlatform extends BasePlatform {
// and we set the state each time, even if the value hasn't changed,
// so we'd need to fix that if enabling the animation.
this.favicon = new Favico({animation: 'none'});
+ this.showUpdateCheck = false;
this._updateFavicon();
this.updatable = true;
+
+ this.startUpdateCheck = this.startUpdateCheck.bind(this);
+ this.stopUpdateCheck = this.stopUpdateCheck.bind(this);
}
getHumanReadableName(): string {
@@ -96,14 +101,30 @@ export default class VectorBasePlatform extends BasePlatform {
return this.updatable;
}
+ startUpdateCheck() {
+ this.showUpdateCheck = true;
+ dis.dispatch({
+ action: 'check_updates',
+ value: { status: updateCheckStatusEnum.CHECKING },
+ });
+ }
+
+ stopUpdateCheck() {
+ this.showUpdateCheck = false;
+ dis.dispatch({
+ action: 'check_updates',
+ value: false,
+ })
+ }
+
/**
* Check for the availability of an update to the version of the
* app that's currently running.
* If an update is available, this function should dispatch the
* 'new_version' action.
- * @returns Promise;
+ image = ;
} else {
image = ;
}
diff --git a/src/i18n/strings/en_EN.json b/src/i18n/strings/en_EN.json
index a535ced6ce..10c21a62d7 100644
--- a/src/i18n/strings/en_EN.json
+++ b/src/i18n/strings/en_EN.json
@@ -159,6 +159,7 @@
"Today": "Today",
"Yesterday": "Yesterday",
"OK": "OK",
+ "Warning": "Warning",
"Checking for an update...": "Checking for an update...",
"Error encountered (%(errorDetail)s).": "Error encountered (%(errorDetail)s).",
"No update available.": "No update available.",