[BUG] regarding `git add -p` and files containing wildcard characters

unixway.drive@gmail.com· Dec 9, 2016, 01:46 UTC · lore

`git add -p` behaves incorrectly if modified file contains any wildcard character. Consider 'random.diff' (attached). For this, interactive 'add' would first ask to add hunk with two diff headers (or with some "random" header at the end):

     $ git add -p
     diff --git a/Random * b/Random *
     index 01e79c3..01f03ff 100644
     --- a/Random *
     +++ b/Random *
     @@ -1,3 +1,5 @@
      1
     +  a
      2
     +  b
      3
     diff --git a/Random Crap b/Random Crap
     index 01e79c3..b4373d5 100644
     --- a/Random Crap
     +++ b/Random Crap
     Stage this hunk [y,n,q,a,d,/,j,J,g,s,e,?]? y

Then it will ask for some irrelevant hunk:

     @@ -1,3 +1,5 @@
      1
     +  whoa
      2
     +  dude
      3
     Stage this hunk [y,n,q,a,d,/,K,g,s,e,?]? y

…and, if confirmed, apply it to the wildcard-named file instead of what was confirmed for staging before:

     $ git diff --cached
     diff --git a/Random * b/Random *
     index 01e79c3..283ac91 100644
     --- a/Random *
     +++ b/Random *
     @@ -1,3 +1,5 @@
      1
     +  whoa
      2
     +  dude
      3

Then one can just repeat this over and over again (unless safely named files are resolved first):

     $ git add -p
     diff --git a/Random * b/Random *
     index 283ac91..04c92f1 100644
     --- a/Random *	
     +++ b/Random *	
     @@ -1,5 +1,5 @@
      1
     -  whoa
     +  a
      2
     -  dude
     +  b
      3
     diff --git a/Random Crap b/Random Crap
     index 01e79c3..283ac91 100644
     --- a/Random Crap	
     +++ b/Random Crap	
     Stage this hunk [y,n,q,a,d,/,j,J,g,s,e,?]?

The problem is that `git-diff-files` does some globbing on the 'path' arguments on its own and has no option to disable that (and `git-add--interactive`'s `run_cmd_pipe` already handles all other sorts of unsafe characters like spaces and backticks well).

     $ strace -f -e trace=execve git add -p
     …
     [pid  1713] execve("/usr/lib/git-core/git",
         ["git", "diff-files", "-p", "--", "Random *"],
     [/* 36 vars */]) = 0
     …
     $ git diff-files -- 'Random *'
     :100644 100644 … … M	Random *
     :100644 100644 … … M	Random Crap

For all the eager people (although I doubt if anybody else is lazy enough to not bother with file names like these), this could be easily worked around like this:

diff --git a/git-add--interactive.perl b/git-add--interactive.perl
index ee3d812..358d877 100755
--- a/git-add--interactive.perl
+++ b/git-add--interactive.perl
@@ -2,3 +2,3 @@

-use 5.008;
+use 5.014;
  use strict;
@@ -761,3 +761,5 @@ sub parse_diff {
         }
-       my @diff = run_cmd_pipe("git", @diff_cmd, "--", $path);
+       my @diff = run_cmd_pipe("git", @diff_cmd, "--", (
+               $path =~ s#[\[*?]#\\$&#gr
+       ));
         my @colored = ();

(Although a `git-diff-files` option is clearly a better solution that 
would cover tools other than `git-add--interactive` as well.)


diff --git a/Random * b/Random *
index 01e79c3..04c92f1 100644
--- a/Random *	
+++ b/Random *	
@@ -1,3 +1,5 @@
 1
+  a
 2
+  b
 3
diff --git a/Random Crap b/Random Crap
index 01e79c3..283ac91 100644
--- a/Random Crap	
+++ b/Random Crap	
@@ -1,3 +1,5 @@
 1
+  whoa
 2
+  dude
 3

Jeff King· Dec 9, 2016, 05:37 UTC · re: unixway.drive@gmail.com · lore

Re: [BUG] regarding `git add -p` and files containing wildcard characters

On Fri, Dec 09, 2016 at 04:46:49AM +0300, unixway.drive@gmail.com wrote:

> The problem is that `git-diff-files` does some globbing on the 'path'
> arguments on its own and has no option to disable that (and
> `git-add--interactive`'s `run_cmd_pipe` already handles all other sorts of
> unsafe characters like spaces and backticks well).

I think the option you're looking for is:

  git --literal-pathspecs diff-files ... -- 'Random *'

I don't know if there are other commands run by add--interactive that would want the same treatment. It might actually make sense to set GIT_LITERAL_PATHSPECS=1 in the environment right after it expands the list via ls-files.

Show 15 quoted lines

> diff --git a/git-add--interactive.perl b/git-add--interactive.perl
> index ee3d812..358d877 100755
> --- a/git-add--interactive.perl
> +++ b/git-add--interactive.perl
> @@ -2,3 +2,3 @@
> 
> -use 5.008;
> +use 5.014;
>  use strict;
> @@ -761,3 +761,5 @@ sub parse_diff {
>         }
> -       my @diff = run_cmd_pipe("git", @diff_cmd, "--", $path);
> +       my @diff = run_cmd_pipe("git", @diff_cmd, "--", (
> +               $path =~ s#[\[*?]#\\$&#gr
> +       ));

This callsite covers "-p". It looks like list_modified() probably needs similar treatment. Maybe others; I didn't look exhaustively.

-Peff