fix(nsis): EULA

Closes #829

docs/Options.md

@@ -188,6 +188,7 @@ See [NSIS target notes](https://github.com/electron-userland/electron-builder/wi
 | 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).
+| license | <a name="NsisOptions-license"></a>The path to EULA license file. Defaults to `build/license.rtf` or `build/license.txt`.
 | language | <a name="NsisOptions-language"></a>* [LCID Dec](https://msdn.microsoft.com/en-au/goglobal/bb964664.aspx), defaults to `1033`(`English - United States`).
 | warningsAsErrors | <a name="NsisOptions-warningsAsErrors"></a><p>Defaults to <code>false</code>.</p> <p>If <code>warningsAsErrors</code> is <code>true</code> (default): NSIS will treat warnings as errors.</p> <p>If <code>warningsAsErrors</code> is <code>false</code>: NSIS will allow warnings.</p>
 

nsis-auto-updater/package.json

@@ -16,7 +16,7 @@
     "fs-extra-p": "^1.1.10",
     "ini": "^1.3.4",
     "semver": "^5.3.0",
-    "source-map-support": "^0.4.4",
+    "source-map-support": "^0.4.5",
     "tunnel-agent": "^0.4.3"
   },
   "typings": "./out/electron-auto-updater.d.ts"

nsis-auto-updater/yarn.lock

@@ -106,9 +106,9 @@ semver@^5.3.0:
   version "5.3.0"
   resolved "https://registry.yarnpkg.com/semver/-/semver-5.3.0.tgz#9b2ce5d3de02d17c6012ad326aa6b4d0cf54f94f"
 
-source-map-support:
-  version "0.4.4"
-  resolved "https://registry.yarnpkg.com/source-map-support/-/source-map-support-0.4.4.tgz#0df5765a05a560c91bc8f8641cf79f2affc0322e"
+source-map-support@^0.4.5:
+  version "0.4.5"
+  resolved "https://registry.yarnpkg.com/source-map-support/-/source-map-support-0.4.5.tgz#4438df4219e1b3c7feb674614b4c67f9722db1e4"
   dependencies:
     source-map "^0.5.3"
 

src/options/winOptions.ts

@@ -102,6 +102,11 @@ export interface NsisOptions {
    */
   readonly script?: string | null
 
+  /*
+  The path to EULA license file. Defaults to `build/license.rtf` or `build/license.txt`.
+   */
+  readonly license?: string | null
+
   /*
    * [LCID Dec](https://msdn.microsoft.com/en-au/goglobal/bb964664.aspx), defaults to `1033`(`English - United States`).
    */

src/platformPackager.ts

@@ -467,18 +467,18 @@ export abstract class PlatformPackager<DC extends PlatformSpecificBuildOptions>
     return asArray(this.devMetadata.build.fileAssociations).concat(asArray(this.platformSpecificBuildOptions.fileAssociations))
   }
 
