Reviewed by Darin Adler.
[WebKit-https.git] / WebKitTools / Scripts / cvs-create-patch
1 #!/usr/bin/perl -w
2
3 # Copyright (C) 2005 Apple Computer, Inc.  All rights reserved.
4 # Copyright (C) 2005 Ben La Monica <ben.lamonica@gmail.com> All rights reserved.
5 # Copyright (C) 2005 Alexey Proskuryakov <ap@nypop.com> All rights reserved.
6 #
7 # Redistribution and use in source and binary forms, with or without
8 # modification, are permitted provided that the following conditions
9 # are met:
10 #
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. 
19 #
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.
30
31 # Simplified but improved "cvs diff" script for Web Kit Open Source Project, used to make patches.
32
33 # Differences from standard "cvs diff":
34 #
35 #   Always passes "-N" to diff so it will include deleted and added files.
36 #   Always passes "-u" to diff so it will use unified diff format.
37 #   Always passes "-p" to diff so it will try to include function names.
38 #   Other command line options are not supported.
39 #   Works in mixed CVS root situations like the mix of internal and open source CVS repositories
40 #       for Apple's Safari and WebKit team, by doing a separate cvs invocation for each directory.
41 #   Fixes diff output paths so they will work with the "patch" tool.
42 #
43 # Missing feature:
44 #
45 #   Handle binary files (some text form of the binary file).
46
47 use strict;
48 use Cwd;
49 use Getopt::Long;
50 use Time::gmtime;
51 use File::stat;
52 use POSIX qw(:errno_h);
53 use Config;
54
55 my $startDir = getcwd();
56 my $includeUnknowns = "";
57 my %paths;
58
59 GetOptions("include-unknowns", \$includeUnknowns);
60
61 # Create list of paths to diff.
62 if (!@ARGV) {
63     $paths{"."} = 1;
64 } else {
65     for my $file (@ARGV) {
66         die "can't handle absolute paths like \"$file\"\n" if $file =~ m|^/|;
67         die "can't handle empty string path\n" if $file eq "";
68         die "can't handle path with ' in the name like \"$file\"\n" if $file =~ /'/; # ' (keep Xcode syntax highlighting happy)
69
70         my $untouchedFile = $file;
71         
72         # Add a leading and trailing slash to simplify logic below.
73         $file = "/$file/";
74
75         # Remove repeated slashes.
76         $file =~ s|//+|/|g;
77
78         # Remove meaningless sequences involving ".".
79         $file =~ s|/\./|/|g;
80
81         # Remove meaningless sequences involving "..".
82         $file =~ s|/[^./]/\.\./|/|g;
83         $file =~ s|/[^/]+[^./]/\.\./|/|g;
84         $file =~ s|/[^./][^/]+/\.\./|/|g;
85         die "can't handle paths with .. like \"$untouchedFile\"\n" if $file =~ m|/\.\./|;
86
87         # Remove the leading and trailing slash.
88         $file =~ s|^/(.*)/$|$1|;
89
90         $paths{$file} = 1;
91     }
92 }
93
94 # Remove any paths that also have a parent listed.
95 for my $path (keys %paths) {
96     my $parent = $path;
97     while ($parent =~ s|/+[^/]+$||) {
98         if ($paths{$parent}) {
99             delete $paths{$path};
100             last;
101         }
102     }
103 }
104
105 sub getDirAndBase
106 {
107     my ($path) = @_;
108     if (-d $path) {
109         $path =~ s|/+$||;
110         return ($path, ".");
111     }
112     return ($1, $2) if $path =~ m|^(.+)/([^/]+)$|;
113     $path !~ m|/| or die "Could not parse path name $path.\n";
114     return (".", $path);
115 }
116
117 # Function to generate a diff.
118 sub diff
119 {
120     my ($path) = @_;
121     my ($dir, $base) = getDirAndBase($path);
122     my $errors = "";
123     chdir $dir or die;
124     open DIFF, "cvs -f diff -Npu '$base' |" or die;
125     my $indexPath;
126     while (<DIFF>) {
127         if (/^Index: (.*)/) {
128             $indexPath = $1;
129             if ($dir ne ".") {
130                 $indexPath = "$dir/$indexPath";
131                 s/Index: .*/Index: $indexPath/;
132             }
133         }
134         if ($indexPath) {
135             # Fix paths on diff, ---, and +++ lines to match preceding Index: line.
136             s/\S+$/$indexPath/ if /^diff/;
137             s/^--- \S+/--- $indexPath/;
138             s/^\+\+\+ \S+/+++ $indexPath/;
139         }
140         if (/^\? (.+)$/) {
141             $errors .= $_;
142             my $unknown = $1;
143             if ($includeUnknowns && $unknown !~ /^\./) {
144                 if (-d $unknown) {
145                     addNewDirectory($dir, $unknown);
146                 } else {
147                     addNewFile($dir, $unknown);
148                 }
149             }
150         } else {
151             print;
152         }
153     }
154     close DIFF;
155     chdir $startDir or die;
156     print STDERR $errors;
157 }
158
159 sub addNewDirectory
160 {
161     my $indexPath = "";
162     my $dir = "";
163     my @files;
164
165     $indexPath = shift;
166     $dir = shift;
167
168     opendir NEWDIR, $dir;
169     @files = readdir(NEWDIR);
170     closedir NEWDIR;
171
172     if (!defined $indexPath || $indexPath eq "") {
173         $indexPath = $dir;
174     } else {
175         $indexPath .= "/$dir";
176     }
177
178     for my $file (@files) {
179         next if $file eq "." || $file eq "..";
180         if (-d "$dir/$file") {
181             my $oldDir = getcwd();
182             chdir $dir;
183             addNewDirectory($indexPath, "$file");
184             chdir $oldDir;
185         } else {
186             my $oldDir = getcwd();
187             chdir $dir;
188             addNewFile($indexPath, "$file");
189             chdir $oldDir;
190         }
191     }
192 }
193
194 sub addNewFile
195 {
196     my $indexPath = "";
197     my $newFile = "";
198     my @fileContents;
199     my $fileDate = "";
200     my @months = ("Jan","Feb","Mar","Apr","May","Jun","Jul","Aug","Sep","Oct","Nov","Dec");
201
202     $indexPath = shift;
203     $newFile = shift;
204
205     $fileDate = gmtime(stat($newFile)->mtime);
206
207     @fileContents = `diff -Nup /dev/null $newFile`;
208
209     if ($#fileContents == 0) {
210         return;
211     }
212
213     $indexPath .= "/" . $newFile;
214
215     #get rid of the first 2 lines
216     shift @fileContents;
217     shift @fileContents;
218
219     print "Index: $indexPath\n";
220     print "===================================================================\n";
221     print "diff -Npu $indexPath\n";
222     print "--- $indexPath\t1 Jan 1970 00:00:00 -0000\n";
223     print "+++ $indexPath\t" . $fileDate->mday . " " . $months[$fileDate->mon] . " " . ($fileDate->year + 1900) . " ";
224     printf "%02d:%02d:%02d -0000\n", ($fileDate->hour, $fileDate->min,$fileDate->sec);
225     print @fileContents;
226 }
227
228 # Generate the diff for each passed file or directory.
229 for my $path (sort keys %paths) {
230     diff($path);
231 }