Unverified Commit d9eb52b0 authored by Artturin's avatar Artturin Committed by GitHub
Browse files

fetchurl: fixup typo on a comment (#344330)

parents b7085bde 3b5971e7

.git-blame-ignore-revs

+3 −0
Original line number Diff line number Diff line
@@ -171,3 +171,6 @@ cffc27daf06c77c0d76bc35d24b929cb9d68c3c9 


# nixos/kanidm: inherit lib, nixfmt

8f18393d380079904d072007fb19dc64baef0a3a



# fetchurl: nixfmt-rfc-style

ce21e97a1f20dee15da85c084f9d1148d84f853b

pkgs/build-support/fetchurl/boot.nix

+19 −10
Original line number Diff line number Diff line 
let mirrors = import ./mirrors.nix; in

let

  mirrors = import ./mirrors.nix;

in



{ system }:



{ url ? builtins.head urls

, urls ? []

, sha256 ? ""

, hash ? ""

, name ? baseNameOf (toString url)

{

  url ? builtins.head urls,

  urls ? [ ],

  sha256 ? "",

  hash ? "",

  name ? baseNameOf (toString url),

}:



# assert exactly one hash is set
@@ -14,12 +17,18 @@ assert hash != "" || sha256 != ""; 
assert hash != "" -> sha256 == "";



import <nix/fetchurl.nix> {

  inherit system hash sha256 name;

  inherit

    system

    hash

    sha256

    name

    ;



  url =

    # Handle mirror:// URIs. Since <nix/fetchurl.nix> currently

    # supports only one URI, use the first listed mirror.

    let m = builtins.match "mirror://([a-z]+)/(.*)" url; in

    if m == null then url

    else builtins.head (mirrors.${builtins.elemAt m 0}) + (builtins.elemAt m 1);

    let

      m = builtins.match "mirror://([a-z]+)/(.*)" url;

    in

    if m == null then url else builtins.head (mirrors.${builtins.elemAt m 0}) + (builtins.elemAt m 1);

}

pkgs/build-support/fetchurl/default.nix

+202 −122
Original line number Diff line number Diff line 
{ lib, buildPackages ? { inherit stdenvNoCC; }, stdenvNoCC

, curl # Note that `curl' may be `null', in case of the native stdenvNoCC.

, cacert ? null }:

{

  lib,

  buildPackages ? {

    inherit stdenvNoCC;

  },

  stdenvNoCC,

  curl, # Note that `curl' may be `null', in case of the native stdenvNoCC.

  cacert ? null,

}:



let
@@ -11,19 +17,23 @@ let 
  # 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 =

    buildPackages.stdenvNoCC.mkDerivation ({

  mirrorsFile = buildPackages.stdenvNoCC.mkDerivation (

    {

      name = "mirrors-list";

      strictDeps = true;

      builder = ./write-mirror-list.sh;

      preferLocalBuild = true;

    } // mirrors);

    }

    // mirrors

  );



  # Names of the master sites that are mirrored (i.e., "sourceforge",

  # "gnu", etc.).

  sites = builtins.attrNames mirrors;



  impureEnvVars = lib.fetchers.proxyImpureEnvVars ++ [

  impureEnvVars =

    lib.fetchers.proxyImpureEnvVars

    ++ [

      # This variable allows the user to pass additional options to curl

      "NIX_CURL_FLAGS"
@@ -34,123 +44,169 @@ let 
      # This variable allows overriding the timeout for connecting to

      # the hashed mirrors.

      "NIX_CONNECT_TIMEOUT"

  ] ++ (map (site: "NIX_MIRRORS_${site}") sites);

    ]

    ++ (map (site: "NIX_MIRRORS_${site}") sites);



in



{ # URL to fetch.

  url ? ""

{

  # URL to fetch.

  url ? "",



, # Alternatively, a list of URLs specifying alternative download

  # Alternatively, a list of URLs specifying alternative download

  # locations.  They are tried in order.

  urls ? []

  urls ? [ ],



, # Additional curl options needed for the download to succeed.

  # Additional curl options needed for the download to succeed.

  # Warning: Each space (no matter the escaping) will start a new argument.

  # If you wish to pass arguments with spaces, use `curlOptsList`

  curlOpts ? ""

  curlOpts ? "",



, # Additional curl options needed for the download to succeed.

  curlOptsList ? []

  # Additional curl options needed for the download to succeed.

  curlOptsList ? [ ],



, # Name of the file.  If empty, use the basename of `url' (or of the

  # Name of the file.  If empty, use the basename of `url' (or of the

  # first element of `urls').

  name ? ""

  name ? "",



  # for versioned downloads optionally take pname + version.

, pname ? ""

, version ? ""

  pname ? "",

  version ? "",



, # SRI hash.

  hash ? ""

  # SRI hash.

  hash ? "",



, # Legacy ways of specifying the hash.

  outputHash ? ""

, outputHashAlgo ? ""

, sha1 ? ""

, sha256 ? ""

, sha512 ? ""

  # Legacy ways of specifying the hash.

  outputHash ? "",

  outputHashAlgo ? "",

  sha1 ? "",

  sha256 ? "",

  sha512 ? "",



, recursiveHash ? false

  recursiveHash ? false,



, # Shell code to build a netrc file for BASIC auth

  netrcPhase ? null

  # Shell code to build a netrc file for BASIC auth

  netrcPhase ? null,



, # Impure env vars (https://nixos.org/nix/manual/#sec-advanced-attributes)

  # Impure env vars (https://nixos.org/nix/manual/#sec-advanced-attributes)

  # needed for netrcPhase

  netrcImpureEnvVars ? []

  netrcImpureEnvVars ? [ ],



, # Shell code executed after the file has been fetched

  # Shell code executed after the file has been fetched

  # successfully. This can do things like check or transform the file.

  postFetch ? ""

  postFetch ? "",



, # Whether to download to a temporary path rather than $out. Useful

  # Whether to download to a temporary path rather than $out. Useful

  # in conjunction with postFetch. The location of the temporary file

  # is communicated to postFetch via $downloadedFile.

  downloadToTemp ? false

  downloadToTemp ? false,



, # If true, set executable bit on downloaded file

  executable ? false

  # If true, set executable bit on downloaded file

  executable ? false,



, # If set, don't download the file, but write a list of all possible

  # If set, don't download the file, but write a list of all possible

  # URLs (resulting from resolving mirror:// URLs) to $out.

  showURLs ? false

  showURLs ? false,



, # Meta information, if any.

  meta ? {}

  # Meta information, if any.

  meta ? { },



  # Passthru information, if any.

, passthru ? {}

  passthru ? { },

  # Doing the download on a remote machine just duplicates network

  # traffic, so don't do that by default

, preferLocalBuild ? true

  preferLocalBuild ? true,



  # Additional packages needed as part of a fetch

, nativeBuildInputs ? [ ]

  nativeBuildInputs ? [ ],

}:



let

  urls_ =

    if urls != [ ] && url == "" then

      (if lib.isList urls then urls

       else throw "`urls` is not a list")

      (if lib.isList urls then urls else throw "`urls` is not a list")

    else if urls == [ ] && url != "" then

      (if lib.isString url then [url]

       else throw "`url` is not a string")

    else throw "fetchurl requires either `url` or `urls` to be set";

      (if lib.isString url then [ url ] else throw "`url` is not a string")

    else

      throw "fetchurl requires either `url` or `urls` to be set";



  hash_ =

    if with lib.lists; length (filter (s: s != "") [ hash outputHash sha1 sha256 sha512 ]) > 1

    then throw "multiple hashes passed to fetchurl" else

    if

      with lib.lists;

      length (

        filter (s: s != "") [

          hash

          outputHash

          sha1

          sha256

          sha512

        ]

      ) > 1

    then

      throw "multiple hashes passed to fetchurl"

    else



    if hash != "" then { outputHashAlgo = null; outputHash = hash; }

    if hash != "" then

      {

        outputHashAlgo = null;

        outputHash = hash;

      }

    else if outputHash != "" then

      if outputHashAlgo != "" then { inherit outputHashAlgo outputHash; }

      else throw "fetchurl was passed outputHash without outputHashAlgo"

    else if sha512 != "" then { outputHashAlgo = "sha512"; outputHash = sha512; }

    else if sha256 != "" then { outputHashAlgo = "sha256"; outputHash = sha256; }

    else if sha1   != "" then { outputHashAlgo = "sha1";   outputHash = sha1; }

    else if cacert != null then { outputHashAlgo = "sha256"; outputHash = ""; }

    else throw "fetchurl requires a hash for fixed-output derivation: ${lib.concatStringsSep ", " urls_}";

      if outputHashAlgo != "" then

        { inherit outputHashAlgo outputHash; }

      else

        throw "fetchurl was passed outputHash without outputHashAlgo"

    else if sha512 != "" then

      {

        outputHashAlgo = "sha512";

        outputHash = sha512;

      }

    else if sha256 != "" then

      {

        outputHashAlgo = "sha256";

        outputHash = sha256;

      }

    else if sha1 != "" then

      {

        outputHashAlgo = "sha1";

        outputHash = sha1;

      }

    else if cacert != null then

      {

        outputHashAlgo = "sha256";

        outputHash = "";

      }

    else

      throw "fetchurl requires a hash for fixed-output derivation: ${lib.concatStringsSep ", " urls_}";

in



assert (lib.isList curlOpts) -> lib.warn ''

    fetchurl for ${toString (builtins.head urls_)}: curlOpts is a list (${lib.generators.toPretty { multiline = false; } curlOpts}), which is not supported anymore.

assert

  (lib.isList curlOpts)

  -> lib.warn ''

    fetchurl for ${toString (builtins.head urls_)}: curlOpts is a list (${

      lib.generators.toPretty { multiline = false; } curlOpts

    }), which is not supported anymore.

    - If you wish to get the same effect as before, for elements with spaces (even if escaped) to expand to multiple curl arguments, use a string argument instead:

      curlOpts = ${lib.strings.escapeNixString (toString curlOpts)};

    - If you wish for each list element to be passed as a separate curl argument, allowing arguments to contain spaces, use curlOptsList instead:

      curlOptsList = [ ${lib.concatMapStringsSep " " lib.strings.escapeNixString curlOpts} ];'' true;



stdenvNoCC.mkDerivation ((

stdenvNoCC.mkDerivation (

  (

    if (pname != "" && version != "") then

      { inherit pname version; }

    else

    { name =

      if showURLs then "urls"

      else if name != "" then name

      else baseNameOf (toString (builtins.head urls_));

      {

        name =

          if showURLs then

            "urls"

          else if name != "" then

            name

          else

            baseNameOf (toString (builtins.head urls_));

      }

) // {

  )

  // {

    builder = ./builder.sh;



    nativeBuildInputs = [ curl ] ++ nativeBuildInputs;
@@ -164,16 +220,33 @@ stdenvNoCC.mkDerivation (( 
    # New-style output content requirements.

    inherit (hash_) outputHashAlgo outputHash;



  # Disable TLS verification only when we know the hash and no credentials are needed to access the ressource

  SSL_CERT_FILE = if (hash_.outputHash == "" || hash_.outputHash == lib.fakeSha256 || hash_.outputHash == lib.fakeSha512 || hash_.outputHash == lib.fakeHash || netrcPhase != null)

                  then "${cacert}/etc/ssl/certs/ca-bundle.crt"

                  else "/no-cert-file.crt";

    # Disable TLS verification only when we know the hash and no credentials are

    # needed to access the resource

    SSL_CERT_FILE =

      if

        (

          hash_.outputHash == ""

          || hash_.outputHash == lib.fakeSha256

          || hash_.outputHash == lib.fakeSha512

          || hash_.outputHash == lib.fakeHash

          || netrcPhase != null

        )

      then

        "${cacert}/etc/ssl/certs/ca-bundle.crt"

      else

        "/no-cert-file.crt";



    outputHashMode = if (recursiveHash || executable) then "recursive" else "flat";



    inherit curlOpts;

    curlOptsList = lib.escapeShellArgs curlOptsList;

  inherit showURLs mirrorsFile postFetch downloadToTemp executable;

    inherit

      showURLs

      mirrorsFile

      postFetch

      downloadToTemp

      executable

      ;



    impureEnvVars = impureEnvVars ++ netrcImpureEnvVars;
@@ -181,11 +254,18 @@ stdenvNoCC.mkDerivation (( 


    inherit preferLocalBuild;



  postHook = if netrcPhase == null then null else ''

    postHook =

      if netrcPhase == null then

        null

      else

        ''

          ${netrcPhase}

          curlOpts="$curlOpts --netrc-file $PWD/netrc"

        '';



    inherit meta;

  passthru = { inherit url; } // passthru;

})
 
    passthru = {

      inherit url;

    } // passthru;

  }

)

pkgs/build-support/fetchurl/tests.nix

+16 −4
Original line number Diff line number Diff line 
{ testers, fetchurl, jq, moreutils, ... }: {

{

  testers,

  fetchurl,

  jq,

  moreutils,

  ...

}:

{

  # Tests that we can send custom headers with spaces in them

  header =

    let headerValue = "Test '\" <- These are some quotes";

    in testers.invalidateFetcherByDrvHash fetchurl {

    let

      headerValue = "Test '\" <- These are some quotes";

    in

    testers.invalidateFetcherByDrvHash fetchurl {

      url = "https://httpbin.org/headers";

      sha256 = builtins.hashString "sha256" (headerValue + "\n");

      curlOptsList = [ "-H" "Hello: ${headerValue}" ];

      curlOptsList = [

        "-H"

        "Hello: ${headerValue}"

      ];

      postFetch = ''

        ${jq}/bin/jq -r '.headers.Hello' $out | ${moreutils}/bin/sponge $out

      '';

pkgs/build-support/fetchurl/mirrors.nix

+1 −1

File changed.

Contains only whitespace changes.