feat(nsis): metro sidebar, customizable sidebar

Close #1248

Author: develar

.idea/dictionaries/develar.xml

@@ -32,11 +32,11 @@ install:
 - nvm install $NODE_VERSION
 - nvm use --delete-prefix $NODE_VERSION
 - ln -sf $PWD/test/vendor/yarn.js /usr/local/bin/yarn
-- yarn install --pure-lockfile
+- yarn --link-duplicates --pure-lockfile
 - if [[ "$TRAVIS_BRANCH" == "master" && "$TRAVIS_PULL_REQUEST" == "false" && "$AUTO_PUBLISH" != "false" && "$TRAVIS_TAG" == "" && "$PUBLISH_TO_NPM" == "true" ]]; then yarn add @develar/semantic-release@next --dev ; fi
 
 script:
-- yarn run test
+- yarn test
 
 after_success:
 - if [[ "$TRAVIS_BRANCH" == "master" && "$TRAVIS_PULL_REQUEST" == "false" && "$AUTO_PUBLISH" != "false" && "$TRAVIS_TAG" == "" && "$PUBLISH_TO_NPM" == "true" ]]; then npm run semantic-release ; fi

.travis.yml

@@ -34,15 +34,12 @@ _Note: Platform specific `7zip-bin-*` packages are `optionalDependencies`, which
 
 1. Specify the standard fields in the application `package.json` — [name](https://github.com/electron-userland/electron-builder/wiki/Options#AppMetadata-name), `description`, `version` and [author](https://docs.npmjs.com/files/package.json#people-fields-author-contributors).
 
-2. Specify the [build](https://github.com/electron-userland/electron-builder/wiki/Options#build) configuration in the development `package.json` as follows:
+2. Specify the [build](https://github.com/electron-userland/electron-builder/wiki/Options#build) configuration in the `package.json` as follows:
     ```json
     "build": {
       "appId": "your.id",
       "mac": {
         "category": "your.app.category.type"
-      },
-      "win": {
-        "iconUrl": "(windows-only) https link to icon"
       }
     }
     ```

README.md

@@ -14,7 +14,7 @@ dependencies:
     - sudo apt-get install git-lfs=1.3.0
     - ssh git@github.com git-lfs-authenticate $CIRCLE_PROJECT_USERNAME/$CIRCLE_PROJECT_REPONAME.git download
     - git lfs pull
-    - docker run --rm --env-file ./test/docker-env.list -v ${PWD}:/project -v ~/.electron:/root/.electron -v ~/.cache/electron-builder:/root/.cache/electron-builder electronuserland/electron-builder:wine /bin/bash -c "node ./test/vendor/yarn.js && node ./test/vendor/yarn.js test"
+    - docker run --rm --env-file ./test/docker-env.list -v ${PWD}:/project -v ~/.electron:/root/.electron -v ~/.cache/electron-builder:/root/.cache/electron-builder electronuserland/electron-builder:wine /bin/bash -c "node ./test/vendor/yarn.js --link-duplicates --pure-lockfile && node ./test/vendor/yarn.js test"
 
 test:
   override:

circle.yml

@@ -181,6 +181,8 @@ See [NSIS target notes](https://github.com/electron-userland/electron-builder/wi
 | guid | <a name="NsisOptions-guid"></a>See [GUID vs Application Name](https://github.com/electron-userland/electron-builder/wiki/NSIS#guid-vs-application-name).
 | installerIcon | <a name="NsisOptions-installerIcon"></a>The path to installer icon. Defaults to `build/installerIcon.ico` or application icon.
 | installerHeader | <a name="NsisOptions-installerHeader"></a>*boring installer only.* `MUI_HEADERIMAGE`, relative to the project directory. Defaults to `build/installerHeader.bmp`
+| installerSidebar | <a name="NsisOptions-installerSidebar"></a>*boring installer only.* `MUI_WELCOMEFINISHPAGE_BITMAP`, relative to the project directory. Defaults to `build/installerSidebar.bmp` or `${NSISDIR}\\Contrib\\Graphics\\Wizard\\nsis3-metro.bmp`
+| uninstallerSidebar | <a name="NsisOptions-uninstallerSidebar"></a>*boring installer only.* `MUI_UNWELCOMEFINISHPAGE_BITMAP`, relative to the project directory. Defaults to `installerSidebar` option or `build/uninstallerSidebar.bmp` or `build/installerSidebar.bmp` or `${NSISDIR}\\Contrib\\Graphics\\Wizard\\nsis3-metro.bmp`
 | installerHeaderIcon | <a name="NsisOptions-installerHeaderIcon"></a>*one-click installer only.* The path to header icon (above the progress bar), relative to the project directory. Defaults to `build/installerHeaderIcon.ico` or application icon.
 | include | <a name="NsisOptions-include"></a>The path to NSIS include script to customize installer. Defaults to `build/installer.nsh`. See [Custom NSIS script](https://github.com/electron-userland/electron-builder/wiki/NSIS#custom-nsis-script).
 | script | <a name="NsisOptions-script"></a>The path to NSIS script to customize installer. Defaults to `build/installer.nsi`. See [Custom NSIS script](https://github.com/electron-userland/electron-builder/wiki/NSIS#custom-nsis-script).

docs/Options.md

@@ -25,7 +25,7 @@
     "7zip-bin": "^2.0.4",
     "archiver": "^1.3.0",
     "asar-electron-builder": "^0.13.5",
-    "aws-sdk": "^2.12.0",
+    "aws-sdk": "^2.13.0",
     "bluebird-lst-c": "^1.0.6",
     "chalk": "^1.1.3",
     "chromium-pickle-js": "^0.2.0",

package.json

@@ -114,6 +114,16 @@ export interface NsisOptions {
    */
   readonly installerHeader?: string | null
 
+  /*
+   *boring installer only.* `MUI_WELCOMEFINISHPAGE_BITMAP`, relative to the project directory. Defaults to `build/installerSidebar.bmp` or `${NSISDIR}\\Contrib\\Graphics\\Wizard\\nsis3-metro.bmp`
+   */
+  readonly installerSidebar?: string | null
+
+  /*
+   *boring installer only.* `MUI_UNWELCOMEFINISHPAGE_BITMAP`, relative to the project directory. Defaults to `installerSidebar` option or `build/uninstallerSidebar.bmp` or `build/installerSidebar.bmp` or `${NSISDIR}\\Contrib\\Graphics\\Wizard\\nsis3-metro.bmp`
+   */
+  readonly uninstallerSidebar?: string | null
+
   /*
    *one-click installer only.* The path to header icon (above the progress bar), relative to the project directory. Defaults to `build/installerHeaderIcon.ico` or application icon.
    */

packages/electron-builder/src/options/winOptions.ts

@@ -15,14 +15,10 @@ import { copyFile } from "electron-builder-util/out/fs"
 import { computeDownloadUrl, getPublishConfigs, getPublishConfigsForUpdateInfo } from "../publish/PublishManager"
 import { getSignVendorPath } from "../windowsCodeSign"
 
-const NSIS_VERSION = "3.0.1.7"
-//noinspection SpellCheckingInspection
-const NSIS_SHA2 = "0e797a7099283bf9caf97ee677e1d7986278c27b39916a501480978af039817c"
-
-//noinspection SpellCheckingInspection
 const ELECTRON_BUILDER_NS_UUID = "50e065bc-3134-11e6-9bab-38c9862bdaf3"
 
-const nsisPathPromise = getBinFromBintray("nsis", NSIS_VERSION, NSIS_SHA2)
+const nsisPathPromise = getBinFromBintray("nsis", "3.0.1.8", "d9429cc33d06198b48b939e51f48fc95b3b7ccd5584dd9fe3f3f4eacce9d8275")
+const nsisResourcePathPromise = getBinFromBintray("nsis-resources", "3.0.0", "cde0e77b249e29d74250bf006aa355d3e02b32226e1c6431fb48facae41d8a7e")
 
 const USE_NSIS_BUILT_IN_COMPRESSOR = false
 
@@ -156,7 +152,7 @@ export default class NsisTarget extends Target {
       OutFile: `"${installerPath}"`,
       VIProductVersion: appInfo.versionInWeirdWindowsForm,
       VIAddVersionKey: this.computeVersionKey(),
-      Unicode: this.isUnicodeEnabled(),
+      Unicode: this.isUnicodeEnabled,
     }
 
     if (packager.config.compression === "store") {
@@ -182,7 +178,7 @@ export default class NsisTarget extends Target {
     packager.dispatchArtifactCreated(installerPath, this, `${packager.appInfo.name}-${this.isWebInstaller ? "Web-" : ""}Setup-${version}.exe`)
   }
 
-  private isUnicodeEnabled() {
+  private get isUnicodeEnabled() {
     return this.options.unicode == null ? true : this.options.unicode
   }
 
@@ -236,16 +232,34 @@ export default class NsisTarget extends Target {
     const packager = this.packager
     const options = this.options
 
-    const installerHeader = oneClick ? null : await packager.getResource(options.installerHeader, "installerHeader.bmp")
-    if (installerHeader != null) {
-      defines.MUI_HEADERIMAGE = null
-      defines.MUI_HEADERIMAGE_RIGHT = null
-      defines.MUI_HEADERIMAGE_BITMAP = installerHeader
+    if (oneClick) {
+      defines.ONE_CLICK = null
+
+      if (options.runAfterFinish !== false) {
+        defines.RUN_AFTER_FINISH = null
+      }
+
+      const installerHeaderIcon = await packager.getResource(options.installerHeaderIcon, "installerHeaderIcon.ico")
+      if (installerHeaderIcon != null) {
+        defines.HEADER_ICO = installerHeaderIcon
+      }
     }
+    else {
+      const installerHeader = await
+      packager.getResource(options.installerHeader, "installerHeader.bmp")
+      if (installerHeader != null) {
+        defines.MUI_HEADERIMAGE = null
+        defines.MUI_HEADERIMAGE_RIGHT = null
+        defines.MUI_HEADERIMAGE_BITMAP = installerHeader
+      }
+
+      const bitmap = (await packager.getResource(options.installerSidebar, "installerSidebar.bmp")) || "${NSISDIR}\\Contrib\\Graphics\\Wizard\\nsis3-metro.bmp"
+      defines.MUI_WELCOMEFINISHPAGE_BITMAP = bitmap
+      defines.MUI_UNWELCOMEFINISHPAGE_BITMAP = (await packager.getResource(options.uninstallerSidebar, "uninstallerSidebar.bmp")) || bitmap
 
-    const installerHeaderIcon = oneClick ? await packager.getResource(options.installerHeaderIcon, "installerHeaderIcon.ico") : null
-    if (installerHeaderIcon != null) {
-      defines.HEADER_ICO = installerHeaderIcon
+      if (options.allowElevation !== false) {
+        defines.MULTIUSER_INSTALLMODE_ALLOW_ELEVATION = null
+      }
     }
 
     if (options.perMachine === true) {
@@ -256,15 +270,6 @@ export default class NsisTarget extends Target {
       defines.INSTALL_MODE_PER_ALL_USERS_REQUIRED = null
     }
 
-    if (oneClick) {
-      if (options.runAfterFinish !== false) {
-        defines.RUN_AFTER_FINISH = null
-      }
-    }
-    else if (options.allowElevation !== false) {
-      defines.MULTIUSER_INSTALLMODE_ALLOW_ELEVATION = null
-    }
-
     if (options.allowToChangeInstallationDirectory) {
       if (oneClick) {
         throw new Error("allowToChangeInstallationDirectory makes sense only for boring installer (please set oneClick to false)")
@@ -280,10 +285,6 @@ export default class NsisTarget extends Target {
       defines.COMPRESSION_METHOD = options.useZip ? "zip" : "7z"
     }
 
-    if (oneClick) {
-      defines.ONE_CLICK = null
-    }
-
     if (options.menuCategory != null) {
       const menu = sanitizeFileName(options.menuCategory === true ? packager.appInfo.companyName : <string>options.menuCategory)
       if (!isEmptyOrSpaces(menu)) {
@@ -293,7 +294,7 @@ export default class NsisTarget extends Target {
 
     use(await packager.getResource(options.license, "license.rtf", "license.txt"), it => defines.LICENSE_FILE = it)
 
-    if (options.multiLanguageInstaller == null ? this.isUnicodeEnabled() : options.multiLanguageInstaller) {
+    if (options.multiLanguageInstaller == null ? this.isUnicodeEnabled : options.multiLanguageInstaller) {
       defines.MULTI_LANGUAGE_INSTALLER = null
     }
 
@@ -331,11 +332,17 @@ export default class NsisTarget extends Target {
     const binDir = process.platform === "darwin" ? "mac" : (process.platform === "win32" ? "Bin" : "linux")
     const nsisPath = await nsisPathPromise
 
+    let scriptHeader = `!addincludedir "${path.win32.join(__dirname, "..", "..", "templates", "nsis", "include")}"\n`
+    const pluginArch = this.isUnicodeEnabled ? "x86-unicode" : "x86-ansi"
+    scriptHeader += `!addplugindir /${pluginArch} "${path.join(await nsisResourcePathPromise, "plugins", pluginArch)}"\n`
+
     let script = originalScript
     const packager = this.packager
     const customInclude = await packager.getResource(this.options.include, "installer.nsh")
     if (customInclude != null) {
-      script = `!addincludedir "${packager.buildResourcesDir}"\n!addplugindir "${packager.buildResourcesDir}"\n\n!include "${customInclude}"\n\n${script}`
+      scriptHeader += `!addincludedir "${packager.buildResourcesDir}"\n`
+      scriptHeader += `!addplugindir /${pluginArch} "${path.join(packager.buildResourcesDir, pluginArch)}"\n`
+      script = `\n!include "${customInclude}"\n\n${script}`
     }
 
     const fileAssociations = packager.fileAssociations
@@ -378,6 +385,8 @@ export default class NsisTarget extends Target {
       }
     }
 
+    script = scriptHeader + script
+
     if (debug.enabled) {
       process.stdout.write("\n\nNSIS script:\n\n" + script + "\n\n---\nEnd of NSIS script.\n\n")
     }