fix: preserve Windows installer paths across shell commands

Fixes version-fox/vfox#685

Author: aooohan

.github/workflows/hooks-test.yml

@@ -1,6 +1,7 @@
 name: Test Plugin
 
 on:
+  workflow_dispatch:
   pull_request:
   push:
     branches: [main]
@@ -21,3 +22,52 @@ jobs:
           cache: false
       - name: Test plugin hooks with vfox's Lua interpreter
         run: go run github.com/yuin/gopher-lua/cmd/glua@v1.1.1 tests/hooks_test.lua
+      - name: Test Windows installer command generation
+        run: go run github.com/yuin/gopher-lua/cmd/glua@v1.1.1 tests/windows_install_test.lua
+
+  windows-install:
+    name: Windows installer paths
+    runs-on: windows-latest
+    timeout-minutes: 20
+    defaults:
+      run:
+        shell: pwsh
+    steps:
+      - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7
+        with:
+          persist-credentials: false
+      - name: Install released vfox
+        env:
+          GH_TOKEN: ${{ github.token }}
+        run: |
+          $ErrorActionPreference = 'Stop'
+          $PSNativeCommandUseErrorActionPreference = $true
+          $directory = Join-Path $env:RUNNER_TEMP 'vfox-cli'
+          gh release download v1.0.12 --repo version-fox/vfox --pattern vfox_1.0.12_windows_x86_64.zip --dir $directory
+          Expand-Archive -LiteralPath (Join-Path $directory 'vfox_1.0.12_windows_x86_64.zip') -DestinationPath $directory
+          $vfox = Get-ChildItem -LiteralPath $directory -Recurse -Filter vfox.exe | Select-Object -First 1
+          if (-not $vfox) { throw 'vfox.exe was not found in the release archive' }
+          "VFOX_TEST_CLI=$($vfox.FullName)" >> $env:GITHUB_ENV
+      - name: Install Python through WiX and embedded MSI packages
+        run: |
+          $ErrorActionPreference = 'Stop'
+          $PSNativeCommandUseErrorActionPreference = $true
+          # Literal percent/exclamation marks also catch cmd expansion bugs.
+          $env:VFOX_HOME = Join-Path $env:RUNNER_TEMP 'Mechael Jackson''s & %USERNAME% ! SDKs'
+          $env:VFOX_PYTHON_USE_UV_BUILD = '0'
+          $archive = Join-Path $env:RUNNER_TEMP 'python-plugin.zip'
+          Compress-Archive -Path metadata.lua,hooks,lib,bin -DestinationPath $archive
+          & $env:VFOX_TEST_CLI add --source $archive
+          & $env:VFOX_TEST_CLI install python@3.14.5
+
+          $root = Join-Path $env:VFOX_HOME 'cache\python\v-3.14.5\python-3.14.5'
+          $python = Join-Path $root 'python.exe'
+          if (-not (Test-Path -LiteralPath $python)) { throw "Python missing: $python" }
+          & $python -c 'import sys; assert sys.version_info[:3] == (3, 14, 5), sys.version; print(sys.executable)'
+          & $python -m pip --version
+          foreach ($name in @('python3.exe', 'python314.exe', 'python3.14.exe')) {
+            & (Join-Path $root $name) -c 'import sys; assert sys.version_info[:3] == (3, 14, 5)'
+          }
+          $venv = Join-Path $env:RUNNER_TEMP 'venv with spaces & symbols'
+          & $python -m venv $venv
+          & (Join-Path $venv 'Scripts\python.exe') -m pip --version

lib/util.lua

@@ -1,6 +1,7 @@
 local http = require("http")
 local html = require("html")
 local json = require("json")
+local windowsCommand = require("windows_command")
 
 -- get mirror
 local PYTHON_URL = "https://www.python.org/ftp/python/"
@@ -91,7 +92,7 @@ function windowsInstallMsi(path, url, version, filename)
 
     -- Install msi
     print("Installing python...")
-    local command = 'msiexec /quiet /a ' .. qInstallFile .. ' TargetDir=' .. qInstallPath
+    local command = windowsCommand.msi(qInstallFile, qInstallPath)
     local exitCode = os.execute(command)
     os.remove(qInstallFile)
     if exitCode ~= 0 then
@@ -104,7 +105,7 @@ function windowsInstallMsi(path, url, version, filename)
     if file then
         io.close(file)
         print("Installing pip...")
-        local command = qInstallPath .. '\\python -E -s -m ensurepip -U --default-pip > NUL'
+        local command = windowsCommand.native(qInstallPath .. '\\python.exe', {'-E', '-s', '-m', 'ensurepip', '-U', '--default-pip'})
         local exitCode = os.execute(command)
         if exitCode ~= 0 then
             error("Install pip failed. exit " .. exitCode)
