From 22d03f20fb1788c6eade6eb9bd7f572fc9ed1670 Mon Sep 17 00:00:00 2001
From: Robert Helgesson <robert@rycee.net>
Date: Fri, 1 May 2020 00:11:14 +0200
Subject: [PATCH] git: escape string values in configuration

This should handle the special characters that typically occur.

Fixes #1206

(cherry picked from commit 642d9ffe24eec1290e94d70e8129ba74922fddf2)
---
 modules/programs/git.nix                      | 12 ++++++-
 .../programs/git/git-expected-include.conf    |  4 +--
 tests/modules/programs/git/git-expected.conf  | 31 ++++++++++---------
 .../programs/git/git-with-email-expected.conf | 20 ++++++------
 .../git-with-str-extra-config-expected.conf   |  4 +--
 tests/modules/programs/git/git.nix            |  1 +
 6 files changed, 42 insertions(+), 30 deletions(-)

diff --git a/modules/programs/git.nix b/modules/programs/git.nix
index 28a11002..28f97789 100644
--- a/modules/programs/git.nix
+++ b/modules/programs/git.nix
@@ -19,9 +19,19 @@ let
     else
       ''${section} "${subsection}"'';
 
+  mkValueString = v:
+    let
+      escapedV = ''
+        "${
+          replaceStrings [ "\n" "	" ''"'' "\\" ] [ "\\n" "\\t" ''\"'' "\\\\" ] v
+        }"'';
+    in generators.mkValueStringDefault { } (if isString v then escapedV else v);
+
   # generation for multiple ini values
   mkKeyValue = k: v:
-    let mkKeyValue = generators.mkKeyValueDefault { } " = " k;
+    let
+      mkKeyValue =
+        generators.mkKeyValueDefault { inherit mkValueString; } " = " k;
     in concatStringsSep "\n" (map (kv: "	" + mkKeyValue kv) (toList v));
 
   # converts { a.b.c = 5; } to { "a.b".c = 5; } for toINI
diff --git a/tests/modules/programs/git/git-expected-include.conf b/tests/modules/programs/git/git-expected-include.conf
index 2913a47e..f05c7b6c 100644
--- a/tests/modules/programs/git/git-expected-include.conf
+++ b/tests/modules/programs/git/git-expected-include.conf
@@ -1,3 +1,3 @@
 [user]
-	email = user@example.org
-	name = John Doe
+	email = "user@example.org"
+	name = "John Doe"
diff --git a/tests/modules/programs/git/git-expected.conf b/tests/modules/programs/git/git-expected.conf
index 96630b9a..45ba08db 100644
--- a/tests/modules/programs/git/git-expected.conf
+++ b/tests/modules/programs/git/git-expected.conf
@@ -1,6 +1,7 @@
 [alias]
-	a1 = foo
-	a2 = baz
+	a1 = "foo"
+	a2 = "baz"
+	escapes = "\"\\n\t"
 
 [commit]
 	gpgSign = true
@@ -10,33 +11,33 @@
 	integer = 38
 	multiple = 1
 	multiple = 2
-	name = value
+	name = "value"
 
 [extra "backcompat.with.dots"]
-	previously = worked
+	previously = "worked"
 
 [extra "subsection"]
-	value = test
+	value = "test"
 
 [filter "lfs"]
-	clean = git-lfs clean -- %f
-	process = git-lfs filter-process
+	clean = "git-lfs clean -- %f"
+	process = "git-lfs filter-process"
 	required = true
-	smudge = git-lfs smudge -- %f
+	smudge = "git-lfs smudge -- %f"
 
 [gpg]
-	program = path-to-gpg
+	program = "path-to-gpg"
 
 [user]
-	email = user@example.org
-	name = John Doe
-	signingKey = 00112233445566778899AABBCCDDEEFF
+	email = "user@example.org"
+	name = "John Doe"
+	signingKey = "00112233445566778899AABBCCDDEEFF"
 
 [include]
-	path = ~/path/to/config.inc
+	path = "~/path/to/config.inc"
 
 [includeIf "gitdir:~/src/dir"]
-	path = ~/path/to/conditional.inc
+	path = "~/path/to/conditional.inc"
 
 [includeIf "gitdir:~/src/dir"]
-	path = @git_include_path@
+	path = "@git_include_path@"
diff --git a/tests/modules/programs/git/git-with-email-expected.conf b/tests/modules/programs/git/git-with-email-expected.conf
index f13de91c..44035a23 100644
--- a/tests/modules/programs/git/git-with-email-expected.conf
+++ b/tests/modules/programs/git/git-with-email-expected.conf
@@ -1,15 +1,15 @@
 [sendemail "hm-account"]
-	from = hm@example.org
-	smtpEncryption = tls
-	smtpServer = smtp.example.org
-	smtpUser = home.manager.jr
+	from = "hm@example.org"
+	smtpEncryption = "tls"
+	smtpServer = "smtp.example.org"
+	smtpUser = "home.manager.jr"
 
 [sendemail "hm@example.com"]
-	from = hm@example.com
-	smtpEncryption = tls
-	smtpServer = smtp.example.com
-	smtpUser = home.manager
+	from = "hm@example.com"
+	smtpEncryption = "tls"
+	smtpServer = "smtp.example.com"
+	smtpUser = "home.manager"
 
 [user]
-	email = hm@example.com
-	name = H. M. Test
+	email = "hm@example.com"
+	name = "H. M. Test"
diff --git a/tests/modules/programs/git/git-with-str-extra-config-expected.conf b/tests/modules/programs/git/git-with-str-extra-config-expected.conf
index b343ed88..071268e8 100644
--- a/tests/modules/programs/git/git-with-str-extra-config-expected.conf
+++ b/tests/modules/programs/git/git-with-str-extra-config-expected.conf
@@ -1,5 +1,5 @@
 This can be anything.
 
 [user]
-	email = user@example.org
-	name = John Doe
+	email = "user@example.org"
+	name = "John Doe"
diff --git a/tests/modules/programs/git/git.nix b/tests/modules/programs/git/git.nix
index 79f4f016..d3c586fe 100644
--- a/tests/modules/programs/git/git.nix
+++ b/tests/modules/programs/git/git.nix
@@ -28,6 +28,7 @@ in {
         aliases = {
           a1 = "foo";
           a2 = "bar";
+          escapes = ''"\n	'';
         };
         extraConfig = {
           extra = {