getgit: Fix user path reg query result potentially getting truncated #558
Conversation
|
/updpkgsums |
The typo in the filename prevented the `/updpkgsums` command in git-for-windows/build-extra#558 (comment) from working. Signed-off-by: Johannes Schindelin <[email protected]>
|
Oops. |
|
/updpkgsums The workflow run was started. The workflow run was started. |
The reg query command used returns a multi-line output that contains the path variable's content in its third line:
Path REG_EXPAND_SZ [actual path variable]
The previous code just returned the last column of that line using awk, which fails to account
for spaces in the path, in which case only the part after the last space was printed.
Now cut is used to skip the first 12 spaces and print every after it, which returns the entire path variable's content unmodified.
Signed-off-by: Moritz Bender <[email protected]>
Signed-off-by: Johannes Schindelin <[email protected]>
git-extra/getgit
Outdated
| userpath=$(reg query "HKEY_CURRENT_USER\Environment" //v Path 2>/dev/null | awk 'NR==3 {print $NF}') | ||
| userpath=$(reg query "HKEY_CURRENT_USER\Environment" //v Path 2>/dev/null | awk 'NR==3 {print}' | cut -d ' ' -f 13-) |
There was a problem hiding this comment.
Would the following work, too?
reg query "HKEY_CURRENT_USER\Environment" //v Path | sed -n 's/^ *Path *REG_EXPAND_SZ *//p'I would have a preference for that if it worked, because:
- It avoids spawning two processes, and
- It spells out what is expected instead of relying on the magic row number 3 and the magic column number 13.
There was a problem hiding this comment.
Looks like that doesn't work all the time because the path variable may be of type REG_SZ or REG_EXPAND_SZ, depending on whether or not variables like %USERPROFILE% are used (see https://learn.microsoft.com/en-us/windows/win32/sysinfo/registry-value-types for registry value types). I assume those are the only valid types for that key that the system accepts, although REG_MULTI_SZ also sounds possible to me. If you prefer the sed approach, reg query "HKEY_CURRENT_USER\Environment" //v Path | sed -n 's/^ *Path *REG\(_EXPAND\)\?_SZ *//p' has worked for both REG_SZ and REG_EXPAND_SZ in my testing.
It's a bit unfortunate that the reg query output is inherently badly formatted for automated reading, but I think the assumptions that have worked so far are safe (value always on line 3, separators are exactly 4 spaces...).
There was a problem hiding this comment.
It's a bit unfortunate that the
reg queryoutput is inherently badly formatted for automated reading, but I think the assumptions that have worked so far are safe (value always on line 3, separators are exactly 4 spaces...).
It might be better to turn this into a PowerShell scriptlet, anyway. Something like this:
userpath="$(powershell -command '(Get-ItemProperty -Path 'HKCU:\Environment' -Name Path).Path')"What do you think?
There was a problem hiding this comment.
Sure, that would be ideal. Given this only runs on windows, powershell should be guaranteed to be available.
The powershell command returns the queried value directly with no additional parsing required. Signed-off-by: Moritz Bender <[email protected]>
|
/updpkgsums The workflow run was started. |
Signed-off-by: Johannes Schindelin <[email protected]>
|
/deploy |
|
/deploy git-extra The i686/x86_64 and the arm64 workflow runs were started. |
The typo in the filename prevented the `/updpkgsums` command in git-for-windows/build-extra#558 (comment) from working. Signed-off-by: Johannes Schindelin <[email protected]>
This reg query result for the user path environment variable could potentially get truncated if a space was contained anywhere inside the path variable. This is especially problematic because this incorrect value is then written back, effectively destroying part of the users path.
For example with path containing
D:\important\entry;C:\my\very spacey\path:Before:
reg query "HKEY_CURRENT_USER\Environment" //v Path 2>/dev/null | awk 'NR==3 {print $NF}'->spacey\pathAfter:
reg query "HKEY_CURRENT_USER\Environment" //v Path 2>/dev/null | awk 'NR==3 {print}' | cut -d ' ' -f 13-->D:\important\entry;C:\my\very spacey\path