feat(nsis): ability to recreate desktop shortcut on fresh install

Close #2725
electron-userland · Mar 21, 2018 · 432b3e9 · 432b3e9
1 parent 0ae220e
commit 432b3e9
Show file tree

Hide file tree

Showing 6 changed files with 74 additions and 11 deletions.
diff --git a/packages/electron-builder-lib/src/options/CommonWindowsInstallerConfiguration.ts b/packages/electron-builder-lib/src/options/CommonWindowsInstallerConfiguration.ts
@@ -18,10 +18,10 @@ export interface CommonWindowsInstallerConfiguration {
   readonly runAfterFinish?: boolean
 
   /**
-   * Whether to create desktop shortcut.
+   * Whether to create desktop shortcut. Set to `always` if to recreate also on reinstall (even if removed by user).
    * @default true
    */
-  readonly createDesktopShortcut?: boolean
+  readonly createDesktopShortcut?: boolean | "always"
 
   /**
    * Whether to create start menu shortcut.
@@ -48,7 +48,7 @@ export interface FinalCommonWindowsInstallerOptions {
   shortcutName: string
   menuCategory: string | null
 
-  isCreateDesktopShortcut: boolean
+  isCreateDesktopShortcut: DesktopShortcutCreationPolicy
   isCreateStartMenuShortcut: boolean
 }
 
@@ -74,8 +74,24 @@ export function getEffectiveOptions(options: CommonWindowsInstallerConfiguration
     isAssisted: options.oneClick === false,
 
     shortcutName: isEmptyOrSpaces(options.shortcutName) ? appInfo.productFilename : packager.expandMacro(options.shortcutName!!),
-    isCreateDesktopShortcut: options.createDesktopShortcut !== false,
+    isCreateDesktopShortcut: convertToDesktopShortcutCreationPolicy(options.createDesktopShortcut),
     isCreateStartMenuShortcut: options.createStartMenuShortcut !== false,
     menuCategory,
   }
+}
+
+function convertToDesktopShortcutCreationPolicy(value: boolean | undefined | string): DesktopShortcutCreationPolicy {
+  if (value === false) {
+    return DesktopShortcutCreationPolicy.NEVER
+  }
+  else if (value === "always") {
+    return DesktopShortcutCreationPolicy.ALWAYS
+  }
+  else {
+    return DesktopShortcutCreationPolicy.FRESH_INSTALL
+  }
+}
+
+export enum DesktopShortcutCreationPolicy {
+  FRESH_INSTALL, ALWAYS, NEVER
 }
diff --git a/packages/electron-builder-lib/src/targets/MsiTarget.ts b/packages/electron-builder-lib/src/targets/MsiTarget.ts
@@ -9,7 +9,7 @@ import { Lazy } from "lazy-val"
 import * as path from "path"
 import { MsiOptions } from "../"
 import { Target } from "../core"
-import { FinalCommonWindowsInstallerOptions, getEffectiveOptions } from "../options/CommonWindowsInstallerConfiguration"
+import { DesktopShortcutCreationPolicy, FinalCommonWindowsInstallerOptions, getEffectiveOptions } from "../options/CommonWindowsInstallerConfiguration"
 import { getTemplatePath } from "../util/pathManager"
 import { VmManager } from "../vm/vm"
 import { WineVmManager } from "../vm/WineVm"
@@ -209,10 +209,10 @@ export default class MsiTarget extends Target {
       else if (directoryId === null) {
         result += ` Id="${path.basename(packagePath)}_f"`
       }
-      if (isMainExecutable && (commonOptions.isCreateDesktopShortcut || commonOptions.isCreateStartMenuShortcut)) {
+      if (isMainExecutable && (commonOptions.isCreateDesktopShortcut !== DesktopShortcutCreationPolicy.NEVER || commonOptions.isCreateStartMenuShortcut)) {
         result += `>\n`
         const shortcutName = commonOptions.shortcutName
-        if (commonOptions.isCreateDesktopShortcut) {
+        if (commonOptions.isCreateDesktopShortcut !== DesktopShortcutCreationPolicy.NEVER) {
           result += `${fileSpace}  <Shortcut Id="desktopShortcut" Directory="DesktopFolder" Name="${shortcutName}" WorkingDirectory="APPLICATIONFOLDER" Advertise="yes" Icon="icon.ico"/>\n`
         }
 

diff --git a/packages/electron-builder-lib/src/targets/nsis/NsisTarget.ts b/packages/electron-builder-lib/src/targets/nsis/NsisTarget.ts
@@ -9,7 +9,7 @@ import { readFile, stat, unlink } from "fs-extra-p"
 import { Lazy } from "lazy-val"
 import * as path from "path"
 import { Target } from "../../core"
-import { getEffectiveOptions } from "../../options/CommonWindowsInstallerConfiguration"
+import { DesktopShortcutCreationPolicy, getEffectiveOptions } from "../../options/CommonWindowsInstallerConfiguration"
 import { isSafeGithubName, normalizeExt } from "../../platformPackager"
 import { time } from "../../util/timer"
 import { WinPackager } from "../../winPackager"
@@ -386,9 +386,12 @@ export class NsisTarget extends Target {
     })
 
     defines.UNINSTALL_DISPLAY_NAME = packager.expandMacro(options.uninstallDisplayName || "${productName} ${version}", null, {}, false)
-    if (!commonOptions.isCreateDesktopShortcut) {
+    if (commonOptions.isCreateDesktopShortcut === DesktopShortcutCreationPolicy.NEVER) {
       defines.DO_NOT_CREATE_DESKTOP_SHORTCUT = null
     }
+    if (commonOptions.isCreateDesktopShortcut === DesktopShortcutCreationPolicy.ALWAYS) {
+      defines.RECREATE_DESKTOP_SHORTCUT = null
+    }
     if (!commonOptions.isCreateStartMenuShortcut) {
       defines.DO_NOT_CREATE_START_MENU_SHORTCUT = null
     }

diff --git a/packages/electron-builder-lib/templates/nsis/include/installer.nsh b/packages/electron-builder-lib/templates/nsis/include/installer.nsh
@@ -219,17 +219,27 @@
     ${ifNot} ${isNoDesktopShortcut}
       # The keepShortcuts mechanism is NOT enabled.
       # Shortcuts will be recreated.
-      ${if} $keepShortcuts  == "false"
+      ${if} $keepShortcuts == "false"
         CreateShortCut "$newDesktopLink" "$appExe" "" "$appExe" 0 "" "" "${APP_DESCRIPTION}"
         ClearErrors
         WinShell::SetLnkAUMI "$newDesktopLink" "${APP_ID}"
       # The keepShortcuts mechanism IS enabled.
       # The desktop shortcut could exist in an obsolete location (due to name change).
       ${elseif} $oldDesktopLink != $newDesktopLink
-      ${andIf} ${FileExists} "$oldDesktopLink"
+      ${orIf} ${FileExists} "$oldDesktopLink"
         Rename $oldDesktopLink $newDesktopLink
         WinShell::UninstShortcut "$oldDesktopLink"
         WinShell::SetLnkAUMI "$newDesktopLink" "${APP_ID}"
+
+      !ifdef RECREATE_DESKTOP_SHORTCUT
+      ${elseif} $oldDesktopLink != $newDesktopLink
+      ${orIfNot} ${FileExists} "$oldDesktopLink"
+        ${ifNot} ${isUpdated}
+          CreateShortCut "$newDesktopLink" "$appExe" "" "$appExe" 0 "" "" "${APP_DESCRIPTION}"
+          ClearErrors
+          WinShell::SetLnkAUMI "$newDesktopLink" "${APP_ID}"
+        ${endIf}
+      !endif
       ${endIf}
       System::Call 'Shell32::SHChangeNotify(i 0x8000000, i 0, i 0, i 0)'
     ${endIf}

diff --git a/test/out/windows/__snapshots__/oneClickInstallerTest.js.snap b/test/out/windows/__snapshots__/oneClickInstallerTest.js.snap
@@ -12,6 +12,30 @@ Object {
 }
 `;
 
+exports[`createDesktopShortcut always 1`] = `
+Object {
+  "win": Array [
+    Object {
+      "arch": "x64",
+      "file": "Test App ßW Setup 1.1.0.exe",
+      "safeArtifactName": "TestApp-Setup-1.1.0.exe",
+      "updateInfo": Object {
+        "sha512": "@sha512",
+        "size": "@size",
+      },
+    },
+    Object {
+      "file": "Test App ßW Setup 1.1.0.exe.blockmap",
+      "safeArtifactName": "TestApp-Setup-1.1.0.exe.blockmap",
+      "updateInfo": Object {
+        "sha512": "@sha512",
+        "size": "@size",
+      },
+    },
+  ],
+}
+`;
+
 exports[`custom include 1`] = `
 Object {
   "win": Array [

diff --git a/test/src/windows/oneClickInstallerTest.ts b/test/src/windows/oneClickInstallerTest.ts
@@ -66,6 +66,16 @@ test.ifAll.ifNotCiMac("html license", app({
   },
 }))
 
+test.ifAll.ifDevOrWinCi("createDesktopShortcut always", app({
+  targets: Platform.WINDOWS.createTarget("nsis"),
+  config: {
+    publish: null,
+    nsis: {
+      createDesktopShortcut: "always",
+    }
+  },
+}))
+
 test.ifDevOrLinuxCi("perMachine, no run after finish", app({
   targets: Platform.WINDOWS.createTarget(["nsis"], Arch.ia32),
   config: {