Convert script and directory _nsis.py subcommands into NSIS code (conda#1069)

* Port mkdirs subcommand into NSIS

* Convert cmd.exe executable into global variable

* Run pre-uninstall script inside NSIS

* Execute post-install script in NSIS

* Add news

* NSIS_SCRIPTS_RAISE_ERRORS

* Convert finding cmd.exe into a macro

* Remove unneeded rmreg command

* Apply suggestions from code review

Co-authored-by: Robin <[email protected]>

* Replace rmreg with conda command

* Add --user and --system options to init reverse command

---------

Co-authored-by: jaimergp <[email protected]>
Co-authored-by: Robin <[email protected]>

Author: 3 people

.github/workflows/main.yml

@@ -107,7 +107,6 @@ jobs:
             && files+=(--file "tests/extra-requirements-${{ runner.os }}.txt")
           conda install ${files[@]} -y
           echo "NSIS_USING_LOG_BUILD=1" >> $GITHUB_ENV
-          echo "NSIS_SCRIPTS_RAISE_ERRORS=1" >> $GITHUB_ENV
           pip install -e . --no-deps --no-build-isolation
       - name: Set up conda executable
         run: |

constructor/nsis/_nsis.py

@@ -8,14 +8,8 @@
 # be tested in an installation.
 
 import os
-import re
 import sys
-from os.path import exists, isfile, join
-
-try:
-    import winreg
-except ImportError:
-    import _winreg as winreg
+from os.path import exists, join
 
 ROOT_PREFIX = sys.prefix
 
@@ -57,96 +51,6 @@ def err(x):
         OutputDebugString('_nsis.py: Error: ' + x)
 
 
-class NSISReg:
-    def __init__(self, reg_path):
-        self.reg_path = reg_path
-        if exists(join(ROOT_PREFIX, '.nonadmin')):
-            self.main_key = winreg.HKEY_CURRENT_USER
-        else:
-            self.main_key = winreg.HKEY_LOCAL_MACHINE
-
-    def set(self, name, value):
-        try:
-            winreg.CreateKey(self.main_key, self.reg_path)
-            registry_key = winreg.OpenKey(self.main_key, self.reg_path, 0,
-                                          winreg.KEY_WRITE)
-            winreg.SetValueEx(registry_key, name, 0, winreg.REG_SZ, value)
-            winreg.CloseKey(registry_key)
-            return True
-        except WindowsError:
-            return False
-
-    def get(self, name):
-        try:
-            registry_key = winreg.OpenKey(self.main_key, self.reg_path, 0,
-                                          winreg.KEY_READ)
-            value, regtype = winreg.QueryValueEx(registry_key, name)
-            winreg.CloseKey(registry_key)
-            return value
-        except WindowsError:
-            return None
-
-
-def mk_dirs():
-    envs_dir = join(ROOT_PREFIX, 'envs')
-    if not exists(envs_dir):
-        os.mkdir(envs_dir)
-
-
-def run_post_install():
-    """
-    call the post install script, if the file exists
-    """
-    path = join(ROOT_PREFIX, 'pkgs', 'post_install.bat')
-    if not isfile(path):
-        return
-    env = os.environ.copy()
-    env.setdefault('PREFIX', str(ROOT_PREFIX))
-    cmd_exe = os.path.join(os.environ['SystemRoot'], 'System32', 'cmd.exe')
-    if not os.path.isfile(cmd_exe):
-        cmd_exe = os.path.join(os.environ['windir'], 'System32', 'cmd.exe')
-    if not os.path.isfile(cmd_exe):
-        err("Error: running %s failed.  cmd.exe could not be found.  "
-            "Looked in SystemRoot and windir env vars.\n" % path)
-        if os.environ.get("NSIS_SCRIPTS_RAISE_ERRORS"):
-            sys.exit(1)
-    args = [cmd_exe, '/d', '/c', path]
-    import subprocess
-    try:
-        subprocess.check_call(args, env=env)
-    except subprocess.CalledProcessError:
-        err("Error: running %s failed\n" % path)
-        if os.environ.get("NSIS_SCRIPTS_RAISE_ERRORS"):
-            sys.exit(1)
-
-
-def run_pre_uninstall():
-    """
-    call the pre uninstall script, if the file exists
-    """
-    path = join(ROOT_PREFIX, 'pre_uninstall.bat')
-    if not isfile(path):
-        return
-    env = os.environ.copy()
-    env.setdefault('PREFIX', str(ROOT_PREFIX))
-    cmd_exe = os.path.join(os.environ['SystemRoot'], 'System32', 'cmd.exe')
-    if not os.path.isfile(cmd_exe):
-        cmd_exe = os.path.join(os.environ['windir'], 'System32', 'cmd.exe')
-    if not os.path.isfile(cmd_exe):
-        err("Error: running %s failed.  cmd.exe could not be found.  "
-            "Looked in SystemRoot and windir env vars.\n" % path)
-        if os.environ.get("NSIS_SCRIPTS_RAISE_ERRORS"):
-            sys.exit(1)
-    args = [cmd_exe, '/d', '/c', path]
-    import subprocess
-    try:
-        subprocess.check_call(args, env=env)
-    except subprocess.CalledProcessError:
-        err("Error: running %s failed\n" % path)
-        if os.environ.get("NSIS_SCRIPTS_RAISE_ERRORS"):
-            sys.exit(1)
-
-
 allusers = (not exists(join(ROOT_PREFIX, '.nonadmin')))
 # out('allusers is %s\n' % allusers)
 
@@ -217,29 +121,9 @@ def add_condabin_to_path():
     broadcast_environment_settings_change()
 
 
-def rm_regkeys():
-    cmdproc_reg_entry = NSISReg(r'Software\Microsoft\Command Processor')
-    cmdproc_autorun_val = cmdproc_reg_entry.get('AutoRun')
-    conda_hook_regex_pat = r'((\s+&\s+)?(if +exist)?(\s*?\"[^\"]*?conda[-_]hook\.bat\"))'
-    if join(ROOT_PREFIX, 'condabin') in (cmdproc_autorun_val or ''):
-        cmdproc_autorun_newval = re.sub(conda_hook_regex_pat, '',
-                                        cmdproc_autorun_val)
-        try:
-            cmdproc_reg_entry.set('AutoRun', cmdproc_autorun_newval)
-        except Exception:
-            # Hey, at least we made an attempt to cleanup
-            pass
-
-
 def main():
     cmd = sys.argv[1].strip()
-    if cmd == 'post_install':
-        run_post_install()
-    elif cmd == 'rmreg':
-        rm_regkeys()
-    elif cmd == 'mkdirs':
-        mk_dirs()
-    elif cmd == 'addpath':
+    if cmd == 'addpath':
         # These checks are probably overkill, but could be useful
         # if I forget to update something that uses this code.
         if len(sys.argv) > 2:
@@ -257,8 +141,6 @@ def main():
         add_condabin_to_path()
     elif cmd == 'rmpath':
         remove_from_path()
-    elif cmd == 'pre_uninstall':
-        run_pre_uninstall()
     else:
         sys.exit("ERROR: did not expect %r" % cmd)
 

constructor/nsis/main.nsi.tmpl

@@ -132,6 +132,22 @@ var /global InstMode # 0 = Just Me, 1 = All Users.
 !define JUST_ME 0
 !define ALL_USERS 1
 
+var /global CMD_EXE
+
+!macro FindCmdExe
+    # Find cmd.exe
+    ReadEnvStr $R0 SystemRoot
+    ReadEnvStr $R1 windir
+    ${If} ${FileExists} "$R0"
+        StrCpy $CMD_EXE "$R0\System32\cmd.exe"
+    ${ElseIf} ${FileExists} "$R1"
+        StrCpy $CMD_EXE "$R1\System32\cmd.exe"
+    ${Else}
+        # Cross our fingers CMD is in PATH
+        StrCpy $CMD_EXE "cmd.exe"
+    ${EndIf}
+!macroend
+
 # Include this one after our defines
 !include "OptionsDialog.nsh"
 
@@ -1226,6 +1242,8 @@ Section "Install"
         call OnDirectoryLeave
     ${EndIf}
 
+    !insertmacro FindCmdExe
+
     SetOutPath "$INSTDIR\Lib"
     File "{{ NSIS_DIR }}\_nsis.py"
     File "{{ NSIS_DIR }}\_system_path.py"
@@ -1353,17 +1371,7 @@ Section "Install"
 
     IfFileExists "$INSTDIR\pkgs\pre_install.bat" 0 NoPreInstall
         ${Print} "Running pre_install scripts..."
-        ReadEnvStr $5 SystemRoot
-        ReadEnvStr $6 windir
-        # This 'FileExists' also returns True for directories
-        ${If} ${FileExists} "$5"
-            push '"$5\System32\cmd.exe" /D /C "$INSTDIR\pkgs\pre_install.bat"'
-        ${ElseIf} ${FileExists} "$6"
-            push '"$6\System32\cmd.exe" /D /C "$INSTDIR\pkgs\pre_install.bat"'
-        ${Else}
-            # Cross our fingers CMD is in PATH
-            push 'cmd.exe /D /C "$INSTDIR\pkgs\pre_install.bat"'
-        ${EndIf}
+        push '"$CMD_EXE" /D /C "$INSTDIR\pkgs\pre_install.bat"'
         push "Failed to run pre_install"
         push 'WithLog'
         call AbortRetryNSExecWait
@@ -1415,19 +1423,20 @@ Section "Install"
     AddSize {{ SIZE }}
 
 {%- if has_conda %}
-    ${Print} "Initializing conda directories..."
-    push '"$INSTDIR\pythonw.exe" -E -s "$INSTDIR\Lib\_nsis.py" mkdirs'
-    push 'Failed to initialize conda directories'
-    push 'WithLog'
-    call AbortRetryNSExecWait
+    StrCpy $R0 "$INSTDIR\envs"
+    ${IfNot} ${FileExists} "$R0"
+        CreateDirectory "$R0"
+    ${EndIf}
 {%- endif %}
 
-    ${If} $Ana_PostInstall_State = ${BST_CHECKED}
-        ${Print} "Running post install..."
-        push '"$INSTDIR\pythonw.exe" -E -s "$INSTDIR\Lib\_nsis.py" post_install'
-        push 'Failed to run post install script'
-        push 'WithLog'
-        call AbortRetryNSExecWait
+    ${If} ${FileExists} "$INSTDIR\pkgs\post_install.bat"
+        ${If} $Ana_PostInstall_State = ${BST_CHECKED}
+            ${Print} "Running post install..."
+            push '"$CMD_EXE" /D /C "$INSTDIR\pkgs\post_install.bat"'
+            push "Failed to run post_install"
+            push 'WithLog'
+            call AbortRetryNSExecWait
+        ${EndIf}
     ${EndIf}
 
     ${If} $Ana_ClearPkgCache_State = ${BST_CHECKED}
@@ -1544,6 +1553,8 @@ Section "Uninstall"
         !insertmacro un.ParseCommandLineArgs
     ${EndIf}
 
+    !insertmacro FindCmdExe
+
     System::Call 'kernel32::SetEnvironmentVariable(t,t)i("CONDA_ROOT_PREFIX", "$INSTDIR")".r0'
 
     # ensure that MSVC runtime DLLs are on PATH during uninstallation
@@ -1599,9 +1610,14 @@ Section "Uninstall"
     ${EndIf}
 
 {%- if uninstall_with_conda_exe %}
-    !insertmacro AbortRetryNSExecWaitLibNsisCmd "pre_uninstall"
+    ${If} ${FileExists} "$INSTDIR\pkgs\pre_uninstall.bat"
+        ${Print} "Running pre_uninstall scripts..."
+        push '"$CMD_EXE" /D /C "$INSTDIR\pkgs\pre_uninstall.bat"'
+        push "Failed to run pre_uninstall"
+        push 'WithLog'
+        call un.AbortRetryNSExecWait
+    ${EndIf}
     !insertmacro AbortRetryNSExecWaitLibNsisCmd "rmpath"
-    !insertmacro AbortRetryNSExecWaitLibNsisCmd "rmreg"
 
     # Parse arguments
     StrCpy $R0 ""
@@ -1649,9 +1665,29 @@ Section "Uninstall"
     call un.AbortRetryNSExecWait
     SetDetailsPrint both
 {%- endfor %}
-    !insertmacro AbortRetryNSExecWaitLibNsisCmd "pre_uninstall"
+    ${If} ${FileExists} "$INSTDIR\pkgs\pre_uninstall.bat"
+        ${Print} "Running pre_uninstall scripts..."
+        push '"$CMD_EXE" /D /C "$INSTDIR\pkgs\pre_uninstall.bat"'
+        push "Failed to run pre_uninstall"
+        push 'WithLog'
+        call un.AbortRetryNSExecWait
+    ${EndIf}
     !insertmacro AbortRetryNSExecWaitLibNsisCmd "rmpath"
-    !insertmacro AbortRetryNSExecWaitLibNsisCmd "rmreg"
+{%- if has_conda %}
+    ${If} ${FileExists} "$INSTDIR\.nonadmin"
+        StrCpy $R0 "user"
+    ${Else}
+        StrCpy $R0 "system"
+    ${EndIf}
+    # When running conda.bat directly, there is a non-fatal error
+    # that DOSKEY (called by conda_hook.bat) is not a valid command.
+    # While the operation still succeeds, this error is confusing.
+    # Calling via cmd.exe fixes that.
+    push '"$CMD_EXE" /D /C "$INSTDIR\condabin\conda.bat" init cmd.exe --reverse --$R0'
+    push 'Failed to clean AutoRun'
+    push 'WithLog'
+    call un.AbortRetryNSExecWait
+{%- endif %}
 
     ${Print} "Removing files and folders..."
     nsExec::Exec 'cmd.exe /D /C RMDIR /Q /S "$INSTDIR"'

news/1069-port-nsispy-cmds-nsis

@@ -0,0 +1,19 @@
+### Enhancements
+
+* Port script execution, AutoRun manipulation, and directory creation functions from `_nsis.py` to NSIS. (#1069)
+
+### Bug fixes
+
+* <news item>
+
+### Deprecations
+
+* <news item>
+
+### Docs
+
+* <news item>
+
+### Other
+
+* <news item>

scripts/run_examples.py

@@ -118,10 +118,6 @@ def run_examples(keep_artifacts=None, conda_exe=None, debug=False):
             if os.path.exists(os.path.join(fpath, "construct.yaml")):
                 example_paths.append(fpath)
 
-    # NSIS won't error out when running scripts unless
-    # we set this custom environment variable
-    os.environ["NSIS_SCRIPTS_RAISE_ERRORS"] = "1"
-
     parent_output = tempfile.mkdtemp()
     tested_files = set()
     which_errored = {}