Windows packaging script. Check administrator permissions and/or 7-Zip version.

[CarlosAlbertoEnciso]

Summary

Update the Windows packaging script.

As discussed here:
https://discourse.llvm.org/t/build-llvm-release-bat-script-options/63146/6
https://reviews.llvm.org/D127938#inline-1234370

Latest 7-zip versions (21.x) require administrator permissions to create symbolic links.

These are the changes in this patch:

• Check if any of the following conditions is true: a) Version of 7-zip is 20.x or older b) Script is running with administrator permissions

[hans]

llvm/utils/release/build_llvm_release.bat

4

This line is saying the same as line 26. If we move the 7zip version check down before :begin, there would be no need to repeat it, and I think it would make sense to do that anyway.

6

I'd suggest baking these notes into the one right before the actual check. Also a little more context may be needed -- the reader might not know why it's desirable to create symlinks.

How about something like : "7zip versions 21.x and higher will try to extract the symlinks in llvm's git archive, which requires running as administrator."

12

Any reason not to do 1-9 instead of 1-3?

[CarlosAlbertoEnciso]

llvm/utils/release/build_llvm_release.bat

4

Good point.

6

All notes replaced with

REM Note:
REM   7zip versions 21.x and higher will try to extract the symlinks in
REM   llvm's git archive, which requires running as administrator.

REM Check for correct 7-zip version and/or administrator permissions.
....

12

Changing to 1-9.

[CarlosAlbertoEnciso]

Address feedback from @hans

• Better description for the reason to create symlinks.
• Expand regular expression to include versions 21 up to 29.

[thieta]

LGTM - maybe a small comment, but won't block on that.

llvm/utils/release/build_llvm_release.bat

24

Took me a while to understand this check - I am guessing you would only have permissions to see it if you are admin? Maybe that should be a comment to explain. There is no better way to test for admin rights in bat?

[hans]

lgtm, thanks!

llvm/utils/release/build_llvm_release.bat

21

Nit: maybe drop "correct" since they're all correct. How about just "Check 7-zip version and/or administrator permissions."

[CarlosAlbertoEnciso]

llvm/utils/release/build_llvm_release.bat

24

Another way to test for administrator rights is using the mklink command. From my understanding, it requires elevated permissions:

mklink /D link target

[CarlosAlbertoEnciso]

Thanks to @hans and @thieta for the patch approval.

But looking with more detail, I found an issue while determining if the script is running with elevated permissions.

• The test is expecting that the %SYSTEMROOT%\SYSTEM32\WDI\LOGFILES permissions have not been changed.

However, those permissions can be changed (at least on my machine as normal user), following the following steps:

1. Try to open that folder with Windows Explorer.
2. You get a warning message You don't have currently permission to acces this folder.
3. An option is presented Click Continue to permanently have access to this folder.
4. After that the script will fail, as the user now has access to that folder.

I found another way (I think more robust) to check for administrator, by using the 'mklink' command.

• It requires administrator permissions to create a symbol link.

Uploaded new patch with these changes.

[CarlosAlbertoEnciso]

Change the test for administrator permissions by using the mklink command.

[hans]

still lgtm (just a few nits)

llvm/utils/release/build_llvm_release.bat

23

I think you mean "temporary" instead of "temporal", here and below.

24

I'd suggest moving this line to where link_name is first used below.

[CarlosAlbertoEnciso]

llvm/utils/release/build_llvm_release.bat

21

Replaced.

23

Changed to temporary.

24

Moved link_name inside the if.

llvm/utils/release/build_llvm_release.bat

 @echo off
-setlocal
+setlocal enabledelayedexpansion
 
 if "%1"=="" goto usage
 goto begin
 
 :usage
 echo Script for building the LLVM installer on Windows,
 echo used for the releases at https://github.com/llvm/llvm-project/releases
 echo.
 echo Usage: build_llvm_release.bat ^<version^>
 echo.
 echo Example: build_llvm_release.bat 14.0.4
 echo.
 exit /b
 
 :begin
 
+REM Note:
+REM   7zip versions 21.x and higher will try to extract the symlinks in
+REM   llvm's git archive, which requires running as administrator.
+
+REM Check 7-zip version and/or administrator permissions.
+for /f "delims=" %%i in ('7z.exe ^| findstr /r "2[1-9].[0-9][0-9]"') do set version=%%i
+if not "%version%"=="" (
+  REM Unique temporary filename to use by the 'mklink' command.
+  set "link_name=%temp%\%username%_%random%_%random%.tmp"
+
+  REM As the 'mklink' requires elevated permissions, the symbolic link
+  REM creation will fail if the script is not running as administrator.
+  mklink /d "!link_name!" . 1>nul 2>nul
+  if errorlevel 1 (
+    echo.
+    echo Script requires administrator permissions, or a 7-zip version 20.x or older.
+    echo Current version is "%version%"
+    exit /b
+  ) else (
+    REM Remove the temporary symbolic link.
+    rd "!link_name!"
+  )
+)
+
 REM Prerequisites:
 REM
 REM   Visual Studio 2019, CMake, Ninja, GNUWin32, SWIG, Python 3,
 REM   NSIS with the strlen_8192 patch,
 REM   Visual Studio 2019 SDK and Nuget (for the clang-format plugin),
 REM   Perl (for the OpenMP run-time).
 REM
 REM