Downloads:

98

Downloads of v 3.0.1:

30

Last Update:

06 Mar 2020

Package Maintainer(s):

Software Author(s):

  • Ildar Shaimordanov

Tags:

psubst batchfile disk-management persistent-drive

psubst

3.0.1 | Updated: 06 Mar 2020

Downloads:

98

Downloads of v 3.0.1:

30

Maintainer(s):

Software Author(s):

  • Ildar Shaimordanov

psubst 3.0.1

All Checks are Passing

2 Passing Test


Validation Testing Passed


Verification Testing Passed

Details

To install psubst, run the following command from the command line or from PowerShell:

>

To upgrade psubst, run the following command from the command line or from PowerShell:

>

To uninstall psubst, run the following command from the command line or from PowerShell:

>

NOTE: This applies to both open source and commercial editions of Chocolatey.

1. Ensure you are set for organizational deployment

Please see the organizational deployment guide

  • Open Source or Commercial:
    • Proxy Repository - Create a proxy nuget repository on Nexus, Artifactory Pro, or a proxy Chocolatey repository on ProGet. Point your upstream to https://chocolatey.org/api/v2. Packages cache on first access automatically. Make sure your choco clients are using your proxy repository as a source and NOT the default community repository. See source command for more information.
    • You can also just download the package and push it to a repository Download

3. Enter your internal repository url