@@ -134,7 +135,7 @@ function windowsInstallExe(path, url, version, filename)
     -- Extract
     print("Extracting installer...")
     local wixBin = RUNTIME.pluginDirPath .. '\\bin\\WiX\\dark.exe'
-    local command = wixBin .. " -x " .. qInstallPath .. '\\ ' .. qInstallFile .. ' > NUL'
+    local command = windowsCommand.native(wixBin, {'-x', qInstallPath, qInstallFile})
     local exitCode = os.execute(command)
     if exitCode ~= 0 then
         error("Extract failed")
@@ -150,25 +151,30 @@ function windowsInstallExe(path, url, version, filename)
 
     -- Install msi
     print("Installing python...")
-    local files = io.popen("dir /b " .. msiPath):lines()
+    local listing, listErr = io.popen(windowsCommand.files(msiPath))
+    if not listing then
+        error('Failed to list installer packages: ' .. tostring(listErr))
+    end
+    local files = listing:lines()
     for file in files do
         if file:match("%.msi$") then
-            local command = "msiexec /quiet /a " .. msiPath .. '\\' .. file .. " TargetDir=" .. qInstallPath
+            local command = windowsCommand.msi(msiPath .. '\\' .. file, qInstallPath)
             local exitCode = os.execute(command)
             if exitCode ~= 0 then
                 error("Install msi failed: " .. file)
             end
             os.remove(qInstallPath .. '\\' .. file)
         end
     end
+    listing:close()
 
     -- Install pip
     print("Installing pip...")
     local ensurepipPath = qInstallPath .. "\\Lib\\ensurepip\\__init__.py"
     local file = io.open(ensurepipPath, "r")
     if file then
         io.close(file)
-        local command = qInstallPath .. '\\python -E -s -m ensurepip -U --default-pip > NUL'
+        local command = windowsCommand.native(qInstallPath .. '\\python.exe', {'-E', '-s', '-m', 'ensurepip', '-U', '--default-pip'})
         local exitCode = os.execute(command)
         if exitCode ~= 0 then
             error("Install pip failed. exit " .. exitCode)
@@ -190,16 +196,20 @@ function windowsInstallExe(path, url, version, filename)
     local files = {qInstallPath .. "\\python" .. major .. ".exe", qInstallPath .. "\\python" .. majorMinor .. ".exe",
                    qInstallPath .. "\\python" .. majorDotMinor .. ".exe"}
     for _, file in ipairs(files) do
-        local command = 'copy /y ' .. pythonExePath .. ' ' .. file .. ' > NUL'
-        os.execute(command)
+        local command = windowsCommand.copy(pythonExePath, file)
+        if os.execute(command) ~= 0 then
+            error('Failed to create Python executable alias: ' .. file)
+        end
     end
 
     -- pythonw.exe
     local files = {qInstallPath .. "\\pythonw" .. major .. ".exe", qInstallPath .. "\\pythonw" .. majorMinor .. ".exe",
                    qInstallPath .. "\\pythonw" .. majorDotMinor .. ".exe"}
     for _, file in ipairs(files) do
-        local command = 'copy /y ' .. pythonwExePath .. ' ' .. file .. ' > NUL'
-        os.execute(command)
+        local command = windowsCommand.copy(pythonwExePath, file)
+        if os.execute(command) ~= 0 then
+            error('Failed to create Python executable alias: ' .. file)
+        end
     end
 
     -- Check if venvlauncher exists
@@ -214,8 +224,10 @@ function windowsInstallExe(path, url, version, filename)
                        qInstallPath .. "\\Lib\\venv\\scripts\\nt\\pythonw" .. majorMinor .. ".exe",
                        qInstallPath .. "\\Lib\\venv\\scripts\\nt\\pythonw" .. majorDotMinor .. ".exe"}
         for _, file in ipairs(files) do
-            local command = 'copy /y ' .. venvlauncherExePath .. ' ' .. file .. ' > NUL'
-            os.execute(command)
+            local command = windowsCommand.copy(venvlauncherExePath, file)
+            if os.execute(command) ~= 0 then
+                error('Failed to create Python venv executable alias: ' .. file)
+            end
         end
     end
 

lib/windows_command.lua

