]>
Commit | Line | Data |
---|---|---|
7e0abcec | 1 | #!/usr/bin/perl |
f47f1e2c | 2 | # Copyright (c) 2009, 2010 David Aguilar |
7e0abcec | 3 | # Copyright (c) 2012 Tim Henigan |
5c38ea31 DA |
4 | # |
5 | # This is a wrapper around the GIT_EXTERNAL_DIFF-compatible | |
a904392e DA |
6 | # git-difftool--helper script. |
7 | # | |
8 | # This script exports GIT_EXTERNAL_DIFF and GIT_PAGER for use by git. | |
7e0abcec | 9 | # The GIT_DIFF* variables are exported for use by git-difftool--helper. |
a904392e | 10 | # |
5c38ea31 DA |
11 | # Any arguments that are unknown to this script are forwarded to 'git diff'. |
12 | ||
d48b2841 | 13 | use 5.008; |
5c38ea31 DA |
14 | use strict; |
15 | use warnings; | |
35989c68 | 16 | use File::Basename qw(basename dirname); |
7e0abcec | 17 | use File::Copy; |
05df5326 | 18 | use File::Compare; |
7e0abcec TH |
19 | use File::stat; |
20 | use File::Path qw(mkpath); | |
21 | use File::Temp qw(tempdir); | |
3f94ff75 TH |
22 | use Getopt::Long qw(:config pass_through); |
23 | use Git; | |
5c38ea31 DA |
24 | |
25 | sub usage | |
26 | { | |
28360769 | 27 | my $exitcode = shift; |
5c38ea31 | 28 | print << 'USAGE'; |
bf73fc21 | 29 | usage: git difftool [-t|--tool=<tool>] [--tool-help] |
85089604 TH |
30 | [-x|--extcmd=<cmd>] |
31 | [-g|--gui] [--no-gui] | |
3f94ff75 | 32 | [--prompt] [-y|--no-prompt] |
7e0abcec | 33 | [-d|--dir-diff] |
f47f1e2c | 34 | ['git diff' options] |
5c38ea31 | 35 | USAGE |
28360769 | 36 | exit($exitcode); |
5c38ea31 DA |
37 | } |
38 | ||
7e0abcec TH |
39 | sub find_worktree |
40 | { | |
75cd7583 DA |
41 | my ($repo) = @_; |
42 | ||
7e0abcec TH |
43 | # Git->repository->wc_path() does not honor changes to the working |
44 | # tree location made by $ENV{GIT_WORK_TREE} or the 'core.worktree' | |
45 | # config variable. | |
46 | my $worktree; | |
47 | my $env_worktree = $ENV{GIT_WORK_TREE}; | |
48 | my $core_worktree = Git::config('core.worktree'); | |
49 | ||
50 | if (defined($env_worktree) and (length($env_worktree) > 0)) { | |
51 | $worktree = $env_worktree; | |
52 | } elsif (defined($core_worktree) and (length($core_worktree) > 0)) { | |
53 | $worktree = $core_worktree; | |
54 | } else { | |
55 | $worktree = $repo->wc_path(); | |
56 | } | |
57 | ||
58 | return $worktree; | |
59 | } | |
60 | ||
bf73fc21 TH |
61 | sub print_tool_help |
62 | { | |
63 | my ($cmd, @found, @notfound); | |
64 | my $gitpath = Git::exec_path(); | |
65 | ||
35989c68 DA |
66 | my @files = map { basename($_) } glob("$gitpath/mergetools/*"); |
67 | my @tools = sort(grep { !m{^defaults$} } @files); | |
bf73fc21 TH |
68 | |
69 | foreach my $tool (@tools) { | |
70 | $cmd = "TOOL_MODE=diff"; | |
71 | $cmd .= ' && . "$(git --exec-path)/git-mergetool--lib"'; | |
72 | $cmd .= " && get_merge_tool_path $tool >/dev/null 2>&1"; | |
73 | $cmd .= " && can_diff >/dev/null 2>&1"; | |
74 | if (system('sh', '-c', $cmd) == 0) { | |
75 | push(@found, $tool); | |
76 | } else { | |
77 | push(@notfound, $tool); | |
78 | } | |
79 | } | |
80 | ||
81 | print "'git difftool --tool=<tool>' may be set to one of the following:\n"; | |
35989c68 | 82 | print "\t$_\n" for (@found); |
bf73fc21 TH |
83 | |
84 | print "\nThe following tools are valid, but not currently available:\n"; | |
35989c68 | 85 | print "\t$_\n" for (@notfound); |
bf73fc21 TH |
86 | |
87 | print "\nNOTE: Some of the tools listed above only work in a windowed\n"; | |
88 | print "environment. If run in a terminal-only session, they will fail.\n"; | |
89 | ||
90 | exit(0); | |
91 | } | |
92 | ||
7e0abcec TH |
93 | sub setup_dir_diff |
94 | { | |
75cd7583 DA |
95 | my ($repo, $workdir) = @_; |
96 | ||
7e0abcec TH |
97 | # Run the diff; exit immediately if no diff found |
98 | # 'Repository' and 'WorkingCopy' must be explicitly set to insure that | |
99 | # if $GIT_DIR and $GIT_WORK_TREE are set in ENV, they are actually used | |
100 | # by Git->repository->command*. | |
75cd7583 | 101 | my $repo_path = $repo->repo_path(); |
7e0abcec TH |
102 | my $diffrepo = Git->repository(Repository => $repo_path, WorkingCopy => $workdir); |
103 | my $diffrtn = $diffrepo->command_oneline('diff', '--raw', '--no-abbrev', '-z', @ARGV); | |
104 | exit(0) if (length($diffrtn) == 0); | |
105 | ||
106 | # Setup temp directories | |
b965e8f4 | 107 | my $tmpdir = tempdir('git-difftool.XXXXX', CLEANUP => 1, TMPDIR => 1); |
7e0abcec TH |
108 | my $ldir = "$tmpdir/left"; |
109 | my $rdir = "$tmpdir/right"; | |
110 | mkpath($ldir) or die $!; | |
111 | mkpath($rdir) or die $!; | |
112 | ||
113 | # Build index info for left and right sides of the diff | |
114 | my $submodule_mode = '160000'; | |
115 | my $symlink_mode = '120000'; | |
116 | my $null_mode = '0' x 6; | |
117 | my $null_sha1 = '0' x 40; | |
118 | my $lindex = ''; | |
119 | my $rindex = ''; | |
120 | my %submodule; | |
121 | my %symlink; | |
75cd7583 | 122 | my @working_tree = (); |
7e0abcec TH |
123 | my @rawdiff = split('\0', $diffrtn); |
124 | ||
125 | my $i = 0; | |
126 | while ($i < $#rawdiff) { | |
127 | if ($rawdiff[$i] =~ /^::/) { | |
128 | print "Combined diff formats ('-c' and '--cc') are not supported in directory diff mode.\n"; | |
129 | exit(1); | |
130 | } | |
131 | ||
132 | my ($lmode, $rmode, $lsha1, $rsha1, $status) = split(' ', substr($rawdiff[$i], 1)); | |
133 | my $src_path = $rawdiff[$i + 1]; | |
134 | my $dst_path; | |
135 | ||
136 | if ($status =~ /^[CR]/) { | |
137 | $dst_path = $rawdiff[$i + 2]; | |
138 | $i += 3; | |
139 | } else { | |
140 | $dst_path = $src_path; | |
141 | $i += 2; | |
142 | } | |
143 | ||
144 | if (($lmode eq $submodule_mode) or ($rmode eq $submodule_mode)) { | |
145 | $submodule{$src_path}{left} = $lsha1; | |
146 | if ($lsha1 ne $rsha1) { | |
147 | $submodule{$dst_path}{right} = $rsha1; | |
148 | } else { | |
149 | $submodule{$dst_path}{right} = "$rsha1-dirty"; | |
150 | } | |
151 | next; | |
152 | } | |
153 | ||
154 | if ($lmode eq $symlink_mode) { | |
155 | $symlink{$src_path}{left} = $diffrepo->command_oneline('show', "$lsha1"); | |
156 | } | |
157 | ||
158 | if ($rmode eq $symlink_mode) { | |
159 | $symlink{$dst_path}{right} = $diffrepo->command_oneline('show', "$rsha1"); | |
160 | } | |
161 | ||
162 | if (($lmode ne $null_mode) and ($status !~ /^C/)) { | |
163 | $lindex .= "$lmode $lsha1\t$src_path\0"; | |
164 | } | |
165 | ||
166 | if ($rmode ne $null_mode) { | |
167 | if ($rsha1 ne $null_sha1) { | |
168 | $rindex .= "$rmode $rsha1\t$dst_path\0"; | |
169 | } else { | |
170 | push(@working_tree, $dst_path); | |
171 | } | |
172 | } | |
173 | } | |
174 | ||
175 | # If $GIT_DIR is not set prior to calling 'git update-index' and | |
176 | # 'git checkout-index', then those commands will fail if difftool | |
177 | # is called from a directory other than the repo root. | |
178 | my $must_unset_git_dir = 0; | |
179 | if (not defined($ENV{GIT_DIR})) { | |
180 | $must_unset_git_dir = 1; | |
181 | $ENV{GIT_DIR} = $repo_path; | |
182 | } | |
183 | ||
184 | # Populate the left and right directories based on each index file | |
185 | my ($inpipe, $ctx); | |
186 | $ENV{GIT_INDEX_FILE} = "$tmpdir/lindex"; | |
187 | ($inpipe, $ctx) = $repo->command_input_pipe(qw/update-index -z --index-info/); | |
188 | print($inpipe $lindex); | |
189 | $repo->command_close_pipe($inpipe, $ctx); | |
75cd7583 | 190 | my $rc = system('git', 'checkout-index', '--all', "--prefix=$ldir/"); |
7e0abcec TH |
191 | exit($rc | ($rc >> 8)) if ($rc != 0); |
192 | ||
193 | $ENV{GIT_INDEX_FILE} = "$tmpdir/rindex"; | |
194 | ($inpipe, $ctx) = $repo->command_input_pipe(qw/update-index -z --index-info/); | |
195 | print($inpipe $rindex); | |
196 | $repo->command_close_pipe($inpipe, $ctx); | |
197 | $rc = system('git', 'checkout-index', '--all', "--prefix=$rdir/"); | |
198 | exit($rc | ($rc >> 8)) if ($rc != 0); | |
199 | ||
200 | # If $GIT_DIR was explicitly set just for the update/checkout | |
201 | # commands, then it should be unset before continuing. | |
202 | delete($ENV{GIT_DIR}) if ($must_unset_git_dir); | |
203 | delete($ENV{GIT_INDEX_FILE}); | |
204 | ||
205 | # Changes in the working tree need special treatment since they are | |
206 | # not part of the index | |
207 | for my $file (@working_tree) { | |
208 | my $dir = dirname($file); | |
209 | unless (-d "$rdir/$dir") { | |
210 | mkpath("$rdir/$dir") or die $!; | |
211 | } | |
212 | copy("$workdir/$file", "$rdir/$file") or die $!; | |
213 | chmod(stat("$workdir/$file")->mode, "$rdir/$file") or die $!; | |
214 | } | |
215 | ||
216 | # Changes to submodules require special treatment. This loop writes a | |
217 | # temporary file to both the left and right directories to show the | |
218 | # change in the recorded SHA1 for the submodule. | |
219 | for my $path (keys %submodule) { | |
220 | if (defined($submodule{$path}{left})) { | |
221 | write_to_file("$ldir/$path", "Subproject commit $submodule{$path}{left}"); | |
222 | } | |
223 | if (defined($submodule{$path}{right})) { | |
224 | write_to_file("$rdir/$path", "Subproject commit $submodule{$path}{right}"); | |
225 | } | |
226 | } | |
227 | ||
228 | # Symbolic links require special treatment. The standard "git diff" | |
229 | # shows only the link itself, not the contents of the link target. | |
230 | # This loop replicates that behavior. | |
231 | for my $path (keys %symlink) { | |
232 | if (defined($symlink{$path}{left})) { | |
233 | write_to_file("$ldir/$path", $symlink{$path}{left}); | |
234 | } | |
235 | if (defined($symlink{$path}{right})) { | |
236 | write_to_file("$rdir/$path", $symlink{$path}{right}); | |
237 | } | |
238 | } | |
239 | ||
75cd7583 | 240 | return ($ldir, $rdir, @working_tree); |
7e0abcec TH |
241 | } |
242 | ||
243 | sub write_to_file | |
244 | { | |
245 | my $path = shift; | |
246 | my $value = shift; | |
247 | ||
248 | # Make sure the path to the file exists | |
249 | my $dir = dirname($path); | |
250 | unless (-d "$dir") { | |
251 | mkpath("$dir") or die $!; | |
252 | } | |
253 | ||
254 | # If the file already exists in that location, delete it. This | |
255 | # is required in the case of symbolic links. | |
256 | unlink("$path"); | |
257 | ||
258 | open(my $fh, '>', "$path") or die $!; | |
259 | print($fh $value); | |
260 | close($fh); | |
261 | } | |
262 | ||
75cd7583 DA |
263 | sub main |
264 | { | |
265 | # parse command-line options. all unrecognized options and arguments | |
266 | # are passed through to the 'git diff' command. | |
c9bdd505 DA |
267 | my %opts = ( |
268 | difftool_cmd => undef, | |
269 | dirdiff => undef, | |
270 | extcmd => undef, | |
271 | gui => undef, | |
272 | help => undef, | |
273 | prompt => undef, | |
274 | tool_help => undef, | |
275 | ); | |
276 | GetOptions('g|gui!' => \$opts{gui}, | |
277 | 'd|dir-diff' => \$opts{dirdiff}, | |
278 | 'h' => \$opts{help}, | |
279 | 'prompt!' => \$opts{prompt}, | |
280 | 'y' => sub { $opts{prompt} = 0; }, | |
281 | 't|tool:s' => \$opts{difftool_cmd}, | |
282 | 'tool-help' => \$opts{tool_help}, | |
283 | 'x|extcmd:s' => \$opts{extcmd}); | |
284 | ||
285 | if (defined($opts{help})) { | |
75cd7583 | 286 | usage(0); |
5c38ea31 | 287 | } |
c9bdd505 | 288 | if (defined($opts{tool_help})) { |
75cd7583 | 289 | print_tool_help(); |
3f94ff75 | 290 | } |
c9bdd505 DA |
291 | if (defined($opts{difftool_cmd})) { |
292 | if (length($opts{difftool_cmd}) > 0) { | |
293 | $ENV{GIT_DIFF_TOOL} = $opts{difftool_cmd}; | |
75cd7583 DA |
294 | } else { |
295 | print "No <tool> given for --tool=<tool>\n"; | |
296 | usage(1); | |
297 | } | |
298 | } | |
c9bdd505 DA |
299 | if (defined($opts{extcmd})) { |
300 | if (length($opts{extcmd}) > 0) { | |
301 | $ENV{GIT_DIFFTOOL_EXTCMD} = $opts{extcmd}; | |
75cd7583 DA |
302 | } else { |
303 | print "No <cmd> given for --extcmd=<cmd>\n"; | |
304 | usage(1); | |
305 | } | |
306 | } | |
c9bdd505 DA |
307 | if ($opts{gui}) { |
308 | my $guitool = Git::config('diff.guitool'); | |
75cd7583 DA |
309 | if (length($guitool) > 0) { |
310 | $ENV{GIT_DIFF_TOOL} = $guitool; | |
311 | } | |
312 | } | |
313 | ||
314 | # In directory diff mode, 'git-difftool--helper' is called once | |
315 | # to compare the a/b directories. In file diff mode, 'git diff' | |
316 | # will invoke a separate instance of 'git-difftool--helper' for | |
317 | # each file that changed. | |
c9bdd505 DA |
318 | if (defined($opts{dirdiff})) { |
319 | dir_diff($opts{extcmd}); | |
75cd7583 | 320 | } else { |
c9bdd505 | 321 | file_diff($opts{prompt}); |
3f94ff75 TH |
322 | } |
323 | } | |
7e0abcec | 324 | |
75cd7583 DA |
325 | sub dir_diff |
326 | { | |
327 | my ($extcmd) = @_; | |
328 | ||
329 | my $rc; | |
330 | my $repo = Git->repository(); | |
331 | ||
332 | my $workdir = find_worktree($repo); | |
333 | my ($a, $b, @working_tree) = setup_dir_diff($repo, $workdir); | |
7e0abcec TH |
334 | if (defined($extcmd)) { |
335 | $rc = system($extcmd, $a, $b); | |
3f94ff75 | 336 | } else { |
7e0abcec TH |
337 | $ENV{GIT_DIFFTOOL_DIRDIFF} = 'true'; |
338 | $rc = system('git', 'difftool--helper', $a, $b); | |
d531174f | 339 | } |
5c38ea31 | 340 | |
7e0abcec TH |
341 | exit($rc | ($rc >> 8)) if ($rc != 0); |
342 | ||
343 | # If the diff including working copy files and those | |
344 | # files were modified during the diff, then the changes | |
345 | # should be copied back to the working tree | |
346 | for my $file (@working_tree) { | |
05df5326 TH |
347 | if (-e "$b/$file" && compare("$b/$file", "$workdir/$file")) { |
348 | copy("$b/$file", "$workdir/$file") or die $!; | |
349 | chmod(stat("$b/$file")->mode, "$workdir/$file") or die $!; | |
350 | } | |
7e0abcec | 351 | } |
75cd7583 DA |
352 | } |
353 | ||
354 | sub file_diff | |
355 | { | |
356 | my ($prompt) = @_; | |
357 | ||
7e0abcec TH |
358 | if (defined($prompt)) { |
359 | if ($prompt) { | |
360 | $ENV{GIT_DIFFTOOL_PROMPT} = 'true'; | |
361 | } else { | |
362 | $ENV{GIT_DIFFTOOL_NO_PROMPT} = 'true'; | |
363 | } | |
364 | } | |
365 | ||
366 | $ENV{GIT_PAGER} = ''; | |
367 | $ENV{GIT_EXTERNAL_DIFF} = 'git-difftool--helper'; | |
368 | ||
369 | # ActiveState Perl for Win32 does not implement POSIX semantics of | |
370 | # exec* system call. It just spawns the given executable and finishes | |
371 | # the starting program, exiting with code 0. | |
372 | # system will at least catch the errors returned by git diff, | |
373 | # allowing the caller of git difftool better handling of failures. | |
374 | my $rc = system('git', 'diff', @ARGV); | |
375 | exit($rc | ($rc >> 8)); | |
376 | } | |
75cd7583 DA |
377 | |
378 | main(); |