Merge pull request #824 from ctrlaltdavid/fix/interface-console

Remove "Console" options from Interface-only installer (Windows)
2025-04-07 20:22:27 +02:00 · 2020-12-20 16:34:25 -05:00 · 2020-12-20 16:34:25 -05:00 · f1576aba78
commit f1576aba78
parent 89d1346644 71cee734ec
5 changed files with 89 additions and 38 deletions
--- a/INSTALLER.md
+++ b/INSTALLER.md
--- a/README.md
+++ b/README.md
@ -30,7 +30,7 @@ Vircadia is a 3D social software project seeking to incrementally bring about a

 ### How to generate an Installer

-[For Windows](https://github.com/vircadia/vircadia/blob/master/INSTALL.md)
+[For Windows](https://github.com/vircadia/vircadia/blob/master/INSTALLER.md)

 [For Linux - AppImage - Vircadia Builder](https://github.com/vircadia/vircadia-builder/blob/master/README.md#building-appimages)

--- a/cmake/macros/OptionalWinExecutableSigning.cmake
+++ b/cmake/macros/OptionalWinExecutableSigning.cmake
@ -10,7 +10,7 @@
 #

 macro(optional_win_executable_signing)
-  if (WIN32 AND PRODUCTION_BUILD)
+  if (WIN32 AND PRODUCTION_BUILD AND NOT BYPASS_SIGNING)
    if (DEFINED ENV{HF_PFX_FILE})
      if (DEFINED ENV{HF_PFX_PASSPHRASE})
        message(STATUS "Executable for ${TARGET_NAME} will be signed with SignTool.")
--- a/cmake/macros/SetPackagingParameters.cmake
+++ b/cmake/macros/SetPackagingParameters.cmake
@ -25,6 +25,7 @@ macro(SET_PACKAGING_PARAMETERS)
  set_from_env(RELEASE_NUMBER RELEASE_NUMBER "")
  set_from_env(STABLE_BUILD STABLE_BUILD 0)
  set_from_env(INITIAL_STARTUP_LOCATION INITIAL_STARTUP_LOCATION "")
+  set_from_env(BYPASS_SIGNING BYPASS_SIGNING 0)

  message(STATUS "The RELEASE_TYPE variable is: ${RELEASE_TYPE}")

--- a/cmake/templates/NSIS.template.in
+++ b/cmake/templates/NSIS.template.in
@ -837,16 +837,24 @@ Function PostInstallOptionsPage
    !insertmacro SetInstallOption $DesktopClientCheckbox @CLIENT_DESKTOP_SHORTCUT_REG_KEY@ ${BST_CHECKED}
  ${EndIf}

+  ; FIXME: Re-enable or permanently remove system tray "Console" for Interface-only installs.
+  ;${If} @SERVER_COMPONENT_CONDITIONAL@
+  ;  ${NSD_CreateCheckbox} 0 $CurrentOffset$OffsetUnits 100% 10u "&Create a desktop shortcut for @SANDBOX_HF_SHORTCUT_NAME@"
+  ;${Else}
+  ;  ${NSD_CreateCheckbox} 0 $CurrentOffset$OffsetUnits 100% 10u "&Create a desktop shortcut for @CONSOLE_HF_SHORTCUT_NAME@"
+  ;${EndIf}
+  ;Pop $DesktopConsoleCheckbox
+  ;IntOp $CurrentOffset $CurrentOffset + 15  
+  ;
+  ;; set the checkbox state depending on what is present in the registry
+  ;!insertmacro SetInstallOption $DesktopConsoleCheckbox @CONSOLE_DESKTOP_SHORTCUT_REG_KEY@ ${BST_UNCHECKED}
  ${If} @SERVER_COMPONENT_CONDITIONAL@
    ${NSD_CreateCheckbox} 0 $CurrentOffset$OffsetUnits 100% 10u "&Create a desktop shortcut for @SANDBOX_HF_SHORTCUT_NAME@"
-  ${Else}
-    ${NSD_CreateCheckbox} 0 $CurrentOffset$OffsetUnits 100% 10u "&Create a desktop shortcut for @CONSOLE_HF_SHORTCUT_NAME@"
+    Pop $DesktopConsoleCheckbox
+    IntOp $CurrentOffset $CurrentOffset + 15  
+    ; set the checkbox state depending on what is present in the registry
+    !insertmacro SetInstallOption $DesktopConsoleCheckbox @CONSOLE_DESKTOP_SHORTCUT_REG_KEY@ ${BST_UNCHECKED}
  ${EndIf}
-  
-  Pop $DesktopConsoleCheckbox
-  IntOp $CurrentOffset $CurrentOffset + 15  
-  ; set the checkbox state depending on what is present in the registry
-  !insertmacro SetInstallOption $DesktopConsoleCheckbox @CONSOLE_DESKTOP_SHORTCUT_REG_KEY@ ${BST_UNCHECKED}

  ${If} @CLIENT_COMPONENT_CONDITIONAL@
    ${NSD_CreateCheckbox} 0 $CurrentOffset$OffsetUnits 100% 10u "&Launch @INTERFACE_HF_SHORTCUT_NAME@ after install"
@ -861,31 +869,54 @@ Function PostInstallOptionsPage
    ${EndIf}
  ${EndIf}

+  ; FIXME: Re-enable or permanently remove system tray "Console" for Interface-only installs.
+  ;${If} @SERVER_COMPONENT_CONDITIONAL@
+  ;  ${NSD_CreateCheckbox} 0 $CurrentOffset$OffsetUnits 100% 10u "&Launch @SANDBOX_HF_SHORTCUT_NAME@ after install"
+  ;${Else}
+  ;  ${NSD_CreateCheckbox} 0 $CurrentOffset$OffsetUnits 100% 10u "&Launch @CONSOLE_HF_SHORTCUT_NAME@ after install"
+  ;${EndIf}
+  ;Pop $LaunchConsoleNowCheckbox
+  ;
+  ;; set the checkbox state depending on what is present in the registry
+  ;!insertmacro SetInstallOption $LaunchConsoleNowCheckbox @SERVER_LAUNCH_NOW_REG_KEY@ ${BST_UNCHECKED}
+  ;${StrContains} $substringResult "/forceNoLaunchServer" $CMDLINE
+  ;${IfNot} $substringResult == ""
+  ;  ${NSD_SetState} $LaunchConsoleNowCheckbox ${BST_UNCHECKED}
+  ;${EndIf}
+  ;IntOp $CurrentOffset $CurrentOffset + 15
  ${If} @SERVER_COMPONENT_CONDITIONAL@
    ${NSD_CreateCheckbox} 0 $CurrentOffset$OffsetUnits 100% 10u "&Launch @SANDBOX_HF_SHORTCUT_NAME@ after install"
-  ${Else}
-    ${NSD_CreateCheckbox} 0 $CurrentOffset$OffsetUnits 100% 10u "&Launch @CONSOLE_HF_SHORTCUT_NAME@ after install"
-  ${EndIf}
-  Pop $LaunchConsoleNowCheckbox
-
-  ; set the checkbox state depending on what is present in the registry
-  !insertmacro SetInstallOption $LaunchConsoleNowCheckbox @SERVER_LAUNCH_NOW_REG_KEY@ ${BST_UNCHECKED}
-  ${StrContains} $substringResult "/forceNoLaunchServer" $CMDLINE
-  ${IfNot} $substringResult == ""
+    Pop $LaunchConsoleNowCheckbox
+    
+    ; set the checkbox state depending on what is present in the registry
+    !insertmacro SetInstallOption $LaunchConsoleNowCheckbox @SERVER_LAUNCH_NOW_REG_KEY@ ${BST_UNCHECKED}
+    ${StrContains} $substringResult "/forceNoLaunchServer" $CMDLINE
+    ${IfNot} $substringResult == ""
      ${NSD_SetState} $LaunchConsoleNowCheckbox ${BST_UNCHECKED}
+    ${EndIf}
+    IntOp $CurrentOffset $CurrentOffset + 15
  ${EndIf}
-  IntOp $CurrentOffset $CurrentOffset + 30
-
-  ${If} @SERVER_COMPONENT_CONDITIONAL@  
-    ${NSD_CreateCheckbox} 0 $CurrentOffset$OffsetUnits 100% 10u "&Launch @SANDBOX_HF_SHORTCUT_NAME@ on startup"
-  ${Else}
-    ${NSD_CreateCheckbox} 0 $CurrentOffset$OffsetUnits 100% 10u "&Launch @CONSOLE_HF_SHORTCUT_NAME@ on startup"
-  ${EndIf}
-  Pop $ConsoleStartupCheckbox
  IntOp $CurrentOffset $CurrentOffset + 15

-  ; set the checkbox state depending on what is present in the registry
-  !insertmacro SetInstallOption $ConsoleStartupCheckbox @CONSOLE_STARTUP_REG_KEY@ ${BST_UNCHECKED}
+  ; FIXME: Re-enable or permanently remove system tray "Console" for Interface-only installs.
+  ;${If} @SERVER_COMPONENT_CONDITIONAL@
+  ;  ${NSD_CreateCheckbox} 0 $CurrentOffset$OffsetUnits 100% 10u "&Launch @SANDBOX_HF_SHORTCUT_NAME@ on startup"
+  ;${Else}
+  ;  ${NSD_CreateCheckbox} 0 $CurrentOffset$OffsetUnits 100% 10u "&Launch @CONSOLE_HF_SHORTCUT_NAME@ on startup"
+  ;${EndIf}
+  ;Pop $ConsoleStartupCheckbox
+  ;IntOp $CurrentOffset $CurrentOffset + 15
+  ;
+  ;; set the checkbox state depending on what is present in the registry
+  ;!insertmacro SetInstallOption $ConsoleStartupCheckbox @CONSOLE_STARTUP_REG_KEY@ ${BST_UNCHECKED}
+  ${If} @SERVER_COMPONENT_CONDITIONAL@
+    ${NSD_CreateCheckbox} 0 $CurrentOffset$OffsetUnits 100% 10u "&Launch @SANDBOX_HF_SHORTCUT_NAME@ on startup"
+    Pop $ConsoleStartupCheckbox
+    IntOp $CurrentOffset $CurrentOffset + 15
+    
+    ; set the checkbox state depending on what is present in the registry
+    !insertmacro SetInstallOption $ConsoleStartupCheckbox @CONSOLE_STARTUP_REG_KEY@ ${BST_UNCHECKED}
+  ${EndIf}

  ${NSD_CreateCheckbox} 0 $CurrentOffset$OffsetUnits 100% 10u "&Perform a clean install (Delete older settings and content)"
  Pop $CleanInstallCheckbox
@ -957,13 +988,29 @@ FunctionEnd

 Function ReadPostInstallOptions

-  ; check if the user asked for a desktop shortcut to console
-  ${NSD_GetState} $DesktopConsoleCheckbox $DesktopConsoleState
-  ${LogText} "Option: Start Desktop Console: $DesktopConsoleState"
+  ; FIXME: Re-enable or permanently remove system tray "Console" for Interface-only installs.
+  ;; check if the user asked for a desktop shortcut to console
+  ;${NSD_GetState} $DesktopConsoleCheckbox $DesktopConsoleState
+  ;${LogText} "Option: Start Desktop Console: $DesktopConsoleState"
+  ${If} @SERVER_COMPONENT_CONDITIONAL@
+    ; check if the user asked for a desktop shortcut to console
+    ${NSD_GetState} $DesktopConsoleCheckbox $DesktopConsoleState
+    ${LogText} "Option: Start Desktop Console: $DesktopConsoleState"
+  ${Else}
+    StrCpy $DesktopConsoleState ${BST_UNCHECKED}
+  ${EndIf}
  
-  ; check if the user asked to have console launched every startup
-  ${NSD_GetState} $ConsoleStartupCheckbox $ConsoleStartupState
-  ${LogText} "Option: Start Desktop Console On Startup: $ConsoleStartupState"
+  ; FIXME: Re-enable or permanently remove system tray "Console" for Interface-only installs.
+  ;; check if the user asked to have console launched every startup
+  ;${NSD_GetState} $ConsoleStartupCheckbox $ConsoleStartupState
+  ;${LogText} "Option: Start Desktop Console On Startup: $ConsoleStartupState"
+  ${If} @SERVER_COMPONENT_CONDITIONAL@
+    ; check if the user asked to have console launched every startup
+    ${NSD_GetState} $ConsoleStartupCheckbox $ConsoleStartupState
+    ${LogText} "Option: Start Desktop Console On Startup: $ConsoleStartupState"
+  ${Else}
+    StrCpy $ConsoleStartupState ${BST_UNCHECKED}
+  ${EndIf}

  ${If} @SERVER_COMPONENT_CONDITIONAL@
    ${LogText} "Option: Install Server"
@ -1308,10 +1355,13 @@ Section "-Core installation"
  ${Else}
    ; handling for interface only console shortcut
    Delete "$SMPROGRAMS\$STARTMENU_FOLDER\@SANDBOX_HF_SHORTCUT_NAME@.lnk"
-    CreateShortCut "$SMPROGRAMS\$STARTMENU_FOLDER\@CONSOLE_SHORTCUT_NAME@.lnk" \
-      "$INSTDIR\@CONSOLE_INSTALL_SUBDIR@\@CONSOLE_WIN_EXEC_NAME@"
-    ; Set appUserModelId
-    ApplicationID::Set "$SMPROGRAMS\$STARTMENU_FOLDER\@CONSOLE_SHORTCUT_NAME@.lnk" "@APP_USER_MODEL_ID@"
+
+    ; FIXME: Re-enable or permanently remove system tray "Console" for Interface-only installs.
+    ;CreateShortCut "$SMPROGRAMS\$STARTMENU_FOLDER\@CONSOLE_SHORTCUT_NAME@.lnk" \
+    ;  "$INSTDIR\@CONSOLE_INSTALL_SUBDIR@\@CONSOLE_WIN_EXEC_NAME@"
+    ;; Set appUserModelId
+    ;ApplicationID::Set "$SMPROGRAMS\$STARTMENU_FOLDER\@CONSOLE_SHORTCUT_NAME@.lnk" "@APP_USER_MODEL_ID@"
+
  ${EndIf}

  CreateShortCut "$SMPROGRAMS\$STARTMENU_FOLDER\Uninstall.lnk" "$INSTDIR\@UNINSTALLER_NAME@"