From 78151b144ce2e5173909834017bec17b3d736814 Mon Sep 17 00:00:00 2001
From: Stefan Karpinski <stefan@karpinski.org>
Date: Mon, 22 Jan 2024 13:16:58 -0500
Subject: [PATCH] ignore tree hashes on Windows w/o symlink capability (#3764)

* ignore tree hashes on Windows w/o symlink capability

Step one of addressing https://github.com/JuliaLang/Pkg.jl/issues/3643

* avoid test setting ENV to "nothing"

* Revert "avoid test setting ENV to "nothing""

This reverts commit 5d98110bc3fd89ed5e236e4672254a6e8e2c6c05.

* fix logic on ignore_hash_env_set

---------

Co-authored-by: Ian Butterworth <i.r.butterworth@gmail.com>
---
 src/Artifacts.jl | 41 +++++++++++++++++++++++++++++++----------
 1 file changed, 31 insertions(+), 10 deletions(-)

diff --git a/src/Artifacts.jl b/src/Artifacts.jl
index 1ee4705fb9..acc01e82d0 100644
--- a/src/Artifacts.jl
+++ b/src/Artifacts.jl
@@ -2,6 +2,7 @@ module Artifacts
 
 using Artifacts, Base.BinaryPlatforms, SHA
 using ..MiniProgressBars, ..PlatformEngines
+using Tar: can_symlink
 
 import ..set_readonly, ..GitTools, ..TOML, ..pkg_server, ..can_fancyprint,
        ..stderr_f, ..printpkgstyle
@@ -311,19 +312,39 @@ function download_artifact(
 
     # Did we get what we expected?  If not, freak out.
     if calc_hash.bytes != tree_hash.bytes
-        msg  = "Tree Hash Mismatch!\n"
-        msg *= "  Expected git-tree-sha1:   $(bytes2hex(tree_hash.bytes))\n"
-        msg *= "  Calculated git-tree-sha1: $(bytes2hex(calc_hash.bytes))"
-        # Since tree hash calculation is still broken on some systems, e.g. Pkg.jl#1860,
-        # and Pkg.jl#2317, we allow setting JULIA_PKG_IGNORE_HASHES=1 to ignore the
-        # error and move the artifact to the expected location and return true
-        ignore_hash = Base.get_bool_env("JULIA_PKG_IGNORE_HASHES", false)
+        msg = """
+        Tree Hash Mismatch!
+          Expected git-tree-sha1:   $(bytes2hex(tree_hash.bytes))
+          Calculated git-tree-sha1: $(bytes2hex(calc_hash.bytes))
+        """
+        # actual and expected artifiact paths
+        src = artifact_path(calc_hash; honor_overrides=false)
+        dst = artifact_path(tree_hash; honor_overrides=false)
+        # Since tree hash calculation is rather fragile and file system dependent,
+        # we allow setting JULIA_PKG_IGNORE_HASHES=1 to ignore the error and move
+        # the artifact to the expected location and return true
+        ignore_hash_env_set = get(ENV, "JULIA_PKG_IGNORE_HASHES", "") != ""
+        if ignore_hash_env_set
+            ignore_hash = Base.get_bool_env("JULIA_PKG_IGNORE_HASHES", false)
+            ignore_hash === nothing && @error(
+                "Invalid ENV[\"JULIA_PKG_IGNORE_HASHES\"] value",
+                ENV["JULIA_PKG_IGNORE_HASHES"],
+            )
+            ignore_hash = something(ignore_hash, false)
+        else
+            # default: false except Windows users who can't symlink
+            ignore_hash = Sys.iswindows() &&
+                !mktempdir(can_symlink, dirname(src))
+        end
         if ignore_hash
-            msg *= "\n\$JULIA_PKG_IGNORE_HASHES is set to 1: ignoring error and moving artifact to the expected location"
+            desc = ignore_hash_env_set ?
+                "Environment variable \$JULIA_PKG_IGNORE_HASHES is true" :
+                "System is Windows and user cannot create symlinks"
+            msg *= "\n$desc: \
+                ignoring hash mismatch and moving \
+                artifact to the expected location"
             @error(msg)
             # Move it to the location we expected
-            src = artifact_path(calc_hash; honor_overrides=false)
-            dst = artifact_path(tree_hash; honor_overrides=false)
             mv(src, dst; force=true)
             return true
         end