Add cross-platform support for the new menuinst

CONSTRUCT.md

@@ -126,9 +126,13 @@ _required:_ no<br/>
 _type:_ list<br/>
 
 A list of packages with menu items to be installed. The packages must have
-necessary metadata in `Menu/<package name>.json`). Menu items are currently
-only supported on Windows. By default, all menu items will be installed;
-supplying this list allows a subset to be selected instead.
+necessary metadata in `Menu/<package name>.json`). By default, all menu items
+found in the installation will be created; supplying this list allows a
+subset to be selected instead. If an empty list is supplied, no shortcuts will
+be created.
+
+If all environments (`extra_envs` included) set `menu_packages` to an empty list,
+no UI options about shortcuts will be offered to the user.
 
 ### `ignore_duplicate_files`
 
@@ -217,6 +221,8 @@ name) to a dictionary of options:
   an empty list.
 - `user_requested_specs` (list of str): same as the global option, but for this env;
   if not provided, global value is _not_ used
+- `menu_packages` (list of str): same as the global option, for this env;
+  if not provided, the global value is _not_ used.
 
 Notes:
 - `ignore_duplicate_files` will always be considered `True` if `extra_envs` is in use.

constructor/construct.py

@@ -80,11 +80,15 @@
 is contained as a result of resolving the specs for `python 2.7`.
 '''),
 
-    ('menu_packages',          False, list, '''
+    ('menu_packages',           False, list, '''
 A list of packages with menu items to be installed. The packages must have
-necessary metadata in `Menu/<package name>.json`). Menu items are currently
-only supported on Windows. By default, all menu items will be installed;
-supplying this list allows a subset to be selected instead.
+necessary metadata in `Menu/<package name>.json`). By default, all menu items
+found in the installation will be created; supplying this list allows a
+subset to be selected instead. If an empty list is supplied, no shortcuts will
+be created.
+
+If all environments (`extra_envs` included) set `menu_packages` to an empty list,
+no UI options about shortcuts will be offered to the user.
 '''),
 
     ('ignore_duplicate_files',  False, bool, '''
@@ -148,6 +152,8 @@
   an empty list.
 - `user_requested_specs` (list of str): same as the global option, but for this env;
   if not provided, global value is _not_ used
+- `menu_packages` (list of str): same as the global option, for this env;
+  if not provided, the global value is _not_ used.
 
 Notes:
 - `ignore_duplicate_files` will always be considered `True` if `extra_envs` is in use.

constructor/header.sh

@@ -42,6 +42,9 @@ KEEP_PKGS=1
 KEEP_PKGS=0
 #endif
 SKIP_SCRIPTS=0
+#if enable_shortcuts
+SKIP_SHORTCUTS=0
+#endif
 TEST=0
 REINSTALL=0
 USAGE="
@@ -66,6 +69,9 @@ Installs __NAME__ __VERSION__
 -p PREFIX    install prefix, defaults to $PREFIX
 #endif
 -s           skip running pre/post-link/install scripts
+#if enable_shortcuts
+-m           disable the creation of menu items / shortcuts
+#endif
 -u           update an existing installation
 #if has_conda
 -t           run package tests after installation (may install conda-build)
@@ -76,7 +82,11 @@ Installs __NAME__ __VERSION__
 # However getopt is not standardized and the version on Mac has different
 # behaviour. getopts is good enough for what we need :)
 # More info: https://unix.stackexchange.com/questions/62950/
+#if enable_shortcuts
+while getopts "bifhkp:smut" x; do
+#else
 while getopts "bifhkp:sut" x; do
+#endif
     case "$x" in
         h)
             printf "%s\\n" "$USAGE"
@@ -100,6 +110,11 @@ while getopts "bifhkp:sut" x; do
         s)
             SKIP_SCRIPTS=1
             ;;
+#if enable_shortcuts
+        m)
+            SKIP_SHORTCUTS=1
+            ;;
+#endif
         u)
             FORCE=1
             ;;
@@ -386,7 +401,7 @@ cd "$PREFIX"
 unset PYTHON_SYSCONFIGDATA_NAME _CONDA_PYTHON_SYSCONFIGDATA_NAME
 
 # the first binary payload: the standalone conda executable
-CONDA_EXEC="$PREFIX/conda.exe"
+CONDA_EXEC="$PREFIX/_conda.exe"
 extract_range "${boundary0}" "${boundary1}" > "$CONDA_EXEC"
 chmod +x "$CONDA_EXEC"
 
@@ -438,13 +453,26 @@ mkdir -p ~/.conda > /dev/null 2>&1
 
 printf "\nInstalling base environment...\n\n"
 
+#if enable_shortcuts
+if [ "$SKIP_SHORTCUTS" = "1" ]; then
+    shortcuts="--no-shortcuts"
+else
+    shortcuts="__SHORTCUTS__"
+fi
+#else
+shortcuts="--no-shortcuts"
+#endif
+
+# shellcheck disable=SC2086
+CONDA_ROOT_PREFIX="$PREFIX" \
 CONDA_SAFETY_CHECKS=disabled \
 CONDA_EXTRA_SAFETY_CHECKS=no \
 CONDA_CHANNELS="__CHANNELS__" \
 CONDA_PKGS_DIRS="$PREFIX/pkgs" \
-"$CONDA_EXEC" install --offline --file "$PREFIX/pkgs/env.txt" -yp "$PREFIX" || exit 1
+"$CONDA_EXEC" install --offline --file "$PREFIX/pkgs/env.txt" -yp "$PREFIX" $shortcuts || exit 1
 rm -f "$PREFIX/pkgs/env.txt"
 
+#The templating doesn't support nested if statements
 #if has_conda
 mkdir -p "$PREFIX/envs"
 for env_pkgs in "${PREFIX}"/pkgs/envs/*/; do
@@ -461,13 +489,27 @@ for env_pkgs in "${PREFIX}"/pkgs/envs/*/; do
     else
         env_channels="__CHANNELS__"
     fi
-
+#endif
+#if has_conda and enable_shortcuts
+    if [ "$SKIP_SHORTCUTS" = "1" ]; then
+        env_shortcuts="--no-shortcuts"
+    else
+        # This file is guaranteed to exist, even if empty
+        env_shortcuts=$(cat "${env_pkgs}shortcuts.txt")
+        rm -f "${env_pkgs}shortcuts.txt"
+    fi
+#else
+    env_shortcuts="--no-shortcuts"
+#endif
+#if has_conda
     # TODO: custom shortcuts per env?
+    # shellcheck disable=SC2086
+    CONDA_ROOT_PREFIX="$PREFIX" \
     CONDA_SAFETY_CHECKS=disabled \
     CONDA_EXTRA_SAFETY_CHECKS=no \
     CONDA_CHANNELS="$env_channels" \
     CONDA_PKGS_DIRS="$PREFIX/pkgs" \
-    "$CONDA_EXEC" install --offline --file "${env_pkgs}env.txt" -yp "$PREFIX/envs/$env_name" || exit 1
+    "$CONDA_EXEC" install --offline --file "${env_pkgs}env.txt" -yp "$PREFIX/envs/$env_name" $env_shortcuts || exit 1
     rm -f "${env_pkgs}env.txt"
 done
 #endif
@@ -477,9 +519,6 @@ __INSTALL_COMMANDS__
 POSTCONDA="$PREFIX/postconda.tar.bz2"
 "$CONDA_EXEC" constructor --prefix "$PREFIX" --extract-tarball < "$POSTCONDA" || exit 1
 rm -f "$POSTCONDA"
-
-rm -f "$CONDA_EXEC"
-
 rm -rf "$PREFIX/install_tmp"
 export TMP="$TMP_BACKUP"
 
@@ -620,4 +659,5 @@ fi
 #endif
 
 exit 0
+# shellcheck disable=SC2317
 @@END_HEADER@@

constructor/main.py

@@ -142,6 +142,16 @@ def main_build(dir_path, output_dir='.', platform=cc_platform,
             if config_key == "environment_file":
                 env_config[config_key] = abspath(join(dir_path, value))
 
+    # Installers will provide shortcut options and features only if the user
+    # didn't opt-out by setting every `menu_packages` item to an empty list
+    info['_enable_shortcuts'] = bool(
+        info.get("menu_packages", True)
+        or any(
+            env.get("menu_packages", True)
+            for env in info.get("_extra_envs_info", {}).values()
+        )
+    )
+
     info['installer_type'] = itypes[0]
     fcp_main(info, verbose=verbose, dry_run=dry_run, conda_exe=conda_exe)
     if dry_run:

constructor/nsis/OptionsDialog.nsh

@@ -43,7 +43,11 @@ Function mui_AnaCustomOptions_InitDefaults
             StrCpy $Ana_RegisterSystemPython_State ${BST_CHECKED}
         ${EndIf}
 	${If} $Ana_CreateShortcuts_State == ""
-        StrCpy $Ana_CreateShortcuts_State ${BST_CHECKED}
+        ${If} "${ENABLE_SHORTCUTS}" == "yes"
+            StrCpy $Ana_CreateShortcuts_State ${BST_CHECKED}
+        ${Else}
+            StrCpy $Ana_CreateShortcuts_State ${BST_UNCHECKED}
+        ${EndIf}
     ${EndIf}
     ${EndIf}
 FunctionEnd
@@ -70,12 +74,15 @@ Function mui_AnaCustomOptions_Show
 
     # We will use $5 as the y axis accumulator, starting at 0
     # We sum the the number of 'u' units added by 'NSD_Create*' functions
+    IntOp $5 0 + 0
 
-    ${NSD_CreateCheckbox} 0 0u 100% 11u "Create start menu shortcuts (supported packages only)."
-    IntOp $5 0 + 11
-    Pop $mui_AnaCustomOptions.CreateShortcuts
-    ${NSD_SetState} $mui_AnaCustomOptions.CreateShortcuts $Ana_CreateShortcuts_State
-    ${NSD_OnClick} $mui_AnaCustomOptions.CreateShortcuts CreateShortcuts_OnClick
+    ${If} "${ENABLE_SHORTCUTS}" == "yes"
+        ${NSD_CreateCheckbox} 0 0u 100% 11u "Create start menu shortcuts (supported packages only)."
+        IntOp $5 $5 + 11
+        Pop $mui_AnaCustomOptions.CreateShortcuts
+        ${NSD_SetState} $mui_AnaCustomOptions.CreateShortcuts $Ana_CreateShortcuts_State
+        ${NSD_OnClick} $mui_AnaCustomOptions.CreateShortcuts CreateShortcuts_OnClick
+    ${EndIf}
 
     ${If} "${SHOW_ADD_TO_PATH}" == "yes"
         # AddToPath is only an option for JustMe installations; it is disabled for AllUsers

constructor/nsis/main.nsi.tmpl

@@ -56,7 +56,7 @@ Unicode "true"
 !define DEFAULT_PREFIX_ALL_USERS __DEFAULT_PREFIX_ALL_USERS__
 !define PRE_INSTALL_DESC __PRE_INSTALL_DESC__
 !define POST_INSTALL_DESC __POST_INSTALL_DESC__
-!define MENU_PKGS "@MENU_PKGS@"
+!define ENABLE_SHORTCUTS __ENABLE_SHORTCUTS__
 !define SHOW_REGISTER_PYTHON __SHOW_REGISTER_PYTHON__
 !define SHOW_ADD_TO_PATH __SHOW_ADD_TO_PATH__
 !define PRODUCT_NAME "${NAME} ${VERSION} (${ARCH})"
@@ -288,14 +288,18 @@ FunctionEnd
         ${EndIf}
     ${EndIf}
 
-    ClearErrors
-    ${GetOptions} $ARGV "/NoShortcuts=" $ARGV_NoShortcuts
-    ${IfNot} ${Errors}
-        ${If} $ARGV_NoShortcuts = "1"
-            StrCpy $Ana_CreateShortcuts_State ${BST_UNCHECKED}
-        ${ElseIf} $ARGV_NoShortcuts = "0"
-            StrCpy $Ana_CreateShortcuts_State ${BST_CHECKED}
+    ${If} "${ENABLE_SHORTCUTS}" == "yes"
+        ClearErrors
+        ${GetOptions} $ARGV "/NoShortcuts=" $ARGV_NoShortcuts
+        ${IfNot} ${Errors}
+            ${If} $ARGV_NoShortcuts = "1"
+                StrCpy $Ana_CreateShortcuts_State ${BST_UNCHECKED}
+            ${ElseIf} $ARGV_NoShortcuts = "0"
+                StrCpy $Ana_CreateShortcuts_State ${BST_CHECKED}
+            ${EndIf}
         ${EndIf}
+    ${Else}
+        StrCpy $Ana_CreateShortcuts_State ${BST_UNCHECKED}
     ${EndIf}
 
     ClearErrors
@@ -1010,6 +1014,7 @@ Section "Install"
 
     System::Call 'kernel32::SetEnvironmentVariable(t,t)i("CONDA_SAFETY_CHECKS", "disabled").r0'
     System::Call 'kernel32::SetEnvironmentVariable(t,t)i("CONDA_EXTRA_SAFETY_CHECKS", "no").r0'
+    System::Call 'kernel32::SetEnvironmentVariable(t,t)i("CONDA_ROOT_PREFIX", "$INSTDIR")".r0'
     System::Call 'kernel32::SetEnvironmentVariable(t,t)i("CONDA_PKGS_DIRS", "$INSTDIR\pkgs")".r0'
     # Extra info for pre and post install scripts
     # NOTE: If more vars are added, make sure to update the examples/scripts tests too
@@ -1050,14 +1055,6 @@ Section "Install"
 
     AddSize @SIZE@
 
-    ${If} $Ana_CreateShortcuts_State = ${BST_CHECKED}
-        DetailPrint "Creating @NAME@ menus..."
-        push '"$INSTDIR\_conda.exe" constructor --prefix "$INSTDIR" --make-menus @MENU_PKGS@'
-        push 'Failed to create menus'
-        push 'WithLog'
-        call AbortRetryNSExecWait
-    ${EndIf}
-
 #if has_conda is True
     DetailPrint "Initializing conda directories..."
     push '"$INSTDIR\pythonw.exe" -E -s "$INSTDIR\Lib\_nsis.py" mkdirs'
@@ -1159,8 +1156,9 @@ SectionEnd
 !macroend
 
 Section "Uninstall"
-    # Remove menu items, path entries
+    System::Call 'kernel32::SetEnvironmentVariable(t,t)i("CONDA_ROOT_PREFIX", "$INSTDIR")".r0'
 
+    # Remove menu items, path entries
     DetailPrint "Deleting @NAME@ menus..."
     nsExec::ExecToLog '"$INSTDIR\_conda.exe" constructor --prefix "$INSTDIR" --rm-menus'
 

constructor/osx/check_shortcuts.sh

@@ -0,0 +1,16 @@
+#!/bin/sh
+
+set -eux
+
+# $2 is the install location, which is ~ by default
+# but which the user can change.
+PREFIX="$2/__NAME_LOWER__"
+PREFIX=$(cd "$PREFIX"; pwd)
+
+# If the UI selected the "Create shortcuts" option
+# we create a sentinel file that will be checked for existence
+# during run_installation.sh
+# If it doesn't exist, it means that this script never ran
+# due to (A) the user deselected the option, or (B) the installer
+# was created with menu_packages=[], which disables shortcuts altogether
+touch "$PREFIX/pkgs/user_wants_shortcuts"

constructor/osx/run_installation.sh

@@ -25,13 +25,24 @@ echo "PREFIX=$PREFIX"
 CONDA_EXEC="$PREFIX/conda.exe"
 # /COMMON UTILS
 
+# Check whether the user wants shortcuts or not
+# See check_shortcuts.sh script for details
+if [[ -f "$PREFIX/pkgs/user_wants_shortcuts" ]]; then
+    shortcuts="__SHORTCUTS__"
+else
+    shortcuts="--no-shortcuts"
+fi
+
 # Perform the conda install
 notify "Installing packages. This might take a few minutes."
-if ! CONDA_SAFETY_CHECKS=disabled \
+# shellcheck disable=SC2086
+if ! \
+CONDA_ROOT_PREFIX="$PREFIX" \
+CONDA_SAFETY_CHECKS=disabled \
 CONDA_EXTRA_SAFETY_CHECKS=no \
 CONDA_CHANNELS=__CHANNELS__ \
 CONDA_PKGS_DIRS="$PREFIX/pkgs" \
-"$CONDA_EXEC" install --offline --file "$PREFIX/pkgs/env.txt" -yp "$PREFIX"; then
+"$CONDA_EXEC" install --offline --file "$PREFIX/pkgs/env.txt" -yp "$PREFIX" $shortcuts; then
     echo "ERROR: could not complete the conda install"
     exit 1
 fi
@@ -60,20 +71,27 @@ for env_pkgs in "${PREFIX}"/pkgs/envs/*/; do
     else
         env_channels="__CHANNELS__"
     fi
-    # TODO: custom channels per env?
+    if [[ -f "$PREFIX/pkgs/user_wants_shortcuts" ]]; then
+        # This file is guaranteed to exist, even if empty
+        env_shortcuts=$(cat "${env_pkgs}shortcuts.txt")
+        rm -f "${env_pkgs}shortcuts.txt"
+    else
+        env_shortcuts="--no-shortcuts"
+    fi
     # TODO: custom shortcuts per env?
+    # shellcheck disable=SC2086
+    CONDA_ROOT_PREFIX="$PREFIX" \
     CONDA_SAFETY_CHECKS=disabled \
     CONDA_EXTRA_SAFETY_CHECKS=no \
     CONDA_CHANNELS="$env_channels" \
     CONDA_PKGS_DIRS="$PREFIX/pkgs" \
-    "$CONDA_EXEC" install --offline --file "${env_pkgs}env.txt" -yp "$PREFIX/envs/$env_name" || exit 1
+    "$CONDA_EXEC" install --offline --file "${env_pkgs}env.txt" -yp "$PREFIX/envs/$env_name" $env_shortcuts || exit 1
     # Move the prepackaged history file into place
     mv "${env_pkgs}/conda-meta/history" "$PREFIX/envs/$env_name/conda-meta/history"
     rm -f "${env_pkgs}env.txt"
 done
 
 # Cleanup!
-rm -f "$CONDA_EXEC"
 find "$PREFIX/pkgs" -type d -empty -exec rmdir {} \; 2>/dev/null || :
 
 __WRITE_CONDARC__