3 # Copyright (C) 2005, 2006, 2007 Apple Inc. All rights reserved.
4 # Copyright (C) 2009 Cameron McCormack <cam@mcc.id.au>
5 # Copyright (C) 2010 Chris Jerdonek (chris.jerdonek@gmail.com)
7 # Redistribution and use in source and binary forms, with or without
8 # modification, are permitted provided that the following conditions
11 # 1. Redistributions of source code must retain the above copyright
12 # notice, this list of conditions and the following disclaimer.
13 # 2. Redistributions in binary form must reproduce the above copyright
14 # notice, this list of conditions and the following disclaimer in the
15 # documentation and/or other materials provided with the distribution.
16 # 3. Neither the name of Apple Computer, Inc. ("Apple") nor the names of
17 # its contributors may be used to endorse or promote products derived
18 # from this software without specific prior written permission.
20 # THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND ANY
21 # EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
22 # WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
23 # DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR ANY
24 # DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
25 # (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
26 # LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
27 # ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
28 # (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
29 # THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31 # "patch" script for WebKit Open Source Project, used to apply patches.
33 # Differences from invoking "patch -p0":
35 # Handles added files (does a svn add with logic to handle local changes).
36 # Handles added directories (does a svn add).
37 # Handles removed files (does a svn rm with logic to handle local changes).
38 # Handles removed directories--those with no more files or directories left in them
40 # Has mode where it will roll back to svn version numbers in the patch file so svn
41 # can do a 3-way merge.
42 # Paths from Index: lines are used rather than the paths on the patch lines, which
43 # makes patches generated by "cvs diff" work (increasingly unimportant since we
44 # use Subversion now).
45 # ChangeLog patches use --fuzz=3 to prevent rejects.
46 # Handles binary files (requires patches made by svn-create-patch).
47 # Handles copied and moved files (requires patches made by svn-create-patch).
48 # Handles git-diff patches (without binary changes) created at the top-level directory
52 # Handle property changes.
53 # Handle copied and moved directories (would require patches made by svn-create-patch).
54 # When doing a removal, check that old file matches what's being removed.
55 # Notice a patch that's being applied at the "wrong level" and make it work anyway.
56 # Do a dry run on the whole patch and don't do anything if part of the patch is
57 # going to fail (probably too strict unless we exclude ChangeLog).
58 # Handle git-diff patches with binary delta
68 use POSIX qw(strftime);
71 use lib $FindBin::Bin;
74 sub addDirectoriesIfNeeded($);
77 sub handleBinaryChange($$);
78 sub handleGitBinaryChange($$);
79 sub isDirectoryEmptyForRemoval($);
81 sub removeDirectoriesIfNeeded();
83 # These should be replaced by an scm class/module:
84 sub scmKnowsOfFile($);
94 my $optionParseSuccess = GetOptions(
96 "help!" => \$showHelp,
97 "reviewer=s" => \$reviewer,
101 if (!$optionParseSuccess || $showHelp) {
102 print STDERR basename($0) . " [-h|--help] [--force] [-m|--merge] [-r|--reviewer name] patch1 [patch2 ...]\n";
106 my %removeDirectoryIgnoreList = (
114 my $epochTime = time(); # This is used to set the date in ChangeLog files.
115 my $globalExitStatus = 0;
117 my $repositoryRootPath = determineVCSRoot();
119 my %checkedDirectories;
121 # Need to use a typeglob to pass the file handle as a parameter,
122 # otherwise get a bareword error.
123 my @diffHashRefs = parsePatch(*ARGV);
125 print "Parsed " . @diffHashRefs . " diffs from patch file(s).\n";
127 my $preparedPatchHash = prepareParsedPatch($force, @diffHashRefs);
129 my @copyDiffHashRefs = @{$preparedPatchHash->{copyDiffHashRefs}};
130 my @nonCopyDiffHashRefs = @{$preparedPatchHash->{nonCopyDiffHashRefs}};
131 my %sourceRevisions = %{$preparedPatchHash->{sourceRevisionHash}};
134 die "--merge is currently only supported for SVN" unless isSVN();
135 # How do we handle Git patches applied to an SVN checkout here?
136 for my $file (sort keys %sourceRevisions) {
137 my $version = $sourceRevisions{$file};
138 print "Getting version $version of $file\n";
139 system("svn", "update", "-r", $version, $file) == 0 or die "Failed to run svn update -r $version $file.";
143 # Handle copied and moved files first since moved files may have their
144 # source deleted before the move.
145 for my $copyDiffHashRef (@copyDiffHashRefs) {
146 my $indexPath = $copyDiffHashRef->{indexPath};
147 my $copiedFromPath = $copyDiffHashRef->{copiedFromPath};
149 addDirectoriesIfNeeded(dirname($indexPath));
150 scmCopy($copiedFromPath, $indexPath);
153 for my $diffHashRef (@nonCopyDiffHashRefs) {
157 removeDirectoriesIfNeeded();
159 exit $globalExitStatus;
161 sub addDirectoriesIfNeeded($)
164 my @dirs = File::Spec->splitdir($path);
166 while (scalar @dirs) {
167 $dir = File::Spec->catdir($dir, shift @dirs);
168 next if exists $checkedDirectories{$dir};
170 mkdir $dir or die "Failed to create required directory '$dir' for path '$path'\n";
172 $checkedDirectories{$dir} = 1;
175 # SVN prints "svn: warning: 'directory' is already under version control"
176 # if you try and add a directory which is already in the repository.
177 # Git will ignore the add, but re-adding large directories can be sloooow.
178 # So we check first to see if the directory is under version control first.
179 if (!scmKnowsOfFile($dir)) {
182 $checkedDirectories{$dir} = 1;
185 die "'$dir' exists, but is not a directory";
191 # $patch: a patch string.
192 # $pathRelativeToRoot: the path of the file to be patched, relative to the
193 # repository root. This should normally be the path
194 # found in the patch's "Index:" line.
195 # $options: a reference to an array of options to pass to the patch command.
198 my ($patch, $pathRelativeToRoot, $options) = @_;
200 my $optionalArgs = {options => $options, ensureForce => $force};
202 my $exitStatus = runPatchCommand($patch, $repositoryRootPath, $pathRelativeToRoot, $optionalArgs);
205 $globalExitStatus = $exitStatus;
212 open(FILE, $file) or die "Can't open '$file': $!";
214 my $checksum = Digest::MD5->new->addfile(*FILE)->hexdigest();
219 sub handleBinaryChange($$)
221 my ($fullPath, $contents) = @_;
222 # [A-Za-z0-9+/] is the class of allowed base64 characters.
223 # One or more lines, at most 76 characters in length.
224 # The last line is allowed to have up to two '=' characters at the end (to signify padding).
225 if ($contents =~ m#((\n[A-Za-z0-9+/]{76})*\n[A-Za-z0-9+/]{2,74}?[A-Za-z0-9+/=]{2}\n)#) {
226 # Addition or Modification
227 open FILE, ">", $fullPath or die "Failed to open $fullPath.";
228 print FILE decode_base64($1);
230 if (!scmKnowsOfFile($fullPath)) {
236 scmRemove($fullPath);
240 sub handleGitBinaryChange($$)
242 my ($fullPath, $diffHashRef) = @_;
244 my $contents = $diffHashRef->{svnConvertedText};
246 my ($binaryChunkType, $binaryChunk, $reverseBinaryChunkType, $reverseBinaryChunk) = decodeGitBinaryPatch($contents, $fullPath);
248 my $isFileAddition = $diffHashRef->{isNew};
249 my $isFileDeletion = $diffHashRef->{isDeletion};
251 my $originalContents = "";
252 if (open FILE, $fullPath) {
253 die "$fullPath already exists" if $isFileAddition;
255 $originalContents = join("", <FILE>);
259 if ($reverseBinaryChunkType eq "literal") {
260 die "Original content of $fullPath mismatches" if $originalContents ne $reverseBinaryChunk;
263 if ($isFileDeletion) {
264 scmRemove($fullPath);
266 # Addition or Modification
268 if ($binaryChunkType eq "delta") {
269 $out = applyGitBinaryPatchDelta($binaryChunk, $originalContents);
273 if ($reverseBinaryChunkType eq "delta") {
274 die "Original content of $fullPath mismatches" if $originalContents ne applyGitBinaryPatchDelta($reverseBinaryChunk, $out);
276 open FILE, ">", $fullPath or die "Failed to open $fullPath.";
279 if ($isFileAddition) {
285 sub isDirectoryEmptyForRemoval($)
288 return 1 unless -d $dir;
289 my $directoryIsEmpty = 1;
290 opendir DIR, $dir or die "Could not open '$dir' to list files: $?";
291 for (my $item = readdir DIR; $item && $directoryIsEmpty; $item = readdir DIR) {
292 next if exists $removeDirectoryIgnoreList{$item};
293 if (-d File::Spec->catdir($dir, $item)) {
294 $directoryIsEmpty = 0;
296 next if (scmWillDeleteFile(File::Spec->catdir($dir, $item)));
297 $directoryIsEmpty = 0;
301 return $directoryIsEmpty;
305 # $diffHashRef: a diff hash reference of the type returned by parsePatch().
308 my ($diffHashRef) = @_;
310 # Make sure $patch is initialized to some value. A deletion can have no
311 # svnConvertedText property in the case of a deletion resulting from a
313 my $patch = $diffHashRef->{svnConvertedText} || "";
315 my $fullPath = $diffHashRef->{indexPath};
316 my $isBinary = $diffHashRef->{isBinary};
317 my $isGit = $diffHashRef->{isGit};
318 my $hasTextChunks = $patch && $diffHashRef->{numTextChunks};
323 $addition = 1 if ($diffHashRef->{isNew} || $patch =~ /\n@@ -0,0 .* @@/);
324 $deletion = 1 if ($diffHashRef->{isDeletion} || $patch =~ /\n@@ .* \+0,0 @@/);
326 if (!$addition && !$deletion && !$isBinary && $hasTextChunks) {
327 # Standard patch, patch tool can handle this.
328 if (basename($fullPath) eq "ChangeLog") {
329 my $changeLogDotOrigExisted = -f "${fullPath}.orig";
330 my $changeLogHash = fixChangeLogPatch($patch);
331 my $newPatch = setChangeLogDateAndReviewer($changeLogHash->{patch}, $reviewer, $epochTime);
332 applyPatch($newPatch, $fullPath, ["--fuzz=3"]);
333 unlink("${fullPath}.orig") if (! $changeLogDotOrigExisted);
335 applyPatch($patch, $fullPath);
338 # Either a deletion, an addition or a binary change.
340 addDirectoriesIfNeeded(dirname($fullPath));
344 handleGitBinaryChange($fullPath, $diffHashRef);
346 handleBinaryChange($fullPath, $patch) if $patch;
348 } elsif ($deletion) {
349 applyPatch($patch, $fullPath, ["--force"]) if $patch;
350 scmRemove($fullPath);
351 } elsif ($addition) {
353 rename($fullPath, "$fullPath.orig") if -e $fullPath;
354 applyPatch($patch, $fullPath) if $patch;
355 unlink("$fullPath.orig") if -e "$fullPath.orig" && checksum($fullPath) eq checksum("$fullPath.orig");
358 system("svn", "stat", "$fullPath.orig") if isSVN() && -e "$fullPath.orig";
362 scmToggleExecutableBit($fullPath, $diffHashRef->{executableBitDelta}) if defined($diffHashRef->{executableBitDelta});
365 sub removeDirectoriesIfNeeded()
367 foreach my $dir (reverse sort keys %checkedDirectories) {
368 if (isDirectoryEmptyForRemoval($dir)) {
374 # This could be made into a more general "status" call, except svn and git
375 # have different ideas about "moving" files which might get confusing.
376 sub scmWillDeleteFile($)
380 my $svnOutput = svnStatus($path);
381 return 1 if $svnOutput && substr($svnOutput, 0, 1) eq "D";
383 my $gitOutput = `git diff-index --name-status HEAD -- $path`;
384 return 1 if $gitOutput && substr($gitOutput, 0, 1) eq "D";
389 # Return whether the file at the given path is known to Git.
391 # This method outputs a message like the following to STDERR when
394 # "error: pathspec 'test.png' did not match any file(s) known to git.
395 # Did you forget to 'git add'?"
396 sub gitKnowsOfFile($)
400 `git ls-files --error-unmatch -- $path`;
401 my $exitStatus = exitStatus($?);
402 return $exitStatus == 0;
405 sub scmKnowsOfFile($)
409 my $svnOutput = svnStatus($path);
410 # This will match more than intended. ? might not be the first field in the status
411 if ($svnOutput && $svnOutput =~ m#\?\s+$path\n#) {
414 # This does not handle errors well.
417 my @result = callSilently(\&gitKnowsOfFile, $path);
424 my ($source, $destination) = @_;
426 system("svn", "copy", $source, $destination) == 0 or die "Failed to svn copy $source $destination.";
428 system("cp", $source, $destination) == 0 or die "Failed to copy $source $destination.";
429 system("git", "add", $destination) == 0 or die "Failed to git add $destination.";
437 system("svn", "add", $path) == 0 or die "Failed to svn add $path.";
439 system("git", "add", $path) == 0 or die "Failed to git add $path.";
447 # SVN is very verbose when removing directories. Squelch all output except the last line.
449 open SVN, "svn rm --force '$path' |" or die "svn rm --force '$path' failed!";
450 # Only print the last line. Subversion outputs all changed statuses below $dir
455 print $svnOutput if $svnOutput;
457 # Git removes a directory if it becomes empty when the last file it contains is
458 # removed by `git rm`. In svn-apply this can happen when a directory is being
459 # removed in a patch, and all of the files inside of the directory are removed
460 # before attemping to remove the directory itself. In this case, Git will have
461 # already deleted the directory and `git rm` would exit with an error claiming
462 # there was no file. The --ignore-unmatch switch gracefully handles this case.
463 system("git", "rm", "--force", "--ignore-unmatch", $path) == 0 or die "Failed to git rm --force --ignore-unmatch $path.";