@@ -0,0 +1,52 @@
+local command = {}
+
+-- os.execute/io.popen pass through cmd.exe before PowerShell. Do not expose
+-- percent expansion, delayed expansion, or quotes to that outer parser.
+local function literal(value)
+    if value:find('[\r\n%z]') then
+        error('Windows command argument contains a control character')
+    end
+    value = value:gsub("'", "''")
+    value = value:gsub('[%%!\"]', function(char)
+        return "' + [char]" .. string.byte(char) .. " + '"
+    end)
+    return "('" .. value .. "')"
+end
+
+local function powershell(script)
+    return 'powershell -NoProfile -NonInteractive -Command "' ..
+        "$ErrorActionPreference = 'Stop'; " .. script .. '"'
+end
+
+function command.native(program, args)
+    local parts = {'&', literal(program)}
+    for _, arg in ipairs(args) do
+        table.insert(parts, literal(arg))
+    end
+    return powershell(table.concat(parts, ' ') .. '; exit $LASTEXITCODE')
+end
+
+function command.msi(file, path)
+    local function argument(value)
+        if value:find('"', 1, true) then
+            error('Windows installer path contains an invalid quote')
+        end
+        -- A backslash immediately before the closing native quote is escaped.
+        return '"' .. value:gsub('(\\+)$', '%1%1') .. '"'
+    end
+    local args = '/quiet /a ' .. argument(file) .. ' ' .. argument('TargetDir=' .. path)
+    return powershell("$process = Start-Process -FilePath msiexec.exe -Wait -PassThru -ArgumentList " ..
+        literal(args) .. '; exit $process.ExitCode')
+end
+
+function command.files(path)
+    return powershell('Get-ChildItem -LiteralPath ' .. literal(path) ..
+        " -Filter '*.msi' -File | ForEach-Object { $_.Name }")
+end
+
+function command.copy(source, target)
+    return powershell('Copy-Item -LiteralPath ' .. literal(source) ..
+        ' -Destination ' .. literal(target) .. ' -Force')
+end
+
+return command

tests/windows_install_test.lua

@@ -0,0 +1,50 @@
+package.path = './lib/?.lua;' .. package.path
+RUNTIME = {osType = 'windows', archType = 'amd64', pluginDirPath = "C:\\Plugin's & %USERNAME% ! store"}
+OS_TYPE = 'windows'
+local state = {commands = {}}
+package.preload.http = function() return {download_file = function() return nil end} end
+package.preload.html = function() return {} end
+package.preload.json = function() return {} end
+local oldExecute, oldPopen, oldOpen, oldClose, oldRemove = os.execute, io.popen, io.open, io.close, os.remove
+os.execute = function(command)
+    state.commands[#state.commands + 1] = command
+    -- Native paths must never be expanded as cmd variables or tokenized on spaces.
+    assert(command:find('powershell ', 1, true), 'unquoted Windows command: ' .. command)
+    assert(not command:find('%%') and not command:find('!'), 'cmd expansion in command: ' .. command)
+    return #state.commands == state.failOn and 1 or 0
+end
+io.popen = function(command)
+    os.execute(command)
+    return {
+        lines = function()
+            local files, i = {'core.msi', 'stdlib.msi'}, 0
+            return function() i = i + 1; return files[i] end
+        end,
+        close = function() return true end,
+    }
+end
+io.open = function()
+    return {close = function() end}
+end
+io.close = function(file) return file:close() end
+os.remove = function() return true end
+require('util')
+local path = "C:\\Users\\Mechael Jackson's & %USERNAME% !\\python-3.14.5"
+windowsInstallExe(path, 'https://example.invalid/python.exe', '3.14.5', 'python.exe')
+assert(#state.commands >= 7, 'installer, enumeration, MSI, pip and aliases must be exercised')
+state.commands = {}
+windowsInstallMsi(path, 'https://example.invalid/python.msi', '3.4.4', 'python.msi')
+assert(#state.commands == 2, 'MSI and ensurepip must both run')
+for _, failure in ipairs({{1, 'Extract failed'}, {3, 'Install msi failed'}, {6, 'executable alias'}}) do
+    state.commands = {}
+    state.failOn = failure[1]
+    local ok, err = pcall(function()
+        windowsInstallExe(path, 'https://example.invalid/python.exe', '3.14.5', 'python.exe')
+    end)
+    assert(not ok and tostring(err):find(failure[2], 1, true), tostring(err))
+end
+local windows = require('windows_command')
+assert(not pcall(windows.msi, 'C:\\bad"path\\python.msi', path), 'invalid Windows quote must fail')
+assert(not pcall(windows.native, 'bad\nprogram', {}), 'control characters must fail')
+os.execute, io.popen, io.open, io.close, os.remove = oldExecute, oldPopen, oldOpen, oldClose, oldRemove
+print('Windows installer command paths and shell expansion regression passed')