pm_sysPath::getPathVerbatimCMD Interface Reference

Generate and return a path quoted with double quotation marks where all instances of double quotes \(\ms{"}\) within the path are removed.
More...

Detailed Description

Generate and return a path quoted with double quotation marks where all instances of double quotes \(\ms{"}\) within the path are removed.

This procedure exists to minimize security vulnerabilities associated with paths that may contain harmful system commands.
To ensure paths are interpreted as simple strings, they must be quoted with proper quotation marks on both Windows and Unix-like platforms.
The path returned by this procedure is as close as one can get to a verbatim path in Windows CMD.
Windows-style paths cannot contain double quotation marks. However, their dangling presence can create security vulnerabilities.
As such, if a path is be used in a call to a CMD runtime shell, it is recommended to pass it to this procedure to ensure the path is quoted and all instances of dangling quotation marks \(\ms{"}\) are gracefully escaped.
See also the warnings below.

When should I quote a Windows CMD path using this generic interface?
Quoting CMD paths is crucial for graceful handling of situations where,

1. the path is too long (> 255 characters), or
2. the path contains blanks or dangling double-quotation marks, or
3. the path mixes forward slash and backward slash as directory separators.
   

Parameters

[in]

path

: The input scalar character of kind any supported by the processor (e.g., SK, SKA, SKD , or SKU) containing the path to be enclosed with quotation marks.

Returns

pathVerbatim : The output allocatable scalar of type character of the same kind as path containing the modified input path enclosed with double quotation marks where all instances of double quotation marks within the path are removed.

Possible calling interfaces ⛓

use pm_sysPath, only: getPathVerbatimCMD
 
pathVerbatim = getPathVerbatimCMD(path)

Warning

Note that this procedure does not inspect the input path for the presence of other illegal Windows reserved characters (e.g., WINDOWS_RESERVED_STR).
The presence of illegal characters in a Windows path can lead to runtime errors even if the path is quoted by the procedures of this generic interface.

The Windows CMD wildcard characters remain interpretable by the CMD shell if any are present in the input path.
The asterisk * and question mark ? are used as wildcard characters in Windows CMD, as they are in MS-DOS and Windows.
The asterisk matches any sequence of characters, whereas the question mark matches any single character.

The pure procedure(s) documented herein become impure when the ParaMonte library is compiled with preprocessor macro CHECK_ENABLED=1.
By default, these procedures are pure in release build and impure in debug and testing builds. The impurity is caused by the call to procedures whose purity depends on the library build configuration.

See also

getPathVerbatimPowerShell
getPathVerbatimPosix
getPathVerbatimFish
getPathVerbatimCMD
getPathVerbatim
getPathPosix
setPathPosix
getPathPosixEscaped
setPathPosixEscaped

Example usage ⛓

program example
 
    use pm_kind, only: SK, LK
    use pm_io, only: display_type
    use pm_sysPath, only: getPathVerbatimCMD
 
    implicit none
 
    character(:), allocatable :: path
 
    type(display_type) :: disp
    disp = display_type(file = "main.out.F90")
 
    call disp%skip()
    call disp%show("path = ''")
                    path = ''
    call disp%show("path = getPathVerbatimCMD(path)")
                    path = getPathVerbatimCMD(path)
    call disp%show("path")
    call disp%show( path , deliml = SK_'''' )
    call disp%skip()
 
    call disp%skip()
    call disp%show("path = './paramonte'")
                    path = './paramonte'
    call disp%show("path = getPathVerbatimCMD(path)")
                    path = getPathVerbatimCMD(path)
    call disp%show("path")
    call disp%show( path , deliml = SK_'''' )
    call disp%skip()
 
    call disp%skip()
    call disp%show("path = './paramonte""'")
                    path = './paramonte"'
    call disp%show("path = getPathVerbatimCMD(path)")
                    path = getPathVerbatimCMD(path)
    call disp%show("path")
    call disp%show( path , deliml = SK_'''' )
    call disp%skip()
 
end program example

Example Unix compile command via Intel ifort compiler ⛓

#!/usr/bin/env sh
rm main.exe
ifort -fpp -standard-semantics -O3 -Wl,-rpath,../../../lib -I../../../inc main.F90 ../../../lib/libparamonte* -o main.exe
./main.exe

Example Windows Batch compile command via Intel ifort compiler ⛓

del main.exe
set PATH=..\..\..\lib;%PATH%
ifort /fpp /standard-semantics /O3 /I:..\..\..\include main.F90 ..\..\..\lib\libparamonte*.lib /exe:main.exe
main.exe

Example Unix / MinGW compile command via GNU gfortran compiler ⛓

#!/usr/bin/env sh
rm main.exe
gfortran -cpp -ffree-line-length-none -O3 -Wl,-rpath,../../../lib -I../../../inc main.F90 ../../../lib/libparamonte* -o main.exe
./main.exe

Example output ⛓

 
path = ''
path = getPathVerbatimCMD(path)
path
'""'
 
 
path = './paramonte'
path = getPathVerbatimCMD(path)
path
'"./paramonte"'
 
 
path = './paramonte"'
path = getPathVerbatimCMD(path)
path
'"./paramonte"'
 
 

Test:

test_pm_sysPath

Final Remarks ⛓

---

If you believe this algorithm or its documentation can be improved, we appreciate your contribution and help to edit this page's documentation and source file on GitHub.
For details on the naming abbreviations, see this page.
For details on the naming conventions, see this page.
This software is distributed under the MIT license with additional terms outlined below.

1. If you use any parts or concepts from this library to any extent, please acknowledge the usage by citing the relevant publications of the ParaMonte library.
   
2. If you regenerate any parts/ideas from this library in a programming environment other than those currently supported by this ParaMonte library (i.e., other than C, C++, Fortran, MATLAB, Python, R), please also ask the end users to cite this original ParaMonte library.
   

This software is available to the public under a highly permissive license.
Help us justify its continued development and maintenance by acknowledging its benefit to society, distributing it, and contributing to it.

Copyright

Computational Data Science Lab

Author:

Amir Shahmoradi, Tuesday March 7, 2017, 3:50 AM, Institute for Computational Engineering and Sciences (ICES), The University of Texas Austin

Definition at line 4955 of file pm_sysPath.F90.

---

The documentation for this interface was generated from the following file:

• src/fortran/main/pm_sysPath.F90