From 7a6a007302c0a2dcffcd606c82d6d3195952ed17 Mon Sep 17 00:00:00 2001 From: Profpatsch Date: Sun, 28 Jun 2020 00:06:11 +0200 Subject: refactor(nix/escapeExecline): move into own directory MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit The escaping functions are going to be used by both `writeExecline` and `runExecline`, so let’s move them to their own namespace. Change-Id: Iccf69eaeca3062573e0751a17c548b7def86196d Reviewed-on: https://cl.tvl.fyi/c/depot/+/706 Reviewed-by: tazjin Reviewed-by: Kane York --- nix/escapeExecline/OWNERS | 3 +++ nix/escapeExecline/default.nix | 29 +++++++++++++++++++++++++++++ nix/writeExecline/default.nix | 32 ++------------------------------ 3 files changed, 34 insertions(+), 30 deletions(-) create mode 100644 nix/escapeExecline/OWNERS create mode 100644 nix/escapeExecline/default.nix diff --git a/nix/escapeExecline/OWNERS b/nix/escapeExecline/OWNERS new file mode 100644 index 000000000000..a742d0d22bf6 --- /dev/null +++ b/nix/escapeExecline/OWNERS @@ -0,0 +1,3 @@ +inherited: true +owners: + - Profpatsch diff --git a/nix/escapeExecline/default.nix b/nix/escapeExecline/default.nix new file mode 100644 index 000000000000..deef5c2c4ec8 --- /dev/null +++ b/nix/escapeExecline/default.nix @@ -0,0 +1,29 @@ +{ lib, ... }: +let + # replaces " and \ to \" and \\ respectively and quote with " + # e.g. + # a"b\c -> "a\"b\\c" + # a\"bc -> "a\\\"bc" + escapeExeclineArg = arg: + ''"${builtins.replaceStrings [ ''"'' ''\'' ] [ ''\"'' ''\\'' ] (toString arg)}"''; + + # Escapes an execline (list of execline strings) to be passed to execlineb + # Give it a nested list of strings. Nested lists are interpolated as execline + # blocks ({}). + # Everything is quoted correctly. + # + # Example: + # escapeExecline [ "if" [ "somecommand" ] "true" ] + # == ''"if" { "somecommand" } "true"'' + escapeExecline = execlineList: lib.concatStringsSep " " + (let + go = arg: + if builtins.isString arg then [(escapeExeclineArg arg)] + else if builtins.isPath arg then [(escapeExeclineArg "${arg}")] + else if lib.isDerivation arg then [(escapeExeclineArg arg)] + else if builtins.isList arg then [ "{" ] ++ builtins.concatMap go arg ++ [ "}" ] + else abort "escapeExecline can only hande nested lists of strings, was ${lib.generators.toPretty {} arg}"; + in builtins.concatMap go execlineList); + +in +escapeExecline diff --git a/nix/writeExecline/default.nix b/nix/writeExecline/default.nix index 0916e2d58eac..49bc416094a3 100644 --- a/nix/writeExecline/default.nix +++ b/nix/writeExecline/default.nix @@ -1,4 +1,4 @@ -{ pkgs, lib, ... }: +{ pkgs, depot, ... }: # Write an execline script, represented as nested nix lists. # Everything is escaped correctly. @@ -6,34 +6,6 @@ # TODO(Profpatsch) upstream into nixpkgs -let - # replaces " and \ to \" and \\ respectively and quote with " - # e.g. - # a"b\c -> "a\"b\\c" - # a\"bc -> "a\\\"bc" - escapeExeclineArg = arg: - ''"${builtins.replaceStrings [ ''"'' ''\'' ] [ ''\"'' ''\\'' ] (toString arg)}"''; - - # Escapes an execline (list of execline strings) to be passed to execlineb - # Give it a nested list of strings. Nested lists are interpolated as execline - # blocks ({}). - # Everything is quoted correctly. - # - # Example: - # escapeExecline [ "if" [ "somecommand" ] "true" ] - # == ''"if" { "somecommand" } "true"'' - escapeExecline = execlineList: lib.concatStringsSep " " - (let - go = arg: - if builtins.isString arg then [(escapeExeclineArg arg)] - else if builtins.isPath arg then [(escapeExeclineArg "${arg}")] - else if lib.isDerivation arg then [(escapeExeclineArg arg)] - else if builtins.isList arg then [ "{" ] ++ builtins.concatMap go arg ++ [ "}" ] - else abort "escapeExecline can only hande nested lists of strings, was ${lib.generators.toPretty {} arg}"; - in builtins.concatMap go execlineList); - -in - name: { # "var": substitute readNArgs variables and start $@ @@ -63,5 +35,5 @@ in # TODO(Profpatsch): rewrite `writeScript` with `runExecline` pkgs.writeScript name '' #!${pkgs.execline}/bin/execlineb -W${env} - ${escapeExecline argList} + ${depot.nix.escapeExecline argList} '' -- cgit 1.4.1