(this should look similar to https://chocolatey.org/api/v2)

4. Choose your deployment method:


choco upgrade psubst -y --source="'STEP 3 URL'" [other options]

See options you can pass to upgrade.

See best practices for scripting.

Add this to a PowerShell script or use a Batch script with tools and in places where you are calling directly to Chocolatey. If you are integrating, keep in mind enhanced exit codes.

If you do use a PowerShell script, use the following to ensure bad exit codes are shown as failures:


choco upgrade psubst -y --source="'STEP 3 URL'"
$exitCode = $LASTEXITCODE

Write-Verbose "Exit code was $exitCode"
$validExitCodes = @(0, 1605, 1614, 1641, 3010)
if ($validExitCodes -contains $exitCode) {
  Exit 0
}

Exit $exitCode

- name: Ensure psubst installed
  win_chocolatey:
    name: psubst
    state: present
    version: 3.0.1
    source: STEP 3 URL

See docs at https://docs.ansible.com/ansible/latest/modules/win_chocolatey_module.html.

Coming early 2020! Central Managment Reporting available now! More information...


chocolatey_package 'psubst' do
  action    :install
  version  '3.0.1'
  source   'STEP 3 URL'
end

See docs at https://docs.chef.io/resource_chocolatey_package.html.


Chocolatey::Ensure-Package
(
    Name: psubst,
    Version: 3.0.1,
    Source: STEP 3 URL
);

Requires Otter Chocolatey Extension. See docs at https://inedo.com/den/otter/chocolatey.


cChocoPackageInstaller psubst
{
   Name     = 'psubst'
   Ensure   = 'Present'
   Version  = '3.0.1'
   Source   = 'STEP 3 URL'
}

Requires cChoco DSC Resource. See docs at https://github.com/chocolatey/cChoco.


package { 'psubst':
  provider => 'chocolatey',
  ensure   => '3.0.1',
  source   => 'STEP 3 URL',
}

Requires Puppet Chocolatey Provider module. See docs at https://forge.puppet.com/puppetlabs/chocolatey.


salt '*' chocolatey.install psubst version="3.0.1" source="STEP 3 URL"

See docs at https://docs.saltstack.com/en/latest/ref/modules/all/salt.modules.chocolatey.html.

5. If applicable - Chocolatey configuration/installation

See infrastructure management matrix for Chocolatey configuration elements and examples.

This package was approved by moderator flcdrg on 09 Mar 2020.

Description

Associates a path with a drive letter and extends the standard SUBST command allowing to create persistent substituted drives between startups.


tools\chocolateyinstall.ps1
# Uninstall previous version, if any
Uninstall-BinFile -Name "psubst"

$dir = "$(Split-Path -Parent $MyInvocation.MyCommand.Definition)"
Copy-Item -Path "$dir/psubst.bat" -Destination "$env:ChocolateyInstall/bin"
tools\chocolateyuninstall.ps1
Remove-Item -Path "$env:ChocolateyInstall/bin/psubst.bat"
tools\psubst.bat
::PSUBST v3.0.1-0-gbbb9804
::
::Associates a path with a drive letter.
::Manages persistently substituted (virtual) drives.
::
::PSUBST [drive1: [drive2:]path] [/P | /PF]
::PSUBST drive1: /D [/P | /PF]
::PSUBST drive1: /P
::
::  drive1:        Specifies a virtual drive to which you want to assign a path.
::  [drive2:]path  Specifies a physical drive and path you want to assign to
::                 a virtual drive.
::  /D             Deletes a substituted (virtual) drive.
::  /P             Add, delete or display persistent drives.
::  /PF            Add or delete persistent drives with elevated privileges.
::
::Type PSUBST with no parameters to display a list of current virtual drives.
::Type PSUBST /P to display a list of persistent virtual drives.
::Type PSUBST drive1: /P to restore a virtual drive from persistency.
@echo off


if "%~1" == "/?" goto :print_usage


if "%~1" == "" (
	rem
	rem SUBST
	rem

	subst

	goto :EOF
)


if /i "%~1" == "/P" (
	rem
	rem SUBST /P
	rem

	setlocal

	call :psubst_init

	call :psubst_print

	endlocal
	goto :EOF
)


setlocal

call :psubst_init

call :psubst_check_disk "%~1" || exit /b %ERRORLEVEL%

if /i "%~2" == "/P" (
	rem
	rem PSUBST X: /P
	rem

	call :psubst_lookup "%psubst_disk%"
	if not defined psubst_persist_path (
		echo:%~n0: Drive not persistent
		exit /b 1
	)

	setlocal enabledelayedexpansion

	subst "!psubst_persist_disk!" "!psubst_persist_path!"

	endlocal
	goto :EOF
)

if /i "%~2" == "/D" (
	rem
	rem PSUBST X: /D ...
	rem

	set "psubst_reg_op=delete"
	set "psubst_path="
) else (
	rem
	rem PSUBST X: "..." ...
	rem

	call :psubst_check_path "%~2" || exit /b %ERRORLEVEL%
)

if /i "%~3" == "/P" (
	rem
	rem PSUBST ... /P
	rem

	call :psubst_persist "%~3"
) else if /i "%~3" == "/PF" (
	rem
	rem PSUBST ... /PF
	rem

	call :psubst_persist "%~3"
) else if defined psubst_path (
	rem
	rem SUBST X: "..."
	rem

	subst "%psubst_disk%" "%psubst_path%"
) else (
	rem
	rem SUBST X: /D
	rem

	subst "%psubst_disk%" /D
)

endlocal
goto :EOF


:psubst_init
set "psubst_disk="
set "psubst_path="
set "psubst_value="
set "psubst_persist_disk="
set "psubst_persist_path="
set "psubst_reg_op="
set "psubst_regkey=HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Control\Session Manager\DOS Devices"
goto :EOF


:psubst_check_disk
if not "%~1" == "" for %%d in ( "%~1" ) do if /i "%%~d" == "%%~dd" (
	set "psubst_disk=%%~d"
	exit /b 0
)

echo:%~n0: Invalid parameter: %~1
exit /b 1


:psubst_check_path
if /i "%~1" == "/D" (
	set "psubst_reg_op=delete"
	set "psubst_path="
	exit /b 0
)

if not "%~1" == "" for %%f in ( "%~1\." ) do if exist %%~sf\nul (
	set "psubst_reg_op=add"
	set "psubst_path=%%~ff"
	exit /b 0
)

echo:%~n0: Path not found: %~1
exit /b 1


:psubst_persist
call :psubst_lookup "%psubst_disk%"

if /i "%psubst_reg_op%" == "add" if defined psubst_persist_disk (
	echo:%~n0: Drive already SUBSTed persistently
	exit /b 1
)

if /i "%psubst_reg_op%" == "delete" if not defined psubst_persist_disk (
	echo:%~n0: Drive not SUBSTed persistently
	exit /b 1
)

set "psubst_value="

if /i "%~1" == "/PF" (
	call :psubst_persist_reg_sudo
) else (
	call :psubst_persist_reg
)

call :psubst_lookup "%psubst_disk%"

if /i "%psubst_reg_op%" == "add" if not defined psubst_persist_disk (
	echo:%~n0: Unable to add persistently SUBSTed drive
	exit /b 1
)

if /i "%psubst_reg_op%" == "delete" if defined psubst_persist_disk (
	echo:%~n0: Unable to delete persistently SUBSTed drive
	exit /b 1
)
goto :EOF

:psubst_persist_reg
if defined psubst_path set "psubst_value=/t REG_SZ /d "\??\%psubst_path%""
reg %psubst_reg_op% "%psubst_regkey%" /v %psubst_disk% %psubst_value% /f >nul
goto :EOF

rem Based on the solution suggested in this thread:
rem https://www.dostips.com/forum/viewtopic.php?f=3&t=9212
:psubst_persist_reg_sudo
if defined psubst_path set "psubst_value=/t REG_SZ /d \"\??\%psubst_path%\""
reg add "HKCU\Software\Classes\.elevate\shell\runas\command" /ve /d "cmd.exe /c start reg %psubst_reg_op% \"%psubst_regkey%\" /v %psubst_disk% %psubst_value% /f >nul" /f >nul

type nul > "%TEMP%\%~n0.elevate"
"%TEMP%\%~n0.elevate"
del /q "%TEMP%\%~n0.elevate"

reg delete "HKCU\Software\Classes\.elevate" /f >nul

goto :EOF


:psubst_print
setlocal
call :psubst_lookup
endlocal
goto :EOF


:psubst_lookup
set "psubst_persist_disk="
set "psubst_persist_path="

for /f "tokens=1,2,*" %%a in ( 'reg query "%psubst_regkey%"' ) do ^
for /f "tokens=1,* delims=\\" %%k in ( "%%~c" ) do ^
if "%%k" == "??" if "%~1" == "" (
	echo:%%~a\: =^> %%~l
) else if /i "%~1" == "%%~a" (
	set "psubst_persist_disk=%%~a"
	set "psubst_persist_path=%%~l"
	goto :EOF
)
goto :EOF


:print_usage
for /f "tokens=* delims=:" %%s in ( 'findstr "^::" "%~f0"' ) do echo:%%s
goto :EOF


Log in or click on link to see number of positives.

In cases where actual malware is found, the packages are subject to removal. Software sometimes has false positives. Moderators do not necessarily validate the safety of the underlying software, only that a package retrieves software from the official distribution point and/or validate embedded software against official distribution point (where distribution rights allow redistribution).

Chocolatey Pro provides runtime protection from possible malware.

Version Downloads Last Updated Status
psubst 2.6.2 68 Wednesday, December 11, 2019 Approved

This package has no dependencies.

Discussion for the psubst Package

Ground Rules:

  • This discussion is only about psubst and the psubst package. If you have feedback for Chocolatey, please contact the Google Group.
  • This discussion will carry over multiple versions. If you have a comment about a particular version, please note that in your comments.
  • The maintainers of this Chocolatey Package will be notified about new comments that are posted to this Disqus thread, however, it is NOT a guarantee that you will get a response. If you do not hear back from the maintainers after posting a message below, please follow up by using the link on the left side of this page or follow this link to contact maintainers. If you still hear nothing back, please follow the package triage process.
  • Tell us what you love about the package or psubst, or tell us what needs improvement.
  • Share your experiences with the package, or extra configuration or gotchas that you've found.
  • If you use a url, the comment will be flagged for moderation until you've been whitelisted. Disqus moderated comments are approved on a weekly schedule if not sooner. It could take between 1-5 days for your comment to show up.
comments powered by Disqus