|
| 1 | +<# |
| 2 | +.SYNOPSIS |
| 3 | + Installs matlab-batch on a Windows system. |
| 4 | +
|
| 5 | +.DESCRIPTION |
| 6 | + Downloads the matlab-batch executable. |
| 7 | + Creates a directory to place the executable into. |
| 8 | + Adds the executable onto the user PATH. |
| 9 | +
|
| 10 | +.PARAMETER InstallLocation |
| 11 | + Specifies the location where matlab-batch will be downloaded to and installed in. |
| 12 | + Defaults to $ProgramFiles\MathWorks. |
| 13 | +
|
| 14 | +.PARAMETER Help |
| 15 | + Shows a help message for the install script if present. |
| 16 | +
|
| 17 | +.EXAMPLE |
| 18 | + Install-Batch |
| 19 | + Install-Batch -Help |
| 20 | + Install-Batch -InstallLocation C:\MyPrograms |
| 21 | +
|
| 22 | +.NOTES |
| 23 | + Copyright 2024 The MathWorks, Inc. |
| 24 | +#> |
| 25 | +param ( |
| 26 | + [string]$InstallLocation='C:\Program Files\MathWorks', |
| 27 | + [switch]$Help |
| 28 | + ) |
| 29 | + |
| 30 | +$DEFAULT_DOWNLOAD_BASE_URL = 'https://ssd.mathworks.com/supportfiles/ci/matlab-batch/v1/win64/matlab-batch.exe' |
| 31 | + |
| 32 | +# Set strict error handling |
| 33 | +$ErrorActionPreference = 'Stop' |
| 34 | + |
| 35 | +# Show help |
| 36 | +function Show-Help { |
| 37 | + Write-Output "Usage: install-matlab-batch.ps1 [parameters]" |
| 38 | + Write-Output "" |
| 39 | + Write-Output "Options:" |
| 40 | + Write-Output " -Help Display this help message." |
| 41 | + Write-Output ' -InstallLocation Specify an install location. Defaults to $ProgramFiles\MathWorks.' |
| 42 | + Write-Output "" |
| 43 | +} |
| 44 | + |
| 45 | +# Function to download the matlab-batch executable binary |
| 46 | +function Download { |
| 47 | + param ( |
| 48 | + [string]$Url, |
| 49 | + [string]$Filename |
| 50 | + ) |
| 51 | + Invoke-WebRequest -Uri $Url -OutFile $Filename |
| 52 | +} |
| 53 | + |
| 54 | +function Install-MatlabBatch { |
| 55 | + param ( |
| 56 | + [string]$InstallDirectory |
| 57 | + ) |
| 58 | + |
| 59 | + Write-Output 'Starting Install-MatlabBatch...' |
| 60 | + |
| 61 | + # Resolve $InstallDirectory to an absolute path |
| 62 | + $InstallDirectory = [System.IO.Path]::GetFullPath([System.IO.Path]::Combine((Get-Location), $InstallDirectory)) + "\matlab-batch" |
| 63 | + |
| 64 | + # Create standard location for install if it does not exist |
| 65 | + New-Item -ItemType Directory -Force -Path "$InstallDirectory" |
| 66 | + |
| 67 | + # Define the default download URL |
| 68 | + $BaseUrl = $DEFAULT_DOWNLOAD_BASE_URL |
| 69 | + try { |
| 70 | + Download "$BaseUrl" "$InstallDirectory\matlab-batch.exe" |
| 71 | + } |
| 72 | + catch { |
| 73 | + Write-Host "Failed to download matlab-batch ($($_.Exception.Message))" |
| 74 | + exit 1 |
| 75 | + } |
| 76 | + |
| 77 | + # Add the installation directory to the system PATH |
| 78 | + $SystemPath = [System.Environment]::GetEnvironmentVariable('Path', [System.EnvironmentVariableTarget]::Machine) |
| 79 | + $PathEntries = $SystemPath.Split(';') |
| 80 | + |
| 81 | + # Check for existing entries for the matlab-batch folder |
| 82 | + $ExistingEntries = @($PathEntries | Where-Object { $_ -like "*matlab-batch*" }) |
| 83 | + |
| 84 | + if ($ExistingEntries.Count -eq 0) { |
| 85 | + # No entry for matlab-batch on PATH |
| 86 | + $NewPath = $SystemPath + ';' + $InstallDirectory |
| 87 | + [System.Environment]::SetEnvironmentVariable('Path', $NewPath, [System.EnvironmentVariableTarget]::Machine) |
| 88 | + Write-Output "Added new installation directory to PATH. You will have to start a fresh PowerShell session to find it on PATH." |
| 89 | + } else { |
| 90 | + if ($ExistingEntries -contains $InstallDirectory) { |
| 91 | + # There are matlab-batch entries on PATH and an entry matches InstallLocation |
| 92 | + $FirstEntry = $ExistingEntries[0] |
| 93 | + |
| 94 | + if ($FirstEntry -ne $InstallDirectory) { |
| 95 | + # Matching entry is not at the start of the PATH, move it to the first entry |
| 96 | + $PathEntries = $PathEntries | Where-Object { $_ -ne $InstallDirectory } |
| 97 | + $FirstMatlabBatchIndex = [Array]::IndexOf($PathEntries, $FirstEntry) |
| 98 | + $PathEntries = $PathEntries[0..($FirstMatlabBatchIndex-1)] + $InstallDirectory + $PathEntries[$FirstMatlabBatchIndex..($PathEntries.Length-1)] |
| 99 | + $NewPath = $PathEntries -join ';' |
| 100 | + [System.Environment]::SetEnvironmentVariable('Path', $NewPath, [System.EnvironmentVariableTarget]::Machine) |
| 101 | + Write-Output "Moved current installation directory to the first position among matlab-batch entries. You will have to start a fresh PowerShell session to find it on PATH." |
| 102 | + } else { |
| 103 | + # Matching entry is the first matlab-batch entry on PATH, do nothing |
| 104 | + Write-Output "The current installation directory is already the first entry on PATH. No changes made." |
| 105 | + } |
| 106 | + } else { |
| 107 | + # There are matlab-batch entries on PATH and no entry matches InstallLocation |
| 108 | + $FirstEntry = $ExistingEntries[0] |
| 109 | + $FirstMatlabBatchIndex = [Array]::IndexOf($PathEntries, $FirstEntry) |
| 110 | + $PathEntries = $PathEntries[0..($FirstMatlabBatchIndex-1)] + $InstallDirectory + $PathEntries[$FirstMatlabBatchIndex..($PathEntries.Length-1)] |
| 111 | + $NewPath = $PathEntries -join ';' |
| 112 | + [System.Environment]::SetEnvironmentVariable('Path', $NewPath, [System.EnvironmentVariableTarget]::Machine) |
| 113 | + Write-Output "Added new installation directory to the beginning of the matlab-batch entries. You will have to start a fresh PowerShell session to find it on PATH." |
| 114 | + } |
| 115 | + } |
| 116 | + |
| 117 | + Write-Output "Done with Install-MatlabBatch." |
| 118 | +} |
| 119 | + |
| 120 | +try { |
| 121 | + # Check if PowerShell is running as Administrator |
| 122 | + $currentPrincipal = New-Object Security.Principal.WindowsPrincipal([Security.Principal.WindowsIdentity]::GetCurrent()) |
| 123 | + $isAdministrator = $currentPrincipal.IsInRole([Security.Principal.WindowsBuiltInRole]::Administrator) |
| 124 | + |
| 125 | + if ($Help) { |
| 126 | + Show-Help |
| 127 | + exit 0 |
| 128 | + } |
| 129 | + |
| 130 | + if ($isAdministrator) { |
| 131 | + Install-MatlabBatch -InstallDirectory $InstallLocation |
| 132 | + } else { |
| 133 | + Write-Host "PowerShell is not running as Administrator. Please run PowerShell as Administrator to proceed with installation." |
| 134 | + } |
| 135 | +} |
| 136 | +catch { |
| 137 | + $ScriptPath = $MyInvocation.MyCommand.Path |
| 138 | + Write-Output "ERROR - An error occurred while running script: $ScriptPath. Error: $_" |
| 139 | + throw |
| 140 | +} |
0 commit comments