pm_sysPath::getPathVerbatim Interface Reference

Generate and return a path quoted with single or double quotation marks whose metacharacters are also properly escaped depending on the runtime system shell.
More...

Detailed Description

Generate and return a path quoted with single or double quotation marks whose metacharacters are also properly escaped depending on the runtime system shell.

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 procedures under this generic interface call one of the following generic interfaces, depending on the specified or determined runtime system shell,

1. getPathVerbatimPowerShell in Windows or Unix PowerShell environments.
   
2. getPathVerbatimPosix in POSIX-compliant shell environments.
   
3. getPathVerbatimCMD in Windows CMD shell environments.
   

Parameters

[in]	path	: The input scalar character of default kind SK containing the path to be enclosed with quotation marks.
[out]	failed	: The output scalar logical of default kind LK that is .true. if and only if an error occurs while inferring the runtime system shell. (optional. If missing and a runtime error occurs, the program will halt by calling error stop.)
[in,out]	errmsg	: The input/output scalar character of default kind SK of arbitrary length type parameter. If an error occurs, errmsg will be set to a descriptive message about the nature of the runtime error. A length of LEN_IOMSG characters is likely sufficient to capture most error messages in full. (optional. If missing, no error message will be output. Its presence is relevant only if failed is also present.)

Returns

pathVerbatim : The output allocatable scalar of type character of the same kind as path containing the modified input path enclosed with single or double quotation marks such that it can be treated as a verbatim path in the specified or the runtime shell.

Possible calling interfaces ⛓

use pm_sysPath, only: getPathVerbatim
character(255, SK) :: errmsg
logical(LK) :: failed
 
pathVerbatim = getPathVerbatim(path, failed = failed, errmsg = errmsg)

Remarks

The procedures under discussion are impure.

See also

getPathVerbatimPowerShell
getPathVerbatimPosix
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: getPathVerbatim
    use pm_sysShell, only: shell_type
 
    implicit none
 
    type(shell_type) :: Shell
    character(:, SK), allocatable :: path
 
    type(display_type) :: disp
    disp = display_type(file = "main.out.F90")
 
    call disp%skip()
    call disp%show('shell = shell_type()')
                    shell = shell_type()
    call disp%show("shell%name")
    call disp%show( shell%name , deliml = SK_"""" )
    call disp%skip()
 
    call disp%skip()
    call disp%show("path = SK_''")
                    path = SK_''
    call disp%show("path = getPathVerbatim(path)")
                    path = getPathVerbatim(path)
    call disp%show("path")
    call disp%show( path , deliml = SK_"""" )
    call disp%skip()
 
    call disp%skip()
    call disp%show("path = './""paramonte""/library'")
                    path = "./""paramonte""/library"
    call disp%show("path = getPathVerbatim(path)")
                    path = getPathVerbatim(path)
    call disp%show("path")
    call disp%show( path , deliml = SK_'''' )
    call disp%skip()
 
    call disp%skip()
    call disp%show('path = "./''paramonte''/library"')
                    path = './''paramonte''/library'
    call disp%show("path = getPathVerbatim(path)")
                    path = getPathVerbatim(path)
    call disp%show("path")
    call disp%show( path , deliml = SK_"""" )
    call disp%skip()
 
    call disp%skip()
    call disp%show('path = "./''paramonte''/library"')
                    path = './''paramonte''/library'
    call disp%show("path = getPathVerbatim(path)")
                    path = getPathVerbatim(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 ⛓

 
shell = shell_type()
shell%name
"dash"
 
 
path = SK_''
path = getPathVerbatim(path)
path
"''"
 
 
path = './"paramonte"/library'
path = getPathVerbatim(path)
path
''./"paramonte"/library''
 
 
path = "./'paramonte'/library"
path = getPathVerbatim(path)
path
"'./'\''paramonte'\''/library'"
 
 
path = "./'paramonte'/library"
path = getPathVerbatim(path)
path
"'./'\''paramonte'\''/library'"
 
 

Test:

test_pm_sysPath

Todo:

High Priority: The current Fortran standard 202x does not allow passing characters of non-default kind to the intrinsic Fortran statements and procedures.
As such, the implementation of this procedure for non-default character kinds leads to compile-time kind mismatch errors.
This procedure should be converted back to a generic interface in the future when non-default character kinds are also fully supported by the intrinsic functions.

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 5454 of file pm_sysPath.F90.

---

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

• src/fortran/main/pm_sysPath.F90