about summary refs log tree commit diff
path: root/pkgs/build-support/fetchurl/default.nix
blob: 1ee4946c85644951bc5a3cb808f876a71403019e (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
{stdenv, curl, writeScript}: # Note that `curl' may be `null', in case of the native stdenv.

let

  mirrors = import ./mirrors.nix;

  # Write the list of mirrors to a file that we can reuse between
  # fetchurl instantiations, instead of passing the mirrors to
  # fetchurl instantiations via environment variables.  This makes the
  # resulting store derivations (.drv files) much smaller, which in
  # turn makes nix-env/nix-instantiate faster.
  mirrorsFile =
    stdenv.mkDerivation ({
      name = "mirrors-list";
      builder = ./write-mirror-list.sh;
    } // mirrors);

  # Names of the master sites that are mirrored (i.e., "sourceforge",
  # "gnu", etc.).
  sites =
    if builtins ? attrNames
    then builtins.attrNames mirrors
    else [] /* backwards compatibility */;

in

{ # URL to fetch.
  url ? ""

, # Alternatively, a list of URLs specifying alternative download
  # locations.  They are tried in order.
  urls ? []

, # Name of the file.  If empty, use the basename of `url' (or of the
  # first element of `urls').
  name ? ""

  # Different ways of specifying the hash.
, outputHash ? ""
, outputHashAlgo ? ""
, md5 ? ""
, sha1 ? ""
, sha256 ? ""

, # If set, don't download the file, but write a list of all possible
  # URLs (resulting from resolving mirror:// URLs) to $out.
  showURLs ? false

, # If set, down't download file but tell user how to download it.
  restricted ? false

, # Used only if restricted. Should contain instructions how to fetch the file.
  message ? ""
}:

assert urls != [] -> url == "";
assert url != "" -> urls == [];

assert showURLs || (outputHash != "" && outputHashAlgo != "")
    || md5 != "" || sha1 != "" || sha256 != "";

let

  urls_ = if urls != [] then urls else [url];
  name_ = if showURLs then "urls"
    else if name != "" then name
    else baseNameOf (toString (builtins.head urls_));
  hashAlgo_ = if outputHashAlgo != "" then outputHashAlgo else
    if sha256 != "" then "sha256" else if sha1 != "" then "sha1" else "md5";
  hash_ = if outputHash != "" then outputHash else
    if sha256 != "" then sha256 else if sha1 != "" then sha1 else md5;
in

stdenv.mkDerivation ({
  name = name_;
  outputHashAlgo = hashAlgo_;
  outputHash = hash_;
  urls = urls_;

  # Compatibility with Nix <= 0.7.
  id = md5;

  inherit showURLs mirrorsFile;
}
// (if (!showURLs && restricted) then rec {
  builder = writeScript "restrict-message" ''
source ${stdenv}/setup
cat <<_EOF_
${message_}
_EOF_
  '';
  message_ = if message != "" then message else ''
  You have to download ${name_} from ${stdenv.lib.concatStringsSep " " urls_} yourself,
  and add it to the store using either
    nix-store --add-fixed ${hashAlgo_} ${name_}
  or
    ${if hashAlgo_ != "sha256" then "NIX_HASH_ALGO=${hashAlgo_} " else
      ""}nix-prefetch-url file://path/to/${name_}
  '';
}
else {
  builder = ./builder.sh;

  buildInputs = [curl];


  # If set, prefer the content-addressable mirrors
  # (http://nixos.org/tarballs) over the original URLs.
  preferHashedMirrors = true;


  # New-style output content requirements.

  impureEnvVars = [
    # We borrow these environment variables from the caller to allow
    # easy proxy configuration.  This is impure, but a fixed-output
    # derivation like fetchurl is allowed to do so since its result is
    # by definition pure.
    "http_proxy" "https_proxy" "ftp_proxy" "all_proxy" "no_proxy"

    # This variable allows the user to override hashedMirrors from the
    # command-line.
    "NIX_HASHED_MIRRORS"
  ] ++ (map (site: "NIX_MIRRORS_${site}") sites);
})
)