-  async getResource(custom: string | n, name: string): Promise<string | null> {
-    let result = custom
-    if (result === undefined) {
+  async getResource(custom: string | n, ...names: Array<string>): Promise<string | null> {
+    if (custom === undefined) {
       const resourceList = await this.resourceList
-      if (resourceList.includes(name)) {
-        return path.join(this.buildResourcesDir, name)
+      for (let name of names) {
+        if (resourceList.includes(name)) {
+          return path.join(this.buildResourcesDir, name)
+        }
       }
     }
-    else {
-      return path.resolve(this.projectDir, result)
+    else if (!isEmptyOrSpaces(custom)) {
+      return path.resolve(this.projectDir, custom)
     }
-
     return null
   }
 }

src/targets/nsis.ts

@@ -176,6 +176,11 @@ export default class NsisTarget extends TargetEx {
       return
     }
 
+    const licenseFile = await this.packager.getResource(this.options.license, "license.rtf", "license.txt")
+    if (licenseFile != null) {
+      defines.LICENSE_FILE = licenseFile
+    }
+
     const customScriptPath = await this.packager.getResource(this.options.script, "installer.nsi")
     const script = await readFile(customScriptPath || path.join(this.nsisTemplatesDir, "installer.nsi"), "utf8")
 

templates/nsis/allowOnlyOneInstallerInstace.nsh → templates/nsis/allowOnlyOneInstallerInstance.nsh

@@ -1,7 +1,7 @@
 !include "nsProcess.nsh"
 
 # http://nsis.sourceforge.net/Allow_only_one_installer_instance
-!macro ALLOW_ONLY_ONE_INSTALLER_INSTACE
+!macro ALLOW_ONLY_ONE_INSTALLER_INSTANCE
   BringToFront
   !define /ifndef SYSTYPE_PTR p ; NSIS v3.0+
   System::Call 'kernel32::CreateMutex(${SYSTYPE_PTR}0, i1, t"${APP_GUID}")?e'

templates/nsis/boringInstaller.nsh

@@ -12,6 +12,10 @@
   !define MUI_FINISHPAGE_RUN
   !define MUI_FINISHPAGE_RUN_FUNCTION "StartApp"
 
+  !ifdef LICENSE_FILE
+    !insertmacro MUI_PAGE_LICENSE "${LICENSE_FILE}"
+  !endif
+
   !ifndef INSTALL_MODE_PER_ALL_USERS
     !insertmacro PAGE_INSTALL_MODE
     Function GuiInit
@@ -20,6 +24,7 @@
 
     !define MUI_CUSTOMFUNCTION_GUIINIT GuiInit
   !endif
+
   !insertmacro MUI_PAGE_INSTFILES
   !insertmacro MUI_PAGE_FINISH
 !else

templates/nsis/installer.nsi

@@ -1,7 +1,7 @@
 !include "common.nsh"
 !include "MUI2.nsh"
 !include "multiUser.nsh"
-!include "allowOnlyOneInstallerInstace.nsh"
+!include "allowOnlyOneInstallerInstance.nsh"
 
 !ifdef INSTALL_MODE_PER_ALL_USERS
   !ifdef BUILD_UNINSTALLER
@@ -41,10 +41,10 @@ Function .onInit
     !insertmacro initMultiUser
 
     !ifdef ONE_CLICK
-      !insertmacro ALLOW_ONLY_ONE_INSTALLER_INSTACE
+      !insertmacro ALLOW_ONLY_ONE_INSTALLER_INSTANCE
     !else
       ${IfNot} ${UAC_IsInnerInstance}
-        !insertmacro ALLOW_ONLY_ONE_INSTALLER_INSTACE
+        !insertmacro ALLOW_ONLY_ONE_INSTALLER_INSTANCE
       ${EndIf}
     !endif
 

templates/nsis/oneClick.nsh

@@ -11,6 +11,10 @@
   !endif
 !endif
 
+!ifdef LICENSE_FILE
+  !insertmacro MUI_PAGE_LICENSE "${LICENSE_FILE}"
+!endif
+
 !insertmacro MUI_PAGE_INSTFILES
 !ifdef BUILD_UNINSTALLER
   !insertmacro MUI_UNPAGE_INSTFILES

test/fixtures/license.txt

@@ -0,0 +1 @@
+Hi!

test/src/nsisTest.ts

@@ -63,7 +63,7 @@ test.ifDevOrLinuxCi("perMachine, no run after finish", app({
 }, {
   projectDirCreated: projectDir => {
     let headerIconPath = path.join(projectDir, "build", "foo.ico")
-    return copy(getTestAsset("headerIcon.ico"), headerIconPath)
+    return BluebirdPromise.all([copy(getTestAsset("headerIcon.ico"), headerIconPath), copy(getTestAsset("license.txt"), path.join(projectDir, "build", "license.txt"))])
   },
   packed: context => {
     return doTest(context.outDir, false)
@@ -134,7 +134,12 @@ test.ifNotCiOsx("boring", app({
       },
     }
   }
-}, {signed: true}))
+}, {
+  signed: true,
+  projectDirCreated: projectDir => {
+    return copy(getTestAsset("license.txt"), path.join(projectDir, "build", "license.txt"))
+  },
+}))
 
 test.ifNotCiOsx("boring, only perMachine", app({
   targets: nsisTarget,

yarn.lock

@@ -2480,8 +2480,8 @@ map-stream@~0.1.0:
   resolved "https://registry.yarnpkg.com/map-stream/-/map-stream-0.1.0.tgz#e56aa94c4c8055a16404a0674b78f215f7c8e194"
 
 markdown-it@^8.0.0:
-  version "8.0.0"
-  resolved "https://registry.yarnpkg.com/markdown-it/-/markdown-it-8.0.0.tgz#e66255497a0e409e816fbc67807975f4f26f6f82"
+  version "8.0.1"
+  resolved "https://registry.yarnpkg.com/markdown-it/-/markdown-it-8.0.1.tgz#ff60e2103d17896cb6c57407baa9766f916495cb"
   dependencies:
     argparse "^1.0.7"
     entities "~1.1.1"
@@ -3436,9 +3436,9 @@ sort-keys@^1.1.1:
   dependencies:
     is-plain-obj "^1.0.0"
 
-source-map-support@^0.4.2, source-map-support@^0.4.3, source-map-support@^0.4.4:
-  version "0.4.4"
-  resolved "https://registry.yarnpkg.com/source-map-support/-/source-map-support-0.4.4.tgz#0df5765a05a560c91bc8f8641cf79f2affc0322e"
+source-map-support@^0.4.2, source-map-support@^0.4.3, source-map-support@^0.4.4, source-map-support@^0.4.5:
+  version "0.4.5"
+  resolved "https://registry.yarnpkg.com/source-map-support/-/source-map-support-0.4.5.tgz#4438df4219e1b3c7feb674614b4c67f9722db1e4"
   dependencies:
     source-map "^0.5.3"