From 5b9104e8aa2bc21cde1d70d2e129f480e913333f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=C8=98tefan=20Daniel=20Mih=C4=83il=C4=83?= Date: Fri, 24 Feb 2017 21:12:03 +0200 Subject: [PATCH] feat(GUI): warn when atempting to burn Windows images (#1043) Change-Type: minor Changelog-Entry: Show warning when user tries to flash a Windows image Closes: https://github.com/resin-io/etcher/issues/1035 --- .../warning-modal/services/warning-modal.js | 3 +- .../templates/warning-modal.tpl.html | 2 +- lib/gui/models/supported-formats.js | 26 +++++++++-- lib/gui/os/open-external/open-external.js | 16 +++++++ .../pages/main/controllers/image-selection.js | 44 ++++++++++++++++--- lib/shared/messages.js | 7 +++ tests/gui/models/supported-formats.spec.js | 30 +++++++++++++ 7 files changed, 115 insertions(+), 13 deletions(-) diff --git a/lib/gui/components/warning-modal/services/warning-modal.js b/lib/gui/components/warning-modal/services/warning-modal.js index befdf699..e2b0c2f5 100644 --- a/lib/gui/components/warning-modal/services/warning-modal.js +++ b/lib/gui/components/warning-modal/services/warning-modal.js @@ -18,7 +18,7 @@ const _ = require('lodash'); -module.exports = function(ModalService) { +module.exports = function($sce, ModalService) { /** * @summary Display the warning modal @@ -39,6 +39,7 @@ module.exports = function(ModalService) { * }); */ this.display = (options = {}) => { + options.description = $sce.trustAsHtml(options.description); return ModalService.open({ template: './components/warning-modal/templates/warning-modal.tpl.html', controller: 'WarningModalController as modal', diff --git a/lib/gui/components/warning-modal/templates/warning-modal.tpl.html b/lib/gui/components/warning-modal/templates/warning-modal.tpl.html index 7b60ad70..1d00fdd2 100644 --- a/lib/gui/components/warning-modal/templates/warning-modal.tpl.html +++ b/lib/gui/components/warning-modal/templates/warning-modal.tpl.html @@ -7,7 +7,7 @@
-

{{ ::modal.options.description }}

+

diff --git a/lib/gui/models/supported-formats.js b/lib/gui/models/supported-formats.js index e1d7bd41..8ac695b3 100644 --- a/lib/gui/models/supported-formats.js +++ b/lib/gui/models/supported-formats.js @@ -107,15 +107,15 @@ SupportedFormats.service('SupportedFormatsModel', function() { * @function * @public * - * @param {String} image - image path + * @param {String} imagePath - image path * @returns {Boolean} whether the image is supported * * if (SupportedFormatsModel.isSupportedImage('foo.iso.bz2')) { * console.log('The image is supported!'); * } */ - this.isSupportedImage = (image) => { - const extension = path.extname(image).slice(1).toLowerCase(); + this.isSupportedImage = (imagePath) => { + const extension = path.extname(imagePath).slice(1).toLowerCase(); if (_.some([ _.includes(this.getNonCompressedExtensions(), extension), @@ -128,7 +128,25 @@ SupportedFormats.service('SupportedFormatsModel', function() { return false; } - return this.isSupportedImage(path.basename(image, `.${extension}`)); + return this.isSupportedImage(path.basename(imagePath, `.${extension}`)); + }; + + /** + * @summary Check if an image seems to be a Windows image + * @function + * @public + * + * @param {String} imagePath - image path + * @returns {Boolean} whether the image seems to be a Windows image + * + * @example + * if (SupportedFormatsModel.looksLikeWindowsImage('path/to/en_windows_7_ultimate_with_sp1_x86_dvd_u_677460.iso')) { + * console.log('Looks like a Windows image'); + * } + */ + this.looksLikeWindowsImage = (imagePath) => { + const regex = /windows|win7|win8|win10|winxp/i; + return regex.test(path.basename(imagePath)); }; }); diff --git a/lib/gui/os/open-external/open-external.js b/lib/gui/os/open-external/open-external.js index 3a22e33b..ddce865c 100644 --- a/lib/gui/os/open-external/open-external.js +++ b/lib/gui/os/open-external/open-external.js @@ -21,9 +21,25 @@ */ const angular = require('angular'); +const url = require('url'); + const MODULE_NAME = 'Etcher.OS.OpenExternal'; const OSOpenExternal = angular.module(MODULE_NAME, []); OSOpenExternal.service('OSOpenExternalService', require('./services/open-external')); OSOpenExternal.directive('osOpenExternal', require('./directives/open-external')); +OSOpenExternal.run(function(OSOpenExternalService) { + document.addEventListener('click', (event) => { + const target = event.target; + if (target.tagName === 'A' && angular.isDefined(target.href)) { + + // Electron interprets relative URLs as being relative to the current loaded URL (with `webContents.loadURL`) and expands + // them to the corresponding absolute URL. If it's a `file://` URL, we don't want it opened in an external browser. + if (url.parse(target.href).protocol !== 'file:') { + OSOpenExternalService.open(target.href); + } + } + }); +}); + module.exports = MODULE_NAME; diff --git a/lib/gui/pages/main/controllers/image-selection.js b/lib/gui/pages/main/controllers/image-selection.js index de63e8e3..06d84e48 100644 --- a/lib/gui/pages/main/controllers/image-selection.js +++ b/lib/gui/pages/main/controllers/image-selection.js @@ -17,9 +17,17 @@ 'use strict'; const _ = require('lodash'); +const Bluebird = require('bluebird'); const messages = require('../../../../shared/messages'); -module.exports = function(SupportedFormatsModel, SelectionStateModel, AnalyticsService, ErrorService, OSDialogService) { +module.exports = function( + SupportedFormatsModel, + SelectionStateModel, + AnalyticsService, + ErrorService, + OSDialogService, + WarningModalService +) { /** * @summary Main supported extensions @@ -65,14 +73,36 @@ module.exports = function(SupportedFormatsModel, SelectionStateModel, AnalyticsS return; } - SelectionStateModel.setImage(image); + Bluebird.try(() => { + if (!SupportedFormatsModel.looksLikeWindowsImage(image.path)) { + return false; + } - // An easy way so we can quickly identify if we're making use of - // certain features without printing pages of text to DevTools. - image.logo = Boolean(image.logo); - image.bmap = Boolean(image.bmap); + AnalyticsService.logEvent('Possibly Windows image', image); + + // TODO: `Continue` should be on a red background (dangerous action) instead of `Change`. + // We want `X` to act as `Continue`, that's why `Continue` is the `rejectionLabel` + return WarningModalService.display({ + confirmationLabel: 'Change', + rejectionLabel: 'Continue', + description: messages.warning.looksLikeWindowsImage() + }); + }).then((shouldChange) => { + + if (shouldChange) { + return this.reselectImage(); + } + + SelectionStateModel.setImage(image); + + // An easy way so we can quickly identify if we're making use of + // certain features without printing pages of text to DevTools. + image.logo = Boolean(image.logo); + image.bmap = Boolean(image.bmap); + + AnalyticsService.logEvent('Select image', image); + }).catch(ErrorService.reportException); - AnalyticsService.logEvent('Select image', image); }; /** diff --git a/lib/shared/messages.js b/lib/shared/messages.js index 98e93e5a..1f7f15b2 100644 --- a/lib/shared/messages.js +++ b/lib/shared/messages.js @@ -51,6 +51,13 @@ module.exports = { exitWhileFlashing: _.template([ 'You are currently flashing a drive.', 'Closing Etcher may leave your drive in an unusable state.' + ].join(' ')), + + looksLikeWindowsImage: _.template([ + 'It looks like you are trying to burn a Windows image.\n\n', + 'Unlike other images, Windows images require special processing to be made bootable.', + 'We suggest you use a tool specially designed for this purpose, such as', + 'Rufus.' ].join(' ')) }, diff --git a/tests/gui/models/supported-formats.spec.js b/tests/gui/models/supported-formats.spec.js index 063a4f8e..0e56f872 100644 --- a/tests/gui/models/supported-formats.spec.js +++ b/tests/gui/models/supported-formats.spec.js @@ -123,6 +123,36 @@ describe('Browser: SupportedFormats', function() { }); + describe('.looksLikeWindowsImage()', function() { + + _.each([ + 'C:\\path\\to\\en_windows_10_multiple_editions_version_1607_updated_jan_2017_x64_dvd_9714399.iso', + '/path/to/en_windows_10_multiple_editions_version_1607_updated_jan_2017_x64_dvd_9714399.iso', + '/path/to/Win10_1607_SingleLang_English_x32.iso', + '/path/to/en_winxp_pro_x86_build2600_iso.img' + ], (imagePath) => { + + it(`should return true if filename is ${imagePath}`, function() { + const looksLikeWindowsImage = SupportedFormatsModel.looksLikeWindowsImage(imagePath); + m.chai.expect(looksLikeWindowsImage).to.be.true; + }); + + }); + + _.each([ + 'C:\\path\\to\\2017-01-11-raspbian-jessie.img', + '/path/to/2017-01-11-raspbian-jessie.img' + ], (imagePath) => { + + it(`should return false if filename is ${imagePath}`, function() { + const looksLikeWindowsImage = SupportedFormatsModel.looksLikeWindowsImage(imagePath); + m.chai.expect(looksLikeWindowsImage).to.be.false; + }); + + }); + + }); + }); });