2 # Copyright (c) 2009, 2010 David Aguilar
3 # Copyright (c) 2012 Tim Henigan
5 # This is a wrapper around the GIT_EXTERNAL_DIFF-compatible
6 # git-difftool--helper script.
8 # This script exports GIT_EXTERNAL_DIFF and GIT_PAGER for use by git.
9 # The GIT_DIFF* variables are exported for use by git-difftool--helper.
11 # Any arguments that are unknown to this script are forwarded to 'git diff'.
16 use File
::Basename
qw(dirname);
21 use File
::Path
qw(mkpath);
22 use File
::Temp
qw(tempdir);
23 use Getopt
::Long
qw(:config pass_through);
30 usage
: git difftool
[-t
|--tool
=<tool
>] [--tool
-help
]
33 [--prompt
] [-y
|--no-prompt
]
44 # Git->repository->wc_path() does not honor changes to the working
45 # tree location made by $ENV{GIT_WORK_TREE} or the 'core.worktree'
48 my $env_worktree = $ENV{GIT_WORK_TREE
};
49 my $core_worktree = Git
::config
('core.worktree');
51 if (defined($env_worktree) and (length($env_worktree) > 0)) {
52 $worktree = $env_worktree;
53 } elsif (defined($core_worktree) and (length($core_worktree) > 0)) {
54 $worktree = $core_worktree;
56 $worktree = $repo->wc_path();
62 sub filter_tool_scripts
67 # Ignore files in subdirectories
68 $File::Find
::prune
= 1;
71 if ((-f
$_) && ($_ ne "defaults")) {
79 my ($cmd, @found, @notfound, @tools);
80 my $gitpath = Git
::exec_path
();
82 find
(sub { filter_tool_scripts
(\
@tools) }, "$gitpath/mergetools");
84 foreach my $tool (@tools) {
85 $cmd = "TOOL_MODE=diff";
86 $cmd .= ' && . "$(git --exec-path)/git-mergetool--lib"';
87 $cmd .= " && get_merge_tool_path $tool >/dev/null 2>&1";
88 $cmd .= " && can_diff >/dev/null 2>&1";
89 if (system('sh', '-c', $cmd) == 0) {
92 push(@notfound, $tool);
96 print "'git difftool --tool=<tool>' may be set to one of the following:\n";
97 print "\t$_\n" for (sort(@found));
99 print "\nThe following tools are valid, but not currently available:\n";
100 print "\t$_\n" for (sort(@notfound));
102 print "\nNOTE: Some of the tools listed above only work in a windowed\n";
103 print "environment. If run in a terminal-only session, they will fail.\n";
110 my ($repo, $workdir, $symlinks) = @_;
112 # Run the diff; exit immediately if no diff found
113 # 'Repository' and 'WorkingCopy' must be explicitly set to insure that
114 # if $GIT_DIR and $GIT_WORK_TREE are set in ENV, they are actually used
115 # by Git->repository->command*.
116 my $repo_path = $repo->repo_path();
117 my $diffrepo = Git
->repository(Repository
=> $repo_path, WorkingCopy
=> $workdir);
118 my $diffrtn = $diffrepo->command_oneline('diff', '--raw', '--no-abbrev', '-z', @ARGV);
119 exit(0) if (length($diffrtn) == 0);
121 # Setup temp directories
122 my $tmpdir = tempdir
('git-difftool.XXXXX', CLEANUP
=> 1, TMPDIR
=> 1);
123 my $ldir = "$tmpdir/left";
124 my $rdir = "$tmpdir/right";
125 mkpath
($ldir) or die $!;
126 mkpath
($rdir) or die $!;
128 # Build index info for left and right sides of the diff
129 my $submodule_mode = '160000';
130 my $symlink_mode = '120000';
131 my $null_mode = '0' x
6;
132 my $null_sha1 = '0' x
40;
137 my @working_tree = ();
138 my @rawdiff = split('\0', $diffrtn);
141 while ($i < $#rawdiff) {
142 if ($rawdiff[$i] =~ /^::/) {
143 print "Combined diff formats ('-c' and '--cc') are not supported in directory diff mode.\n";
147 my ($lmode, $rmode, $lsha1, $rsha1, $status) = split(' ', substr($rawdiff[$i], 1));
148 my $src_path = $rawdiff[$i + 1];
151 if ($status =~ /^[CR]/) {
152 $dst_path = $rawdiff[$i + 2];
155 $dst_path = $src_path;
159 if (($lmode eq $submodule_mode) or ($rmode eq $submodule_mode)) {
160 $submodule{$src_path}{left
} = $lsha1;
161 if ($lsha1 ne $rsha1) {
162 $submodule{$dst_path}{right
} = $rsha1;
164 $submodule{$dst_path}{right
} = "$rsha1-dirty";
169 if ($lmode eq $symlink_mode) {
170 $symlink{$src_path}{left
} = $diffrepo->command_oneline('show', "$lsha1");
173 if ($rmode eq $symlink_mode) {
174 $symlink{$dst_path}{right
} = $diffrepo->command_oneline('show', "$rsha1");
177 if (($lmode ne $null_mode) and ($status !~ /^C/)) {
178 $lindex .= "$lmode $lsha1\t$src_path\0";
181 if ($rmode ne $null_mode) {
182 if ($rsha1 ne $null_sha1) {
183 $rindex .= "$rmode $rsha1\t$dst_path\0";
185 push(@working_tree, $dst_path);
190 # If $GIT_DIR is not set prior to calling 'git update-index' and
191 # 'git checkout-index', then those commands will fail if difftool
192 # is called from a directory other than the repo root.
193 my $must_unset_git_dir = 0;
194 if (not defined($ENV{GIT_DIR
})) {
195 $must_unset_git_dir = 1;
196 $ENV{GIT_DIR
} = $repo_path;
199 # Populate the left and right directories based on each index file
201 $ENV{GIT_INDEX_FILE
} = "$tmpdir/lindex";
202 ($inpipe, $ctx) = $repo->command_input_pipe(qw
/update-index -z --index-info/);
203 print($inpipe $lindex);
204 $repo->command_close_pipe($inpipe, $ctx);
205 my $rc = system('git', 'checkout-index', '--all', "--prefix=$ldir/");
206 exit($rc | ($rc >> 8)) if ($rc != 0);
208 $ENV{GIT_INDEX_FILE
} = "$tmpdir/rindex";
209 ($inpipe, $ctx) = $repo->command_input_pipe(qw
/update-index -z --index-info/);
210 print($inpipe $rindex);
211 $repo->command_close_pipe($inpipe, $ctx);
212 $rc = system('git', 'checkout-index', '--all', "--prefix=$rdir/");
213 exit($rc | ($rc >> 8)) if ($rc != 0);
215 # If $GIT_DIR was explicitly set just for the update/checkout
216 # commands, then it should be unset before continuing.
217 delete($ENV{GIT_DIR
}) if ($must_unset_git_dir);
218 delete($ENV{GIT_INDEX_FILE
});
220 # Changes in the working tree need special treatment since they are
221 # not part of the index
222 for my $file (@working_tree) {
223 my $dir = dirname
($file);
224 unless (-d
"$rdir/$dir") {
225 mkpath
("$rdir/$dir") or die $!;
228 symlink("$workdir/$file", "$rdir/$file") or die $!;
230 copy
("$workdir/$file", "$rdir/$file") or die $!;
231 my $mode = stat("$workdir/$file")->mode;
232 chmod($mode, "$rdir/$file") or die $!;
236 # Changes to submodules require special treatment. This loop writes a
237 # temporary file to both the left and right directories to show the
238 # change in the recorded SHA1 for the submodule.
239 for my $path (keys %submodule) {
240 if (defined($submodule{$path}{left
})) {
241 write_to_file
("$ldir/$path", "Subproject commit $submodule{$path}{left}");
243 if (defined($submodule{$path}{right
})) {
244 write_to_file
("$rdir/$path", "Subproject commit $submodule{$path}{right}");
248 # Symbolic links require special treatment. The standard "git diff"
249 # shows only the link itself, not the contents of the link target.
250 # This loop replicates that behavior.
251 for my $path (keys %symlink) {
252 if (defined($symlink{$path}{left
})) {
253 write_to_file
("$ldir/$path", $symlink{$path}{left
});
255 if (defined($symlink{$path}{right
})) {
256 write_to_file
("$rdir/$path", $symlink{$path}{right
});
260 return ($ldir, $rdir, @working_tree);
268 # Make sure the path to the file exists
269 my $dir = dirname
($path);
271 mkpath
("$dir") or die $!;
274 # If the file already exists in that location, delete it. This
275 # is required in the case of symbolic links.
278 open(my $fh, '>', "$path") or die $!;
285 # parse command-line options. all unrecognized options and arguments
286 # are passed through to the 'git diff' command.
288 difftool_cmd
=> undef,
294 symlinks
=> $^O
ne 'MSWin32' && $^O
ne 'msys',
297 GetOptions
('g|gui!' => \
$opts{gui
},
298 'd|dir-diff' => \
$opts{dirdiff
},
300 'prompt!' => \
$opts{prompt
},
301 'y' => sub { $opts{prompt
} = 0; },
302 'symlinks' => \
$opts{symlinks
},
303 'no-symlinks' => sub { $opts{symlinks
} = 0; },
304 't|tool:s' => \
$opts{difftool_cmd
},
305 'tool-help' => \
$opts{tool_help
},
306 'x|extcmd:s' => \
$opts{extcmd
});
308 if (defined($opts{help
})) {
311 if (defined($opts{tool_help
})) {
314 if (defined($opts{difftool_cmd
})) {
315 if (length($opts{difftool_cmd
}) > 0) {
316 $ENV{GIT_DIFF_TOOL
} = $opts{difftool_cmd
};
318 print "No <tool> given for --tool=<tool>\n";
322 if (defined($opts{extcmd
})) {
323 if (length($opts{extcmd
}) > 0) {
324 $ENV{GIT_DIFFTOOL_EXTCMD
} = $opts{extcmd
};
326 print "No <cmd> given for --extcmd=<cmd>\n";
331 my $guitool = Git
::config
('diff.guitool');
332 if (length($guitool) > 0) {
333 $ENV{GIT_DIFF_TOOL
} = $guitool;
337 # In directory diff mode, 'git-difftool--helper' is called once
338 # to compare the a/b directories. In file diff mode, 'git diff'
339 # will invoke a separate instance of 'git-difftool--helper' for
340 # each file that changed.
341 if (defined($opts{dirdiff
})) {
342 dir_diff
($opts{extcmd
}, $opts{symlinks
});
344 file_diff
($opts{prompt
});
350 my ($extcmd, $symlinks) = @_;
353 my $repo = Git
->repository();
355 my $workdir = find_worktree
($repo);
356 my ($a, $b, @worktree) = setup_dir_diff
($repo, $workdir, $symlinks);
357 if (defined($extcmd)) {
358 $rc = system($extcmd, $a, $b);
360 $ENV{GIT_DIFFTOOL_DIRDIFF
} = 'true';
361 $rc = system('git', 'difftool--helper', $a, $b);
364 exit($rc | ($rc >> 8)) if ($rc != 0);
366 # If the diff including working copy files and those
367 # files were modified during the diff, then the changes
368 # should be copied back to the working tree.
369 # Do not copy back files when symlinks are used and the
370 # external tool did not replace the original link with a file.
371 for my $file (@worktree) {
372 next if $symlinks && -l
"$b/$file";
373 next if ! -f
"$b/$file";
375 my $diff = compare
("$b/$file", "$workdir/$file");
378 } elsif ($diff == -1) {
379 my $errmsg = "warning: Could not compare ";
380 $errmsg += "'$b/$file' with '$workdir/$file'\n";
382 } elsif ($diff == 1) {
383 copy
("$b/$file", "$workdir/$file") or die $!;
384 my $mode = stat("$b/$file")->mode;
385 chmod($mode, "$workdir/$file") or die $!;
395 if (defined($prompt)) {
397 $ENV{GIT_DIFFTOOL_PROMPT
} = 'true';
399 $ENV{GIT_DIFFTOOL_NO_PROMPT
} = 'true';
403 $ENV{GIT_PAGER
} = '';
404 $ENV{GIT_EXTERNAL_DIFF
} = 'git-difftool--helper';
406 # ActiveState Perl for Win32 does not implement POSIX semantics of
407 # exec* system call. It just spawns the given executable and finishes
408 # the starting program, exiting with code 0.
409 # system will at least catch the errors returned by git diff,
410 # allowing the caller of git difftool better handling of failures.
411 my $rc = system('git', 'diff', @ARGV);
412 exit($rc | ($rc >> 8));